Class: Increase::Models::PhysicalCard

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/physical_card.rb,
sig/increase/models/physical_card.rbs

Overview

See Also:

  • Increase::Resources::PhysicalCards#create

Defined Under Namespace

Modules: Status, Type Classes: Cardholder, Shipment

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(first_name:, last_name:) ⇒ Object

Details about the cardholder, as it appears on the printed card.

Parameters:

  • first_name (String) —

    The cardholder's first name.

  • last_name (String) —

    The cardholder's last name.




# File 'lib/increase/models/physical_card.rb', line 65

Instance Attribute Details

#card_id ⇒ String

The identifier for the Card this Physical Card represents.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :card_id, String

#cardholder ⇒ Increase::Models::PhysicalCard::Cardholder

Details about the cardholder, as it appears on the printed card.

Parameters:

  • value (Increase::PhysicalCard::Cardholder)

Returns:



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

required :cardholder, -> { Increase::PhysicalCard::Cardholder }

#created_at ⇒ Time

The ISO 8601 date and time at which the Physical Card was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


30
 
# File 'lib/increase/models/physical_card.rb', line 30

required :created_at, Time

#id ⇒ String

The physical card identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


38
 
# File 'lib/increase/models/physical_card.rb', line 38

required :idempotency_key, String, nil?: true

#physical_card_profile_id ⇒ String?

The Physical Card Profile used for this Physical Card.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

required :physical_card_profile_id, String, nil?: true

#shipment ⇒ Increase::Models::PhysicalCard::Shipment

The details used to ship this physical card.

Parameters:

  • value (Increase::PhysicalCard::Shipment)

Returns:



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

required :shipment, -> { Increase::PhysicalCard::Shipment }

#status ⇒ Symbol, Increase::Models::PhysicalCard::Status

The status of the Physical Card.

Parameters:

  • value (Increase::Models::PhysicalCard::status)

Returns:



56
 
# File 'lib/increase/models/physical_card.rb', line 56

required :status, enum: -> { Increase::PhysicalCard::Status }

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

A constant representing the object's type. For this resource it will always be physical_card.

Parameters:

  • value (Increase::Models::PhysicalCard::type_)

Returns:



63
 
# File 'lib/increase/models/physical_card.rb', line 63

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/physical_card.rb', line 443

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


47
 
# File 'sig/increase/models/physical_card.rbs', line 47

def to_hash: -> {