Class: KoronaCloudClient::AccountsApi
- Inherits:
-
Object
- Object
- KoronaCloudClient::AccountsApi
- Defined in:
- lib/korona-cloud-client/api/accounts_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new accounts.
-
#add_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
adds a batch of new accounts.
-
#delete_account(korona_account_id, account_id, opts = {}) ⇒ nil
deletes the single account.
-
#delete_account_with_http_info(korona_account_id, account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
deletes the single account.
-
#delete_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of accounts.
-
#delete_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
deletes a batch of accounts.
-
#get_account(korona_account_id, account_id, opts = {}) ⇒ Account
returns a single account.
-
#get_account_with_http_info(korona_account_id, account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>
returns a single account.
-
#get_accounts(korona_account_id, opts = {}) ⇒ ResultListAccount
lists all accounts.
-
#get_accounts_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListAccount, Integer, Hash)>
lists all accounts.
-
#initialize(api_client = ApiClient.default) ⇒ AccountsApi
constructor
A new instance of AccountsApi.
-
#update_account(korona_account_id, account_id, account, opts = {}) ⇒ nil
updates the single account; if [number] is set, the number of the object will change and the resource location as well.
-
#update_account_with_http_info(korona_account_id, account_id, account, opts = {}) ⇒ Array<(nil, Integer, Hash)>
updates the single account; if [number] is set, the number of the object will change and the resource location as well.
-
#update_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of accounts; [number] must be set in the objects, otherwise the object cannot be updated.
-
#update_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
updates a batch of accounts; [number] must be set in the objects, otherwise the object cannot be updated.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AccountsApi
Returns a new instance of AccountsApi.
19 20 21 |
# File 'lib/korona-cloud-client/api/accounts_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/korona-cloud-client/api/accounts_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new accounts
29 30 31 32 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 29 def add_accounts(korona_account_id, account, opts = {}) data, _status_code, _headers = add_accounts_with_http_info(korona_account_id, account, opts) data end |
#add_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
adds a batch of new accounts
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 95 96 97 98 99 100 101 102 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 41 def add_accounts_with_http_info(korona_account_id, account, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.add_accounts ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.add_accounts" end # verify the required parameter 'account' is set if @api_client.config.client_side_validation && account.nil? fail ArgumentError, "Missing the required parameter 'account' when calling AccountsApi.add_accounts" end allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"] if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode']) fail ArgumentError, "invalid value for \"write_mode\", must be one of #{allowable_values}" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil? query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(account) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.add_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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#add_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_account(korona_account_id, account_id, opts = {}) ⇒ nil
deletes the single account
109 110 111 112 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 109 def delete_account(korona_account_id, account_id, opts = {}) delete_account_with_http_info(korona_account_id, account_id, opts) nil end |
#delete_account_with_http_info(korona_account_id, account_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
deletes the single account
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 169 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 119 def delete_account_with_http_info(korona_account_id, account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.delete_account ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.delete_account" end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts/{accountId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'accountId' + '}', CGI.escape(account_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.delete_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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of accounts
176 177 178 179 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 176 def delete_accounts(korona_account_id, account, opts = {}) data, _status_code, _headers = delete_accounts_with_http_info(korona_account_id, account, opts) data end |
#delete_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
deletes a batch of accounts
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 186 def delete_accounts_with_http_info(korona_account_id, account, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.delete_accounts ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.delete_accounts" end # verify the required parameter 'account' is set if @api_client.config.client_side_validation && account.nil? fail ArgumentError, "Missing the required parameter 'account' when calling AccountsApi.delete_accounts" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(account) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.delete_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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#delete_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_account(korona_account_id, account_id, opts = {}) ⇒ Account
returns a single account
248 249 250 251 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 248 def get_account(korona_account_id, account_id, opts = {}) data, _status_code, _headers = get_account_with_http_info(korona_account_id, account_id, opts) data end |
#get_account_with_http_info(korona_account_id, account_id, opts = {}) ⇒ Array<(Account, Integer, Hash)>
returns a single account
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 258 def get_account_with_http_info(korona_account_id, account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.get_account ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.get_account" end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts/{accountId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'accountId' + '}', CGI.escape(account_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Account' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_accounts(korona_account_id, opts = {}) ⇒ ResultListAccount
lists all accounts
319 320 321 322 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 319 def get_accounts(korona_account_id, opts = {}) data, _status_code, _headers = get_accounts_with_http_info(korona_account_id, opts) data end |
#get_accounts_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListAccount, Integer, Hash)>
lists all accounts
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 333 def get_accounts_with_http_info(korona_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.get_accounts ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.get_accounts" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil? query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ResultListAccount' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.get_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#get_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_account(korona_account_id, account_id, account, opts = {}) ⇒ nil
updates the single account; if [number] is set, the number of the object will change and the resource location as well
392 393 394 395 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 392 def update_account(korona_account_id, account_id, account, opts = {}) update_account_with_http_info(korona_account_id, account_id, account, opts) nil end |
#update_account_with_http_info(korona_account_id, account_id, account, opts = {}) ⇒ Array<(nil, Integer, Hash)>
updates the single account; if [number] is set, the number of the object will change and the resource location as well
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 403 def update_account_with_http_info(korona_account_id, account_id, account, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.update_account ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.update_account" end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.update_account" end # verify the required parameter 'account' is set if @api_client.config.client_side_validation && account.nil? fail ArgumentError, "Missing the required parameter 'account' when calling AccountsApi.update_account" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts/{accountId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(account) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.update_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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_accounts(korona_account_id, account, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of accounts; [number] must be set in the objects, otherwise the object cannot be updated
469 470 471 472 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 469 def update_accounts(korona_account_id, account, opts = {}) data, _status_code, _headers = update_accounts_with_http_info(korona_account_id, account, opts) data end |
#update_accounts_with_http_info(korona_account_id, account, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
updates a batch of accounts; [number] must be set in the objects, otherwise the object cannot be updated
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 527 528 529 530 531 532 533 534 |
# File 'lib/korona-cloud-client/api/accounts_api.rb', line 479 def update_accounts_with_http_info(korona_account_id, account, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountsApi.update_accounts ...' end # verify the required parameter 'korona_account_id' is set if @api_client.config.client_side_validation && korona_account_id.nil? fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling AccountsApi.update_accounts" end # verify the required parameter 'account' is set if @api_client.config.client_side_validation && account.nil? fail ArgumentError, "Missing the required parameter 'account' when calling AccountsApi.update_accounts" end # resource path local_var_path = '/accounts/{koronaAccountId}/accounts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(account) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"AccountsApi.update_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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountsApi#update_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |