Class: SmplkitGeneratedClient::Audit::ForwardersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ForwardersApi

Returns a new instance of ForwardersApi.



19
20
21
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_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/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_forwarder(forwarder_request, opts = {}) ⇒ ForwarderResponse

Create Forwarder Create a forwarder for this account.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 27

def create_forwarder(forwarder_request, opts = {})
  data, _status_code, _headers = create_forwarder_with_http_info(forwarder_request, opts)
  data
end

#create_forwarder_with_http_info(forwarder_request, opts = {}) ⇒ Array<(ForwarderResponse, Integer, Hash)>

Create Forwarder Create a forwarder for this account.

Parameters:

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

    the optional parameters

Returns:

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

    ForwarderResponse 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/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 37

def create_forwarder_with_http_info(forwarder_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.create_forwarder ...'
  end
  # verify the required parameter 'forwarder_request' is set
  if @api_client.config.client_side_validation && forwarder_request.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_request' when calling ForwardersApi.create_forwarder"
  end
  # resource path
  local_var_path = '/api/v1/forwarders'

  # 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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  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(forwarder_request)

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

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

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

#delete_forwarder(forwarder_id, opts = {}) ⇒ nil

Delete Forwarder Delete a forwarder. Past delivery log entries are retained. A new forwarder may be created later under the same name.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 95

def delete_forwarder(forwarder_id, opts = {})
  delete_forwarder_with_http_info(forwarder_id, opts)
  nil
end

#delete_forwarder_with_http_info(forwarder_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Forwarder Delete a forwarder. Past delivery log entries are retained. A new forwarder may be created later under the same name.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 105

def delete_forwarder_with_http_info(forwarder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.delete_forwarder ...'
  end
  # verify the required parameter 'forwarder_id' is set
  if @api_client.config.client_side_validation && forwarder_id.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.delete_forwarder"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}'.sub('{forwarder_id}', CGI.escape(forwarder_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"ForwardersApi.delete_forwarder",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ForwardersApi#delete_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#execute_test_forwarder(test_forwarder_request, opts = {}) ⇒ TestForwarderResponse

Execute Test Forwarder Send a test HTTP request to a forwarder destination and return the result. Useful for verifying a destination URL, credentials, or transform before saving the forwarder. The same network-safety rules that apply to live deliveries (private/internal address blocking, port allowlist) apply here.

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 156

def execute_test_forwarder(test_forwarder_request, opts = {})
  data, _status_code, _headers = execute_test_forwarder_with_http_info(test_forwarder_request, opts)
  data
end

#execute_test_forwarder_with_http_info(test_forwarder_request, opts = {}) ⇒ Array<(TestForwarderResponse, Integer, Hash)>

Execute Test Forwarder Send a test HTTP request to a forwarder destination and return the result. Useful for verifying a destination URL, credentials, or transform before saving the forwarder. The same network-safety rules that apply to live deliveries (private/internal address blocking, port allowlist) apply here.

Parameters:

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

    the optional parameters

Returns:

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

    TestForwarderResponse data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 166

def execute_test_forwarder_with_http_info(test_forwarder_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.execute_test_forwarder ...'
  end
  # verify the required parameter 'test_forwarder_request' is set
  if @api_client.config.client_side_validation && test_forwarder_request.nil?
    fail ArgumentError, "Missing the required parameter 'test_forwarder_request' when calling ForwardersApi.execute_test_forwarder"
  end
  # resource path
  local_var_path = '/api/v1/functions/test_forwarder/actions/execute'

  # 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']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  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(test_forwarder_request)

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

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

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

#get_forwarder(forwarder_id, opts = {}) ⇒ ForwarderResponse

Get Forwarder Retrieve a single forwarder by id. Header values are returned in plaintext so the resource can be round-tripped with ‘GET`, mutate, `PUT` without re-entering secrets.

Parameters:

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 224

def get_forwarder(forwarder_id, opts = {})
  data, _status_code, _headers = get_forwarder_with_http_info(forwarder_id, opts)
  data
end

#get_forwarder_with_http_info(forwarder_id, opts = {}) ⇒ Array<(ForwarderResponse, Integer, Hash)>

Get Forwarder Retrieve a single forwarder by id. Header values are returned in plaintext so the resource can be round-tripped with &#x60;GET&#x60;, mutate, &#x60;PUT&#x60; without re-entering secrets.

Parameters:

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

    the optional parameters

Returns:

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

    ForwarderResponse data, response status code and response headers



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 234

def get_forwarder_with_http_info(forwarder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.get_forwarder ...'
  end
  # verify the required parameter 'forwarder_id' is set
  if @api_client.config.client_side_validation && forwarder_id.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.get_forwarder"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}'.sub('{forwarder_id}', CGI.escape(forwarder_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/vnd.api+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] || 'ForwarderResponse'

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

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

#list_forwarder_deliveries(forwarder_id, opts = {}) ⇒ ForwarderDeliveryListResponse

List Forwarder Deliveries List delivery log entries for a forwarder. Default sort is ‘-created_at` (newest first). Filter by `status` (one of `SUCCEEDED`, `FAILED`, `FILTERED_OUT`, `SKIPPED_DO_NOT_FORWARD` — case-insensitive), by `event_id`, or by a `created_at` range using interval notation (e.g. `[2026-01-01T00:00:00Z,*)`).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_status (String)
  • :filter_created_at (String)
  • :filter_event_id (String)
  • :page_size (Integer)
  • :page_after (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;. (default to ‘-created_at’)

Returns:



293
294
295
296
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 293

def list_forwarder_deliveries(forwarder_id, opts = {})
  data, _status_code, _headers = list_forwarder_deliveries_with_http_info(forwarder_id, opts)
  data
end

#list_forwarder_deliveries_with_http_info(forwarder_id, opts = {}) ⇒ Array<(ForwarderDeliveryListResponse, Integer, Hash)>

List Forwarder Deliveries List delivery log entries for a forwarder. Default sort is &#x60;-created_at&#x60; (newest first). Filter by &#x60;status&#x60; (one of &#x60;SUCCEEDED&#x60;, &#x60;FAILED&#x60;, &#x60;FILTERED_OUT&#x60;, &#x60;SKIPPED_DO_NOT_FORWARD&#x60; — case-insensitive), by &#x60;event_id&#x60;, or by a &#x60;created_at&#x60; range using interval notation (e.g. &#x60;[2026-01-01T00:00:00Z,*)&#x60;).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_status (String)
  • :filter_created_at (String)
  • :filter_event_id (String)
  • :page_size (Integer)
  • :page_after (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;. (default to ‘-created_at’)

Returns:



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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 309

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

  allowable_values = ["created_at", "-created_at"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}/deliveries'.sub('{forwarder_id}', CGI.escape(forwarder_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[status]'] = opts[:'filter_status'] if !opts[:'filter_status'].nil?
  query_params[:'filter[created_at]'] = opts[:'filter_created_at'] if !opts[:'filter_created_at'].nil?
  query_params[:'filter[event_id]'] = opts[:'filter_event_id'] if !opts[:'filter_event_id'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'ForwarderDeliveryListResponse'

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

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

#list_forwarders(opts = {}) ⇒ ForwarderListResponse

List Forwarders List forwarders for this account. Default sort is ‘-created_at` (newest first). Pagination uses cursor tokens; keep the same `sort` value across paginated requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_forwarder_type (String)
  • :filter_enabled (Boolean)
  • :page_size (Integer)
  • :page_after (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to ‘-created_at’)

Returns:



380
381
382
383
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 380

def list_forwarders(opts = {})
  data, _status_code, _headers = list_forwarders_with_http_info(opts)
  data
end

#list_forwarders_with_http_info(opts = {}) ⇒ Array<(ForwarderListResponse, Integer, Hash)>

List Forwarders List forwarders for this account. Default sort is &#x60;-created_at&#x60; (newest first). Pagination uses cursor tokens; keep the same &#x60;sort&#x60; value across paginated requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_forwarder_type (String)
  • :filter_enabled (Boolean)
  • :page_size (Integer)
  • :page_after (String)
  • :sort (String) —

    Field to sort by. Prefix with &#x60;-&#x60; for descending order. Default: &#x60;-created_at&#x60;. Allowed values: &#x60;created_at&#x60;, &#x60;-created_at&#x60;, &#x60;updated_at&#x60;, &#x60;-updated_at&#x60;. (default to ‘-created_at’)

Returns:

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

    ForwarderListResponse data, response status code and response headers



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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 394

def list_forwarders_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.list_forwarders ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ForwardersApi.list_forwarders, must be greater than or equal to 1.'
  end

  allowable_values = ["created_at", "-created_at", "updated_at", "-updated_at"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v1/forwarders'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[forwarder_type]'] = opts[:'filter_forwarder_type'] if !opts[:'filter_forwarder_type'].nil?
  query_params[:'filter[enabled]'] = opts[:'filter_enabled'] if !opts[:'filter_enabled'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+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] || 'ForwarderListResponse'

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

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

#retry_failed_forwarder_deliveries(forwarder_id, opts = {}) ⇒ RetryFailedDeliveriesSummary

Retry Failed Forwarder Deliveries Retry every failed delivery for this forwarder. Each failed delivery is re-attempted using the forwarder’s current configuration and the original event. Returns the counts.

Parameters:

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 456

def retry_failed_forwarder_deliveries(forwarder_id, opts = {})
  data, _status_code, _headers = retry_failed_forwarder_deliveries_with_http_info(forwarder_id, opts)
  data
end

#retry_failed_forwarder_deliveries_with_http_info(forwarder_id, opts = {}) ⇒ Array<(RetryFailedDeliveriesSummary, Integer, Hash)>

Retry Failed Forwarder Deliveries Retry every failed delivery for this forwarder. Each failed delivery is re-attempted using the forwarder&#39;s current configuration and the original event. Returns the counts.

Parameters:

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

    the optional parameters

Returns:



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/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 466

def retry_failed_forwarder_deliveries_with_http_info(forwarder_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.retry_failed_forwarder_deliveries ...'
  end
  # verify the required parameter 'forwarder_id' is set
  if @api_client.config.client_side_validation && forwarder_id.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.retry_failed_forwarder_deliveries"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}/actions/retry_failed_deliveries'.sub('{forwarder_id}', CGI.escape(forwarder_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/vnd.api+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] || 'RetryFailedDeliveriesSummary'

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

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

#retry_forwarder_delivery(forwarder_id, delivery_id, opts = {}) ⇒ ForwarderDeliveryResponse

Retry Forwarder Delivery Retry a single failed delivery. Returns the new delivery log entry. The prior entry is left in place.

Parameters:

  • forwarder_id (String)
  • delivery_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



520
521
522
523
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 520

def retry_forwarder_delivery(forwarder_id, delivery_id, opts = {})
  data, _status_code, _headers = retry_forwarder_delivery_with_http_info(forwarder_id, delivery_id, opts)
  data
end

#retry_forwarder_delivery_with_http_info(forwarder_id, delivery_id, opts = {}) ⇒ Array<(ForwarderDeliveryResponse, Integer, Hash)>

Retry Forwarder Delivery Retry a single failed delivery. Returns the new delivery log entry. The prior entry is left in place.

Parameters:

  • forwarder_id (String)
  • delivery_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ForwarderDeliveryResponse data, response status code and response headers



531
532
533
534
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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 531

def retry_forwarder_delivery_with_http_info(forwarder_id, delivery_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.retry_forwarder_delivery ...'
  end
  # verify the required parameter 'forwarder_id' is set
  if @api_client.config.client_side_validation && forwarder_id.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.retry_forwarder_delivery"
  end
  # verify the required parameter 'delivery_id' is set
  if @api_client.config.client_side_validation && delivery_id.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_id' when calling ForwardersApi.retry_forwarder_delivery"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}/deliveries/{delivery_id}/actions/retry'.sub('{forwarder_id}', CGI.escape(forwarder_id.to_s)).sub('{delivery_id}', CGI.escape(delivery_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/vnd.api+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] || 'ForwarderDeliveryResponse'

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

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

#update_forwarder(forwarder_id, forwarder_request, opts = {}) ⇒ ForwarderResponse

Update Forwarder Replace an existing forwarder. Every writable field is overwritten.

Parameters:

  • forwarder_id (String)
  • forwarder_request (ForwarderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



589
590
591
592
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 589

def update_forwarder(forwarder_id, forwarder_request, opts = {})
  data, _status_code, _headers = update_forwarder_with_http_info(forwarder_id, forwarder_request, opts)
  data
end

#update_forwarder_with_http_info(forwarder_id, forwarder_request, opts = {}) ⇒ Array<(ForwarderResponse, Integer, Hash)>

Update Forwarder Replace an existing forwarder. Every writable field is overwritten.

Parameters:

  • forwarder_id (String)
  • forwarder_request (ForwarderRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ForwarderResponse data, response status code and response headers



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 600

def update_forwarder_with_http_info(forwarder_id, forwarder_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.update_forwarder ...'
  end
  # verify the required parameter 'forwarder_id' is set
  if @api_client.config.client_side_validation && forwarder_id.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_id' when calling ForwardersApi.update_forwarder"
  end
  # verify the required parameter 'forwarder_request' is set
  if @api_client.config.client_side_validation && forwarder_request.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_request' when calling ForwardersApi.update_forwarder"
  end
  # resource path
  local_var_path = '/api/v1/forwarders/{forwarder_id}'.sub('{forwarder_id}', CGI.escape(forwarder_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/vnd.api+json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
  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(forwarder_request)

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

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

  new_options = opts.merge(
    :operation => :"ForwardersApi.update_forwarder",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ForwardersApi#update_forwarder\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end