Class: MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit

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

Defined Under Namespace

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

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(credit_type_id:, quantity:, unit_price:) ⇒ Object

The amount the customer should be billed for the commit.

Parameters:

  • credit_type_id (String)
  • quantity (Float)
  • unit_price (Float) 



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

Instance Attribute Details

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

The amount of commit to grant.

Returns:



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

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

#applicable_product_ids ⇒ Array<String>?

Will be passed down to the individual commits

Returns:

  • (Array<String>, nil) 


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

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) 


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

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

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

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

Returns:



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

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

#description ⇒ String?

Returns:

  • (String, nil) 


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

optional :description, String

#duration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::Duration?

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

Returns:



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

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

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#invoice_amount ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::InvoiceAmount?

The amount the customer should be billed for the commit.

Returns:



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

optional :invoice_amount,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::InvoiceAmount }

#name ⇒ String?

Returns:

  • (String, nil) 


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

optional :name, String

#priority ⇒ Float

Returns:

  • (Float) 


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

required :priority, Float

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

Returns:



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

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



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

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

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

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

Returns:



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

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



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

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


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

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:



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

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

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

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

Returns:



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

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

#subscription_config ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::SubscriptionConfig?

Attach a subscription to the recurring commit/credit.

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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