Class: MetronomeSDK::Models::ContractV2::Commit

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/contract_v2.rb

Defined Under Namespace

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

Instance Attribute Summary

• #access_schedule ⇒ MetronomeSDK::Models::ScheduleDuration^?

  The schedule that the customer will gain access to the credits purposed with this commit.

• #applicable_contract_ids ⇒ Array<String>^?
• #applicable_product_ids ⇒ Array<String>^?
• #applicable_product_tags ⇒ Array<String>^?
• #archived_at ⇒ Time^?
• #balance ⇒ Float^?

  The current balance of the credit or commit.

• #contract ⇒ MetronomeSDK::Models::ContractV2::Commit::Contract^?
• #created_at ⇒ Time

  Timestamp of when the commit was created.

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

  Custom fields to be added eg.

• #description ⇒ String^?
• #hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration^?

  Optional configuration for commit hierarchy access control.

• #id ⇒ String
• #invoice_contract ⇒ MetronomeSDK::Models::ContractV2::Commit::InvoiceContract^?

  The contract that this commit will be billed on.

• #invoice_schedule ⇒ MetronomeSDK::Models::SchedulePointInTime^?

  The schedule that the customer will be invoiced for this commit.

• #ledger ⇒ Array<MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>^?

  A list of ordered events that impact the balance of a commit.

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

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

• #priority ⇒ Float^?

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

• #product ⇒ MetronomeSDK::Models::ContractV2::Commit::Product
• #rate_type ⇒ Symbol, ...
• #rolled_over_from ⇒ MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom^?
• #rollover_fraction ⇒ Float^?
• #salesforce_opportunity_id ⇒ String^?

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

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

  List of filters that determine what kind of customer usage draws down a commit or credit.

• #type ⇒ Symbol, MetronomeSDK::Models::ContractV2::Commit::Type

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)

Instance Method Summary

• #initialize(id: ) ⇒ Object constructor

  The contract that this commit will be billed on.

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

The contract that this commit will be billed on.

Parameters:

• id (String) (defaults to: )

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

class Commit < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute created_at
  #   Timestamp of when the commit was created.
  #
  #   - Recurring commits: latter of commit service period date and parent commit
  #     start date
  #   - Rollover commits: when the new contract started
  #
  #   @return [Time]
  required :created_at, Time

  # @!attribute product
  #
  #   @return [MetronomeSDK::Models::ContractV2::Commit::Product]
  required :product, -> { MetronomeSDK::ContractV2::Commit::Product }

  # @!attribute type
  #
  #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Type]
  required :type, enum: -> { MetronomeSDK::ContractV2::Commit::Type }

  # @!attribute access_schedule
  #   The schedule that the customer will gain access to the credits purposed with
  #   this commit.
  #
  #   @return [MetronomeSDK::Models::ScheduleDuration, nil]
  optional :access_schedule, -> { MetronomeSDK::ScheduleDuration }

  # @!attribute applicable_contract_ids
  #
  #   @return [Array<String>, nil]
  optional :applicable_contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute applicable_product_ids
  #
  #   @return [Array<String>, nil]
  optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute applicable_product_tags
  #
  #   @return [Array<String>, nil]
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

  # @!attribute archived_at
  #
  #   @return [Time, nil]
  optional :archived_at, Time

  # @!attribute balance
  #   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.
  #
  #   @return [Float, nil]
  optional :balance, Float

  # @!attribute contract
  #
  #   @return [MetronomeSDK::Models::ContractV2::Commit::Contract, nil]
  optional :contract, -> { MetronomeSDK::ContractV2::Commit::Contract }

  # @!attribute custom_fields
  #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

  # @!attribute description
  #
  #   @return [String, nil]
  optional :description, String

  # @!attribute hierarchy_configuration
  #   Optional configuration for commit hierarchy access control
  #
  #   @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
  optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }

  # @!attribute invoice_contract
  #   The contract that this commit will be billed on.
  #
  #   @return [MetronomeSDK::Models::ContractV2::Commit::InvoiceContract, nil]
  optional :invoice_contract, -> { MetronomeSDK::ContractV2::Commit::InvoiceContract }

  # @!attribute invoice_schedule
  #   The schedule that the customer will be invoiced for this commit.
  #
  #   @return [MetronomeSDK::Models::SchedulePointInTime, nil]
  optional :invoice_schedule, -> { MetronomeSDK::SchedulePointInTime }

  # @!attribute ledger
  #   A list of ordered events that impact the balance of a commit. For example, an
  #   invoice deduction or a rollover.
  #
  #   @return [Array<MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
  optional :ledger,
           -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::ContractV2::Commit::Ledger] }

  # @!attribute name
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute netsuite_sales_order_id
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [String, nil]
  optional :netsuite_sales_order_id, String

  # @!attribute priority
  #   If multiple credits or commits are applicable, the one with the lower priority
  #   will apply first.
  #
  #   @return [Float, nil]
  optional :priority, Float

  # @!attribute rate_type
  #
  #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType, nil]
  optional :rate_type, enum: -> { MetronomeSDK::ContractV2::Commit::RateType }

  # @!attribute rolled_over_from
  #
  #   @return [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom, nil]
  optional :rolled_over_from, -> { MetronomeSDK::ContractV2::Commit::RolledOverFrom }

  # @!attribute rollover_fraction
  #
  #   @return [Float, nil]
  optional :rollover_fraction, Float

  # @!attribute salesforce_opportunity_id
  #   This field's availability is dependent on your client's configuration.
  #
  #   @return [String, nil]
  optional :salesforce_opportunity_id, String

  # @!attribute specifiers
  #   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.
  #
  #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
  optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }

  # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil)
  #   Some parameter documentations has been truncated, see
  #   {MetronomeSDK::Models::ContractV2::Commit} for more details.
  #
  #   @param id [String]
  #
  #   @param created_at [Time] Timestamp of when the commit was created.
  #
  #   @param product [MetronomeSDK::Models::ContractV2::Commit::Product]
  #
  #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Type]
  #
  #   @param access_schedule [MetronomeSDK::Models::ScheduleDuration] The schedule that the customer will gain access to the credits purposed with thi
  #
  #   @param applicable_contract_ids [Array<String>]
  #
  #   @param applicable_product_ids [Array<String>]
  #
  #   @param applicable_product_tags [Array<String>]
  #
  #   @param archived_at [Time]
  #
  #   @param balance [Float] The current balance of the credit or commit. This balance reflects the amount of
  #
  #   @param contract [MetronomeSDK::Models::ContractV2::Commit::Contract]
  #
  #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
  #
  #   @param description [String]
  #
  #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
  #
  #   @param invoice_contract [MetronomeSDK::Models::ContractV2::Commit::InvoiceContract] The contract that this commit will be billed on.
  #
  #   @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
  #
  #   @param ledger [Array<MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
  #
  #   @param name [String]
  #
  #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
  #
  #   @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
  #
  #   @param rate_type [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType]
  #
  #   @param rolled_over_from [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom]
  #
  #   @param rollover_fraction [Float]
  #
  #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
  #
  #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o

  # @see MetronomeSDK::Models::ContractV2::Commit#product
  class Product < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String]
    required :id, String

    # @!attribute name
    #
    #   @return [String]
    required :name, String

    # @!method initialize(id:, name:)
    #   @param id [String]
    #   @param name [String]
  end

  # @see MetronomeSDK::Models::ContractV2::Commit#type
  module Type
    extend MetronomeSDK::Internal::Type::Enum

    PREPAID = :PREPAID
    POSTPAID = :POSTPAID

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see MetronomeSDK::Models::ContractV2::Commit#contract
  class Contract < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String]
    required :id, String

    # @!method initialize(id:)
    #   @param id [String]
  end

  # @see MetronomeSDK::Models::ContractV2::Commit#invoice_contract
  class InvoiceContract < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute id
    #
    #   @return [String]
    required :id, String

    # @!method initialize(id:)
    #   The contract that this commit will be billed on.
    #
    #   @param id [String]
  end

  module Ledger
    extend MetronomeSDK::Internal::Type::Union

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry }

    variant -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry }

    class PrepaidCommitSegmentStartLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type }

      # @!method initialize(amount:, segment_id:, timestamp:, type:)
      #   @param amount [Float]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_SEGMENT_START = :PREPAID_COMMIT_SEGMENT_START

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitAutomatedInvoiceDeductionLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute invoice_id
      #
      #   @return [String]
      required :invoice_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type }

      # @!attribute contract_id
      #
      #   @return [String, nil]
      optional :contract_id, String

      # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
      #   @param amount [Float]
      #   @param invoice_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
      #   @param contract_id [String]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION = :PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitRolloverLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute new_contract_id
      #
      #   @return [String]
      required :new_contract_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type }

      # @!method initialize(amount:, new_contract_id:, segment_id:, timestamp:, type:)
      #   @param amount [Float]
      #   @param new_contract_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_ROLLOVER = :PREPAID_COMMIT_ROLLOVER

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitExpirationLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type }

      # @!method initialize(amount:, segment_id:, timestamp:, type:)
      #   @param amount [Float]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_EXPIRATION = :PREPAID_COMMIT_EXPIRATION

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitCanceledLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute invoice_id
      #
      #   @return [String]
      required :invoice_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type }

      # @!attribute contract_id
      #
      #   @return [String, nil]
      optional :contract_id, String

      # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
      #   @param amount [Float]
      #   @param invoice_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
      #   @param contract_id [String]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_CANCELED = :PREPAID_COMMIT_CANCELED

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitCreditedLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute invoice_id
      #
      #   @return [String]
      required :invoice_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type }

      # @!attribute contract_id
      #
      #   @return [String, nil]
      optional :contract_id, String

      # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
      #   @param amount [Float]
      #   @param invoice_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
      #   @param contract_id [String]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_CREDITED = :PREPAID_COMMIT_CREDITED

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitSeatBasedAdjustmentLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type }

      # @!method initialize(amount:, segment_id:, timestamp:, type:)
      #   @param amount [Float]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitInitialBalanceLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type }

      # @!method initialize(amount:, timestamp:, type:)
      #   @param amount [Float]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_INITIAL_BALANCE = :POSTPAID_COMMIT_INITIAL_BALANCE

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitAutomatedInvoiceDeductionLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute invoice_id
      #
      #   @return [String]
      required :invoice_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type }

      # @!attribute contract_id
      #
      #   @return [String, nil]
      optional :contract_id, String

      # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:, contract_id: nil)
      #   @param amount [Float]
      #   @param invoice_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
      #   @param contract_id [String]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION = :POSTPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitRolloverLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute new_contract_id
      #
      #   @return [String]
      required :new_contract_id, String

      # @!attribute segment_id
      #
      #   @return [String]
      required :segment_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type }

      # @!method initialize(amount:, new_contract_id:, segment_id:, timestamp:, type:)
      #   @param amount [Float]
      #   @param new_contract_id [String]
      #   @param segment_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_ROLLOVER = :POSTPAID_COMMIT_ROLLOVER

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitTrueupLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute invoice_id
      #
      #   @return [String]
      required :invoice_id, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type }

      # @!attribute contract_id
      #
      #   @return [String, nil]
      optional :contract_id, String

      # @!method initialize(amount:, invoice_id:, timestamp:, type:, contract_id: nil)
      #   @param amount [Float]
      #   @param invoice_id [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
      #   @param contract_id [String]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_TRUEUP = :POSTPAID_COMMIT_TRUEUP

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PrepaidCommitManualLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute reason
      #
      #   @return [String]
      required :reason, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type }

      # @!method initialize(amount:, reason:, timestamp:, type:)
      #   @param amount [Float]
      #   @param reason [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_MANUAL = :PREPAID_COMMIT_MANUAL

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitManualLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute reason
      #
      #   @return [String]
      required :reason, String

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type }

      # @!method initialize(amount:, reason:, timestamp:, type:)
      #   @param amount [Float]
      #   @param reason [String]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_MANUAL = :POSTPAID_COMMIT_MANUAL

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    class PostpaidCommitExpirationLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute timestamp
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #
      #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type }

      # @!method initialize(amount:, timestamp:, type:)
      #   @param amount [Float]
      #   @param timestamp [Time]
      #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]

      # @see MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        POSTPAID_COMMIT_EXPIRATION = :POSTPAID_COMMIT_EXPIRATION

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end

    # @!method self.variants
    #   @return [Array(MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
  end

  # @see MetronomeSDK::Models::ContractV2::Commit#rate_type
  module RateType
    extend MetronomeSDK::Internal::Type::Enum

    COMMIT_RATE = :COMMIT_RATE
    LIST_RATE = :LIST_RATE

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # @see MetronomeSDK::Models::ContractV2::Commit#rolled_over_from
  class RolledOverFrom < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute commit_id
    #
    #   @return [String]
    required :commit_id, String

    # @!attribute contract_id
    #
    #   @return [String]
    required :contract_id, String

    # @!method initialize(commit_id:, contract_id:)
    #   @param commit_id [String]
    #   @param contract_id [String]
  end
end

Instance Attribute Details

#access_schedule ⇒ MetronomeSDK::Models::ScheduleDuration^?

The schedule that the customer will gain access to the credits purposed with this commit.

Returns:

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

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

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

#applicable_contract_ids ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

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

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

#applicable_product_ids ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

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

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

#applicable_product_tags ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

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

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

#archived_at ⇒ Time^?

Returns:

• (Time, nil)

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

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)

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

optional :balance, Float

#contract ⇒ MetronomeSDK::Models::ContractV2::Commit::Contract^?

Returns:

• (MetronomeSDK::Models::ContractV2::Commit::Contract, nil)

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

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

#created_at ⇒ Time

Timestamp of when the commit was created.

• Recurring commits: latter of commit service period date and parent commit start date

• Rollover commits: when the new contract started

Returns:

• (Time)

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

required :created_at, Time

#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/contract_v2.rb', line 368

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

#description ⇒ String^?

Returns:

• (String, nil)

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

optional :description, String

#hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration^?

Optional configuration for commit hierarchy access control

Returns:

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

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

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

#id ⇒ String

Returns:

• (String)

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

required :id, String

#invoice_contract ⇒ MetronomeSDK::Models::ContractV2::Commit::InvoiceContract^?

The contract that this commit will be billed on.

Returns:

• (MetronomeSDK::Models::ContractV2::Commit::InvoiceContract, nil)

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

optional :invoice_contract, -> { MetronomeSDK::ContractV2::Commit::InvoiceContract }

#invoice_schedule ⇒ MetronomeSDK::Models::SchedulePointInTime^?

The schedule that the customer will be invoiced for this commit.

Returns:

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

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

optional :invoice_schedule, -> { MetronomeSDK::SchedulePointInTime }

#ledger ⇒ Array<MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>^?

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

Returns:

• (Array<MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil)

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

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

#name ⇒ String^?

Returns:

• (String, nil)

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

optional :name, String

#netsuite_sales_order_id ⇒ String^?

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

Returns:

• (String, nil)

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

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)

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

optional :priority, Float

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

Returns:

• (MetronomeSDK::Models::ContractV2::Commit::Product)

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

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

#rate_type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType, nil)

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

optional :rate_type, enum: -> { MetronomeSDK::ContractV2::Commit::RateType }

#rolled_over_from ⇒ MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom^?

Returns:

• (MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom, nil)

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

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

#rollover_fraction ⇒ Float^?

Returns:

• (Float, nil)

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

optional :rollover_fraction, Float

#salesforce_opportunity_id ⇒ String^?

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

Returns:

• (String, nil)

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

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:

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

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

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

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

Returns:

• (Symbol, MetronomeSDK::Models::ContractV2::Commit::Type)

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

.variants ⇒ Array(MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)

Returns:

• (Array(MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::ContractV2::Commit::Ledger::PostpaidCommitExpirationLedgerEntry))

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