Class: MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/v2/contract_edit_params.rb

Defined Under Namespace

Modules: RateType Classes: AccessSchedule, InvoiceSchedule

Instance Attribute Summary

• #access_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit::AccessSchedule^?
• #applicable_product_ids ⇒ Array<String>^?

  Which products the commit applies to.

• #applicable_product_tags ⇒ Array<String>^?

  Which tags the commit applies to.

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

  Optional configuration for commit hierarchy access control.

• #invoice_schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit::InvoiceSchedule^?
• #name ⇒ String^?
• #netsuite_sales_order_id ⇒ String^?
• #priority ⇒ Float^?
• #product_id ⇒ String^?
• #rate_type ⇒ Symbol, ...

  If provided, updates the commit to use the specified rate type for current and future invoices.

• #rollover_fraction ⇒ Float^?

Instance Method Summary

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

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:, amount: nil, quantity: nil, timestamp: nil, unit_price: nil) ⇒ Object

Parameters:

• id (String)
• amount (Float) (defaults to: nil)
• quantity (Float) (defaults to: nil)
• timestamp (Time) (defaults to: nil)
• unit_price (Float) (defaults to: nil)

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

Instance Attribute Details

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

Returns:

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

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

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

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

Returns:

• (Array<String>, nil)

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

optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true

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

Returns:

• (Array<String>, nil)

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

optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true

#commit_id ⇒ String

Returns:

• (String)

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

required :commit_id, String

#description ⇒ String^?

Returns:

• (String, nil)

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

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 3512

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

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

Returns:

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

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

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

#name ⇒ String^?

Returns:

• (String, nil)

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

optional :name, String

#netsuite_sales_order_id ⇒ String^?

Returns:

• (String, nil)

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

optional :netsuite_sales_order_id, String, nil?: true

#priority ⇒ Float^?

Returns:

• (Float, nil)

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

optional :priority, Float, nil?: true

#product_id ⇒ String^?

Returns:

• (String, nil)

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

optional :product_id, String

#rate_type ⇒ Symbol, ...

If provided, updates the commit to use the specified rate type for current and future invoices. Previously finalized invoices will need to be voided and regenerated to reflect the rate type change.

Returns:

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

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

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

#rollover_fraction ⇒ Float^?

Returns:

• (Float, nil)

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

optional :rollover_fraction, Float, nil?: true