ultracart_api 3.10.2 → 3.10.3
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 +6 -4
- data/docs/ChannelPartnerApi.md +2 -2
- data/docs/OrderApi.md +4 -4
- data/docs/OrderFormat.md +1 -1
- data/docs/OrderItem.md +1 -0
- data/docs/OrderPackingSlipResponse.md +12 -0
- data/lib/ultracart_api/api/channel_partner_api.rb +2 -2
- data/lib/ultracart_api/api/order_api.rb +6 -6
- data/lib/ultracart_api/models/order_format.rb +7 -7
- data/lib/ultracart_api/models/order_item.rb +11 -1
- data/lib/ultracart_api/models/order_packing_slip_response.rb +222 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d01bf76cc706d4a7de2aa0b66631f71c44ca6857994dd76b1931b4cfcc08676
|
|
4
|
+
data.tar.gz: d3bc36852795a167568deffc6f66744caf069f0b723bacf3ea101a2fd066c35f
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ba49c68c3c0c30d66dd83bf0653298eb4b89c57b7c5607c8adbbf85f149e3fca68a16a1c6f40b9139ccb16ba6cf5d3e610b196e4a65d0eb60856971d27f3c3a4
|
|
7
|
+
data.tar.gz: a377dc7cd3586569f539270bb5e3821e902b82c91508332eb84dd38a10cd36df49409ad9bbab58e3459f8a400e6dbb8bcee18d580e50afbb165394981aefc25c
|
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.10.
|
|
10
|
+
- Package version: 3.10.3
|
|
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.10.
|
|
27
|
+
gem install ./ultracart_api-3.10.3.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.3.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.10.
|
|
35
|
+
gem 'ultracart_api', '~> 3.10.3'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -916,6 +916,7 @@ Class | Method | HTTP request | Description
|
|
|
916
916
|
- [UltracartClient::OrderItemTag](docs/OrderItemTag.md)
|
|
917
917
|
- [UltracartClient::OrderLinkedShipment](docs/OrderLinkedShipment.md)
|
|
918
918
|
- [UltracartClient::OrderMarketing](docs/OrderMarketing.md)
|
|
919
|
+
- [UltracartClient::OrderPackingSlipResponse](docs/OrderPackingSlipResponse.md)
|
|
919
920
|
- [UltracartClient::OrderPayment](docs/OrderPayment.md)
|
|
920
921
|
- [UltracartClient::OrderPaymentCheck](docs/OrderPaymentCheck.md)
|
|
921
922
|
- [UltracartClient::OrderPaymentCreditCard](docs/OrderPaymentCreditCard.md)
|
|
@@ -1171,6 +1172,7 @@ Not every change is committed to every SDK.
|
|
|
1171
1172
|
|
|
1172
1173
|
| Version | Date | Comments |
|
|
1173
1174
|
| --: | :-: | --- |
|
|
1175
|
+
| 3.10.3 | 05/20/2022 | OrderApi.generatePackingSkip calls had wrong return type |
|
|
1174
1176
|
| 3.10.2 | 05/12/2022 | ChannelPartnerApi renamed one of the delete methods |
|
|
1175
1177
|
| 3.10.1 | 05/12/2022 | ChannelPartnerApi added orderId to import response obj |
|
|
1176
1178
|
| 3.10.0 | 05/10/2022 | beta release of ChannelPartnerApi |
|
data/docs/ChannelPartnerApi.md
CHANGED
|
@@ -55,7 +55,7 @@ Name | Type | Description | Notes
|
|
|
55
55
|
|
|
56
56
|
### HTTP request headers
|
|
57
57
|
|
|
58
|
-
- **Content-Type**: application/json
|
|
58
|
+
- **Content-Type**: application/json
|
|
59
59
|
- **Accept**: application/json
|
|
60
60
|
|
|
61
61
|
|
|
@@ -105,7 +105,7 @@ Name | Type | Description | Notes
|
|
|
105
105
|
|
|
106
106
|
### HTTP request headers
|
|
107
107
|
|
|
108
|
-
- **Content-Type**: application/json
|
|
108
|
+
- **Content-Type**: application/json
|
|
109
109
|
- **Accept**: application/json
|
|
110
110
|
|
|
111
111
|
|
data/docs/OrderApi.md
CHANGED
|
@@ -339,7 +339,7 @@ Name | Type | Description | Notes
|
|
|
339
339
|
|
|
340
340
|
|
|
341
341
|
# **generate_packing_slip_all_dc**
|
|
342
|
-
>
|
|
342
|
+
> OrderPackingSlipResponse generate_packing_slip_all_dc(order_id)
|
|
343
343
|
|
|
344
344
|
Generate a packing slip for this order across all distribution centers.
|
|
345
345
|
|
|
@@ -375,7 +375,7 @@ Name | Type | Description | Notes
|
|
|
375
375
|
|
|
376
376
|
### Return type
|
|
377
377
|
|
|
378
|
-
[**
|
|
378
|
+
[**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
|
|
379
379
|
|
|
380
380
|
### Authorization
|
|
381
381
|
|
|
@@ -389,7 +389,7 @@ Name | Type | Description | Notes
|
|
|
389
389
|
|
|
390
390
|
|
|
391
391
|
# **generate_packing_slip_specific_dc**
|
|
392
|
-
>
|
|
392
|
+
> OrderPackingSlipResponse generate_packing_slip_specific_dc(distribution_center_code, order_id)
|
|
393
393
|
|
|
394
394
|
Generate a packing slip for this order for the given distribution center.
|
|
395
395
|
|
|
@@ -428,7 +428,7 @@ Name | Type | Description | Notes
|
|
|
428
428
|
|
|
429
429
|
### Return type
|
|
430
430
|
|
|
431
|
-
[**
|
|
431
|
+
[**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
|
|
432
432
|
|
|
433
433
|
### Authorization
|
|
434
434
|
|
data/docs/OrderFormat.md
CHANGED
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**dont_link_email_to_search** | **BOOLEAN** | True to not link the email address to the order search | [optional]
|
|
8
8
|
**email_as_link** | **BOOLEAN** | True to make the email address a clickable mailto link | [optional]
|
|
9
9
|
**filter_distribution_center_oid** | **Integer** | Specify a distribution center oid to filter the items displayed to that particular distribution center. | [optional]
|
|
10
|
-
**
|
|
10
|
+
**filter_to_items_in_container_oid** | **Integer** | The container oid to filter items to. | [optional]
|
|
11
11
|
**format** | **String** | The desired format. | [optional]
|
|
12
12
|
**hide_bill_to_address** | **BOOLEAN** | True to ide the bill to address | [optional]
|
|
13
13
|
**hide_price_information** | **BOOLEAN** | True to hide price information | [optional]
|
data/docs/OrderItem.md
CHANGED
|
@@ -46,6 +46,7 @@ Name | Type | Description | Notes
|
|
|
46
46
|
**ship_separately** | **BOOLEAN** | True if this item ships in a separate box | [optional]
|
|
47
47
|
**shipped_by_user** | **String** | Shipped by user | [optional]
|
|
48
48
|
**shipped_dts** | **String** | Date/time that this item was marked shipped | [optional]
|
|
49
|
+
**shipping_status** | **String** | Shipping status for this item. This is the replacement for the old order level shipping status. | [optional]
|
|
49
50
|
**special_product_type** | **String** | Special product type (USPS Media Mail) | [optional]
|
|
50
51
|
**tags** | [**Array<OrderItemTag>**](OrderItemTag.md) | Tags | [optional]
|
|
51
52
|
**tax_free** | **BOOLEAN** | True if the item is tax free | [optional]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::OrderPackingSlipResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
8
|
+
**pdf_base64** | **String** | pdf_base64 | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -67,7 +67,7 @@ module UltracartClient
|
|
|
67
67
|
# HTTP header 'Accept' (if needed)
|
|
68
68
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
69
69
|
# HTTP header 'Content-Type'
|
|
70
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json
|
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
71
71
|
|
|
72
72
|
# form parameters
|
|
73
73
|
form_params = {}
|
|
@@ -122,7 +122,7 @@ module UltracartClient
|
|
|
122
122
|
# HTTP header 'Accept' (if needed)
|
|
123
123
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
124
124
|
# HTTP header 'Content-Type'
|
|
125
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json
|
|
125
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
126
126
|
|
|
127
127
|
# form parameters
|
|
128
128
|
form_params = {}
|
|
@@ -380,7 +380,7 @@ module UltracartClient
|
|
|
380
380
|
# The packing slip PDF that is returned is base 64 encoded
|
|
381
381
|
# @param order_id Order ID
|
|
382
382
|
# @param [Hash] opts the optional parameters
|
|
383
|
-
# @return [
|
|
383
|
+
# @return [OrderPackingSlipResponse]
|
|
384
384
|
def generate_packing_slip_all_dc(order_id, opts = {})
|
|
385
385
|
data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
|
|
386
386
|
data
|
|
@@ -390,7 +390,7 @@ module UltracartClient
|
|
|
390
390
|
# The packing slip PDF that is returned is base 64 encoded
|
|
391
391
|
# @param order_id Order ID
|
|
392
392
|
# @param [Hash] opts the optional parameters
|
|
393
|
-
# @return [Array<(
|
|
393
|
+
# @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
|
|
394
394
|
def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
|
|
395
395
|
if @api_client.config.debugging
|
|
396
396
|
@api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
|
|
@@ -425,7 +425,7 @@ module UltracartClient
|
|
|
425
425
|
:form_params => form_params,
|
|
426
426
|
:body => post_body,
|
|
427
427
|
:auth_names => auth_names,
|
|
428
|
-
:return_type => '
|
|
428
|
+
:return_type => 'OrderPackingSlipResponse')
|
|
429
429
|
if @api_client.config.debugging
|
|
430
430
|
@api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
431
431
|
end
|
|
@@ -436,7 +436,7 @@ module UltracartClient
|
|
|
436
436
|
# @param distribution_center_code Distribution center code
|
|
437
437
|
# @param order_id Order ID
|
|
438
438
|
# @param [Hash] opts the optional parameters
|
|
439
|
-
# @return [
|
|
439
|
+
# @return [OrderPackingSlipResponse]
|
|
440
440
|
def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
|
|
441
441
|
data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
|
|
442
442
|
data
|
|
@@ -447,7 +447,7 @@ module UltracartClient
|
|
|
447
447
|
# @param distribution_center_code Distribution center code
|
|
448
448
|
# @param order_id Order ID
|
|
449
449
|
# @param [Hash] opts the optional parameters
|
|
450
|
-
# @return [Array<(
|
|
450
|
+
# @return [Array<(OrderPackingSlipResponse, Fixnum, Hash)>] OrderPackingSlipResponse data, response status code and response headers
|
|
451
451
|
def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
|
|
452
452
|
if @api_client.config.debugging
|
|
453
453
|
@api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
|
|
@@ -486,7 +486,7 @@ module UltracartClient
|
|
|
486
486
|
:form_params => form_params,
|
|
487
487
|
:body => post_body,
|
|
488
488
|
:auth_names => auth_names,
|
|
489
|
-
:return_type => '
|
|
489
|
+
:return_type => 'OrderPackingSlipResponse')
|
|
490
490
|
if @api_client.config.debugging
|
|
491
491
|
@api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
492
492
|
end
|
|
@@ -27,7 +27,7 @@ module UltracartClient
|
|
|
27
27
|
attr_accessor :filter_distribution_center_oid
|
|
28
28
|
|
|
29
29
|
# The container oid to filter items to.
|
|
30
|
-
attr_accessor :
|
|
30
|
+
attr_accessor :filter_to_items_in_container_oid
|
|
31
31
|
|
|
32
32
|
# The desired format.
|
|
33
33
|
attr_accessor :format
|
|
@@ -91,7 +91,7 @@ module UltracartClient
|
|
|
91
91
|
:'dont_link_email_to_search' => :'dont_link_email_to_search',
|
|
92
92
|
:'email_as_link' => :'email_as_link',
|
|
93
93
|
:'filter_distribution_center_oid' => :'filter_distribution_center_oid',
|
|
94
|
-
:'
|
|
94
|
+
:'filter_to_items_in_container_oid' => :'filter_to_items_in_container_oid',
|
|
95
95
|
:'format' => :'format',
|
|
96
96
|
:'hide_bill_to_address' => :'hide_bill_to_address',
|
|
97
97
|
:'hide_price_information' => :'hide_price_information',
|
|
@@ -113,7 +113,7 @@ module UltracartClient
|
|
|
113
113
|
:'dont_link_email_to_search' => :'BOOLEAN',
|
|
114
114
|
:'email_as_link' => :'BOOLEAN',
|
|
115
115
|
:'filter_distribution_center_oid' => :'Integer',
|
|
116
|
-
:'
|
|
116
|
+
:'filter_to_items_in_container_oid' => :'Integer',
|
|
117
117
|
:'format' => :'String',
|
|
118
118
|
:'hide_bill_to_address' => :'BOOLEAN',
|
|
119
119
|
:'hide_price_information' => :'BOOLEAN',
|
|
@@ -152,8 +152,8 @@ module UltracartClient
|
|
|
152
152
|
self.filter_distribution_center_oid = attributes[:'filter_distribution_center_oid']
|
|
153
153
|
end
|
|
154
154
|
|
|
155
|
-
if attributes.has_key?(:'
|
|
156
|
-
self.
|
|
155
|
+
if attributes.has_key?(:'filter_to_items_in_container_oid')
|
|
156
|
+
self.filter_to_items_in_container_oid = attributes[:'filter_to_items_in_container_oid']
|
|
157
157
|
end
|
|
158
158
|
|
|
159
159
|
if attributes.has_key?(:'format')
|
|
@@ -235,7 +235,7 @@ module UltracartClient
|
|
|
235
235
|
dont_link_email_to_search == o.dont_link_email_to_search &&
|
|
236
236
|
email_as_link == o.email_as_link &&
|
|
237
237
|
filter_distribution_center_oid == o.filter_distribution_center_oid &&
|
|
238
|
-
|
|
238
|
+
filter_to_items_in_container_oid == o.filter_to_items_in_container_oid &&
|
|
239
239
|
format == o.format &&
|
|
240
240
|
hide_bill_to_address == o.hide_bill_to_address &&
|
|
241
241
|
hide_price_information == o.hide_price_information &&
|
|
@@ -258,7 +258,7 @@ module UltracartClient
|
|
|
258
258
|
# Calculates hash code according to all attributes.
|
|
259
259
|
# @return [Fixnum] Hash code
|
|
260
260
|
def hash
|
|
261
|
-
[context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid,
|
|
261
|
+
[context, dont_link_email_to_search, email_as_link, filter_distribution_center_oid, filter_to_items_in_container_oid, format, hide_bill_to_address, hide_price_information, link_file_attachments, show_contact_info, show_in_merchant_currency, show_internal_information, show_merchant_notes, show_non_sensitive_payment_info, show_payment_info, translate].hash
|
|
262
262
|
end
|
|
263
263
|
|
|
264
264
|
# Builds the object from hash
|
|
@@ -136,6 +136,9 @@ module UltracartClient
|
|
|
136
136
|
# Date/time that this item was marked shipped
|
|
137
137
|
attr_accessor :shipped_dts
|
|
138
138
|
|
|
139
|
+
# Shipping status for this item. This is the replacement for the old order level shipping status.
|
|
140
|
+
attr_accessor :shipping_status
|
|
141
|
+
|
|
139
142
|
# Special product type (USPS Media Mail)
|
|
140
143
|
attr_accessor :special_product_type
|
|
141
144
|
|
|
@@ -234,6 +237,7 @@ module UltracartClient
|
|
|
234
237
|
:'ship_separately' => :'ship_separately',
|
|
235
238
|
:'shipped_by_user' => :'shipped_by_user',
|
|
236
239
|
:'shipped_dts' => :'shipped_dts',
|
|
240
|
+
:'shipping_status' => :'shipping_status',
|
|
237
241
|
:'special_product_type' => :'special_product_type',
|
|
238
242
|
:'tags' => :'tags',
|
|
239
243
|
:'tax_free' => :'tax_free',
|
|
@@ -295,6 +299,7 @@ module UltracartClient
|
|
|
295
299
|
:'ship_separately' => :'BOOLEAN',
|
|
296
300
|
:'shipped_by_user' => :'String',
|
|
297
301
|
:'shipped_dts' => :'String',
|
|
302
|
+
:'shipping_status' => :'String',
|
|
298
303
|
:'special_product_type' => :'String',
|
|
299
304
|
:'tags' => :'Array<OrderItemTag>',
|
|
300
305
|
:'tax_free' => :'BOOLEAN',
|
|
@@ -496,6 +501,10 @@ module UltracartClient
|
|
|
496
501
|
self.shipped_dts = attributes[:'shipped_dts']
|
|
497
502
|
end
|
|
498
503
|
|
|
504
|
+
if attributes.has_key?(:'shipping_status')
|
|
505
|
+
self.shipping_status = attributes[:'shipping_status']
|
|
506
|
+
end
|
|
507
|
+
|
|
499
508
|
if attributes.has_key?(:'special_product_type')
|
|
500
509
|
self.special_product_type = attributes[:'special_product_type']
|
|
501
510
|
end
|
|
@@ -710,6 +719,7 @@ module UltracartClient
|
|
|
710
719
|
ship_separately == o.ship_separately &&
|
|
711
720
|
shipped_by_user == o.shipped_by_user &&
|
|
712
721
|
shipped_dts == o.shipped_dts &&
|
|
722
|
+
shipping_status == o.shipping_status &&
|
|
713
723
|
special_product_type == o.special_product_type &&
|
|
714
724
|
tags == o.tags &&
|
|
715
725
|
tax_free == o.tax_free &&
|
|
@@ -733,7 +743,7 @@ module UltracartClient
|
|
|
733
743
|
# Calculates hash code according to all attributes.
|
|
734
744
|
# @return [Fixnum] Hash code
|
|
735
745
|
def hash
|
|
736
|
-
[accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
|
|
746
|
+
[accounting_code, activation_codes, arbitrary_unit_cost, auto_order_last_rebill_dts, auto_order_schedule, barcode, channel_partner_item_id, cogs, component_unit_value, cost, country_code_of_origin, customs_description, description, discount, discount_quantity, discount_shipping_weight, distribution_center_code, edi, exclude_coupon, free_shipping, hazmat, height, item_reference_oid, kit, kit_component, length, manufacturer_sku, max_days_time_in_transit, merchant_item_id, mix_and_match_group_name, mix_and_match_group_oid, no_shipping_discount, options, packed_by_user, perishable_class, pricing_tier_name, properties, quantity, quantity_refunded, quickbooks_class, ship_separately, shipped_by_user, shipped_dts, shipping_status, special_product_type, tags, tax_free, tax_product_type, taxable_cost, total_cost_with_discount, total_refunded, transmitted_to_distribution_center_dts, unit_cost_with_discount, upsell, weight, width].hash
|
|
737
747
|
end
|
|
738
748
|
|
|
739
749
|
# Builds the object from hash
|
|
@@ -0,0 +1,222 @@
|
|
|
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 'date'
|
|
14
|
+
|
|
15
|
+
module UltracartClient
|
|
16
|
+
class OrderPackingSlipResponse
|
|
17
|
+
attr_accessor :error
|
|
18
|
+
|
|
19
|
+
attr_accessor :metadata
|
|
20
|
+
|
|
21
|
+
# pdf_base64
|
|
22
|
+
attr_accessor :pdf_base64
|
|
23
|
+
|
|
24
|
+
# Indicates if API call was successful
|
|
25
|
+
attr_accessor :success
|
|
26
|
+
|
|
27
|
+
attr_accessor :warning
|
|
28
|
+
|
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
30
|
+
def self.attribute_map
|
|
31
|
+
{
|
|
32
|
+
:'error' => :'error',
|
|
33
|
+
:'metadata' => :'metadata',
|
|
34
|
+
:'pdf_base64' => :'pdfBase64',
|
|
35
|
+
:'success' => :'success',
|
|
36
|
+
:'warning' => :'warning'
|
|
37
|
+
}
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Attribute type mapping.
|
|
41
|
+
def self.swagger_types
|
|
42
|
+
{
|
|
43
|
+
:'error' => :'Error',
|
|
44
|
+
:'metadata' => :'ResponseMetadata',
|
|
45
|
+
:'pdf_base64' => :'String',
|
|
46
|
+
:'success' => :'BOOLEAN',
|
|
47
|
+
:'warning' => :'Warning'
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Initializes the object
|
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
|
+
def initialize(attributes = {})
|
|
54
|
+
return unless attributes.is_a?(Hash)
|
|
55
|
+
|
|
56
|
+
# convert string to symbol for hash key
|
|
57
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
58
|
+
|
|
59
|
+
if attributes.has_key?(:'error')
|
|
60
|
+
self.error = attributes[:'error']
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
if attributes.has_key?(:'metadata')
|
|
64
|
+
self.metadata = attributes[:'metadata']
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
if attributes.has_key?(:'pdfBase64')
|
|
68
|
+
self.pdf_base64 = attributes[:'pdfBase64']
|
|
69
|
+
end
|
|
70
|
+
|
|
71
|
+
if attributes.has_key?(:'success')
|
|
72
|
+
self.success = attributes[:'success']
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
if attributes.has_key?(:'warning')
|
|
76
|
+
self.warning = attributes[:'warning']
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
81
|
+
# @return Array for valid properties with the reasons
|
|
82
|
+
def list_invalid_properties
|
|
83
|
+
invalid_properties = Array.new
|
|
84
|
+
invalid_properties
|
|
85
|
+
end
|
|
86
|
+
|
|
87
|
+
# Check to see if the all the properties in the model are valid
|
|
88
|
+
# @return true if the model is valid
|
|
89
|
+
def valid?
|
|
90
|
+
true
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
# Checks equality by comparing each attribute.
|
|
94
|
+
# @param [Object] Object to be compared
|
|
95
|
+
def ==(o)
|
|
96
|
+
return true if self.equal?(o)
|
|
97
|
+
self.class == o.class &&
|
|
98
|
+
error == o.error &&
|
|
99
|
+
metadata == o.metadata &&
|
|
100
|
+
pdf_base64 == o.pdf_base64 &&
|
|
101
|
+
success == o.success &&
|
|
102
|
+
warning == o.warning
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# @see the `==` method
|
|
106
|
+
# @param [Object] Object to be compared
|
|
107
|
+
def eql?(o)
|
|
108
|
+
self == o
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
# Calculates hash code according to all attributes.
|
|
112
|
+
# @return [Fixnum] Hash code
|
|
113
|
+
def hash
|
|
114
|
+
[error, metadata, pdf_base64, success, warning].hash
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Builds the object from hash
|
|
118
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
119
|
+
# @return [Object] Returns the model itself
|
|
120
|
+
def build_from_hash(attributes)
|
|
121
|
+
return nil unless attributes.is_a?(Hash)
|
|
122
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
123
|
+
if type =~ /\AArray<(.*)>/i
|
|
124
|
+
# check to ensure the input is an array given that the attribute
|
|
125
|
+
# is documented as an array but the input is not
|
|
126
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
127
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
128
|
+
end
|
|
129
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
130
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
131
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
self
|
|
135
|
+
end
|
|
136
|
+
|
|
137
|
+
# Deserializes the data based on type
|
|
138
|
+
# @param string type Data type
|
|
139
|
+
# @param string value Value to be deserialized
|
|
140
|
+
# @return [Object] Deserialized data
|
|
141
|
+
def _deserialize(type, value)
|
|
142
|
+
case type.to_sym
|
|
143
|
+
when :DateTime
|
|
144
|
+
DateTime.parse(value)
|
|
145
|
+
when :Date
|
|
146
|
+
Date.parse(value)
|
|
147
|
+
when :String
|
|
148
|
+
value.to_s
|
|
149
|
+
when :Integer
|
|
150
|
+
value.to_i
|
|
151
|
+
when :Float
|
|
152
|
+
value.to_f
|
|
153
|
+
when :BOOLEAN
|
|
154
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
155
|
+
true
|
|
156
|
+
else
|
|
157
|
+
false
|
|
158
|
+
end
|
|
159
|
+
when :Object
|
|
160
|
+
# generic object (usually a Hash), return directly
|
|
161
|
+
value
|
|
162
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
163
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
164
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
165
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
166
|
+
k_type = Regexp.last_match[:k_type]
|
|
167
|
+
v_type = Regexp.last_match[:v_type]
|
|
168
|
+
{}.tap do |hash|
|
|
169
|
+
value.each do |k, v|
|
|
170
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
else # model
|
|
174
|
+
temp_model = UltracartClient.const_get(type).new
|
|
175
|
+
temp_model.build_from_hash(value)
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
# Returns the string representation of the object
|
|
180
|
+
# @return [String] String presentation of the object
|
|
181
|
+
def to_s
|
|
182
|
+
to_hash.to_s
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
186
|
+
# @return [Hash] Returns the object in the form of hash
|
|
187
|
+
def to_body
|
|
188
|
+
to_hash
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Returns the object in the form of hash
|
|
192
|
+
# @return [Hash] Returns the object in the form of hash
|
|
193
|
+
def to_hash
|
|
194
|
+
hash = {}
|
|
195
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
196
|
+
value = self.send(attr)
|
|
197
|
+
next if value.nil?
|
|
198
|
+
hash[param] = _to_hash(value)
|
|
199
|
+
end
|
|
200
|
+
hash
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
# Outputs non-array value in the form of hash
|
|
204
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
205
|
+
# @param [Object] value Any valid value
|
|
206
|
+
# @return [Hash] Returns the value in the form of hash
|
|
207
|
+
def _to_hash(value)
|
|
208
|
+
if value.is_a?(Array)
|
|
209
|
+
value.compact.map { |v| _to_hash(v) }
|
|
210
|
+
elsif value.is_a?(Hash)
|
|
211
|
+
{}.tap do |hash|
|
|
212
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
213
|
+
end
|
|
214
|
+
elsif value.respond_to? :to_hash
|
|
215
|
+
value.to_hash
|
|
216
|
+
else
|
|
217
|
+
value
|
|
218
|
+
end
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
end
|
|
222
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -493,6 +493,7 @@ require 'ultracart_api/models/order_item_property'
|
|
|
493
493
|
require 'ultracart_api/models/order_item_tag'
|
|
494
494
|
require 'ultracart_api/models/order_linked_shipment'
|
|
495
495
|
require 'ultracart_api/models/order_marketing'
|
|
496
|
+
require 'ultracart_api/models/order_packing_slip_response'
|
|
496
497
|
require 'ultracart_api/models/order_payment'
|
|
497
498
|
require 'ultracart_api/models/order_payment_check'
|
|
498
499
|
require 'ultracart_api/models/order_payment_credit_card'
|
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.10.
|
|
4
|
+
version: 3.10.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-05-
|
|
11
|
+
date: 2022-05-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -711,6 +711,7 @@ files:
|
|
|
711
711
|
- docs/OrderItemTag.md
|
|
712
712
|
- docs/OrderLinkedShipment.md
|
|
713
713
|
- docs/OrderMarketing.md
|
|
714
|
+
- docs/OrderPackingSlipResponse.md
|
|
714
715
|
- docs/OrderPayment.md
|
|
715
716
|
- docs/OrderPaymentCheck.md
|
|
716
717
|
- docs/OrderPaymentCreditCard.md
|
|
@@ -1403,6 +1404,7 @@ files:
|
|
|
1403
1404
|
- lib/ultracart_api/models/order_item_tag.rb
|
|
1404
1405
|
- lib/ultracart_api/models/order_linked_shipment.rb
|
|
1405
1406
|
- lib/ultracart_api/models/order_marketing.rb
|
|
1407
|
+
- lib/ultracart_api/models/order_packing_slip_response.rb
|
|
1406
1408
|
- lib/ultracart_api/models/order_payment.rb
|
|
1407
1409
|
- lib/ultracart_api/models/order_payment_check.rb
|
|
1408
1410
|
- lib/ultracart_api/models/order_payment_credit_card.rb
|