ultracart_api 3.11.19 → 3.11.21

data/docs/OrderApi.md

@@ -26,6 +26,7 @@ Method | HTTP request | Description
 [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
 [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
 [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
+[**replace_order_item_merchant_item_id**](OrderApi.md#replace_order_item_merchant_item_id) | **PUT** /order/orders/{order_id}/replace_item_id | Replaces an order item id
 [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
 [**resend_receipt**](OrderApi.md#resend_receipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
 [**resend_shipment_confirmation**](OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
@@ -1265,6 +1266,63 @@ Name | Type | Description  | Notes
 
 
 
+# **replace_order_item_merchant_item_id**
+> OrderResponse replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts)
+
+Replaces an order item id
+
+Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged.  A custom method requested by a merchant to allow for item id updates due to shipping errors.  It is doubtful you will ever need this method.  The expansion variable affects the returned order object. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+replace_order_item_id_request = UltracartClient::ReplaceOrderItemIdRequest.new # ReplaceOrderItemIdRequest | Replacement Request
+
+order_id = 'order_id_example' # String | The order id to update.
+
+opts = { 
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Replaces an order item id
+  result = api_instance.replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->replace_order_item_merchant_item_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **replace_order_item_id_request** | [**ReplaceOrderItemIdRequest**](ReplaceOrderItemIdRequest.md)| Replacement Request | 
+ **order_id** | **String**| The order id to update. | 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**OrderResponse**](OrderResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json; charset=UTF-8
+ - **Accept**: application/json
+
+
+
 # **replacement**
 > OrderReplacementResponse replacement(order_id, replacement)
 

data/docs/ReplaceOrderItemIdRequest.md

@@ -0,0 +1,11 @@
+# UltracartClient::ReplaceOrderItemIdRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**item_index** | **Integer** | Index of the item on the order (one based index) | [optional] 
+**merchant_item_id** | **String** | Item ID | [optional] 
+**order_id** | **String** | Order ID | [optional] 
+**replacement_merchant_item_id** | **String** | Replacement Item ID | [optional] 
+
+

data/lib/ultracart_api/api/datawarehouse_api.rb

@@ -32,6 +32,67 @@ module UltracartClient
       UltracartClient::DatawarehouseApi.new(api_client)
     end
 
+    # Analyze a custom report
+    # Analyze a custom report on the UltraCart account. 
+    # @param analyze_request Request to analyze custom report
+    # @param custom_report_oid The report oid to analyze.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportAnalysisResponse]
+    def analyze_custom_report(analyze_request, custom_report_oid, opts = {})
+      data, _status_code, _headers = analyze_custom_report_with_http_info(analyze_request, custom_report_oid, opts)
+      data
+    end
+
+    # Analyze a custom report
+    # Analyze a custom report on the UltraCart account. 
+    # @param analyze_request Request to analyze custom report
+    # @param custom_report_oid The report oid to analyze.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportAnalysisResponse, Fixnum, Hash)>] CustomReportAnalysisResponse data, response status code and response headers
+    def analyze_custom_report_with_http_info(analyze_request, custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.analyze_custom_report ...'
+      end
+      # verify the required parameter 'analyze_request' is set
+      if @api_client.config.client_side_validation && analyze_request.nil?
+        fail ArgumentError, "Missing the required parameter 'analyze_request' when calling DatawarehouseApi.analyze_custom_report"
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.analyze_custom_report"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/analysis'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(analyze_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'CustomReportAnalysisResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#analyze_custom_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete a custom dashboard
     # Delete a custom dashboard on the UltraCart account. 
     # @param custom_dashboard_oid The dashboard oid to delete.
@@ -86,6 +147,66 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Delete a custom dashboard schedule
+    # delete a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid The dashboard schedule oid to delete.
+    # @param custom_dashboard_oid The dashboard oid that owns the schedule.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_custom_dashboard_schedule(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts)
+      nil
+    end
+
+    # Delete a custom dashboard schedule
+    # delete a custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_schedule_oid The dashboard schedule oid to delete.
+    # @param custom_dashboard_oid The dashboard oid that owns the schedule.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_custom_dashboard_schedule_with_http_info(custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.delete_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'custom_dashboard_schedule_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.delete_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', custom_dashboard_schedule_oid.to_s).sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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: DatawarehouseApi#delete_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Delete a custom report
     # Delete a custom report on the UltraCart account. 
     # @param custom_report_oid The report oid to delete.
@@ -476,6 +597,61 @@ module UltracartClient
     end
     # Get custom dashboards
     # Retrieve a custom dashboards 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardSchedulesResponse]
+    def get_custom_dashboard_schedules(custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts)
+      data
+    end
+
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
+    # @param custom_dashboard_oid 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardSchedulesResponse, Fixnum, Hash)>] CustomDashboardSchedulesResponse data, response status code and response headers
+    def get_custom_dashboard_schedules_with_http_info(custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_dashboard_schedules ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.get_custom_dashboard_schedules"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'CustomDashboardSchedulesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_dashboard_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom dashboards
+    # Retrieve a custom dashboards 
     # @param [Hash] opts the optional parameters
     # @return [CustomDashboardsResponse]
     def get_custom_dashboards(opts = {})
@@ -627,6 +803,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Upload a PNG of a custom report chart
+    # Upload a PNG of a custom report chart 
+    # @param custom_report_oid The report oid to upload a chart PNG for.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomReportChartPngUploadResponse]
+    def get_custom_report_chart_png_upload_url(custom_report_oid, opts = {})
+      data, _status_code, _headers = get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts)
+      data
+    end
+
+    # Upload a PNG of a custom report chart
+    # Upload a PNG of a custom report chart 
+    # @param custom_report_oid The report oid to upload a chart PNG for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomReportChartPngUploadResponse, Fixnum, Hash)>] CustomReportChartPngUploadResponse data, response status code and response headers
+    def get_custom_report_chart_png_upload_url_with_http_info(custom_report_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.get_custom_report_chart_png_upload_url ...'
+      end
+      # verify the required parameter 'custom_report_oid' is set
+      if @api_client.config.client_side_validation && custom_report_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_report_oid' when calling DatawarehouseApi.get_custom_report_chart_png_upload_url"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_reports/{custom_report_oid}/chart_png'.sub('{' + 'custom_report_oid' + '}', custom_report_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'CustomReportChartPngUploadResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#get_custom_report_chart_png_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get custom reports
     # Retrieve a custom reports 
     # @param [Hash] opts the optional parameters
@@ -1000,6 +1231,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create a custom dashboard schedule
+    # Create a new custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_oid 
+    # @param dashboard_schedule Dashboard schedule to create
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardScheduleResponse]
+    def insert_custom_dashboard_schedule(custom_dashboard_oid, dashboard_schedule, opts = {})
+      data, _status_code, _headers = insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts)
+      data
+    end
+
+    # Create a custom dashboard schedule
+    # Create a new custom dashboard schedule on the UltraCart account. 
+    # @param custom_dashboard_oid 
+    # @param dashboard_schedule Dashboard schedule to create
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardScheduleResponse, Fixnum, Hash)>] CustomDashboardScheduleResponse data, response status code and response headers
+    def insert_custom_dashboard_schedule_with_http_info(custom_dashboard_oid, dashboard_schedule, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.insert_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'dashboard_schedule' is set
+      if @api_client.config.client_side_validation && dashboard_schedule.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.insert_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules'.sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard_schedule)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'CustomDashboardScheduleResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#insert_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create a custom report
     # Create a new custom report on the UltraCart account. 
     # @param report Report to create
@@ -1171,6 +1463,73 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Update a custom dashboard schedule
+    # Update a custom dashboard schedule on the UltraCart account. 
+    # @param dashboard_schedule Dashboard schedule to update
+    # @param custom_dashboard_schedule_oid The dashboard schedule oid to update.
+    # @param custom_dashboard_oid The dashboard oid to update.
+    # @param [Hash] opts the optional parameters
+    # @return [CustomDashboardResponse]
+    def update_custom_dashboard_schedule(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      data, _status_code, _headers = update_custom_dashboard_schedule_with_http_info(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid, opts)
+      data
+    end
+
+    # Update a custom dashboard schedule
+    # Update a custom dashboard schedule on the UltraCart account. 
+    # @param dashboard_schedule Dashboard schedule to update
+    # @param custom_dashboard_schedule_oid The dashboard schedule oid to update.
+    # @param custom_dashboard_oid The dashboard oid to update.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomDashboardResponse, Fixnum, Hash)>] CustomDashboardResponse data, response status code and response headers
+    def update_custom_dashboard_schedule_with_http_info(dashboard_schedule, custom_dashboard_schedule_oid, custom_dashboard_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DatawarehouseApi.update_custom_dashboard_schedule ...'
+      end
+      # verify the required parameter 'dashboard_schedule' is set
+      if @api_client.config.client_side_validation && dashboard_schedule.nil?
+        fail ArgumentError, "Missing the required parameter 'dashboard_schedule' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'custom_dashboard_schedule_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_schedule_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_schedule_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # verify the required parameter 'custom_dashboard_oid' is set
+      if @api_client.config.client_side_validation && custom_dashboard_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_dashboard_oid' when calling DatawarehouseApi.update_custom_dashboard_schedule"
+      end
+      # resource path
+      local_var_path = '/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}'.sub('{' + 'custom_dashboard_schedule_oid' + '}', custom_dashboard_schedule_oid.to_s).sub('{' + 'custom_dashboard_oid' + '}', custom_dashboard_oid.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(dashboard_schedule)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'CustomDashboardResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DatawarehouseApi#update_custom_dashboard_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a custom report
     # Update a custom report on the UltraCart account. 
     # @param report Report to custom update

data/lib/ultracart_api/api/order_api.rb

@@ -1411,6 +1411,70 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Replaces an order item id
+    # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged.  A custom method requested by a merchant to allow for item id updates due to shipping errors.  It is doubtful you will ever need this method.  The expansion variable affects the returned order object. 
+    # @param replace_order_item_id_request Replacement Request
+    # @param order_id The order id to update.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [OrderResponse]
+    def replace_order_item_merchant_item_id(replace_order_item_id_request, order_id, opts = {})
+      data, _status_code, _headers = replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts)
+      data
+    end
+
+    # Replaces an order item id
+    # Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged.  A custom method requested by a merchant to allow for item id updates due to shipping errors.  It is doubtful you will ever need this method.  The expansion variable affects the returned order object. 
+    # @param replace_order_item_id_request Replacement Request
+    # @param order_id The order id to update.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    def replace_order_item_merchant_item_id_with_http_info(replace_order_item_id_request, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.replace_order_item_merchant_item_id ...'
+      end
+      # verify the required parameter 'replace_order_item_id_request' is set
+      if @api_client.config.client_side_validation && replace_order_item_id_request.nil?
+        fail ArgumentError, "Missing the required parameter 'replace_order_item_id_request' when calling OrderApi.replace_order_item_merchant_item_id"
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.replace_order_item_merchant_item_id"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/replace_item_id'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # 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; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(replace_order_item_id_request)
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      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 => 'OrderResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#replace_order_item_merchant_item_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Replacement order
     # Create a replacement order based upon a previous order 
     # @param order_id The order id to generate a replacement for.