Class: MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription

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: CollectionSchedule, QuantityManagementMode Classes: BillingCycleConfig, Duration, Proration, SeatConfig, StartingAtOffset, SubscriptionRate

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

Some parameter documentations has been truncated, see SeatConfig for more details.

Parameters:

  • seat_group_key (String) —

    The property name, sent on usage events, that identifies the seat ID associated




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

Instance Attribute Details

#billing_cycle_config ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig?

Returns:



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

optional :billing_cycle_config,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig }

#collection_schedule ⇒ Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::CollectionSchedule

Parameters:

  • value (MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::collection_schedule)

Returns:



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

required :collection_schedule,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::CollectionSchedule }

#custom_fields ⇒ Hash{Symbol=>String}?

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Returns:

  • (Hash{Symbol=>String}, nil) 


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

optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :description, String

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

Returns:



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

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

#fiat_credit_type_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :fiat_credit_type_id, String

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :id, String

#initial_quantity ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

optional :initial_quantity, Float

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :name, String

#proration ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::Proration

Parameters:

Returns:



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

required :proration,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::Proration }

#quantity_management_mode ⇒ Symbol, ...

Determines how the subscription's quantity is controlled. Defaults to QUANTITY_ONLY. QUANTITY_ONLY: The subscription quantity is specified directly on the subscription. initial_quantity must be provided with this option. Compatible with recurring commits/credits that use POOLED allocation. SEAT_BASED: Use when you want to pass specific seat identifiers (e.g. add user_123) to increment and decrement a subscription quantity, rather than directly providing the quantity. You must use a SEAT_BASED subscription to use a linked recurring credit with an allocation per seat. seat_config must be provided with this option.

Returns:



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

optional :quantity_management_mode,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::QuantityManagementMode }

#seat_config ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::SeatConfig?

Returns:



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

optional :seat_config,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::SeatConfig }

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::StartingAtOffset?

Returns:



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

optional :starting_at_offset,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::StartingAtOffset }

#subscription_rate ⇒ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::SubscriptionRate

Parameters:

Returns:



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

required :subscription_rate,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::SubscriptionRate }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {