Class: Fastly::TlsBulkCertificatesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsBulkCertificatesApi

Returns a new instance of TlsBulkCertificatesApi.



17
18
19
 
# File 'lib/fastly/api/tls_bulk_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_bulk_certificates_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#delete_bulk_tls_cert(opts = {}) ⇒ nil

Delete a certificate Destroy a certificate. This disables TLS for all domains listed as SAN entries.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

Returns:

  • (nil) 


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

def delete_bulk_tls_cert(opts = {})
  delete_bulk_tls_cert_with_http_info(opts)
  nil
end

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

Delete a certificate Destroy a certificate. This disables TLS for all domains listed as SAN entries.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

Returns:

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

    nil, 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
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 33

def delete_bulk_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsBulkCertificatesApi.delete_bulk_tls_cert ...'
  end
  # unbox the parameters from the hash
  certificate_id = opts[:'certificate_id']
  # 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 TlsBulkCertificatesApi.delete_bulk_tls_cert"
  end
  # resource path
  local_var_path = '/tls/bulk/certificates/{certificate_id}'.sub('{' + 'certificate_id' + '}', 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] || ['token']

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

#get_tls_bulk_cert(opts = {}) ⇒ TlsBulkCertificateResponse

Get a certificate Retrieve a single certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

Returns:



85
86
87
88
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 85

def get_tls_bulk_cert(opts = {})
  data, _status_code, _headers = get_tls_bulk_cert_with_http_info(opts)
  data
end

#get_tls_bulk_cert_with_http_info(opts = {}) ⇒ Array<(TlsBulkCertificateResponse, Integer, Hash)>

Get a certificate Retrieve a single certificate.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

Returns:

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

    TlsBulkCertificateResponse data, response status code and response headers



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

def get_tls_bulk_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsBulkCertificatesApi.get_tls_bulk_cert ...'
  end
  # unbox the parameters from the hash
  certificate_id = opts[:'certificate_id']
  # 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 TlsBulkCertificatesApi.get_tls_bulk_cert"
  end
  # resource path
  local_var_path = '/tls/bulk/certificates/{certificate_id}'.sub('{' + 'certificate_id' + '}', 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/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] || 'TlsBulkCertificateResponse'

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

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

#list_tls_bulk_certs(opts = {}) ⇒ TlsBulkCertificatesResponse

List certificates List all certificates.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_tls_domain_id (String) —

    Filter certificates by their matching, fully-qualified domain name.

  • :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:



151
152
153
154
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 151

def list_tls_bulk_certs(opts = {})
  data, _status_code, _headers = list_tls_bulk_certs_with_http_info(opts)
  data
end

#list_tls_bulk_certs_with_http_info(opts = {}) ⇒ Array<(TlsBulkCertificatesResponse, Integer, Hash)>

List certificates List all certificates.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_tls_domain_id (String) —

    Filter certificates by their matching, fully-qualified domain name.

  • :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<(TlsBulkCertificatesResponse, Integer, Hash)>) —

    TlsBulkCertificatesResponse data, response status code and response headers



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 163

def list_tls_bulk_certs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsBulkCertificatesApi.list_tls_bulk_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 TlsBulkCertificatesApi.list_tls_bulk_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 TlsBulkCertificatesApi.list_tls_bulk_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/bulk/certificates'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[tls_domain.id]'] = opts[:'filter_tls_domain_id'] if !opts[:'filter_tls_domain_id'].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] || 'TlsBulkCertificatesResponse'

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

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

#update_bulk_tls_cert(opts = {}) ⇒ TlsBulkCertificateResponse

Update a certificate Replace a certificate with a newly reissued certificate. By using this endpoint, the original certificate will cease to be used for future TLS handshakes. Thus, only SAN entries that appear in the replacement certificate will become TLS enabled. Any SAN entries that are missing in the replacement certificate will become disabled.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

  • :tls_bulk_certificate (TlsBulkCertificate)

Returns:



229
230
231
232
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 229

def update_bulk_tls_cert(opts = {})
  data, _status_code, _headers = update_bulk_tls_cert_with_http_info(opts)
  data
end

#update_bulk_tls_cert_with_http_info(opts = {}) ⇒ Array<(TlsBulkCertificateResponse, Integer, Hash)>

Update a certificate Replace a certificate with a newly reissued certificate. By using this endpoint, the original certificate will cease to be used for future TLS handshakes. Thus, only SAN entries that appear in the replacement certificate will become TLS enabled. Any SAN entries that are missing in the replacement certificate will become disabled.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :certificate_id (String) —

    Alphanumeric string identifying a TLS bulk certificate. (required)

  • :tls_bulk_certificate (TlsBulkCertificate)

Returns:

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

    TlsBulkCertificateResponse data, response status code and response headers



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

def update_bulk_tls_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsBulkCertificatesApi.update_bulk_tls_cert ...'
  end
  # unbox the parameters from the hash
  certificate_id = opts[:'certificate_id']
  # 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 TlsBulkCertificatesApi.update_bulk_tls_cert"
  end
  # resource path
  local_var_path = '/tls/bulk/certificates/{certificate_id}'.sub('{' + 'certificate_id' + '}', 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/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_bulk_certificate'])

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

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

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

#upload_tls_bulk_cert(opts = {}) ⇒ TlsBulkCertificateResponse

Upload a certificate Upload a new certificate. TLS domains are automatically enabled upon certificate creation. If a domain is already enabled on a previously uploaded certificate, that domain will be updated to use the new certificate for all future TLS handshake requests.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



298
299
300
301
 
# File 'lib/fastly/api/tls_bulk_certificates_api.rb', line 298

def upload_tls_bulk_cert(opts = {})
  data, _status_code, _headers = upload_tls_bulk_cert_with_http_info(opts)
  data
end

#upload_tls_bulk_cert_with_http_info(opts = {}) ⇒ Array<(TlsBulkCertificateResponse, Integer, Hash)>

Upload a certificate Upload a new certificate. TLS domains are automatically enabled upon certificate creation. If a domain is already enabled on a previously uploaded certificate, that domain will be updated to use the new certificate for all future TLS handshake requests.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    TlsBulkCertificateResponse data, response status code and response headers



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

def upload_tls_bulk_cert_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsBulkCertificatesApi.upload_tls_bulk_cert ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/bulk/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_bulk_certificate'])

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

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

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