Class: MetronomeSDK::Models::ContractWithoutAmendments

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: ScheduledChargesOnUsageInvoices Classes: RecurringCommit, RecurringCredit, ResellerRoyalty, SpendTracker, 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>^?
• #discounts ⇒ Array<MetronomeSDK::Models::Discount>^?

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

• #ending_before ⇒ Time^?
• #hierarchy_configuration ⇒ MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration, ...

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

• #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::Override>
• #prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration^?
• #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::ContractWithoutAmendments::RecurringCommit>^?
• #recurring_credits ⇒ Array<MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit>^?
• #reseller_royalties ⇒ Array<MetronomeSDK::Models::ContractWithoutAmendments::ResellerRoyalty>^?

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

• #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::SpendThresholdConfiguration^?
• #spend_trackers ⇒ Array<MetronomeSDK::Models::ContractWithoutAmendments::SpendTracker>^?

  Spend trackers attached to this contract.

• #starting_at ⇒ Time
• #total_contract_value ⇒ Float^?

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

• #transitions ⇒ Array<MetronomeSDK::Models::ContractWithoutAmendments::Transition>
• #usage_filter ⇒ MetronomeSDK::Models::ContractWithoutAmendments::UsageFilter^?
• #usage_statement_schedule ⇒ MetronomeSDK::Models::ContractWithoutAmendments::UsageStatementSchedule

Class Method Summary

• .values ⇒ Array<Symbol>

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_without_amendments.rb', line 1343

Instance Attribute Details

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

Parameters:

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

Returns:

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

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

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#created_by ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :created_by, String

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 50

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

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

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 56

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

#ending_before ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 61

optional :ending_before, Time

#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/contract_without_amendments.rb', line 68

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

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 73

optional :name, String

#net_payment_terms_days ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

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

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_without_amendments.rb', line 84

optional :netsuite_sales_order_id, String

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

Parameters:

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

Returns:

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

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

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

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

Returns:

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

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

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

#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_without_amendments.rb', line 96

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

#rate_card_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :rate_card_id, String

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 106

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

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 112

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

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

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 119

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

#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_without_amendments.rb', line 126

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_without_amendments.rb', line 29

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::ContractWithoutAmendments::ScheduledChargesOnUsageInvoices, nil)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 136

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

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

Returns:

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

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 142

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

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

Spend trackers attached to this contract.

Returns:

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

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

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

#starting_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :starting_at, Time

#total_contract_value ⇒ Float^?

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

Parameters:

• (Float)

Returns:

• (Float, nil)

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

optional :total_contract_value, Float

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

Parameters:

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

Returns:

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

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

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

#usage_filter ⇒ MetronomeSDK::Models::ContractWithoutAmendments::UsageFilter^?

Returns:

• (MetronomeSDK::Models::ContractWithoutAmendments::UsageFilter, nil)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 160

optional :usage_filter, -> { MetronomeSDK::ContractWithoutAmendments::UsageFilter }

#usage_statement_schedule ⇒ MetronomeSDK::Models::ContractWithoutAmendments::UsageStatementSchedule

Parameters:

• value (MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule)

Returns:

• (MetronomeSDK::Models::ContractWithoutAmendments::UsageStatementSchedule)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 45

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/contract_without_amendments.rb', line 247

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/contract_without_amendments.rbs', line 181

def to_hash: -> {