Class: Square::Terminal::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/square/terminal/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#actions ⇒ Square::Actions::Client

Returns:

  • (Square::Actions::Client) 


120
121
122
 
# File 'lib/square/terminal/client.rb', line 120

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

#checkouts ⇒ Square::Checkouts::Client

Returns:

  • (Square::Checkouts::Client) 


125
126
127
 
# File 'lib/square/terminal/client.rb', line 125

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.

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :action_id (String)

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/square/terminal/client.rb', line 29

def dismiss_terminal_action(request_options: {}, **params)
  params = Square::Internal::Types::Utils.normalize_keys(params)
  request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v2/terminals/actions/#{params[:action_id]}/dismiss",
    request_options: request_options
  )
  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.

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :checkout_id (String)

Returns:



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

def dismiss_terminal_checkout(request_options: {}, **params)
  params = Square::Internal::Types::Utils.normalize_keys(params)
  request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v2/terminals/checkouts/#{params[:checkout_id]}/dismiss",
    request_options: request_options
  )
  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.

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :terminal_refund_id (String)

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/square/terminal/client.rb', line 97

def dismiss_terminal_refund(request_options: {}, **params)
  params = Square::Internal::Types::Utils.normalize_keys(params)
  request = Square::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v2/terminals/refunds/#{params[:terminal_refund_id]}/dismiss",
    request_options: request_options
  )
  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:



130
131
132
 
# File 'lib/square/terminal/client.rb', line 130

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