Class: KoronaCloudClient::CashiersApi
- Inherits:
-
Object
- Object
- KoronaCloudClient::CashiersApi
- Defined in:
- lib/korona-cloud-client/api/cashiers_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new cashiers.
-
#add_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
adds a batch of new cashiers.
-
#delete_cashier(korona_account_id, cashier_id, opts = {}) ⇒ nil
deletes the single cashier.
-
#delete_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
deletes the single cashier.
-
#delete_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of cashiers.
-
#delete_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
deletes a batch of cashiers.
-
#get_cashier(korona_account_id, cashier_id, opts = {}) ⇒ Cashier
returns the single cashier.
-
#get_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) ⇒ Array<(Cashier, Integer, Hash)>
returns the single cashier.
-
#get_cashiers(korona_account_id, opts = {}) ⇒ ResultListCashier
lists all cashiers.
-
#get_cashiers_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCashier, Integer, Hash)>
lists all cashiers.
-
#initialize(api_client = ApiClient.default) ⇒ CashiersApi
constructor
A new instance of CashiersApi.
-
#update_cashier(korona_account_id, cashier_id, body, opts = {}) ⇒ nil
updates the single cashier if [number] is set, the number of the object will change and the resource location as well.
-
#update_cashier_with_http_info(korona_account_id, cashier_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
updates the single cashier if [number] is set, the number of the object will change and the resource location as well.
-
#update_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of cashiers [number] must be set in the objects, otherwise the object cannot be updated.
-
#update_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
updates a batch of cashiers [number] must be set in the objects, otherwise the object cannot be updated.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CashiersApi
Returns a new instance of CashiersApi.
19 20 21 |
# File 'lib/korona-cloud-client/api/cashiers_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/cashiers_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new cashiers
28 29 30 31 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 28 def add_cashiers(korona_account_id, body, opts = {}) data, _status_code, _headers = add_cashiers_with_http_info(korona_account_id, body, opts) data end |
#add_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
adds a batch of new cashiers
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 95 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 39 def add_cashiers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.add_cashiers ...' 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 CashiersApi.add_cashiers" 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 CashiersApi.add_cashiers" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers'.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? # 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(body) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.add_cashiers", :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: CashiersApi#add_cashiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_cashier(korona_account_id, cashier_id, opts = {}) ⇒ nil
deletes the single cashier
102 103 104 105 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 102 def delete_cashier(korona_account_id, cashier_id, opts = {}) delete_cashier_with_http_info(korona_account_id, cashier_id, opts) nil end |
#delete_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
deletes the single cashier
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 112 def delete_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.delete_cashier ...' 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 CashiersApi.delete_cashier" end # verify the required parameter 'cashier_id' is set if @api_client.config.client_side_validation && cashier_id.nil? fail ArgumentError, "Missing the required parameter 'cashier_id' when calling CashiersApi.delete_cashier" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers/{cashierId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'cashierId' + '}', CGI.escape(cashier_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 => :"CashiersApi.delete_cashier", :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: CashiersApi#delete_cashier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of cashiers
169 170 171 172 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 169 def delete_cashiers(korona_account_id, body, opts = {}) data, _status_code, _headers = delete_cashiers_with_http_info(korona_account_id, body, opts) data end |
#delete_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
deletes a batch of cashiers
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 179 def delete_cashiers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.delete_cashiers ...' 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 CashiersApi.delete_cashiers" 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 CashiersApi.delete_cashiers" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers'.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(body) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.delete_cashiers", :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: CashiersApi#delete_cashiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_cashier(korona_account_id, cashier_id, opts = {}) ⇒ Cashier
returns the single cashier
242 243 244 245 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 242 def get_cashier(korona_account_id, cashier_id, opts = {}) data, _status_code, _headers = get_cashier_with_http_info(korona_account_id, cashier_id, opts) data end |
#get_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) ⇒ Array<(Cashier, Integer, Hash)>
returns the single cashier
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 253 def get_cashier_with_http_info(korona_account_id, cashier_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.get_cashier ...' 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 CashiersApi.get_cashier" end # verify the required parameter 'cashier_id' is set if @api_client.config.client_side_validation && cashier_id.nil? fail ArgumentError, "Missing the required parameter 'cashier_id' when calling CashiersApi.get_cashier" end allowable_values = ["HASH", "PLAIN", "NONE"] if @api_client.config.client_side_validation && opts[:'display_cashier_credentials'] && !allowable_values.include?(opts[:'display_cashier_credentials']) fail ArgumentError, "invalid value for \"display_cashier_credentials\", must be one of #{allowable_values}" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers/{cashierId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'cashierId' + '}', CGI.escape(cashier_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'displayCashierCredentials'] = opts[:'display_cashier_credentials'] if !opts[:'display_cashier_credentials'].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] || 'Cashier' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.get_cashier", :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: CashiersApi#get_cashier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_cashiers(korona_account_id, opts = {}) ⇒ ResultListCashier
lists all cashiers
321 322 323 324 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 321 def get_cashiers(korona_account_id, opts = {}) data, _status_code, _headers = get_cashiers_with_http_info(korona_account_id, opts) data end |
#get_cashiers_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCashier, Integer, Hash)>
lists all cashiers
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 391 392 393 394 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 337 def get_cashiers_with_http_info(korona_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.get_cashiers ...' 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 CashiersApi.get_cashiers" end allowable_values = ["HASH", "PLAIN", "NONE"] if @api_client.config.client_side_validation && opts[:'display_cashier_credentials'] && !allowable_values.include?(opts[:'display_cashier_credentials']) fail ArgumentError, "invalid value for \"display_cashier_credentials\", must be one of #{allowable_values}" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers'.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? query_params[:'displayCashierCredentials'] = opts[:'display_cashier_credentials'] if !opts[:'display_cashier_credentials'].nil? query_params[:'number'] = opts[:'number'] if !opts[:'number'].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] || 'ResultListCashier' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.get_cashiers", :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: CashiersApi#get_cashiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_cashier(korona_account_id, cashier_id, body, opts = {}) ⇒ nil
updates the single cashier if [number] is set, the number of the object will change and the resource location as well
403 404 405 406 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 403 def update_cashier(korona_account_id, cashier_id, body, opts = {}) update_cashier_with_http_info(korona_account_id, cashier_id, body, opts) nil end |
#update_cashier_with_http_info(korona_account_id, cashier_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>
updates the single cashier if [number] is set, the number of the object will change and the resource location as well
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 463 464 465 466 467 468 469 470 471 472 473 474 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 415 def update_cashier_with_http_info(korona_account_id, cashier_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.update_cashier ...' 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 CashiersApi.update_cashier" end # verify the required parameter 'cashier_id' is set if @api_client.config.client_side_validation && cashier_id.nil? fail ArgumentError, "Missing the required parameter 'cashier_id' when calling CashiersApi.update_cashier" 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 CashiersApi.update_cashier" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers/{cashierId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(korona_account_id.to_s)).sub('{' + 'cashierId' + '}', CGI.escape(cashier_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(body) # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.update_cashier", :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: CashiersApi#update_cashier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_cashiers(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of cashiers
- number
-
must be set in the objects, otherwise the object cannot be updated
482 483 484 485 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 482 def update_cashiers(korona_account_id, body, opts = {}) data, _status_code, _headers = update_cashiers_with_http_info(korona_account_id, body, opts) data end |
#update_cashiers_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>
updates a batch of cashiers
- number
-
must be set in the objects, otherwise the object cannot be updated
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 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/korona-cloud-client/api/cashiers_api.rb', line 493 def update_cashiers_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CashiersApi.update_cashiers ...' 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 CashiersApi.update_cashiers" 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 CashiersApi.update_cashiers" end # resource path local_var_path = '/accounts/{koronaAccountId}/cashiers'.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(body) # return_type return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>' # auth_names auth_names = opts[:debug_auth_names] || ['basicAuth'] = opts.merge( :operation => :"CashiersApi.update_cashiers", :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: CashiersApi#update_cashiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |