Class: Increase::Models::DigitalCardProfile

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

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: TextColor

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(blue: , green: , red: ) ⇒ Object

The Card’s text color, specified as an RGB triple.

Parameters:

  • blue (Integer) (defaults to: ) —

    The value of the blue channel in the RGB color.

  • green (Integer) (defaults to: ) —

    The value of the green channel in the RGB color.

  • red (Integer) (defaults to: ) —

    The value of the red channel in the RGB color.




# File 'lib/increase/models/digital_card_profile.rb', line 95

Instance Attribute Details

#app_icon_file_id ⇒ String

The identifier of the File containing the card’s icon image.

Returns:

  • (String) 


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

required :app_icon_file_id, String

#background_image_file_id ⇒ String

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

Returns:

  • (String) 


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

required :background_image_file_id, String

#card_description ⇒ String

A user-facing description for the card itself.

Returns:

  • (String) 


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

required :card_description, String

#contact_email ⇒ String?

An email address the user can contact to receive support for their card.

Returns:

  • (String, nil) 


35
 
# File 'lib/increase/models/digital_card_profile.rb', line 35

required :contact_email, String, nil?: true

#contact_phone ⇒ String?

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

Returns:

  • (String, nil) 


41
 
# File 'lib/increase/models/digital_card_profile.rb', line 41

required :contact_phone, String, nil?: true

#contact_website ⇒ String?

A website the user can visit to view and receive support for their card.

Returns:

  • (String, nil) 


47
 
# File 'lib/increase/models/digital_card_profile.rb', line 47

required :contact_website, 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) 


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

required :created_at, Time

#description ⇒ String

A description you can use to identify the Card Profile.

Returns:

  • (String) 


60
 
# File 'lib/increase/models/digital_card_profile.rb', line 60

required :description, String

#id ⇒ String

The Card Profile identifier.

Returns:

  • (String) 


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


68
 
# File 'lib/increase/models/digital_card_profile.rb', line 68

required :idempotency_key, String, nil?: true

#issuer_name ⇒ String

A user-facing description for whoever is issuing the card.

Returns:

  • (String) 


74
 
# File 'lib/increase/models/digital_card_profile.rb', line 74

required :issuer_name, String

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

The status of the Card Profile.

Returns:



80
 
# File 'lib/increase/models/digital_card_profile.rb', line 80

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

#text_color ⇒ Increase::Models::DigitalCardProfile::TextColor

The Card’s text color, specified as an RGB triple.

Returns:



86
 
# File 'lib/increase/models/digital_card_profile.rb', line 86

required :text_color, -> { Increase::DigitalCardProfile::TextColor }

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

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

Returns:



93
 
# File 'lib/increase/models/digital_card_profile.rb', line 93

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/digital_card_profile.rb', line 149