Class: Dodopayments::Models::ProductCollectionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::ProductCollectionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/product_collection_create_params.rb

Overview

See Also:

• Resources::ProductCollections#create

Instance Attribute Summary

• #brand_id ⇒ String^?

  Brand id for the collection, if not provided will default to primary brand.

• #description ⇒ String^?

  Optional description of the product collection.

• #groups ⇒ Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>

  Groups of products in this collection.

• #name ⇒ String

  Name of the product collection.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

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(groups:, name:, brand_id: nil, description: nil, request_options: {}) ⇒ Object

Parameters:

• groups (Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>) —

  Groups of products in this collection

• name (String) —

  Name of the product collection

• brand_id (String, nil) (defaults to: nil) —

  Brand id for the collection, if not provided will default to primary brand

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

  Optional description of the product collection

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

# File 'lib/dodopayments/models/product_collection_create_params.rb', line 35

Instance Attribute Details

#brand_id ⇒ String^?

Brand id for the collection, if not provided will default to primary brand

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_collection_create_params.rb', line 27

optional :brand_id, String, nil?: true

#description ⇒ String^?

Optional description of the product collection

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_collection_create_params.rb', line 33

optional :description, String, nil?: true

#groups ⇒ Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>

Groups of products in this collection

Returns:

• (Array<Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails>)

# File 'lib/dodopayments/models/product_collection_create_params.rb', line 14

required :groups,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::ProductCollectionGroupDetails] }

#name ⇒ String

Name of the product collection

Returns:

• (String)

# File 'lib/dodopayments/models/product_collection_create_params.rb', line 21

required :name, String