Class: LinodeOpenapiClient::AccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/api/account_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountApi

Returns a new instance of AccountApi.



19
20
21
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_client(api_version, client_id, opts = {}) ⇒ Object

Delete an OAuth client Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by [login.linode.com](login.linode.com), and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work). <<LB>> — - __CLI__. “‘ linode-cli account client-delete \ edc6790ea9db4d224c5c “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 28

def delete_client(api_version, client_id, opts = {})
  data, _status_code, _headers = delete_client_with_http_info(api_version, client_id, opts)
  data
end

#delete_client_with_http_info(api_version, client_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete an OAuth client Deletes an OAuth Client registered with Linode. The Client ID and Client secret will no longer be accepted by [login.linode.com](login.linode.com), and all tokens issued to this client will be invalidated (meaning that if your application was using a token, it will no longer work). &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account client-delete \ edc6790ea9db4d224c5c &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
89
90
91
92
93
94
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 39

def delete_client_with_http_info(api_version, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_client ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.delete_client"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.delete_client"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#delete_entity_transfer(api_version, token, opts = {}) ⇒ Object

Cancel an entity transfer __Deprecated__ Please run [Cancel a service transfer](techdocs.akamai.com/linode-api/reference/delete-service-transfer). <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:

  • (Object) 


102
103
104
105
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 102

def delete_entity_transfer(api_version, token, opts = {})
  data, _status_code, _headers = delete_entity_transfer_with_http_info(api_version, token, opts)
  data
end

#delete_entity_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Cancel an entity transfer __Deprecated__ Please run [Cancel a service transfer](techdocs.akamai.com/linode-api/reference/delete-service-transfer). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
161
162
163
164
165
166
167
168
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 113

def delete_entity_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_entity_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.delete_entity_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.delete_entity_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/entity-transfers/{token}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#delete_payment_method(api_version, payment_method_id, opts = {}) ⇒ Object

Delete a payment method Deactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, run the [Add a payment method](techdocs.akamai.com/linode-api/reference/post-payment-method) operation. To designate an existing Payment Method as the default method, run the [Set a default payment method](techdocs.akamai.com/linode-api/reference/post-make-payment-method-default) operation. <<LB>> — - __CLI__. “‘ linode-cli payment-methods delete 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to look up.

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

    the optional parameters

Returns:

  • (Object) 


176
177
178
179
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 176

def delete_payment_method(api_version, payment_method_id, opts = {})
  data, _status_code, _headers = delete_payment_method_with_http_info(api_version, payment_method_id, opts)
  data
end

#delete_payment_method_with_http_info(api_version, payment_method_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a payment method Deactivate the specified Payment Method. The default Payment Method can not be deleted. To add a new default Payment Method, run the [Add a payment method](techdocs.akamai.com/linode-api/reference/post-payment-method) operation. To designate an existing Payment Method as the default method, run the [Set a default payment method](techdocs.akamai.com/linode-api/reference/post-make-payment-method-default) operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli payment-methods delete 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to look up.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 187

def delete_payment_method_with_http_info(api_version, payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_payment_method ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.delete_payment_method"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'payment_method_id' is set
  if @api_client.config.client_side_validation && payment_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_id' when calling AccountApi.delete_payment_method"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payment-methods/{paymentMethodId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'paymentMethodId' + '}', CGI.escape(payment_method_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#delete_service_transfer(api_version, token, opts = {}) ⇒ Object

Cancel a service transfer Cancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the transfer must be [created](techdocs.akamai.com/linode-api/reference/post-service-transfer) again. When canceled, an email notification for the cancellation is sent to the account that created this transfer. Transfers can not be canceled if they are expired or have been accepted. This operation can only be accessed by the unrestricted users of the account that created this transfer. <<LB>> — - __CLI__. “‘ linode-cli service-transfers \ cancel 123E4567-E89B-12D3-A456-426614174000 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:

  • (Object) 


250
251
252
253
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 250

def delete_service_transfer(api_version, token, opts = {})
  data, _status_code, _headers = delete_service_transfer_with_http_info(api_version, token, opts)
  data
end

#delete_service_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Cancel a service transfer Cancels the Service Transfer for the provided token. Once canceled, a transfer cannot be accepted or otherwise acted on in any way. If canceled in error, the transfer must be [created](techdocs.akamai.com/linode-api/reference/post-service-transfer) again. When canceled, an email notification for the cancellation is sent to the account that created this transfer. Transfers can not be canceled if they are expired or have been accepted. This operation can only be accessed by the unrestricted users of the account that created this transfer. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli service-transfers \ cancel 123E4567-E89B-12D3-A456-426614174000 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 261

def delete_service_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_service_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.delete_service_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.delete_service_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/service-transfers/{token}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#delete_user(api_version, username, opts = {}) ⇒ Object

Delete a user Deletes a user. The API immediately logs the user out and removes all of its ‘grants`. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can’t delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation. - A parent account using an unrestricted proxy user can use this operation to delete a child account user. <<LB>> — - __CLI__. “‘ linode-cli users delete example_user “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:

  • (Object) 


324
325
326
327
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 324

def delete_user(api_version, username, opts = {})
  data, _status_code, _headers = delete_user_with_http_info(api_version, username, opts)
  data
end

#delete_user_with_http_info(api_version, username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a user Deletes a user. The API immediately logs the user out and removes all of its &#x60;grants&#x60;. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can&#39;t delete a child account parent user (proxy user). The API returns a 403 error if you target a proxy user with this operation. - A parent account using an unrestricted proxy user can use this operation to delete a child account user. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli users delete example_user &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 335

def delete_user_with_http_info(api_version, username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_user ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.delete_user"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling AccountApi.delete_user"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users/{username}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account(api_version, opts = {}) ⇒ GetAccount200Response

Get your account Returns the contact and billing information related to your Account. <<LB>> — - __CLI__. “‘ linode-cli account view “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



397
398
399
400
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 397

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

#get_account_agreements(api_version, opts = {}) ⇒ GetAccountAgreements200Response

List agreements Returns all agreements and their acceptance status for your account. <<LB>> — - __OAuth scopes__. “‘ account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



465
466
467
468
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 465

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

#get_account_agreements_with_http_info(api_version, opts = {}) ⇒ Array<(GetAccountAgreements200Response, Integer, Hash)>

List agreements Returns all agreements and their acceptance status for your account. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 475

def (api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_agreements ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account_agreements"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/agreements'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account_availability(api_version, id, opts = {}) ⇒ GetAccountAvailability200Response

Get a region’s service availability View the available services for your account in a specific region. __Note__. Only authorized users can access this. <<LB>> — - __CLI__. “‘ linode-cli account get-account-availability us-east “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • id (String) —

    The slug for the applicable data center. Run the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation to view the slug for each data center.

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

    the optional parameters

Returns:



534
535
536
537
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 534

def (api_version, id, opts = {})
  data, _status_code, _headers = (api_version, id, opts)
  data
end

#get_account_availability_with_http_info(api_version, id, opts = {}) ⇒ Array<(GetAccountAvailability200Response, Integer, Hash)>

Get a region&#39;s service availability View the available services for your account in a specific region. __Note__. Only authorized users can access this. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account get-account-availability us-east &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • id (String) —

    The slug for the applicable data center. Run the [List regions](techdocs.akamai.com/linode-api/reference/get-regions) operation to view the slug for each data center.

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

    the optional parameters

Returns:



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 545

def (api_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_availability ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account_availability"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # 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 AccountApi.get_account_availability"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/availability/{id}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account_login(api_version, login_id, opts = {}) ⇒ GetAccountLogin200Response

Get an account login Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This operation can only be accessed by the unrestricted users of the account. <<LB>> — - __CLI__. “‘ linode-cli account login-view 1234 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • login_id (Integer) —

    The ID of the login object to access.

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

    the optional parameters

Returns:



608
609
610
611
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 608

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

#get_account_login_with_http_info(api_version, login_id, opts = {}) ⇒ Array<(GetAccountLogin200Response, Integer, Hash)>

Get an account login Returns a Login object that displays information about a successful login. The logins that can be viewed can be for any user on the account, and are not limited to only the logins of the user that is accessing this API endpoint. This operation can only be accessed by the unrestricted users of the account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account login-view 1234 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • login_id (Integer) —

    The ID of the login object to access.

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

    the optional parameters

Returns:

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

    GetAccountLogin200Response data, response status code and response headers



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 619

def (api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_login ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account_login"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'login_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'login_id' when calling AccountApi.get_account_login"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/logins/{loginId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'loginId' + '}', CGI.escape(.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account_logins(api_version, opts = {}) ⇒ GetAccountLogins200Response

List user logins Returns a collection of successful logins for all users on the account during the last 90 days. This operation can only be accessed by the unrestricted users of an account. <<LB>> — - __CLI__. “‘ linode-cli account logins-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



681
682
683
684
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 681

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

#get_account_logins_with_http_info(api_version, opts = {}) ⇒ Array<(GetAccountLogins200Response, Integer, Hash)>

List user logins Returns a collection of successful logins for all users on the account during the last 90 days. This operation can only be accessed by the unrestricted users of an account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account logins-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    GetAccountLogins200Response data, response status code and response headers



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 691

def (api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_logins ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account_logins"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/logins'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account_settings(api_version, opts = {}) ⇒ GetAccountSettings200Response

Get account settings Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper. <<LB>> — - __CLI__. “‘ linode-cli account settings “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



749
750
751
752
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 749

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

#get_account_settings_with_http_info(api_version, opts = {}) ⇒ Array<(GetAccountSettings200Response, Integer, Hash)>

Get account settings Returns information related to your Account settings: Managed service subscription, Longview subscription, and network helper. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account settings &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 759

def (api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_settings ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account_settings"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/settings'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_account_with_http_info(api_version, opts = {}) ⇒ Array<(GetAccount200Response, Integer, Hash)>

Get your account Returns the contact and billing information related to your Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account view &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    GetAccount200Response data, response status code and response headers



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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 407

def (api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_account"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_availability(api_version, opts = {}) ⇒ GetAvailability200Response

List available services Returns a paginated list of the services available to you, for all Linode regions. __Note__. Only authorized Users can run this operation. <<LB>> — - __CLI__. “‘ linode-cli account get-availability “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



819
820
821
822
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 819

def get_availability(api_version, opts = {})
  data, _status_code, _headers = get_availability_with_http_info(api_version, opts)
  data
end

#get_availability_with_http_info(api_version, opts = {}) ⇒ Array<(GetAvailability200Response, Integer, Hash)>

List available services Returns a paginated list of the services available to you, for all Linode regions. __Note__. Only authorized Users can run this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account get-availability &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetAvailability200Response data, response status code and response headers



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 831

def get_availability_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_availability ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_availability"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_availability, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_availability, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_availability, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/availability'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_child_account(api_version, euuid, opts = {}) ⇒ GetChildAccount200Response

Get a child account View a specific child account based on its ‘euuid`. See [Parent and Child Accounts for Akamai Partners](www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts. __Note__. This operation can only be accessed by an unrestricted user, or restricted user with the `child_account_access` grant. <<LB>> — - __CLI__. “` linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` child_account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • euuid (String) —

    The child account to look up. You can run the [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its &#x60;euuid&#x60;.

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

    the optional parameters

Returns:



904
905
906
907
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 904

def (api_version, euuid, opts = {})
  data, _status_code, _headers = (api_version, euuid, opts)
  data
end

#get_child_account_with_http_info(api_version, euuid, opts = {}) ⇒ Array<(GetChildAccount200Response, Integer, Hash)>

Get a child account View a specific child account based on its &#x60;euuid&#x60;. See [Parent and Child Accounts for Akamai Partners](www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts. __Note__. This operation can only be accessed by an unrestricted user, or restricted user with the &#x60;child_account_access&#x60; grant. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli child-account view A1BC2DEF-34GH-567I-J890KLMN12O34P56 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; child_account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • euuid (String) —

    The child account to look up. You can run the [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its &#x60;euuid&#x60;.

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

    the optional parameters

Returns:

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

    GetChildAccount200Response data, response status code and response headers



915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 915

def (api_version, euuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_child_account ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_child_account"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'euuid' is set
  if @api_client.config.client_side_validation && euuid.nil?
    fail ArgumentError, "Missing the required parameter 'euuid' when calling AccountApi.get_child_account"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/child-accounts/{euuid}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'euuid' + '}', CGI.escape(euuid.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_child_accounts(api_version, opts = {}) ⇒ GetChildAccounts200Response

List child accounts Returns a paginated list of basic information for the child accounts that exist for your parent account. See [Parent and Child Accounts for Akamai Partners](www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts. __Note__. This operation can only be accessed by an unrestricted parent user, or restricted parent user with the ‘child_account_access` grant. <<LB>> — - __CLI__. “` linode-cli child-account list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` child_account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



979
980
981
982
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 979

def get_child_accounts(api_version, opts = {})
  data, _status_code, _headers = get_child_accounts_with_http_info(api_version, opts)
  data
end

#get_child_accounts_with_http_info(api_version, opts = {}) ⇒ Array<(GetChildAccounts200Response, Integer, Hash)>

List child accounts Returns a paginated list of basic information for the child accounts that exist for your parent account. See [Parent and Child Accounts for Akamai Partners](www.linode.com/docs/guides/parent-child-accounts/) for details on these accounts. __Note__. This operation can only be accessed by an unrestricted parent user, or restricted parent user with the &#x60;child_account_access&#x60; grant. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli child-account list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; child_account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetChildAccounts200Response data, response status code and response headers



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 991

def get_child_accounts_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_child_accounts ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_child_accounts"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_child_accounts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_child_accounts, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_child_accounts, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/child-accounts'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_client(api_version, client_id, opts = {}) ⇒ GetClient200Response

Get an OAuth client Returns information about a single OAuth client. <<LB>> — - __CLI__. “‘ linode-cli account client-view \ edc6790ea9db4d224c5c “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:



1064
1065
1066
1067
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1064

def get_client(api_version, client_id, opts = {})
  data, _status_code, _headers = get_client_with_http_info(api_version, client_id, opts)
  data
end

#get_client_thumbnail(api_version, client_id, opts = {}) ⇒ File

Get the OAuth client’s thumbnail Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:

  • (File) 


1138
1139
1140
1141
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1138

def get_client_thumbnail(api_version, client_id, opts = {})
  data, _status_code, _headers = get_client_thumbnail_with_http_info(api_version, client_id, opts)
  data
end

#get_client_thumbnail_with_http_info(api_version, client_id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Get the OAuth client&#39;s thumbnail Returns the thumbnail for this OAuth Client. This is a publicly-viewable endpoint, and can be accessed without authentication.

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1149

def get_client_thumbnail_with_http_info(api_version, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_client_thumbnail ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_client_thumbnail"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.get_client_thumbnail"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}/thumbnail'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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(['image/png', 'application/json']) unless header_params['Accept']

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

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

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

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

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

#get_client_with_http_info(api_version, client_id, opts = {}) ⇒ Array<(GetClient200Response, Integer, Hash)>

Get an OAuth client Returns information about a single OAuth client. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account client-view \ edc6790ea9db4d224c5c &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:

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

    GetClient200Response data, response status code and response headers



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1075

def get_client_with_http_info(api_version, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_client ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_client"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.get_client"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_clients(api_version, opts = {}) ⇒ GetClients200Response

List OAuth clients Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application. <<LB>> — - __CLI__. “‘ linode-cli account clients-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1213
1214
1215
1216
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1213

def get_clients(api_version, opts = {})
  data, _status_code, _headers = get_clients_with_http_info(api_version, opts)
  data
end

#get_clients_with_http_info(api_version, opts = {}) ⇒ Array<(GetClients200Response, Integer, Hash)>

List OAuth clients Returns a paginated list of OAuth Clients registered to your Account. OAuth Clients allow users to log into applications you write or host using their Linode Account, and may allow them to grant some level of access to their Linodes or other entities to your application. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account clients-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetClients200Response data, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1225

def get_clients_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_clients ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_clients"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_clients, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_clients, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_clients, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_enrolled_beta_program(api_version, beta_id, opts = {}) ⇒ GetEnrolledBetaProgram200Response

Get an enrolled Beta program Display an enrolled Beta Program for your Account. The Beta Program may be inactive. Only unrestricted Users can access this operation. <<LB>> — - __CLI__. “‘ linode-cli betas enrolled-view $betaId “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • beta_id (String) —

    The ID of the Beta Program.

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

    the optional parameters

Returns:



1298
1299
1300
1301
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1298

def get_enrolled_beta_program(api_version, beta_id, opts = {})
  data, _status_code, _headers = get_enrolled_beta_program_with_http_info(api_version, beta_id, opts)
  data
end

#get_enrolled_beta_program_with_http_info(api_version, beta_id, opts = {}) ⇒ Array<(GetEnrolledBetaProgram200Response, Integer, Hash)>

Get an enrolled Beta program Display an enrolled Beta Program for your Account. The Beta Program may be inactive. Only unrestricted Users can access this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli betas enrolled-view $betaId &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • beta_id (String) —

    The ID of the Beta Program.

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

    the optional parameters

Returns:



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1309

def get_enrolled_beta_program_with_http_info(api_version, beta_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_enrolled_beta_program ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_enrolled_beta_program"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'beta_id' is set
  if @api_client.config.client_side_validation && beta_id.nil?
    fail ArgumentError, "Missing the required parameter 'beta_id' when calling AccountApi.get_enrolled_beta_program"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/betas/{betaId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'betaId' + '}', CGI.escape(beta_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_enrolled_beta_programs(api_version, opts = {}) ⇒ GetEnrolledBetaPrograms200Response

List enrolled Beta programs Display all enrolled Beta Programs for your Account. Includes inactive as well as active Beta Programs. Only unrestricted Users can access this operation. <<LB>> — - __CLI__. “‘ linode-cli betas enrolled “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1373
1374
1375
1376
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1373

def get_enrolled_beta_programs(api_version, opts = {})
  data, _status_code, _headers = get_enrolled_beta_programs_with_http_info(api_version, opts)
  data
end

#get_enrolled_beta_programs_with_http_info(api_version, opts = {}) ⇒ Array<(GetEnrolledBetaPrograms200Response, Integer, Hash)>

List enrolled Beta programs Display all enrolled Beta Programs for your Account. Includes inactive as well as active Beta Programs. Only unrestricted Users can access this operation. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli betas enrolled &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1385

def get_enrolled_beta_programs_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_enrolled_beta_programs ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_enrolled_beta_programs"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_enrolled_beta_programs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_enrolled_beta_programs, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_enrolled_beta_programs, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/betas'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_entity_transfer(api_version, token, opts = {}) ⇒ GetEntityTransfer200Response

Get an entity transfer __Deprecated__ Please run [Get a service transfer request](techdocs.akamai.com/linode-api/reference/get-service-transfer). <<LB>> — - __OAuth scopes__. “‘ account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:



1458
1459
1460
1461
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1458

def get_entity_transfer(api_version, token, opts = {})
  data, _status_code, _headers = get_entity_transfer_with_http_info(api_version, token, opts)
  data
end

#get_entity_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(GetEntityTransfer200Response, Integer, Hash)>

Get an entity transfer __Deprecated__ Please run [Get a service transfer request](techdocs.akamai.com/linode-api/reference/get-service-transfer). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1469

def get_entity_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_entity_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_entity_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.get_entity_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/entity-transfers/{token}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_entity_transfers(api_version, opts = {}) ⇒ GetEntityTransfers200Response

List entity transfers __Deprecated__ Please run [List service transfers](techdocs.akamai.com/linode-api/reference/get-service-transfers). <<LB>> — - __OAuth scopes__. “‘ account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1533
1534
1535
1536
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1533

def get_entity_transfers(api_version, opts = {})
  data, _status_code, _headers = get_entity_transfers_with_http_info(api_version, opts)
  data
end

#get_entity_transfers_with_http_info(api_version, opts = {}) ⇒ Array<(GetEntityTransfers200Response, Integer, Hash)>

List entity transfers __Deprecated__ Please run [List service transfers](techdocs.akamai.com/linode-api/reference/get-service-transfers). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1545

def get_entity_transfers_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_entity_transfers ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_entity_transfers"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_entity_transfers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_entity_transfers, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_entity_transfers, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/entity-transfers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_event(api_version, event_id, opts = {}) ⇒ GetEvent200Response

Get an event Returns a single Event object. <<LB>> — - __CLI__. “‘ linode-cli events view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` events:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event.

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

    the optional parameters

Returns:



1618
1619
1620
1621
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1618

def get_event(api_version, event_id, opts = {})
  data, _status_code, _headers = get_event_with_http_info(api_version, event_id, opts)
  data
end

#get_event_with_http_info(api_version, event_id, opts = {}) ⇒ Array<(GetEvent200Response, Integer, Hash)>

Get an event Returns a single Event object. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli events view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; events:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event.

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

    the optional parameters

Returns:

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

    GetEvent200Response data, response status code and response headers



1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1629

def get_event_with_http_info(api_version, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_event ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_event"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling AccountApi.get_event"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/events/{eventId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_events(api_version, opts = {}) ⇒ GetEvents200Response

List events Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants. <<LB>> — - __CLI__. “‘ linode-cli events list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` events:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1693
1694
1695
1696
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1693

def get_events(api_version, opts = {})
  data, _status_code, _headers = get_events_with_http_info(api_version, opts)
  data
end

#get_events_with_http_info(api_version, opts = {}) ⇒ Array<(GetEvents200Response, Integer, Hash)>

List events Returns a collection of Event objects representing actions taken on your Account from the last 90 days. The Events returned depend on your grants. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli events list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; events:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetEvents200Response data, response status code and response headers



1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1705

def get_events_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_events ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_events"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_events, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_events, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_events, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/events'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_invoice(api_version, invoice_id, opts = {}) ⇒ GetInvoice200Response

Get an invoice Returns a single Invoice object. <<LB>> — - __CLI__. “‘ linode-cli account invoice-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • invoice_id (Integer) —

    The ID of the Invoice.

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

    the optional parameters

Returns:



1778
1779
1780
1781
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1778

def get_invoice(api_version, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_with_http_info(api_version, invoice_id, opts)
  data
end

#get_invoice_items(api_version, invoice_id, opts = {}) ⇒ GetInvoiceItems200Response

List invoice items Returns a paginated list of Invoice items. <<LB>> — - __CLI__. “‘ linode-cli account invoice-items 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • invoice_id (Integer) —

    The ID of the Invoice.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1854
1855
1856
1857
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1854

def get_invoice_items(api_version, invoice_id, opts = {})
  data, _status_code, _headers = get_invoice_items_with_http_info(api_version, invoice_id, opts)
  data
end

#get_invoice_items_with_http_info(api_version, invoice_id, opts = {}) ⇒ Array<(GetInvoiceItems200Response, Integer, Hash)>

List invoice items Returns a paginated list of Invoice items. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account invoice-items 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • invoice_id (Integer) —

    The ID of the Invoice.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetInvoiceItems200Response data, response status code and response headers



1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1867

def get_invoice_items_with_http_info(api_version, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_invoice_items ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_invoice_items"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountApi.get_invoice_items"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_invoice_items, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_invoice_items, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_invoice_items, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/invoices/{invoiceId}/items'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'invoiceId' + '}', CGI.escape(invoice_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_invoice_with_http_info(api_version, invoice_id, opts = {}) ⇒ Array<(GetInvoice200Response, Integer, Hash)>

Get an invoice Returns a single Invoice object. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account invoice-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • invoice_id (Integer) —

    The ID of the Invoice.

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

    the optional parameters

Returns:

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

    GetInvoice200Response data, response status code and response headers



1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1789

def get_invoice_with_http_info(api_version, invoice_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_invoice ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_invoice"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'invoice_id' is set
  if @api_client.config.client_side_validation && invoice_id.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_id' when calling AccountApi.get_invoice"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/invoices/{invoiceId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'invoiceId' + '}', CGI.escape(invoice_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_invoices(api_version, opts = {}) ⇒ GetInvoices200Response

List invoices Returns a paginated list of Invoices against your Account. <<LB>> — - __CLI__. “‘ linode-cli account invoices-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



1945
1946
1947
1948
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1945

def get_invoices(api_version, opts = {})
  data, _status_code, _headers = get_invoices_with_http_info(api_version, opts)
  data
end

#get_invoices_with_http_info(api_version, opts = {}) ⇒ Array<(GetInvoices200Response, Integer, Hash)>

List invoices Returns a paginated list of Invoices against your Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account invoices-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetInvoices200Response data, response status code and response headers



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 1957

def get_invoices_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_invoices ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_invoices"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_invoices, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_invoices, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_invoices, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/invoices'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_maintenance(api_version, opts = {}) ⇒ GetMaintenance200Response

List maintenances Returns a collection of Maintenance objects for any entity a user has permissions to view. Canceled Maintenance objects are not returned. Currently, Linodes are the only entities available for viewing. <<LB>> — - __CLI__. “‘ linode-cli account maintenance-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



2029
2030
2031
2032
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2029

def get_maintenance(api_version, opts = {})
  data, _status_code, _headers = get_maintenance_with_http_info(api_version, opts)
  data
end

#get_maintenance_with_http_info(api_version, opts = {}) ⇒ Array<(GetMaintenance200Response, Integer, Hash)>

List maintenances Returns a collection of Maintenance objects for any entity a user has permissions to view. Canceled Maintenance objects are not returned. Currently, Linodes are the only entities available for viewing. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account maintenance-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    GetMaintenance200Response data, response status code and response headers



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2039

def get_maintenance_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_maintenance ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_maintenance"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/maintenance'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_notifications(api_version, opts = {}) ⇒ GetNotifications200Response

List notifications Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. You cannot interact directly with Notifications, and a Notification will disappear when the circumstances causing it have been resolved. For example, if you have an important Ticket open, you must respond to the Ticket to dismiss the Notification. <<LB>> — - __CLI__. “‘ linode-cli account notifications-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



2097
2098
2099
2100
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2097

def get_notifications(api_version, opts = {})
  data, _status_code, _headers = get_notifications_with_http_info(api_version, opts)
  data
end

#get_notifications_with_http_info(api_version, opts = {}) ⇒ Array<(GetNotifications200Response, Integer, Hash)>

List notifications Returns a collection of Notification objects representing important, often time-sensitive items related to your Account. You cannot interact directly with Notifications, and a Notification will disappear when the circumstances causing it have been resolved. For example, if you have an important Ticket open, you must respond to the Ticket to dismiss the Notification. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account notifications-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    GetNotifications200Response data, response status code and response headers



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2107

def get_notifications_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_notifications ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_notifications"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/notifications'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_payment(api_version, payment_id, opts = {}) ⇒ GetPayments200ResponseDataInner

Get a payment Returns information about a specific Payment. <<LB>> — - __CLI__. “‘ linode-cli account payment-view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_id (Integer) —

    The ID of the Payment to look up.

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

    the optional parameters

Returns:



2166
2167
2168
2169
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2166

def get_payment(api_version, payment_id, opts = {})
  data, _status_code, _headers = get_payment_with_http_info(api_version, payment_id, opts)
  data
end

#get_payment_method(api_version, payment_method_id, opts = {}) ⇒ GetPaymentMethod200Response

Get a payment method View the details of the specified Payment Method. <<LB>> — - __CLI__. “‘ linode-cli payment-methods view 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to look up.

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

    the optional parameters

Returns:



2240
2241
2242
2243
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2240

def get_payment_method(api_version, payment_method_id, opts = {})
  data, _status_code, _headers = get_payment_method_with_http_info(api_version, payment_method_id, opts)
  data
end

#get_payment_method_with_http_info(api_version, payment_method_id, opts = {}) ⇒ Array<(GetPaymentMethod200Response, Integer, Hash)>

Get a payment method View the details of the specified Payment Method. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli payment-methods view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to look up.

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

    the optional parameters

Returns:

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

    GetPaymentMethod200Response data, response status code and response headers



2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2251

def get_payment_method_with_http_info(api_version, payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_payment_method ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_payment_method"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'payment_method_id' is set
  if @api_client.config.client_side_validation && payment_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_id' when calling AccountApi.get_payment_method"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payment-methods/{paymentMethodId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'paymentMethodId' + '}', CGI.escape(payment_method_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_payment_methods(api_version, opts = {}) ⇒ GetPaymentMethods200Response

List payment methods Returns a paginated list of Payment Methods for this Account. <<LB>> — - __CLI__. “‘ linode-cli payment-methods list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2315
2316
2317
2318
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2315

def get_payment_methods(api_version, opts = {})
  data, _status_code, _headers = get_payment_methods_with_http_info(api_version, opts)
  data
end

#get_payment_methods_with_http_info(api_version, opts = {}) ⇒ Array<(GetPaymentMethods200Response, Integer, Hash)>

List payment methods Returns a paginated list of Payment Methods for this Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli payment-methods list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2327

def get_payment_methods_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_payment_methods ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_payment_methods"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_payment_methods, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_payment_methods, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_payment_methods, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/payment-methods'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_payment_with_http_info(api_version, payment_id, opts = {}) ⇒ Array<(GetPayments200ResponseDataInner, Integer, Hash)>

Get a payment Returns information about a specific Payment. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account payment-view 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_id (Integer) —

    The ID of the Payment to look up.

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

    the optional parameters

Returns:



2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2177

def get_payment_with_http_info(api_version, payment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_payment ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_payment"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'payment_id' is set
  if @api_client.config.client_side_validation && payment_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_id' when calling AccountApi.get_payment"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payments/{paymentId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(payment_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_payments(api_version, opts = {}) ⇒ GetPayments200Response

List payments Returns a paginated list of Payments made on this Account. <<LB>> — - __CLI__. “‘ linode-cli account payments-list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2401
2402
2403
2404
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2401

def get_payments(api_version, opts = {})
  data, _status_code, _headers = get_payments_with_http_info(api_version, opts)
  data
end

#get_payments_with_http_info(api_version, opts = {}) ⇒ Array<(GetPayments200Response, Integer, Hash)>

List payments Returns a paginated list of Payments made on this Account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account payments-list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetPayments200Response data, response status code and response headers



2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2413

def get_payments_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_payments ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_payments"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_payments, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_payments, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_payments, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/payments'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_service_transfer(api_version, token, opts = {}) ⇒ GetServiceTransfer200Response

Get a service transfer request Returns the details of the Service Transfer for the provided token. While a transfer is pending, any unrestricted user _of any account_ can access this operation. After a transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and accepted the transfer. If canceled or expired, only unrestricted users of the account that created the transfer can view it. <<LB>> — - __CLI__. “‘ linode-cli service-transfers \ view 123E4567-E89B-12D3-A456-426614174000 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:



2486
2487
2488
2489
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2486

def get_service_transfer(api_version, token, opts = {})
  data, _status_code, _headers = get_service_transfer_with_http_info(api_version, token, opts)
  data
end

#get_service_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(GetServiceTransfer200Response, Integer, Hash)>

Get a service transfer request Returns the details of the Service Transfer for the provided token. While a transfer is pending, any unrestricted user _of any account_ can access this operation. After a transfer has been accepted, it can only be viewed by unrestricted users of the accounts that created and accepted the transfer. If canceled or expired, only unrestricted users of the account that created the transfer can view it. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli service-transfers \ view 123E4567-E89B-12D3-A456-426614174000 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:



2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2497

def get_service_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_service_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_service_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.get_service_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/service-transfers/{token}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_service_transfers(api_version, opts = {}) ⇒ GetServiceTransfers200Response

List service transfers Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer. This operation can only be accessed by the unrestricted users of an account. <<LB>> — - __CLI__. “‘ linode-cli service-transfers \ list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2561
2562
2563
2564
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2561

def get_service_transfers(api_version, opts = {})
  data, _status_code, _headers = get_service_transfers_with_http_info(api_version, opts)
  data
end

#get_service_transfers_with_http_info(api_version, opts = {}) ⇒ Array<(GetServiceTransfers200Response, Integer, Hash)>

List service transfers Returns a collection of all created and accepted Service Transfers for this account, regardless of the user that created or accepted the transfer. This operation can only be accessed by the unrestricted users of an account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli service-transfers \ list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2573

def get_service_transfers_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_service_transfers ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_service_transfers"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_service_transfers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_service_transfers, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_service_transfers, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/service-transfers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_transfer(api_version, opts = {}) ⇒ GetTransfer200Response

Get network usage Returns a Transfer object showing your network utilization, in GB, for the current month. <<LB>> — - __CLI__. “‘ linode-cli account transfer “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:



2645
2646
2647
2648
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2645

def get_transfer(api_version, opts = {})
  data, _status_code, _headers = get_transfer_with_http_info(api_version, opts)
  data
end

#get_transfer_with_http_info(api_version, opts = {}) ⇒ Array<(GetTransfer200Response, Integer, Hash)>

Get network usage Returns a Transfer object showing your network utilization, in GB, for the current month. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account transfer &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    GetTransfer200Response data, response status code and response headers



2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2655

def get_transfer_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/transfer'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_user(api_version, username, opts = {}) ⇒ GetUser200Response

Get a user Returns information about a single user on your account. __Note__. This operation can only be accessed by account users with unrestricted access. <<LB>> — - __CLI__. “‘ linode-cli users view example_user “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:



2714
2715
2716
2717
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2714

def get_user(api_version, username, opts = {})
  data, _status_code, _headers = get_user_with_http_info(api_version, username, opts)
  data
end

#get_user_grants(api_version, username, opts = {}) ⇒ GetUserGrants200Response

List a user’s grants Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them. This doesn’t apply to the account owner or the current authenticated user. You can run the [List grants](techdocs.akamai.com/linode-api/reference/get-profile-grants) operation to view those grants. However, this doesn’t show the entities that they _don’t_ have access to. __Note__. This operation can only be accessed by account users with unrestricted access. <<LB>> — - __OAuth scopes__. “‘ account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:



2788
2789
2790
2791
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2788

def get_user_grants(api_version, username, opts = {})
  data, _status_code, _headers = get_user_grants_with_http_info(api_version, username, opts)
  data
end

#get_user_grants_with_http_info(api_version, username, opts = {}) ⇒ Array<(GetUserGrants200Response, Integer, Hash)>

List a user&#39;s grants Returns the full grants structure for an account username you specify. This includes all entities on the account, and the level of access this user has to each of them. This doesn&#39;t apply to the account owner or the current authenticated user. You can run the [List grants](techdocs.akamai.com/linode-api/reference/get-profile-grants) operation to view those grants. However, this doesn&#39;t show the entities that they _don&#39;t_ have access to. __Note__. This operation can only be accessed by account users with unrestricted access. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:

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

    GetUserGrants200Response data, response status code and response headers



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2799

def get_user_grants_with_http_info(api_version, username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_user_grants ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_user_grants"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling AccountApi.get_user_grants"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users/{username}/grants'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_user_with_http_info(api_version, username, opts = {}) ⇒ Array<(GetUser200Response, Integer, Hash)>

Get a user Returns information about a single user on your account. __Note__. This operation can only be accessed by account users with unrestricted access. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli users view example_user &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Returns:

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

    GetUser200Response data, response status code and response headers



2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2725

def get_user_with_http_info(api_version, username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_user ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_user"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling AccountApi.get_user"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users/{username}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#get_users(api_version, opts = {}) ⇒ GetUsers200Response

List users Returns a paginated list of all users on your account. __Note__. This operation can only be accessed by account users with unrestricted access. A user can access all or part of an account based on their access status and grants: - __Unrestricted access__. These users can access everything on an account. - __Restricted access__. These users can only access entities or perform actions they’ve been given specific grants to. <<LB>> — - __CLI__. “‘ linode-cli users list “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:



2863
2864
2865
2866
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2863

def get_users(api_version, opts = {})
  data, _status_code, _headers = get_users_with_http_info(api_version, opts)
  data
end

#get_users_with_http_info(api_version, opts = {}) ⇒ Array<(GetUsers200Response, Integer, Hash)>

List users Returns a paginated list of all users on your account. __Note__. This operation can only be accessed by account users with unrestricted access. A user can access all or part of an account based on their access status and grants: - __Unrestricted access__. These users can access everything on an account. - __Restricted access__. These users can only access entities or perform actions they&#39;ve been given specific grants to. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli users list &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page of a collection to return. (default to 1)

  • :page_size (Integer) —

    The number of items to return per page. (default to 100)

Returns:

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

    GetUsers200Response data, response status code and response headers



2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2875

def get_users_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_users ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.get_users"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AccountApi.get_users, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 500
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_users, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 25
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling AccountApi.get_users, must be greater than or equal to 25.'
  end

  # resource path
  local_var_path = '/{apiVersion}/account/users'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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/json']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_accept_entity_transfer(api_version, token, opts = {}) ⇒ Object

Accept an entity transfer __Deprecated__ Please run [Accept a service transfer](techdocs.akamai.com/linode-api/reference/post-accept-service-transfer). <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:

  • (Object) 


2948
2949
2950
2951
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2948

def post_accept_entity_transfer(api_version, token, opts = {})
  data, _status_code, _headers = post_accept_entity_transfer_with_http_info(api_version, token, opts)
  data
end

#post_accept_entity_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Accept an entity transfer __Deprecated__ Please run [Accept a service transfer](techdocs.akamai.com/linode-api/reference/post-accept-service-transfer). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Entity Transfer.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 2959

def post_accept_entity_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_accept_entity_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_accept_entity_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.post_accept_entity_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/entity-transfers/{token}/accept'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_accept_service_transfer(api_version, token, opts = {}) ⇒ Object

Accept a service transfer Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred. When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer. There are several conditions that must be met in order to accept a transfer request: 1. Only transfers with a ‘pending` status can be accepted. 1. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred. 1. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations. 1. The service must still be owned by the account that created the transfer. 1. Linodes must not: - be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer’s expiration to allow the transfer to be accepted by the receiving account. <<LB>> — - __CLI__. “‘ linode-cli service-transfers \ accept 123E4567-E89B-12D3-A456-426614174000 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:

  • (Object) 


3022
3023
3024
3025
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3022

def post_accept_service_transfer(api_version, token, opts = {})
  data, _status_code, _headers = post_accept_service_transfer_with_http_info(api_version, token, opts)
  data
end

#post_accept_service_transfer_with_http_info(api_version, token, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Accept a service transfer Accept a Service Transfer for the provided token to receive the services included in the transfer to your account. At this time, only Linodes can be transferred. When accepted, email confirmations are sent to the accounts that created and accepted the transfer. A transfer can take up to three hours to complete once accepted. Once a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of the account that receives the transfer. Users of the same account that created a transfer cannot accept the transfer. There are several conditions that must be met in order to accept a transfer request: 1. Only transfers with a &#x60;pending&#x60; status can be accepted. 1. The account accepting the transfer must have a registered payment method and must not have a past due balance or other account limitations for the services to be transferred. 1. Both the account that created the transfer and the account that is accepting the transfer must not have any active Terms of Service violations. 1. The service must still be owned by the account that created the transfer. 1. Linodes must not: - be assigned to a NodeBalancer, Firewall, VLAN, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. Any and all of the above conditions must be cured and maintained by the relevant account prior to the transfer&#39;s expiration to allow the transfer to be accepted by the receiving account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli service-transfers \ accept 123E4567-E89B-12D3-A456-426614174000 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • token (String) —

    The UUID of the Service Transfer.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3033

def post_accept_service_transfer_with_http_info(api_version, token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_accept_service_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_accept_service_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AccountApi.post_accept_service_transfer"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/service-transfers/{token}/accept'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'token' + '}', CGI.escape(token.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_account_agreements(api_version, post_account_agreements_request, opts = {}) ⇒ Object

Acknowledge agreements Accept required agreements by setting them to ‘true`. This remains until the content of the agreement changes. If it does, you need to run this operation again to accept it. If you set this to `false`, the API rejects the request and you need to open a [support ticket](techdocs.akamai.com/linode-api/reference/post-ticket) to reset the agreement. Omitted agreements are left unchanged. <<LB>> — - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

  • (Object) 


3096
3097
3098
3099
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3096

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

#post_account_agreements_with_http_info(api_version, post_account_agreements_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Acknowledge agreements Accept required agreements by setting them to &#x60;true&#x60;. This remains until the content of the agreement changes. If it does, you need to run this operation again to accept it. If you set this to &#x60;false&#x60;, the API rejects the request and you need to open a [support ticket](techdocs.akamai.com/linode-api/reference/post-ticket) to reset the agreement. Omitted agreements are left unchanged. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3107

def (api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_account_agreements ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_account_agreements"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_account_agreements_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'post_account_agreements_request' when calling AccountApi.post_account_agreements"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/agreements'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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()

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_beta_program(api_version, post_beta_program_request, opts = {}) ⇒ Object

Enroll in a Beta program Enroll your Account in an active Beta Program. Only unrestricted Users can access this operation. To view active Beta Programs, run the [List beta programs](techdocs.akamai.com/linode-api/reference/get-beta-programs) operation. Active Beta Programs may have a limited number of enrollments. If a Beta Program has reached is maximum number of enrollments, an error is returned even though the request is successful. Beta Programs with ‘"greenlight_only": true` can only be enrolled by Accounts that participate in the [Greenlight](www.linode.com/green-light/) program. <<LB>> — - __CLI__. “` linode-cli betas enroll –id example_open “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_beta_program_request (PostBetaProgramRequest) —

    Updated information for the Managed MySQL Database.

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

    the optional parameters

Returns:

  • (Object) 


3175
3176
3177
3178
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3175

def post_beta_program(api_version, post_beta_program_request, opts = {})
  data, _status_code, _headers = post_beta_program_with_http_info(api_version, post_beta_program_request, opts)
  data
end

#post_beta_program_with_http_info(api_version, post_beta_program_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Enroll in a Beta program Enroll your Account in an active Beta Program. Only unrestricted Users can access this operation. To view active Beta Programs, run the [List beta programs](techdocs.akamai.com/linode-api/reference/get-beta-programs) operation. Active Beta Programs may have a limited number of enrollments. If a Beta Program has reached is maximum number of enrollments, an error is returned even though the request is successful. Beta Programs with &#x60;&quot;greenlight_only&quot;: true&#x60; can only be enrolled by Accounts that participate in the [Greenlight](www.linode.com/green-light/) program. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli betas enroll –id example_open &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_beta_program_request (PostBetaProgramRequest) —

    Updated information for the Managed MySQL Database.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3186

def post_beta_program_with_http_info(api_version, post_beta_program_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_beta_program ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_beta_program"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_beta_program_request' is set
  if @api_client.config.client_side_validation && post_beta_program_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_beta_program_request' when calling AccountApi.post_beta_program"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/betas'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_beta_program_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_cancel_account(api_version, post_cancel_account_request, opts = {}) ⇒ PostCancelAccount200Response

Cancel your account Cancels an active Linode account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - A child account user can’t cancel a child account. - You can’t cancel a parent account if it has an active child account. - You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account. <<LB>> — - __CLI__. “‘ linode-cli account cancel \ –comments "I’m consolidating my accounts" “‘ [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_cancel_account_request (PostCancelAccountRequest) —

    Supply a comment stating the reason that you are cancelling your account.

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

    the optional parameters

Returns:



3254
3255
3256
3257
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3254

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

#post_cancel_account_with_http_info(api_version, post_cancel_account_request, opts = {}) ⇒ Array<(PostCancelAccount200Response, Integer, Hash)>

Cancel your account Cancels an active Linode account. Akamai attempts to charge the credit card on file for any remaining balance. An error occurs if this charge fails. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - A child account user can&#39;t cancel a child account. - You can&#39;t cancel a parent account if it has an active child account. - You need to work with your Akamai account team to dissolve any parent-child account relationships before you can fully cancel a child or parent account. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account cancel \ –comments &quot;I&#39;m consolidating my accounts&quot; &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_cancel_account_request (PostCancelAccountRequest) —

    Supply a comment stating the reason that you are cancelling your account.

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

    the optional parameters

Returns:



3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3265

def (api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_cancel_account ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_cancel_account"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_cancel_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'post_cancel_account_request' when calling AccountApi.post_cancel_account"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/cancel'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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()

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_child_account_token(api_version, euuid, opts = {}) ⇒ PostChildAccountToken200Response

Create a proxy user token Create a short-lived bearer token for a parent user on a child account, using the ‘euuid` of that child account. In the context of the API, a parent user on a child account is referred to as a "proxy user." When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention: <Parent account `company` name>_<SHA256 hash of parent `company` name and child account `euuid`> __Note__. The variables above use only the first 15 and 16 characters of these values, respectively. The token lets a parent account run API operations through the proxy user, as if they are a child user in the child account. These points apply to the use of this operation: - To create a token, a parent account user needs the `child_account_access` grant. This lets them use the proxy user on the child account. You can run [List a user’s grants](techdocs.akamai.com/linode-api/reference/get-user-grants) on a parent account user to check its ‘child_account_access` setting. To add this access, you can [update](techdocs.akamai.com/linode-api/reference/put-user-grants) the parent account user. - The created token inherits the permissions of the proxy user. It will never have less. - The API returns the raw token in the response. You can’t get it again, so be sure to store it. Example workflow: 1. [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) and store the ‘euuid` for the applicable one. 2. Run this operation and store the `token` that’s created for the proxy user. 3. As a parent account user with access to the proxy user in the child account, use this ‘token` to authenticate API operations, as if you were a child user. <<LB>> — - __CLI__. “` linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` child_account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • euuid (String) —

    The child account to look up. You can run the [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its &#x60;euuid&#x60;.

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

    the optional parameters

Returns:



3333
3334
3335
3336
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3333

def (api_version, euuid, opts = {})
  data, _status_code, _headers = (api_version, euuid, opts)
  data
end

#post_child_account_token_with_http_info(api_version, euuid, opts = {}) ⇒ Array<(PostChildAccountToken200Response, Integer, Hash)>

Create a proxy user token Create a short-lived bearer token for a parent user on a child account, using the &#x60;euuid&#x60; of that child account. In the context of the API, a parent user on a child account is referred to as a &quot;proxy user.&quot; When Akamai provisions your parent-child account environment, a proxy user is automatically set in the child account. It follows a specific naming convention: &lt;Parent account &#x60;company&#x60; name&gt;_&lt;SHA256 hash of parent &#x60;company&#x60; name and child account &#x60;euuid&#x60;&gt; __Note__. The variables above use only the first 15 and 16 characters of these values, respectively. The token lets a parent account run API operations through the proxy user, as if they are a child user in the child account. These points apply to the use of this operation: - To create a token, a parent account user needs the &#x60;child_account_access&#x60; grant. This lets them use the proxy user on the child account. You can run [List a user&#39;s grants](techdocs.akamai.com/linode-api/reference/get-user-grants) on a parent account user to check its &#x60;child_account_access&#x60; setting. To add this access, you can [update](techdocs.akamai.com/linode-api/reference/put-user-grants) the parent account user. - The created token inherits the permissions of the proxy user. It will never have less. - The API returns the raw token in the response. You can&#39;t get it again, so be sure to store it. Example workflow: 1. [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) and store the &#x60;euuid&#x60; for the applicable one. 2. Run this operation and store the &#x60;token&#x60; that&#39;s created for the proxy user. 3. As a parent account user with access to the proxy user in the child account, use this &#x60;token&#x60; to authenticate API operations, as if you were a child user. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli child-account create A1BC2DEF-34GH-567I-J890KLMN12O34P56 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; child_account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • euuid (String) —

    The child account to look up. You can run the [List child accounts](techdocs.akamai.com/linode-api/reference/get-child-accounts) operation to find the applicable account and store its &#x60;euuid&#x60;.

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

    the optional parameters

Returns:



3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3344

def (api_version, euuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_child_account_token ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_child_account_token"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'euuid' is set
  if @api_client.config.client_side_validation && euuid.nil?
    fail ArgumentError, "Missing the required parameter 'euuid' when calling AccountApi.post_child_account_token"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/child-accounts/{euuid}/token'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'euuid' + '}', CGI.escape(euuid.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_client(api_version, opts = {}) ⇒ PostClient200Response

Create an OAuth client Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities. <<LB>> — - __CLI__. “‘ linode-cli account client-create \ –label Test_Client_1 \ –redirect_uri example.org/callback “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_client_request (PostClientRequest) —

    Information about the OAuth Client to create.

Returns:



3407
3408
3409
3410
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3407

def post_client(api_version, opts = {})
  data, _status_code, _headers = post_client_with_http_info(api_version, opts)
  data
end

#post_client_with_http_info(api_version, opts = {}) ⇒ Array<(PostClient200Response, Integer, Hash)>

Create an OAuth client Creates an OAuth Client, which can be used to allow users (using their Linode account) to log in to your own application, and optionally grant your application some amount of access to their Linodes or other entities. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account client-create \ –label Test_Client_1 \ –redirect_uri example.org/callback &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_client_request (PostClientRequest) —

    Information about the OAuth Client to create.

Returns:

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

    PostClient200Response data, response status code and response headers



3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3418

def post_client_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_client ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_client"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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[:'post_client_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_credit_card(api_version, post_credit_card_request, opts = {}) ⇒ Object

Add or edit a credit card __Deprecated__ Please run [Add a payment method](techdocs.akamai.com/linode-api/reference/post-payment-method). Adds a credit card Payment Method to your account and sets it as the default method. <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_credit_card_request (PostCreditCardRequest) —

    Update the credit card information associated with your Account.

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

    the optional parameters

Returns:

  • (Object) 


3482
3483
3484
3485
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3482

def post_credit_card(api_version, post_credit_card_request, opts = {})
  data, _status_code, _headers = post_credit_card_with_http_info(api_version, post_credit_card_request, opts)
  data
end

#post_credit_card_with_http_info(api_version, post_credit_card_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add or edit a credit card __Deprecated__ Please run [Add a payment method](techdocs.akamai.com/linode-api/reference/post-payment-method). Adds a credit card Payment Method to your account and sets it as the default method. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_credit_card_request (PostCreditCardRequest) —

    Update the credit card information associated with your Account.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3493

def post_credit_card_with_http_info(api_version, post_credit_card_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_credit_card ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_credit_card"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_credit_card_request' is set
  if @api_client.config.client_side_validation && post_credit_card_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_credit_card_request' when calling AccountApi.post_credit_card"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/credit-card'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_credit_card_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_enable_account_managed(api_version, opts = {}) ⇒ Object

Enable Linode Managed Enables Linode Managed for the entire account and sends a welcome email to the account’s associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](www.linode.com/docs/guides/linode-managed/) to learn more. <<LB>> — - __CLI__. “‘ linode-cli account enable-managed “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

  • (Object) 


3560
3561
3562
3563
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3560

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

#post_enable_account_managed_with_http_info(api_version, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Enable Linode Managed Enables Linode Managed for the entire account and sends a welcome email to the account&#39;s associated email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See our [Linode Managed guide](www.linode.com/docs/guides/linode-managed/) to learn more. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account enable-managed &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3570

def (api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_enable_account_managed ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_enable_account_managed"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/settings/managed-enable'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_entity_transfer(api_version, opts = {}) ⇒ PostEntityTransfer200Response

Create an entity transfer __Deprecated__ Please run [Request a service transfer](techdocs.akamai.com/linode-api/reference/post-service-transfer). <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:



3629
3630
3631
3632
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3629

def post_entity_transfer(api_version, opts = {})
  data, _status_code, _headers = post_entity_transfer_with_http_info(api_version, opts)
  data
end

#post_entity_transfer_with_http_info(api_version, opts = {}) ⇒ Array<(PostEntityTransfer200Response, Integer, Hash)>

Create an entity transfer __Deprecated__ Please run [Request a service transfer](techdocs.akamai.com/linode-api/reference/post-service-transfer). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:



3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3640

def post_entity_transfer_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_entity_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_entity_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/entity-transfers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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[:'post_entity_transfer_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_event_read(api_version, event_id, opts = {}) ⇒ Object

Mark an event as read Marks a single Event as read. <<LB>> — - __CLI__. “‘ linode-cli events mark-read 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` events:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event to designate as read.

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

    the optional parameters

Returns:

  • (Object) 


3704
3705
3706
3707
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3704

def post_event_read(api_version, event_id, opts = {})
  data, _status_code, _headers = post_event_read_with_http_info(api_version, event_id, opts)
  data
end

#post_event_read_with_http_info(api_version, event_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Mark an event as read Marks a single Event as read. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli events mark-read 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; events:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event to designate as read.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3715

def post_event_read_with_http_info(api_version, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_event_read ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_event_read"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling AccountApi.post_event_read"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/events/{eventId}/read'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_event_seen(api_version, event_id, opts = {}) ⇒ Object

Mark an event as seen Marks all Events up to and including this Event by ID as seen. <<LB>> — - __CLI__. “‘ linode-cli events mark-seen 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` events:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event to designate as seen.

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

    the optional parameters

Returns:

  • (Object) 


3778
3779
3780
3781
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3778

def post_event_seen(api_version, event_id, opts = {})
  data, _status_code, _headers = post_event_seen_with_http_info(api_version, event_id, opts)
  data
end

#post_event_seen_with_http_info(api_version, event_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Mark an event as seen Marks all Events up to and including this Event by ID as seen. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli events mark-seen 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; events:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • event_id (Integer) —

    The ID of the Event to designate as seen.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3789

def post_event_seen_with_http_info(api_version, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_event_seen ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_event_seen"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling AccountApi.post_event_seen"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/events/{eventId}/seen'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_execute_pay_pal_payment(api_version, post_execute_pay_pal_payment_request, opts = {}) ⇒ Object

Execute a PayPal payment __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](www.linode.com/docs/products/platform/billing/guides/payment-methods/). <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_execute_pay_pal_payment_request (PostExecutePayPalPaymentRequest) —

    The details of the Payment to execute.

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

    the optional parameters

Returns:

  • (Object) 


3852
3853
3854
3855
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3852

def post_execute_pay_pal_payment(api_version, post_execute_pay_pal_payment_request, opts = {})
  data, _status_code, _headers = post_execute_pay_pal_payment_with_http_info(api_version, post_execute_pay_pal_payment_request, opts)
  data
end

#post_execute_pay_pal_payment_with_http_info(api_version, post_execute_pay_pal_payment_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Execute a PayPal payment __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](www.linode.com/docs/products/platform/billing/guides/payment-methods/). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_execute_pay_pal_payment_request (PostExecutePayPalPaymentRequest) —

    The details of the Payment to execute.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3863

def post_execute_pay_pal_payment_with_http_info(api_version, post_execute_pay_pal_payment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_execute_pay_pal_payment ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_execute_pay_pal_payment"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_execute_pay_pal_payment_request' is set
  if @api_client.config.client_side_validation && post_execute_pay_pal_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_execute_pay_pal_payment_request' when calling AccountApi.post_execute_pay_pal_payment"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payments/paypal/execute'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_execute_pay_pal_payment_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_make_payment_method_default(api_version, payment_method_id, opts = {}) ⇒ Object

Set a default payment method Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can’t run this operation. These users don’t have access to billing-related operations. <<LB>> — - __CLI__. “‘ linode-cli payment-methods default 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to make default.

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

    the optional parameters

Returns:

  • (Object) 


3931
3932
3933
3934
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3931

def post_make_payment_method_default(api_version, payment_method_id, opts = {})
  data, _status_code, _headers = post_make_payment_method_default_with_http_info(api_version, payment_method_id, opts)
  data
end

#post_make_payment_method_default_with_http_info(api_version, payment_method_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Set a default payment method Make the specified Payment Method the default method for automatically processing payments. Removes the default status from any other Payment Method. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can&#39;t run this operation. These users don&#39;t have access to billing-related operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli payment-methods default 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • payment_method_id (Integer) —

    The ID of the Payment Method to make default.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 3942

def post_make_payment_method_default_with_http_info(api_version, payment_method_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_make_payment_method_default ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_make_payment_method_default"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'payment_method_id' is set
  if @api_client.config.client_side_validation && payment_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'payment_method_id' when calling AccountApi.post_make_payment_method_default"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payment-methods/{paymentMethodId}/make-default'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'paymentMethodId' + '}', CGI.escape(payment_method_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_pay_pal_payment(api_version, post_pay_pal_payment_request, opts = {}) ⇒ PostPayPalPayment200Response

Stage a PayPal payment __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](www.linode.com/docs/products/platform/billing/guides/payment-methods/). <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_pay_pal_payment_request (PostPayPalPaymentRequest) —

    The amount of the Payment to submit via PayPal.

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

    the optional parameters

Returns:



4005
4006
4007
4008
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4005

def post_pay_pal_payment(api_version, post_pay_pal_payment_request, opts = {})
  data, _status_code, _headers = post_pay_pal_payment_with_http_info(api_version, post_pay_pal_payment_request, opts)
  data
end

#post_pay_pal_payment_with_http_info(api_version, post_pay_pal_payment_request, opts = {}) ⇒ Array<(PostPayPalPayment200Response, Integer, Hash)>

Stage a PayPal payment __Deprecated__ This operation is disabled and no longer accessible. PayPal can be designated as a Payment Method for automated payments using the Cloud Manager. See [Manage Payment Methods](www.linode.com/docs/products/platform/billing/guides/payment-methods/). &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_pay_pal_payment_request (PostPayPalPaymentRequest) —

    The amount of the Payment to submit via PayPal.

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

    the optional parameters

Returns:



4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4016

def post_pay_pal_payment_with_http_info(api_version, post_pay_pal_payment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_pay_pal_payment ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_pay_pal_payment"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_pay_pal_payment_request' is set
  if @api_client.config.client_side_validation && post_pay_pal_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_pay_pal_payment_request' when calling AccountApi.post_pay_pal_payment"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payments/paypal'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_pay_pal_payment_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_payment(api_version, post_payment_request, opts = {}) ⇒ PostPayment200Response

Make a payment Makes a Payment to your Account. - The requested amount is charged to the default Payment Method if no ‘payment_method_id` is specified. - A `payment_submitted` event is generated when a payment is successfully submitted. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can’t run this operation. These users don’t have access to billing-related operations. <<LB>> — - __CLI__. “‘ linode-cli account payment-create \ –usd 120.50 \ –payment_method_id 123 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_payment_request (PostPaymentRequest) —

    Information about the Payment you are making.

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

    the optional parameters

Returns:



4084
4085
4086
4087
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4084

def post_payment(api_version, post_payment_request, opts = {})
  data, _status_code, _headers = post_payment_with_http_info(api_version, post_payment_request, opts)
  data
end

#post_payment_method(api_version, post_payment_method_request, opts = {}) ⇒ Object

Add a payment method Adds a Payment Method to your Account with the option to set it as the default method. - Adding a default Payment Method removes the default status from any other Payment Method. - An Account can have up to 6 active Payment Methods. - Up to 60 Payment Methods can be added each day. - Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid ‘zip` by running the [Update your account](techdocs.akamai.com/linode-api/reference/put-account) operation. - A `payment_method_add` event is generated when a payment is successfully submitted. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can’t run this operation. These users don’t have access to billing-related operations. <<LB>> — - __CLI__. “‘ linode-cli payment-methods add \ –type credit_card \ –is_default true \ –data.card_number 4111111111111111 \ –data.expiry_month 11 \ –data.expiry_year 2020 \ –data.cvv 111 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_payment_method_request (PostPaymentMethodRequest) —

    The details of the Payment Method to add.

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

    the optional parameters

Returns:

  • (Object) 


4163
4164
4165
4166
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4163

def post_payment_method(api_version, post_payment_method_request, opts = {})
  data, _status_code, _headers = post_payment_method_with_http_info(api_version, post_payment_method_request, opts)
  data
end

#post_payment_method_with_http_info(api_version, post_payment_method_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Add a payment method Adds a Payment Method to your Account with the option to set it as the default method. - Adding a default Payment Method removes the default status from any other Payment Method. - An Account can have up to 6 active Payment Methods. - Up to 60 Payment Methods can be added each day. - Prior to adding a Payment Method, ensure that your billing address information is up-to-date with a valid &#x60;zip&#x60; by running the [Update your account](techdocs.akamai.com/linode-api/reference/put-account) operation. - A &#x60;payment_method_add&#x60; event is generated when a payment is successfully submitted. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can&#39;t run this operation. These users don&#39;t have access to billing-related operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli payment-methods add \ –type credit_card \ –is_default true \ –data.card_number 4111111111111111 \ –data.expiry_month 11 \ –data.expiry_year 2020 \ –data.cvv 111 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_payment_method_request (PostPaymentMethodRequest) —

    The details of the Payment Method to add.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4174

def post_payment_method_with_http_info(api_version, post_payment_method_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_payment_method ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_payment_method"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_payment_method_request' is set
  if @api_client.config.client_side_validation && post_payment_method_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_payment_method_request' when calling AccountApi.post_payment_method"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payment-methods'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_payment_method_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_payment_with_http_info(api_version, post_payment_request, opts = {}) ⇒ Array<(PostPayment200Response, Integer, Hash)>

Make a payment Makes a Payment to your Account. - The requested amount is charged to the default Payment Method if no &#x60;payment_method_id&#x60; is specified. - A &#x60;payment_submitted&#x60; event is generated when a payment is successfully submitted. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can&#39;t run this operation. These users don&#39;t have access to billing-related operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account payment-create \ –usd 120.50 \ –payment_method_id 123 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • post_payment_request (PostPaymentRequest) —

    Information about the Payment you are making.

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

    the optional parameters

Returns:

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

    PostPayment200Response data, response status code and response headers



4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4095

def post_payment_with_http_info(api_version, post_payment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_payment ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_payment"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'post_payment_request' is set
  if @api_client.config.client_side_validation && post_payment_request.nil?
    fail ArgumentError, "Missing the required parameter 'post_payment_request' when calling AccountApi.post_payment"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/payments'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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(post_payment_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_promo_credit(api_version, opts = {}) ⇒ PostPromoCredit200Response

Add a promo credit Adds an expiring Promo Credit to your account. The following restrictions apply: - Your account needs to be less than 90 days old. - You can’t already have a Promo Credit on your account. - The user making the request needs to be unrestricted. You can run the [Update a user](techdocs.akamai.com/linode-api/reference/put-user) operation to change a user’s restricted status. - The ‘promo_code` needs to be valid and unexpired. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can’t run this operation. These users don’t have access to billing-related operations. <<LB>> — - __CLI__. “‘ linode-cli account \ promo-add \ –promo-code abcdefABCDEF1234567890 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_only “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_promo_credit_request (PostPromoCreditRequest) —

    Enter a Promo Code to add its associated credit to your Account.

Returns:



4242
4243
4244
4245
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4242

def post_promo_credit(api_version, opts = {})
  data, _status_code, _headers = post_promo_credit_with_http_info(api_version, opts)
  data
end

#post_promo_credit_with_http_info(api_version, opts = {}) ⇒ Array<(PostPromoCredit200Response, Integer, Hash)>

Add a promo credit Adds an expiring Promo Credit to your account. The following restrictions apply: - Your account needs to be less than 90 days old. - You can&#39;t already have a Promo Credit on your account. - The user making the request needs to be unrestricted. You can run the [Update a user](techdocs.akamai.com/linode-api/reference/put-user) operation to change a user&#39;s restricted status. - The &#x60;promo_code&#x60; needs to be valid and unexpired. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - Child account users can&#39;t run this operation. These users don&#39;t have access to billing-related operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account \ promo-add \ –promo-code abcdefABCDEF1234567890 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_only &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_promo_credit_request (PostPromoCreditRequest) —

    Enter a Promo Code to add its associated credit to your Account.

Returns:

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

    PostPromoCredit200Response data, response status code and response headers



4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4253

def post_promo_credit_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_promo_credit ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_promo_credit"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/promo-codes'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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[:'post_promo_credit_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_reset_client_secret(api_version, client_id, opts = {}) ⇒ PostResetClientSecret200Response

Reset an OAuth client secret Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail. <<LB>> — - __CLI__. “‘ linode-cli account client-reset-secret \ edc6790ea9db4d224c5c “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:



4317
4318
4319
4320
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4317

def post_reset_client_secret(api_version, client_id, opts = {})
  data, _status_code, _headers = post_reset_client_secret_with_http_info(api_version, client_id, opts)
  data
end

#post_reset_client_secret_with_http_info(api_version, client_id, opts = {}) ⇒ Array<(PostResetClientSecret200Response, Integer, Hash)>

Reset an OAuth client secret Resets the OAuth Client secret for a client you own, and returns the OAuth Client with the plaintext secret. This secret is not supposed to be publicly known or disclosed anywhere. This can be used to generate a new secret in case the one you have has been leaked, or to get a new secret if you lost the original. The old secret is expired immediately, and logins to your client with the old secret will fail. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account client-reset-secret \ edc6790ea9db4d224c5c &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Returns:



4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4328

def post_reset_client_secret_with_http_info(api_version, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_reset_client_secret ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_reset_client_secret"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.post_reset_client_secret"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}/reset-secret'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_service_transfer(api_version, opts = {}) ⇒ PostServiceTransfer200Response

Request a service transfer Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred. When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer. When a transfer is [accepted](techdocs.akamai.com/linode-api/reference/post-accept-service-transfer), the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well. DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer. A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of an account. There are several conditions that you need to meet to successfully create a transfer request: 1. The account creating the transfer can’t have a past due balance or active Terms of Service violation. 1. The service needs to be owned by the account that is creating the transfer. 1. The service can’t be assigned to another Service Transfer that is pending or that’s been accepted and is incomplete. 1. Linodes can’t: - be assigned to a NodeBalancer, Firewall, VLAN, VPC, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. <<LB>> — - __CLI__. “‘ linode-cli service-transfers \ create \ –entities.linodes 111 \ –entities.linodes 222 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:



4391
4392
4393
4394
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4391

def post_service_transfer(api_version, opts = {})
  data, _status_code, _headers = post_service_transfer_with_http_info(api_version, opts)
  data
end

#post_service_transfer_with_http_info(api_version, opts = {}) ⇒ Array<(PostServiceTransfer200Response, Integer, Hash)>

Request a service transfer Creates a transfer request for the specified services. A request can contain any of the specified service types and any number of each service type. At this time, only Linodes can be transferred. When created successfully, a confirmation email is sent to the account that created this transfer containing a transfer token and instructions on completing the transfer. When a transfer is [accepted](techdocs.akamai.com/linode-api/reference/post-accept-service-transfer), the requested services are moved to the receiving account. Linode services will not experience interruptions due to the transfer process. Backups for Linodes are transferred as well. DNS records that are associated with requested services will not be transferred or updated. Please ensure that associated DNS records have been updated or communicated to the recipient prior to the transfer. A transfer can take up to three hours to complete once accepted. When a transfer is completed, billing for transferred services ends for the sending account and begins for the receiving account. This operation can only be accessed by the unrestricted users of an account. There are several conditions that you need to meet to successfully create a transfer request: 1. The account creating the transfer can&#39;t have a past due balance or active Terms of Service violation. 1. The service needs to be owned by the account that is creating the transfer. 1. The service can&#39;t be assigned to another Service Transfer that is pending or that&#39;s been accepted and is incomplete. 1. Linodes can&#39;t: - be assigned to a NodeBalancer, Firewall, VLAN, VPC, or Managed Service. - have any attached Block Storage Volumes. - have any shared IP addresses. - have any assigned /56, /64, or /116 IPv6 ranges. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli service-transfers \ create \ –entities.linodes 111 \ –entities.linodes 222 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

Returns:



4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4402

def post_service_transfer_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_service_transfer ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_service_transfer"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/service-transfers'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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[:'post_service_transfer_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#post_user(api_version, opts = {}) ⇒ PostUser200Response

Create a user Creates a user on your account. You determine the new user’s account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user’s ‘email` address. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - A parent account user can create new parent account users. - A child account can [update](techdocs.akamai.com/linode-api/reference/put-user) the child account parent user (proxy user) to `unrestricted`. This gives the proxy user access to create new child account users. - A child account user can create new child account users. - You can’t create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship. <<LB>> — - __CLI__. “‘ linode-cli users create \ –username example_user \ –email [email protected] \ –restricted true “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_user_request (PostUserRequest) —

    Information about the User to create.

Returns:



4466
4467
4468
4469
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4466

def post_user(api_version, opts = {})
  data, _status_code, _headers = post_user_with_http_info(api_version, opts)
  data
end

#post_user_with_http_info(api_version, opts = {}) ⇒ Array<(PostUser200Response, Integer, Hash)>

Create a user Creates a user on your account. You determine the new user&#39;s account access by setting it to restricted or unrestricted and by defining its grants. After completion, the API sends a confirmation message containing password creation and login instructions to the user&#39;s &#x60;email&#x60; address. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - A parent account user can create new parent account users. - A child account can [update](techdocs.akamai.com/linode-api/reference/put-user) the child account parent user (proxy user) to &#x60;unrestricted&#x60;. This gives the proxy user access to create new child account users. - A child account user can create new child account users. - You can&#39;t create a proxy user. The proxy user in a child account is predefined when you initially provision the parent-child relationship. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli users create \ –username example_user \ –email [email protected] \ –restricted true &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

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

    the optional parameters

Options Hash (opts):

  • :post_user_request (PostUserRequest) —

    Information about the User to create.

Returns:

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

    PostUser200Response data, response status code and response headers



4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4477

def post_user_with_http_info(api_version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.post_user ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.post_user"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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[:'post_user_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_account(api_version, put_account_request, opts = {}) ⇒ PutAccount200Response

Update your account Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged. __Note__. When updating an account’s ‘country` to `US`, you’ll get an error if the account’s ‘zip` is not a valid US zip code. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can’t change the ‘company` for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account. - Child account users can’t run this operation. These users don’t have access to billing-related operations. <<LB>> — - __CLI__. “‘ linode-cli account update \ –address_1 "123 Main St." \ –address_2 "Suite 101" \ –city Philadelphia \ –company My Company \ LLC \ –country US \ –email [email protected] \ –first_name John \ –last_name Smith \ –phone 555-555-1212 \ –state PA \ –tax_id ATU99999999 \ –zip 19102 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • put_account_request (PutAccountRequest) —

    Updated contact and billing information.

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

    the optional parameters

Returns:



4541
4542
4543
4544
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4541

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

#put_account_settings(api_version, put_account_settings_request, opts = {}) ⇒ PutAccountSettings200Response

Update account settings Updates your account settings. For a Longview subscription plan, see [Update a Longview plan](techdocs.akamai.com/linode-api/reference/put-longview-plan). <<LB>> — - __CLI__. “‘ linode-cli account settings-update \ –network_helper false “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • put_account_settings_request (PutAccountSettingsRequest) —

    Update Account settings information.

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

    the optional parameters

Returns:



4620
4621
4622
4623
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4620

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

#put_account_settings_with_http_info(api_version, put_account_settings_request, opts = {}) ⇒ Array<(PutAccountSettings200Response, Integer, Hash)>

Update account settings Updates your account settings. For a Longview subscription plan, see [Update a Longview plan](techdocs.akamai.com/linode-api/reference/put-longview-plan). &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account settings-update \ –network_helper false &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • put_account_settings_request (PutAccountSettingsRequest) —

    Update Account settings information.

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

    the optional parameters

Returns:



4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4631

def (api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_account_settings ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_account_settings"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'put_account_settings_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'put_account_settings_request' when calling AccountApi.put_account_settings"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/settings'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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()

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_account_with_http_info(api_version, put_account_request, opts = {}) ⇒ Array<(PutAccount200Response, Integer, Hash)>

Update your account Updates contact and billing information related to your account. If you exclude any properties from the request, the operation leaves them unchanged. __Note__. When updating an account&#39;s &#x60;country&#x60; to &#x60;US&#x60;, you&#39;ll get an error if the account&#39;s &#x60;zip&#x60; is not a valid US zip code. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can&#39;t change the &#x60;company&#x60; for a parent account. Akamai uses this value to set the name for a child account parent user (proxy user) on any child account. - Child account users can&#39;t run this operation. These users don&#39;t have access to billing-related operations. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account update \ –address_1 &quot;123 Main St.&quot; \ –address_2 &quot;Suite 101&quot; \ –city Philadelphia \ –company My Company \ LLC \ –country US \ –email [email protected] \ –first_name John \ –last_name Smith \ –phone 555-555-1212 \ –state PA \ –tax_id ATU99999999 \ –zip 19102 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • put_account_request (PutAccountRequest) —

    Updated contact and billing information.

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

    the optional parameters

Returns:

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

    PutAccount200Response data, response status code and response headers



4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4552

def (api_version, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_account ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_account"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'put_account_request' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'put_account_request' when calling AccountApi.put_account"
  end
  # resource path
  local_var_path = '/{apiVersion}/account'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.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']) unless header_params['Accept']
  # 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()

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_client(api_version, client_id, opts = {}) ⇒ PutClient200Response

Update an OAuth client Update information about an OAuth Client on your Account. This can be especially useful to update the ‘redirect_uri` of your client in the event that the callback url changed in your application. <<LB>> — - __CLI__. “` linode-cli account client-update \ edc6790ea9db4d224c5c \ –label Test_Client_1 “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Options Hash (opts):

Returns:



4700
4701
4702
4703
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4700

def put_client(api_version, client_id, opts = {})
  data, _status_code, _headers = put_client_with_http_info(api_version, client_id, opts)
  data
end

#put_client_thumbnail(api_version, client_id, body, opts = {}) ⇒ Object

Update the OAuth client’s thumbnail Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be publicly-viewable. <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

  • body (File) —

    The image to set as the thumbnail.

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

    the optional parameters

Returns:

  • (Object) 


4781
4782
4783
4784
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4781

def put_client_thumbnail(api_version, client_id, body, opts = {})
  data, _status_code, _headers = put_client_thumbnail_with_http_info(api_version, client_id, body, opts)
  data
end

#put_client_thumbnail_with_http_info(api_version, client_id, body, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update the OAuth client&#39;s thumbnail Upload a thumbnail for a client you own. You must upload an image file that will be returned when the thumbnail is retrieved. This image will be publicly-viewable. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

  • body (File) —

    The image to set as the thumbnail.

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4793

def put_client_thumbnail_with_http_info(api_version, client_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_client_thumbnail ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_client_thumbnail"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.put_client_thumbnail"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling AccountApi.put_client_thumbnail"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}/thumbnail'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['image/png'])
  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(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_client_with_http_info(api_version, client_id, opts = {}) ⇒ Array<(PutClient200Response, Integer, Hash)>

Update an OAuth client Update information about an OAuth Client on your Account. This can be especially useful to update the &#x60;redirect_uri&#x60; of your client in the event that the callback url changed in your application. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli account client-update \ edc6790ea9db4d224c5c \ –label Test_Client_1 &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • client_id (String) —

    The OAuth Client ID to look up.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PutClient200Response data, response status code and response headers



4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4712

def put_client_with_http_info(api_version, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_client ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_client"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AccountApi.put_client"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/oauth-clients/{clientId}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_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']) unless header_params['Accept']
  # 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[:'put_client_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_user(api_version, username, opts = {}) ⇒ PutUser200Response

Update a user Update information about a user on your account, including its restricted status. When setting a user to ‘restricted`, the API sets no grants for it. You need to set grants so that user can access things on the account. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can’t edit the ‘username` or `email` values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user’s ‘restricted` status can be modified. This can only be done by an unrestricted child account user. - A parent account using an unrestricted proxy user in a child account can modify the `username`, `email`, and `restricted` status for an existing child account user. - A restricted account user–parent or child–can’t change their user to ‘unrestricted`. <<LB>> — - __CLI__. “` linode-cli users update example_user \ –username example_user \ –email [email protected] \ –restricted true “` [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. “` account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Options Hash (opts):

Returns:



4866
4867
4868
4869
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4866

def put_user(api_version, username, opts = {})
  data, _status_code, _headers = put_user_with_http_info(api_version, username, opts)
  data
end

#put_user_grants(api_version, username, put_user_grants_request, opts = {}) ⇒ PutUserGrants200Response

Update a user’s grants Update the grants a user has. This can be used to give a user access to new entities or actions, or take access away. You don’t need to include the grant for every entity on the account in this request. Any that are not included remain unchanged. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - No child account user can modify the ‘account_access` grant for the child account parent user (proxy user). - An unrestricted child account user can configure all other grants for the proxy user, via `global` object. - An unrestricted child account user can enable the `account_access` grant for other child account users. However, enabled child users are still subject to child user restrictions–they can’t perform write operations for any billing or account information. <<LB>> — - __OAuth scopes__. “‘ account:read_write “` [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

  • put_user_grants_request (PutUserGrantsRequest) —

    The grants to update. Omitted grants will be left unchanged.

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

    the optional parameters

Returns:



4947
4948
4949
4950
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4947

def put_user_grants(api_version, username, put_user_grants_request, opts = {})
  data, _status_code, _headers = put_user_grants_with_http_info(api_version, username, put_user_grants_request, opts)
  data
end

#put_user_grants_with_http_info(api_version, username, put_user_grants_request, opts = {}) ⇒ Array<(PutUserGrants200Response, Integer, Hash)>

Update a user&#39;s grants Update the grants a user has. This can be used to give a user access to new entities or actions, or take access away. You don&#39;t need to include the grant for every entity on the account in this request. Any that are not included remain unchanged. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - No child account user can modify the &#x60;account_access&#x60; grant for the child account parent user (proxy user). - An unrestricted child account user can configure all other grants for the proxy user, via &#x60;global&#x60; object. - An unrestricted child account user can enable the &#x60;account_access&#x60; grant for other child account users. However, enabled child users are still subject to child user restrictions–they can&#39;t perform write operations for any billing or account information. &lt;&lt;LB&gt;&gt; — - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

  • put_user_grants_request (PutUserGrantsRequest) —

    The grants to update. Omitted grants will be left unchanged.

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

    the optional parameters

Returns:

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

    PutUserGrants200Response data, response status code and response headers



4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4959

def put_user_grants_with_http_info(api_version, username, put_user_grants_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_user_grants ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_user_grants"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling AccountApi.put_user_grants"
  end
  # verify the required parameter 'put_user_grants_request' is set
  if @api_client.config.client_side_validation && put_user_grants_request.nil?
    fail ArgumentError, "Missing the required parameter 'put_user_grants_request' when calling AccountApi.put_user_grants"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users/{username}/grants'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
  # 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(put_user_grants_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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

#put_user_with_http_info(api_version, username, opts = {}) ⇒ Array<(PutUser200Response, Integer, Hash)>

Update a user Update information about a user on your account, including its restricted status. When setting a user to &#x60;restricted&#x60;, the API sets no grants for it. You need to set grants so that user can access things on the account. __Note__. This operation can only be accessed by account users with unrestricted access. __Parent and child accounts__ In a [parent and child account](www.linode.com/docs/guides/parent-child-accounts/) environment, the following apply: - You can&#39;t edit the &#x60;username&#x60; or &#x60;email&#x60; values for the child account parent user (proxy user). These are predefined for the proxy user when you initially provision the parent-child relationship. Only a proxy user&#39;s &#x60;restricted&#x60; status can be modified. This can only be done by an unrestricted child account user. - A parent account using an unrestricted proxy user in a child account can modify the &#x60;username&#x60;, &#x60;email&#x60;, and &#x60;restricted&#x60; status for an existing child account user. - A restricted account user–parent or child–can&#39;t change their user to &#x60;unrestricted&#x60;. &lt;&lt;LB&gt;&gt; — - __CLI__. &#x60;&#x60;&#x60; linode-cli users update example_user \ –username example_user \ –email [email protected] \ –restricted true &#x60;&#x60;&#x60; [Learn more…](www.linode.com/docs/products/tools/cli/get-started/) - __OAuth scopes__. &#x60;&#x60;&#x60; account:read_write &#x60;&#x60;&#x60; [Learn more…](techdocs.akamai.com/linode-api/reference/get-started#oauth)

Parameters:

  • api_version (String) —

    __Enum__ Call either the &#x60;v4&#x60; URL, or &#x60;v4beta&#x60; for operations still in Beta.

  • username (String) —

    The username to look up.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    PutUser200Response data, response status code and response headers



4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
 
# File 'lib/linode_openapi_client/api/account_api.rb', line 4878

def put_user_with_http_info(api_version, username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.put_user ...'
  end
  # verify the required parameter 'api_version' is set
  if @api_client.config.client_side_validation && api_version.nil?
    fail ArgumentError, "Missing the required parameter 'api_version' when calling AccountApi.put_user"
  end
  # verify enum value
  allowable_values = ["v4", "v4beta"]
  if @api_client.config.client_side_validation && !allowable_values.include?(api_version)
    fail ArgumentError, "invalid value for \"api_version\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling AccountApi.put_user"
  end
  # resource path
  local_var_path = '/{apiVersion}/account/users/{username}'.sub('{' + 'apiVersion' + '}', CGI.escape(api_version.to_s)).sub('{' + 'username' + '}', CGI.escape(username.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']) unless header_params['Accept']
  # 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[:'put_user_request'])

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['personalAccessToken', 'oauth']

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