Class: MetronomeSDK::Models::ContractV2::RecurringCredit

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/contract_v2.rb

Defined Under Namespace

Modules: Proration, RateType, RecurrenceFrequency Classes: AccessAmount, CommitDuration, Contract, Product

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:) ⇒ Object

Parameters:

  • id (String) 



# File 'lib/metronome_sdk/models/contract_v2.rb', line 3029

Instance Attribute Details

#access_amount ⇒ MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount

The amount of commit to grant.

Returns:



2911
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2911

required :access_amount, -> { MetronomeSDK::ContractV2::RecurringCredit::AccessAmount }

#applicable_product_ids ⇒ Array<String>?

Will be passed down to the individual commits

Returns:

  • (Array<String>, nil) 


2946
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2946

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

#applicable_product_tags ⇒ Array<String>?

Will be passed down to the individual commits

Returns:

  • (Array<String>, nil) 


2952
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2952

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

#commit_duration ⇒ MetronomeSDK::Models::ContractV2::RecurringCredit::CommitDuration

The amount of time the created commits will be valid for

Returns:



2917
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2917

required :commit_duration, -> { MetronomeSDK::ContractV2::RecurringCredit::CommitDuration }

#contract ⇒ MetronomeSDK::Models::ContractV2::RecurringCredit::Contract?

Returns:



2957
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2957

optional :contract, -> { MetronomeSDK::ContractV2::RecurringCredit::Contract }

#description ⇒ String?

Will be passed down to the individual commits

Returns:

  • (String, nil) 


2963
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2963

optional :description, String

#ending_before ⇒ Time?

Determines when the contract will stop creating recurring commits. Optional

Returns:

  • (Time, nil) 


2969
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2969

optional :ending_before, Time

#hierarchy_configuration ⇒ MetronomeSDK::Models::CommitHierarchyConfiguration?

Optional configuration for recurring credit hierarchy access control

Returns:



2975
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2975

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

#id ⇒ String

Returns:

  • (String) 


2905
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2905

required :id, String

#name ⇒ String?

Displayed on invoices. Will be passed through to the individual commits

Returns:

  • (String, nil) 


2981
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2981

optional :name, String

#netsuite_sales_order_id ⇒ String?

Will be passed down to the individual commits

Returns:

  • (String, nil) 


2987
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2987

optional :netsuite_sales_order_id, String

#priority ⇒ Float

Will be passed down to the individual commits

Returns:

  • (Float) 


2923
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2923

required :priority, Float

#product ⇒ MetronomeSDK::Models::ContractV2::RecurringCredit::Product

Returns:



2928
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2928

required :product, -> { MetronomeSDK::ContractV2::RecurringCredit::Product }

#proration ⇒ Symbol, ...

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Returns:



2994
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2994

optional :proration, enum: -> { MetronomeSDK::ContractV2::RecurringCredit::Proration }

#rate_type ⇒ Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::RateType

Whether the created commits will use the commit rate or list rate

Returns:



2934
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2934

required :rate_type, enum: -> { MetronomeSDK::ContractV2::RecurringCredit::RateType }

#recurrence_frequency ⇒ Symbol, ...

The frequency at which the recurring commits will be created. If not provided: - The commits will be created on the usage invoice frequency. If provided: - The period defined in the duration will correspond to this frequency. - Commits will be created aligned with the recurring commit’s starting_at rather than the usage invoice dates.

Returns:



3004
3005
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3004

optional :recurrence_frequency,
enum: -> { MetronomeSDK::ContractV2::RecurringCredit::RecurrenceFrequency }

#rollover_fraction ⇒ Float?

Will be passed down to the individual commits. This controls how much of an individual unexpired commit will roll over upon contract transition. Must be between 0 and 1.

Returns:

  • (Float, nil) 


3013
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3013

optional :rollover_fraction, Float

#specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifier>?

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.

Returns:



3021
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3021

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

#starting_at ⇒ Time

Determines the start time for the first commit

Returns:

  • (Time) 


2940
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 2940

required :starting_at, Time

#subscription_config ⇒ MetronomeSDK::Models::RecurringCommitSubscriptionConfig?

Attach a subscription to the recurring commit/credit.

Returns:



3027
 
# File 'lib/metronome_sdk/models/contract_v2.rb', line 3027

optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/contract_v2.rb', line 3122