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_response, opts = {}) ⇒ ForwarderResponse

Create Forwarder Create a forwarder. Requires the “audit.siem_streaming“ entitlement on the account; lower-tier accounts get 402.

Parameters:

  • forwarder_response (ForwarderResponse)
  • 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_response, opts = {})
  data, _status_code, _headers = create_forwarder_with_http_info(forwarder_response, opts)
  data
end

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

Create Forwarder Create a forwarder. Requires the &#x60;&#x60;audit.siem_streaming&#x60;&#x60; entitlement on the account; lower-tier accounts get 402.

Parameters:

  • forwarder_response (ForwarderResponse)
  • 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_response, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ForwardersApi.create_forwarder ...'
  end
  # verify the required parameter 'forwarder_response' is set
  if @api_client.config.client_side_validation && forwarder_response.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_response' 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_response)

  # 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 Soft-delete a forwarder. Delivery rows are retained per the normal forwarder_delivery retention; a future create with the same slug is allowed (the unique index is partial on deleted_at IS NULL).

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 Soft-delete a forwarder. Delivery rows are retained per the normal forwarder_delivery retention; a future create with the same slug is allowed (the unique index is partial on deleted_at IS NULL).

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 Execute a prepared HTTP request server-side and return the response. The same SSRF guard that gates the in-line forwarder loop is applied here — internal/private addresses, link-local IPs (including the EC2 metadata service at 169.254.169.254), unique-local IPv6, and ports outside the configured allowlist are all rejected.

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 Execute a prepared HTTP request server-side and return the response. The same SSRF guard that gates the in-line forwarder loop is applied here — internal/private addresses, link-local IPs (including the EC2 metadata service at 169.254.169.254), unique-local IPv6, and ports outside the configured allowlist are all rejected.

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. Returns 404 if no forwarder with that id exists in the caller’s account, including if the forwarder is soft-deleted. Header values in the response are always redacted regardless of caller permission.

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. Returns 404 if no forwarder with that id exists in the caller&#39;s account, including if the forwarder is soft-deleted. Header values in the response are always redacted regardless of caller permission.

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 rows for a forwarder. Default sort is “-created_at“. Cursor pagination via “page“. Filter by status (“succeeded“ / “failed“ / “filtered_out“ / “skipped_do_not_forward“) or by a “created_at“ range using the platform’s interval notation (“[2026-01-01T00:00:00Z,*)“). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_status (String)
  • :filter_created_at (String)
  • :page_size (Integer)
  • :page_after (String)

Returns:



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

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 rows for a forwarder. Default sort is &#x60;&#x60;-created_at&#x60;&#x60;. Cursor pagination via &#x60;&#x60;page&#x60;&#x60;. Filter by status (&#x60;&#x60;succeeded&#x60;&#x60; / &#x60;&#x60;failed&#x60;&#x60; / &#x60;&#x60;filtered_out&#x60;&#x60; / &#x60;&#x60;skipped_do_not_forward&#x60;&#x60;) or by a &#x60;&#x60;created_at&#x60;&#x60; range using the platform&#39;s interval notation (&#x60;&#x60;[2026-01-01T00:00:00Z,*)&#x60;&#x60;). Reads do not require the entitlement — a downgraded account can still inspect historical deliveries from when the forwarder was active.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter_status (String)
  • :filter_created_at (String)
  • :page_size (Integer)
  • :page_after (String)

Returns:



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
356
357
358
359
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 305

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

  # 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[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[after]'] = opts[:'page_after'] if !opts[:'page_after'].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 the authenticated account. Reads do not require the entitlement — a downgraded account can still inspect what they configured, they just can’t create new ones.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:



369
370
371
372
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 369

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 the authenticated account. Reads do not require the entitlement — a downgraded account can still inspect what they configured, they just can&#39;t create new ones.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    ForwarderListResponse data, response status code and response headers



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

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

  # 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?

  # 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 the forwarder. For each failed delivery row, re-attempt with the latest forwarder configuration and the original event payload. Returns counts.

Parameters:

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

    the optional parameters

Returns:



439
440
441
442
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 439

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 the forwarder. For each failed delivery row, re-attempt with the latest forwarder configuration and the original event payload. Returns counts.

Parameters:

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

    the optional parameters

Returns:



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 449

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 row with its outcome. Prior delivery rows are not modified.

Parameters:

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

    the optional parameters

Returns:



503
504
505
506
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 503

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 row with its outcome. Prior delivery rows are not modified.

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



514
515
516
517
518
519
520
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
554
555
556
557
558
559
560
561
562
563
564
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 514

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_response, opts = {}) ⇒ ForwarderResponse

Update Forwarder Full-replace update. PUT semantics — every field is overwritten. The header values must be re-supplied; the GET path redacts them, but a PUT body that contains “"<redacted>"“ would persist that literal. Customers must round-trip the actual secret back. This is the standard get-mutate-put pattern (see CLAUDE.md "Updating Resources via the API"); the SDK helpers track the un-redacted secret client-side so customers don’t usually need to re-enter it.

Parameters:

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

    the optional parameters

Returns:



572
573
574
575
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 572

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

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

Update Forwarder Full-replace update. PUT semantics — every field is overwritten. The header values must be re-supplied; the GET path redacts them, but a PUT body that contains &#x60;&#x60;&quot;&lt;redacted&gt;&quot;&#x60;&#x60; would persist that literal. Customers must round-trip the actual secret back. This is the standard get-mutate-put pattern (see CLAUDE.md &quot;Updating Resources via the API&quot;); the SDK helpers track the un-redacted secret client-side so customers don&#39;t usually need to re-enter it.

Parameters:

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

    the optional parameters

Returns:

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

    ForwarderResponse data, response status code and response headers



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
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
 
# File 'lib/smplkit/_generated/audit/lib/smplkit_audit_client/api/forwarders_api.rb', line 583

def update_forwarder_with_http_info(forwarder_id, forwarder_response, 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_response' is set
  if @api_client.config.client_side_validation && forwarder_response.nil?
    fail ArgumentError, "Missing the required parameter 'forwarder_response' 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_response)

  # 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