ultracart_api 3.11.21 → 3.11.23
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 +18 -4
- data/docs/ConversationApi.md +213 -0
- data/docs/ConversationDeleteKnowledgeBaseDocumentResponse.md +12 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentRequest.md +8 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentResponse.md +14 -0
- data/docs/ConversationKnowledgeBaseDocument.md +14 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrl.md +9 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md +12 -0
- data/docs/ConversationKnowledgeBaseDocumentsResponse.md +12 -0
- data/docs/CustomReportAccountConfig.md +1 -0
- data/docs/CustomReportUsageBreakdown.md +9 -0
- data/docs/Customer.md +1 -0
- data/docs/CustomerApi.md +4 -5
- data/docs/ItemApi.md +3 -3
- data/docs/ItemShippingMethod.md +1 -0
- data/docs/OrderApi.md +2 -2
- data/docs/ReplaceOrderItemIdRequest.md +1 -1
- data/lib/ultracart_api/api/conversation_api.rb +238 -0
- data/lib/ultracart_api/api/customer_api.rb +6 -7
- data/lib/ultracart_api/api/item_api.rb +3 -3
- data/lib/ultracart_api/api/order_api.rb +2 -2
- data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb +184 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb +241 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document.rb +239 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb +193 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb +224 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +12 -1
- data/lib/ultracart_api/models/custom_report_usage_breakdown.rb +194 -0
- data/lib/ultracart_api/models/customer.rb +26 -1
- data/lib/ultracart_api/models/item_shipping_method.rb +11 -1
- data/lib/ultracart_api/models/order_payment.rb +2 -2
- data/lib/ultracart_api/models/replace_order_item_id_request.rb +1 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +8 -0
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4d356bfbcf996d166f3d334b55be71dbbbaaa13139a36eaa759331ce1c2b9d35
|
4
|
+
data.tar.gz: 83f41899f0a03f69e5529730303708de70a67e48fa5133d98bf8418987dd6dc9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4b46d4945a4b3949971494c25f8b447391e93ac4f35633b7deeb79603d9d2d60e0bcd07068e40b50e558803b7574675dac539c830cfdbe2308f21c0dfa589d7
|
7
|
+
data.tar.gz: 1108d0d048cf84bc46738bf736cf43d6072acb386f0e68c9e381aa6cdac4d3408a9bc3590b45a4c9aa3a21e210a9a0f5cef9043f91880223c4a86ac67a1f7a9f
|
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.23
|
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.23.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.23.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.23'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -133,6 +133,7 @@ Class | Method | HTTP request | Description
|
|
133
133
|
*UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
134
134
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
135
135
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
136
|
+
*UltracartClient::ConversationApi* | [**delete_agent_profile_knowledge_base_document**](docs/ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document
|
136
137
|
*UltracartClient::ConversationApi* | [**delete_conversation_canned_message**](docs/ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
137
138
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
138
139
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
@@ -146,6 +147,7 @@ Class | Method | HTTP request | Description
|
|
146
147
|
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
147
148
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
148
149
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
150
|
+
*UltracartClient::ConversationApi* | [**get_agent_profile_knowledge_base**](docs/ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile
|
149
151
|
*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
150
152
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
151
153
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
@@ -155,6 +157,7 @@ Class | Method | HTTP request | Description
|
|
155
157
|
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
156
158
|
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
157
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//rest/v2/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
158
161
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
159
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
|
160
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
|
@@ -188,6 +191,7 @@ Class | Method | HTTP request | Description
|
|
188
191
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
189
192
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
190
193
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
194
|
+
*UltracartClient::ConversationApi* | [**insert_agent_profile_knowledge_base_document**](docs/ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
|
191
195
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
192
196
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
193
197
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
@@ -754,6 +758,7 @@ Class | Method | HTTP request | Description
|
|
754
758
|
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
755
759
|
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
756
760
|
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
761
|
+
- [UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse](docs/ConversationDeleteKnowledgeBaseDocumentResponse.md)
|
757
762
|
- [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
|
758
763
|
- [UltracartClient::ConversationDepartmentMember](docs/ConversationDepartmentMember.md)
|
759
764
|
- [UltracartClient::ConversationDepartmentMembersResponse](docs/ConversationDepartmentMembersResponse.md)
|
@@ -773,7 +778,13 @@ Class | Method | HTTP request | Description
|
|
773
778
|
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
774
779
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
775
780
|
- [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
|
781
|
+
- [UltracartClient::ConversationInsertKnowledgeBaseDocumentRequest](docs/ConversationInsertKnowledgeBaseDocumentRequest.md)
|
782
|
+
- [UltracartClient::ConversationInsertKnowledgeBaseDocumentResponse](docs/ConversationInsertKnowledgeBaseDocumentResponse.md)
|
776
783
|
- [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
|
784
|
+
- [UltracartClient::ConversationKnowledgeBaseDocument](docs/ConversationKnowledgeBaseDocument.md)
|
785
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentUploadUrl](docs/ConversationKnowledgeBaseDocumentUploadUrl.md)
|
786
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentUploadUrlResponse](docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md)
|
787
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentsResponse](docs/ConversationKnowledgeBaseDocumentsResponse.md)
|
777
788
|
- [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
|
778
789
|
- [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
|
779
790
|
- [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
|
@@ -940,6 +951,7 @@ Class | Method | HTTP request | Description
|
|
940
951
|
- [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
|
941
952
|
- [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
|
942
953
|
- [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
|
954
|
+
- [UltracartClient::CustomReportUsageBreakdown](docs/CustomReportUsageBreakdown.md)
|
943
955
|
- [UltracartClient::CustomReportsExecutionReportData](docs/CustomReportsExecutionReportData.md)
|
944
956
|
- [UltracartClient::CustomReportsExecutionRequest](docs/CustomReportsExecutionRequest.md)
|
945
957
|
- [UltracartClient::CustomReportsExecutionResponse](docs/CustomReportsExecutionResponse.md)
|
@@ -1577,6 +1589,8 @@ Not every change is committed to every SDK.
|
|
1577
1589
|
|
1578
1590
|
| Version | Date | Comments |
|
1579
1591
|
| --: | :-: | --- |
|
1592
|
+
| 3.11.23 | 10/14/2025 | CustomerApi.deleteWishlistItem bug fix for bad response type |
|
1593
|
+
| 3.11.22 | 10/06/2025 | added Customer.fax back into object model |
|
1580
1594
|
| 3.11.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
1581
1595
|
| 3.11.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
1582
1596
|
| 3.11.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
|
data/docs/ConversationApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**delete_agent_profile_knowledge_base_document**](ConversationApi.md#delete_agent_profile_knowledge_base_document) | **DELETE** /conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid} | Delete a knowledge base document
|
7
8
|
[**delete_conversation_canned_message**](ConversationApi.md#delete_conversation_canned_message) | **DELETE** /conversation/canned_messages/{conversation_canned_message_oid} | Delete a conversation canned message
|
8
9
|
[**delete_department**](ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
9
10
|
[**delete_engagement**](ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
@@ -17,6 +18,7 @@ Method | HTTP request | Description
|
|
17
18
|
[**delete_pbx_voicemail_mailbox**](ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
18
19
|
[**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
19
20
|
[**get_agent_profile**](ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
21
|
+
[**get_agent_profile_knowledge_base**](ConversationApi.md#get_agent_profile_knowledge_base) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base | Get the list of knowledge base documents associated with this agent profile
|
20
22
|
[**get_agent_profiles**](ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
21
23
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
22
24
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
@@ -26,6 +28,7 @@ Method | HTTP request | Description
|
|
26
28
|
[**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
27
29
|
[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
28
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//rest/v2/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
29
32
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
30
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
|
31
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
|
@@ -59,6 +62,7 @@ Method | HTTP request | Description
|
|
59
62
|
[**get_pbx_voicemail_mailboxes**](ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
60
63
|
[**get_virtual_agent_budget**](ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
61
64
|
[**get_virtual_agent_capabilities**](ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
65
|
+
[**insert_agent_profile_knowledge_base_document**](ConversationApi.md#insert_agent_profile_knowledge_base_document) | **POST** /conversation/agent/profiles/{user_id}/knowledge_base | Insert a knowledge base document
|
62
66
|
[**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
63
67
|
[**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
64
68
|
[**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
@@ -94,6 +98,59 @@ Method | HTTP request | Description
|
|
94
98
|
[**update_virtual_agent_capabilities**](ConversationApi.md#update_virtual_agent_capabilities) | **PUT** /conversation/virtualagent/capabilities | Update virtual agent capabilities
|
95
99
|
|
96
100
|
|
101
|
+
# **delete_agent_profile_knowledge_base_document**
|
102
|
+
> ConversationDeleteKnowledgeBaseDocumentResponse delete_agent_profile_knowledge_base_document(user_id, document_uuid)
|
103
|
+
|
104
|
+
Delete a knowledge base document
|
105
|
+
|
106
|
+
Delete a knowledge base document
|
107
|
+
|
108
|
+
### Example
|
109
|
+
```ruby
|
110
|
+
# load the gem
|
111
|
+
require 'ultracart_api'
|
112
|
+
|
113
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
114
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
115
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
116
|
+
|
117
|
+
|
118
|
+
user_id = 56 # Integer |
|
119
|
+
|
120
|
+
document_uuid = 'document_uuid_example' # String |
|
121
|
+
|
122
|
+
|
123
|
+
begin
|
124
|
+
#Delete a knowledge base document
|
125
|
+
result = api_instance.delete_agent_profile_knowledge_base_document(user_id, document_uuid)
|
126
|
+
p result
|
127
|
+
rescue UltracartClient::ApiError => e
|
128
|
+
puts "Exception when calling ConversationApi->delete_agent_profile_knowledge_base_document: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**user_id** | **Integer**| |
|
137
|
+
**document_uuid** | **String**| |
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
[**ConversationDeleteKnowledgeBaseDocumentResponse**](ConversationDeleteKnowledgeBaseDocumentResponse.md)
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: application/json
|
150
|
+
- **Accept**: application/json
|
151
|
+
|
152
|
+
|
153
|
+
|
97
154
|
# **delete_conversation_canned_message**
|
98
155
|
> delete_conversation_canned_message(conversation_canned_message_oid)
|
99
156
|
|
@@ -731,6 +788,56 @@ This endpoint does not need any parameter.
|
|
731
788
|
|
732
789
|
|
733
790
|
|
791
|
+
# **get_agent_profile_knowledge_base**
|
792
|
+
> ConversationKnowledgeBaseDocumentsResponse get_agent_profile_knowledge_base(user_id)
|
793
|
+
|
794
|
+
Get the list of knowledge base documents associated with this agent profile
|
795
|
+
|
796
|
+
Retrieve knowledge base documents
|
797
|
+
|
798
|
+
### Example
|
799
|
+
```ruby
|
800
|
+
# load the gem
|
801
|
+
require 'ultracart_api'
|
802
|
+
|
803
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
804
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
805
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
806
|
+
|
807
|
+
|
808
|
+
user_id = 56 # Integer |
|
809
|
+
|
810
|
+
|
811
|
+
begin
|
812
|
+
#Get the list of knowledge base documents associated with this agent profile
|
813
|
+
result = api_instance.get_agent_profile_knowledge_base(user_id)
|
814
|
+
p result
|
815
|
+
rescue UltracartClient::ApiError => e
|
816
|
+
puts "Exception when calling ConversationApi->get_agent_profile_knowledge_base: #{e}"
|
817
|
+
end
|
818
|
+
```
|
819
|
+
|
820
|
+
### Parameters
|
821
|
+
|
822
|
+
Name | Type | Description | Notes
|
823
|
+
------------- | ------------- | ------------- | -------------
|
824
|
+
**user_id** | **Integer**| |
|
825
|
+
|
826
|
+
### Return type
|
827
|
+
|
828
|
+
[**ConversationKnowledgeBaseDocumentsResponse**](ConversationKnowledgeBaseDocumentsResponse.md)
|
829
|
+
|
830
|
+
### Authorization
|
831
|
+
|
832
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
833
|
+
|
834
|
+
### HTTP request headers
|
835
|
+
|
836
|
+
- **Content-Type**: application/json
|
837
|
+
- **Accept**: application/json
|
838
|
+
|
839
|
+
|
840
|
+
|
734
841
|
# **get_agent_profiles**
|
735
842
|
> ConversationAgentProfilesResponse get_agent_profiles
|
736
843
|
|
@@ -1155,6 +1262,59 @@ This endpoint does not need any parameter.
|
|
1155
1262
|
|
1156
1263
|
|
1157
1264
|
|
1265
|
+
# **get_conversation_knowledge_base_document_upload_url**
|
1266
|
+
> ConversationKnowledgeBaseDocumentUploadUrlResponse get_conversation_knowledge_base_document_upload_url(user_id, extension)
|
1267
|
+
|
1268
|
+
Get a pre-signed conversation knowledge base document upload URL
|
1269
|
+
|
1270
|
+
Get a pre-signed conversation knowledge base document upload URL
|
1271
|
+
|
1272
|
+
### Example
|
1273
|
+
```ruby
|
1274
|
+
# load the gem
|
1275
|
+
require 'ultracart_api'
|
1276
|
+
|
1277
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1278
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1279
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1280
|
+
|
1281
|
+
|
1282
|
+
user_id = 56 # Integer |
|
1283
|
+
|
1284
|
+
extension = 'extension_example' # String |
|
1285
|
+
|
1286
|
+
|
1287
|
+
begin
|
1288
|
+
#Get a pre-signed conversation knowledge base document upload URL
|
1289
|
+
result = api_instance.get_conversation_knowledge_base_document_upload_url(user_id, extension)
|
1290
|
+
p result
|
1291
|
+
rescue UltracartClient::ApiError => e
|
1292
|
+
puts "Exception when calling ConversationApi->get_conversation_knowledge_base_document_upload_url: #{e}"
|
1293
|
+
end
|
1294
|
+
```
|
1295
|
+
|
1296
|
+
### Parameters
|
1297
|
+
|
1298
|
+
Name | Type | Description | Notes
|
1299
|
+
------------- | ------------- | ------------- | -------------
|
1300
|
+
**user_id** | **Integer**| |
|
1301
|
+
**extension** | **String**| |
|
1302
|
+
|
1303
|
+
### Return type
|
1304
|
+
|
1305
|
+
[**ConversationKnowledgeBaseDocumentUploadUrlResponse**](ConversationKnowledgeBaseDocumentUploadUrlResponse.md)
|
1306
|
+
|
1307
|
+
### Authorization
|
1308
|
+
|
1309
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1310
|
+
|
1311
|
+
### HTTP request headers
|
1312
|
+
|
1313
|
+
- **Content-Type**: application/json
|
1314
|
+
- **Accept**: application/json
|
1315
|
+
|
1316
|
+
|
1317
|
+
|
1158
1318
|
# **get_conversation_messages**
|
1159
1319
|
> ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
|
1160
1320
|
|
@@ -2752,6 +2912,59 @@ This endpoint does not need any parameter.
|
|
2752
2912
|
|
2753
2913
|
|
2754
2914
|
|
2915
|
+
# **insert_agent_profile_knowledge_base_document**
|
2916
|
+
> ConversationInsertKnowledgeBaseDocumentResponse insert_agent_profile_knowledge_base_document(user_id, knowledge_base_document_request)
|
2917
|
+
|
2918
|
+
Insert a knowledge base document
|
2919
|
+
|
2920
|
+
Insert a knowledge base document
|
2921
|
+
|
2922
|
+
### Example
|
2923
|
+
```ruby
|
2924
|
+
# load the gem
|
2925
|
+
require 'ultracart_api'
|
2926
|
+
|
2927
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2928
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2929
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
2930
|
+
|
2931
|
+
|
2932
|
+
user_id = 56 # Integer |
|
2933
|
+
|
2934
|
+
knowledge_base_document_request = UltracartClient::ConversationInsertKnowledgeBaseDocumentRequest.new # ConversationInsertKnowledgeBaseDocumentRequest | Insert request
|
2935
|
+
|
2936
|
+
|
2937
|
+
begin
|
2938
|
+
#Insert a knowledge base document
|
2939
|
+
result = api_instance.insert_agent_profile_knowledge_base_document(user_id, knowledge_base_document_request)
|
2940
|
+
p result
|
2941
|
+
rescue UltracartClient::ApiError => e
|
2942
|
+
puts "Exception when calling ConversationApi->insert_agent_profile_knowledge_base_document: #{e}"
|
2943
|
+
end
|
2944
|
+
```
|
2945
|
+
|
2946
|
+
### Parameters
|
2947
|
+
|
2948
|
+
Name | Type | Description | Notes
|
2949
|
+
------------- | ------------- | ------------- | -------------
|
2950
|
+
**user_id** | **Integer**| |
|
2951
|
+
**knowledge_base_document_request** | [**ConversationInsertKnowledgeBaseDocumentRequest**](ConversationInsertKnowledgeBaseDocumentRequest.md)| Insert request |
|
2952
|
+
|
2953
|
+
### Return type
|
2954
|
+
|
2955
|
+
[**ConversationInsertKnowledgeBaseDocumentResponse**](ConversationInsertKnowledgeBaseDocumentResponse.md)
|
2956
|
+
|
2957
|
+
### Authorization
|
2958
|
+
|
2959
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2960
|
+
|
2961
|
+
### HTTP request headers
|
2962
|
+
|
2963
|
+
- **Content-Type**: application/json
|
2964
|
+
- **Accept**: application/json
|
2965
|
+
|
2966
|
+
|
2967
|
+
|
2755
2968
|
# **insert_conversation_canned_message**
|
2756
2969
|
> ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
|
2757
2970
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**document_id** | **String** | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ConversationInsertKnowledgeBaseDocumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**document_uuid** | **String** | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**s3_key** | **String** | | [optional]
|
10
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
11
|
+
**vector_keys** | **Array<String>** | | [optional]
|
12
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocument
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**chunk_count** | **Integer** | | [optional]
|
7
|
+
**description** | **String** | | [optional]
|
8
|
+
**document_id** | **String** | Human readable identifier. Filename is recommended. | [optional]
|
9
|
+
**document_uuid** | **String** | | [optional]
|
10
|
+
**metadata** | **String** | | [optional]
|
11
|
+
**mime_type** | **String** | | [optional]
|
12
|
+
**s3_key** | **String** | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocumentUploadUrlResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_pbx_audio_upload_url** | [**ConversationKnowledgeBaseDocumentUploadUrl**](ConversationKnowledgeBaseDocumentUploadUrl.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocumentsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**documents** | [**Array<ConversationKnowledgeBaseDocument>**](ConversationKnowledgeBaseDocument.md) | documents | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**ai_budget** | **Float** | | [optional]
|
7
7
|
**ai_usage** | **Float** | Current AI usage creating reports | [optional]
|
8
|
+
**ai_usage_breakdowns** | [**Array<CustomReportUsageBreakdown>**](CustomReportUsageBreakdown.md) | | [optional]
|
8
9
|
**merchant_id** | **String** | Current BigQuery SQL usage running reports | [optional]
|
9
10
|
**novice_sql_comments** | **BOOLEAN** | | [optional]
|
10
11
|
**opt_in** | **BOOLEAN** | True if they have opted into custom reports | [optional]
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::CustomReportUsageBreakdown
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**usage** | **Float** | | [optional]
|
7
|
+
**usage_date** | **String** | Date/time that usage occurred | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Customer.md
CHANGED
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
|
26
26
|
**edi** | [**CustomerEDI**](CustomerEDI.md) | | [optional]
|
27
27
|
**email** | **String** | Email address of this customer profile | [optional]
|
28
28
|
**exempt_shipping_handling_charge** | **BOOLEAN** | Exempt shipping handling charge | [optional]
|
29
|
+
**fax** | **String** | Fax Number | [optional]
|
29
30
|
**fedex_account_number** | **String** | FedEx account number | [optional]
|
30
31
|
**free_shipping** | **BOOLEAN** | This customer always receives free shipping | [optional]
|
31
32
|
**free_shipping_minimum** | **Float** | If free_shipping is true, this is the minimum subtotal required for free shipping | [optional]
|
data/docs/CustomerApi.md
CHANGED
@@ -186,7 +186,7 @@ nil (empty response body)
|
|
186
186
|
|
187
187
|
|
188
188
|
# **delete_wish_list_item**
|
189
|
-
>
|
189
|
+
> delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
190
190
|
|
191
191
|
Delete a customer wishlist item
|
192
192
|
|
@@ -209,8 +209,7 @@ customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist i
|
|
209
209
|
|
210
210
|
begin
|
211
211
|
#Delete a customer wishlist item
|
212
|
-
|
213
|
-
p result
|
212
|
+
api_instance.delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
214
213
|
rescue UltracartClient::ApiError => e
|
215
214
|
puts "Exception when calling CustomerApi->delete_wish_list_item: #{e}"
|
216
215
|
end
|
@@ -225,7 +224,7 @@ Name | Type | Description | Notes
|
|
225
224
|
|
226
225
|
### Return type
|
227
226
|
|
228
|
-
|
227
|
+
nil (empty response body)
|
229
228
|
|
230
229
|
### Authorization
|
231
230
|
|
@@ -233,7 +232,7 @@ Name | Type | Description | Notes
|
|
233
232
|
|
234
233
|
### HTTP request headers
|
235
234
|
|
236
|
-
- **Content-Type**: application/json
|
235
|
+
- **Content-Type**: application/json
|
237
236
|
- **Accept**: application/json
|
238
237
|
|
239
238
|
|
data/docs/ItemApi.md
CHANGED
@@ -174,7 +174,7 @@ nil (empty response body)
|
|
174
174
|
|
175
175
|
### HTTP request headers
|
176
176
|
|
177
|
-
- **Content-Type**: application/json
|
177
|
+
- **Content-Type**: application/json
|
178
178
|
- **Accept**: application/json
|
179
179
|
|
180
180
|
|
@@ -661,7 +661,7 @@ Name | Type | Description | Notes
|
|
661
661
|
|
662
662
|
### HTTP request headers
|
663
663
|
|
664
|
-
- **Content-Type**: application/json
|
664
|
+
- **Content-Type**: application/json
|
665
665
|
- **Accept**: application/json
|
666
666
|
|
667
667
|
|
@@ -711,7 +711,7 @@ Name | Type | Description | Notes
|
|
711
711
|
|
712
712
|
### HTTP request headers
|
713
713
|
|
714
|
-
- **Content-Type**: application/json
|
714
|
+
- **Content-Type**: application/json
|
715
715
|
- **Accept**: application/json
|
716
716
|
|
717
717
|
|
data/docs/ItemShippingMethod.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
|
|
17
17
|
**shipping_method** | **String** | Shipping method name | [optional]
|
18
18
|
**shipping_method_oid** | **Integer** | Shipping method object identifier | [optional]
|
19
19
|
**shipping_method_validity** | **String** | Shipping method validity | [optional]
|
20
|
+
**ships_separately** | **BOOLEAN** | Ships separately | [optional]
|
20
21
|
**signature_required** | **BOOLEAN** | Signature required | [optional]
|
21
22
|
|
22
23
|
|
data/docs/OrderApi.md
CHANGED
@@ -808,7 +808,7 @@ Name | Type | Description | Notes
|
|
808
808
|
|
809
809
|
### HTTP request headers
|
810
810
|
|
811
|
-
- **Content-Type**: application/json
|
811
|
+
- **Content-Type**: application/json
|
812
812
|
- **Accept**: application/json
|
813
813
|
|
814
814
|
|
@@ -1137,7 +1137,7 @@ Name | Type | Description | Notes
|
|
1137
1137
|
|
1138
1138
|
### HTTP request headers
|
1139
1139
|
|
1140
|
-
- **Content-Type**: application/json
|
1140
|
+
- **Content-Type**: application/json
|
1141
1141
|
- **Accept**: application/json
|
1142
1142
|
|
1143
1143
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**item_index** | **Integer** | Index of the item on the order
|
6
|
+
**item_index** | **Integer** | Index of the item on the order. Must match order.items[].item_index | [optional]
|
7
7
|
**merchant_item_id** | **String** | Item ID | [optional]
|
8
8
|
**order_id** | **String** | Order ID | [optional]
|
9
9
|
**replacement_merchant_item_id** | **String** | Replacement Item ID | [optional]
|