ultracart_api 3.11.23 → 3.11.25
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 +7 -5
- data/docs/ConversationApi.md +1 -1
- data/docs/ConversationVirtualAgentCapabilities.md +1 -0
- data/docs/CustomerLoyalty.md +3 -0
- data/lib/ultracart_api/api/conversation_api.rb +1 -1
- data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb +11 -1
- data/lib/ultracart_api/models/customer_loyalty.rb +31 -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: 6e260e60adb1c5cb0080901ec9b3128c1a0e988111204ffbe7d8106420901f60
|
|
4
|
+
data.tar.gz: 5a122f322db56ca0b9e50d55a15fed6ee6c6a04108d850c086fd5a11fb740f2c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 71afc84895abb25e1040f962fb38c3a7a252eb04b003e233a0f17a9a36d378298901dbf0eab4334902993786629b2fb12d1d9b71fbe1431c8fd744c1790a79a9
|
|
7
|
+
data.tar.gz: 17438a84e8cc9ac5766660c9a29f70aabdf5846e957932edd8c8e26e16e764be554df6d181bb02b4dd56b4a2de38966f5fcf2c7de2a1c9c54e636b5d2ae53ded
|
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.11.
|
|
10
|
+
- Package version: 3.11.25
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
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.11.
|
|
27
|
+
gem install ./ultracart_api-3.11.25.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.25.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.11.
|
|
35
|
+
gem 'ultracart_api', '~> 3.11.25'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -157,7 +157,7 @@ Class | Method | HTTP request | Description
|
|
|
157
157
|
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
|
158
158
|
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
|
159
159
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
|
160
|
-
*UltracartClient::ConversationApi* | [**get_conversation_knowledge_base_document_upload_url**](docs/ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation
|
|
160
|
+
*UltracartClient::ConversationApi* | [**get_conversation_knowledge_base_document_upload_url**](docs/ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
|
161
161
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
162
162
|
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
|
163
163
|
*UltracartClient::ConversationApi* | [**get_conversation_pbx_audio_upload_url**](docs/ConversationApi.md#get_conversation_pbx_audio_upload_url) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
|
|
@@ -1589,6 +1589,8 @@ Not every change is committed to every SDK.
|
|
|
1589
1589
|
|
|
1590
1590
|
| Version | Date | Comments |
|
|
1591
1591
|
| --: | :-: | --- |
|
|
1592
|
+
| 3.11.25 | 10/20/2025 | conversation api bug fix for bad url on agent profile kb upload |
|
|
1593
|
+
| 3.11.24 | 10/20/2025 | new perm flag on conversation virtual agent capabilities |
|
|
1592
1594
|
| 3.11.23 | 10/14/2025 | CustomerApi.deleteWishlistItem bug fix for bad response type |
|
|
1593
1595
|
| 3.11.22 | 10/06/2025 | added Customer.fax back into object model |
|
|
1594
1596
|
| 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -28,7 +28,7 @@ Method | HTTP request | Description
|
|
|
28
28
|
[**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
|
29
29
|
[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
|
30
30
|
[**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
|
31
|
-
[**get_conversation_knowledge_base_document_upload_url**](ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation
|
|
31
|
+
[**get_conversation_knowledge_base_document_upload_url**](ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
|
32
32
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
33
33
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
|
34
34
|
[**get_conversation_pbx_audio_upload_url**](ConversationApi.md#get_conversation_pbx_audio_upload_url) | **GET** /conversation/pbx/audio/upload_url/{extension} | Get a pre-signed conversation multimedia upload URL
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**access_storefront_and_item** | **BOOLEAN** | Permission flag to allow this Agent access to the storefront and item information. | [optional]
|
|
6
7
|
**cancel_subscription** | **BOOLEAN** | | [optional]
|
|
7
8
|
**delay_subscription** | **BOOLEAN** | | [optional]
|
|
8
9
|
**lookup_order_information** | **BOOLEAN** | | [optional]
|
data/docs/CustomerLoyalty.md
CHANGED
|
@@ -8,6 +8,9 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**internal_gift_certificate_balance** | **String** | Loyalty Cashback / Store credit balance (internal gift certificate balance) | [optional]
|
|
9
9
|
**internal_gift_certificate_oid** | **Integer** | Internal gift certificate oid used to tracking loyalty cashback / store credit. | [optional]
|
|
10
10
|
**ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional]
|
|
11
|
+
**loyalty_tier_expiration_dts** | **String** | Loyalty tier expiration date (read only because of SDK addition) | [optional]
|
|
12
|
+
**loyalty_tier_name** | **String** | Loyalty tier name | [optional]
|
|
13
|
+
**loyalty_tier_oid** | **Integer** | Loyalty tier oid (set to zero to remove the tier) | [optional]
|
|
11
14
|
**pending_points** | **Integer** | Pending Points | [optional]
|
|
12
15
|
**redemptions** | [**Array<CustomerLoyaltyRedemption>**](CustomerLoyaltyRedemption.md) | Redemptions | [optional]
|
|
13
16
|
|
|
@@ -1343,7 +1343,7 @@ module UltracartClient
|
|
|
1343
1343
|
fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_knowledge_base_document_upload_url"
|
|
1344
1344
|
end
|
|
1345
1345
|
# resource path
|
|
1346
|
-
local_var_path = '/conversation
|
|
1346
|
+
local_var_path = '/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}'.sub('{' + 'user_id' + '}', user_id.to_s).sub('{' + 'extension' + '}', extension.to_s)
|
|
1347
1347
|
|
|
1348
1348
|
# query parameters
|
|
1349
1349
|
query_params = {}
|
|
@@ -14,6 +14,9 @@ require 'date'
|
|
|
14
14
|
|
|
15
15
|
module UltracartClient
|
|
16
16
|
class ConversationVirtualAgentCapabilities
|
|
17
|
+
# Permission flag to allow this Agent access to the storefront and item information.
|
|
18
|
+
attr_accessor :access_storefront_and_item
|
|
19
|
+
|
|
17
20
|
attr_accessor :cancel_subscription
|
|
18
21
|
|
|
19
22
|
attr_accessor :delay_subscription
|
|
@@ -72,6 +75,7 @@ module UltracartClient
|
|
|
72
75
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
73
76
|
def self.attribute_map
|
|
74
77
|
{
|
|
78
|
+
:'access_storefront_and_item' => :'access_storefront_and_item',
|
|
75
79
|
:'cancel_subscription' => :'cancel_subscription',
|
|
76
80
|
:'delay_subscription' => :'delay_subscription',
|
|
77
81
|
:'lookup_order_information' => :'lookup_order_information',
|
|
@@ -92,6 +96,7 @@ module UltracartClient
|
|
|
92
96
|
# Attribute type mapping.
|
|
93
97
|
def self.swagger_types
|
|
94
98
|
{
|
|
99
|
+
:'access_storefront_and_item' => :'BOOLEAN',
|
|
95
100
|
:'cancel_subscription' => :'BOOLEAN',
|
|
96
101
|
:'delay_subscription' => :'BOOLEAN',
|
|
97
102
|
:'lookup_order_information' => :'BOOLEAN',
|
|
@@ -117,6 +122,10 @@ module UltracartClient
|
|
|
117
122
|
# convert string to symbol for hash key
|
|
118
123
|
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
119
124
|
|
|
125
|
+
if attributes.has_key?(:'access_storefront_and_item')
|
|
126
|
+
self.access_storefront_and_item = attributes[:'access_storefront_and_item']
|
|
127
|
+
end
|
|
128
|
+
|
|
120
129
|
if attributes.has_key?(:'cancel_subscription')
|
|
121
130
|
self.cancel_subscription = attributes[:'cancel_subscription']
|
|
122
131
|
end
|
|
@@ -206,6 +215,7 @@ module UltracartClient
|
|
|
206
215
|
def ==(o)
|
|
207
216
|
return true if self.equal?(o)
|
|
208
217
|
self.class == o.class &&
|
|
218
|
+
access_storefront_and_item == o.access_storefront_and_item &&
|
|
209
219
|
cancel_subscription == o.cancel_subscription &&
|
|
210
220
|
delay_subscription == o.delay_subscription &&
|
|
211
221
|
lookup_order_information == o.lookup_order_information &&
|
|
@@ -231,7 +241,7 @@ module UltracartClient
|
|
|
231
241
|
# Calculates hash code according to all attributes.
|
|
232
242
|
# @return [Fixnum] Hash code
|
|
233
243
|
def hash
|
|
234
|
-
[cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
|
|
244
|
+
[access_storefront_and_item, cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, open_support_ticket_zoho_desk_department_id, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card, zoho_desk_available, zoho_desk_departments].hash
|
|
235
245
|
end
|
|
236
246
|
|
|
237
247
|
# Builds the object from hash
|
|
@@ -28,6 +28,15 @@ module UltracartClient
|
|
|
28
28
|
# Ledger entries
|
|
29
29
|
attr_accessor :ledger_entries
|
|
30
30
|
|
|
31
|
+
# Loyalty tier expiration date (read only because of SDK addition)
|
|
32
|
+
attr_accessor :loyalty_tier_expiration_dts
|
|
33
|
+
|
|
34
|
+
# Loyalty tier name
|
|
35
|
+
attr_accessor :loyalty_tier_name
|
|
36
|
+
|
|
37
|
+
# Loyalty tier oid (set to zero to remove the tier)
|
|
38
|
+
attr_accessor :loyalty_tier_oid
|
|
39
|
+
|
|
31
40
|
# Pending Points
|
|
32
41
|
attr_accessor :pending_points
|
|
33
42
|
|
|
@@ -42,6 +51,9 @@ module UltracartClient
|
|
|
42
51
|
:'internal_gift_certificate_balance' => :'internal_gift_certificate_balance',
|
|
43
52
|
:'internal_gift_certificate_oid' => :'internal_gift_certificate_oid',
|
|
44
53
|
:'ledger_entries' => :'ledger_entries',
|
|
54
|
+
:'loyalty_tier_expiration_dts' => :'loyalty_tier_expiration_dts',
|
|
55
|
+
:'loyalty_tier_name' => :'loyalty_tier_name',
|
|
56
|
+
:'loyalty_tier_oid' => :'loyalty_tier_oid',
|
|
45
57
|
:'pending_points' => :'pending_points',
|
|
46
58
|
:'redemptions' => :'redemptions'
|
|
47
59
|
}
|
|
@@ -55,6 +67,9 @@ module UltracartClient
|
|
|
55
67
|
:'internal_gift_certificate_balance' => :'String',
|
|
56
68
|
:'internal_gift_certificate_oid' => :'Integer',
|
|
57
69
|
:'ledger_entries' => :'Array<CustomerLoyaltyLedger>',
|
|
70
|
+
:'loyalty_tier_expiration_dts' => :'String',
|
|
71
|
+
:'loyalty_tier_name' => :'String',
|
|
72
|
+
:'loyalty_tier_oid' => :'Integer',
|
|
58
73
|
:'pending_points' => :'Integer',
|
|
59
74
|
:'redemptions' => :'Array<CustomerLoyaltyRedemption>'
|
|
60
75
|
}
|
|
@@ -90,6 +105,18 @@ module UltracartClient
|
|
|
90
105
|
end
|
|
91
106
|
end
|
|
92
107
|
|
|
108
|
+
if attributes.has_key?(:'loyalty_tier_expiration_dts')
|
|
109
|
+
self.loyalty_tier_expiration_dts = attributes[:'loyalty_tier_expiration_dts']
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.has_key?(:'loyalty_tier_name')
|
|
113
|
+
self.loyalty_tier_name = attributes[:'loyalty_tier_name']
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
if attributes.has_key?(:'loyalty_tier_oid')
|
|
117
|
+
self.loyalty_tier_oid = attributes[:'loyalty_tier_oid']
|
|
118
|
+
end
|
|
119
|
+
|
|
93
120
|
if attributes.has_key?(:'pending_points')
|
|
94
121
|
self.pending_points = attributes[:'pending_points']
|
|
95
122
|
end
|
|
@@ -124,6 +151,9 @@ module UltracartClient
|
|
|
124
151
|
internal_gift_certificate_balance == o.internal_gift_certificate_balance &&
|
|
125
152
|
internal_gift_certificate_oid == o.internal_gift_certificate_oid &&
|
|
126
153
|
ledger_entries == o.ledger_entries &&
|
|
154
|
+
loyalty_tier_expiration_dts == o.loyalty_tier_expiration_dts &&
|
|
155
|
+
loyalty_tier_name == o.loyalty_tier_name &&
|
|
156
|
+
loyalty_tier_oid == o.loyalty_tier_oid &&
|
|
127
157
|
pending_points == o.pending_points &&
|
|
128
158
|
redemptions == o.redemptions
|
|
129
159
|
end
|
|
@@ -137,7 +167,7 @@ module UltracartClient
|
|
|
137
167
|
# Calculates hash code according to all attributes.
|
|
138
168
|
# @return [Fixnum] Hash code
|
|
139
169
|
def hash
|
|
140
|
-
[current_points, internal_gift_certificate, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
|
|
170
|
+
[current_points, internal_gift_certificate, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, loyalty_tier_expiration_dts, loyalty_tier_name, loyalty_tier_oid, pending_points, redemptions].hash
|
|
141
171
|
end
|
|
142
172
|
|
|
143
173
|
# 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: 3.11.
|
|
4
|
+
version: 3.11.25
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2025-10-
|
|
11
|
+
date: 2025-10-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|