Class: Fastly::TlsPrivateKeysApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TlsPrivateKeysApi

Returns a new instance of TlsPrivateKeysApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_tls_key(opts = {}) ⇒ TlsPrivateKeyResponse

Create a TLS private key Create a TLS private key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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

def create_tls_key(opts = {})
  data, _status_code, _headers = create_tls_key_with_http_info(opts)
  data
end

#create_tls_key_with_http_info(opts = {}) ⇒ Array<(TlsPrivateKeyResponse, Integer, Hash)>

Create a TLS private key Create a TLS private key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:

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

    TlsPrivateKeyResponse 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_private_keys_api.rb', line 33

def create_tls_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TlsPrivateKeysApi.create_tls_key ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/tls/private_keys'

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

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

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

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

#delete_tls_key(opts = {}) ⇒ nil

Delete a TLS private key Destroy a TLS private key. Only private keys not already matched to any certificates can be deleted.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_private_key_id (String) —

    Alphanumeric string identifying a private Key. (required)

Returns:

  • (nil) 


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

def delete_tls_key(opts = {})
  delete_tls_key_with_http_info(opts)
  nil
end

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

Delete a TLS private key Destroy a TLS private key. Only private keys not already matched to any certificates can be deleted.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_private_key_id (String) —

    Alphanumeric string identifying a private Key. (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_private_keys_api.rb', line 96

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

#get_tls_key(opts = {}) ⇒ TlsPrivateKeyResponse

Get a TLS private key Show a TLS private key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_private_key_id (String) —

    Alphanumeric string identifying a private Key. (required)

Returns:



148
149
150
151
 
# File 'lib/fastly/api/tls_private_keys_api.rb', line 148

def get_tls_key(opts = {})
  data, _status_code, _headers = get_tls_key_with_http_info(opts)
  data
end

#get_tls_key_with_http_info(opts = {}) ⇒ Array<(TlsPrivateKeyResponse, Integer, Hash)>

Get a TLS private key Show a TLS private key.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :tls_private_key_id (String) —

    Alphanumeric string identifying a private Key. (required)

Returns:

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

    TlsPrivateKeyResponse data, response status code and response headers



157
158
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
 
# File 'lib/fastly/api/tls_private_keys_api.rb', line 157

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

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

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

#list_tls_keys(opts = {}) ⇒ TlsPrivateKeysResponse

List TLS private keys List all TLS private keys.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Limit the returned keys to those without any matching TLS certificates. The only valid value is false.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:



213
214
215
216
 
# File 'lib/fastly/api/tls_private_keys_api.rb', line 213

def list_tls_keys(opts = {})
  data, _status_code, _headers = list_tls_keys_with_http_info(opts)
  data
end

#list_tls_keys_with_http_info(opts = {}) ⇒ Array<(TlsPrivateKeysResponse, Integer, Hash)>

List TLS private keys List all TLS private keys.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :filter_in_use (String) —

    Limit the returned keys to those without any matching TLS certificates. The only valid value is false.

  • :page_number (Integer) —

    Current page.

  • :page_size (Integer) —

    Number of records per page. (default to 20)

Returns:

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

    TlsPrivateKeysResponse data, response status code and response headers



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

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

  # resource path
  local_var_path = '/tls/private_keys'

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

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

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