Class: MetronomeSDK::Models::V1::PackageCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/package_create_params.rb

Overview

See Also:

Defined Under Namespace

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

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name:, ending_before: nil, starting_at: nil) ⇒ Object

Parameters:

  • name (String)
  • ending_before (Time) (defaults to: nil)
  • starting_at (Time) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 222

Instance Attribute Details

#aliases ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::Alias>?

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.

Returns:



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_anchor_date ⇒ Symbol, ...

Returns:



28
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 28

optional :billing_anchor_date, enum: -> { MetronomeSDK::V1::PackageCreateParams::BillingAnchorDate }

#billing_provider ⇒ Symbol, ...

Returns:



33
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 33

optional :billing_provider, enum: -> { MetronomeSDK::V1::PackageCreateParams::BillingProvider }

#commits ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::Commit>?

Returns:



38
39
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 38

optional :commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Commit] }

#contract_name ⇒ String?

Returns:

  • (String, nil) 


44
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 44

optional :contract_name, String

#credits ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::Credit>?

Returns:



49
50
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 49

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

#delivery_method ⇒ Symbol, ...

Returns:



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

optional :delivery_method, enum: -> { MetronomeSDK::V1::PackageCreateParams::DeliveryMethod }

#duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::Duration?

Returns:



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

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.

Returns:



69
70
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 69

optional :multiplier_override_prioritization,
enum: -> { MetronomeSDK::V1::PackageCreateParams::MultiplierOverridePrioritization }

#name ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 14

required :name, String

#net_payment_terms_days ⇒ Float?

Returns:

  • (Float, nil) 


75
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 75

optional :net_payment_terms_days, Float

#overrides ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::Override>?

Returns:



80
81
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 80

optional :overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PackageCreateParams::Override] }

#prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration?

Returns:



86
87
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 86

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.

Returns:

  • (String, nil) 


94
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 94

optional :rate_card_alias, String

#rate_card_id ⇒ String?

Returns:

  • (String, nil) 


99
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 99

optional :rate_card_id, String

#recurring_commits ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::RecurringCommit>?

Returns:



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

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

#recurring_credits ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit>?

Returns:



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

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

#scheduled_charges ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::ScheduledCharge>?

Returns:



116
117
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 116

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.

Returns:



127
128
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 127

optional :scheduled_charges_on_usage_invoices,
enum: -> { MetronomeSDK::V1::PackageCreateParams::ScheduledChargesOnUsageInvoices }

#spend_threshold_configuration ⇒ MetronomeSDK::Models::SpendThresholdConfiguration?

Returns:



133
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 133

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

#subscriptions ⇒ Array<MetronomeSDK::Models::V1::PackageCreateParams::Subscription>?

Returns:



138
139
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 138

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.

Returns:

  • (String, nil) 


147
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 147

optional :uniqueness_key, String

#usage_statement_schedule ⇒ MetronomeSDK::Models::V1::PackageCreateParams::UsageStatementSchedule?

Returns:



152
 
# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 152

optional :usage_statement_schedule, -> { MetronomeSDK::V1::PackageCreateParams::UsageStatementSchedule }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 234