Class: Fastly::TlsActivationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsActivationsApi

Returns a new instance of TlsActivationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_tls_activation(opts = {}) ⇒ TlsActivationResponse

Enable TLS for a domain using a custom certificate Enable TLS for a particular TLS domain and certificate combination. These relationships must be specified to create the TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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

def create_tls_activation(opts = {})
  data, _status_code, _headers = create_tls_activation_with_http_info(opts)
  data
end

#create_tls_activation_with_http_info(opts = {}) ⇒ Array<(TlsActivationResponse, Integer, Hash)>

Enable TLS for a domain using a custom certificate Enable TLS for a particular TLS domain and certificate combination. These relationships must be specified to create the TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    TlsActivationResponse 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_activations_api.rb', line 33

def create_tls_activation_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsActivationsApi.create_tls_activation ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/activations'

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

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

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

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

#delete_tls_activation(opts = {}) ⇒ nil

Disable TLS on a domain Disable TLS on the domain associated with this TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (required)

Returns:

  • (nil) 


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

def delete_tls_activation(opts = {})
  delete_tls_activation_with_http_info(opts)
  nil
end

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

Disable TLS on a domain Disable TLS on the domain associated with this TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (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_activations_api.rb', line 96

def delete_tls_activation_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsActivationsApi.delete_tls_activation ...'
  end
  # unbox the parameters from the hash
  tls_activation_id = opts[:'tls_activation_id']
  # verify the required parameter 'tls_activation_id' is set
  if @api_client.config.client_side_validation && tls_activation_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_activation_id' when calling TlsActivationsApi.delete_tls_activation"
  end
  # resource path
  local_var_path = '/tls/activations/{tls_activation_id}'.sub('{' + 'tls_activation_id' + '}', CGI.escape(tls_activation_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 => :"TlsActivationsApi.delete_tls_activation",
    :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: TlsActivationsApi#delete_tls_activation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tls_activation(opts = {}) ⇒ TlsActivationResponse

Get a TLS activation Show a TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (required)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_certificate&#x60;, &#x60;tls_configuration&#x60;, and &#x60;tls_domain&#x60;.

Returns:



149
150
151
152
 
# File 'lib/fastly/api/tls_activations_api.rb', line 149

def get_tls_activation(opts = {})
  data, _status_code, _headers = get_tls_activation_with_http_info(opts)
  data
end

#get_tls_activation_with_http_info(opts = {}) ⇒ Array<(TlsActivationResponse, Integer, Hash)>

Get a TLS activation Show a TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (required)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_certificate&#x60;, &#x60;tls_configuration&#x60;, and &#x60;tls_domain&#x60;.

Returns:

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

    TlsActivationResponse data, response status code and response headers



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
206
207
208
 
# File 'lib/fastly/api/tls_activations_api.rb', line 159

def get_tls_activation_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsActivationsApi.get_tls_activation ...'
  end
  # unbox the parameters from the hash
  tls_activation_id = opts[:'tls_activation_id']
  # verify the required parameter 'tls_activation_id' is set
  if @api_client.config.client_side_validation && tls_activation_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_activation_id' when calling TlsActivationsApi.get_tls_activation"
  end
  # resource path
  local_var_path = '/tls/activations/{tls_activation_id}'.sub('{' + 'tls_activation_id' + '}', CGI.escape(tls_activation_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].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] || 'TlsActivationResponse'

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

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

#list_tls_activations(opts = {}) ⇒ TlsActivationsResponse

List TLS activations List all TLS activations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_tls_certificate_id (String) —

    Limit the returned activations to a specific certificate.

  • :filter_tls_configuration_id (String) —

    Limit the returned activations to a specific TLS configuration.

  • :filter_tls_domain_id (String) —

    Limit the returned rules to a specific domain name.

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_certificate&#x60;, &#x60;tls_configuration&#x60;, and &#x60;tls_domain&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



219
220
221
222
 
# File 'lib/fastly/api/tls_activations_api.rb', line 219

def list_tls_activations(opts = {})
  data, _status_code, _headers = list_tls_activations_with_http_info(opts)
  data
end

#list_tls_activations_with_http_info(opts = {}) ⇒ Array<(TlsActivationsResponse, Integer, Hash)>

List TLS activations List all TLS activations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_tls_certificate_id (String) —

    Limit the returned activations to a specific certificate.

  • :filter_tls_configuration_id (String) —

    Limit the returned activations to a specific TLS configuration.

  • :filter_tls_domain_id (String) —

    Limit the returned rules to a specific domain name.

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_certificate&#x60;, &#x60;tls_configuration&#x60;, and &#x60;tls_domain&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

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

    TlsActivationsResponse data, response status code and response headers



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

def list_tls_activations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsActivationsApi.list_tls_activations ...'
  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 TlsActivationsApi.list_tls_activations, 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 TlsActivationsApi.list_tls_activations, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/tls/activations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[tls_certificate.id]'] = opts[:'filter_tls_certificate_id'] if !opts[:'filter_tls_certificate_id'].nil?
  query_params[:'filter[tls_configuration.id]'] = opts[:'filter_tls_configuration_id'] if !opts[:'filter_tls_configuration_id'].nil?
  query_params[:'filter[tls_domain.id]'] = opts[:'filter_tls_domain_id'] if !opts[:'filter_tls_domain_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?

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

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

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

#update_tls_activation(opts = {}) ⇒ TlsActivationResponse

Update a certificate Update the certificate used to terminate TLS traffic for the domain associated with this TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (required)

  • :tls_activation (TlsActivation)

Returns:



297
298
299
300
 
# File 'lib/fastly/api/tls_activations_api.rb', line 297

def update_tls_activation(opts = {})
  data, _status_code, _headers = update_tls_activation_with_http_info(opts)
  data
end

#update_tls_activation_with_http_info(opts = {}) ⇒ Array<(TlsActivationResponse, Integer, Hash)>

Update a certificate Update the certificate used to terminate TLS traffic for the domain associated with this TLS activation.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_activation_id (String) —

    Alphanumeric string identifying a TLS activation. (required)

  • :tls_activation (TlsActivation)

Returns:

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

    TlsActivationResponse 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
356
357
358
359
360
 
# File 'lib/fastly/api/tls_activations_api.rb', line 307

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

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

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

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