Class: MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit

Defined in:

lib/metronome_sdk/models/v1/package_retrieve_response.rb,
sig/metronome_sdk/models/v1/package_retrieve_response.rbs

Defined Under Namespace

Modules: Proration, RateType, RecurrenceFrequency Classes: AccessAmount, CommitDuration, Duration, Product, ProrationRounding, StartingAtOffset, SubscriptionConfig

Instance Attribute Summary

• #access_amount ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount

  The amount of commit to grant.

• #applicable_product_ids ⇒ Array<String>^?

  Will be passed down to the individual commits.

• #applicable_product_tags ⇒ Array<String>^?

  Will be passed down to the individual commits.

• #commit_duration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::CommitDuration

  The amount of time each of the created commits will be valid for.

• #description ⇒ String^?
• #duration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Duration^?

  Offset relative to the recurring credit start that determines when the contract will stop creating recurring commits.

• #id ⇒ String
• #name ⇒ String^?
• #priority ⇒ Float
• #product ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Product
• #proration ⇒ Symbol, ...

  Determines whether the first and last commit will be prorated.

• #proration_rounding ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::ProrationRounding^?

  Rounding configuration for prorated recurring credit amounts.

• #rate_type ⇒ Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::RateType

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

• #recurrence_frequency ⇒ Symbol, ...

  The frequency at which the recurring commits will be created.

• #rollover_fraction ⇒ Float^?

  Will be passed down to the individual commits.

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

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

• #starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::StartingAtOffset

  Offset relative to the contract start date that determines the start time for the first commit.

• #subscription_config ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::SubscriptionConfig^?

  Attach a subscription to the recurring commit/credit.

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/v1/package_retrieve_response.rb', line 2027

Instance Attribute Details

#access_amount ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount

The amount of commit to grant.

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount)

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1911

required :access_amount,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount }

#applicable_product_ids ⇒ Array<String>^?

Will be passed down to the individual commits

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1951

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

#applicable_product_tags ⇒ Array<String>^?

Will be passed down to the individual commits

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1957

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

#commit_duration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::CommitDuration

The amount of time each of the created commits will be valid for

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::CommitDuration)

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::CommitDuration)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1918

required :commit_duration,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::CommitDuration }

#description ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1962

optional :description, String

#duration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Duration^?

Offset relative to the recurring credit start that determines when the contract will stop creating recurring commits. optional

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Duration, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1969

optional :duration,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Duration }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1905

required :id, String

#name ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1975

optional :name, String

#priority ⇒ Float

Parameters:

• value (Float)

Returns:

• (Float)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1924

required :priority, Float

#product ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Product

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Product)

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Product)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1929

required :product,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::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:

• (Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Proration, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1982

optional :proration,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::Proration }

#proration_rounding ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::ProrationRounding^?

Rounding configuration for prorated recurring credit amounts.

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::ProrationRounding, nil)

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::ProrationRounding, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1989

optional :proration_rounding,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::ProrationRounding },
nil?: true

#rate_type ⇒ Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::RateType

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

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::rate_type)

Returns:

• (Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::RateType)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1936

required :rate_type,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::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:

• (Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::RecurrenceFrequency, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 2001

optional :recurrence_frequency,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::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.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 2010

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:

• (Array<MetronomeSDK::Models::CommitSpecifier>, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 2018

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

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::StartingAtOffset

Offset relative to the contract start date that determines the start time for the first commit

Parameters:

• value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::StartingAtOffset)

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::StartingAtOffset)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1944

required :starting_at_offset,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::StartingAtOffset }

#subscription_config ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::SubscriptionConfig^?

Attach a subscription to the recurring commit/credit.

Returns:

• (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::SubscriptionConfig, nil)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 2024

optional :subscription_config,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::SubscriptionConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 2118

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v1/package_retrieve_response.rbs', line 2058

def to_hash: -> {