Class: MetronomeSDK::Models::V2::ContractEditCreditParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v2/contract_edit_credit_params.rb

Overview

See Also:

Defined Under Namespace

Modules: RateType Classes: AccessSchedule

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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_credit_params.rb', line 200

Instance Attribute Details

#access_schedule ⇒ MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule?

Returns:



26
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 26

optional :access_schedule, -> { MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule }

#applicable_product_ids ⇒ Array<String>?

Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.

Returns:

  • (Array<String>, nil) 


33
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 33

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

#applicable_product_tags ⇒ Array<String>?

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

Returns:

  • (Array<String>, nil) 


40
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 40

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

#credit_id ⇒ String

ID of the credit to edit

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 15

required :credit_id, String

#customer_id ⇒ String

ID of the customer whose credit is being edited

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 21

required :customer_id, String

#description ⇒ String?

Updated description for the credit

Returns:

  • (String, nil) 


46
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 46

optional :description, String

#hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration?

Optional configuration for credit hierarchy access control

Returns:



52
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 52

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

#name ⇒ String?

Updated name for the credit

Returns:

  • (String, nil) 


58
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 58

optional :name, String

#priority ⇒ Float?

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

Returns:

  • (Float, nil) 


65
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 65

optional :priority, Float, nil?: true

#product_id ⇒ String?

Returns:

  • (String, nil) 


70
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 70

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:



78
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 78

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

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



89
90
91
 
# File 'lib/metronome_sdk/models/v2/contract_edit_credit_params.rb', line 89

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