ultracart_api 4.0.230 → 4.0.231
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/docs/OrderApi.md +2 -0
- data/docs/OrderQueryBatch.md +3 -1
- data/docs/SelfConfig.md +4 -0
- data/docs/UltraCartConfig.md +4 -0
- data/lib/ultracart_api/api/order_api.rb +3 -0
- data/lib/ultracart_api/models/order_query_batch.rb +48 -4
- data/lib/ultracart_api/models/self_config.rb +21 -1
- data/lib/ultracart_api/models/ultra_cart_config.rb +21 -1
- 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: 34974570592c4f662df1ba6c7ce249cfe01b8b4179c378df6f83c5421fa6e202
|
4
|
+
data.tar.gz: 20497ccdc504bc640cd8e7601d5afe0add61a3fce7eb186ab08dfaedf9bd4278
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 91b1dca1e3b6a22f338adc4aab73471c2d4e622071e35102931456dbbd9eedf36a874b725f0b3d60efb59d0bc0773fb68233b427b89bc14c415a8f971c50f11e
|
7
|
+
data.tar.gz: a83f3fa625fc07ac0d5fa1eb28b0f55b9e8c760cf1c5915a4841f822079bbee01980ce237c1376eed283d2814f77663f002dcf77d944d6d689ffb3ce39389cd8
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.231
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.231.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.231.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.231'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -1518,6 +1518,7 @@ Not every change is committed to every SDK.
|
|
1518
1518
|
|
1519
1519
|
| Version | Date | Comments |
|
1520
1520
|
| --: | :-: | --- |
|
1521
|
+
| 4.0.231 | 08/08/2024 | added query_target to OrderApi.getOrdersBatch to allow cache usage |
|
1521
1522
|
| 4.0.230 | 06/24/2024 | conversation object cleanup |
|
1522
1523
|
| 4.0.229 | 06/14/2024 | pbx menu - add say voice property |
|
1523
1524
|
| 4.0.228 | 06/07/2024 | conversation pbx - adjust agent voicemail box uuid fields |
|
data/docs/OrderApi.md
CHANGED
@@ -1590,6 +1590,7 @@ opts = {
|
|
1590
1590
|
manual_refund: true, # Boolean | Consider a manual refund done externally
|
1591
1591
|
reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
|
1592
1592
|
issue_store_credit: true, # Boolean | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
1593
|
+
auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
|
1593
1594
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
1594
1595
|
}
|
1595
1596
|
|
@@ -1632,6 +1633,7 @@ end
|
|
1632
1633
|
| **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
|
1633
1634
|
| **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
|
1634
1635
|
| **issue_store_credit** | **Boolean** | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional][default to false] |
|
1636
|
+
| **auto_order_cancel_reason** | **String** | Reason for auto orders cancellation | [optional] |
|
1635
1637
|
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
1636
1638
|
|
1637
1639
|
### Return type
|
data/docs/OrderQueryBatch.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **order_ids** | **Array<String>** | Order IDs | [optional] |
|
8
|
+
| **query_target** | **String** | Query Target | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'ultracart_api'
|
13
14
|
|
14
15
|
instance = UltracartClient::OrderQueryBatch.new(
|
15
|
-
order_ids: null
|
16
|
+
order_ids: null,
|
17
|
+
query_target: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
data/docs/SelfConfig.md
CHANGED
@@ -4,6 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **exempt_from_colorado_retail_delivery_fee** | **Boolean** | True if the Colorado Retail Delivery Fee should not be collected | [optional] |
|
8
|
+
| **exempt_from_minnesota_retail_delivery_fee** | **Boolean** | True if the Minnesota Retail Delivery Fee should not be collected | [optional] |
|
7
9
|
| **tax_billing** | **Boolean** | True if sales tax should be collected based on billing address instead of shipping address | [optional] |
|
8
10
|
|
9
11
|
## Example
|
@@ -12,6 +14,8 @@
|
|
12
14
|
require 'ultracart_api'
|
13
15
|
|
14
16
|
instance = UltracartClient::SelfConfig.new(
|
17
|
+
exempt_from_colorado_retail_delivery_fee: null,
|
18
|
+
exempt_from_minnesota_retail_delivery_fee: null,
|
15
19
|
tax_billing: null
|
16
20
|
)
|
17
21
|
```
|
data/docs/UltraCartConfig.md
CHANGED
@@ -4,6 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **exempt_from_colorado_retail_delivery_fee** | **Boolean** | True if the Colorado Retail Delivery Fee should not be collected | [optional] |
|
8
|
+
| **exempt_from_minnesota_retail_delivery_fee** | **Boolean** | True if the Minnesota Retail Delivery Fee should not be collected | [optional] |
|
7
9
|
| **tax_billing** | **Boolean** | True if sales tax should be collected based on billing address instead of shipping address | [optional] |
|
8
10
|
|
9
11
|
## Example
|
@@ -12,6 +14,8 @@
|
|
12
14
|
require 'ultracart_api'
|
13
15
|
|
14
16
|
instance = UltracartClient::UltraCartConfig.new(
|
17
|
+
exempt_from_colorado_retail_delivery_fee: null,
|
18
|
+
exempt_from_minnesota_retail_delivery_fee: null,
|
15
19
|
tax_billing: null
|
16
20
|
)
|
17
21
|
```
|
@@ -1491,6 +1491,7 @@ module UltracartClient
|
|
1491
1491
|
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1492
1492
|
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1493
1493
|
# @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
|
1494
|
+
# @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
|
1494
1495
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1495
1496
|
# @return [OrderResponse]
|
1496
1497
|
def refund_order(order_id, order, opts = {})
|
@@ -1509,6 +1510,7 @@ module UltracartClient
|
|
1509
1510
|
# @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
|
1510
1511
|
# @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
|
1511
1512
|
# @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
|
1513
|
+
# @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
|
1512
1514
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1513
1515
|
# @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
|
1514
1516
|
def refund_order_with_http_info(order_id, order, opts = {})
|
@@ -1534,6 +1536,7 @@ module UltracartClient
|
|
1534
1536
|
query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
|
1535
1537
|
query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
|
1536
1538
|
query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
|
1539
|
+
query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
|
1537
1540
|
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
1538
1541
|
|
1539
1542
|
# header parameters
|
@@ -18,10 +18,36 @@ module UltracartClient
|
|
18
18
|
# Order IDs
|
19
19
|
attr_accessor :order_ids
|
20
20
|
|
21
|
+
# Query Target
|
22
|
+
attr_accessor :query_target
|
23
|
+
|
24
|
+
class EnumAttributeValidator
|
25
|
+
attr_reader :datatype
|
26
|
+
attr_reader :allowable_values
|
27
|
+
|
28
|
+
def initialize(datatype, allowable_values)
|
29
|
+
@allowable_values = allowable_values.map do |value|
|
30
|
+
case datatype.to_s
|
31
|
+
when /Integer/i
|
32
|
+
value.to_i
|
33
|
+
when /Float/i
|
34
|
+
value.to_f
|
35
|
+
else
|
36
|
+
value
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def valid?(value)
|
42
|
+
!value || allowable_values.include?(value)
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
21
46
|
# Attribute mapping from ruby-style variable name to JSON key.
|
22
47
|
def self.attribute_map
|
23
48
|
{
|
24
|
-
:'order_ids' => :'order_ids'
|
49
|
+
:'order_ids' => :'order_ids',
|
50
|
+
:'query_target' => :'query_target'
|
25
51
|
}
|
26
52
|
end
|
27
53
|
|
@@ -33,7 +59,8 @@ module UltracartClient
|
|
33
59
|
# Attribute type mapping.
|
34
60
|
def self.openapi_types
|
35
61
|
{
|
36
|
-
:'order_ids' => :'Array<String>'
|
62
|
+
:'order_ids' => :'Array<String>',
|
63
|
+
:'query_target' => :'String'
|
37
64
|
}
|
38
65
|
end
|
39
66
|
|
@@ -63,6 +90,10 @@ module UltracartClient
|
|
63
90
|
self.order_ids = value
|
64
91
|
end
|
65
92
|
end
|
93
|
+
|
94
|
+
if attributes.key?(:'query_target')
|
95
|
+
self.query_target = attributes[:'query_target']
|
96
|
+
end
|
66
97
|
end
|
67
98
|
|
68
99
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -75,15 +106,28 @@ module UltracartClient
|
|
75
106
|
# Check to see if the all the properties in the model are valid
|
76
107
|
# @return true if the model is valid
|
77
108
|
def valid?
|
109
|
+
query_target_validator = EnumAttributeValidator.new('String', ["origin", "cache"])
|
110
|
+
return false unless query_target_validator.valid?(@query_target)
|
78
111
|
true
|
79
112
|
end
|
80
113
|
|
114
|
+
# Custom attribute writer method checking allowed values (enum).
|
115
|
+
# @param [Object] query_target Object to be assigned
|
116
|
+
def query_target=(query_target)
|
117
|
+
validator = EnumAttributeValidator.new('String', ["origin", "cache"])
|
118
|
+
unless validator.valid?(query_target)
|
119
|
+
fail ArgumentError, "invalid value for \"query_target\", must be one of #{validator.allowable_values}."
|
120
|
+
end
|
121
|
+
@query_target = query_target
|
122
|
+
end
|
123
|
+
|
81
124
|
# Checks equality by comparing each attribute.
|
82
125
|
# @param [Object] Object to be compared
|
83
126
|
def ==(o)
|
84
127
|
return true if self.equal?(o)
|
85
128
|
self.class == o.class &&
|
86
|
-
order_ids == o.order_ids
|
129
|
+
order_ids == o.order_ids &&
|
130
|
+
query_target == o.query_target
|
87
131
|
end
|
88
132
|
|
89
133
|
# @see the `==` method
|
@@ -95,7 +139,7 @@ module UltracartClient
|
|
95
139
|
# Calculates hash code according to all attributes.
|
96
140
|
# @return [Integer] Hash code
|
97
141
|
def hash
|
98
|
-
[order_ids].hash
|
142
|
+
[order_ids, query_target].hash
|
99
143
|
end
|
100
144
|
|
101
145
|
# Builds the object from hash
|
@@ -15,12 +15,20 @@ require 'time'
|
|
15
15
|
|
16
16
|
module UltracartClient
|
17
17
|
class SelfConfig
|
18
|
+
# True if the Colorado Retail Delivery Fee should not be collected
|
19
|
+
attr_accessor :exempt_from_colorado_retail_delivery_fee
|
20
|
+
|
21
|
+
# True if the Minnesota Retail Delivery Fee should not be collected
|
22
|
+
attr_accessor :exempt_from_minnesota_retail_delivery_fee
|
23
|
+
|
18
24
|
# True if sales tax should be collected based on billing address instead of shipping address
|
19
25
|
attr_accessor :tax_billing
|
20
26
|
|
21
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
22
28
|
def self.attribute_map
|
23
29
|
{
|
30
|
+
:'exempt_from_colorado_retail_delivery_fee' => :'exempt_from_colorado_retail_delivery_fee',
|
31
|
+
:'exempt_from_minnesota_retail_delivery_fee' => :'exempt_from_minnesota_retail_delivery_fee',
|
24
32
|
:'tax_billing' => :'tax_billing'
|
25
33
|
}
|
26
34
|
end
|
@@ -33,6 +41,8 @@ module UltracartClient
|
|
33
41
|
# Attribute type mapping.
|
34
42
|
def self.openapi_types
|
35
43
|
{
|
44
|
+
:'exempt_from_colorado_retail_delivery_fee' => :'Boolean',
|
45
|
+
:'exempt_from_minnesota_retail_delivery_fee' => :'Boolean',
|
36
46
|
:'tax_billing' => :'Boolean'
|
37
47
|
}
|
38
48
|
end
|
@@ -58,6 +68,14 @@ module UltracartClient
|
|
58
68
|
h[k.to_sym] = v
|
59
69
|
}
|
60
70
|
|
71
|
+
if attributes.key?(:'exempt_from_colorado_retail_delivery_fee')
|
72
|
+
self.exempt_from_colorado_retail_delivery_fee = attributes[:'exempt_from_colorado_retail_delivery_fee']
|
73
|
+
end
|
74
|
+
|
75
|
+
if attributes.key?(:'exempt_from_minnesota_retail_delivery_fee')
|
76
|
+
self.exempt_from_minnesota_retail_delivery_fee = attributes[:'exempt_from_minnesota_retail_delivery_fee']
|
77
|
+
end
|
78
|
+
|
61
79
|
if attributes.key?(:'tax_billing')
|
62
80
|
self.tax_billing = attributes[:'tax_billing']
|
63
81
|
end
|
@@ -81,6 +99,8 @@ module UltracartClient
|
|
81
99
|
def ==(o)
|
82
100
|
return true if self.equal?(o)
|
83
101
|
self.class == o.class &&
|
102
|
+
exempt_from_colorado_retail_delivery_fee == o.exempt_from_colorado_retail_delivery_fee &&
|
103
|
+
exempt_from_minnesota_retail_delivery_fee == o.exempt_from_minnesota_retail_delivery_fee &&
|
84
104
|
tax_billing == o.tax_billing
|
85
105
|
end
|
86
106
|
|
@@ -93,7 +113,7 @@ module UltracartClient
|
|
93
113
|
# Calculates hash code according to all attributes.
|
94
114
|
# @return [Integer] Hash code
|
95
115
|
def hash
|
96
|
-
[tax_billing].hash
|
116
|
+
[exempt_from_colorado_retail_delivery_fee, exempt_from_minnesota_retail_delivery_fee, tax_billing].hash
|
97
117
|
end
|
98
118
|
|
99
119
|
# Builds the object from hash
|
@@ -15,12 +15,20 @@ require 'time'
|
|
15
15
|
|
16
16
|
module UltracartClient
|
17
17
|
class UltraCartConfig
|
18
|
+
# True if the Colorado Retail Delivery Fee should not be collected
|
19
|
+
attr_accessor :exempt_from_colorado_retail_delivery_fee
|
20
|
+
|
21
|
+
# True if the Minnesota Retail Delivery Fee should not be collected
|
22
|
+
attr_accessor :exempt_from_minnesota_retail_delivery_fee
|
23
|
+
|
18
24
|
# True if sales tax should be collected based on billing address instead of shipping address
|
19
25
|
attr_accessor :tax_billing
|
20
26
|
|
21
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
22
28
|
def self.attribute_map
|
23
29
|
{
|
30
|
+
:'exempt_from_colorado_retail_delivery_fee' => :'exempt_from_colorado_retail_delivery_fee',
|
31
|
+
:'exempt_from_minnesota_retail_delivery_fee' => :'exempt_from_minnesota_retail_delivery_fee',
|
24
32
|
:'tax_billing' => :'tax_billing'
|
25
33
|
}
|
26
34
|
end
|
@@ -33,6 +41,8 @@ module UltracartClient
|
|
33
41
|
# Attribute type mapping.
|
34
42
|
def self.openapi_types
|
35
43
|
{
|
44
|
+
:'exempt_from_colorado_retail_delivery_fee' => :'Boolean',
|
45
|
+
:'exempt_from_minnesota_retail_delivery_fee' => :'Boolean',
|
36
46
|
:'tax_billing' => :'Boolean'
|
37
47
|
}
|
38
48
|
end
|
@@ -58,6 +68,14 @@ module UltracartClient
|
|
58
68
|
h[k.to_sym] = v
|
59
69
|
}
|
60
70
|
|
71
|
+
if attributes.key?(:'exempt_from_colorado_retail_delivery_fee')
|
72
|
+
self.exempt_from_colorado_retail_delivery_fee = attributes[:'exempt_from_colorado_retail_delivery_fee']
|
73
|
+
end
|
74
|
+
|
75
|
+
if attributes.key?(:'exempt_from_minnesota_retail_delivery_fee')
|
76
|
+
self.exempt_from_minnesota_retail_delivery_fee = attributes[:'exempt_from_minnesota_retail_delivery_fee']
|
77
|
+
end
|
78
|
+
|
61
79
|
if attributes.key?(:'tax_billing')
|
62
80
|
self.tax_billing = attributes[:'tax_billing']
|
63
81
|
end
|
@@ -81,6 +99,8 @@ module UltracartClient
|
|
81
99
|
def ==(o)
|
82
100
|
return true if self.equal?(o)
|
83
101
|
self.class == o.class &&
|
102
|
+
exempt_from_colorado_retail_delivery_fee == o.exempt_from_colorado_retail_delivery_fee &&
|
103
|
+
exempt_from_minnesota_retail_delivery_fee == o.exempt_from_minnesota_retail_delivery_fee &&
|
84
104
|
tax_billing == o.tax_billing
|
85
105
|
end
|
86
106
|
|
@@ -93,7 +113,7 @@ module UltracartClient
|
|
93
113
|
# Calculates hash code according to all attributes.
|
94
114
|
# @return [Integer] Hash code
|
95
115
|
def hash
|
96
|
-
[tax_billing].hash
|
116
|
+
[exempt_from_colorado_retail_delivery_fee, exempt_from_minnesota_retail_delivery_fee, tax_billing].hash
|
97
117
|
end
|
98
118
|
|
99
119
|
# Builds the object from hash
|
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: 4.0.
|
4
|
+
version: 4.0.231
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-08-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|