Class: FeratelCheckApiClient::CheckResourcesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/feratel-check-api-client/api/check_resources_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CheckResourcesApi

Returns a new instance of CheckResourcesApi.



19
20
21
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_tenant_id_secure_checkpoints_check_point_id_check_get(tenant_id, check_point_id, opts = {}) ⇒ CheckResult

check Check, if an identification is permitted at the time of the request or not.
The HTTP method GET performs a check only - no transaction will be written.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer's QR-code / barcode.<br>After scanning this code, provide the complete code-content without trimming!

Returns:



29
30
31
32
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 29

def v1_tenant_id_secure_checkpoints_check_point_id_check_get(tenant_id, check_point_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info(tenant_id, check_point_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info(tenant_id, check_point_id, opts = {}) ⇒ Array<(CheckResult, Integer, Hash)>

check Check, if an identification is permitted at the time of the request or not.&lt;br&gt;The HTTP method GET performs a check only - no transaction will be written.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:

  • (Array<(CheckResult, Integer, Hash)>) —

    CheckResult data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 41

def v1_tenant_id_secure_checkpoints_check_point_id_check_get_with_http_info(tenant_id, check_point_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_get ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_get"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_get"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}/check'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_check_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_post(tenant_id, check_point_id, opts = {}) ⇒ TransactResult

check and transaction Check, if an identification is permitted at the time of the request or not.
The HTTP method POST performs a check with a persistent transaction.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:



106
107
108
109
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 106

def v1_tenant_id_secure_checkpoints_check_point_id_check_post(tenant_id, check_point_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info(tenant_id, check_point_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info(tenant_id, check_point_id, opts = {}) ⇒ Array<(TransactResult, Integer, Hash)>

check and transaction Check, if an identification is permitted at the time of the request or not.&lt;br&gt;The HTTP method POST performs a check with a persistent transaction.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:

  • (Array<(TransactResult, Integer, Hash)>) —

    TransactResult data, response status code and response headers



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 118

def v1_tenant_id_secure_checkpoints_check_point_id_check_post_with_http_info(tenant_id, check_point_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_post ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_post"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_post"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_post, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}/check'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_check_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get(tenant_id, check_point_id, service_type_id, opts = {}) ⇒ CheckResult

check based on service Check, if an identification is permitted for a specific serviceType at the time of the request or not.
The HTTP method GET performs a check only - no transaction will be written.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • service_type_id (String) —

    ID of Service

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:



184
185
186
187
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 184

def v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get(tenant_id, check_point_id, service_type_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info(tenant_id, check_point_id, service_type_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info(tenant_id, check_point_id, service_type_id, opts = {}) ⇒ Array<(CheckResult, Integer, Hash)>

check based on service Check, if an identification is permitted for a specific serviceType at the time of the request or not.&lt;br&gt;The HTTP method GET performs a check only - no transaction will be written.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • service_type_id (String) —

    ID of Service

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:

  • (Array<(CheckResult, Integer, Hash)>) —

    CheckResult data, response status code and response headers



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 197

def v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get_with_http_info(tenant_id, check_point_id, service_type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'service_type_id' is set
  if @api_client.config.client_side_validation && service_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_type_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && service_type_id !~ pattern
    fail ArgumentError, "invalid value for 'service_type_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}/check/{serviceTypeId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s)).sub('{' + 'serviceTypeId' + '}', CGI.escape(service_type_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CheckResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post(tenant_id, check_point_id, service_type_id, opts = {}) ⇒ TransactResult

check based on service and transaction Check, if an identification is permitted for a specific serviceType at the time of the request or not.
The HTTP method POST performs a check with a persistent transaction.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String)
  • service_type_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:



272
273
274
275
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 272

def v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post(tenant_id, check_point_id, service_type_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info(tenant_id, check_point_id, service_type_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info(tenant_id, check_point_id, service_type_id, opts = {}) ⇒ Array<(TransactResult, Integer, Hash)>

check based on service and transaction Check, if an identification is permitted for a specific serviceType at the time of the request or not.&lt;br&gt;The HTTP method POST performs a check with a persistent transaction.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String)
  • service_type_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    The Identifier is part of the customer&#39;s QR-code / barcode.&lt;br&gt;After scanning this code, provide the complete code-content without trimming!

Returns:

  • (Array<(TransactResult, Integer, Hash)>) —

    TransactResult data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 285

def v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post_with_http_info(tenant_id, check_point_id, service_type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'service_type_id' is set
  if @api_client.config.client_side_validation && service_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_type_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && service_type_id !~ pattern
    fail ArgumentError, "invalid value for 'service_type_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}/check/{serviceTypeId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s)).sub('{' + 'serviceTypeId' + '}', CGI.escape(service_type_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TransactResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_check_service_type_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_check_point_id_get(tenant_id, check_point_id, opts = {}) ⇒ CheckPoint

checkpoint details Get all service and usage details of a specific checkpoint.
The ServiceTypeId (type:id) contained in the response is required to check an identification based on a service (method "check/serviceTypeId").

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



358
359
360
361
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 358

def v1_tenant_id_secure_checkpoints_check_point_id_get(tenant_id, check_point_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info(tenant_id, check_point_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info(tenant_id, check_point_id, opts = {}) ⇒ Array<(CheckPoint, Integer, Hash)>

checkpoint details Get all service and usage details of a specific checkpoint.&lt;br&gt;The ServiceTypeId (type:id) contained in the response is required to check an identification based on a service (method &quot;check/serviceTypeId&quot;).

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CheckPoint, Integer, Hash)>) —

    CheckPoint data, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 369

def v1_tenant_id_secure_checkpoints_check_point_id_get_with_http_info(tenant_id, check_point_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_get ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_get"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_get"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CheckPoint'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_check_point_id_history_get(tenant_id, check_point_id, opts = {}) ⇒ History

transaction history Get the last 5 checks (transactions) of a specific checkpoint.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    start page index (default to 0)

  • :service_id (String) —

    ID of Service

  • :size (Integer) —

    max. delivered pages (default to 5)

Returns:



435
436
437
438
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 435

def v1_tenant_id_secure_checkpoints_check_point_id_history_get(tenant_id, check_point_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info(tenant_id, check_point_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info(tenant_id, check_point_id, opts = {}) ⇒ Array<(History, Integer, Hash)>

transaction history Get the last 5 checks (transactions) of a specific checkpoint.

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • check_point_id (String) —

    ID of CheckPoint

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    start page index (default to 0)

  • :service_id (String) —

    ID of Service

  • :size (Integer) —

    max. delivered pages (default to 5)

Returns:

  • (Array<(History, Integer, Hash)>) —

    History data, response status code and response headers



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 449

def v1_tenant_id_secure_checkpoints_check_point_id_history_get_with_http_info(tenant_id, check_point_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get"
  end
  # verify the required parameter 'check_point_id' is set
  if @api_client.config.client_side_validation && check_point_id.nil?
    fail ArgumentError, "Missing the required parameter 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get"
  end
  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && check_point_id !~ pattern
    fail ArgumentError, "invalid value for 'check_point_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get, must conform to the pattern #{pattern}."
  end

  pattern = Regexp.new(/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/)
  if @api_client.config.client_side_validation && !opts[:'service_id'].nil? && opts[:'service_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"service_id\"]' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints/{checkPointId}/history'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s)).sub('{' + 'checkPointId' + '}', CGI.escape(check_point_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'serviceID'] = opts[:'service_id'] if !opts[:'service_id'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'History'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_check_point_id_history_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_check_point_id_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_tenant_id_secure_checkpoints_get(tenant_id, opts = {}) ⇒ Array<CheckPointItem>

list of checkpoints Get all your user-assigned checkpoints in the selected card-project (tenant).
Use the corresponding checkpointid to "check" the permission of an identification (f.e. Card ID).

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :active (Boolean) —

    If true only active checkpoints

  • :page (Integer) —

    Index of start page (default to 0)

  • :size (Integer) —

    Number of max delivered pages (default to 100)

Returns:



522
523
524
525
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 522

def v1_tenant_id_secure_checkpoints_get(tenant_id, opts = {})
  data, _status_code, _headers = v1_tenant_id_secure_checkpoints_get_with_http_info(tenant_id, opts)
  data
end

#v1_tenant_id_secure_checkpoints_get_with_http_info(tenant_id, opts = {}) ⇒ Array<(Array<CheckPointItem>, Integer, Hash)>

list of checkpoints Get all your user-assigned checkpoints in the selected card-project (tenant).&lt;br&gt;Use the corresponding checkpointid to &quot;check&quot; the permission of an identification (f.e. Card ID).

Parameters:

  • tenant_id (String) —

    Code of target tenant

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :active (Boolean) —

    If true only active checkpoints

  • :page (Integer) —

    Index of start page (default to 0)

  • :size (Integer) —

    Number of max delivered pages (default to 100)

Returns:

  • (Array<(Array<CheckPointItem>, Integer, Hash)>) —

    Array<CheckPointItem> data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/feratel-check-api-client/api/check_resources_api.rb', line 535

def v1_tenant_id_secure_checkpoints_get_with_http_info(tenant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CheckResourcesApi.v1_tenant_id_secure_checkpoints_get ...'
  end
  # verify the required parameter 'tenant_id' is set
  if @api_client.config.client_side_validation && tenant_id.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_id' when calling CheckResourcesApi.v1_tenant_id_secure_checkpoints_get"
  end
  # resource path
  local_var_path = '/v1/{tenantId}/secure/checkpoints'.sub('{' + 'tenantId' + '}', CGI.escape(tenant_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CheckPointItem>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth']

  new_options = opts.merge(
    :operation => :"CheckResourcesApi.v1_tenant_id_secure_checkpoints_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CheckResourcesApi#v1_tenant_id_secure_checkpoints_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end