Class: MetronomeSDK::Models::Override::OverrideSpecifier

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/override.rb,
sig/metronome_sdk/models/override.rbs

Defined Under Namespace

Modules: BillingFrequency

Instance Attribute 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(any_commit_or_credit_ids: nil, billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil) ⇒ Object

Parameters:

  • any_commit_or_credit_ids (Array<String>) (defaults to: nil)
  • billing_frequency (Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency) (defaults to: nil)
  • commit_ids (Array<String>) (defaults to: nil)
  • presentation_group_values (Hash{Symbol=>String, nil}) (defaults to: nil)
  • pricing_group_values (Hash{Symbol=>String}) (defaults to: nil)
  • product_id (String) (defaults to: nil)
  • product_tags (Array<String>) (defaults to: nil)
  • recurring_commit_ids (Array<String>) (defaults to: nil) 


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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/metronome_sdk/models/override.rb', line 173

class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute any_commit_or_credit_ids
  #
  #   @return [Array<String>, nil]
  optional :any_commit_or_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute billing_frequency
  #
  #   @return [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency, nil]
  optional :billing_frequency, enum: -> { MetronomeSDK::Override::OverrideSpecifier::BillingFrequency }

  # @!attribute commit_ids
  #
  #   @return [Array<String>, nil]
  optional :commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute presentation_group_values
  #
  #   @return [Hash{Symbol=>String, nil}, nil]
  optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String, nil?: true]

  # @!attribute pricing_group_values
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

  # @!attribute product_id
  #
  #   @return [String, nil]
  optional :product_id, String

  # @!attribute product_tags
  #
  #   @return [Array<String>, nil]
  optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute recurring_commit_ids
  #
  #   @return [Array<String>, nil]
  optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!method initialize(any_commit_or_credit_ids: nil, billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil)
  #   @param any_commit_or_credit_ids [Array<String>]
  #   @param billing_frequency [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency]
  #   @param commit_ids [Array<String>]
  #   @param presentation_group_values [Hash{Symbol=>String, nil}]
  #   @param pricing_group_values [Hash{Symbol=>String}]
  #   @param product_id [String]
  #   @param product_tags [Array<String>]
  #   @param recurring_commit_ids [Array<String>]

  # @see MetronomeSDK::Models::Override::OverrideSpecifier#billing_frequency
  module BillingFrequency
    extend MetronomeSDK::Internal::Type::Enum

    MONTHLY = :MONTHLY
    QUARTERLY = :QUARTERLY
    ANNUAL = :ANNUAL
    WEEKLY = :WEEKLY

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

Instance Attribute Details

#any_commit_or_credit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


177
 
# File 'lib/metronome_sdk/models/override.rb', line 177

optional :any_commit_or_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#billing_frequency ⇒ Symbol, ...

Returns:



182
 
# File 'lib/metronome_sdk/models/override.rb', line 182

optional :billing_frequency, enum: -> { MetronomeSDK::Override::OverrideSpecifier::BillingFrequency }

#commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


187
 
# File 'lib/metronome_sdk/models/override.rb', line 187

optional :commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#presentation_group_values ⇒ Hash{Symbol=>String, nil}?

Returns:

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


192
 
# File 'lib/metronome_sdk/models/override.rb', line 192

optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String, nil?: true]

#pricing_group_values ⇒ Hash{Symbol=>String}?

Returns:

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


197
 
# File 'lib/metronome_sdk/models/override.rb', line 197

optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

#product_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


202
 
# File 'lib/metronome_sdk/models/override.rb', line 202

optional :product_id, String

#product_tags ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


207
 
# File 'lib/metronome_sdk/models/override.rb', line 207

optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

#recurring_commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


212
 
# File 'lib/metronome_sdk/models/override.rb', line 212

optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


240
 
# File 'sig/metronome_sdk/models/override.rbs', line 240

def to_hash: -> {