Class: MetronomeSDK::Models::V2::ContractEditParams::AddCommit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V2::ContractEditParams::AddCommit

Defined in:

lib/metronome_sdk/models/v2/contract_edit_params.rb,
sig/metronome_sdk/models/v2/contract_edit_params.rbs

Defined Under Namespace

Modules: RateType, Type Classes: AccessSchedule, InvoiceSchedule, PaymentGateConfig, SpendTrackerAttributes

Constant Summary

MetronomeSDK =

Returns:

• (:CommitHierarchyConfiguration)

Instance Attribute Summary

• #access_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule^?

  Required: Schedule for distributing the commit to the customer.

• #amount ⇒ Float^?

  (DEPRECATED) Use access_schedule and invoice_schedule instead.

• #applicable_product_ids ⇒ Array<String>^?

  Which products the commit applies to.

• #applicable_product_tags ⇒ Array<String>^?

  Which tags the commit applies to.

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

  Custom fields to be added eg.

• #description ⇒ String^?

  Used only in UI/API.

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

  Optional configuration for commit hierarchy access control.

• #invoice_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule^?

  Required for "POSTPAID" commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match access_schedule amount.

• #name ⇒ String^?

  displayed on invoices.

• #netsuite_sales_order_id ⇒ String^?

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

• #payment_gate_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::PaymentGateConfig^?

  optionally payment gate this commit.

• #priority ⇒ Float^?

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

• #product_id ⇒ String
• #rate_type ⇒ Symbol, ...
• #rollover_fraction ⇒ Float^?

  Fraction of unused segments that will be rolled over.

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

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

• #spend_tracker_attributes ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::SpendTrackerAttributes^?

  Optional attributes for spend tracker integration.

• #temporary_id ⇒ String^?

  A temporary ID for the commit that can be used to reference the commit for commit specific overrides.

• #type ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::Type

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(timestamp:, amount: nil, quantity: nil, unit_price: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see InvoiceSchedule::ScheduleItem 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(timestamp:, amount: nil, quantity: nil, unit_price: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem for more details.

Parameters:

• timestamp (Time) —

  timestamp of the scheduled event

• amount (Float) (defaults to: nil) —

  Amount for the charge. Can be provided instead of unit_price and quantity. If am

• quantity (Float) (defaults to: nil) —

  Quantity for the charge. Will be multiplied by unit_price to determine the amoun

• unit_price (Float) (defaults to: nil) —

  Unit price for the charge. Will be multiplied by quantity to determine the amoun

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 567

Instance Attribute Details

#access_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule^?

Required: Schedule for distributing the commit to the customer. For "POSTPAID" commits only one schedule item is allowed and amount must match invoice_schedule total.

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 455

optional :access_schedule, -> { MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule }

#amount ⇒ Float^?

(DEPRECATED) Use access_schedule and invoice_schedule instead.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 461

optional :amount, Float

#applicable_product_ids ⇒ Array<String>^?

Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 469

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

#applicable_product_tags ⇒ Array<String>^?

Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 477

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

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

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

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 483

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

#description ⇒ String^?

Used only in UI/API. It is not exposed to end customers.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 489

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/v2/contract_edit_params.rb', line 495

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

#invoice_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule^?

Required for "POSTPAID" commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match access_schedule amount. Optional for "PREPAID" commits: if not provided, this will be a "complimentary" commit with no invoice.

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 504

optional :invoice_schedule, -> { MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule }

#name ⇒ String^?

displayed on invoices

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 510

optional :name, String

#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/v2/contract_edit_params.rb', line 516

optional :netsuite_sales_order_id, String

#payment_gate_config ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::PaymentGateConfig^?

optionally payment gate this commit

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddCommit::PaymentGateConfig, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 522

optional :payment_gate_config, -> { MetronomeSDK::V2::ContractEditParams::AddCommit::PaymentGateConfig }

#priority ⇒ Float^?

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

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 529

optional :priority, Float

#product_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 442

required :product_id, String

#rate_type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::RateType, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 534

optional :rate_type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::RateType }

#rollover_fraction ⇒ Float^?

Fraction of unused segments that will be rolled over. Must be between 0 and 1.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 540

optional :rollover_fraction, Float

#specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifierInput>^?

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. This field cannot be used together with applicable_product_ids or applicable_product_tags. Instead, to target usage by product or product tag, pass those values in the body of specifiers.

Returns:

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

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 551

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

#spend_tracker_attributes ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddCommit::SpendTrackerAttributes^?

Optional attributes for spend tracker integration. Immutable after creation.

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddCommit::SpendTrackerAttributes, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 557

optional :spend_tracker_attributes,
-> { MetronomeSDK::V2::ContractEditParams::AddCommit::SpendTrackerAttributes }

#temporary_id ⇒ String^?

A temporary ID for the commit that can be used to reference the commit for commit specific overrides.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 565

optional :temporary_id, String

#type ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::Type

Parameters:

• value (MetronomeSDK::Models::V2::ContractEditParams::AddCommit::type_)

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::Type)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 447

required :type, enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 616

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v2/contract_edit_params.rbs', line 568

def to_hash: -> {