Class: Fastly::AutomationTokensApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AutomationTokensApi

Returns a new instance of AutomationTokensApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_automation_token(opts = {}) ⇒ AutomationTokenCreateResponse

Create Automation Token Creates a new automation token.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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

def create_automation_token(opts = {})
  data, _status_code, _headers = create_automation_token_with_http_info(opts)
  data
end

#create_automation_token_with_http_info(opts = {}) ⇒ Array<(AutomationTokenCreateResponse, Integer, Hash)>

Create Automation Token Creates a new automation token.

Parameters:

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

    a customizable set of options

Options Hash (opts):

Returns:



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/automation_tokens_api.rb', line 33

def create_automation_token_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AutomationTokensApi.create_automation_token ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/automation-tokens'

  # 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[:'automation_token_create_request'])

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

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

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

#get_automation_token_id(opts = {}) ⇒ AutomationTokenResponse

Retrieve an Automation Token by ID Retrieves an automation token by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required

Returns:



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

def get_automation_token_id(opts = {})
  data, _status_code, _headers = get_automation_token_id_with_http_info(opts)
  data
end

#get_automation_token_id_with_http_info(opts = {}) ⇒ Array<(AutomationTokenResponse, Integer, Hash)>

Retrieve an Automation Token by ID Retrieves an automation token by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required

Returns:

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

    AutomationTokenResponse data, 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
143
144
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 96

def get_automation_token_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AutomationTokensApi.get_automation_token_id ...'
  end
  # unbox the parameters from the hash
  id = opts[:'id']
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AutomationTokensApi.get_automation_token_id"
  end
  # resource path
  local_var_path = '/automation-tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(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', 'application/problem+json'])

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

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

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

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

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

#get_automation_tokens_id_services(opts = {}) ⇒ InlineResponse2001

List Automation Token Services List of services associated with the automation token.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required
  • :per_page (Integer)
  • :page (Integer)

Returns:



152
153
154
155
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 152

def get_automation_tokens_id_services(opts = {})
  data, _status_code, _headers = get_automation_tokens_id_services_with_http_info(opts)
  data
end

#get_automation_tokens_id_services_with_http_info(opts = {}) ⇒ Array<(InlineResponse2001, Integer, Hash)>

List Automation Token Services List of services associated with the automation token.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required
  • :per_page (Integer)
  • :page (Integer)

Returns:

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

    InlineResponse2001 data, response status code and response headers



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
206
207
208
209
210
211
212
213
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 163

def get_automation_tokens_id_services_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AutomationTokensApi.get_automation_tokens_id_services ...'
  end
  # unbox the parameters from the hash
  id = opts[:'id']
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AutomationTokensApi.get_automation_tokens_id_services"
  end
  # resource path
  local_var_path = '/automation-tokens/{id}/services'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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', 'application/problem+json'])

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

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

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

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

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

#list_automation_tokens(opts = {}) ⇒ Array<AutomationTokenResponse>

List Customer Automation Tokens Lists all automation tokens for a customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer)
  • :page (Integer)

Returns:



220
221
222
223
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 220

def list_automation_tokens(opts = {})
  data, _status_code, _headers = list_automation_tokens_with_http_info(opts)
  data
end

#list_automation_tokens_with_http_info(opts = {}) ⇒ Array<(Array<AutomationTokenResponse>, Integer, Hash)>

List Customer Automation Tokens Lists all automation tokens for a customer.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :per_page (Integer)
  • :page (Integer)

Returns:

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

    Array<AutomationTokenResponse> data, response status code and response headers



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

def list_automation_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AutomationTokensApi.list_automation_tokens ...'
  end
  # unbox the parameters from the hash
  # resource path
  local_var_path = '/automation-tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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', 'application/problem+json'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AutomationTokenResponse>'

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

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

#revoke_automation_token_id(opts = {}) ⇒ AutomationTokenErrorResponse

Revoke an Automation Token by ID Revoke an automation token by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required

Returns:



281
282
283
284
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 281

def revoke_automation_token_id(opts = {})
  data, _status_code, _headers = revoke_automation_token_id_with_http_info(opts)
  data
end

#revoke_automation_token_id_with_http_info(opts = {}) ⇒ Array<(AutomationTokenErrorResponse, Integer, Hash)>

Revoke an Automation Token by ID Revoke an automation token by ID.

Parameters:

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

    a customizable set of options

Options Hash (opts):

  • :id (String) — default: required

Returns:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
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
 
# File 'lib/fastly/api/automation_tokens_api.rb', line 290

def revoke_automation_token_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AutomationTokensApi.revoke_automation_token_id ...'
  end
  # unbox the parameters from the hash
  id = opts[:'id']
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AutomationTokensApi.revoke_automation_token_id"
  end
  # resource path
  local_var_path = '/automation-tokens/{id}'.sub('{' + 'id' + '}', CGI.escape(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', 'application/problem+json'])

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

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

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

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

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