Class: Increase::Resources::DigitalCardProfiles

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/digital_card_profiles.rb,
sig/increase/resources/digital_card_profiles.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DigitalCardProfiles

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of DigitalCardProfiles.

Parameters:



165
166
167
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 165

def initialize(client:)
  @client = client
end

Instance Method Details

#archive(digital_card_profile_id, request_options: {}) ⇒ Increase::Models::DigitalCardProfile

Archive a Digital Card Profile

Parameters:

  • digital_card_profile_id (String) —

    The identifier of the Digital Card Profile to archive.

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

Returns:

See Also:



112
113
114
115
116
117
118
119
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 112

def archive(digital_card_profile_id, params = {})
  @client.request(
    method: :post,
    path: ["digital_card_profiles/%1$s/archive", digital_card_profile_id],
    model: Increase::DigitalCardProfile,
    options: params[:request_options]
  )
end

#clone_(digital_card_profile_id, app_icon_file_id: nil, background_image_file_id: nil, card_description: nil, contact_email: nil, contact_phone: nil, contact_website: nil, description: nil, issuer_name: nil, text_color: nil, request_options: {}) ⇒ Increase::Models::DigitalCardProfile

Clones a Digital Card Profile

Parameters:

  • digital_card_profile_id (String) —

    The identifier of the Digital Card Profile to clone.

  • app_icon_file_id (String) —

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

  • background_image_file_id (String) —

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

  • card_description (String) —

    A user-facing description for the card itself.

  • contact_email (String) —

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

  • contact_phone (String) —

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

  • contact_website (String) —

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

  • description (String) —

    A description you can use to identify the Card Profile.

  • issuer_name (String) —

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

  • text_color (Increase::Models::DigitalCardProfileCloneParams::TextColor) —

    The Card's text color, specified as an RGB triple. The default is white.

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

Returns:

See Also:



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 151

def clone_(digital_card_profile_id, params = {})
  parsed, options = Increase::DigitalCardProfileCloneParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["digital_card_profiles/%1$s/clone", digital_card_profile_id],
    body: parsed,
    model: Increase::DigitalCardProfile,
    options: options
  )
end

#create(app_icon_file_id:, background_image_file_id:, card_description:, description:, issuer_name:, contact_email: nil, contact_phone: nil, contact_website: nil, text_color: nil, request_options: {}) ⇒ Increase::Models::DigitalCardProfile

Create a Digital Card Profile

Parameters:

  • app_icon_file_id (String) —

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

  • background_image_file_id (String) —

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

  • card_description (String) —

    A user-facing description for the card itself.

  • description (String) —

    A description you can use to identify the Card Profile.

  • issuer_name (String) —

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

  • contact_email (String) —

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

  • contact_phone (String) —

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

  • contact_website (String) —

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

  • text_color (Increase::Models::DigitalCardProfileCreateParams::TextColor) —

    The Card's text color, specified as an RGB triple. The default is white.

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

Returns:

See Also:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 34

def create(params)
  parsed, options = Increase::DigitalCardProfileCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "digital_card_profiles",
    body: parsed,
    model: Increase::DigitalCardProfile,
    options: options
  )
end

#list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::DigitalCardProfile>

List Card Profiles

Parameters:

  • cursor (String) —

    Return the page of entries after this one.

  • idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • status (Increase::Models::DigitalCardProfileListParams::Status)
  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 88

def list(params = {})
  parsed, options = Increase::DigitalCardProfileListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "digital_card_profiles",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::DigitalCardProfile,
    options: options
  )
end

#retrieve(digital_card_profile_id, request_options: {}) ⇒ Increase::Models::DigitalCardProfile

Retrieve a Digital Card Profile

Parameters:

  • digital_card_profile_id (String) —

    The identifier of the Digital Card Profile.

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

Returns:

See Also:



56
57
58
59
60
61
62
63
 
# File 'lib/increase/resources/digital_card_profiles.rb', line 56

def retrieve(digital_card_profile_id, params = {})
  @client.request(
    method: :get,
    path: ["digital_card_profiles/%1$s", digital_card_profile_id],
    model: Increase::DigitalCardProfile,
    options: params[:request_options]
  )
end