Class: MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit

Inherits:

Internal::Type::BaseModel

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

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 Classes: AccessSchedule

Constant Summary

MetronomeSDK =

Returns:

• (:CommitHierarchyConfiguration)

Instance Attribute Summary

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

  Which products the credit applies to.

• #applicable_product_tags ⇒ Array<String>^?

  Which tags the credit applies to.

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

  Optional configuration for commit hierarchy access control.

• #name ⇒ String^?
• #netsuite_sales_order_id ⇒ String^?
• #priority ⇒ Float^?
• #product_id ⇒ String^?
• #rate_type ⇒ Symbol, ...

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

• #rollover_fraction ⇒ Float^?

Instance Method Summary

• #initialize(id:, amount: nil, ending_before: nil, starting_at: nil) ⇒ 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(id:, amount: nil, ending_before: nil, starting_at: nil) ⇒ Object

Parameters:

• id (String)
• amount (Float) (defaults to: nil)
• ending_before (Time) (defaults to: nil)
• starting_at (Time) (defaults to: nil)

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

Instance Attribute Details

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

Returns:

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

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

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

#applicable_product_ids ⇒ Array<String>^?

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

Parameters:

• value (::Array[String], nil)

Returns:

• (Array<String>, nil)

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

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

#applicable_product_tags ⇒ Array<String>^?

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

Parameters:

• value (::Array[String], nil)

Returns:

• (Array<String>, nil)

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

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

#credit_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :credit_id, String

#description ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

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 4099

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

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :name, String

#netsuite_sales_order_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :netsuite_sales_order_id, String, nil?: true

#priority ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

optional :priority, Float, nil?: true

#product_id ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :product_id, String

#rate_type ⇒ Symbol, ...

If provided, updates the credit 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::UpdateCredit::RateType, nil)

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

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

#rollover_fraction ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

optional :rollover_fraction, Float, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {