Class: Increase::Models::PhysicalCardProfile

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

Overview

See Also:

Defined Under Namespace

Modules: Creator, Status, Type

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, 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: , back_image_file_id: , carrier_image_file_id: , contact_phone: , created_at: , creator: , description: , front_image_file_id: , idempotency_key: , is_default: , program_id: , status: , type: ) ⇒ Object

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

This contains artwork and metadata relating to a Physical Card’s appearance. For more information, see our guide on [physical card artwork](increase.com/documentation/card-art-physical-cards).

Parameters:

  • id (String) (defaults to: ) —

    The Card Profile identifier.

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

    The identifier of the File containing the physical card’s back image.

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

    The identifier of the File containing the physical card’s carrier image.

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

    A phone number the user can contact to receive support for their card.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • creator (Symbol, Increase::Models::PhysicalCardProfile::Creator) (defaults to: ) —

    The creator of this Physical Card Profile.

  • description (String) (defaults to: ) —

    A description you can use to identify the Physical Card Profile.

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

    The identifier of the File containing the physical card’s front image.

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

    The idempotency key you chose for this object. This value is unique across Incre

  • is_default (Boolean) (defaults to: ) —

    Whether this Physical Card Profile is the default for all cards in its Increase

  • program_id (String) (defaults to: ) —

    The identifier for the Program this Physical Card Profile belongs to.

  • status (Symbol, Increase::Models::PhysicalCardProfile::Status) (defaults to: ) —

    The status of the Physical Card Profile.

  • type (Symbol, Increase::Models::PhysicalCardProfile::Type) (defaults to: ) —

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




# File 'lib/increase/models/physical_card_profile.rb', line 90

Instance Attribute Details

#back_image_file_id ⇒ String?

The identifier of the File containing the physical card’s back image.

Returns:

  • (String, nil) 


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

required :back_image_file_id, String, nil?: true

#carrier_image_file_id ⇒ String?

The identifier of the File containing the physical card’s carrier image.

Returns:

  • (String, nil) 


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

required :carrier_image_file_id, String, nil?: true

#contact_phone ⇒ String?

A phone number the user can contact to receive support for their card.

Returns:

  • (String, nil) 


29
 
# File 'lib/increase/models/physical_card_profile.rb', line 29

required :contact_phone, String, nil?: true

#created_at ⇒ Time

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

Returns:

  • (Time) 


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

required :created_at, Time

#creator ⇒ Symbol, Increase::Models::PhysicalCardProfile::Creator

The creator of this Physical Card Profile.

Returns:



42
 
# File 'lib/increase/models/physical_card_profile.rb', line 42

required :creator, enum: -> { Increase::PhysicalCardProfile::Creator }

#description ⇒ String

A description you can use to identify the Physical Card Profile.

Returns:

  • (String) 


48
 
# File 'lib/increase/models/physical_card_profile.rb', line 48

required :description, String

#front_image_file_id ⇒ String?

The identifier of the File containing the physical card’s front image.

Returns:

  • (String, nil) 


54
 
# File 'lib/increase/models/physical_card_profile.rb', line 54

required :front_image_file_id, String, nil?: true

#id ⇒ String

The Card Profile identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/physical_card_profile.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) 


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

required :idempotency_key, String, nil?: true

#is_default ⇒ Boolean

Whether this Physical Card Profile is the default for all cards in its Increase group.

Returns:

  • (Boolean) 


69
 
# File 'lib/increase/models/physical_card_profile.rb', line 69

required :is_default, Increase::Internal::Type::Boolean

#program_id ⇒ String

The identifier for the Program this Physical Card Profile belongs to.

Returns:

  • (String) 


75
 
# File 'lib/increase/models/physical_card_profile.rb', line 75

required :program_id, String

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

The status of the Physical Card Profile.

Returns:



81
 
# File 'lib/increase/models/physical_card_profile.rb', line 81

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

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

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

Returns:



88
 
# File 'lib/increase/models/physical_card_profile.rb', line 88

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/physical_card_profile.rb', line 136