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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/contract_create_response.rb

Overview

See Also:

Defined Under Namespace

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

Instance Attribute Summary collapse

Class Method 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(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 328

Instance Attribute Details

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

Returns:



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

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

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#created_by ⇒ String

Returns:

  • (String) 


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

required :created_by, String

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

Returns:



97
 
# 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) 


103
 
# 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?

The billing provider configuration associated with the contract.

Returns:



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

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

#customer_id ⇒ String

Returns:

  • (String) 


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

required :customer_id, String

#ending_before ⇒ Time?

Returns:

  • (Time, nil) 


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

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:



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

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:



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

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

#id ⇒ String

Returns:

  • (String) 


39
 
# 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:



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

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

#name ⇒ String?

Returns:

  • (String, nil) 


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

optional :name, String

#net_payment_terms_days ⇒ Float?

Returns:

  • (Float, nil) 


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

optional :net_payment_terms_days, Float

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

Returns:



64
 
# 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.

Returns:

  • (String, nil) 


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

optional :package_id, String

#prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration?

Returns:



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

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

#rate_card_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :rate_card_id, String

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

Returns:



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

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:



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

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

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

Returns:



69
 
# 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:



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

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

#spend_threshold_configuration ⇒ MetronomeSDK::Models::SpendThresholdConfiguration?

Returns:



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

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

#starting_at ⇒ Time

Returns:

  • (Time) 


74
 
# 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:



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

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

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

Returns:



79
80
 
# 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.

Returns:

  • (String, nil) 


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

optional :uniqueness_key, String

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

Returns:



85
86
 
# 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

Returns:



91
92
 
# 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 302