Class: KoronaClient::CommodityGroupsApi
- Inherits:
-
Object
- Object
- KoronaClient::CommodityGroupsApi
- Defined in:
- lib/korona_client/api/commodity_groups_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#add_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new commodity groups.
-
#add_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
adds a batch of new commodity groups.
-
#delete_commodity_group(korona_account_id, commodity_group_id, opts = {}) ⇒ nil
deletes the single commodity group.
-
#delete_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
deletes the single commodity group.
-
#delete_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of commodity groups.
-
#delete_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
deletes a batch of commodity groups.
-
#get_commodity_group(korona_account_id, commodity_group_id, opts = {}) ⇒ CommodityGroup
returns the single commodity group.
-
#get_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) ⇒ Array<(CommodityGroup, Fixnum, Hash)>
returns the single commodity group.
-
#get_commodity_groups(korona_account_id, opts = {}) ⇒ ResultListCommodityGroup
lists all commodity groups.
-
#get_commodity_groups_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCommodityGroup, Fixnum, Hash)>
lists all commodity groups.
-
#initialize(api_client = ApiClient.default) ⇒ CommodityGroupsApi
constructor
A new instance of CommodityGroupsApi.
-
#update_commodity_group(korona_account_id, commodity_group_id, body, opts = {}) ⇒ nil
updates the single commodity group.
-
#update_commodity_group_with_http_info(korona_account_id, commodity_group_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
updates the single commodity group.
-
#update_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of commodity groups.
-
#update_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
updates a batch of commodity groups.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ CommodityGroupsApi
Returns a new instance of CommodityGroupsApi.
19 20 21 |
# File 'lib/korona_client/api/commodity_groups_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_client/api/commodity_groups_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#add_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
adds a batch of new commodity groups
29 30 31 32 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 29 def add_commodity_groups(korona_account_id, body, opts = {}) data, _status_code, _headers = add_commodity_groups_with_http_info(korona_account_id, body, opts) data end |
#add_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
adds a batch of new commodity groups
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 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 41 def add_commodity_groups_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.add_commodity_groups ...' 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 CommodityGroupsApi.add_commodity_groups" 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 CommodityGroupsApi.add_commodity_groups" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s) # query parameters query_params = {} query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#add_commodity_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_commodity_group(korona_account_id, commodity_group_id, opts = {}) ⇒ nil
deletes the single commodity group
91 92 93 94 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 91 def delete_commodity_group(korona_account_id, commodity_group_id, opts = {}) delete_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts) nil end |
#delete_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
deletes the single commodity group
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 102 def delete_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.delete_commodity_group ...' 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 CommodityGroupsApi.delete_commodity_group" end # verify the required parameter 'commodity_group_id' is set if @api_client.config.client_side_validation && commodity_group_id.nil? fail ArgumentError, "Missing the required parameter 'commodity_group_id' when calling CommodityGroupsApi.delete_commodity_group" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups/{commodityGroupId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'commodityGroupId' + '}', commodity_group_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#delete_commodity_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
deletes a batch of commodity groups
150 151 152 153 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 150 def delete_commodity_groups(korona_account_id, body, opts = {}) data, _status_code, _headers = delete_commodity_groups_with_http_info(korona_account_id, body, opts) data end |
#delete_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
deletes a batch of commodity groups
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 161 def delete_commodity_groups_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.delete_commodity_groups ...' 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 CommodityGroupsApi.delete_commodity_groups" 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 CommodityGroupsApi.delete_commodity_groups" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#delete_commodity_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_commodity_group(korona_account_id, commodity_group_id, opts = {}) ⇒ CommodityGroup
returns the single commodity group
210 211 212 213 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 210 def get_commodity_group(korona_account_id, commodity_group_id, opts = {}) data, _status_code, _headers = get_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts) data end |
#get_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) ⇒ Array<(CommodityGroup, Fixnum, Hash)>
returns the single commodity group
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 221 def get_commodity_group_with_http_info(korona_account_id, commodity_group_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.get_commodity_group ...' 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 CommodityGroupsApi.get_commodity_group" end # verify the required parameter 'commodity_group_id' is set if @api_client.config.client_side_validation && commodity_group_id.nil? fail ArgumentError, "Missing the required parameter 'commodity_group_id' when calling CommodityGroupsApi.get_commodity_group" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups/{commodityGroupId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'commodityGroupId' + '}', commodity_group_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'CommodityGroup') if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#get_commodity_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_commodity_groups(korona_account_id, opts = {}) ⇒ ResultListCommodityGroup
lists all commodity groups
275 276 277 278 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 275 def get_commodity_groups(korona_account_id, opts = {}) data, _status_code, _headers = get_commodity_groups_with_http_info(korona_account_id, opts) data end |
#get_commodity_groups_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListCommodityGroup, Fixnum, Hash)>
lists all commodity groups
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 291 def get_commodity_groups_with_http_info(korona_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.get_commodity_groups ...' 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 CommodityGroupsApi.get_commodity_groups" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s) # query parameters 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[:'number'] = opts[:'number'] if !opts[:'number'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ResultListCommodityGroup') if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#get_commodity_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_commodity_group(korona_account_id, commodity_group_id, body, opts = {}) ⇒ nil
updates the single commodity group
343 344 345 346 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 343 def update_commodity_group(korona_account_id, commodity_group_id, body, opts = {}) update_commodity_group_with_http_info(korona_account_id, commodity_group_id, body, opts) nil end |
#update_commodity_group_with_http_info(korona_account_id, commodity_group_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
updates the single commodity group
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 395 396 397 398 399 400 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 355 def update_commodity_group_with_http_info(korona_account_id, commodity_group_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.update_commodity_group ...' 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 CommodityGroupsApi.update_commodity_group" end # verify the required parameter 'commodity_group_id' is set if @api_client.config.client_side_validation && commodity_group_id.nil? fail ArgumentError, "Missing the required parameter 'commodity_group_id' when calling CommodityGroupsApi.update_commodity_group" 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 CommodityGroupsApi.update_commodity_group" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups/{commodityGroupId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'commodityGroupId' + '}', commodity_group_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#update_commodity_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_commodity_groups(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>
updates a batch of commodity groups
407 408 409 410 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 407 def update_commodity_groups(korona_account_id, body, opts = {}) data, _status_code, _headers = update_commodity_groups_with_http_info(korona_account_id, body, opts) data end |
#update_commodity_groups_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>
updates a batch of commodity groups
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 |
# File 'lib/korona_client/api/commodity_groups_api.rb', line 418 def update_commodity_groups_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CommodityGroupsApi.update_commodity_groups ...' 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 CommodityGroupsApi.update_commodity_groups" 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 CommodityGroupsApi.update_commodity_groups" end # resource path local_var_path = '/accounts/{koronaAccountId}/commodityGroups'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<AddOrUpdateResult>') if @api_client.config.debugging @api_client.config.logger.debug "API called: CommodityGroupsApi#update_commodity_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |