Class: Fastly::TlsDomainsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsDomainsApi

Returns a new instance of TlsDomainsApi.



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

def api_client
  @api_client
end

Instance Method Details

#list_tls_domains(opts = {}) ⇒ TlsDomainsResponse

List TLS domains List all TLS domains.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered "in use") Permitted values: true, false.

  • :filter_tls_certificates_id (String) —

    Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list.

  • :filter_tls_subscriptions_id (String) —

    Optional. Limit the returned domains to those for a given TLS subscription.

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`.

  • :sort (String) —

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

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



30
31
32
33
 
# File 'lib/fastly/api/tls_domains_api.rb', line 30

def list_tls_domains(opts = {})
  data, _status_code, _headers = list_tls_domains_with_http_info(opts)
  data
end

#list_tls_domains_with_http_info(opts = {}) ⇒ Array<(TlsDomainsResponse, Integer, Hash)>

List TLS domains List all TLS domains.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered &quot;in use&quot;) Permitted values: true, false.

  • :filter_tls_certificates_id (String) —

    Optional. Limit the returned domains to those listed in the given TLS certificate&#39;s SAN list.

  • :filter_tls_subscriptions_id (String) —

    Optional. Limit the returned domains to those for a given TLS subscription.

  • :include (String) —

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

  • :sort (String) —

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

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

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

    TlsDomainsResponse data, response status code and response headers



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
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fastly/api/tls_domains_api.rb', line 45

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

  # resource path
  local_var_path = '/tls/domains'

  # 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[tls_certificates.id]'] = opts[:'filter_tls_certificates_id'] if !opts[:'filter_tls_certificates_id'].nil?
  query_params[:'filter[tls_subscriptions.id]'] = opts[:'filter_tls_subscriptions_id'] if !opts[:'filter_tls_subscriptions_id'].nil?
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'TlsDomainsResponse'

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

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