Class: Lithic::Models::CardBulkOrder

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/card_bulk_order.rb

Overview

See Also:

Defined Under Namespace

Modules: ShippingMethod, Status

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(token:, card_tokens:, created:, customer_product_id:, shipping_address:, shipping_method:, status:, updated:) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::CardBulkOrder for more details.

Represents a bulk order for physical card shipments

Parameters:

  • token (String) —

    Globally unique identifier for the bulk order

  • card_tokens (Array<String>) —

    List of card tokens associated with this bulk order

  • created (Time) —

    An RFC 3339 timestamp for when the bulk order was created. UTC time zone

  • customer_product_id (String, nil) —

    Customer-specified product configuration for physical card manufacturing. This m

  • shipping_address (Object) —

    Shipping address for all cards in this bulk order

  • shipping_method (Symbol, Lithic::Models::CardBulkOrder::ShippingMethod) —

    Shipping method for all cards in this bulk order

  • status (Symbol, Lithic::Models::CardBulkOrder::Status) —

    Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED in

  • updated (Time) —

    An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone




# File 'lib/lithic/models/card_bulk_order.rb', line 57

Instance Attribute Details

#card_tokens ⇒ Array<String>

List of card tokens associated with this bulk order

Returns:

  • (Array<String>) 


17
 
# File 'lib/lithic/models/card_bulk_order.rb', line 17

required :card_tokens, Lithic::Internal::Type::ArrayOf[String]

#created ⇒ Time

An RFC 3339 timestamp for when the bulk order was created. UTC time zone

Returns:

  • (Time) 


23
 
# File 'lib/lithic/models/card_bulk_order.rb', line 23

required :created, Time

#customer_product_id ⇒ String?

Customer-specified product configuration for physical card manufacturing. This must be configured with Lithic before use

Returns:

  • (String, nil) 


30
 
# File 'lib/lithic/models/card_bulk_order.rb', line 30

required :customer_product_id, String, nil?: true

#shipping_address ⇒ Object

Shipping address for all cards in this bulk order

Returns:

  • (Object) 


36
 
# File 'lib/lithic/models/card_bulk_order.rb', line 36

required :shipping_address, Lithic::Internal::Type::Unknown

#shipping_method ⇒ Symbol, Lithic::Models::CardBulkOrder::ShippingMethod

Shipping method for all cards in this bulk order

Returns:



42
 
# File 'lib/lithic/models/card_bulk_order.rb', line 42

required :shipping_method, enum: -> { Lithic::CardBulkOrder::ShippingMethod }

#status ⇒ Symbol, Lithic::Models::CardBulkOrder::Status

Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED indicates the order is finalized and no more cards can be added

Returns:



49
 
# File 'lib/lithic/models/card_bulk_order.rb', line 49

required :status, enum: -> { Lithic::CardBulkOrder::Status }

#token ⇒ String

Globally unique identifier for the bulk order

Returns:

  • (String) 


11
 
# File 'lib/lithic/models/card_bulk_order.rb', line 11

required :token, String

#updated ⇒ Time

An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone

Returns:

  • (Time) 


55
 
# File 'lib/lithic/models/card_bulk_order.rb', line 55

required :updated, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/card_bulk_order.rb', line 87