Class: MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit

Defined in:

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

Defined Under Namespace

Modules: RateType, Type Classes: Product

Constant Summary

MetronomeSDK =

Returns:

• (:ScheduleDuration)

Instance Attribute Summary

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

  The schedule that the customer will gain access to the credits.

• #applicable_product_ids ⇒ Array<String>^?
• #applicable_product_tags ⇒ Array<String>^?
• #description ⇒ String^?
• #hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration^?

  Optional configuration for recurring credit hierarchy access control.

• #id ⇒ String
• #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::V2::ContractEditResponse::Data::Edit::AddCredit::Product
• #rate_type ⇒ Symbol, ...
• #rollover_fraction ⇒ Float^?
• #salesforce_opportunity_id ⇒ String^?

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

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

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

• #type ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Type

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, name:) ⇒ 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:, name:) ⇒ Object

Parameters:

• id (String)
• name (String)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 625

Instance Attribute Details

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

The schedule that the customer will gain access to the credits.

Returns:

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

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 556

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

#applicable_product_ids ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 561

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

#applicable_product_tags ⇒ Array<String>^?

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 566

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

#description ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 571

optional :description, String

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

Optional configuration for recurring credit hierarchy access control

Returns:

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

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 577

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 582

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_response.rb', line 588

optional :netsuite_sales_order_id, String

#priority ⇒ Float^?

If multiple credits or 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_response.rb', line 595

optional :priority, Float

#product ⇒ MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Product

Parameters:

• value (MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Product)

Returns:

• (MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Product)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 545

required :product, -> { MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Product }

#rate_type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::RateType, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 600

optional :rate_type,
enum: -> { MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::RateType }

#rollover_fraction ⇒ Float^?

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 606

optional :rollover_fraction, Float

#salesforce_opportunity_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_response.rb', line 612

optional :salesforce_opportunity_id, String

#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_response.rb', line 623

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

#type ⇒ Symbol, MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Type

Parameters:

• value (MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::type_)

Returns:

• (Symbol, MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Type)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 550

required :type, enum: -> { MetronomeSDK::Models::V2::ContractEditResponse::Data::Edit::AddCredit::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v2/contract_edit_response.rb', line 683

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v2/contract_edit_response.rbs', line 675

def to_hash: -> {