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

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

Overview

See Also:

Defined Under Namespace

Modules: BillingProvider, DeliveryMethod, MultiplierOverridePrioritization, ScheduledChargesOnUsageInvoices Classes: Alias, Commit, Credit, Duration, Override, RecurringCommit, RecurringCredit, ScheduledCharge, Subscription, UsageStatementSchedule

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

Parameters:

  • is_prorated (Boolean)

    Indicates whether a mid-period seat increase should be prorated.



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

Instance Attribute Details

#aliasesArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Alias>?



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

optional :aliases,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Alias] }

#archived_atTime?

Returns:

  • (Time, nil)


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

optional :archived_at, Time

#billing_providerSymbol, ...



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

optional :billing_provider,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::BillingProvider }

#commitsArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit>



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

required :commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit] }

#contract_nameString?

The name to use for contracts created from this package.

Returns:

  • (String, nil)


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

optional :contract_name, String

#created_atTime

Returns:

  • (Time)


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

required :created_at, Time

#created_byString

Returns:

  • (String)


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

required :created_by, String

#creditsArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit>?



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

optional :credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit] }

#delivery_methodSymbol, ...



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

optional :delivery_method,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::DeliveryMethod }

#durationMetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Duration?



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

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

#idString

Returns:

  • (String)


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

required :id, String

#multiplier_override_prioritizationSymbol, ...

Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list prices automatically. EXPLICIT prioritization requires specifying priorities for each multiplier; the one with the lowest priority value will be prioritized first.



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

optional :multiplier_override_prioritization,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::MultiplierOverridePrioritization }

#nameString?

Returns:

  • (String, nil)


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

optional :name, String

#net_payment_terms_daysFloat?

Returns:

  • (Float, nil)


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

optional :net_payment_terms_days, Float

#overridesArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Override>



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

required :overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Override] }

#prepaid_balance_threshold_configurationMetronomeSDK::Models::PrepaidBalanceThresholdConfiguration?



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

optional :prepaid_balance_threshold_configuration,
-> { MetronomeSDK::PrepaidBalanceThresholdConfiguration }

#rate_card_idString?

Returns:

  • (String, nil)


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

optional :rate_card_id, String

#recurring_commitsArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit>?



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

optional :recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit] }

#recurring_creditsArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit>?



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

optional :recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit] }

#scheduled_chargesArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::ScheduledCharge>



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

required :scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::ScheduledCharge] }

#scheduled_charges_on_usage_invoicesSymbol, ...

Determines which scheduled and commit charges to consolidate onto the Contract’s usage invoice. The charge’s ‘timestamp` must match the usage invoice’s ‘ending_before` date for consolidation to occur. This field cannot be modified after a Contract has been created. If this field is omitted, charges will appear on a separate invoice from usage charges.



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

optional :scheduled_charges_on_usage_invoices,
enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::ScheduledChargesOnUsageInvoices }

#spend_threshold_configurationMetronomeSDK::Models::SpendThresholdConfiguration?



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

optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }

#subscriptionsArray<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription>?



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

optional :subscriptions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription] }

#uniqueness_keyString?

Prevents the creation of duplicates. If a request to create a record is made with a previously used uniqueness key, a new record will not be created and the request will fail with a 409 error.

Returns:

  • (String, nil)


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

optional :uniqueness_key, String

#usage_statement_scheduleMetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule



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

required :usage_statement_schedule,
-> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


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