Class: Increase::Models::CardPurchaseSupplement::LineItem

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_purchase_supplement.rb

Defined Under Namespace

Modules: DetailIndicator, DiscountTreatmentCode

Instance Attribute Summary collapse

Class Method 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:, detail_indicator:, discount_amount:, discount_currency:, discount_treatment_code:, item_commodity_code:, item_descriptor:, item_quantity:, product_code:, sales_tax_amount:, sales_tax_currency:, sales_tax_rate:, total_amount:, total_amount_currency:, unit_cost:, unit_cost_currency:, unit_of_measure_code:) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CardPurchaseSupplement::LineItem for more details.

Parameters:

  • id (String) —

    The Card Purchase Supplement Line Item identifier.

  • detail_indicator (Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DetailIndicator, nil) —

    Indicates the type of line item.

  • discount_amount (Integer, nil) —

    Discount amount for this specific line item.

  • discount_currency (String, nil) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the discount.

  • discount_treatment_code (Symbol, Increase::Models::CardPurchaseSupplement::LineItem::DiscountTreatmentCode, nil) —

    Indicates how the merchant applied the discount for this specific line item.

  • item_commodity_code (String, nil) —

    Code used to categorize the purchase item.

  • item_descriptor (String, nil) —

    Description of the purchase item.

  • item_quantity (String, nil) —

    The number of units of the product being purchased.

  • product_code (String, nil) —

    Code used to categorize the product being purchased.

  • sales_tax_amount (Integer, nil) —

    Sales tax amount for this line item.

  • sales_tax_currency (String, nil) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the sales tax as

  • sales_tax_rate (String, nil) —

    Sales tax rate for this line item.

  • total_amount (Integer, nil) —

    Total amount of all line items.

  • total_amount_currency (String, nil) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total amount

  • unit_cost (String, nil) —

    Cost of line item per unit of measure, in major units.

  • unit_cost_currency (String, nil) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the unit cost.

  • unit_of_measure_code (String, nil) —

    Code indicating unit of measure (gallons, etc.).




# File 'lib/increase/models/card_purchase_supplement.rb', line 369

Instance Attribute Details

#detail_indicator ⇒ Symbol, ...

Indicates the type of line item.

Returns:



271
272
273
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 271

required :detail_indicator,
enum: -> { Increase::CardPurchaseSupplement::LineItem::DetailIndicator },
nil?: true

#discount_amount ⇒ Integer?

Discount amount for this specific line item.

Returns:

  • (Integer, nil) 


279
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 279

required :discount_amount, Integer, nil?: true

#discount_currency ⇒ String?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the discount.

Returns:

  • (String, nil) 


285
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 285

required :discount_currency, String, nil?: true

#discount_treatment_code ⇒ Symbol, ...

Indicates how the merchant applied the discount for this specific line item.

Returns:



291
292
293
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 291

required :discount_treatment_code,
enum: -> { Increase::CardPurchaseSupplement::LineItem::DiscountTreatmentCode },
nil?: true

#id ⇒ String

The Card Purchase Supplement Line Item identifier.

Returns:

  • (String) 


265
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 265

required :id, String

#item_commodity_code ⇒ String?

Code used to categorize the purchase item.

Returns:

  • (String, nil) 


299
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 299

required :item_commodity_code, String, nil?: true

#item_descriptor ⇒ String?

Description of the purchase item.

Returns:

  • (String, nil) 


305
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 305

required :item_descriptor, String, nil?: true

#item_quantity ⇒ String?

The number of units of the product being purchased.

Returns:

  • (String, nil) 


311
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 311

required :item_quantity, String, nil?: true

#product_code ⇒ String?

Code used to categorize the product being purchased.

Returns:

  • (String, nil) 


317
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 317

required :product_code, String, nil?: true

#sales_tax_amount ⇒ Integer?

Sales tax amount for this line item.

Returns:

  • (Integer, nil) 


323
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 323

required :sales_tax_amount, Integer, nil?: true

#sales_tax_currency ⇒ String?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the sales tax assessed.

Returns:

  • (String, nil) 


330
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 330

required :sales_tax_currency, String, nil?: true

#sales_tax_rate ⇒ String?

Sales tax rate for this line item.

Returns:

  • (String, nil) 


336
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 336

required :sales_tax_rate, String, nil?: true

#total_amount ⇒ Integer?

Total amount of all line items.

Returns:

  • (Integer, nil) 


342
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 342

required :total_amount, Integer, nil?: true

#total_amount_currency ⇒ String?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the total amount.

Returns:

  • (String, nil) 


349
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 349

required :total_amount_currency, String, nil?: true

#unit_cost ⇒ String?

Cost of line item per unit of measure, in major units.

Returns:

  • (String, nil) 


355
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 355

required :unit_cost, String, nil?: true

#unit_cost_currency ⇒ String?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the unit cost.

Returns:

  • (String, nil) 


361
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 361

required :unit_cost_currency, String, nil?: true

#unit_of_measure_code ⇒ String?

Code indicating unit of measure (gallons, etc.).

Returns:

  • (String, nil) 


367
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 367

required :unit_of_measure_code, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_purchase_supplement.rb', line 422