Class: Fastly::TlsSubscriptionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsSubscriptionsApi

Returns a new instance of TlsSubscriptionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_globalsign_email_challenge(opts = {}) ⇒ Object

Creates a GlobalSign email challenge. Creates an email challenge for a domain on a GlobalSign subscription. An email challenge will generate an email that can be used to validate domain ownership. If this challenge is created, then the domain can only be validated using email for the given subscription.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :tls_authorization_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :request_body (Hash<String, Object>)

Returns:

  • (Object) 


26
27
28
29
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 26

def create_globalsign_email_challenge(opts = {})
  data, _status_code, _headers = create_globalsign_email_challenge_with_http_info(opts)
  data
end

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

Creates a GlobalSign email challenge. Creates an email challenge for a domain on a GlobalSign subscription. An email challenge will generate an email that can be used to validate domain ownership. If this challenge is created, then the domain can only be validated using email for the given subscription.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :tls_authorization_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :request_body (Hash<String, Object>)

Returns:

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

    Object data, 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 37

def create_globalsign_email_challenge_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsSubscriptionsApi.create_globalsign_email_challenge ...'
  end
  # unbox the parameters from the hash
  tls_subscription_id = opts[:'tls_subscription_id']
  tls_authorization_id = opts[:'tls_authorization_id']
  # verify the required parameter 'tls_subscription_id' is set
  if @api_client.config.client_side_validation && tls_subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_subscription_id' when calling TlsSubscriptionsApi.create_globalsign_email_challenge"
  end
  # verify the required parameter 'tls_authorization_id' is set
  if @api_client.config.client_side_validation && tls_authorization_id.nil?
    fail ArgumentError, "Missing the required parameter 'tls_authorization_id' when calling TlsSubscriptionsApi.create_globalsign_email_challenge"
  end
  # resource path
  local_var_path = '/tls/subscriptions/{tls_subscription_id}/authorizations/{tls_authorization_id}/globalsign_email_challenges'.sub('{' + 'tls_subscription_id' + '}', CGI.escape(tls_subscription_id.to_s)).sub('{' + 'tls_authorization_id' + '}', CGI.escape(tls_authorization_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'
  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[:'request_body'])

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

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

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

#create_tls_sub(opts = {}) ⇒ TlsSubscriptionResponse

Create a TLS subscription Create a new TLS subscription. This response includes a list of possible challenges to verify domain ownership.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :force (Boolean) —

    A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain.

  • :tls_subscription (TlsSubscription)

Returns:



102
103
104
105
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 102

def create_tls_sub(opts = {})
  data, _status_code, _headers = create_tls_sub_with_http_info(opts)
  data
end

#create_tls_sub_with_http_info(opts = {}) ⇒ Array<(TlsSubscriptionResponse, Integer, Hash)>

Create a TLS subscription Create a new TLS subscription. This response includes a list of possible challenges to verify domain ownership.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :force (Boolean) —

    A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain.

  • :tls_subscription (TlsSubscription)

Returns:

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

    TlsSubscriptionResponse data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 112

def create_tls_sub_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsSubscriptionsApi.create_tls_sub ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/subscriptions'

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

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

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

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

#delete_globalsign_email_challenge(opts = {}) ⇒ nil

Delete a GlobalSign email challenge Deletes a GlobalSign email challenge. After a GlobalSign email challenge is deleted, the domain can use HTTP and DNS validation methods again.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :tls_authorization_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :globalsign_email_challenge_id (String) —

    Alphanumeric string identifying a GlobalSign email challenge. (required)

Returns:

  • (nil) 


169
170
171
172
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 169

def delete_globalsign_email_challenge(opts = {})
  delete_globalsign_email_challenge_with_http_info(opts)
  nil
end

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

Delete a GlobalSign email challenge Deletes a GlobalSign email challenge. After a GlobalSign email challenge is deleted, the domain can use HTTP and DNS validation methods again.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :tls_authorization_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :globalsign_email_challenge_id (String) —

    Alphanumeric string identifying a GlobalSign email challenge. (required)

Returns:

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

    nil, response status code and response headers



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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 180

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

#delete_tls_sub(opts = {}) ⇒ nil

Delete a TLS subscription Destroy a TLS subscription. A subscription cannot be destroyed if there are domains in the TLS enabled state.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

Returns:

  • (nil) 


242
243
244
245
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 242

def delete_tls_sub(opts = {})
  delete_tls_sub_with_http_info(opts)
  nil
end

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

Delete a TLS subscription Destroy a TLS subscription. A subscription cannot be destroyed if there are domains in the TLS enabled state.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

Returns:

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

    nil, response status code and response headers



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
295
296
297
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 251

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

#get_tls_sub(opts = {}) ⇒ TlsSubscriptionResponse

Get a TLS subscription Show a TLS subscription.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_authorizations&#x60;, &#x60;tls_authorizations.globalsign_email_challenge&#x60;, &#x60;tls_authorizations.self_managed_http_challenge&#x60;, and &#x60;tls_certificates&#x60;.

Returns:



304
305
306
307
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 304

def get_tls_sub(opts = {})
  data, _status_code, _headers = get_tls_sub_with_http_info(opts)
  data
end

#get_tls_sub_with_http_info(opts = {}) ⇒ Array<(TlsSubscriptionResponse, Integer, Hash)>

Get a TLS subscription Show a TLS subscription.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_authorizations&#x60;, &#x60;tls_authorizations.globalsign_email_challenge&#x60;, &#x60;tls_authorizations.self_managed_http_challenge&#x60;, and &#x60;tls_certificates&#x60;.

Returns:

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

    TlsSubscriptionResponse data, response status code and response headers



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

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

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

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

#list_tls_subs(opts = {}) ⇒ TlsSubscriptionsResponse

List TLS subscriptions List all TLS subscriptions.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_state (String) —

    Limit the returned subscriptions by state. Valid values are &#x60;pending&#x60;, &#x60;processing&#x60;, &#x60;issued&#x60;, &#x60;renewing&#x60;, and &#x60;failed&#x60;. Accepts parameters: &#x60;not&#x60; (e.g., &#x60;filter[not]&#x3D;renewing&#x60;).

  • :filter_tls_domains_id (String) —

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

  • :filter_has_active_order (Boolean) —

    Limit the returned subscriptions to those that have currently active orders. Permitted values: &#x60;true&#x60;.

  • :filter_certificate_authority (String) —

    Limit the returned subscriptions to a specific certification authority. Values may include &#x60;certainly&#x60;, &#x60;lets-encrypt&#x60;, or &#x60;globalsign&#x60;.

  • :sort (String) —

    The order in which to list the results. (default to ‘-created_at’)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_authorizations&#x60;, &#x60;tls_authorizations.globalsign_email_challenge&#x60;, &#x60;tls_authorizations.self_managed_http_challenge&#x60;, and &#x60;tls_certificates&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



376
377
378
379
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 376

def list_tls_subs(opts = {})
  data, _status_code, _headers = list_tls_subs_with_http_info(opts)
  data
end

#list_tls_subs_with_http_info(opts = {}) ⇒ Array<(TlsSubscriptionsResponse, Integer, Hash)>

List TLS subscriptions List all TLS subscriptions.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_state (String) —

    Limit the returned subscriptions by state. Valid values are &#x60;pending&#x60;, &#x60;processing&#x60;, &#x60;issued&#x60;, &#x60;renewing&#x60;, and &#x60;failed&#x60;. Accepts parameters: &#x60;not&#x60; (e.g., &#x60;filter[not]&#x3D;renewing&#x60;).

  • :filter_tls_domains_id (String) —

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

  • :filter_has_active_order (Boolean) —

    Limit the returned subscriptions to those that have currently active orders. Permitted values: &#x60;true&#x60;.

  • :filter_certificate_authority (String) —

    Limit the returned subscriptions to a specific certification authority. Values may include &#x60;certainly&#x60;, &#x60;lets-encrypt&#x60;, or &#x60;globalsign&#x60;.

  • :sort (String) —

    The order in which to list the results. (default to ‘-created_at’)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: &#x60;tls_authorizations&#x60;, &#x60;tls_authorizations.globalsign_email_challenge&#x60;, &#x60;tls_authorizations.self_managed_http_challenge&#x60;, and &#x60;tls_certificates&#x60;.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

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

    TlsSubscriptionsResponse data, response status code and response headers



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
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
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 392

def list_tls_subs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsSubscriptionsApi.list_tls_subs ...'
  end
  # unbox the parameters from the hash
  allowable_values = ["created_at", "-created_at", "tls_certificates.not_after", "-tls_certificates.not_after"]
  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
  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 TlsSubscriptionsApi.list_tls_subs, 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 TlsSubscriptionsApi.list_tls_subs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/tls/subscriptions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[state]'] = opts[:'filter_state'] if !opts[:'filter_state'].nil?
  query_params[:'filter[tls_domains.id]'] = opts[:'filter_tls_domains_id'] if !opts[:'filter_tls_domains_id'].nil?
  query_params[:'filter[has_active_order]'] = opts[:'filter_has_active_order'] if !opts[:'filter_has_active_order'].nil?
  query_params[:'filter[certificate_authority]'] = opts[:'filter_certificate_authority'] if !opts[:'filter_certificate_authority'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'TlsSubscriptionsResponse'

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

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

#patch_tls_sub(opts = {}) ⇒ TlsSubscriptionResponse

Update a TLS subscription Change the TLS domains or common name associated with this subscription, update the TLS configuration for this set of domains, or retry a subscription with state ‘failed` by setting the state to `retry`.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :force (Boolean) —

    A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain.

  • :tls_subscription (TlsSubscription)

Returns:



463
464
465
466
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 463

def patch_tls_sub(opts = {})
  data, _status_code, _headers = patch_tls_sub_with_http_info(opts)
  data
end

#patch_tls_sub_with_http_info(opts = {}) ⇒ Array<(TlsSubscriptionResponse, Integer, Hash)>

Update a TLS subscription Change the TLS domains or common name associated with this subscription, update the TLS configuration for this set of domains, or retry a subscription with state &#x60;failed&#x60; by setting the state to &#x60;retry&#x60;.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_subscription_id (String) —

    Alphanumeric string identifying a TLS subscription. (required)

  • :force (Boolean) —

    A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain.

  • :tls_subscription (TlsSubscription)

Returns:

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

    TlsSubscriptionResponse data, response status code and response headers



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/fastly/api/tls_subscriptions_api.rb', line 474

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

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

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

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

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