Class: Dodopayments::Models::ProductCollectionUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dodopayments/models/product_collection_update_params.rb

Overview

See Also:

Defined Under Namespace

Modules: EffectiveAtOnDowngrade, EffectiveAtOnUpgrade, OnPaymentFailure, ProrationBillingModeOnDowngrade, ProrationBillingModeOnUpgrade

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(id:, brand_id: nil, description: nil, effective_at_on_downgrade: nil, effective_at_on_upgrade: nil, group_order: nil, image_id: nil, name: nil, on_payment_failure: nil, proration_billing_mode_on_downgrade: nil, proration_billing_mode_on_upgrade: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::ProductCollectionUpdateParams for more details.

Parameters:




# File 'lib/dodopayments/models/product_collection_update_params.rb', line 90

Instance Attribute Details

#brand_id ⇒ String?

Optional brand_id update

Returns:

  • (String, nil) 


19
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 19

optional :brand_id, String, nil?: true

#description ⇒ String?

Optional description update - pass null to remove, omit to keep unchanged

Returns:

  • (String, nil) 


25
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 25

optional :description, String, nil?: true

#effective_at_on_downgrade ⇒ Symbol, ...

Effective_at setting for downgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

Returns:



32
33
34
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 32

optional :effective_at_on_downgrade,
enum: -> { Dodopayments::ProductCollectionUpdateParams::EffectiveAtOnDowngrade },
nil?: true

#effective_at_on_upgrade ⇒ Symbol, ...

Effective_at setting for upgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

Returns:



41
42
43
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 41

optional :effective_at_on_upgrade,
enum: -> { Dodopayments::ProductCollectionUpdateParams::EffectiveAtOnUpgrade },
nil?: true

#group_order ⇒ Array<String>?

Optional new order for groups (array of group UUIDs in desired order)

Returns:

  • (Array<String>, nil) 


49
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 49

optional :group_order, Dodopayments::Internal::Type::ArrayOf[String], nil?: true

#id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 13

required :id, String

#image_id ⇒ String?

Optional image update - pass null to remove, omit to keep unchanged

Returns:

  • (String, nil) 


55
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 55

optional :image_id, String, nil?: true

#name ⇒ String?

Optional new name for the collection

Returns:

  • (String, nil) 


61
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 61

optional :name, String, nil?: true

#on_payment_failure ⇒ Symbol, ...

On payment failure behavior: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

Returns:



68
69
70
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 68

optional :on_payment_failure,
enum: -> { Dodopayments::ProductCollectionUpdateParams::OnPaymentFailure },
nil?: true

#proration_billing_mode_on_downgrade ⇒ Symbol, ...

Proration billing mode for downgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

Returns:



77
78
79
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 77

optional :proration_billing_mode_on_downgrade,
enum: -> { Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnDowngrade },
nil?: true

#proration_billing_mode_on_upgrade ⇒ Symbol, ...

Proration billing mode for upgrades: Some(Some(val)) = set, Some(None) = clear (inherit), None = no change

Returns:



86
87
88
 
# File 'lib/dodopayments/models/product_collection_update_params.rb', line 86

optional :proration_billing_mode_on_upgrade,
enum: -> { Dodopayments::ProductCollectionUpdateParams::ProrationBillingModeOnUpgrade },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/dodopayments/models/product_collection_update_params.rb', line 126