Class: Increase::Models::CardPurchaseSupplement

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

Overview

See Also:

Defined Under Namespace

Modules: Type Classes: Invoice, LineItem

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: , card_payment_id: , invoice: , line_items: , transaction_id: , type: ) ⇒ Object

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

Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.

Parameters:




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

Instance Attribute Details

#card_payment_id ⇒ String?

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String, nil) 


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

required :card_payment_id, String, nil?: true

#id ⇒ String

The Card Purchase Supplement identifier.

Returns:

  • (String) 


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

required :id, String

#invoice ⇒ Increase::Models::CardPurchaseSupplement::Invoice?

Invoice-level information about the payment.

Returns:



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

required :invoice, -> { Increase::CardPurchaseSupplement::Invoice }, nil?: true

#line_items ⇒ Array<Increase::Models::CardPurchaseSupplement::LineItem>?

Line item information, such as individual products purchased.

Returns:



29
30
31
 
# File 'lib/increase/models/card_purchase_supplement.rb', line 29

required :line_items,
-> { Increase::Internal::Type::ArrayOf[Increase::CardPurchaseSupplement::LineItem] },
nil?: true

#transaction_id ⇒ String

The ID of the transaction.

Returns:

  • (String) 


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

required :transaction_id, String

#type ⇒ Symbol, Increase::Models::CardPurchaseSupplement::Type

A constant representing the object’s type. For this resource it will always be ‘card_purchase_supplement`.

Returns:



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

required :type, enum: -> { Increase::CardPurchaseSupplement::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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