Class: PostfinancecheckoutRubySdk::ManualTasksService

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ManualTasksService

Returns a new instance of ManualTasksService.



30
31
32
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



27
28
29
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 27

def api_client
  @api_client
end

Instance Method Details

#get_manual_tasks(space, opts = {}) ⇒ ManualTaskListResponse

List all manual tasks

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object's ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object's ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:



42
43
44
45
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 42

def get_manual_tasks(space, opts = {})
  data, _status_code, _headers = get_manual_tasks_with_http_info(space, opts)
  data
end

#get_manual_tasks_id(id, space, opts = {}) ⇒ ManualTask

Retrieve a manual task

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



133
134
135
136
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 133

def get_manual_tasks_id(id, space, opts = {})
  data, _status_code, _headers = get_manual_tasks_id_with_http_info(id, space, opts)
  data
end

#get_manual_tasks_id_notification(id, space, opts = {}) ⇒ String

Retrieve a manual task’s notification message

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (String) 


204
205
206
207
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 204

def get_manual_tasks_id_notification(id, space, opts = {})
  data, _status_code, _headers = get_manual_tasks_id_notification_with_http_info(id, space, opts)
  data
end

#get_manual_tasks_id_notification_with_http_info(id, space, opts = {}) ⇒ Array<(String, Integer, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
263
264
265
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 215

def get_manual_tasks_id_notification_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManualTasksService.get_manual_tasks_id_notification ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ManualTasksService.get_manual_tasks_id_notification"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling ManualTasksService.get_manual_tasks_id_notification"
  end
  # resource path
  local_var_path = '/manual-tasks/{id}/notification'.sub('{' + 'id' + '}', CGI.escape(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(['text/plain', 'application/json']) unless header_params['Accept']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"ManualTasksService.get_manual_tasks_id_notification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManualTasksService#get_manual_tasks_id_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_manual_tasks_id_with_http_info(id, space, opts = {}) ⇒ Array<(ManualTask, Integer, Hash)>

Returns ManualTask data, response status code and response headers.

Parameters:

  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    ManualTask data, response status code and response headers



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 145

def get_manual_tasks_id_with_http_info(id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManualTasksService.get_manual_tasks_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ManualTasksService.get_manual_tasks_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling ManualTasksService.get_manual_tasks_id"
  end
  # resource path
  local_var_path = '/manual-tasks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"ManualTasksService.get_manual_tasks_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManualTasksService#get_manual_tasks_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_manual_tasks_search(space, opts = {}) ⇒ ManualTaskSearchResponse

Search manual tasks

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:



277
278
279
280
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 277

def get_manual_tasks_search(space, opts = {})
  data, _status_code, _headers = get_manual_tasks_search_with_http_info(space, opts)
  data
end

#get_manual_tasks_search_with_http_info(space, opts = {}) ⇒ Array<(ManualTaskSearchResponse, Integer, Hash)>

Returns ManualTaskSearchResponse data, response status code and response headers.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:

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

    ManualTaskSearchResponse data, response status code and response headers



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
351
352
353
354
355
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 292

def get_manual_tasks_search_with_http_info(space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManualTasksService.get_manual_tasks_search ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling ManualTasksService.get_manual_tasks_search"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ManualTasksService.get_manual_tasks_search, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ManualTasksService.get_manual_tasks_search, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling ManualTasksService.get_manual_tasks_search, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = '/manual-tasks/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"ManualTasksService.get_manual_tasks_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManualTasksService#get_manual_tasks_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_manual_tasks_with_http_info(space, opts = {}) ⇒ Array<(ManualTaskListResponse, Integer, Hash)>

Returns ManualTaskListResponse data, response status code and response headers.

Parameters:

  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:

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

    ManualTaskListResponse data, response status code and response headers



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 57

def get_manual_tasks_with_http_info(space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManualTasksService.get_manual_tasks ...'
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling ManualTasksService.get_manual_tasks"
  end
  if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1
    fail ArgumentError, 'invalid value for "opts[:"after"]" when calling ManualTasksService.get_manual_tasks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1
    fail ArgumentError, 'invalid value for "opts[:"before"]" when calling ManualTasksService.get_manual_tasks, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ManualTasksService.get_manual_tasks, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ManualTasksService.get_manual_tasks, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/manual-tasks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if !opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"ManualTasksService.get_manual_tasks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManualTasksService#get_manual_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_manual_tasks_id_action_action_id(id, action_id, space, opts = {}) ⇒ nil

Process a manual task’s action

Parameters:

  • id (Integer)
  • action_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (nil) 


364
365
366
367
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 364

def post_manual_tasks_id_action_action_id(id, action_id, space, opts = {})
  post_manual_tasks_id_action_action_id_with_http_info(id, action_id, space, opts)
  nil
end

#post_manual_tasks_id_action_action_id_with_http_info(id, action_id, space, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • id (Integer)
  • action_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
425
426
427
428
429
430
 
# File 'lib/postfinancecheckout-ruby-sdk/service/manual_tasks_service.rb', line 376

def post_manual_tasks_id_action_action_id_with_http_info(id, action_id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ManualTasksService.post_manual_tasks_id_action_action_id ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ManualTasksService.post_manual_tasks_id_action_action_id"
  end
  # verify the required parameter 'action_id' is set
  if @api_client.config.client_side_validation && action_id.nil?
    fail ArgumentError, "Missing the required parameter 'action_id' when calling ManualTasksService.post_manual_tasks_id_action_action_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling ManualTasksService.post_manual_tasks_id_action_action_id"
  end
  # resource path
  local_var_path = '/manual-tasks/{id}/action/{actionId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'actionId' + '}', CGI.escape(action_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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type]

  new_options = opts.merge(
    :operation => :"ManualTasksService.post_manual_tasks_id_action_action_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ManualTasksService#post_manual_tasks_id_action_action_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end