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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge

Defined in:

lib/metronome_sdk/models/v2/contract_edit_params.rb

Defined Under Namespace

Classes: Schedule

Instance Attribute Summary

• #custom_fields ⇒ Hash{Symbol=>String}^?

  Custom fields to be added eg.

• #name ⇒ String^?

  displayed on invoices.

• #netsuite_sales_order_id ⇒ String^?

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

• #product_id ⇒ String
• #schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule

  Must provide either schedule_items or recurring_schedule.

Instance Method Summary

• #initialize(product_id: , schedule: , custom_fields: nil, name: nil, netsuite_sales_order_id: nil) ⇒ Object constructor

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(product_id: , schedule: , custom_fields: nil, name: nil, netsuite_sales_order_id: nil) ⇒ Object

Parameters:

• product_id (String) (defaults to: )
• schedule (MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule) (defaults to: ) —

  Must provide either schedule_items or recurring_schedule.

• custom_fields (Hash{Symbol=>String}) (defaults to: nil) —

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

• name (String) (defaults to: nil) —

  displayed on invoices

• netsuite_sales_order_id (String) (defaults to: nil) —

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

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

Instance Attribute Details

#custom_fields ⇒ Hash{Symbol=>String}^?

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

Returns:

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

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

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

#name ⇒ String^?

displayed on invoices

Returns:

• (String, nil)

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

optional :name, String

#netsuite_sales_order_id ⇒ String^?

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

Returns:

• (String, nil)

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

optional :netsuite_sales_order_id, String

#product_id ⇒ String

Returns:

• (String)

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

required :product_id, String

#schedule ⇒ MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule

Must provide either schedule_items or recurring_schedule.

Returns:

• (MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule)

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

required :schedule, -> { MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule }