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

Inherits:
Internal::Type::BaseModel show all
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, InvoiceAmount, Product, ProrationRounding, 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 1494

Instance Attribute Details

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

The amount of commit to grant.

Parameters:

Returns:



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

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

#applicable_product_ids ⇒ Array<String>?

Will be passed down to the individual commits

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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) 


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

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

Parameters:

Returns:



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

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

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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:



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

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

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

The amount the customer should be billed for the commit.

Returns:



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

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

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :name, String

#priority ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


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

required :priority, Float

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

Parameters:

Returns:



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

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:



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

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

#proration_rounding ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::ProrationRounding?

Rounding configuration for prorated recurring commit amounts.

Parameters:

Returns:



1456
1457
1458
 
# File 'lib/metronome_sdk/models/v1/package_retrieve_response.rb', line 1456

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

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

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

Parameters:

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

Returns:



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

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:



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

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.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

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:



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

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

Parameters:

Returns:



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

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:



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

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 1587

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {