Class: OpenapiClient::EndpointsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/endpoints_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EndpointsApi

Returns a new instance of EndpointsApi.



19
20
21
 
# File 'lib/openapi_client/api/endpoints_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/openapi_client/api/endpoints_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#endpoints_get(opts = {}) ⇒ Array<Endpoint>

List all endpoints

Parameters:

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

    the optional parameters

Returns:



25
26
27
28
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 25

def endpoints_get(opts = {})
  data, _status_code, _headers = endpoints_get_with_http_info(opts)
  data
end

#endpoints_get_with_http_info(opts = {}) ⇒ Array<(Array<Endpoint>, Integer, Hash)>

List all endpoints

Parameters:

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

    the optional parameters

Returns:

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

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



33
34
35
36
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
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 33

def endpoints_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_get ...'
  end
  # resource path
  local_var_path = '/endpoints'

  # 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']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Endpoint>'

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

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

#endpoints_id_delete(id, opts = {}) ⇒ nil

Delete endpoint

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


81
82
83
84
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 81

def endpoints_id_delete(id, opts = {})
  endpoints_id_delete_with_http_info(id, opts)
  nil
end

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

Delete endpoint

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 90

def endpoints_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.endpoints_id_delete"
  end
  # resource path
  local_var_path = '/endpoints/{id}'.sub('{id}', CGI.escape(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] || ['BearerAuth']

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

#endpoints_id_get(id, opts = {}) ⇒ Endpoint

Get endpoint by ID

Parameters:

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

    the optional parameters

Returns:



140
141
142
143
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 140

def endpoints_id_get(id, opts = {})
  data, _status_code, _headers = endpoints_id_get_with_http_info(id, opts)
  data
end

#endpoints_id_get_with_http_info(id, opts = {}) ⇒ Array<(Endpoint, Integer, Hash)>

Get endpoint by ID

Parameters:

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

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 149

def endpoints_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.endpoints_id_get"
  end
  # resource path
  local_var_path = '/endpoints/{id}'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

#endpoints_id_put(id, update_endpoint_request, opts = {}) ⇒ Endpoint

Update endpoint

Parameters:

  • id (String)
  • update_endpoint_request (UpdateEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



202
203
204
205
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 202

def endpoints_id_put(id, update_endpoint_request, opts = {})
  data, _status_code, _headers = endpoints_id_put_with_http_info(id, update_endpoint_request, opts)
  data
end

#endpoints_id_put_with_http_info(id, update_endpoint_request, opts = {}) ⇒ Array<(Endpoint, Integer, Hash)>

Update endpoint

Parameters:

  • id (String)
  • update_endpoint_request (UpdateEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 212

def endpoints_id_put_with_http_info(id, update_endpoint_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.endpoints_id_put"
  end
  # verify the required parameter 'update_endpoint_request' is set
  if @api_client.config.client_side_validation && update_endpoint_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_endpoint_request' when calling EndpointsApi.endpoints_id_put"
  end
  # resource path
  local_var_path = '/endpoints/{id}'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

#endpoints_id_retry_policy_put(id, retry_policy, opts = {}) ⇒ Endpoint

Update retry policy for an endpoint

Parameters:

  • id (String)
  • retry_policy (RetryPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



274
275
276
277
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 274

def endpoints_id_retry_policy_put(id, retry_policy, opts = {})
  data, _status_code, _headers = endpoints_id_retry_policy_put_with_http_info(id, retry_policy, opts)
  data
end

#endpoints_id_retry_policy_put_with_http_info(id, retry_policy, opts = {}) ⇒ Array<(Endpoint, Integer, Hash)>

Update retry policy for an endpoint

Parameters:

  • id (String)
  • retry_policy (RetryPolicy)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



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
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
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 284

def endpoints_id_retry_policy_put_with_http_info(id, retry_policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_id_retry_policy_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.endpoints_id_retry_policy_put"
  end
  # verify the required parameter 'retry_policy' is set
  if @api_client.config.client_side_validation && retry_policy.nil?
    fail ArgumentError, "Missing the required parameter 'retry_policy' when calling EndpointsApi.endpoints_id_retry_policy_put"
  end
  # resource path
  local_var_path = '/endpoints/{id}/retry-policy'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

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

#endpoints_id_rotate_secret_post(id, opts = {}) ⇒ EndpointsIdRotateSecretPost200Response

Rotate endpoint signing secret

Parameters:

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

    the optional parameters

Returns:



345
346
347
348
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 345

def endpoints_id_rotate_secret_post(id, opts = {})
  data, _status_code, _headers = endpoints_id_rotate_secret_post_with_http_info(id, opts)
  data
end

#endpoints_id_rotate_secret_post_with_http_info(id, opts = {}) ⇒ Array<(EndpointsIdRotateSecretPost200Response, Integer, Hash)>

Rotate endpoint signing secret

Parameters:

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

    the optional parameters

Returns:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 354

def endpoints_id_rotate_secret_post_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EndpointsApi.endpoints_id_rotate_secret_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling EndpointsApi.endpoints_id_rotate_secret_post"
  end
  # resource path
  local_var_path = '/endpoints/{id}/rotate-secret'.sub('{id}', CGI.escape(id.to_s))

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

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

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

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

#endpoints_post(create_endpoint_request, opts = {}) ⇒ Endpoint

Create a new endpoint

Parameters:

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

    the optional parameters

Returns:



406
407
408
409
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 406

def endpoints_post(create_endpoint_request, opts = {})
  data, _status_code, _headers = endpoints_post_with_http_info(create_endpoint_request, opts)
  data
end

#endpoints_post_with_http_info(create_endpoint_request, opts = {}) ⇒ Array<(Endpoint, Integer, Hash)>

Create a new endpoint

Parameters:

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

    the optional parameters

Returns:

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

    Endpoint data, response status code and response headers



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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/openapi_client/api/endpoints_api.rb', line 415

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

  # 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(create_endpoint_request)

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

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

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