Class: MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract

Defined in:

lib/metronome_sdk/models/v1/contract_create_response.rb,
sig/metronome_sdk/models/v1/contract_create_response.rbs

Overview

See Also:

• MetronomeSDK::Models::V1::ContractCreateResponse::Data#contract

Defined Under Namespace

Modules: MultiplierOverridePrioritization, ScheduledChargesOnUsageInvoices Classes: CustomerBillingProviderConfiguration, HasMore, RecurringCommit, RecurringCredit, Transition, UsageFilter, UsageStatementSchedule

Constant Summary

MetronomeSDK =

Returns:

• (:PrepaidBalanceThresholdConfiguration)

Instance Attribute Summary

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

  Custom fields to be added eg.

• #customer_billing_provider_configuration ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration^?
• #customer_id ⇒ String
• #ending_before ⇒ Time^?
• #has_more ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::HasMore^?

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

• #hierarchy_configuration ⇒ MetronomeSDK::Models::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^?
• #overrides ⇒ Array<MetronomeSDK::Models::Override>
• #package_id ⇒ String^?

  ID of the package this contract was created from, if applicable.

• #prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration^?
• #rate_card_id ⇒ String^?
• #recurring_commits ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit>^?
• #recurring_credits ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit>^?
• #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::SpendThresholdConfiguration^?
• #starting_at ⇒ Time
• #subscriptions ⇒ Array<MetronomeSDK::Models::Subscription>^?

  List of subscriptions on the contract.

• #transitions ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::Transition>
• #uniqueness_key ⇒ String^?

  Optional uniqueness key to prevent duplicate contract creations.

• #usage_filter ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageFilter>
• #usage_statement_schedule ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageStatementSchedule

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(commits:, credits:) ⇒ Object constructor

  Some parameter documentations has been truncated, see HasMore for more details.

• #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(commits:, credits:) ⇒ Object

Some parameter documentations has been truncated, see HasMore for more details.

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

Parameters:

• commits (Boolean) —

  Whether there are more commits on this contract than the limit for this endpoint

• credits (Boolean) —

  Whether there are more credits on this contract than the limit for this endpoint

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 326

Instance Attribute Details

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

Parameters:

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

Returns:

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

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

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#created_by ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :created_by, String

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 97

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

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

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 103

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

#customer_billing_provider_configuration ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration^?

Returns:

• (MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration, nil)

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

optional :customer_billing_provider_configuration,
-> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::CustomerBillingProviderConfiguration }

#customer_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 59

required :customer_id, String

#ending_before ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 114

optional :ending_before, Time

#has_more ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::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::V1::ContractCreateResponse::Data::Contract::HasMore, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 121

optional :has_more, -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::HasMore }

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

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

Returns:

• (MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 128

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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::V1::ContractCreateResponse::Data::Contract::MultiplierOverridePrioritization, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 137

optional :multiplier_override_prioritization,
enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::MultiplierOverridePrioritization }

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 143

optional :name, String

#net_payment_terms_days ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 148

optional :net_payment_terms_days, Float

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

Parameters:

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 64

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

#package_id ⇒ String^?

ID of the package this contract was created from, if applicable.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 154

optional :package_id, String

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

Returns:

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

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

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

#rate_card_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 165

optional :rate_card_id, String

#recurring_commits ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit>^?

Returns:

• (Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit>, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 170

optional :recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit] }

#recurring_credits ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit>^?

Returns:

• (Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit>, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 176

optional :recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit] }

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

Parameters:

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 69

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::V1::ContractCreateResponse::Data::Contract::ScheduledChargesOnUsageInvoices, nil)

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

optional :scheduled_charges_on_usage_invoices,
enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::ScheduledChargesOnUsageInvoices }

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

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 193

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

#starting_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 74

required :starting_at, Time

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

List of subscriptions on the contract.

Returns:

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

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 199

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

#transitions ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::Transition>

Parameters:

• value (::Array[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::Transition])

Returns:

• (Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::Transition>)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 79

required :transitions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::Transition] }

#uniqueness_key ⇒ String^?

Optional uniqueness key to prevent duplicate contract creations.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 205

optional :uniqueness_key, String

#usage_filter ⇒ Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageFilter>

Parameters:

• value (::Array[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageFilter])

Returns:

• (Array<MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageFilter>)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 85

required :usage_filter,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageFilter] }

#usage_statement_schedule ⇒ MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageStatementSchedule

Parameters:

• value (MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageStatementSchedule)

Returns:

• (MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageStatementSchedule)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 91

required :usage_statement_schedule,
-> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::UsageStatementSchedule }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/contract_create_response.rb', line 300

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v1/contract_create_response.rbs', line 227

def to_hash: -> {