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) 


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
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 1401

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) 


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

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

#billing_frequency ⇒ Symbol, ...

Returns:



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

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

#commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

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

Returns:

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


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

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

#pricing_group_values ⇒ Hash{Symbol=>String}?

Returns:

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


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

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

#product_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :product_id, String

#product_tags ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

#recurring_commit_ids ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {