Class: SubskribeSandboxClient::ApprovalsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/approvals_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApprovalsApi

Returns a new instance of ApprovalsApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/approvals_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/subskribe_sandbox/api/approvals_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_approval_role(opts = {}) ⇒ String

Add an approval role Adds an approval role to the order execution hierarchy and returns its ID

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 27

def add_approval_role(opts = {})
  data, _status_code, _headers = add_approval_role_with_http_info(opts)
  data
end

#add_approval_role_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Add an approval role Adds an approval role to the order execution hierarchy and returns its ID

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String 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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 37

def add_approval_role_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.add_approval_role ...'
  end
  # resource path
  local_var_path = '/approvalRoles'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#add_approval_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_approval_segment(opts = {}) ⇒ String

Add an approval segment Define and add an approval segment which can be later specified in an approval matrix. The ID of the segment is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


75
76
77
78
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 75

def add_approval_segment(opts = {})
  data, _status_code, _headers = add_approval_segment_with_http_info(opts)
  data
end

#add_approval_segment_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Add an approval segment Define and add an approval segment which can be later specified in an approval matrix. The ID of the segment is returned.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 85

def add_approval_segment_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.add_approval_segment ...'
  end
  # resource path
  local_var_path = '/approvalSegments'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#add_approval_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_approval_role(approval_role_id, opts = {}) ⇒ ApprovalRoleJson

Delete an approval role Deletes an approval role

Parameters:

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

    the optional parameters

Returns:



123
124
125
126
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 123

def delete_approval_role(approval_role_id, opts = {})
  data, _status_code, _headers = delete_approval_role_with_http_info(approval_role_id, opts)
  data
end

#delete_approval_role_with_http_info(approval_role_id, opts = {}) ⇒ Array<(ApprovalRoleJson, Fixnum, Hash)>

Delete an approval role Deletes an approval role

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ApprovalRoleJson, Fixnum, Hash)>) —

    ApprovalRoleJson data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 133

def delete_approval_role_with_http_info(approval_role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.delete_approval_role ...'
  end
  # verify the required parameter 'approval_role_id' is set
  if @api_client.config.client_side_validation && approval_role_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_role_id' when calling ApprovalsApi.delete_approval_role"
  end
  # resource path
  local_var_path = '/approvalRoles/{approvalRoleId}'.sub('{' + 'approvalRoleId' + '}', approval_role_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRoleJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#delete_approval_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_approval_segment(approval_segment_id, opts = {}) ⇒ ApprovalSegmentJson

Delete a segment Deletes the segment specified by the id

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 175

def delete_approval_segment(approval_segment_id, opts = {})
  data, _status_code, _headers = delete_approval_segment_with_http_info(approval_segment_id, opts)
  data
end

#delete_approval_segment_with_http_info(approval_segment_id, opts = {}) ⇒ Array<(ApprovalSegmentJson, Fixnum, Hash)>

Delete a segment Deletes the segment specified by the id

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Returns:

  • (Array<(ApprovalSegmentJson, Fixnum, Hash)>) —

    ApprovalSegmentJson data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 185

def delete_approval_segment_with_http_info(approval_segment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.delete_approval_segment ...'
  end
  # verify the required parameter 'approval_segment_id' is set
  if @api_client.config.client_side_validation && approval_segment_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_segment_id' when calling ApprovalsApi.delete_approval_segment"
  end
  # resource path
  local_var_path = '/approvalSegments/{approvalSegmentId}'.sub('{' + 'approvalSegmentId' + '}', approval_segment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalSegmentJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#delete_approval_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#fetch_notification(opts = {}) ⇒ nil

make ngrok happy

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


226
227
228
229
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 226

def fetch_notification(opts = {})
  fetch_notification_with_http_info(opts)
  nil
end

#fetch_notification_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

make ngrok happy

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
266
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 235

def fetch_notification_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.fetch_notification ...'
  end
  # resource path
  local_var_path = '/approvalFlowNotifications'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#fetch_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_import_details(opts = {}) ⇒ Array<ApprovalMatrixImportDataJson>

Get approval matrix details Returns details regarding the approval matrices that have been uploaded

Parameters:

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

    the optional parameters

Returns:



271
272
273
274
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 271

def get_all_import_details(opts = {})
  data, _status_code, _headers = get_all_import_details_with_http_info(opts)
  data
end

#get_all_import_details_with_http_info(opts = {}) ⇒ Array<(Array<ApprovalMatrixImportDataJson>, Fixnum, Hash)>

Get approval matrix details Returns details regarding the approval matrices that have been uploaded

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<ApprovalMatrixImportDataJson>, Fixnum, Hash)>) —

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



280
281
282
283
284
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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 280

def get_all_import_details_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_all_import_details ...'
  end
  # resource path
  local_var_path = '/approvalMatrix/csv'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ApprovalMatrixImportDataJson>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_all_import_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_matrix_as_csv(opts = {}) ⇒ nil

Download approval matrix Downloads your order approval matrix as a csv

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


317
318
319
320
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 317

def get_approval_matrix_as_csv(opts = {})
  get_approval_matrix_as_csv_with_http_info(opts)
  nil
end

#get_approval_matrix_as_csv_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Download approval matrix Downloads your order approval matrix as a csv

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
356
357
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 326

def get_approval_matrix_as_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_approval_matrix_as_csv ...'
  end
  # resource path
  local_var_path = '/approvalMatrix/csv/download'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_approval_matrix_as_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_role_by_id(approval_role_id, opts = {}) ⇒ ApprovalRoleJson

Get Details of an approval role Returns the details of the specified approval role

Parameters:

  • approval_role_id —

    id of the approval role

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

    the optional parameters

Returns:



363
364
365
366
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 363

def get_approval_role_by_id(approval_role_id, opts = {})
  data, _status_code, _headers = get_approval_role_by_id_with_http_info(approval_role_id, opts)
  data
end

#get_approval_role_by_id_with_http_info(approval_role_id, opts = {}) ⇒ Array<(ApprovalRoleJson, Fixnum, Hash)>

Get Details of an approval role Returns the details of the specified approval role

Parameters:

  • approval_role_id —

    id of the approval role

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

    the optional parameters

Returns:

  • (Array<(ApprovalRoleJson, Fixnum, Hash)>) —

    ApprovalRoleJson data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 373

def get_approval_role_by_id_with_http_info(approval_role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_approval_role_by_id ...'
  end
  # verify the required parameter 'approval_role_id' is set
  if @api_client.config.client_side_validation && approval_role_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_role_id' when calling ApprovalsApi.get_approval_role_by_id"
  end
  # resource path
  local_var_path = '/approvalRoles/{approvalRoleId}'.sub('{' + 'approvalRoleId' + '}', approval_role_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalRoleJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_approval_role_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_roles(opts = {}) ⇒ Array<ApprovalRoleJson>

Get approval roles Gets all approval roles

Parameters:

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

    the optional parameters

Returns:



414
415
416
417
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 414

def get_approval_roles(opts = {})
  data, _status_code, _headers = get_approval_roles_with_http_info(opts)
  data
end

#get_approval_roles_with_http_info(opts = {}) ⇒ Array<(Array<ApprovalRoleJson>, Fixnum, Hash)>

Get approval roles Gets all approval roles

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<ApprovalRoleJson>, Fixnum, Hash)>) —

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



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 423

def get_approval_roles_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_approval_roles ...'
  end
  # resource path
  local_var_path = '/approvalRoles'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ApprovalRoleJson>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_approval_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_segment_by_id(approval_segment_id, opts = {}) ⇒ ApprovalSegmentJson

Get approval segment details Gets the details of the specified approval segment

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Returns:



461
462
463
464
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 461

def get_approval_segment_by_id(approval_segment_id, opts = {})
  data, _status_code, _headers = get_approval_segment_by_id_with_http_info(approval_segment_id, opts)
  data
end

#get_approval_segment_by_id_with_http_info(approval_segment_id, opts = {}) ⇒ Array<(ApprovalSegmentJson, Fixnum, Hash)>

Get approval segment details Gets the details of the specified approval segment

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Returns:

  • (Array<(ApprovalSegmentJson, Fixnum, Hash)>) —

    ApprovalSegmentJson data, response status code and response headers



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
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 471

def get_approval_segment_by_id_with_http_info(approval_segment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_approval_segment_by_id ...'
  end
  # verify the required parameter 'approval_segment_id' is set
  if @api_client.config.client_side_validation && approval_segment_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_segment_id' when calling ApprovalsApi.get_approval_segment_by_id"
  end
  # resource path
  local_var_path = '/approvalSegments/{approvalSegmentId}'.sub('{' + 'approvalSegmentId' + '}', approval_segment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalSegmentJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_approval_segment_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_approval_segments(opts = {}) ⇒ Array<ApprovalSegmentJson>

Get approval segments Get all approval segments

Parameters:

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

    the optional parameters

Returns:



512
513
514
515
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 512

def get_approval_segments(opts = {})
  data, _status_code, _headers = get_approval_segments_with_http_info(opts)
  data
end

#get_approval_segments_with_http_info(opts = {}) ⇒ Array<(Array<ApprovalSegmentJson>, Fixnum, Hash)>

Get approval segments Get all approval segments

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<ApprovalSegmentJson>, Fixnum, Hash)>) —

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



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 521

def get_approval_segments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_approval_segments ...'
  end
  # resource path
  local_var_path = '/approvalSegments'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<ApprovalSegmentJson>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_approval_segments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_details_by_id(import_id, opts = {}) ⇒ ApprovalMatrixImportDataJson

Get import details Gets the details of an import specified by the passed ID

Parameters:

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

    the optional parameters

Returns:



559
560
561
562
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 559

def get_import_details_by_id(import_id, opts = {})
  data, _status_code, _headers = get_import_details_by_id_with_http_info(import_id, opts)
  data
end

#get_import_details_by_id_with_http_info(import_id, opts = {}) ⇒ Array<(ApprovalMatrixImportDataJson, Fixnum, Hash)>

Get import details Gets the details of an import specified by the passed ID

Parameters:

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

    the optional parameters

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 569

def get_import_details_by_id_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_import_details_by_id ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling ApprovalsApi.get_import_details_by_id"
  end
  # resource path
  local_var_path = '/approvalMatrix/csv/{importId}'.sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalMatrixImportDataJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_import_details_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_preview(import_id, opts = {}) ⇒ ApprovalMatrixImportPreview

Preview import changes Preview the changes that a specified approval matrix import will have once applied

Parameters:

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

    the optional parameters

Returns:



611
612
613
614
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 611

def get_import_preview(import_id, opts = {})
  data, _status_code, _headers = get_import_preview_with_http_info(import_id, opts)
  data
end

#get_import_preview_with_http_info(import_id, opts = {}) ⇒ Array<(ApprovalMatrixImportPreview, Fixnum, Hash)>

Preview import changes Preview the changes that a specified approval matrix import will have once applied

Parameters:

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

    the optional parameters

Returns:



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 621

def get_import_preview_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_import_preview ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling ApprovalsApi.get_import_preview"
  end
  # resource path
  local_var_path = '/approvalMatrix/csv/{importId}/preview'.sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalMatrixImportPreview')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_import_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_import_result(import_id, opts = {}) ⇒ nil

Download the csv for an import Downloads the CSV for an import activity specified by the passed ID

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


663
664
665
666
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 663

def get_import_result(import_id, opts = {})
  get_import_result_with_http_info(import_id, opts)
  nil
end

#get_import_result_with_http_info(import_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Download the csv for an import Downloads the CSV for an import activity specified by the passed ID

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 673

def get_import_result_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.get_import_result ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling ApprovalsApi.get_import_result"
  end
  # resource path
  local_var_path = '/approvalMatrix/csv/{importId}/download'.sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#get_import_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#receive_approval_flow_notification(opts = {}) ⇒ nil

Receive approval flow notification

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:

  • (nil) 


714
715
716
717
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 714

def receive_approval_flow_notification(opts = {})
  receive_approval_flow_notification_with_http_info(opts)
  nil
end

#receive_approval_flow_notification_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Receive approval flow notification

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:

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

    nil, response status code and response headers



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 724

def receive_approval_flow_notification_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.receive_approval_flow_notification ...'
  end
  # resource path
  local_var_path = '/approvalFlowNotifications'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#receive_approval_flow_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#submit_approval_matrix_csv(import_id, opts = {}) ⇒ nil

Finalize an import Submit and finalize the import for the specified import operation.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


761
762
763
764
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 761

def submit_approval_matrix_csv(import_id, opts = {})
  submit_approval_matrix_csv_with_http_info(import_id, opts)
  nil
end

#submit_approval_matrix_csv_with_http_info(import_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Finalize an import Submit and finalize the import for the specified import operation.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 771

def submit_approval_matrix_csv_with_http_info(import_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.submit_approval_matrix_csv ...'
  end
  # verify the required parameter 'import_id' is set
  if @api_client.config.client_side_validation && import_id.nil?
    fail ArgumentError, "Missing the required parameter 'import_id' when calling ApprovalsApi.submit_approval_matrix_csv"
  end
  # resource path
  local_var_path = '/approvalMatrix/csv/{importId}/submit'.sub('{' + 'importId' + '}', import_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#submit_approval_matrix_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_approval_role(approval_role_id, opts = {}) ⇒ nil

Update an approval role Updates the details of the specified approval role

Parameters:

  • approval_role_id —

    id of the role

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


813
814
815
816
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 813

def update_approval_role(approval_role_id, opts = {})
  update_approval_role_with_http_info(approval_role_id, opts)
  nil
end

#update_approval_role_with_http_info(approval_role_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update an approval role Updates the details of the specified approval role

Parameters:

  • approval_role_id —

    id of the role

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 824

def update_approval_role_with_http_info(approval_role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.update_approval_role ...'
  end
  # verify the required parameter 'approval_role_id' is set
  if @api_client.config.client_side_validation && approval_role_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_role_id' when calling ApprovalsApi.update_approval_role"
  end
  # resource path
  local_var_path = '/approvalRoles/{approvalRoleId}'.sub('{' + 'approvalRoleId' + '}', approval_role_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#update_approval_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_approval_segment(approval_segment_id, opts = {}) ⇒ nil

Update an approval segment Update the details of the specified approval segment

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


866
867
868
869
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 866

def update_approval_segment(approval_segment_id, opts = {})
  update_approval_segment_with_http_info(approval_segment_id, opts)
  nil
end

#update_approval_segment_with_http_info(approval_segment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update an approval segment Update the details of the specified approval segment

Parameters:

  • approval_segment_id —

    id of the segment

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 877

def update_approval_segment_with_http_info(approval_segment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.update_approval_segment ...'
  end
  # verify the required parameter 'approval_segment_id' is set
  if @api_client.config.client_side_validation && approval_segment_id.nil?
    fail ArgumentError, "Missing the required parameter 'approval_segment_id' when calling ApprovalsApi.update_approval_segment"
  end
  # resource path
  local_var_path = '/approvalSegments/{approvalSegmentId}'.sub('{' + 'approvalSegmentId' + '}', approval_segment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#update_approval_segment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_approval_matrix_csv(opts = {}) ⇒ ApprovalMatrixImportDataJson

Upload an Approval Matrix Upload a csv containing the order approval matrix to be used on order execution. The csv should have the following format: Segment, ApprovalRoleName1, ApprovalRoleName2 … SegmentName1, UserEmailOrGroupName1, UserEmailOrGroupName2 … Roles, userEmails, userGroups are expected to be added before putting them in this csv. Any new segment names defined here will add a new segment. If a segment isn’t added, it shall be deleted.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



918
919
920
921
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 918

def upload_approval_matrix_csv(opts = {})
  data, _status_code, _headers = upload_approval_matrix_csv_with_http_info(opts)
  data
end

#upload_approval_matrix_csv_with_http_info(opts = {}) ⇒ Array<(ApprovalMatrixImportDataJson, Fixnum, Hash)>

Upload an Approval Matrix Upload a csv containing the order approval matrix to be used on order execution. The csv should have the following format: Segment, ApprovalRoleName1, ApprovalRoleName2 … SegmentName1, UserEmailOrGroupName1, UserEmailOrGroupName2 … Roles, userEmails, userGroups are expected to be added before putting them in this csv. Any new segment names defined here will add a new segment. If a segment isn&#39;t added, it shall be deleted.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File)

Returns:



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
 
# File 'lib/subskribe_sandbox/api/approvals_api.rb', line 928

def upload_approval_matrix_csv_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApprovalsApi.upload_approval_matrix_csv ...'
  end
  # resource path
  local_var_path = '/approvalMatrix/csv'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApprovalMatrixImportDataJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApprovalsApi#upload_approval_matrix_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end