Class: CityPayApiClient::OperationalFunctionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/api/operational_functions_api__.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OperationalFunctionsApi

Returns a new instance of OperationalFunctionsApi.



19
20
21
 
# File 'lib/citypay_api_client/api/operational_functions_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/citypay_api_client/api/operational_functions_api__.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#acl_check_request(acl_check_request, opts = {}) ⇒ AclCheckResponseModel

ACL Check Request Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and services such as AWS or Azure to check that those addresses are listed in the ACLs.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 27

def acl_check_request(acl_check_request, opts = {})
  data, _status_code, _headers = acl_check_request_with_http_info(acl_check_request, opts)
  data
end

#acl_check_request_with_http_info(acl_check_request, opts = {}) ⇒ Array<(AclCheckResponseModel, Integer, Hash)>

ACL Check Request Allows the checking of IP addresses against configured ACLs. Requests can perform a lookup of addresses in subnets and services such as AWS or Azure to check that those addresses are listed in the ACLs.

Parameters:

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

    the optional parameters

Returns:

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

    AclCheckResponseModel data, response status code and response headers



37
38
39
40
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
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 37

def acl_check_request_with_http_info(acl_check_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.acl_check_request ...'
  end
  # verify the required parameter 'acl_check_request' is set
  if @api_client.config.client_side_validation && acl_check_request.nil?
    fail ArgumentError, "Missing the required parameter 'acl_check_request' when calling OperationalFunctionsApi.acl_check_request"
  end
  # resource path
  local_var_path = '/v6/acl/check'

  # 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', 'text/xml']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(acl_check_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.acl_check_request",
    :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: OperationalFunctionsApi#acl_check_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_key_check_request(domain_key_check_request, opts = {}) ⇒ DomainKeyResponse

Domain Key Check Request Checks the contents of a ‘domain key`. Can be used for operational processes to ensure that the properties of a domain key meet their expectations.

Parameters:

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 95

def domain_key_check_request(domain_key_check_request, opts = {})
  data, _status_code, _headers = domain_key_check_request_with_http_info(domain_key_check_request, opts)
  data
end

#domain_key_check_request_with_http_info(domain_key_check_request, opts = {}) ⇒ Array<(DomainKeyResponse, Integer, Hash)>

Domain Key Check Request Checks the contents of a &#x60;domain key&#x60;. Can be used for operational processes to ensure that the properties of a domain key meet their expectations.

Parameters:

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

    the optional parameters

Returns:

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

    DomainKeyResponse data, response status code and response headers



105
106
107
108
109
110
111
112
113
114
115
116
117
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
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 105

def domain_key_check_request_with_http_info(domain_key_check_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.domain_key_check_request ...'
  end
  # verify the required parameter 'domain_key_check_request' is set
  if @api_client.config.client_side_validation && domain_key_check_request.nil?
    fail ArgumentError, "Missing the required parameter 'domain_key_check_request' when calling OperationalFunctionsApi.domain_key_check_request"
  end
  # resource path
  local_var_path = '/dk/check'

  # 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', 'text/xml']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(domain_key_check_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.domain_key_check_request",
    :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: OperationalFunctionsApi#domain_key_check_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#domain_key_gen_request(domain_key_request, opts = {}) ⇒ DomainKeyResponse

Domain Key Generation Request Generates a domain key based on the permissions of the calling ‘api-key`. Domain keys can be used in _Direct Post_ and `XHR` calls to the API services.

Parameters:

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

    the optional parameters

Returns:



163
164
165
166
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 163

def domain_key_gen_request(domain_key_request, opts = {})
  data, _status_code, _headers = domain_key_gen_request_with_http_info(domain_key_request, opts)
  data
end

#domain_key_gen_request_with_http_info(domain_key_request, opts = {}) ⇒ Array<(DomainKeyResponse, Integer, Hash)>

Domain Key Generation Request Generates a domain key based on the permissions of the calling &#x60;api-key&#x60;. Domain keys can be used in _Direct Post_ and &#x60;XHR&#x60; calls to the API services.

Parameters:

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

    the optional parameters

Returns:

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

    DomainKeyResponse data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
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
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 173

def domain_key_gen_request_with_http_info(domain_key_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.domain_key_gen_request ...'
  end
  # verify the required parameter 'domain_key_request' is set
  if @api_client.config.client_side_validation && domain_key_request.nil?
    fail ArgumentError, "Missing the required parameter 'domain_key_request' when calling OperationalFunctionsApi.domain_key_gen_request"
  end
  # resource path
  local_var_path = '/dk/gen'

  # 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', 'text/xml']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(domain_key_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.domain_key_gen_request",
    :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: OperationalFunctionsApi#domain_key_gen_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_merchants_request(clientid, opts = {}) ⇒ ListMerchantsResponse

List Merchants Request An operational request to list current merchants for a client. ### Sorting Sorting can be performed by include a query parameter i.e. ‘/merchants/?sort=merchantid` Fields that can be sorted are `merchantid` or `name`.

Parameters:

  • clientid (String) —

    The client id to return merchants for, specifying &quot;default&quot; will use the value in your api key.

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

    the optional parameters

Returns:



231
232
233
234
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 231

def list_merchants_request(clientid, opts = {})
  data, _status_code, _headers = list_merchants_request_with_http_info(clientid, opts)
  data
end

#list_merchants_request_with_http_info(clientid, opts = {}) ⇒ Array<(ListMerchantsResponse, Integer, Hash)>

List Merchants Request An operational request to list current merchants for a client. ### Sorting Sorting can be performed by include a query parameter i.e. &#x60;/merchants/?sort&#x3D;merchantid&#x60; Fields that can be sorted are &#x60;merchantid&#x60; or &#x60;name&#x60;.

Parameters:

  • clientid (String) —

    The client id to return merchants for, specifying &quot;default&quot; will use the value in your api key.

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

    the optional parameters

Returns:

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

    ListMerchantsResponse data, response status code and response headers



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 241

def list_merchants_request_with_http_info(clientid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.list_merchants_request ...'
  end
  # verify the required parameter 'clientid' is set
  if @api_client.config.client_side_validation && clientid.nil?
    fail ArgumentError, "Missing the required parameter 'clientid' when calling OperationalFunctionsApi.list_merchants_request"
  end
  # resource path
  local_var_path = '/v6/merchants/{clientid}'.sub('{' + 'clientid' + '}', CGI.escape(clientid.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', 'text/xml']) 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] || 'ListMerchantsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.list_merchants_request",
    :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: OperationalFunctionsApi#list_merchants_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ping_request(ping, opts = {}) ⇒ Acknowledgement

Ping Request A ping request which performs a connection and authentication test to the CityPay API server. The request will return a standard Acknowledgement with a response code ‘044` to signify a successful ping. The ping call is useful to confirm that you will be able to access the API from behind any firewalls and that the permission model is granting access from your source.

Parameters:

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

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 294

def ping_request(ping, opts = {})
  data, _status_code, _headers = ping_request_with_http_info(ping, opts)
  data
end

#ping_request_with_http_info(ping, opts = {}) ⇒ Array<(Acknowledgement, Integer, Hash)>

Ping Request A ping request which performs a connection and authentication test to the CityPay API server. The request will return a standard Acknowledgement with a response code &#x60;044&#x60; to signify a successful ping. The ping call is useful to confirm that you will be able to access the API from behind any firewalls and that the permission model is granting access from your source.

Parameters:

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

    the optional parameters

Returns:

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

    Acknowledgement data, response status code and response headers



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
351
352
353
354
355
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 304

def ping_request_with_http_info(ping, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.ping_request ...'
  end
  # verify the required parameter 'ping' is set
  if @api_client.config.client_side_validation && ping.nil?
    fail ArgumentError, "Missing the required parameter 'ping' when calling OperationalFunctionsApi.ping_request"
  end
  # resource path
  local_var_path = '/v6/ping'

  # 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/x-www-form-urlencoded', 'application/json', 'text/xml']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(ping)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-domain-key', 'cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.ping_request",
    :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: OperationalFunctionsApi#ping_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#register_temp_key(register_ip_model, opts = {}) ⇒ Acknowledgement

Register Temp Key Registers a temporary licence key.

Parameters:

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

    the optional parameters

Returns:



362
363
364
365
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 362

def register_temp_key(register_ip_model, opts = {})
  data, _status_code, _headers = register_temp_key_with_http_info(register_ip_model, opts)
  data
end

#register_temp_key_with_http_info(register_ip_model, opts = {}) ⇒ Array<(Acknowledgement, Integer, Hash)>

Register Temp Key Registers a temporary licence key.

Parameters:

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

    the optional parameters

Returns:

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

    Acknowledgement data, response status code and response headers



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
 
# File 'lib/citypay_api_client/api/operational_functions_api__.rb', line 372

def register_temp_key_with_http_info(register_ip_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OperationalFunctionsApi.register_temp_key ...'
  end
  # verify the required parameter 'register_ip_model' is set
  if @api_client.config.client_side_validation && register_ip_model.nil?
    fail ArgumentError, "Missing the required parameter 'register_ip_model' when calling OperationalFunctionsApi.register_temp_key"
  end
  # resource path
  local_var_path = '/v6/permissions/register-temp-ip'

  # 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', 'text/xml']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'text/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(register_ip_model)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['cp-api-key']

  new_options = opts.merge(
    :operation => :"OperationalFunctionsApi.register_temp_key",
    :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: OperationalFunctionsApi#register_temp_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end