Class: MetronomeSDK::Models::V2::ContractEditParams

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

Overview

See Also:

Defined Under Namespace

Classes: AddBillingProviderConfigurationUpdate, AddCommit, AddCredit, AddDiscount, AddOverride, AddProfessionalService, AddRecurringCommit, AddRecurringCredit, AddResellerRoyalty, AddScheduledCharge, AddSubscription, ArchiveCommit, ArchiveCredit, ArchiveScheduledCharge, RemoveOverride, UpdateCommit, UpdateCredit, UpdatePrepaidBalanceThresholdConfiguration, UpdateRecurringCommit, UpdateRecurringCredit, UpdateScheduledCharge, UpdateSpendThresholdConfiguration, UpdateSubscription

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(commit: nil, is_enabled: nil, payment_gate_config: nil, threshold_amount: nil) ⇒ Object

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

Parameters:




# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 1380

Instance Attribute Details

#add_billing_provider_configuration_update ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddBillingProviderConfigurationUpdate?

Update the billing provider configuration on the contract. Currently only supports adding a billing provider configuration to a contract that does not already have one.

Returns:



29
30
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 29

optional :add_billing_provider_configuration_update,
-> { MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate }

#add_commits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>?

Returns:



35
36
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 35

optional :add_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit] }

#add_credits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit>?

Returns:



41
42
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 41

optional :add_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCredit] }

#add_discounts ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddDiscount>?

Returns:



47
48
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 47

optional :add_discounts,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddDiscount] }

#add_overrides ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddOverride>?

Returns:



53
54
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 53

optional :add_overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddOverride] }

#add_prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2?

Returns:



59
60
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 59

optional :add_prepaid_balance_threshold_configuration,
-> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2 }

#add_professional_services ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddProfessionalService>?

This field’s availability is dependent on your client’s configuration.

Returns:



66
67
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 66

optional :add_professional_services,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddProfessionalService] }

#add_recurring_commits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit>?

Returns:



72
73
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 72

optional :add_recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCommit] }

#add_recurring_credits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit>?

Returns:



78
79
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 78

optional :add_recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCredit] }

#add_reseller_royalties ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddResellerRoyalty>?

Returns:



84
85
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 84

optional :add_reseller_royalties,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty] }

#add_scheduled_charges ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge>?

Returns:



90
91
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 90

optional :add_scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddScheduledCharge] }

#add_spend_threshold_configuration ⇒ MetronomeSDK::Models::SpendThresholdConfigurationV2?

Returns:



96
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 96

optional :add_spend_threshold_configuration, -> { MetronomeSDK::SpendThresholdConfigurationV2 }

#add_subscriptions ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::AddSubscription>?

Optional list of [subscriptions](docs.metronome.com/manage-product-access/create-subscription/) to add to the contract.

Returns:



104
105
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 104

optional :add_subscriptions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddSubscription] }

#allow_contract_ending_before_finalized_invoice ⇒ Boolean?

If true, allows setting the contract end date earlier than the end_timestamp of existing finalized invoices. Finalized invoices will be unchanged; if you want to incorporate the new end date, you can void and regenerate finalized usage invoices. Defaults to true.

Returns:

  • (Boolean, nil) 


114
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 114

optional :allow_contract_ending_before_finalized_invoice, MetronomeSDK::Internal::Type::Boolean

#archive_commits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCommit>?

IDs of commits to archive

Returns:



120
121
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 120

optional :archive_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveCommit] }

#archive_credits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCredit>?

IDs of credits to archive

Returns:



127
128
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 127

optional :archive_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveCredit] }

#archive_scheduled_charges ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveScheduledCharge>?

IDs of scheduled charges to archive

Returns:



134
135
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 134

optional :archive_scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge] }

#contract_id ⇒ String

ID of the contract being edited

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 15

required :contract_id, String

#customer_id ⇒ String

ID of the customer whose contract is being edited

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 21

required :customer_id, String

#remove_overrides ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::RemoveOverride>?

IDs of overrides to remove

Returns:



141
142
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 141

optional :remove_overrides,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::RemoveOverride] }

#uniqueness_key ⇒ String?

Optional uniqueness key to prevent duplicate contract edits.

Returns:

  • (String, nil) 


148
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 148

optional :uniqueness_key, String

#update_commits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit>?

Returns:



153
154
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 153

optional :update_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCommit] }

#update_contract_end_date ⇒ Time?

RFC 3339 timestamp indicating when the contract will end (exclusive).

Returns:

  • (Time, nil) 


160
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 160

optional :update_contract_end_date, Time, nil?: true

#update_contract_name ⇒ String?

Value to update the contract name to. If not provided, the contract name will remain unchanged.

Returns:

  • (String, nil) 


167
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 167

optional :update_contract_name, String, nil?: true

#update_credits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit>?

Returns:



172
173
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 172

optional :update_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateCredit] }

#update_prepaid_balance_threshold_configuration ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration?

Returns:



178
179
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 178

optional :update_prepaid_balance_threshold_configuration,
-> { MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration }

#update_recurring_commits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCommit>?

Edits to these recurring commits will only affect commits whose access schedules has not started. Expired commits, and commits with an active access schedule will remain unchanged.

Returns:



187
188
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 187

optional :update_recurring_commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateRecurringCommit] }

#update_recurring_credits ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateRecurringCredit>?

Edits to these recurring credits will only affect credits whose access schedules has not started. Expired credits, and credits with an active access schedule will remain unchanged.

Returns:



196
197
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 196

optional :update_recurring_credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateRecurringCredit] }

#update_scheduled_charges ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateScheduledCharge>?

Returns:



202
203
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 202

optional :update_scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge] }

#update_spend_threshold_configuration ⇒ MetronomeSDK::Models::V2::ContractEditParams::UpdateSpendThresholdConfiguration?

Returns:



208
209
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 208

optional :update_spend_threshold_configuration,
-> { MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration }

#update_subscriptions ⇒ Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription>?

Optional list of subscriptions to update.

Returns:



215
216
 
# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 215

optional :update_subscriptions,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::UpdateSubscription] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v2/contract_edit_params.rb', line 393