Class: Fastly::TlsCertificatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/tls_certificates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsCertificatesApi

Returns a new instance of TlsCertificatesApi.



17
18
19
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_tls_cert(opts = {}) ⇒ Object

Create a TLS certificate Create a TLS certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

  • (Object) 


24
25
26
27
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 24

def create_tls_cert(opts = {})
  data, _status_code, _headers = create_tls_cert_with_http_info(opts)
  data
end

#create_tls_cert_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create a TLS certificate Create a TLS certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    Object 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
76
77
78
79
80
81
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 33

def create_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsCertificatesApi.create_tls_cert ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/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/vnd.api+json'])
  # 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(opts[:'tls_certificate'])

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

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

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

#delete_tls_cert(opts = {}) ⇒ nil

Delete a TLS certificate Destroy a TLS certificate. TLS certificates already enabled for a domain cannot be destroyed.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 87

def delete_tls_cert(opts = {})
  delete_tls_cert_with_http_info(opts)
  nil
end

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

Delete a TLS certificate Destroy a TLS certificate. TLS certificates already enabled for a domain cannot be destroyed.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

Returns:

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

    nil, response status code and response headers



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
135
136
137
138
139
140
141
142
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 96

def delete_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsCertificatesApi.delete_tls_cert ...'
  end
  # unbox the parameters from the hash
  tls_certificate_id = opts[:'tls_certificate_id']
  # verify the required parameter 'tls_certificate_id' is set
  if @api_client.config.client_side_validation && tls_certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_certificate_id' when calling TlsCertificatesApi.delete_tls_cert"
  end
  # resource path
  local_var_path = '/tls/certificates/{tls_certificate_id}'.sub('{' + 'tls_certificate_id' + '}', CGI.escape(tls_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] || ['token']

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

#get_tls_cert(opts = {}) ⇒ TlsCertificateResponse

Get a TLS certificate Show a TLS certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

Returns:



148
149
150
151
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 148

def get_tls_cert(opts = {})
  data, _status_code, _headers = get_tls_cert_with_http_info(opts)
  data
end

#get_tls_cert_with_http_info(opts = {}) ⇒ Array<(TlsCertificateResponse, Integer, Hash)>

Get a TLS certificate Show a TLS certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

Returns:

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

    TlsCertificateResponse data, response status code and response headers



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
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 157

def get_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsCertificatesApi.get_tls_cert ...'
  end
  # unbox the parameters from the hash
  tls_certificate_id = opts[:'tls_certificate_id']
  # verify the required parameter 'tls_certificate_id' is set
  if @api_client.config.client_side_validation && tls_certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_certificate_id' when calling TlsCertificatesApi.get_tls_cert"
  end
  # resource path
  local_var_path = '/tls/certificates/{tls_certificate_id}'.sub('{' + 'tls_certificate_id' + '}', CGI.escape(tls_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/vnd.api+json'])

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

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

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

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

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

#list_tls_certs(opts = {}) ⇒ TlsCertificatesResponse

List TLS certificates List all TLS certificates.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Optional. Limit the returned certificates to those currently using Fastly to terminate TLS (that is, certificates associated with an activation). Permitted values: true, false.

  • :filter_not_after (String) —

    Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[lte]&#x3D;2020-05-05).

  • :filter_tls_domains_id (String) —

    Limit the returned certificates to those that include the specific domain.

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_activations&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :sort (String) —

    The order in which to list the results by creation date. (default to ‘created_at’)

Returns:



217
218
219
220
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 217

def list_tls_certs(opts = {})
  data, _status_code, _headers = list_tls_certs_with_http_info(opts)
  data
end

#list_tls_certs_with_http_info(opts = {}) ⇒ Array<(TlsCertificatesResponse, Integer, Hash)>

List TLS certificates List all TLS certificates.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Optional. Limit the returned certificates to those currently using Fastly to terminate TLS (that is, certificates associated with an activation). Permitted values: true, false.

  • :filter_not_after (String) —

    Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[lte]&#x3D;2020-05-05).

  • :filter_tls_domains_id (String) —

    Limit the returned certificates to those that include the specific domain.

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_activations&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

  • :sort (String) —

    The order in which to list the results by creation date. (default to ‘created_at’)

Returns:

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

    TlsCertificatesResponse data, response status code and response headers



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 232

def list_tls_certs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsCertificatesApi.list_tls_certs ...'
  end
  # unbox the parameters from the hash
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TlsCertificatesApi.list_tls_certs, must be smaller than or equal to 100.'
  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 TlsCertificatesApi.list_tls_certs, 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 = '/tls/certificates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[in_use]'] = opts[:'filter_in_use'] if !opts[:'filter_in_use'].nil?
  query_params[:'filter[not_after]'] = opts[:'filter_not_after'] if !opts[:'filter_not_after'].nil?
  query_params[:'filter[tls_domains.id]'] = opts[:'filter_tls_domains_id'] if !opts[:'filter_tls_domains_id'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].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'])

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

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

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

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

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

#update_tls_cert(opts = {}) ⇒ TlsCertificateResponse

Update a TLS certificate Replace a TLS certificate with a newly reissued TLS certificate, or update a TLS certificate’s name. If replacing a TLS certificate, the new TLS certificate must contain all SAN entries as the current TLS certificate. It must either have an exact matching list or contain a superset.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

  • :tls_certificate (TlsCertificate)

Returns:



301
302
303
304
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 301

def update_tls_cert(opts = {})
  data, _status_code, _headers = update_tls_cert_with_http_info(opts)
  data
end

#update_tls_cert_with_http_info(opts = {}) ⇒ Array<(TlsCertificateResponse, Integer, Hash)>

Update a TLS certificate Replace a TLS certificate with a newly reissued TLS certificate, or update a TLS certificate&#39;s name. If replacing a TLS certificate, the new TLS certificate must contain all SAN entries as the current TLS certificate. It must either have an exact matching list or contain a superset.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_certificate_id (String) —

    Alphanumeric string identifying a TLS certificate. (required)

  • :tls_certificate (TlsCertificate)

Returns:

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

    TlsCertificateResponse data, response status code and response headers



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
 
# File 'lib/fastly/api/tls_certificates_api.rb', line 311

def update_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsCertificatesApi.update_tls_cert ...'
  end
  # unbox the parameters from the hash
  tls_certificate_id = opts[:'tls_certificate_id']
  # verify the required parameter 'tls_certificate_id' is set
  if @api_client.config.client_side_validation && tls_certificate_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_certificate_id' when calling TlsCertificatesApi.update_tls_cert"
  end
  # resource path
  local_var_path = '/tls/certificates/{tls_certificate_id}'.sub('{' + 'tls_certificate_id' + '}', CGI.escape(tls_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/vnd.api+json'])
  # 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(opts[:'tls_certificate'])

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

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

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