Class: MetronomeSDK::Models::ContractV2

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::ContractV2

Defined in:

lib/metronome_sdk/models/contract_v2.rb,
sig/metronome_sdk/models/contract_v2.rbs

Defined Under Namespace

Modules: HierarchyConfiguration, MultiplierOverridePrioritization, ScheduledChargesOnUsageInvoices Classes: BillingProviderConfigurationSchedule, Commit, Credit, CustomerBillingProviderConfiguration, HasMore, Override, RecurringCommit, RecurringCredit, ResellerRoyalty, RevenueSystemConfigurationSchedule, SpendTracker, Subscription, Transition, UsageFilter, UsageStatementSchedule

Constant Summary

MetronomeSDK =

Returns:

• (:PrepaidBalanceThresholdConfigurationV2)

Instance Attribute Summary

• #archived_at ⇒ Time^?
• #billing_provider_configuration_schedule ⇒ Array<MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule>^?

  The schedule of billing provider configuration changes on the contract, ordered by effective_at ascending.

• #commits ⇒ Array<MetronomeSDK::Models::ContractV2::Commit>
• #created_at ⇒ Time
• #created_by ⇒ String
• #credits ⇒ Array<MetronomeSDK::Models::ContractV2::Credit>^?
• #custom_fields ⇒ Hash{Symbol=>String}^?

  Custom fields to be added eg.

• #customer_billing_provider_configuration ⇒ MetronomeSDK::Models::ContractV2::CustomerBillingProviderConfiguration^?
• #customer_id ⇒ String
• #discounts ⇒ Array<MetronomeSDK::Models::Discount>^?

  This field's availability is dependent on your client's configuration.

• #ending_before ⇒ Time^?
• #has_more ⇒ MetronomeSDK::Models::ContractV2::HasMore^?

  Indicates whether there are more items than the limit for this endpoint.

• #hierarchy_configuration ⇒ MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, ...

  Either a parent configuration with a list of children or a child configuration with a single parent.

• #id ⇒ String
• #multiplier_override_prioritization ⇒ Symbol, ...

  Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically.

• #name ⇒ String^?
• #net_payment_terms_days ⇒ Float^?
• #netsuite_sales_order_id ⇒ String^?

  This field's availability is dependent on your client's configuration.

• #overrides ⇒ Array<MetronomeSDK::Models::ContractV2::Override>
• #prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2^?
• #priority ⇒ Float^?

  Priority of the contract.

• #professional_services ⇒ Array<MetronomeSDK::Models::ProService>^?

  This field's availability is dependent on your client's configuration.

• #rate_card_id ⇒ String^?
• #recurring_commits ⇒ Array<MetronomeSDK::Models::ContractV2::RecurringCommit>^?
• #recurring_credits ⇒ Array<MetronomeSDK::Models::ContractV2::RecurringCredit>^?
• #reseller_royalties ⇒ Array<MetronomeSDK::Models::ContractV2::ResellerRoyalty>^?

  This field's availability is dependent on your client's configuration.

• #revenue_system_configuration_schedule ⇒ Array<MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule>^?

  The schedule of revenue system configuration changes on the contract, ordered by effective_at ascending.

• #salesforce_opportunity_id ⇒ String^?

  This field's availability is dependent on your client's configuration.

• #scheduled_charges ⇒ Array<MetronomeSDK::Models::ScheduledCharge>
• #scheduled_charges_on_usage_invoices ⇒ Symbol, ...

  Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice.

• #spend_threshold_configuration ⇒ MetronomeSDK::Models::SpendThresholdConfigurationV2^?
• #spend_trackers ⇒ Array<MetronomeSDK::Models::ContractV2::SpendTracker>^?

  Spend trackers attached to this contract.

• #starting_at ⇒ Time
• #subscriptions ⇒ Array<MetronomeSDK::Models::ContractV2::Subscription>^?

  List of subscriptions on the contract.

• #total_contract_value ⇒ Float^?
• #transitions ⇒ Array<MetronomeSDK::Models::ContractV2::Transition>
• #uniqueness_key ⇒ String^?

  Optional uniqueness key to prevent duplicate contract creations.

• #usage_filter ⇒ Array<MetronomeSDK::Models::ContractV2::UsageFilter>
• #usage_statement_schedule ⇒ MetronomeSDK::Models::ContractV2::UsageStatementSchedule

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2)

Instance Method Summary

• #initialize(amount:, period_ending_before:, period_starting_at:) ⇒ Object constructor
• #to_hash ⇒ {

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(amount:, period_ending_before:, period_starting_at:) ⇒ Object

Parameters:

• amount (Float)
• period_ending_before (Time)
• period_starting_at (Time)

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

Instance Attribute Details

#archived_at ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :archived_at, Time

#billing_provider_configuration_schedule ⇒ Array<MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule>^?

The schedule of billing provider configuration changes on the contract, ordered by effective_at ascending.

Returns:

• (Array<MetronomeSDK::Models::ContractV2::BillingProviderConfigurationSchedule>, nil)

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

optional :billing_provider_configuration_schedule,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::BillingProviderConfigurationSchedule] }

#commits ⇒ Array<MetronomeSDK::Models::ContractV2::Commit>

Parameters:

• value (::Array[MetronomeSDK::ContractV2::Commit])

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Commit>)

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

required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Commit] }

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#created_by ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :created_by, String

#credits ⇒ Array<MetronomeSDK::Models::ContractV2::Credit>^?

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Credit>, nil)

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

optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Credit] }

#custom_fields ⇒ Hash{Symbol=>String}^?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Parameters:

• (::Hash[Symbol, String])

Returns:

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

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

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

#customer_billing_provider_configuration ⇒ MetronomeSDK::Models::ContractV2::CustomerBillingProviderConfiguration^?

Returns:

• (MetronomeSDK::Models::ContractV2::CustomerBillingProviderConfiguration, nil)

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

optional :customer_billing_provider_configuration,
-> { MetronomeSDK::ContractV2::CustomerBillingProviderConfiguration }

#customer_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :customer_id, String

#discounts ⇒ Array<MetronomeSDK::Models::Discount>^?

This field's availability is dependent on your client's configuration.

Returns:

• (Array<MetronomeSDK::Models::Discount>, nil)

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

optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }

#ending_before ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :ending_before, Time

#has_more ⇒ MetronomeSDK::Models::ContractV2::HasMore^?

Indicates whether there are more items than the limit for this endpoint. Use the respective list endpoints to get the full lists.

Returns:

• (MetronomeSDK::Models::ContractV2::HasMore, nil)

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

optional :has_more, -> { MetronomeSDK::ContractV2::HasMore }

#hierarchy_configuration ⇒ MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, ...

Either a parent configuration with a list of children or a child configuration with a single parent.

Returns:

• (MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2, nil)

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

optional :hierarchy_configuration, union: -> { MetronomeSDK::ContractV2::HierarchyConfiguration }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#multiplier_override_prioritization ⇒ Symbol, ...

Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first.

Returns:

• (Symbol, MetronomeSDK::Models::ContractV2::MultiplierOverridePrioritization, nil)

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

optional :multiplier_override_prioritization,
enum: -> { MetronomeSDK::ContractV2::MultiplierOverridePrioritization }

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :name, String

#net_payment_terms_days ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :net_payment_terms_days, Float

#netsuite_sales_order_id ⇒ String^?

This field's availability is dependent on your client's configuration.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :netsuite_sales_order_id, String

#overrides ⇒ Array<MetronomeSDK::Models::ContractV2::Override>

Parameters:

• value (::Array[MetronomeSDK::ContractV2::Override])

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Override>)

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

required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Override] }

#prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2^?

Returns:

• (MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2, nil)

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

optional :prepaid_balance_threshold_configuration,
-> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2 }

#priority ⇒ Float^?

Priority of the contract.

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :priority, Float

#professional_services ⇒ Array<MetronomeSDK::Models::ProService>^?

This field's availability is dependent on your client's configuration.

Returns:

• (Array<MetronomeSDK::Models::ProService>, nil)

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

optional :professional_services, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService] }

#rate_card_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :rate_card_id, String

#recurring_commits ⇒ Array<MetronomeSDK::Models::ContractV2::RecurringCommit>^?

Returns:

• (Array<MetronomeSDK::Models::ContractV2::RecurringCommit>, nil)

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

optional :recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::RecurringCommit] }

#recurring_credits ⇒ Array<MetronomeSDK::Models::ContractV2::RecurringCredit>^?

Returns:

• (Array<MetronomeSDK::Models::ContractV2::RecurringCredit>, nil)

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

optional :recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::RecurringCredit] }

#reseller_royalties ⇒ Array<MetronomeSDK::Models::ContractV2::ResellerRoyalty>^?

This field's availability is dependent on your client's configuration.

Returns:

• (Array<MetronomeSDK::Models::ContractV2::ResellerRoyalty>, nil)

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

optional :reseller_royalties,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::ResellerRoyalty] }

#revenue_system_configuration_schedule ⇒ Array<MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule>^?

The schedule of revenue system configuration changes on the contract, ordered by effective_at ascending.

Returns:

• (Array<MetronomeSDK::Models::ContractV2::RevenueSystemConfigurationSchedule>, nil)

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

optional :revenue_system_configuration_schedule,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::RevenueSystemConfigurationSchedule] }

#salesforce_opportunity_id ⇒ String^?

This field's availability is dependent on your client's configuration.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :salesforce_opportunity_id, String

#scheduled_charges ⇒ Array<MetronomeSDK::Models::ScheduledCharge>

Parameters:

• value (::Array[MetronomeSDK::ScheduledCharge])

Returns:

• (Array<MetronomeSDK::Models::ScheduledCharge>)

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

required :scheduled_charges, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge] }

#scheduled_charges_on_usage_invoices ⇒ Symbol, ...

Determines which scheduled and commit charges to consolidate onto the Contract's usage invoice. The charge's timestamp must match the usage invoice's ending_before date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges.

Returns:

• (Symbol, MetronomeSDK::Models::ContractV2::ScheduledChargesOnUsageInvoices, nil)

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

optional :scheduled_charges_on_usage_invoices,
enum: -> { MetronomeSDK::ContractV2::ScheduledChargesOnUsageInvoices }

#spend_threshold_configuration ⇒ MetronomeSDK::Models::SpendThresholdConfigurationV2^?

Returns:

• (MetronomeSDK::Models::SpendThresholdConfigurationV2, nil)

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

optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfigurationV2 }

#spend_trackers ⇒ Array<MetronomeSDK::Models::ContractV2::SpendTracker>^?

Spend trackers attached to this contract.

Returns:

• (Array<MetronomeSDK::Models::ContractV2::SpendTracker>, nil)

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

optional :spend_trackers,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::SpendTracker] }

#starting_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :starting_at, Time

#subscriptions ⇒ Array<MetronomeSDK::Models::ContractV2::Subscription>^?

List of subscriptions on the contract.

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Subscription>, nil)

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

optional :subscriptions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Subscription] }

#total_contract_value ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :total_contract_value, Float

#transitions ⇒ Array<MetronomeSDK::Models::ContractV2::Transition>

Parameters:

• value (::Array[MetronomeSDK::ContractV2::Transition])

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Transition>)

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

required :transitions, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Transition] }

#uniqueness_key ⇒ String^?

Optional uniqueness key to prevent duplicate contract creations.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :uniqueness_key, String

#usage_filter ⇒ Array<MetronomeSDK::Models::ContractV2::UsageFilter>

Parameters:

• value (::Array[MetronomeSDK::ContractV2::UsageFilter])

Returns:

• (Array<MetronomeSDK::Models::ContractV2::UsageFilter>)

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

required :usage_filter,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::UsageFilter] }

#usage_statement_schedule ⇒ MetronomeSDK::Models::ContractV2::UsageStatementSchedule

Parameters:

• value (MetronomeSDK::ContractV2::UsageStatementSchedule)

Returns:

• (MetronomeSDK::Models::ContractV2::UsageStatementSchedule)

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

required :usage_statement_schedule, -> { MetronomeSDK::ContractV2::UsageStatementSchedule }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

.variants ⇒ Array(MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2)

Returns:

• (Array(MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2))

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {