Class: MetronomeSDK::Models::V1::PackageCreateParams
Overview
Defined Under Namespace
Modules: BillingProvider, DeliveryMethod, MultiplierOverridePrioritization, ScheduledChargesOnUsageInvoices
Classes: Alias, Commit, Credit, Duration, Override, RecurringCommit, RecurringCredit, ScheduledCharge, SpendTracker, Subscription, UsageStatementSchedule
Constant Summary
collapse
- MetronomeSDK =
Instance Attribute Summary collapse
#request_options
Class Method Summary
collapse
Instance Method Summary
collapse
dump_request
included
==, #==, #[], 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
#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info
#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type
Constructor Details
#initialize(name:, ending_before: nil, starting_at: nil) ⇒ Object
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 223
|
Instance Attribute Details
Reference this alias when creating a contract. If the same alias is assigned to
multiple packages, it will reference the package to which it was most recently
assigned. It is not exposed to end customers.
22
23
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 22
optional :aliases,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Alias] }
|
#billing_provider ⇒ Symbol, ...
28
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 28
optional :billing_provider, enum: -> { MetronomeSDK::V1::PackageCreateParams::BillingProvider }
|
33
34
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 33
optional :commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Commit] }
|
#contract_name ⇒ String?
39
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 39
optional :contract_name, String
|
44
45
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 44
optional :credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Credit] }
|
#delivery_method ⇒ Symbol, ...
50
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 50
optional :delivery_method, enum: -> { MetronomeSDK::V1::PackageCreateParams::DeliveryMethod }
|
55
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 55
optional :duration, -> { MetronomeSDK::V1::PackageCreateParams::Duration }
|
#multiplier_override_prioritization ⇒ Symbol, ...
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. If tiered overrides are used, prioritization must be explicit.
64
65
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 64
optional :multiplier_override_prioritization,
enum: -> { MetronomeSDK::V1::PackageCreateParams::MultiplierOverridePrioritization }
|
#name ⇒ String
14
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 14
required :name, String
|
#net_payment_terms_days ⇒ Float?
70
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 70
optional :net_payment_terms_days, Float
|
75
76
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 75
optional :overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Override] }
|
81
82
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 81
optional :prepaid_balance_threshold_configuration,
-> { MetronomeSDK::PrepaidBalanceThresholdConfiguration }
|
#rate_card_alias ⇒ String?
Selects the rate card linked to the specified alias as of the contract's start
date.
89
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 89
optional :rate_card_alias, String
|
#rate_card_id ⇒ String?
94
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 94
optional :rate_card_id, String
|
99
100
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 99
optional :recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::RecurringCommit] }
|
105
106
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 105
optional :recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::RecurringCredit] }
|
111
112
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 111
optional :scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::ScheduledCharge] }
|
#scheduled_charges_on_usage_invoices ⇒ Symbol, ...
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.
122
123
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 122
optional :scheduled_charges_on_usage_invoices,
enum: -> { MetronomeSDK::V1::PackageCreateParams::ScheduledChargesOnUsageInvoices }
|
128
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 128
optional :spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfiguration }
|
133
134
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 133
optional :spend_trackers,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::SpendTracker] }
|
139
140
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 139
optional :subscriptions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Subscription] }
|
#uniqueness_key ⇒ String?
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.
148
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 148
optional :uniqueness_key, String
|
153
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 153
optional :usage_statement_schedule, -> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule }
|
Class Method Details
.values ⇒ Array<Symbol>
|
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 238
|
Instance Method Details
#to_hash ⇒ {
187
|
# File 'sig/metronome_sdk/models/v1/package_create_params.rbs', line 187
def to_hash: -> {
|