Class: MetronomeSDK::Models::V1::ContractAmendParams

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

Overview

Defined Under Namespace

Classes: Commit, Credit, Discount, Override, ProfessionalService, ResellerRoyalty, ScheduledCharge

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(gcp_account_id: nil, gcp_offer_id: nil) ⇒ Object

Parameters:

  • gcp_account_id (String) (defaults to: nil)
  • gcp_offer_id (String) (defaults to: nil)


# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 1107


Instance Attribute Details

#commitsArray<MetronomeSDK::Models::V1::ContractAmendParams::Commit>?



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

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

#contract_idString

ID of the contract to amend

Returns:

  • (String)


15
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 15

required :contract_id, String

#creditsArray<MetronomeSDK::Models::V1::ContractAmendParams::Credit>?



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

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

#custom_fieldsHash{Symbol=>String}?

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

Returns:

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


45
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 45

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

#customer_idString

ID of the customer whose contract is to be amended

Returns:

  • (String)


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

required :customer_id, String

#discountsArray<MetronomeSDK::Models::V1::ContractAmendParams::Discount>?

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



51
52
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 51

optional :discounts,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount] }

#netsuite_sales_order_idString?

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

Returns:

  • (String, nil)


58
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 58

optional :netsuite_sales_order_id, String

#overridesArray<MetronomeSDK::Models::V1::ContractAmendParams::Override>?



63
64
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 63

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

#professional_servicesArray<MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService>?

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



70
71
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 70

optional :professional_services,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService] }

#reseller_royaltiesArray<MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty>?

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



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

optional :reseller_royalties,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty] }

#salesforce_opportunity_idString?

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

Returns:

  • (String, nil)


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

optional :salesforce_opportunity_id, String

#scheduled_chargesArray<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge>?



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

optional :scheduled_charges,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge] }

#starting_atTime

inclusive start time for the amendment

Returns:

  • (Time)


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

required :starting_at, Time

#total_contract_valueFloat?

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

Returns:

  • (Float, nil)


96
# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 96

optional :total_contract_value, Float

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/metronome_sdk/models/v1/contract_amend_params.rb', line 720