ultracart_api 4.1.32 → 4.1.34
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 +4 -2
- data/docs/ConversationAgentProfile.md +7 -1
- data/docs/CouponFreeItemWithItemPurchaseAndFreeShipping.md +3 -1
- data/docs/CouponPercentOffItemsAndFreeShipping.md +3 -1
- data/lib/ultracart_api/models/conversation_agent_profile.rb +38 -4
- data/lib/ultracart_api/models/coupon_free_item_with_item_purchase_and_free_shipping.rb +16 -4
- data/lib/ultracart_api/models/coupon_percent_off_items_and_free_shipping.rb +16 -4
- 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: '08e4cf39d82bc3f1b8995a91ca73bfaeaeb118b0fbeac5b550be2bf71e0dcaa1'
|
|
4
|
+
data.tar.gz: 34b74e14c0e7c3a5fff9964e0621470e0060678b652bc527adee4e5316548930
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9b44d6c9d7d94ccf480ba5d5f6de45f923344268343422e949fc7919d1042899edb7325b0ccfd4aa9bc69d72e9470d14557ff82ea9f16186344fb47558f2ebdb
|
|
7
|
+
data.tar.gz: 97271a58f51d6db11cf0c7421ed4db574867f2f6eb946008cdec1e81fa727bd73a1968d249a3700ccadf563db0aa0b7098a5a349cfd1daa5b731f6aeb5e2e5f8
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.34
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.34'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -1599,6 +1599,8 @@ Not every change is committed to every SDK.
|
|
|
1599
1599
|
|
|
1600
1600
|
| Version | Date | Comments |
|
|
1601
1601
|
| --: | :-: | --- |
|
|
1602
|
+
| 4.1.34 | 12/02/2025 | coupons - added optional free specific shipping method to two coupons |
|
|
1603
|
+
| 4.1.33 | 11/26/2025 | conversation - AI agent profile fields |
|
|
1602
1604
|
| 4.1.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
|
|
1603
1605
|
| 4.1.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
|
|
1604
1606
|
| 4.1.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **ai_chat_instructions** | **String** | Additional instructions for this AI when handle web chats | [optional] |
|
|
9
9
|
| **ai_persona** | **String** | Persona of this AI agent | [optional] |
|
|
10
10
|
| **ai_sms_instructions** | **String** | Additional instructions for this AI when handle SMS messages | [optional] |
|
|
11
|
+
| **ai_ticket_instructions** | **String** | Additional instructions for this AI when handling ticket draft replies | [optional] |
|
|
11
12
|
| **chat_limit** | **Integer** | The number of engagement chats that can be pushed on them at any given time. | [optional] |
|
|
12
13
|
| **default_language_iso_code** | **String** | The default language the agent is chatting in | [optional] |
|
|
13
14
|
| **default_status** | **String** | Default status when the agent loads conversations app. | [optional] |
|
|
@@ -16,6 +17,8 @@
|
|
|
16
17
|
| **profile_image_upload_key** | **String** | An upload key used to update the profile image. | [optional] |
|
|
17
18
|
| **profile_image_url** | **String** | Their current profile image URL | [optional] |
|
|
18
19
|
| **user_id** | **Integer** | User ID associated with the agent. Populated by getAgentProfiles call only. | [optional] |
|
|
20
|
+
| **zohodesk_classifications** | **Array<String>** | Restrict this agent to drafting replies only to tickets with these classifications | [optional] |
|
|
21
|
+
| **zohodesk_departments** | **Array<String>** | Restrict this agent to drafting replies only to these department ids | [optional] |
|
|
19
22
|
|
|
20
23
|
## Example
|
|
21
24
|
|
|
@@ -27,6 +30,7 @@ instance = UltracartClient::ConversationAgentProfile.new(
|
|
|
27
30
|
ai_chat_instructions: null,
|
|
28
31
|
ai_persona: null,
|
|
29
32
|
ai_sms_instructions: null,
|
|
33
|
+
ai_ticket_instructions: null,
|
|
30
34
|
chat_limit: null,
|
|
31
35
|
default_language_iso_code: null,
|
|
32
36
|
default_status: null,
|
|
@@ -34,7 +38,9 @@ instance = UltracartClient::ConversationAgentProfile.new(
|
|
|
34
38
|
name: null,
|
|
35
39
|
profile_image_upload_key: null,
|
|
36
40
|
profile_image_url: null,
|
|
37
|
-
user_id: null
|
|
41
|
+
user_id: null,
|
|
42
|
+
zohodesk_classifications: null,
|
|
43
|
+
zohodesk_departments: null
|
|
38
44
|
)
|
|
39
45
|
```
|
|
40
46
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **limit** | **Integer** | The (optional) maximum quantity of discounted items. Free shipping will apply to all units of the free item ids though. | [optional] |
|
|
9
9
|
| **match_required_purchase_item_to_free_item** | **Boolean** | If true then the free item is matched 1:1 with the free item in the list. | [optional] |
|
|
10
10
|
| **required_purchase_items** | **Array<String>** | Required items (at least one from the list) that must be purchased for coupon to be valid | [optional] |
|
|
11
|
+
| **shipping_methods** | **Array<String>** | One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods | [optional] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,7 +19,8 @@ instance = UltracartClient::CouponFreeItemWithItemPurchaseAndFreeShipping.new(
|
|
|
18
19
|
items: null,
|
|
19
20
|
limit: null,
|
|
20
21
|
match_required_purchase_item_to_free_item: null,
|
|
21
|
-
required_purchase_items: null
|
|
22
|
+
required_purchase_items: null,
|
|
23
|
+
shipping_methods: null
|
|
22
24
|
)
|
|
23
25
|
```
|
|
24
26
|
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional] |
|
|
10
10
|
| **item_tags** | **Array<String>** | An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items. | [optional] |
|
|
11
11
|
| **items** | **Array<String>** | An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items. | [optional] |
|
|
12
|
+
| **shipping_methods** | **Array<String>** | One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods | [optional] |
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,7 +21,8 @@ instance = UltracartClient::CouponPercentOffItemsAndFreeShipping.new(
|
|
|
20
21
|
excluded_item_tags: null,
|
|
21
22
|
excluded_items: null,
|
|
22
23
|
item_tags: null,
|
|
23
|
-
items: null
|
|
24
|
+
items: null,
|
|
25
|
+
shipping_methods: null
|
|
24
26
|
)
|
|
25
27
|
```
|
|
26
28
|
|
|
@@ -27,6 +27,9 @@ module UltracartClient
|
|
|
27
27
|
# Additional instructions for this AI when handle SMS messages
|
|
28
28
|
attr_accessor :ai_sms_instructions
|
|
29
29
|
|
|
30
|
+
# Additional instructions for this AI when handling ticket draft replies
|
|
31
|
+
attr_accessor :ai_ticket_instructions
|
|
32
|
+
|
|
30
33
|
# The number of engagement chats that can be pushed on them at any given time.
|
|
31
34
|
attr_accessor :chat_limit
|
|
32
35
|
|
|
@@ -51,6 +54,12 @@ module UltracartClient
|
|
|
51
54
|
# User ID associated with the agent. Populated by getAgentProfiles call only.
|
|
52
55
|
attr_accessor :user_id
|
|
53
56
|
|
|
57
|
+
# Restrict this agent to drafting replies only to tickets with these classifications
|
|
58
|
+
attr_accessor :zohodesk_classifications
|
|
59
|
+
|
|
60
|
+
# Restrict this agent to drafting replies only to these department ids
|
|
61
|
+
attr_accessor :zohodesk_departments
|
|
62
|
+
|
|
54
63
|
class EnumAttributeValidator
|
|
55
64
|
attr_reader :datatype
|
|
56
65
|
attr_reader :allowable_values
|
|
@@ -80,6 +89,7 @@ module UltracartClient
|
|
|
80
89
|
:'ai_chat_instructions' => :'ai_chat_instructions',
|
|
81
90
|
:'ai_persona' => :'ai_persona',
|
|
82
91
|
:'ai_sms_instructions' => :'ai_sms_instructions',
|
|
92
|
+
:'ai_ticket_instructions' => :'ai_ticket_instructions',
|
|
83
93
|
:'chat_limit' => :'chat_limit',
|
|
84
94
|
:'default_language_iso_code' => :'default_language_iso_code',
|
|
85
95
|
:'default_status' => :'default_status',
|
|
@@ -87,7 +97,9 @@ module UltracartClient
|
|
|
87
97
|
:'name' => :'name',
|
|
88
98
|
:'profile_image_upload_key' => :'profile_image_upload_key',
|
|
89
99
|
:'profile_image_url' => :'profile_image_url',
|
|
90
|
-
:'user_id' => :'user_id'
|
|
100
|
+
:'user_id' => :'user_id',
|
|
101
|
+
:'zohodesk_classifications' => :'zohodesk_classifications',
|
|
102
|
+
:'zohodesk_departments' => :'zohodesk_departments'
|
|
91
103
|
}
|
|
92
104
|
end
|
|
93
105
|
|
|
@@ -103,6 +115,7 @@ module UltracartClient
|
|
|
103
115
|
:'ai_chat_instructions' => :'String',
|
|
104
116
|
:'ai_persona' => :'String',
|
|
105
117
|
:'ai_sms_instructions' => :'String',
|
|
118
|
+
:'ai_ticket_instructions' => :'String',
|
|
106
119
|
:'chat_limit' => :'Integer',
|
|
107
120
|
:'default_language_iso_code' => :'String',
|
|
108
121
|
:'default_status' => :'String',
|
|
@@ -110,7 +123,9 @@ module UltracartClient
|
|
|
110
123
|
:'name' => :'String',
|
|
111
124
|
:'profile_image_upload_key' => :'String',
|
|
112
125
|
:'profile_image_url' => :'String',
|
|
113
|
-
:'user_id' => :'Integer'
|
|
126
|
+
:'user_id' => :'Integer',
|
|
127
|
+
:'zohodesk_classifications' => :'Array<String>',
|
|
128
|
+
:'zohodesk_departments' => :'Array<String>'
|
|
114
129
|
}
|
|
115
130
|
end
|
|
116
131
|
|
|
@@ -151,6 +166,10 @@ module UltracartClient
|
|
|
151
166
|
self.ai_sms_instructions = attributes[:'ai_sms_instructions']
|
|
152
167
|
end
|
|
153
168
|
|
|
169
|
+
if attributes.key?(:'ai_ticket_instructions')
|
|
170
|
+
self.ai_ticket_instructions = attributes[:'ai_ticket_instructions']
|
|
171
|
+
end
|
|
172
|
+
|
|
154
173
|
if attributes.key?(:'chat_limit')
|
|
155
174
|
self.chat_limit = attributes[:'chat_limit']
|
|
156
175
|
end
|
|
@@ -182,6 +201,18 @@ module UltracartClient
|
|
|
182
201
|
if attributes.key?(:'user_id')
|
|
183
202
|
self.user_id = attributes[:'user_id']
|
|
184
203
|
end
|
|
204
|
+
|
|
205
|
+
if attributes.key?(:'zohodesk_classifications')
|
|
206
|
+
if (value = attributes[:'zohodesk_classifications']).is_a?(Array)
|
|
207
|
+
self.zohodesk_classifications = value
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
if attributes.key?(:'zohodesk_departments')
|
|
212
|
+
if (value = attributes[:'zohodesk_departments']).is_a?(Array)
|
|
213
|
+
self.zohodesk_departments = value
|
|
214
|
+
end
|
|
215
|
+
end
|
|
185
216
|
end
|
|
186
217
|
|
|
187
218
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -218,6 +249,7 @@ module UltracartClient
|
|
|
218
249
|
ai_chat_instructions == o.ai_chat_instructions &&
|
|
219
250
|
ai_persona == o.ai_persona &&
|
|
220
251
|
ai_sms_instructions == o.ai_sms_instructions &&
|
|
252
|
+
ai_ticket_instructions == o.ai_ticket_instructions &&
|
|
221
253
|
chat_limit == o.chat_limit &&
|
|
222
254
|
default_language_iso_code == o.default_language_iso_code &&
|
|
223
255
|
default_status == o.default_status &&
|
|
@@ -225,7 +257,9 @@ module UltracartClient
|
|
|
225
257
|
name == o.name &&
|
|
226
258
|
profile_image_upload_key == o.profile_image_upload_key &&
|
|
227
259
|
profile_image_url == o.profile_image_url &&
|
|
228
|
-
user_id == o.user_id
|
|
260
|
+
user_id == o.user_id &&
|
|
261
|
+
zohodesk_classifications == o.zohodesk_classifications &&
|
|
262
|
+
zohodesk_departments == o.zohodesk_departments
|
|
229
263
|
end
|
|
230
264
|
|
|
231
265
|
# @see the `==` method
|
|
@@ -237,7 +271,7 @@ module UltracartClient
|
|
|
237
271
|
# Calculates hash code according to all attributes.
|
|
238
272
|
# @return [Integer] Hash code
|
|
239
273
|
def hash
|
|
240
|
-
[ai, ai_chat_instructions, ai_persona, ai_sms_instructions, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url, user_id].hash
|
|
274
|
+
[ai, ai_chat_instructions, ai_persona, ai_sms_instructions, ai_ticket_instructions, chat_limit, default_language_iso_code, default_status, display_name, name, profile_image_upload_key, profile_image_url, user_id, zohodesk_classifications, zohodesk_departments].hash
|
|
241
275
|
end
|
|
242
276
|
|
|
243
277
|
# Builds the object from hash
|
|
@@ -27,13 +27,17 @@ module UltracartClient
|
|
|
27
27
|
# Required items (at least one from the list) that must be purchased for coupon to be valid
|
|
28
28
|
attr_accessor :required_purchase_items
|
|
29
29
|
|
|
30
|
+
# One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
|
|
31
|
+
attr_accessor :shipping_methods
|
|
32
|
+
|
|
30
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
31
34
|
def self.attribute_map
|
|
32
35
|
{
|
|
33
36
|
:'items' => :'items',
|
|
34
37
|
:'limit' => :'limit',
|
|
35
38
|
:'match_required_purchase_item_to_free_item' => :'match_required_purchase_item_to_free_item',
|
|
36
|
-
:'required_purchase_items' => :'required_purchase_items'
|
|
39
|
+
:'required_purchase_items' => :'required_purchase_items',
|
|
40
|
+
:'shipping_methods' => :'shipping_methods'
|
|
37
41
|
}
|
|
38
42
|
end
|
|
39
43
|
|
|
@@ -48,7 +52,8 @@ module UltracartClient
|
|
|
48
52
|
:'items' => :'Array<String>',
|
|
49
53
|
:'limit' => :'Integer',
|
|
50
54
|
:'match_required_purchase_item_to_free_item' => :'Boolean',
|
|
51
|
-
:'required_purchase_items' => :'Array<String>'
|
|
55
|
+
:'required_purchase_items' => :'Array<String>',
|
|
56
|
+
:'shipping_methods' => :'Array<String>'
|
|
52
57
|
}
|
|
53
58
|
end
|
|
54
59
|
|
|
@@ -92,6 +97,12 @@ module UltracartClient
|
|
|
92
97
|
self.required_purchase_items = value
|
|
93
98
|
end
|
|
94
99
|
end
|
|
100
|
+
|
|
101
|
+
if attributes.key?(:'shipping_methods')
|
|
102
|
+
if (value = attributes[:'shipping_methods']).is_a?(Array)
|
|
103
|
+
self.shipping_methods = value
|
|
104
|
+
end
|
|
105
|
+
end
|
|
95
106
|
end
|
|
96
107
|
|
|
97
108
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -115,7 +126,8 @@ module UltracartClient
|
|
|
115
126
|
items == o.items &&
|
|
116
127
|
limit == o.limit &&
|
|
117
128
|
match_required_purchase_item_to_free_item == o.match_required_purchase_item_to_free_item &&
|
|
118
|
-
required_purchase_items == o.required_purchase_items
|
|
129
|
+
required_purchase_items == o.required_purchase_items &&
|
|
130
|
+
shipping_methods == o.shipping_methods
|
|
119
131
|
end
|
|
120
132
|
|
|
121
133
|
# @see the `==` method
|
|
@@ -127,7 +139,7 @@ module UltracartClient
|
|
|
127
139
|
# Calculates hash code according to all attributes.
|
|
128
140
|
# @return [Integer] Hash code
|
|
129
141
|
def hash
|
|
130
|
-
[items, limit, match_required_purchase_item_to_free_item, required_purchase_items].hash
|
|
142
|
+
[items, limit, match_required_purchase_item_to_free_item, required_purchase_items, shipping_methods].hash
|
|
131
143
|
end
|
|
132
144
|
|
|
133
145
|
# Builds the object from hash
|
|
@@ -30,6 +30,9 @@ module UltracartClient
|
|
|
30
30
|
# An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items.
|
|
31
31
|
attr_accessor :items
|
|
32
32
|
|
|
33
|
+
# One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods
|
|
34
|
+
attr_accessor :shipping_methods
|
|
35
|
+
|
|
33
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
34
37
|
def self.attribute_map
|
|
35
38
|
{
|
|
@@ -37,7 +40,8 @@ module UltracartClient
|
|
|
37
40
|
:'excluded_item_tags' => :'excluded_item_tags',
|
|
38
41
|
:'excluded_items' => :'excluded_items',
|
|
39
42
|
:'item_tags' => :'item_tags',
|
|
40
|
-
:'items' => :'items'
|
|
43
|
+
:'items' => :'items',
|
|
44
|
+
:'shipping_methods' => :'shipping_methods'
|
|
41
45
|
}
|
|
42
46
|
end
|
|
43
47
|
|
|
@@ -53,7 +57,8 @@ module UltracartClient
|
|
|
53
57
|
:'excluded_item_tags' => :'Array<String>',
|
|
54
58
|
:'excluded_items' => :'Array<String>',
|
|
55
59
|
:'item_tags' => :'Array<String>',
|
|
56
|
-
:'items' => :'Array<String>'
|
|
60
|
+
:'items' => :'Array<String>',
|
|
61
|
+
:'shipping_methods' => :'Array<String>'
|
|
57
62
|
}
|
|
58
63
|
end
|
|
59
64
|
|
|
@@ -105,6 +110,12 @@ module UltracartClient
|
|
|
105
110
|
self.items = value
|
|
106
111
|
end
|
|
107
112
|
end
|
|
113
|
+
|
|
114
|
+
if attributes.key?(:'shipping_methods')
|
|
115
|
+
if (value = attributes[:'shipping_methods']).is_a?(Array)
|
|
116
|
+
self.shipping_methods = value
|
|
117
|
+
end
|
|
118
|
+
end
|
|
108
119
|
end
|
|
109
120
|
|
|
110
121
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -129,7 +140,8 @@ module UltracartClient
|
|
|
129
140
|
excluded_item_tags == o.excluded_item_tags &&
|
|
130
141
|
excluded_items == o.excluded_items &&
|
|
131
142
|
item_tags == o.item_tags &&
|
|
132
|
-
items == o.items
|
|
143
|
+
items == o.items &&
|
|
144
|
+
shipping_methods == o.shipping_methods
|
|
133
145
|
end
|
|
134
146
|
|
|
135
147
|
# @see the `==` method
|
|
@@ -141,7 +153,7 @@ module UltracartClient
|
|
|
141
153
|
# Calculates hash code according to all attributes.
|
|
142
154
|
# @return [Integer] Hash code
|
|
143
155
|
def hash
|
|
144
|
-
[discount_percent, excluded_item_tags, excluded_items, item_tags, items].hash
|
|
156
|
+
[discount_percent, excluded_item_tags, excluded_items, item_tags, items, shipping_methods].hash
|
|
145
157
|
end
|
|
146
158
|
|
|
147
159
|
# 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.1.
|
|
4
|
+
version: 4.1.34
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-
|
|
11
|
+
date: 2025-12-02 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|