Class: OrderCloud::PriceScheduleApi
- Inherits:
-
Object
- Object
- OrderCloud::PriceScheduleApi
- Defined in:
- lib/order_cloud/api/price_schedule_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
- #create(price_schedule, opts = {}) ⇒ PriceSchedule
-
#create_with_http_info(price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
PriceSchedule data, response status code and response headers.
- #delete(price_schedule_id, opts = {}) ⇒ nil
- #delete_price_break(price_schedule_id, quantity, opts = {}) ⇒ nil
-
#delete_price_break_with_http_info(price_schedule_id, quantity, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Nil, response status code and response headers.
-
#delete_with_http_info(price_schedule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Nil, response status code and response headers.
- #get(price_schedule_id, opts = {}) ⇒ PriceSchedule
-
#get_with_http_info(price_schedule_id, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
PriceSchedule data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ PriceScheduleApi
constructor
A new instance of PriceScheduleApi.
- #list(opts = {}) ⇒ ListPriceSchedule
-
#list_with_http_info(opts = {}) ⇒ Array<(ListPriceSchedule, Fixnum, Hash)>
ListPriceSchedule data, response status code and response headers.
- #patch(price_schedule_id, price_schedule, opts = {}) ⇒ PriceSchedule
-
#patch_with_http_info(price_schedule_id, price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
PriceSchedule data, response status code and response headers.
- #save_price_break(price_schedule_id, price_break, opts = {}) ⇒ PriceSchedule
-
#save_price_break_with_http_info(price_schedule_id, price_break, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
PriceSchedule data, response status code and response headers.
- #update(price_schedule_id, price_schedule, opts = {}) ⇒ PriceSchedule
-
#update_with_http_info(price_schedule_id, price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
PriceSchedule data, response status code and response headers.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ PriceScheduleApi
Returns a new instance of PriceScheduleApi.
30 31 32 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
28 29 30 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 28 def api_client @api_client end |
Instance Method Details
#create(price_schedule, opts = {}) ⇒ PriceSchedule
39 40 41 42 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 39 def create(price_schedule, opts = {}) data, _status_code, _headers = create_with_http_info(price_schedule, opts) return data end |
#create_with_http_info(price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
Returns PriceSchedule data, response status code and response headers.
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 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 49 def create_with_http_info(price_schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.create ..." end # verify the required parameter 'price_schedule' is set fail ArgumentError, "Missing the required parameter 'price_schedule' when calling PriceScheduleApi.create" if price_schedule.nil? # resource path local_var_path = "/priceschedules".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(price_schedule) auth_names = ['oauth2'] 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 => 'PriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete(price_schedule_id, opts = {}) ⇒ nil
96 97 98 99 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 96 def delete(price_schedule_id, opts = {}) delete_with_http_info(price_schedule_id, opts) return nil end |
#delete_price_break(price_schedule_id, quantity, opts = {}) ⇒ nil
153 154 155 156 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 153 def delete_price_break(price_schedule_id, quantity, opts = {}) delete_price_break_with_http_info(price_schedule_id, quantity, opts) return nil end |
#delete_price_break_with_http_info(price_schedule_id, quantity, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Returns nil, response status code and response headers.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 164 def delete_price_break_with_http_info(price_schedule_id, quantity, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.delete_price_break ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.delete_price_break" if price_schedule_id.nil? # verify the required parameter 'quantity' is set fail ArgumentError, "Missing the required parameter 'quantity' when calling PriceScheduleApi.delete_price_break" if quantity.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}/PriceBreaks".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} query_params[:'quantity'] = quantity # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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: PriceScheduleApi#delete_price_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_with_http_info(price_schedule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Returns nil, response status code and response headers.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 106 def delete_with_http_info(price_schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.delete ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.delete" if price_schedule_id.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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: PriceScheduleApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get(price_schedule_id, opts = {}) ⇒ PriceSchedule
213 214 215 216 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 213 def get(price_schedule_id, opts = {}) data, _status_code, _headers = get_with_http_info(price_schedule_id, opts) return data end |
#get_with_http_info(price_schedule_id, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
Returns PriceSchedule data, response status code and response headers.
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/order_cloud/api/price_schedule_api.rb', line 223 def get_with_http_info(price_schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.get ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.get" if price_schedule_id.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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 => 'PriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list(opts = {}) ⇒ ListPriceSchedule
275 276 277 278 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 275 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) return data end |
#list_with_http_info(opts = {}) ⇒ Array<(ListPriceSchedule, Fixnum, Hash)>
Returns ListPriceSchedule data, response status code and response headers.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 290 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.list ..." end # resource path local_var_path = "/priceschedules".sub('{format}','json') # query parameters query_params = {} query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil? query_params[:'searchOn'] = opts[:'search_on'] if !opts[:'search_on'].nil? query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'filters'] = opts[:'filters'] if !opts[:'filters'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['oauth2'] 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 => 'ListPriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch(price_schedule_id, price_schedule, opts = {}) ⇒ PriceSchedule
342 343 344 345 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 342 def patch(price_schedule_id, price_schedule, opts = {}) data, _status_code, _headers = patch_with_http_info(price_schedule_id, price_schedule, opts) return data end |
#patch_with_http_info(price_schedule_id, price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
Returns PriceSchedule data, response status code and response headers.
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 395 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 353 def patch_with_http_info(price_schedule_id, price_schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.patch ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.patch" if price_schedule_id.nil? # verify the required parameter 'price_schedule' is set fail ArgumentError, "Missing the required parameter 'price_schedule' when calling PriceScheduleApi.patch" if price_schedule.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(price_schedule) auth_names = ['oauth2'] 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 => 'PriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#save_price_break(price_schedule_id, price_break, opts = {}) ⇒ PriceSchedule
403 404 405 406 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 403 def save_price_break(price_schedule_id, price_break, opts = {}) data, _status_code, _headers = save_price_break_with_http_info(price_schedule_id, price_break, opts) return data end |
#save_price_break_with_http_info(price_schedule_id, price_break, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
Returns PriceSchedule data, response status code and response headers.
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 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 414 def save_price_break_with_http_info(price_schedule_id, price_break, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.save_price_break ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.save_price_break" if price_schedule_id.nil? # verify the required parameter 'price_break' is set fail ArgumentError, "Missing the required parameter 'price_break' when calling PriceScheduleApi.save_price_break" if price_break.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}/PriceBreaks".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(price_break) auth_names = ['oauth2'] 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 => 'PriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#save_price_break\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(price_schedule_id, price_schedule, opts = {}) ⇒ PriceSchedule
464 465 466 467 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 464 def update(price_schedule_id, price_schedule, opts = {}) data, _status_code, _headers = update_with_http_info(price_schedule_id, price_schedule, opts) return data end |
#update_with_http_info(price_schedule_id, price_schedule, opts = {}) ⇒ Array<(PriceSchedule, Fixnum, Hash)>
Returns PriceSchedule data, response status code and response headers.
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 |
# File 'lib/order_cloud/api/price_schedule_api.rb', line 475 def update_with_http_info(price_schedule_id, price_schedule, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PriceScheduleApi.update ..." end # verify the required parameter 'price_schedule_id' is set fail ArgumentError, "Missing the required parameter 'price_schedule_id' when calling PriceScheduleApi.update" if price_schedule_id.nil? # verify the required parameter 'price_schedule' is set fail ArgumentError, "Missing the required parameter 'price_schedule' when calling PriceScheduleApi.update" if price_schedule.nil? # resource path local_var_path = "/priceschedules/{priceScheduleID}".sub('{format}','json').sub('{' + 'priceScheduleID' + '}', price_schedule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/plain; charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(price_schedule) auth_names = ['oauth2'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PriceSchedule') if @api_client.config.debugging @api_client.config.logger.debug "API called: PriceScheduleApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |