Class: Orb::Models::InvoiceCreateParams::LineItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/invoice_create_params.rb

Defined Under Namespace

Modules: ModelType

Instance Attribute Summary collapse

Instance Method Summary collapse

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(end_date: , item_id: , model_type: , name: , quantity: , start_date: , unit_config: ) ⇒ Object

Parameters:

  • end_date (Date) (defaults to: ) —

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

  • item_id (String) (defaults to: )
  • model_type (Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType) (defaults to: )
  • name (String) (defaults to: ) —

    The name of the line item.

  • 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.

  • unit_config (Orb::Models::UnitConfig) (defaults to: ) 


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/orb/models/invoice_create_params.rb', line 106

class LineItem < Orb::Internal::Type::BaseModel
  # @!attribute end_date
  #   A date string to specify the line item's end date in the customer's timezone.
  #
  #   @return [Date]
  required :end_date, Date

  # @!attribute item_id
  #
  #   @return [String]
  required :item_id, String

  # @!attribute model_type
  #
  #   @return [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
  required :model_type, enum: -> { Orb::InvoiceCreateParams::LineItem::ModelType }

  # @!attribute name
  #   The name of the line item.
  #
  #   @return [String]
  required :name, String

  # @!attribute quantity
  #   The number of units on the line item
  #
  #   @return [Float]
  required :quantity, Float

  # @!attribute start_date
  #   A date string to specify the line item's start date in the customer's timezone.
  #
  #   @return [Date]
  required :start_date, Date

  # @!attribute unit_config
  #
  #   @return [Orb::Models::UnitConfig]
  required :unit_config, -> { Orb::UnitConfig }

  # @!method initialize(end_date:, item_id:, model_type:, name:, quantity:, start_date:, unit_config:)
  #   @param end_date [Date] A date string to specify the line item's end date in the customer's timezone.
  #
  #   @param item_id [String]
  #
  #   @param model_type [Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType]
  #
  #   @param name [String] The name of the line item.
  #
  #   @param quantity [Float] The number of units on the line item
  #
  #   @param start_date [Date] A date string to specify the line item's start date in the customer's timezone.
  #
  #   @param unit_config [Orb::Models::UnitConfig]

  # @see Orb::Models::InvoiceCreateParams::LineItem#model_type
  module ModelType
    extend Orb::Internal::Type::Enum

    UNIT = :unit

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#end_date ⇒ Date

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

Returns:

  • (Date) 


111
 
# File 'lib/orb/models/invoice_create_params.rb', line 111

required :end_date, Date

#item_id ⇒ String

Returns:

  • (String) 


116
 
# File 'lib/orb/models/invoice_create_params.rb', line 116

required :item_id, String

#model_type ⇒ Symbol, Orb::Models::InvoiceCreateParams::LineItem::ModelType

Returns:



121
 
# File 'lib/orb/models/invoice_create_params.rb', line 121

required :model_type, enum: -> { Orb::InvoiceCreateParams::LineItem::ModelType }

#name ⇒ String

The name of the line item.

Returns:

  • (String) 


127
 
# File 'lib/orb/models/invoice_create_params.rb', line 127

required :name, String

#quantity ⇒ Float

The number of units on the line item

Returns:

  • (Float) 


133
 
# File 'lib/orb/models/invoice_create_params.rb', line 133

required :quantity, Float

#start_date ⇒ Date

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

Returns:

  • (Date) 


139
 
# File 'lib/orb/models/invoice_create_params.rb', line 139

required :start_date, Date

#unit_config ⇒ Orb::Models::UnitConfig

Returns:



144
 
# File 'lib/orb/models/invoice_create_params.rb', line 144

required :unit_config, -> { Orb::UnitConfig }