class KoronaClient::CustomerOrdersApi
Attributes
Public Class Methods
# File lib/korona_client/api/customer_orders_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
adds a batch of new customer orders
@param korona_account_id account id of the KORONA.cloud account @param body array of new customer orders @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]
# File lib/korona_client/api/customer_orders_api.rb, line 28 def add_customer_orders(korona_account_id, body, opts = {}) data, _status_code, _headers = add_customer_orders_with_http_info(korona_account_id, body, opts) data end
adds a batch of new customer orders
@param korona_account_id account id of the KORONA.cloud account @param body array of new customer orders @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 39 def add_customer_orders_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.add_customer_orders ...' 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 CustomerOrdersApi.add_customer_orders" 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 CustomerOrdersApi.add_customer_orders" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders'.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(: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: CustomerOrdersApi#add_customer_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
deletes the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @option opts [String] :number number of the related object @return [nil]
# File lib/korona_client/api/customer_orders_api.rb, line 89 def delete_customer_order(korona_account_id, customer_order_id, opts = {}) delete_customer_order_with_http_info(korona_account_id, customer_order_id, opts) nil end
deletes the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @option opts [String] :number number of the related object @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 101 def delete_customer_order_with_http_info(korona_account_id, customer_order_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.delete_customer_order ...' 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 CustomerOrdersApi.delete_customer_order" end # verify the required parameter 'customer_order_id' is set if @api_client.config.client_side_validation && customer_order_id.nil? fail ArgumentError, "Missing the required parameter 'customer_order_id' when calling CustomerOrdersApi.delete_customer_order" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders/{customerOrderId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerOrderId' + '}', customer_order_id.to_s) # query parameters query_params = {} 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(: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: CustomerOrdersApi#delete_customer_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
returns the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [CustomerOrder]
# File lib/korona_client/api/customer_orders_api.rb, line 150 def get_customer_order(korona_account_id, customer_order_id, opts = {}) data, _status_code, _headers = get_customer_order_with_http_info(korona_account_id, customer_order_id, opts) data end
returns the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param [Hash] opts the optional parameters @return [Array<(CustomerOrder
, Fixnum, Hash)>] CustomerOrder
data, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 161 def get_customer_order_with_http_info(korona_account_id, customer_order_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.get_customer_order ...' 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 CustomerOrdersApi.get_customer_order" end # verify the required parameter 'customer_order_id' is set if @api_client.config.client_side_validation && customer_order_id.nil? fail ArgumentError, "Missing the required parameter 'customer_order_id' when calling CustomerOrdersApi.get_customer_order" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders/{customerOrderId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerOrderId' + '}', customer_order_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 => 'CustomerOrder') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerOrdersApi#get_customer_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
lists all customer orders
@param korona_account_id account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [BOOLEAN] :include_deleted indicates deleted objects should be loaded or not (default: false) @option opts [DateTime] :min_create_time min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :max_create_time max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :min_pick_up_time min (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :max_pick_up_time max (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) @option opts [String] :number number of the related object @return [ResultListCustomerOrder]
# File lib/korona_client/api/customer_orders_api.rb, line 219 def get_customer_orders(korona_account_id, opts = {}) data, _status_code, _headers = get_customer_orders_with_http_info(korona_account_id, opts) data end
lists all customer orders
@param korona_account_id account id of the KORONA.cloud account @param [Hash] opts the optional parameters @option opts [Integer] :page number of the page to fetch @option opts [Integer] :size amount of objects to return per page @option opts [String] :sort attribute to sort by (multiple separated by comma; max. 5) @option opts [Integer] :revision last revision number, objects with a greater revision than this will be returned @option opts [BOOLEAN] :include_deleted indicates deleted objects should be loaded or not (default: false) @option opts [DateTime] :min_create_time min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :max_create_time max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :min_pick_up_time min (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) @option opts [DateTime] :max_pick_up_time max (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) @option opts [String] :number number of the related object @return [Array<(ResultListCustomerOrder
, Fixnum, Hash)>] ResultListCustomerOrder
data, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 239 def get_customer_orders_with_http_info(korona_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.get_customer_orders ...' 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 CustomerOrdersApi.get_customer_orders" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders'.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[:'minCreateTime'] = opts[:'min_create_time'] if !opts[:'min_create_time'].nil? query_params[:'maxCreateTime'] = opts[:'max_create_time'] if !opts[:'max_create_time'].nil? query_params[:'minPickUpTime'] = opts[:'min_pick_up_time'] if !opts[:'min_pick_up_time'].nil? query_params[:'maxPickUpTime'] = opts[:'max_pick_up_time'] if !opts[:'max_pick_up_time'].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 => 'ResultListCustomerOrder') if @api_client.config.debugging @api_client.config.logger.debug "API called: CustomerOrdersApi#get_customer_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
updates the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the customer order @param [Hash] opts the optional parameters @return [nil]
# File lib/korona_client/api/customer_orders_api.rb, line 295 def update_customer_order(korona_account_id, customer_order_id, body, opts = {}) update_customer_order_with_http_info(korona_account_id, customer_order_id, body, opts) nil end
updates the single customer order
@param korona_account_id account id of the KORONA.cloud account @param customer_order_id id of the related object (important: id should match the uuid-format) @param body the properties to update of the customer order @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 307 def update_customer_order_with_http_info(korona_account_id, customer_order_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.update_customer_order ...' 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 CustomerOrdersApi.update_customer_order" end # verify the required parameter 'customer_order_id' is set if @api_client.config.client_side_validation && customer_order_id.nil? fail ArgumentError, "Missing the required parameter 'customer_order_id' when calling CustomerOrdersApi.update_customer_order" 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 CustomerOrdersApi.update_customer_order" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders/{customerOrderId}'.sub('{' + 'koronaAccountId' + '}', korona_account_id.to_s).sub('{' + 'customerOrderId' + '}', customer_order_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: CustomerOrdersApi#update_customer_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
updates a batch of customer orders
- number
-
must be set in the objects, otherwise the object cannot be updated
@param korona_account_id account id of the KORONA.cloud account @param body an array of existing customer orders @param [Hash] opts the optional parameters @return [Array<AddOrUpdateResult>]
# File lib/korona_client/api/customer_orders_api.rb, line 359 def update_customer_orders(korona_account_id, body, opts = {}) data, _status_code, _headers = update_customer_orders_with_http_info(korona_account_id, body, opts) data end
updates a batch of customer orders
- number
-
must be set in the objects, otherwise the object cannot be updated
@param korona_account_id account id of the KORONA.cloud account @param body an array of existing customer orders @param [Hash] opts the optional parameters @return [Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>] Array<AddOrUpdateResult> data, response status code and response headers
# File lib/korona_client/api/customer_orders_api.rb, line 370 def update_customer_orders_with_http_info(korona_account_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: CustomerOrdersApi.update_customer_orders ...' 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 CustomerOrdersApi.update_customer_orders" 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 CustomerOrdersApi.update_customer_orders" end # resource path local_var_path = '/accounts/{koronaAccountId}/customerOrders'.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: CustomerOrdersApi#update_customer_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end