Class: Square::Locations::Transactions::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/square/locations/transactions/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Square::Locations::Transactions::Client 



8
9
10
 
# File 'lib/square/locations/transactions/client.rb', line 8

def initialize(client:)
  @client = client
end

Instance Method Details

#capture(request_options: {}, **params) ⇒ Square::Types::CaptureTransactionResponse

Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) endpoint with a ‘delay_capture` value of `true`.

See [Delayed capture transactions](developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Returns:



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/square/locations/transactions/client.rb', line 79

def capture(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "POST",
    path: "v2/locations/#{params[:location_id]}/transactions/#{params[:transaction_id]}/capture"
  )
  begin
    _response = @client.send(_request)
  rescue Net::HTTPRequestTimeout
    raise Square::Errors::TimeoutError
  end
  code = _response.code.to_i
  if code.between?(200, 299)
    Square::Types::CaptureTransactionResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

#get(request_options: {}, **params) ⇒ Square::Types::GetTransactionResponse

Retrieves details for a single transaction.

Returns:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/square/locations/transactions/client.rb', line 51

def get(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "GET",
    path: "v2/locations/#{params[:location_id]}/transactions/#{params[:transaction_id]}"
  )
  begin
    _response = @client.send(_request)
  rescue Net::HTTPRequestTimeout
    raise Square::Errors::TimeoutError
  end
  code = _response.code.to_i
  if code.between?(200, 299)
    Square::Types::GetTransactionResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

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

Lists transactions for a particular location.

Transactions include payment information from sales and exchanges and refund information from returns and exchanges.

Max results per [page](developer.squareup.com/docs/working-with-apis/pagination): 50

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/square/locations/transactions/client.rb', line 20

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

  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "GET",
    path: "v2/locations/#{params[:location_id]}/transactions",
    query: _query
  )
  begin
    _response = @client.send(_request)
  rescue Net::HTTPRequestTimeout
    raise Square::Errors::TimeoutError
  end
  code = _response.code.to_i
  if code.between?(200, 299)
    Square::Types::ListTransactionsResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

#void(request_options: {}, **params) ⇒ Square::Types::VoidTransactionResponse

Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) endpoint with a ‘delay_capture` value of `true`.

See [Delayed capture transactions](developer.squareup.com/docs/payments/transactions/overview#delayed-capture) for more information.

Returns:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/square/locations/transactions/client.rb', line 107

def void(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "POST",
    path: "v2/locations/#{params[:location_id]}/transactions/#{params[:transaction_id]}/void"
  )
  begin
    _response = @client.send(_request)
  rescue Net::HTTPRequestTimeout
    raise Square::Errors::TimeoutError
  end
  code = _response.code.to_i
  if code.between?(200, 299)
    Square::Types::VoidTransactionResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end