Class: MetronomeSDK::Models::V1::Customers::CommitCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::Customers::CommitCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/customers/commit_create_params.rb

Overview

See Also:

• Resources::V1::Customers::Commits#create

Defined Under Namespace

Modules: RateType, Type Classes: AccessSchedule, InvoiceSchedule

Instance Attribute Summary

• #access_schedule ⇒ MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule

  Schedule for distributing the commit to the customer.

• #applicable_contract_ids ⇒ Array<String>^?

  Which contract the commit applies to.

• #applicable_product_ids ⇒ Array<String>^?

  Which products the commit applies to.

• #applicable_product_tags ⇒ Array<String>^?

  Which tags the commit applies to.

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

  Custom fields to be added eg.

• #customer_id ⇒ String
• #description ⇒ String^?

  Used only in UI/API.

• #invoice_contract_id ⇒ String^?

  The contract that this commit will be billed on.

• #invoice_schedule ⇒ MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule^?

  Required for “POSTPAID” commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount.

• #name ⇒ String^?

  displayed on invoices.

• #netsuite_sales_order_id ⇒ String^?

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

• #priority ⇒ Float

  If multiple credits or commits are applicable, the one with the lower priority will apply first.

• #product_id ⇒ String

  ID of the fixed product associated with the commit.

• #rate_type ⇒ Symbol, ...
• #salesforce_opportunity_id ⇒ String^?

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

• #specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifierInput>^?

  List of filters that determine what kind of customer usage draws down a commit or credit.

• #type ⇒ Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type
• #uniqueness_key ⇒ String^?

  Prevents the creation of duplicates.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(timestamp: , amount: nil, quantity: nil, unit_price: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see InvoiceSchedule::ScheduleItem for more details.

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(timestamp: , amount: nil, quantity: nil, unit_price: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem for more details.

Parameters:

• timestamp (Time) (defaults to: ) —

  timestamp of the scheduled event

• amount (Float) (defaults to: nil) —

  Amount for the charge. Can be provided instead of unit_price and quantity. If am

• quantity (Float) (defaults to: nil) —

  Quantity for the charge. Will be multiplied by unit_price to determine the amoun

• unit_price (Float) (defaults to: nil) —

  Unit price for the charge. Will be multiplied by quantity to determine the amoun

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 217

Instance Attribute Details

#access_schedule ⇒ MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule

Schedule for distributing the commit to the customer. For “POSTPAID” commits only one schedule item is allowed and amount must match invoice_schedule total.

Returns:

• (MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 17

required :access_schedule, -> { MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule }

#applicable_contract_ids ⇒ Array<String>^?

Which contract the commit applies to. If not provided, the commit applies to all contracts.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 48

optional :applicable_contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#applicable_product_ids ⇒ Array<String>^?

Which products the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 56

optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#applicable_product_tags ⇒ Array<String>^?

Which tags the commit applies to. If applicable_product_ids, applicable_product_tags or specifiers are not provided, the commit applies to all products.

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 64

optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

#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/v1/customers/commit_create_params.rb', line 70

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

#customer_id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 22

required :customer_id, String

#description ⇒ String^?

Used only in UI/API. It is not exposed to end customers.

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 76

optional :description, String

#invoice_contract_id ⇒ String^?

The contract that this commit will be billed on. This is required for “POSTPAID” commits and for “PREPAID” commits unless there is no invoice schedule above (i.e., the commit is ‘free’), or if do_not_invoice is set to true.

Returns:

• (String, nil)

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

optional :invoice_contract_id, String

#invoice_schedule ⇒ MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule^?

Required for “POSTPAID” commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount. Optional for “PREPAID” commits: if not provided, this will be a “complimentary” commit with no invoice.

Returns:

• (MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 93

optional :invoice_schedule, -> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule }

#name ⇒ String^?

displayed on invoices

Returns:

• (String, nil)

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

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/v1/customers/commit_create_params.rb', line 105

optional :netsuite_sales_order_id, String

#priority ⇒ Float

If multiple credits or commits are applicable, the one with the lower priority will apply first.

Returns:

• (Float)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 29

required :priority, Float

#product_id ⇒ String

ID of the fixed product associated with the commit. This is required because products are used to invoice the commit amount.

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 36

required :product_id, String

#rate_type ⇒ Symbol, ...

Returns:

• (Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 110

optional :rate_type, enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::RateType }

#salesforce_opportunity_id ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 116

optional :salesforce_opportunity_id, String

#specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifierInput>^?

List of filters that determine what kind of customer usage draws down a commit or credit. A customer’s usage needs to meet the condition of at least one of the specifiers to contribute to a commit’s or credit’s drawdown. This field cannot be used together with ‘applicable_product_ids` or `applicable_product_tags`.

Returns:

• (Array<MetronomeSDK::Models::CommitSpecifierInput>, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 125

optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }

#type ⇒ Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type

Returns:

• (Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 41

required :type, enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::Type }

#uniqueness_key ⇒ String^?

Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 134

optional :uniqueness_key, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/customers/commit_create_params.rb', line 232