Class: Square::GiftCards::Activities::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/square/gift_cards/activities/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Square::GiftCards::Activities::Client 



8
9
10
 
# File 'lib/square/gift_cards/activities/client.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#create(request_options: {}, **params) ⇒ Square::Types::CreateGiftCardActivityResponse

Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard). For example, create an ‘ACTIVATE` activity to activate a gift card with an initial balance before first use.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/square/gift_cards/activities/client.rb', line 42

def create(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "POST",
    path: "v2/gift-cards/activities",
    body: params
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::CreateGiftCardActivityResponse.load(_response.body)
  end

  raise _response.body
end

#list(request_options: {}, **params) ⇒ Square::Types::ListGiftCardActivitiesResponse

Lists gift card activities. By default, you get gift card activities for all gift cards in the seller’s account. You can optionally specify query parameters to filter the list. For example, you can get a list of gift card activities for a gift card, for all gift cards in a specific region, or for activities within a time window.

Returns:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/square/gift_cards/activities/client.rb', line 18

def list(request_options: {}, **params)
  _query_param_names = %w[gift_card_id type location_id begin_time end_time limit cursor
                          sort_order]
  _query = params.slice(*_query_param_names)
  params.except(*_query_param_names)

  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::SANDBOX,
    method: "GET",
    path: "v2/gift-cards/activities",
    query: _query
  )
  _response = @client.send(_request)
  if _response.code >= "200" && _response.code < "300"
    return Square::Types::ListGiftCardActivitiesResponse.load(_response.body)
  end

  raise _response.body
end