Class: Increase::Models::PhysicalCardProfileCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/physical_card_profile_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: BackColor, FrontColor Classes: FrontText

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(carrier_image_file_id: , contact_phone: , description: , front_image_file_id: , program_id: , back_color: nil, card_stock_reference: nil, carrier_stock_reference: nil, front_color: nil, front_text: nil, request_options: {}) ⇒ Object

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

Parameters:

  • carrier_image_file_id (String) (defaults to: ) —

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

  • contact_phone (String) (defaults to: ) —

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

  • description (String) (defaults to: ) —

    A description you can use to identify the Card Profile.

  • front_image_file_id (String) (defaults to: ) —

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

  • program_id (String) (defaults to: ) —

    The identifier for the Program that this Physical Card Profile falls under.

  • back_color (Symbol, Increase::Models::PhysicalCardProfileCreateParams::BackColor) (defaults to: nil) —

    The color of the text on the back of the card. Defaults to “black”.

  • card_stock_reference (String) (defaults to: nil) —

    A reference ID provided by the fulfillment provider for the card stock used. Onl

  • carrier_stock_reference (String) (defaults to: nil) —

    A reference ID provided by the fulfillment provider for the carrier stock used.

  • front_color (Symbol, Increase::Models::PhysicalCardProfileCreateParams::FrontColor) (defaults to: nil) —

    The color of the design on the front of the card. Defaults to “black”.

  • front_text (Increase::Models::PhysicalCardProfileCreateParams::FrontText) (defaults to: nil) —

    Text printed on the front of the card. Reach out to [support@increase.com](mailt

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/increase/models/physical_card_profile_create_params.rb', line 73

Instance Attribute Details

#back_color ⇒ Symbol, ...

The color of the text on the back of the card. Defaults to “black”.

Returns:



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

optional :back_color, enum: -> { Increase::PhysicalCardProfileCreateParams::BackColor }

#card_stock_reference ⇒ String?

A reference ID provided by the fulfillment provider for the card stock used. Only used if you’ve ordered card stock separately.

Returns:

  • (String, nil) 


51
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 51

optional :card_stock_reference, String

#carrier_image_file_id ⇒ String

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

Returns:

  • (String) 


14
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 14

required :carrier_image_file_id, String

#carrier_stock_reference ⇒ String?

A reference ID provided by the fulfillment provider for the carrier stock used. Only used if you’ve ordered carrier stock separately.

Returns:

  • (String, nil) 


58
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 58

optional :carrier_stock_reference, String

#contact_phone ⇒ String

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

Returns:

  • (String) 


20
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 20

required :contact_phone, String

#description ⇒ String

A description you can use to identify the Card Profile.

Returns:

  • (String) 


26
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 26

required :description, String

#front_color ⇒ Symbol, ...

The color of the design on the front of the card. Defaults to “black”.

Returns:



64
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 64

optional :front_color, enum: -> { Increase::PhysicalCardProfileCreateParams::FrontColor }

#front_image_file_id ⇒ String

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

Returns:

  • (String) 


32
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 32

required :front_image_file_id, String

#front_text ⇒ Increase::Models::PhysicalCardProfileCreateParams::FrontText?

Text printed on the front of the card. Reach out to [support@increase.com](support@increase.com) for more information.

Returns:



71
 
# File 'lib/increase/models/physical_card_profile_create_params.rb', line 71

optional :front_text, -> { Increase::PhysicalCardProfileCreateParams::FrontText }

#program_id ⇒ String

The identifier for the Program that this Physical Card Profile falls under.

Returns:

  • (String) 


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

required :program_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/physical_card_profile_create_params.rb', line 109