ultracart_api 3.9.6 → 3.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +27 -4
- data/docs/AdjustInternalCertificateRequest.md +13 -0
- data/docs/AdjustInternalCertificateResponse.md +13 -0
- data/docs/CartSettingsShippingEstimate.md +1 -0
- data/docs/ChannelPartnerApi.md +212 -0
- data/docs/ChannelPartnerCancelResponse.md +12 -0
- data/docs/ChannelPartnerEstimateShippingResponse.md +12 -0
- data/docs/ChannelPartnerImportResponse.md +13 -0
- data/docs/ChannelPartnerOrder.md +87 -0
- data/docs/ChannelPartnerOrderItem.md +14 -0
- data/docs/ChannelPartnerOrderItemOption.md +9 -0
- data/docs/ChannelPartnerOrderTransaction.md +9 -0
- data/docs/ChannelPartnerOrderTransactionDetail.md +9 -0
- data/docs/ChannelPartnerShippingEstimate.md +9 -0
- data/docs/CustomerApi.md +54 -0
- data/docs/CustomerLoyalty.md +2 -1
- data/docs/IntegrationLogApi.md +57 -0
- data/docs/OrderApi.md +55 -0
- data/lib/ultracart_api/api/channel_partner_api.rb +256 -0
- data/lib/ultracart_api/api/customer_api.rb +61 -0
- data/lib/ultracart_api/api/integration_log_api.rb +67 -0
- data/lib/ultracart_api/api/order_api.rb +58 -0
- data/lib/ultracart_api/models/adjust_internal_certificate_request.rb +235 -0
- data/lib/ultracart_api/models/adjust_internal_certificate_response.rb +232 -0
- data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +11 -1
- data/lib/ultracart_api/models/channel_partner_cancel_response.rb +224 -0
- data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +224 -0
- data/lib/ultracart_api/models/channel_partner_import_response.rb +236 -0
- data/lib/ultracart_api/models/channel_partner_order.rb +1569 -0
- data/lib/ultracart_api/models/channel_partner_order_item.rb +296 -0
- data/lib/ultracart_api/models/channel_partner_order_item_option.rb +195 -0
- data/lib/ultracart_api/models/channel_partner_order_transaction.rb +197 -0
- data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +195 -0
- data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +195 -0
- data/lib/ultracart_api/models/customer_loyalty.rb +11 -2
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +12 -0
- metadata +26 -2
data/docs/IntegrationLogApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
|
8
8
|
[**get_integration_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
|
9
|
+
[**get_integration_log_file_pdf**](IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
|
9
10
|
[**get_integration_log_summaries_query**](IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
|
10
11
|
[**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
|
11
12
|
|
@@ -119,6 +120,62 @@ Name | Type | Description | Notes
|
|
119
120
|
|
120
121
|
|
121
122
|
|
123
|
+
# **get_integration_log_file_pdf**
|
124
|
+
> File get_integration_log_file_pdf(pk, sk, uuid)
|
125
|
+
|
126
|
+
Retrieve an integration log file converted to PDF
|
127
|
+
|
128
|
+
Retrieve an integration log file from the account based identifiers
|
129
|
+
|
130
|
+
### Example
|
131
|
+
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'ultracart_api'
|
134
|
+
|
135
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
136
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
137
|
+
api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
|
138
|
+
|
139
|
+
|
140
|
+
pk = 'pk_example' # String |
|
141
|
+
|
142
|
+
sk = 'sk_example' # String |
|
143
|
+
|
144
|
+
uuid = 'uuid_example' # String |
|
145
|
+
|
146
|
+
|
147
|
+
begin
|
148
|
+
#Retrieve an integration log file converted to PDF
|
149
|
+
result = api_instance.get_integration_log_file_pdf(pk, sk, uuid)
|
150
|
+
p result
|
151
|
+
rescue UltracartClient::ApiError => e
|
152
|
+
puts "Exception when calling IntegrationLogApi->get_integration_log_file_pdf: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
Name | Type | Description | Notes
|
159
|
+
------------- | ------------- | ------------- | -------------
|
160
|
+
**pk** | **String**| |
|
161
|
+
**sk** | **String**| |
|
162
|
+
**uuid** | **String**| |
|
163
|
+
|
164
|
+
### Return type
|
165
|
+
|
166
|
+
**File**
|
167
|
+
|
168
|
+
### Authorization
|
169
|
+
|
170
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
171
|
+
|
172
|
+
### HTTP request headers
|
173
|
+
|
174
|
+
- **Content-Type**: application/json
|
175
|
+
- **Accept**: application/octet-stream
|
176
|
+
|
177
|
+
|
178
|
+
|
122
179
|
# **get_integration_log_summaries_query**
|
123
180
|
> IntegrationLogSummaryQueryResponse get_integration_log_summaries_query(integration_log_summaries_query)
|
124
181
|
|
data/docs/OrderApi.md
CHANGED
@@ -7,6 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**adjust_order_total**](OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
|
8
8
|
[**cancel_order**](OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
|
9
9
|
[**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
|
10
|
+
[**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
|
10
11
|
[**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
|
11
12
|
[**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
|
12
13
|
[**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
|
@@ -180,6 +181,60 @@ nil (empty response body)
|
|
180
181
|
|
181
182
|
|
182
183
|
|
184
|
+
# **duplicate_order**
|
185
|
+
> OrderResponse duplicate_order(order_id, opts)
|
186
|
+
|
187
|
+
Duplicate an order
|
188
|
+
|
189
|
+
Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
190
|
+
|
191
|
+
### Example
|
192
|
+
```ruby
|
193
|
+
# load the gem
|
194
|
+
require 'ultracart_api'
|
195
|
+
|
196
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
197
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
198
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
199
|
+
|
200
|
+
|
201
|
+
order_id = 'order_id_example' # String | The order id to duplicate.
|
202
|
+
|
203
|
+
opts = {
|
204
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
205
|
+
}
|
206
|
+
|
207
|
+
begin
|
208
|
+
#Duplicate an order
|
209
|
+
result = api_instance.duplicate_order(order_id, opts)
|
210
|
+
p result
|
211
|
+
rescue UltracartClient::ApiError => e
|
212
|
+
puts "Exception when calling OrderApi->duplicate_order: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
Name | Type | Description | Notes
|
219
|
+
------------- | ------------- | ------------- | -------------
|
220
|
+
**order_id** | **String**| The order id to duplicate. |
|
221
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
222
|
+
|
223
|
+
### Return type
|
224
|
+
|
225
|
+
[**OrderResponse**](OrderResponse.md)
|
226
|
+
|
227
|
+
### Authorization
|
228
|
+
|
229
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
230
|
+
|
231
|
+
### HTTP request headers
|
232
|
+
|
233
|
+
- **Content-Type**: application/json; charset=UTF-8
|
234
|
+
- **Accept**: application/json
|
235
|
+
|
236
|
+
|
237
|
+
|
183
238
|
# **format**
|
184
239
|
> OrderFormatResponse format(order_id, format_options)
|
185
240
|
|
@@ -0,0 +1,256 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'addressable/uri'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class ChannelPartnerApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
|
23
|
+
def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
|
24
|
+
api_config = Configuration.new
|
25
|
+
api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
|
26
|
+
api_config.api_version = '2017-03-01'
|
27
|
+
api_config.verify_ssl = verify_ssl
|
28
|
+
|
29
|
+
api_client = ApiClient.new(api_config)
|
30
|
+
api_client.config.debugging = debugging
|
31
|
+
|
32
|
+
UltracartClient::ChannelPartnerApi.new(api_client)
|
33
|
+
end
|
34
|
+
|
35
|
+
# Cancel channel partner order by channel partner order id
|
36
|
+
# Cancel channel partner order by channel partner order id
|
37
|
+
# @param order_id The channel partner order id to delete.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [ChannelPartnerCancelResponse]
|
40
|
+
def cancel_order_by_channel_partner_order_id(order_id, opts = {})
|
41
|
+
data, _status_code, _headers = cancel_order_by_channel_partner_order_id_with_http_info(order_id, opts)
|
42
|
+
data
|
43
|
+
end
|
44
|
+
|
45
|
+
# Cancel channel partner order by channel partner order id
|
46
|
+
# Cancel channel partner order by channel partner order id
|
47
|
+
# @param order_id The channel partner order id to delete.
|
48
|
+
# @param [Hash] opts the optional parameters
|
49
|
+
# @return [Array<(ChannelPartnerCancelResponse, Fixnum, Hash)>] ChannelPartnerCancelResponse data, response status code and response headers
|
50
|
+
def cancel_order_by_channel_partner_order_id_with_http_info(order_id, opts = {})
|
51
|
+
if @api_client.config.debugging
|
52
|
+
@api_client.config.logger.debug 'Calling API: ChannelPartnerApi.cancel_order_by_channel_partner_order_id ...'
|
53
|
+
end
|
54
|
+
# verify the required parameter 'order_id' is set
|
55
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
56
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.cancel_order_by_channel_partner_order_id"
|
57
|
+
end
|
58
|
+
# resource path
|
59
|
+
local_var_path = '/channel_partner/cancel/by_channel_partner_order_id/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
|
60
|
+
|
61
|
+
# query parameters
|
62
|
+
query_params = {}
|
63
|
+
|
64
|
+
# header parameters
|
65
|
+
header_params = {}
|
66
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
67
|
+
# HTTP header 'Accept' (if needed)
|
68
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
69
|
+
# HTTP header 'Content-Type'
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
78
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
79
|
+
:header_params => header_params,
|
80
|
+
:query_params => query_params,
|
81
|
+
:form_params => form_params,
|
82
|
+
:body => post_body,
|
83
|
+
:auth_names => auth_names,
|
84
|
+
:return_type => 'ChannelPartnerCancelResponse')
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: ChannelPartnerApi#cancel_order_by_channel_partner_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
# Cancel channel partner order by UltraCart order id
|
91
|
+
# Cancel channel partner order by UltraCart order id
|
92
|
+
# @param order_id The UltraCart order id to delete.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [ChannelPartnerCancelResponse]
|
95
|
+
def cancel_order_by_channel_ultra_cart_order_id(order_id, opts = {})
|
96
|
+
data, _status_code, _headers = cancel_order_by_channel_ultra_cart_order_id_with_http_info(order_id, opts)
|
97
|
+
data
|
98
|
+
end
|
99
|
+
|
100
|
+
# Cancel channel partner order by UltraCart order id
|
101
|
+
# Cancel channel partner order by UltraCart order id
|
102
|
+
# @param order_id The UltraCart order id to delete.
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(ChannelPartnerCancelResponse, Fixnum, Hash)>] ChannelPartnerCancelResponse data, response status code and response headers
|
105
|
+
def cancel_order_by_channel_ultra_cart_order_id_with_http_info(order_id, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: ChannelPartnerApi.cancel_order_by_channel_ultra_cart_order_id ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'order_id' is set
|
110
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling ChannelPartnerApi.cancel_order_by_channel_ultra_cart_order_id"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/channel_partner/cancel/by_ultracart_order_id/{order_id}'.sub('{' + 'order_id' + '}', order_id.to_s)
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = {}
|
121
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
122
|
+
# HTTP header 'Accept' (if needed)
|
123
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
124
|
+
# HTTP header 'Content-Type'
|
125
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
126
|
+
|
127
|
+
# form parameters
|
128
|
+
form_params = {}
|
129
|
+
|
130
|
+
# http body (model)
|
131
|
+
post_body = nil
|
132
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
133
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
134
|
+
:header_params => header_params,
|
135
|
+
:query_params => query_params,
|
136
|
+
:form_params => form_params,
|
137
|
+
:body => post_body,
|
138
|
+
:auth_names => auth_names,
|
139
|
+
:return_type => 'ChannelPartnerCancelResponse')
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: ChannelPartnerApi#cancel_order_by_channel_ultra_cart_order_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
# Estimate shipping for channel partner order
|
146
|
+
# Estimate shipping for order from a channel partner.
|
147
|
+
# @param channel_partner_order Order needing shipping estimate
|
148
|
+
# @param [Hash] opts the optional parameters
|
149
|
+
# @return [ChannelPartnerEstimateShippingResponse]
|
150
|
+
def estimate_shipping_for_channel_partner_order(channel_partner_order, opts = {})
|
151
|
+
data, _status_code, _headers = estimate_shipping_for_channel_partner_order_with_http_info(channel_partner_order, opts)
|
152
|
+
data
|
153
|
+
end
|
154
|
+
|
155
|
+
# Estimate shipping for channel partner order
|
156
|
+
# Estimate shipping for order from a channel partner.
|
157
|
+
# @param channel_partner_order Order needing shipping estimate
|
158
|
+
# @param [Hash] opts the optional parameters
|
159
|
+
# @return [Array<(ChannelPartnerEstimateShippingResponse, Fixnum, Hash)>] ChannelPartnerEstimateShippingResponse data, response status code and response headers
|
160
|
+
def estimate_shipping_for_channel_partner_order_with_http_info(channel_partner_order, opts = {})
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug 'Calling API: ChannelPartnerApi.estimate_shipping_for_channel_partner_order ...'
|
163
|
+
end
|
164
|
+
# verify the required parameter 'channel_partner_order' is set
|
165
|
+
if @api_client.config.client_side_validation && channel_partner_order.nil?
|
166
|
+
fail ArgumentError, "Missing the required parameter 'channel_partner_order' when calling ChannelPartnerApi.estimate_shipping_for_channel_partner_order"
|
167
|
+
end
|
168
|
+
# resource path
|
169
|
+
local_var_path = '/channel_partner/estimate_shipping'
|
170
|
+
|
171
|
+
# query parameters
|
172
|
+
query_params = {}
|
173
|
+
|
174
|
+
# header parameters
|
175
|
+
header_params = {}
|
176
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
177
|
+
# HTTP header 'Accept' (if needed)
|
178
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
179
|
+
# HTTP header 'Content-Type'
|
180
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
181
|
+
|
182
|
+
# form parameters
|
183
|
+
form_params = {}
|
184
|
+
|
185
|
+
# http body (model)
|
186
|
+
post_body = @api_client.object_to_http_body(channel_partner_order)
|
187
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
188
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
189
|
+
:header_params => header_params,
|
190
|
+
:query_params => query_params,
|
191
|
+
:form_params => form_params,
|
192
|
+
:body => post_body,
|
193
|
+
:auth_names => auth_names,
|
194
|
+
:return_type => 'ChannelPartnerEstimateShippingResponse')
|
195
|
+
if @api_client.config.debugging
|
196
|
+
@api_client.config.logger.debug "API called: ChannelPartnerApi#estimate_shipping_for_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
197
|
+
end
|
198
|
+
return data, status_code, headers
|
199
|
+
end
|
200
|
+
# Insert channel partner order
|
201
|
+
# Insert order from a channel partner.
|
202
|
+
# @param channel_partner_order Order to insert
|
203
|
+
# @param [Hash] opts the optional parameters
|
204
|
+
# @return [ChannelPartnerImportResponse]
|
205
|
+
def import_channel_partner_order(channel_partner_order, opts = {})
|
206
|
+
data, _status_code, _headers = import_channel_partner_order_with_http_info(channel_partner_order, opts)
|
207
|
+
data
|
208
|
+
end
|
209
|
+
|
210
|
+
# Insert channel partner order
|
211
|
+
# Insert order from a channel partner.
|
212
|
+
# @param channel_partner_order Order to insert
|
213
|
+
# @param [Hash] opts the optional parameters
|
214
|
+
# @return [Array<(ChannelPartnerImportResponse, Fixnum, Hash)>] ChannelPartnerImportResponse data, response status code and response headers
|
215
|
+
def import_channel_partner_order_with_http_info(channel_partner_order, opts = {})
|
216
|
+
if @api_client.config.debugging
|
217
|
+
@api_client.config.logger.debug 'Calling API: ChannelPartnerApi.import_channel_partner_order ...'
|
218
|
+
end
|
219
|
+
# verify the required parameter 'channel_partner_order' is set
|
220
|
+
if @api_client.config.client_side_validation && channel_partner_order.nil?
|
221
|
+
fail ArgumentError, "Missing the required parameter 'channel_partner_order' when calling ChannelPartnerApi.import_channel_partner_order"
|
222
|
+
end
|
223
|
+
# resource path
|
224
|
+
local_var_path = '/channel_partner/import'
|
225
|
+
|
226
|
+
# query parameters
|
227
|
+
query_params = {}
|
228
|
+
|
229
|
+
# header parameters
|
230
|
+
header_params = {}
|
231
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
232
|
+
# HTTP header 'Accept' (if needed)
|
233
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
234
|
+
# HTTP header 'Content-Type'
|
235
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
236
|
+
|
237
|
+
# form parameters
|
238
|
+
form_params = {}
|
239
|
+
|
240
|
+
# http body (model)
|
241
|
+
post_body = @api_client.object_to_http_body(channel_partner_order)
|
242
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
243
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
244
|
+
:header_params => header_params,
|
245
|
+
:query_params => query_params,
|
246
|
+
:form_params => form_params,
|
247
|
+
:body => post_body,
|
248
|
+
:auth_names => auth_names,
|
249
|
+
:return_type => 'ChannelPartnerImportResponse')
|
250
|
+
if @api_client.config.debugging
|
251
|
+
@api_client.config.logger.debug "API called: ChannelPartnerApi#import_channel_partner_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
252
|
+
end
|
253
|
+
return data, status_code, headers
|
254
|
+
end
|
255
|
+
end
|
256
|
+
end
|
@@ -32,6 +32,67 @@ module UltracartClient
|
|
32
32
|
UltracartClient::CustomerApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
36
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
37
|
+
# @param customer_profile_oid The customer profile oid
|
38
|
+
# @param adjust_internal_certificate_request adjustInternalCertificateRequest
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [AdjustInternalCertificateResponse]
|
41
|
+
def adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request, opts = {})
|
42
|
+
data, _status_code, _headers = adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts)
|
43
|
+
data
|
44
|
+
end
|
45
|
+
|
46
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
47
|
+
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
48
|
+
# @param customer_profile_oid The customer profile oid
|
49
|
+
# @param adjust_internal_certificate_request adjustInternalCertificateRequest
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @return [Array<(AdjustInternalCertificateResponse, Fixnum, Hash)>] AdjustInternalCertificateResponse data, response status code and response headers
|
52
|
+
def adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts = {})
|
53
|
+
if @api_client.config.debugging
|
54
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.adjust_internal_certificate ...'
|
55
|
+
end
|
56
|
+
# verify the required parameter 'customer_profile_oid' is set
|
57
|
+
if @api_client.config.client_side_validation && customer_profile_oid.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.adjust_internal_certificate"
|
59
|
+
end
|
60
|
+
# verify the required parameter 'adjust_internal_certificate_request' is set
|
61
|
+
if @api_client.config.client_side_validation && adjust_internal_certificate_request.nil?
|
62
|
+
fail ArgumentError, "Missing the required parameter 'adjust_internal_certificate_request' when calling CustomerApi.adjust_internal_certificate"
|
63
|
+
end
|
64
|
+
# resource path
|
65
|
+
local_var_path = '/customer/customers/{customer_profile_oid}/adjust_cashback_balance'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
|
66
|
+
|
67
|
+
# query parameters
|
68
|
+
query_params = {}
|
69
|
+
|
70
|
+
# header parameters
|
71
|
+
header_params = {}
|
72
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
73
|
+
# HTTP header 'Accept' (if needed)
|
74
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
75
|
+
# HTTP header 'Content-Type'
|
76
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
77
|
+
|
78
|
+
# form parameters
|
79
|
+
form_params = {}
|
80
|
+
|
81
|
+
# http body (model)
|
82
|
+
post_body = @api_client.object_to_http_body(adjust_internal_certificate_request)
|
83
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
84
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names,
|
90
|
+
:return_type => 'AdjustInternalCertificateResponse')
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug "API called: CustomerApi#adjust_internal_certificate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
|
+
end
|
94
|
+
return data, status_code, headers
|
95
|
+
end
|
35
96
|
# Delete a customer
|
36
97
|
# Delete a customer on the UltraCart account.
|
37
98
|
# @param customer_profile_oid The customer_profile_oid to delete.
|
@@ -160,6 +160,73 @@ module UltracartClient
|
|
160
160
|
end
|
161
161
|
return data, status_code, headers
|
162
162
|
end
|
163
|
+
# Retrieve an integration log file converted to PDF
|
164
|
+
# Retrieve an integration log file from the account based identifiers
|
165
|
+
# @param pk
|
166
|
+
# @param sk
|
167
|
+
# @param uuid
|
168
|
+
# @param [Hash] opts the optional parameters
|
169
|
+
# @return [File]
|
170
|
+
def get_integration_log_file_pdf(pk, sk, uuid, opts = {})
|
171
|
+
data, _status_code, _headers = get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts)
|
172
|
+
data
|
173
|
+
end
|
174
|
+
|
175
|
+
# Retrieve an integration log file converted to PDF
|
176
|
+
# Retrieve an integration log file from the account based identifiers
|
177
|
+
# @param pk
|
178
|
+
# @param sk
|
179
|
+
# @param uuid
|
180
|
+
# @param [Hash] opts the optional parameters
|
181
|
+
# @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
|
182
|
+
def get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts = {})
|
183
|
+
if @api_client.config.debugging
|
184
|
+
@api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file_pdf ...'
|
185
|
+
end
|
186
|
+
# verify the required parameter 'pk' is set
|
187
|
+
if @api_client.config.client_side_validation && pk.nil?
|
188
|
+
fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file_pdf"
|
189
|
+
end
|
190
|
+
# verify the required parameter 'sk' is set
|
191
|
+
if @api_client.config.client_side_validation && sk.nil?
|
192
|
+
fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file_pdf"
|
193
|
+
end
|
194
|
+
# verify the required parameter 'uuid' is set
|
195
|
+
if @api_client.config.client_side_validation && uuid.nil?
|
196
|
+
fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file_pdf"
|
197
|
+
end
|
198
|
+
# resource path
|
199
|
+
local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}/pdf'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s).sub('{' + 'uuid' + '}', uuid.to_s)
|
200
|
+
|
201
|
+
# query parameters
|
202
|
+
query_params = {}
|
203
|
+
|
204
|
+
# header parameters
|
205
|
+
header_params = {}
|
206
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
207
|
+
# HTTP header 'Accept' (if needed)
|
208
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
|
209
|
+
# HTTP header 'Content-Type'
|
210
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
211
|
+
|
212
|
+
# form parameters
|
213
|
+
form_params = {}
|
214
|
+
|
215
|
+
# http body (model)
|
216
|
+
post_body = nil
|
217
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
218
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
219
|
+
:header_params => header_params,
|
220
|
+
:query_params => query_params,
|
221
|
+
:form_params => form_params,
|
222
|
+
:body => post_body,
|
223
|
+
:auth_names => auth_names,
|
224
|
+
:return_type => 'File')
|
225
|
+
if @api_client.config.debugging
|
226
|
+
@api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
227
|
+
end
|
228
|
+
return data, status_code, headers
|
229
|
+
end
|
163
230
|
# Retrieve integration log summaries
|
164
231
|
# Retrieves a set of integration log summaries from the account based on a query object.
|
165
232
|
# @param integration_log_summaries_query Integration log summaries query
|
@@ -202,6 +202,64 @@ module UltracartClient
|
|
202
202
|
end
|
203
203
|
return data, status_code, headers
|
204
204
|
end
|
205
|
+
# Duplicate an order
|
206
|
+
# Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
207
|
+
# @param order_id The order id to duplicate.
|
208
|
+
# @param [Hash] opts the optional parameters
|
209
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
210
|
+
# @return [OrderResponse]
|
211
|
+
def duplicate_order(order_id, opts = {})
|
212
|
+
data, _status_code, _headers = duplicate_order_with_http_info(order_id, opts)
|
213
|
+
data
|
214
|
+
end
|
215
|
+
|
216
|
+
# Duplicate an order
|
217
|
+
# Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
|
218
|
+
# @param order_id The order id to duplicate.
|
219
|
+
# @param [Hash] opts the optional parameters
|
220
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
221
|
+
# @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
|
222
|
+
def duplicate_order_with_http_info(order_id, opts = {})
|
223
|
+
if @api_client.config.debugging
|
224
|
+
@api_client.config.logger.debug 'Calling API: OrderApi.duplicate_order ...'
|
225
|
+
end
|
226
|
+
# verify the required parameter 'order_id' is set
|
227
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
228
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.duplicate_order"
|
229
|
+
end
|
230
|
+
# resource path
|
231
|
+
local_var_path = '/order/orders/{order_id}/duplicate'.sub('{' + 'order_id' + '}', order_id.to_s)
|
232
|
+
|
233
|
+
# query parameters
|
234
|
+
query_params = {}
|
235
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
236
|
+
|
237
|
+
# header parameters
|
238
|
+
header_params = {}
|
239
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
240
|
+
# HTTP header 'Accept' (if needed)
|
241
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
242
|
+
# HTTP header 'Content-Type'
|
243
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
244
|
+
|
245
|
+
# form parameters
|
246
|
+
form_params = {}
|
247
|
+
|
248
|
+
# http body (model)
|
249
|
+
post_body = nil
|
250
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
251
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
252
|
+
:header_params => header_params,
|
253
|
+
:query_params => query_params,
|
254
|
+
:form_params => form_params,
|
255
|
+
:body => post_body,
|
256
|
+
:auth_names => auth_names,
|
257
|
+
:return_type => 'OrderResponse')
|
258
|
+
if @api_client.config.debugging
|
259
|
+
@api_client.config.logger.debug "API called: OrderApi#duplicate_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
260
|
+
end
|
261
|
+
return data, status_code, headers
|
262
|
+
end
|
205
263
|
# Format order
|
206
264
|
# Format the order for display at text or html
|
207
265
|
# @param order_id The order id to format
|