Class: Lithic::Resources::DigitalCardArt

Inherits:
Object
  • Object
show all
Defined in:
lib/lithic/resources/digital_card_art.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ DigitalCardArt

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 DigitalCardArt.

Parameters:



63
64
65
 
# File 'lib/lithic/resources/digital_card_art.rb', line 63

def initialize(client:)
  @client = client
end

Instance Method Details

#list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}) ⇒ Lithic::Internal::CursorPage<Lithic::Models::DigitalCardArtAPI>

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

List digital card art.

Parameters:

  • ending_before (String) —

    A cursor representing an item’s token before which a page of results should end.

  • page_size (Integer) —

    Page size (for pagination).

  • starting_after (String) —

    A cursor representing an item’s token after which a page of results should begin

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

Returns:

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/lithic/resources/digital_card_art.rb', line 47

def list(params = {})
  parsed, options = Lithic::DigitalCardArtListParams.dump_request(params)
  query = Lithic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/digital_card_art",
    query: query,
    page: Lithic::Internal::CursorPage,
    model: Lithic::DigitalCardArtAPI,
    options: options
  )
end

#retrieve(digital_card_art_token, request_options: {}) ⇒ Lithic::Models::DigitalCardArtAPI

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

Get digital card art by token.

Parameters:

  • digital_card_art_token (String) —

    Specifies the digital card art to be displayed in the user’s digital wallet afte

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

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/lithic/resources/digital_card_art.rb', line 20

def retrieve(digital_card_art_token, params = {})
  @client.request(
    method: :get,
    path: ["v1/digital_card_art/%1$s", digital_card_art_token],
    model: Lithic::DigitalCardArtAPI,
    options: params[:request_options]
  )
end