Class: Square::Terminal::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Square::Terminal::Client 



7
8
9
 
# File 'lib/square/terminal/client.rb', line 7

def initialize(client:)
  @client = client
end

Instance Method Details

#actions ⇒ Square::Actions::Client

Returns:

  • (Square::Actions::Client) 


83
84
85
 
# File 'lib/square/terminal/client.rb', line 83

def actions
  @actions ||= Square::Terminal::Actions::Client.new(client: @client)
end

#checkouts ⇒ Square::Checkouts::Client

Returns:

  • (Square::Checkouts::Client) 


88
89
90
 
# File 'lib/square/terminal/client.rb', line 88

def checkouts
  @checkouts ||= Square::Terminal::Checkouts::Client.new(client: @client)
end

#dismiss_terminal_action(request_options: {}, **params) ⇒ Square::Types::DismissTerminalActionResponse

Dismisses a Terminal action request if the status and type of the request permits it.

See [Link and Dismiss Actions](developer.squareup.com/docs/terminal-api/advanced-features/custom-workflows/link-and-dismiss-actions) for more details.

Returns:



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

def dismiss_terminal_action(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "POST",
    path: "v2/terminals/actions/#{params[:action_id]}/dismiss"
  )
  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::DismissTerminalActionResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

#dismiss_terminal_checkout(request_options: {}, **params) ⇒ Square::Types::DismissTerminalCheckoutResponse

Dismisses a Terminal checkout request if the status and type of the request permits it.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/square/terminal/client.rb', line 39

def dismiss_terminal_checkout(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "POST",
    path: "v2/terminals/checkouts/#{params[:checkout_id]}/dismiss"
  )
  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::DismissTerminalCheckoutResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

#dismiss_terminal_refund(request_options: {}, **params) ⇒ Square::Types::DismissTerminalRefundResponse

Dismisses a Terminal refund request if the status and type of the request permits it.

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/square/terminal/client.rb', line 62

def dismiss_terminal_refund(request_options: {}, **params)
  _request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url] || Square::Environment::PRODUCTION,
    method: "POST",
    path: "v2/terminals/refunds/#{params[:terminal_refund_id]}/dismiss"
  )
  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::DismissTerminalRefundResponse.load(_response.body)
  else
    error_class = Square::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(_response.body, code: code)
  end
end

#refunds ⇒ Square::Refunds::Client

Returns:



93
94
95
 
# File 'lib/square/terminal/client.rb', line 93

def refunds
  @refunds ||= Square::Terminal::Refunds::Client.new(client: @client)
end