Class: Increase::Models::Card

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

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: BillingAddress, DigitalWallet

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(digital_card_profile_id: , email: , phone: ) ⇒ Object

Some parameter documentations has been truncated, see DigitalWallet for more details.

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

Parameters:

  • digital_card_profile_id (String, nil) (defaults to: ) —

    The digital card profile assigned to this digital card. Card profiles may also b

  • email (String, nil) (defaults to: ) —

    An email address that can be used to verify the cardholder via one-time passcode

  • phone (String, nil) (defaults to: ) —

    A phone number that can be used to verify the cardholder via one-time passcode o




# File 'lib/increase/models/card.rb', line 91

Instance Attribute Details

#account_id ⇒ String

The identifier for the account this card belongs to.

Returns:

  • (String) 


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

required :account_id, String

#billing_address ⇒ Increase::Models::Card::BillingAddress

The Card’s billing address.

Returns:



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

required :billing_address, -> { Increase::Card::BillingAddress }

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the Card was created.

Returns:

  • (Time) 


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

required :created_at, Time

#description ⇒ String?

The card’s description for display purposes.

Returns:

  • (String, nil) 


36
 
# File 'lib/increase/models/card.rb', line 36

required :description, String, nil?: true

#digital_wallet ⇒ Increase::Models::Card::DigitalWallet?

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

Returns:



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

required :digital_wallet, -> { Increase::Card::DigitalWallet }, nil?: true

#entity_id ⇒ String?

The identifier for the entity associated with this card.

Returns:

  • (String, nil) 


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

required :entity_id, String, nil?: true

#expiration_month ⇒ Integer

The month the card expires in M format (e.g., August is 8).

Returns:

  • (Integer) 


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

required :expiration_month, Integer

#expiration_year ⇒ Integer

The year the card expires in YYYY format (e.g., 2025).

Returns:

  • (Integer) 


62
 
# File 'lib/increase/models/card.rb', line 62

required :expiration_year, Integer

#id ⇒ String

The card identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


70
 
# File 'lib/increase/models/card.rb', line 70

required :idempotency_key, String, nil?: true

#last4 ⇒ String

The last 4 digits of the Card’s Primary Account Number.

Returns:

  • (String) 


76
 
# File 'lib/increase/models/card.rb', line 76

required :last4, String

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

This indicates if payments can be made with the card.

Returns:



82
 
# File 'lib/increase/models/card.rb', line 82

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

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

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

Returns:



89
 
# File 'lib/increase/models/card.rb', line 89

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card.rb', line 225