Class: Moonbase::Models::CollectionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Moonbase::Models::CollectionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/moonbase/models/collection_create_params.rb

Overview

See Also:

• Resources::Collections#create

Instance Attribute Summary

• #description ⇒ String^?

  An optional, longer-form description of the collection’s purpose.

• #name ⇒ String

  The user-facing name of the collection (e.g., “Leads”).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(name:, description: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CollectionCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, description: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Moonbase::Models::CollectionCreateParams for more details.

Parameters:

• name (String) —

  The user-facing name of the collection (e.g., “Leads”). A ‘ref` is automatically

• description (String) (defaults to: nil) —

  An optional, longer-form description of the collection’s purpose.

• request_options (Moonbase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/moonbase/models/collection_create_params.rb', line 23

Instance Attribute Details

#description ⇒ String^?

An optional, longer-form description of the collection’s purpose.

Returns:

• (String, nil)

# File 'lib/moonbase/models/collection_create_params.rb', line 21

optional :description, String

#name ⇒ String

The user-facing name of the collection (e.g., “Leads”). A ‘ref` is automatically derived from the name.

Returns:

• (String)

# File 'lib/moonbase/models/collection_create_params.rb', line 15

required :name, String