Class: Fastly::TlsConfigurationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsConfigurationsApi

Returns a new instance of TlsConfigurationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_tls_config(opts = {}) ⇒ TlsConfigurationResponse

Get a TLS configuration Show a TLS configuration.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_configuration_id (String) —

    Alphanumeric string identifying a TLS configuration. (required)

  • :include (String) —

    Include related objects. Optional, comma-separated values. Permitted values: `dns_records`.

Returns:



25
26
27
28
 
# File 'lib/fastly/api/tls_configurations_api.rb', line 25

def get_tls_config(opts = {})
  data, _status_code, _headers = get_tls_config_with_http_info(opts)
  data
end

#get_tls_config_with_http_info(opts = {}) ⇒ Array<(TlsConfigurationResponse, Integer, Hash)>

Get a TLS configuration Show a TLS configuration.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_configuration_id (String) —

    Alphanumeric string identifying a TLS configuration. (required)

  • :include (String) —

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

Returns:

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

    TlsConfigurationResponse data, response status code and response headers



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
82
83
84
 
# File 'lib/fastly/api/tls_configurations_api.rb', line 35

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

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

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

#list_tls_configs(opts = {}) ⇒ TlsConfigurationsResponse

List TLS configurations List all TLS configurations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_bulk (String) —

    Optionally filters by the bulk attribute.

  • :include (String) —

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

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



93
94
95
96
 
# File 'lib/fastly/api/tls_configurations_api.rb', line 93

def list_tls_configs(opts = {})
  data, _status_code, _headers = list_tls_configs_with_http_info(opts)
  data
end

#list_tls_configs_with_http_info(opts = {}) ⇒ Array<(TlsConfigurationsResponse, Integer, Hash)>

List TLS configurations List all TLS configurations.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_bulk (String) —

    Optionally filters by the bulk attribute.

  • :include (String) —

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

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

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

    TlsConfigurationsResponse data, response status code and response headers



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

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

  # resource path
  local_var_path = '/tls/configurations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filter[bulk]'] = opts[:'filter_bulk'] if !opts[:'filter_bulk'].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] || 'TlsConfigurationsResponse'

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

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

#update_tls_config(opts = {}) ⇒ TlsConfigurationResponse

Update a TLS configuration Update a TLS configuration.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_configuration_id (String) —

    Alphanumeric string identifying a TLS configuration. (required)

  • :tls_configuration (TlsConfiguration)

Returns:



167
168
169
170
 
# File 'lib/fastly/api/tls_configurations_api.rb', line 167

def update_tls_config(opts = {})
  data, _status_code, _headers = update_tls_config_with_http_info(opts)
  data
end

#update_tls_config_with_http_info(opts = {}) ⇒ Array<(TlsConfigurationResponse, Integer, Hash)>

Update a TLS configuration Update a TLS configuration.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_configuration_id (String) —

    Alphanumeric string identifying a TLS configuration. (required)

  • :tls_configuration (TlsConfiguration)

Returns:

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

    TlsConfigurationResponse data, response status code and response headers



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
223
224
225
226
227
228
229
230
 
# File 'lib/fastly/api/tls_configurations_api.rb', line 177

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

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

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

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