Class: Orb::Models::InvoiceLineItemCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/invoice_line_item_create_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(amount: , end_date: , invoice_id: , name: , quantity: , start_date: , request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::InvoiceLineItemCreateParams for more details.

Parameters:

  • amount (String) (defaults to: ) —

    The total amount in the invoice’s currency to add to the line item.

  • end_date (Date) (defaults to: ) —

    A date string to specify the line item’s end date in the customer’s timezone.

  • invoice_id (String) (defaults to: ) —

    The id of the Invoice to add this line item.

  • name (String) (defaults to: ) —

    The item name associated with this line item. If an item with the same name exis

  • quantity (Float) (defaults to: ) —

    The number of units on the line item

  • start_date (Date) (defaults to: ) —

    A date string to specify the line item’s start date in the customer’s timezone.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/invoice_line_item_create_params.rb', line 47

Instance Attribute Details

#amount ⇒ String

The total amount in the invoice’s currency to add to the line item.

Returns:

  • (String) 


14
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 14

required :amount, String

#end_date ⇒ Date

A date string to specify the line item’s end date in the customer’s timezone.

Returns:

  • (Date) 


20
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 20

required :end_date, Date

#invoice_id ⇒ String

The id of the Invoice to add this line item.

Returns:

  • (String) 


26
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 26

required :invoice_id, String

#name ⇒ String

The item name associated with this line item. If an item with the same name exists in Orb, that item will be associated with the line item.

Returns:

  • (String) 


33
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 33

required :name, String

#quantity ⇒ Float

The number of units on the line item

Returns:

  • (Float) 


39
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 39

required :quantity, Float

#start_date ⇒ Date

A date string to specify the line item’s start date in the customer’s timezone.

Returns:

  • (Date) 


45
 
# File 'lib/orb/models/invoice_line_item_create_params.rb', line 45

required :start_date, Date