ultracart_api 3.9.7 → 3.9.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/docs/OrderApi.md +55 -0
- data/lib/ultracart_api/api/order_api.rb +58 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bc550dfae2f16031ee4c8f7d560de4df0ab718b6dc96a2699b32801ccf8c3be1
|
4
|
+
data.tar.gz: cbe4241585f35825355c41ff0051f11274b4c9ce4d4fd9e1cea207717a32ab0c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2f9c11b33d19ad23f31053a94d655cf6f5bb35e85dfdcbf04f6e573890d6b49abd6dd2d89bc73d0cfb1f52ad029e64ac38c3dff2da8e8dee4c295ef3e747da07
|
7
|
+
data.tar.gz: 287841e47268091226f675ff169e86cacc8e9ecda174158534b3dc0a2c21797a4623f613875d5d00a7343fb06815a8ed6a8edf1448c2ca34960fb344b6f65828
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.9.
|
10
|
+
- Package version: 3.9.8
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.9.
|
27
|
+
gem install ./ultracart_api-3.9.8.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.9.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.9.8.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.9.
|
35
|
+
gem 'ultracart_api', '~> 3.9.8'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -201,6 +201,7 @@ Class | Method | HTTP request | Description
|
|
201
201
|
*UltracartClient::OrderApi* | [**adjust_order_total**](docs/OrderApi.md#adjust_order_total) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
|
202
202
|
*UltracartClient::OrderApi* | [**cancel_order**](docs/OrderApi.md#cancel_order) | **POST** /order/orders/{order_id}/cancel | Cancel an order
|
203
203
|
*UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
|
204
|
+
*UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
|
204
205
|
*UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
|
205
206
|
*UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
|
206
207
|
*UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/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.
|
@@ -1155,6 +1156,7 @@ Not every change is committed to every SDK.
|
|
1155
1156
|
|
1156
1157
|
| Version | Date | Comments |
|
1157
1158
|
| --: | :-: | --- |
|
1159
|
+
| 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
|
1158
1160
|
| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
|
1159
1161
|
| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
|
1160
1162
|
| 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
|
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
|
|
@@ -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
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.9.
|
4
|
+
version: 3.9.8
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-04-
|
11
|
+
date: 2022-04-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|