Class: Stigg::Models::V1::SubscriptionImportParams::Subscription

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/subscription_import_params.rb

Defined Under Namespace

Modules: BillingPeriod Classes: Addon, Charge

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(id:, quantity:) ⇒ Object

Addon configuration

Parameters:

  • id (String) —

    Addon ID

  • quantity (Integer) —

    Number of addon instances



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 45

class Subscription < Stigg::Internal::Type::BaseModel
  # @!attribute id
  #   Subscription ID
  #
  #   @return [String]
  required :id, String

  # @!attribute customer_id
  #   Customer ID
  #
  #   @return [String]
  required :customer_id, String, api_name: :customerId

  # @!attribute plan_id
  #   Plan ID
  #
  #   @return [String]
  required :plan_id, String, api_name: :planId

  # @!attribute addons
  #
  #   @return [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Addon>, nil]
  optional :addons,
           -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionImportParams::Subscription::Addon] }

  # @!attribute billing_id
  #   Billing ID
  #
  #   @return [String, nil]
  optional :billing_id, String, api_name: :billingId, nil?: true

  # @!attribute billing_period
  #   Billing period (MONTHLY or ANNUALLY)
  #
  #   @return [Symbol, Stigg::Models::V1::SubscriptionImportParams::Subscription::BillingPeriod, nil]
  optional :billing_period,
           enum: -> { Stigg::V1::SubscriptionImportParams::Subscription::BillingPeriod },
           api_name: :billingPeriod

  # @!attribute charges
  #
  #   @return [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge>, nil]
  optional :charges,
           -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionImportParams::Subscription::Charge] }

  # @!attribute end_date
  #   Subscription end date
  #
  #   @return [Time, nil]
  optional :end_date, Time, api_name: :endDate, nil?: true

  # @!attribute metadata
  #   Additional metadata for the subscription
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :metadata, Stigg::Internal::Type::HashOf[String]

  # @!attribute resource_id
  #   Resource ID
  #
  #   @return [String, nil]
  optional :resource_id, String, api_name: :resourceId, nil?: true

  # @!attribute start_date
  #   Subscription start date
  #
  #   @return [Time, nil]
  optional :start_date, Time, api_name: :startDate

  # @!method initialize(id:, customer_id:, plan_id:, addons: nil, billing_id: nil, billing_period: nil, charges: nil, end_date: nil, metadata: nil, resource_id: nil, start_date: nil)
  #   @param id [String] Subscription ID
  #
  #   @param customer_id [String] Customer ID
  #
  #   @param plan_id [String] Plan ID
  #
  #   @param addons [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Addon>]
  #
  #   @param billing_id [String, nil] Billing ID
  #
  #   @param billing_period [Symbol, Stigg::Models::V1::SubscriptionImportParams::Subscription::BillingPeriod] Billing period (MONTHLY or ANNUALLY)
  #
  #   @param charges [Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge>]
  #
  #   @param end_date [Time, nil] Subscription end date
  #
  #   @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
  #
  #   @param resource_id [String, nil] Resource ID
  #
  #   @param start_date [Time] Subscription start date

  class Addon < Stigg::Internal::Type::BaseModel
    # @!attribute id
    #   Addon ID
    #
    #   @return [String]
    required :id, String

    # @!attribute quantity
    #   Number of addon instances
    #
    #   @return [Integer]
    required :quantity, Integer

    # @!method initialize(id:, quantity:)
    #   Addon configuration
    #
    #   @param id [String] Addon ID
    #
    #   @param quantity [Integer] Number of addon instances
  end

  # Billing period (MONTHLY or ANNUALLY)
  #
  # @see Stigg::Models::V1::SubscriptionImportParams::Subscription#billing_period
  module BillingPeriod
    extend Stigg::Internal::Type::Enum

    MONTHLY = :MONTHLY
    ANNUALLY = :ANNUALLY

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  class Charge < Stigg::Internal::Type::BaseModel
    # @!attribute id
    #   Charge ID
    #
    #   @return [String]
    required :id, String

    # @!attribute quantity
    #   Charge quantity. Minimum is 0 (zero is allowed).
    #
    #   @return [Float]
    required :quantity, Float

    # @!attribute type
    #   Charge type
    #
    #   @return [Symbol, Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge::Type]
    required :type, enum: -> { Stigg::V1::SubscriptionImportParams::Subscription::Charge::Type }

    # @!method initialize(id:, quantity:, type:)
    #   A charge selection for a subscription (references a catalog charge with a
    #   quantity).
    #
    #   @param id [String] Charge ID
    #
    #   @param quantity [Float] Charge quantity. Minimum is 0 (zero is allowed).
    #
    #   @param type [Symbol, Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge::Type] Charge type

    # Charge type
    #
    # @see Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge#type
    module Type
      extend Stigg::Internal::Type::Enum

      FEATURE = :FEATURE
      CREDIT = :CREDIT

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#addons ⇒ Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Addon>?

Returns:



67
68
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 67

optional :addons,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionImportParams::Subscription::Addon] }

#billing_id ⇒ String?

Billing ID

Returns:

  • (String, nil) 


74
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 74

optional :billing_id, String, api_name: :billingId, nil?: true

#billing_period ⇒ Symbol, ...

Billing period (MONTHLY or ANNUALLY)

Returns:



80
81
82
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 80

optional :billing_period,
enum: -> { Stigg::V1::SubscriptionImportParams::Subscription::BillingPeriod },
api_name: :billingPeriod

#charges ⇒ Array<Stigg::Models::V1::SubscriptionImportParams::Subscription::Charge>?

Returns:



87
88
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 87

optional :charges,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::SubscriptionImportParams::Subscription::Charge] }

#customer_id ⇒ String

Customer ID

Returns:

  • (String) 


56
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 56

required :customer_id, String, api_name: :customerId

#end_date ⇒ Time?

Subscription end date

Returns:

  • (Time, nil) 


94
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 94

optional :end_date, Time, api_name: :endDate, nil?: true

#id ⇒ String

Subscription ID

Returns:

  • (String) 


50
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 50

required :id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata for the subscription

Returns:

  • (Hash{Symbol=>String}, nil) 


100
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 100

optional :metadata, Stigg::Internal::Type::HashOf[String]

#plan_id ⇒ String

Plan ID

Returns:

  • (String) 


62
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 62

required :plan_id, String, api_name: :planId

#resource_id ⇒ String?

Resource ID

Returns:

  • (String, nil) 


106
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 106

optional :resource_id, String, api_name: :resourceId, nil?: true

#start_date ⇒ Time?

Subscription start date

Returns:

  • (Time, nil) 


112
 
# File 'lib/stigg/models/v1/subscription_import_params.rb', line 112

optional :start_date, Time, api_name: :startDate

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/subscription_import_params.rb', line 167