Class: MethodRuby::Models::Entities::SubscriptionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::Entities::SubscriptionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/entities/subscription_create_params.rb

Overview

See Also:

• Resources::Entities::Subscriptions#create

Defined Under Namespace

Modules: Enroll, MethodVersion Classes: Payload

Instance Attribute Summary

• #enroll ⇒ Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll

  Subscription name to enroll.

• #entity_id ⇒ String
• #idempotency_key ⇒ String^?
• #method_version ⇒ Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion
• #payload ⇒ MethodRuby::Models::Entities::SubscriptionCreateParams::Payload^?

  Optional payload for the subscription.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(entity_id:, enroll:, method_version:, payload: nil, idempotency_key: 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(entity_id:, enroll:, method_version:, payload: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

• entity_id (String)
• enroll (Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll) —

  Subscription name to enroll.

• method_version (Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion)
• payload (MethodRuby::Models::Entities::SubscriptionCreateParams::Payload, nil) (defaults to: nil) —

  Optional payload for the subscription. Required when enroll is attribute.

• idempotency_key (String) (defaults to: nil)
• request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 38

Instance Attribute Details

#enroll ⇒ Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll

Subscription name to enroll.

Returns:

• (Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 20

required :enroll, enum: -> { MethodRuby::Entities::SubscriptionCreateParams::Enroll }

#entity_id ⇒ String

Returns:

• (String)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 14

required :entity_id, String

#idempotency_key ⇒ String^?

Returns:

• (String, nil)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 36

optional :idempotency_key, String

#method_version ⇒ Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion

Returns:

• (Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 25

required :method_version, enum: -> { MethodRuby::Entities::SubscriptionCreateParams::MethodVersion }

#payload ⇒ MethodRuby::Models::Entities::SubscriptionCreateParams::Payload^?

Optional payload for the subscription. Required when enroll is attribute.

Returns:

• (MethodRuby::Models::Entities::SubscriptionCreateParams::Payload, nil)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 31

optional :payload, -> { MethodRuby::Entities::SubscriptionCreateParams::Payload }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/entities/subscription_create_params.rb', line 59