Class: TerminalShop::Models::SubscriptionUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• TerminalShop::Models::SubscriptionUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/terminal_shop/models/subscription_update_params.rb

Overview

See Also:

• Resources::Subscription#update

Defined Under Namespace

Modules: Schedule

Instance Attribute Summary

• #address_id ⇒ String^?

  New shipping address ID for the subscription.

• #card_id ⇒ String^?

  New payment method ID for the subscription.

• #schedule ⇒ TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, ...

  New schedule for the subscription.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(address_id: nil, card_id: nil, schedule: 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(address_id: nil, card_id: nil, schedule: nil, request_options: {}) ⇒ Object

Parameters:

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

  New shipping address ID for the subscription.

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

  New payment method ID for the subscription.

• schedule (TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly) (defaults to: nil) —

  New schedule for the subscription.

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

# File 'lib/terminal_shop/models/subscription_update_params.rb', line 28

Instance Attribute Details

#address_id ⇒ String^?

New shipping address ID for the subscription.

Returns:

• (String, nil)

# File 'lib/terminal_shop/models/subscription_update_params.rb', line 14

optional :address_id, String, api_name: :addressID

#card_id ⇒ String^?

New payment method ID for the subscription.

Returns:

• (String, nil)

# File 'lib/terminal_shop/models/subscription_update_params.rb', line 20

optional :card_id, String, api_name: :cardID

#schedule ⇒ TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, ...

New schedule for the subscription.

Returns:

• (TerminalShop::Models::SubscriptionUpdateParams::Schedule::Fixed, TerminalShop::Models::SubscriptionUpdateParams::Schedule::Weekly, nil)

# File 'lib/terminal_shop/models/subscription_update_params.rb', line 26

optional :schedule, union: -> { TerminalShop::SubscriptionUpdateParams::Schedule }