Class: IonoscloudCertManager::CertificatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ionoscloud-cert-manager/api/certificates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CertificatesApi

Returns a new instance of CertificatesApi.



19
20
21
 
# File 'lib/ionoscloud-cert-manager/api/certificates_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/ionoscloud-cert-manager/api/certificates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#certificates_delete(certificate_id, opts = {}) ⇒ nil

Delete a Certificate by ID Deletes a certificate specified by its ID.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 27

def certificates_delete(certificate_id, opts = {})
  certificates_delete_with_http_info(certificate_id, opts)
  nil
end

#certificates_delete_with_http_info(certificate_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Certificate by ID Deletes a certificate specified by its ID.

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 37

def certificates_delete_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificatesApi.certificates_delete ...'
  end
  # verify the required parameter 'certificate_id' is set
  if @api_client.config.client_side_validation && certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'certificate_id' when calling CertificatesApi.certificates_delete"
  end
  # resource path
  local_var_path = '/certificatemanager/certificates/{certificateId}'.sub('{' + 'certificateId' + '}', CGI.escape(certificate_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] || ['basicAuth', 'tokenAuth']

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

#certificates_get(opts = {}) ⇒ CertificateCollectionDto

Get Certificates Retrieves all available certificates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    &#39;Limit&#39; and &#39;Offset&#39; are optional; you can use these filter parameters to retrieve only part of the results obtained by a request. Offset is the first element (from the complete list of elements) to be included in the response.

  • :limit (String) —

    &#39;Limit&#39; and &#39;Offset&#39; are optional; you can use these filter parameters to retrieve only part of the results of a query. If both &#39;Offset&#39; and &#39;Limit&#39;are specified, the offset lines are skipped before counting the returned limit lines.

Returns:



89
90
91
92
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 89

def certificates_get(opts = {})
  data, _status_code, _headers = certificates_get_with_http_info(opts)
  data
end

#certificates_get_by_id(certificate_id, opts = {}) ⇒ CertificateDto

Get a Certificate by ID Retrieves a certificate specified by its ID.

Parameters:

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 151

def certificates_get_by_id(certificate_id, opts = {})
  data, _status_code, _headers = certificates_get_by_id_with_http_info(certificate_id, opts)
  data
end

#certificates_get_by_id_with_http_info(certificate_id, opts = {}) ⇒ Array<(CertificateDto, Integer, Hash)>

Get a Certificate by ID Retrieves a certificate specified by its ID.

Parameters:

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

    the optional parameters

Returns:

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

    CertificateDto data, response status code and response headers



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 161

def certificates_get_by_id_with_http_info(certificate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificatesApi.certificates_get_by_id ...'
  end
  # verify the required parameter 'certificate_id' is set
  if @api_client.config.client_side_validation && certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'certificate_id' when calling CertificatesApi.certificates_get_by_id"
  end
  # resource path
  local_var_path = '/certificatemanager/certificates/{certificateId}'.sub('{' + 'certificateId' + '}', CGI.escape(certificate_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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#certificates_get_with_http_info(opts = {}) ⇒ Array<(CertificateCollectionDto, Integer, Hash)>

Get Certificates Retrieves all available certificates.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (String) —

    &#39;Limit&#39; and &#39;Offset&#39; are optional; you can use these filter parameters to retrieve only part of the results obtained by a request. Offset is the first element (from the complete list of elements) to be included in the response.

  • :limit (String) —

    &#39;Limit&#39; and &#39;Offset&#39; are optional; you can use these filter parameters to retrieve only part of the results of a query. If both &#39;Offset&#39; and &#39;Limit&#39;are specified, the offset lines are skipped before counting the returned limit lines.

Returns:

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

    CertificateCollectionDto data, response status code and response headers



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
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 100

def certificates_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificatesApi.certificates_get ...'
  end
  # resource path
  local_var_path = '/certificatemanager/certificates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#certificates_patch(certificate_id, certificate_patch_dto, opts = {}) ⇒ CertificateDto

Update a Certificate Name by ID Updates the name of the specified certificate.

Parameters:

  • certificate_id (String)
  • certificate_patch_dto (CertificatePatchDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



215
216
217
218
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 215

def certificates_patch(certificate_id, certificate_patch_dto, opts = {})
  data, _status_code, _headers = certificates_patch_with_http_info(certificate_id, certificate_patch_dto, opts)
  data
end

#certificates_patch_with_http_info(certificate_id, certificate_patch_dto, opts = {}) ⇒ Array<(CertificateDto, Integer, Hash)>

Update a Certificate Name by ID Updates the name of the specified certificate.

Parameters:

  • certificate_id (String)
  • certificate_patch_dto (CertificatePatchDto)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    CertificateDto data, response status code and response headers



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
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 226

def certificates_patch_with_http_info(certificate_id, certificate_patch_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificatesApi.certificates_patch ...'
  end
  # verify the required parameter 'certificate_id' is set
  if @api_client.config.client_side_validation && certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'certificate_id' when calling CertificatesApi.certificates_patch"
  end
  # verify the required parameter 'certificate_patch_dto' is set
  if @api_client.config.client_side_validation && certificate_patch_dto.nil?
    fail ArgumentError, "Missing the required parameter 'certificate_patch_dto' when calling CertificatesApi.certificates_patch"
  end
  # resource path
  local_var_path = '/certificatemanager/certificates/{certificateId}'.sub('{' + 'certificateId' + '}', CGI.escape(certificate_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(certificate_patch_dto)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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

#certificates_post(certificate_post_dto, opts = {}) ⇒ CertificateDto

Add a New Certificate Adds a new PEM (Privacy Enhanced Mail) file that is used to store SSL certificates and their associated private keys.

Parameters:

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 285

def certificates_post(certificate_post_dto, opts = {})
  data, _status_code, _headers = certificates_post_with_http_info(certificate_post_dto, opts)
  data
end

#certificates_post_with_http_info(certificate_post_dto, opts = {}) ⇒ Array<(CertificateDto, Integer, Hash)>

Add a New Certificate Adds a new PEM (Privacy Enhanced Mail) file that is used to store SSL certificates and their associated private keys.

Parameters:

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

    the optional parameters

Returns:

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

    CertificateDto data, response status code and response headers



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ionoscloud-cert-manager/api/certificates_api.rb', line 295

def certificates_post_with_http_info(certificate_post_dto, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificatesApi.certificates_post ...'
  end
  # verify the required parameter 'certificate_post_dto' is set
  if @api_client.config.client_side_validation && certificate_post_dto.nil?
    fail ArgumentError, "Missing the required parameter 'certificate_post_dto' when calling CertificatesApi.certificates_post"
  end
  # resource path
  local_var_path = '/certificatemanager/certificates'

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

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(certificate_post_dto)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'tokenAuth']

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