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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/contract_v2.rb,
sig/metronome_sdk/models/contract_v2.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::ContractV2::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) 


1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1374

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::ContractV2::Override::OverrideSpecifier::BillingFrequency, nil]
  optional :billing_frequency,
           enum: -> { MetronomeSDK::ContractV2::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::ContractV2::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::ContractV2::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) 


1378
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1378

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

#billing_frequency ⇒ Symbol, ...

Returns:



1383
1384
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1383

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

#commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


1389
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1389

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

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

Returns:

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


1394
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1394

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

#pricing_group_values ⇒ Hash{Symbol=>String}?

Returns:

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


1399
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1399

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

#product_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


1404
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1404

optional :product_id, String

#product_tags ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


1409
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1409

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

#recurring_commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


1414
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1414

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1435
 
# File 'sig/metronome_sdk/models/contract_v2.rbs', line 1435

def to_hash: -> {