Class: Fastly::SecretStoreItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SecretStoreItemApi

Returns a new instance of SecretStoreItemApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_secret(opts = {}) ⇒ SecretResponse

Create a new secret in a store. Create a new secret in a store. Returns an error if a secret already exists with the same name. See ‘PUT` and `PATCH` methods for ways to recreate an existing secret. The `secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:



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

def create_secret(opts = {})
  data, _status_code, _headers = create_secret_with_http_info(opts)
  data
end

#create_secret_with_http_info(opts = {}) ⇒ Array<(SecretResponse, Integer, Hash)>

Create a new secret in a store. Create a new secret in a store. Returns an error if a secret already exists with the same name. See &#x60;PUT&#x60; and &#x60;PATCH&#x60; methods for ways to recreate an existing secret. The &#x60;secret&#x60; field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is &quot;Hello, world!&quot;

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:

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

    SecretResponse 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
85
86
87
88
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 35

def create_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecretStoreItemApi.create_secret ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling SecretStoreItemApi.create_secret"
  end
  # resource path
  local_var_path = '/resources/stores/secret/{store_id}/secrets'.sub('{' + 'store_id' + '}', CGI.escape(store_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/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[:'secret'])

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

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

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

#delete_secret(opts = {}) ⇒ nil

Delete a secret from a store. Delete a secret from a store by name.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret_name (String) — default: required

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 95

def delete_secret(opts = {})
  delete_secret_with_http_info(opts)
  nil
end

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

Delete a secret from a store. Delete a secret from a store by name.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret_name (String) — default: required

Returns:

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

    nil, 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
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 105

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

#get_secret(opts = {}) ⇒ SecretResponse

Get secret metadata. Get metadata about a secret by name.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret_name (String) — default: required

Returns:



163
164
165
166
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 163

def get_secret(opts = {})
  data, _status_code, _headers = get_secret_with_http_info(opts)
  data
end

#get_secret_with_http_info(opts = {}) ⇒ Array<(SecretResponse, Integer, Hash)>

Get secret metadata. Get metadata about a secret by name.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret_name (String) — default: required

Returns:

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

    SecretResponse data, response status code and response headers



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 173

def get_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecretStoreItemApi.get_secret ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  secret_name = opts[:'secret_name']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling SecretStoreItemApi.get_secret"
  end
  # verify the required parameter 'secret_name' is set
  if @api_client.config.client_side_validation && secret_name.nil?
    fail ArgumentError, "Missing the required parameter 'secret_name' when calling SecretStoreItemApi.get_secret"
  end
  # resource path
  local_var_path = '/resources/stores/secret/{store_id}/secrets/{secret_name}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s)).sub('{' + 'secret_name' + '}', CGI.escape(secret_name.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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#get_secrets(opts = {}) ⇒ InlineResponse2006

List secrets within a store. List all secrets within a store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (String) —

    Number of results per page. The maximum is 200. (default to ‘100’)

Returns:



234
235
236
237
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 234

def get_secrets(opts = {})
  data, _status_code, _headers = get_secrets_with_http_info(opts)
  data
end

#get_secrets_with_http_info(opts = {}) ⇒ Array<(InlineResponse2006, Integer, Hash)>

List secrets within a store. List all secrets within a store.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :cursor (String) —

    Cursor value from the &#x60;next_cursor&#x60; field of a previous response, used to retrieve the next page. To request the first page, this should be empty.

  • :limit (String) —

    Number of results per page. The maximum is 200. (default to ‘100’)

Returns:

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

    InlineResponse2006 data, response status code and response headers



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
291
292
293
294
295
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 245

def get_secrets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecretStoreItemApi.get_secrets ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling SecretStoreItemApi.get_secrets"
  end
  # resource path
  local_var_path = '/resources/stores/secret/{store_id}/secrets'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#must_recreate_secret(opts = {}) ⇒ SecretResponse

Recreate a secret in a store. Recreate a secret based on the secret’s name. Returns an error if there is no existing secret with the same name. The ‘secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:



302
303
304
305
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 302

def must_recreate_secret(opts = {})
  data, _status_code, _headers = must_recreate_secret_with_http_info(opts)
  data
end

#must_recreate_secret_with_http_info(opts = {}) ⇒ Array<(SecretResponse, Integer, Hash)>

Recreate a secret in a store. Recreate a secret based on the secret&#39;s name. Returns an error if there is no existing secret with the same name. The &#x60;secret&#x60; field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is &quot;Hello, world!&quot;

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:

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

    SecretResponse data, response status code and response headers



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
361
362
363
364
365
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 312

def must_recreate_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecretStoreItemApi.must_recreate_secret ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling SecretStoreItemApi.must_recreate_secret"
  end
  # resource path
  local_var_path = '/resources/stores/secret/{store_id}/secrets'.sub('{' + 'store_id' + '}', CGI.escape(store_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/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[:'secret'])

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

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

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

#recreate_secret(opts = {}) ⇒ SecretResponse

Create or recreate a secret in a store. Create or recreate a secret based on the secret’s name. The response object’s ‘recreated` field will be true if the secret was recreated. The `secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is "Hello, world!"

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:



372
373
374
375
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 372

def recreate_secret(opts = {})
  data, _status_code, _headers = recreate_secret_with_http_info(opts)
  data
end

#recreate_secret_with_http_info(opts = {}) ⇒ Array<(SecretResponse, Integer, Hash)>

Create or recreate a secret in a store. Create or recreate a secret based on the secret&#39;s name. The response object&#39;s &#x60;recreated&#x60; field will be true if the secret was recreated. The &#x60;secret&#x60; field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is &quot;Hello, world!&quot;

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :store_id (String) — default: required
  • :secret (Secret)

Returns:

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

    SecretResponse data, response status code and response headers



382
383
384
385
386
387
388
389
390
391
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
 
# File 'lib/fastly/api/secret_store_item_api.rb', line 382

def recreate_secret_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SecretStoreItemApi.recreate_secret ...'
  end
  # unbox the parameters from the hash
  store_id = opts[:'store_id']
  # verify the required parameter 'store_id' is set
  if @api_client.config.client_side_validation && store_id.nil?
    fail ArgumentError, "Missing the required parameter 'store_id' when calling SecretStoreItemApi.recreate_secret"
  end
  # resource path
  local_var_path = '/resources/stores/secret/{store_id}/secrets'.sub('{' + 'store_id' + '}', CGI.escape(store_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/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[:'secret'])

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

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

  new_options = opts.merge(
    :operation => :"SecretStoreItemApi.recreate_secret",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecretStoreItemApi#recreate_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end