Class: Stigg::Models::V1::SubscriptionProvisionResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription_provision_response.rb,
sig/stigg/models/v1/subscription_provision_response.rbs

Overview

See Also:

  • Stigg::Models::V1::SubscriptionProvisionResponse#data

Defined Under Namespace

Modules: Entitlement, Status Classes: Subscription

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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 ⇒ Object 



50
 
# File 'sig/stigg/models/v1/subscription_provision_response.rbs', line 50

def initialize: (

Instance Attribute Details

#checkout_billing_id ⇒ String?

Checkout billing ID when payment is required

Parameters:

  • (String)

Returns:

  • (String, nil) 


52
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 52

optional :checkout_billing_id, String, api_name: :checkoutBillingId

#checkout_url ⇒ String?

URL to complete payment when PAYMENT_REQUIRED

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 58

optional :checkout_url, String, api_name: :checkoutUrl

#entitlements ⇒ Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant0, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1>?

Parameters:

  • value (::Array[Stigg::Models::V1::SubscriptionProvisionResponse::Data::entitlement], nil)

Returns:



30
31
32
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 30

required :entitlements,
-> { Stigg::Internal::Type::ArrayOf[union: Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement] },
nil?: true

#id ⇒ String

Unique identifier for the provisioned subscription

Parameters:

  • value (String)

Returns:

  • (String) 


25
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 25

required :id, String

#is_scheduled ⇒ Boolean?

Whether the subscription is scheduled for future activation

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


64
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 64

optional :is_scheduled, Stigg::Internal::Type::Boolean, api_name: :isScheduled

#status ⇒ Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Status

Provision status: SUCCESS or PAYMENT_REQUIRED

Parameters:

  • value (Stigg::Models::V1::SubscriptionProvisionResponse::Data::status)

Returns:



38
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 38

required :status, enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Status }

#subscription ⇒ Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription?

Created subscription (when status is SUCCESS)

Parameters:

Returns:



44
45
46
 
# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 44

required :subscription,
-> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 484

.variants ⇒ Array(Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant0, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::UnionObjectVariant1)

Returns:




# File 'lib/stigg/models/v1/subscription_provision_response.rb', line 489

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/stigg/models/v1/subscription_provision_response.rbs', line 60

def to_hash: -> {