Class: MetronomeSDK::Models::ContractV2::Credit

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

Defined Under Namespace

Modules: Ledger, Type Classes: Contract, Product, RolledOverFrom

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(id:) ⇒ Object

Parameters:

  • id (String) 



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

Instance Attribute Details

#access_schedule ⇒ MetronomeSDK::Models::ScheduleDuration?

The schedule that the customer will gain access to the credits.

Returns:



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

optional :access_schedule, -> { MetronomeSDK::ScheduleDuration }

#applicable_contract_ids ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#applicable_product_ids ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#applicable_product_tags ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#archived_at ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :archived_at, Time

#balance ⇒ Float?

The current balance of the credit or commit. This balance reflects the amount of credit or commit that the customer has access to use at this moment - thus, expired and upcoming credit or commit segments contribute 0 to the balance. The balance will match the sum of all ledger entries with the exception of the case where the sum of negative manual ledger entries exceeds the positive amount remaining on the credit or commit - in that case, the balance will be 0. All manual ledger entries associated with active credit or commit segments are included in the balance, including future-dated manual ledger entries.

Returns:

  • (Float, nil) 


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

optional :balance, Float

#contract ⇒ MetronomeSDK::Models::ContractV2::Credit::Contract?

Returns:



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

optional :contract, -> { MetronomeSDK::ContractV2::Credit::Contract }

#created_at ⇒ Time?

Timestamp of when the credit was created.

  • Recurring credits: latter of credit service period date and parent credit start date

Returns:

  • (Time, nil) 


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

optional :created_at, Time

#custom_fields ⇒ Hash{Symbol=>String}?

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

Returns:

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


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

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

#description ⇒ String?

Returns:

  • (String, nil) 


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

optional :description, String

#hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration?

Optional configuration for credit hierarchy access control

Returns:



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

optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#ledger ⇒ Array<MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry>?

A list of ordered events that impact the balance of a credit. For example, an invoice deduction or an expiration.

Returns:



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

optional :ledger,
-> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::ContractV2::Credit::Ledger] }

#name ⇒ String?

Returns:

  • (String, nil) 


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

optional :name, String

#netsuite_sales_order_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :netsuite_sales_order_id, String

#priority ⇒ Float?

If multiple credits or commits are applicable, the one with the lower priority will apply first.

Returns:

  • (Float, nil) 


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

optional :priority, Float

#product ⇒ MetronomeSDK::Models::ContractV2::Credit::Product

Returns:



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

required :product, -> { MetronomeSDK::ContractV2::Credit::Product }

#recurring_credit_id ⇒ String?

The ID of the recurring credit that created this credit

Returns:

  • (String, nil) 


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

optional :recurring_credit_id, String

#rolled_over_from ⇒ MetronomeSDK::Models::ContractV2::Credit::RolledOverFrom?

Returns:



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

optional :rolled_over_from, -> { MetronomeSDK::ContractV2::Credit::RolledOverFrom }

#salesforce_opportunity_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :salesforce_opportunity_id, String

#specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifier>?

List of filters that determine what kind of customer usage draws down a commit or credit. A customer’s usage needs to meet the condition of at least one of the specifiers to contribute to a commit’s or credit’s drawdown.

Returns:



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

optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }

#subscription_config ⇒ MetronomeSDK::Models::RecurringCommitSubscriptionConfig?

Attach a subscription to the recurring commit/credit.

Returns:



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

optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }

#type ⇒ Symbol, MetronomeSDK::Models::ContractV2::Credit::Type

Returns:



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

required :type, enum: -> { MetronomeSDK::ContractV2::Credit::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

.variants ⇒ Array(MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry)

Returns:




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