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, Shipping

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(customer_reference_number:, destination_address:, destination_country_code:, destination_postal_code:, destination_receiver_name:, discount_amount:, net_amount:, number_of_packages:, origin_address:, origin_country_code:, origin_postal_code:, origin_sender_name:, pick_up_date:, service_description:, service_level_code:, shipping_courier_name:, tax_amount:, tracking_number:, unit_of_measure:, weight:) ⇒ Object

Shipping information for the purchase.

Parameters:

  • customer_reference_number (String, nil) —

    The customer reference number.

  • destination_address (String, nil) —

    Address of the destination.

  • destination_country_code (String, nil) —

    Country code of the destination.

  • destination_postal_code (String, nil) —

    Postal code of the destination.

  • destination_receiver_name (String, nil) —

    Name of the receiver at the destination.

  • discount_amount (Integer, nil) —

    Discount amount for the shipment.

  • net_amount (Integer, nil) —

    Net shipping amount.

  • number_of_packages (Integer, nil) —

    Number of packages shipped.

  • origin_address (String, nil) —

    Address of the origin.

  • origin_country_code (String, nil) —

    Country code of the origin.

  • origin_postal_code (String, nil) —

    Postal code of the origin.

  • origin_sender_name (String, nil) —

    Name of the sender at the origin.

  • pick_up_date (Date, nil) —

    Date the shipment should be picked up.

  • service_description (String, nil) —

    Description of the shipping service.

  • service_level_code (String, nil) —

    Service level code for the shipment.

  • shipping_courier_name (String, nil) —

    Name of the shipping courier.

  • tax_amount (Integer, nil) —

    Tax amount for the shipment.

  • tracking_number (String, nil) —

    Tracking number for the shipment.

  • unit_of_measure (String, nil) —

    Unit of measure for the shipment weight.

  • weight (String, nil) —

    Weight of the shipment.




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

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

#shipping ⇒ Increase::Models::CardPurchaseSupplement::Shipping?

Shipping information for the purchase.

Returns:



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

required :shipping, -> { Increase::CardPurchaseSupplement::Shipping }, nil?: true

#transaction_id ⇒ String

The ID of the transaction.

Returns:

  • (String) 


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

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:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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