Class: Orb::Models::CreditNote::LineItem::Discount

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

Defined Under Namespace

Modules: DiscountType

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(id: , amount_applied: , applies_to_price_ids: , discount_type: , percentage_discount: , amount_discount: nil, reason: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: )
  • amount_applied (String) (defaults to: )
  • applies_to_price_ids (Array<String>) (defaults to: )
  • discount_type (Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType) (defaults to: )
  • percentage_discount (Float) (defaults to: )
  • amount_discount (String, nil) (defaults to: nil)
  • reason (String, nil) (defaults to: nil) 


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/orb/models/credit_note.rb', line 217

class Discount < Orb::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

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

  # @!attribute applies_to_price_ids
  #
  #   @return [Array<String>]
  required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]

  # @!attribute discount_type
  #
  #   @return [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
  required :discount_type, enum: -> { Orb::CreditNote::LineItem::Discount::DiscountType }

  # @!attribute percentage_discount
  #
  #   @return [Float]
  required :percentage_discount, Float

  # @!attribute amount_discount
  #
  #   @return [String, nil]
  optional :amount_discount, String, nil?: true

  # @!attribute reason
  #
  #   @return [String, nil]
  optional :reason, String, nil?: true

  # @!method initialize(id:, amount_applied:, applies_to_price_ids:, discount_type:, percentage_discount:, amount_discount: nil, reason: nil)
  #   @param id [String]
  #   @param amount_applied [String]
  #   @param applies_to_price_ids [Array<String>]
  #   @param discount_type [Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType]
  #   @param percentage_discount [Float]
  #   @param amount_discount [String, nil]
  #   @param reason [String, nil]

  # @see Orb::Models::CreditNote::LineItem::Discount#discount_type
  module DiscountType
    extend Orb::Internal::Type::Enum

    PERCENTAGE = :percentage
    AMOUNT = :amount

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

Instance Attribute Details

#amount_applied ⇒ String

Returns:

  • (String) 


226
 
# File 'lib/orb/models/credit_note.rb', line 226

required :amount_applied, String

#amount_discount ⇒ String?

Returns:

  • (String, nil) 


246
 
# File 'lib/orb/models/credit_note.rb', line 246

optional :amount_discount, String, nil?: true

#applies_to_price_ids ⇒ Array<String>

Returns:

  • (Array<String>) 


231
 
# File 'lib/orb/models/credit_note.rb', line 231

required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]

#discount_type ⇒ Symbol, Orb::Models::CreditNote::LineItem::Discount::DiscountType

Returns:



236
 
# File 'lib/orb/models/credit_note.rb', line 236

required :discount_type, enum: -> { Orb::CreditNote::LineItem::Discount::DiscountType }

#id ⇒ String

Returns:

  • (String) 


221
 
# File 'lib/orb/models/credit_note.rb', line 221

required :id, String

#percentage_discount ⇒ Float

Returns:

  • (Float) 


241
 
# File 'lib/orb/models/credit_note.rb', line 241

required :percentage_discount, Float

#reason ⇒ String?

Returns:

  • (String, nil) 


251
 
# File 'lib/orb/models/credit_note.rb', line 251

optional :reason, String, nil?: true