ultracart_api 4.1.22 → 4.1.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 +15 -2
- data/docs/ConversationApi.md +219 -0
- data/docs/ConversationDeleteKnowledgeBaseDocumentResponse.md +26 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentRequest.md +18 -0
- data/docs/ConversationInsertKnowledgeBaseDocumentResponse.md +30 -0
- data/docs/ConversationKnowledgeBaseDocument.md +30 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrl.md +20 -0
- data/docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md +26 -0
- data/docs/ConversationKnowledgeBaseDocumentsResponse.md +26 -0
- data/docs/CustomReportAccountConfig.md +2 -0
- data/docs/CustomReportUsageBreakdown.md +20 -0
- data/docs/CustomerApi.md +5 -5
- data/lib/ultracart_api/api/conversation_api.rb +279 -0
- data/lib/ultracart_api/api/customer_api.rb +5 -5
- data/lib/ultracart_api/models/conversation_delete_knowledge_base_document_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_request.rb +219 -0
- data/lib/ultracart_api/models/conversation_insert_knowledge_base_document_response.rb +276 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document.rb +274 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url.rb +228 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_document_upload_url_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_knowledge_base_documents_response.rb +259 -0
- data/lib/ultracart_api/models/custom_report_account_config.rb +12 -1
- data/lib/ultracart_api/models/custom_report_usage_breakdown.rb +229 -0
- 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: 44bc8be8569bee54c55b590a94864d430c68b3ac0b9595dea7c25f6f9d7d9854
|
|
4
|
+
data.tar.gz: e6446c76acbb0ca2ba567b603a90165754e220ddfc8cfac87b94d09ea1655174
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c2a5618ccc5029a45537941568cb34fe0a4947cd305e0188165d9d754733c9af348ab3f2920599adfd50ba2adaf90dd796dea02e97e2760e6d1677780653ed0f
|
|
7
|
+
data.tar.gz: 2fb8ab2d8dd3ee10ed4ff42e9edbe1489c2306b53628952ee7dedd926efa95b4915637ca7cebadc5ef43851bdf74f4851c81142cb47cb195fd4f9705eb92890f
|
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.23
|
|
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.23'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -129,6 +129,7 @@ Class | Method | HTTP request | Description
|
|
|
129
129
|
*UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
|
|
130
130
|
*UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
|
|
131
131
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
132
|
+
*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
|
|
132
133
|
*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
|
|
133
134
|
*UltracartClient::ConversationApi* | [**delete_department**](docs/ConversationApi.md#delete_department) | **DELETE** /conversation/departments/{conversation_department_oid} | Delete a conversation department
|
|
134
135
|
*UltracartClient::ConversationApi* | [**delete_engagement**](docs/ConversationApi.md#delete_engagement) | **DELETE** /conversation/engagements/{conversation_engagement_oid} | Delete a conversation engagement
|
|
@@ -142,6 +143,7 @@ Class | Method | HTTP request | Description
|
|
|
142
143
|
*UltracartClient::ConversationApi* | [**delete_pbx_voicemail_mailbox**](docs/ConversationApi.md#delete_pbx_voicemail_mailbox) | **DELETE** /conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid} | Delete pbx voicemailMailbox
|
|
143
144
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
144
145
|
*UltracartClient::ConversationApi* | [**get_agent_profile**](docs/ConversationApi.md#get_agent_profile) | **GET** /conversation/agent/profile | Get agent profile
|
|
146
|
+
*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
|
|
145
147
|
*UltracartClient::ConversationApi* | [**get_agent_profiles**](docs/ConversationApi.md#get_agent_profiles) | **GET** /conversation/agent/profiles | Get agent profiles
|
|
146
148
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
147
149
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
@@ -151,6 +153,7 @@ Class | Method | HTTP request | Description
|
|
|
151
153
|
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
|
152
154
|
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
|
153
155
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
|
156
|
+
*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
|
|
154
157
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
155
158
|
*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
|
|
156
159
|
*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
|
|
@@ -184,6 +187,7 @@ Class | Method | HTTP request | Description
|
|
|
184
187
|
*UltracartClient::ConversationApi* | [**get_pbx_voicemail_mailboxes**](docs/ConversationApi.md#get_pbx_voicemail_mailboxes) | **GET** /conversation/pbx/voicemail_mailbox | Get pbx voicemailMailboxes
|
|
185
188
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_budget**](docs/ConversationApi.md#get_virtual_agent_budget) | **GET** /conversation/virtualagent/budget | Get virtual agent budget
|
|
186
189
|
*UltracartClient::ConversationApi* | [**get_virtual_agent_capabilities**](docs/ConversationApi.md#get_virtual_agent_capabilities) | **GET** /conversation/virtualagent/capabilities | Get virtual agent capabilities
|
|
190
|
+
*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
|
|
187
191
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
188
192
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
|
189
193
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
|
@@ -750,6 +754,7 @@ Class | Method | HTTP request | Description
|
|
|
750
754
|
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
|
751
755
|
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
|
752
756
|
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
|
757
|
+
- [UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse](docs/ConversationDeleteKnowledgeBaseDocumentResponse.md)
|
|
753
758
|
- [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
|
|
754
759
|
- [UltracartClient::ConversationDepartmentMember](docs/ConversationDepartmentMember.md)
|
|
755
760
|
- [UltracartClient::ConversationDepartmentMembersResponse](docs/ConversationDepartmentMembersResponse.md)
|
|
@@ -768,7 +773,13 @@ Class | Method | HTTP request | Description
|
|
|
768
773
|
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
|
769
774
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
|
770
775
|
- [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
|
|
776
|
+
- [UltracartClient::ConversationInsertKnowledgeBaseDocumentRequest](docs/ConversationInsertKnowledgeBaseDocumentRequest.md)
|
|
777
|
+
- [UltracartClient::ConversationInsertKnowledgeBaseDocumentResponse](docs/ConversationInsertKnowledgeBaseDocumentResponse.md)
|
|
771
778
|
- [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
|
|
779
|
+
- [UltracartClient::ConversationKnowledgeBaseDocument](docs/ConversationKnowledgeBaseDocument.md)
|
|
780
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentUploadUrl](docs/ConversationKnowledgeBaseDocumentUploadUrl.md)
|
|
781
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentUploadUrlResponse](docs/ConversationKnowledgeBaseDocumentUploadUrlResponse.md)
|
|
782
|
+
- [UltracartClient::ConversationKnowledgeBaseDocumentsResponse](docs/ConversationKnowledgeBaseDocumentsResponse.md)
|
|
772
783
|
- [UltracartClient::ConversationLocationCountry](docs/ConversationLocationCountry.md)
|
|
773
784
|
- [UltracartClient::ConversationLocationStateProvince](docs/ConversationLocationStateProvince.md)
|
|
774
785
|
- [UltracartClient::ConversationLocationsResponse](docs/ConversationLocationsResponse.md)
|
|
@@ -935,6 +946,7 @@ Class | Method | HTTP request | Description
|
|
|
935
946
|
- [UltracartClient::CustomReportQuery](docs/CustomReportQuery.md)
|
|
936
947
|
- [UltracartClient::CustomReportResponse](docs/CustomReportResponse.md)
|
|
937
948
|
- [UltracartClient::CustomReportTooltip](docs/CustomReportTooltip.md)
|
|
949
|
+
- [UltracartClient::CustomReportUsageBreakdown](docs/CustomReportUsageBreakdown.md)
|
|
938
950
|
- [UltracartClient::CustomReportsExecutionReportData](docs/CustomReportsExecutionReportData.md)
|
|
939
951
|
- [UltracartClient::CustomReportsExecutionRequest](docs/CustomReportsExecutionRequest.md)
|
|
940
952
|
- [UltracartClient::CustomReportsExecutionResponse](docs/CustomReportsExecutionResponse.md)
|
|
@@ -1575,6 +1587,7 @@ Not every change is committed to every SDK.
|
|
|
1575
1587
|
|
|
1576
1588
|
| Version | Date | Comments |
|
|
1577
1589
|
| --: | :-: | --- |
|
|
1590
|
+
| 4.1.23 | 10/14/2025 | CustomerApi.deleteWishlistItem bug fix for bad response type |
|
|
1578
1591
|
| 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
|
|
1579
1592
|
| 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
|
|
1580
1593
|
| 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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,60 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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
|
+
|
|
103
|
+
> <ConversationDeleteKnowledgeBaseDocumentResponse> delete_agent_profile_knowledge_base_document(user_id, document_uuid)
|
|
104
|
+
|
|
105
|
+
Delete a knowledge base document
|
|
106
|
+
|
|
107
|
+
Delete a knowledge base document
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### Examples
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
(No example for this operation).
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
#### Using the delete_agent_profile_knowledge_base_document_with_http_info variant
|
|
117
|
+
|
|
118
|
+
This returns an Array which contains the response data, status code and headers.
|
|
119
|
+
|
|
120
|
+
> <Array(<ConversationDeleteKnowledgeBaseDocumentResponse>, Integer, Hash)> delete_agent_profile_knowledge_base_document_with_http_info(user_id, document_uuid)
|
|
121
|
+
|
|
122
|
+
```ruby
|
|
123
|
+
begin
|
|
124
|
+
# Delete a knowledge base document
|
|
125
|
+
data, status_code, headers = api_instance.delete_agent_profile_knowledge_base_document_with_http_info(user_id, document_uuid)
|
|
126
|
+
p status_code # => 2xx
|
|
127
|
+
p headers # => { ... }
|
|
128
|
+
p data # => <ConversationDeleteKnowledgeBaseDocumentResponse>
|
|
129
|
+
rescue UltracartClient::ApiError => e
|
|
130
|
+
puts "Error when calling ConversationApi->delete_agent_profile_knowledge_base_document_with_http_info: #{e}"
|
|
131
|
+
end
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Parameters
|
|
135
|
+
|
|
136
|
+
| Name | Type | Description | Notes |
|
|
137
|
+
| ---- | ---- | ----------- | ----- |
|
|
138
|
+
| **user_id** | **Integer** | | |
|
|
139
|
+
| **document_uuid** | **String** | | |
|
|
140
|
+
|
|
141
|
+
### Return type
|
|
142
|
+
|
|
143
|
+
[**ConversationDeleteKnowledgeBaseDocumentResponse**](ConversationDeleteKnowledgeBaseDocumentResponse.md)
|
|
144
|
+
|
|
145
|
+
### Authorization
|
|
146
|
+
|
|
147
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
148
|
+
|
|
149
|
+
### HTTP request headers
|
|
150
|
+
|
|
151
|
+
- **Content-Type**: Not defined
|
|
152
|
+
- **Accept**: application/json
|
|
153
|
+
|
|
154
|
+
|
|
97
155
|
## delete_conversation_canned_message
|
|
98
156
|
|
|
99
157
|
> delete_conversation_canned_message(conversation_canned_message_oid)
|
|
@@ -793,6 +851,59 @@ This endpoint does not need any parameter.
|
|
|
793
851
|
- **Accept**: application/json
|
|
794
852
|
|
|
795
853
|
|
|
854
|
+
## get_agent_profile_knowledge_base
|
|
855
|
+
|
|
856
|
+
> <ConversationKnowledgeBaseDocumentsResponse> get_agent_profile_knowledge_base(user_id)
|
|
857
|
+
|
|
858
|
+
Get the list of knowledge base documents associated with this agent profile
|
|
859
|
+
|
|
860
|
+
Retrieve knowledge base documents
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
### Examples
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
(No example for this operation).
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
#### Using the get_agent_profile_knowledge_base_with_http_info variant
|
|
870
|
+
|
|
871
|
+
This returns an Array which contains the response data, status code and headers.
|
|
872
|
+
|
|
873
|
+
> <Array(<ConversationKnowledgeBaseDocumentsResponse>, Integer, Hash)> get_agent_profile_knowledge_base_with_http_info(user_id)
|
|
874
|
+
|
|
875
|
+
```ruby
|
|
876
|
+
begin
|
|
877
|
+
# Get the list of knowledge base documents associated with this agent profile
|
|
878
|
+
data, status_code, headers = api_instance.get_agent_profile_knowledge_base_with_http_info(user_id)
|
|
879
|
+
p status_code # => 2xx
|
|
880
|
+
p headers # => { ... }
|
|
881
|
+
p data # => <ConversationKnowledgeBaseDocumentsResponse>
|
|
882
|
+
rescue UltracartClient::ApiError => e
|
|
883
|
+
puts "Error when calling ConversationApi->get_agent_profile_knowledge_base_with_http_info: #{e}"
|
|
884
|
+
end
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
### Parameters
|
|
888
|
+
|
|
889
|
+
| Name | Type | Description | Notes |
|
|
890
|
+
| ---- | ---- | ----------- | ----- |
|
|
891
|
+
| **user_id** | **Integer** | | |
|
|
892
|
+
|
|
893
|
+
### Return type
|
|
894
|
+
|
|
895
|
+
[**ConversationKnowledgeBaseDocumentsResponse**](ConversationKnowledgeBaseDocumentsResponse.md)
|
|
896
|
+
|
|
897
|
+
### Authorization
|
|
898
|
+
|
|
899
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
900
|
+
|
|
901
|
+
### HTTP request headers
|
|
902
|
+
|
|
903
|
+
- **Content-Type**: Not defined
|
|
904
|
+
- **Accept**: application/json
|
|
905
|
+
|
|
906
|
+
|
|
796
907
|
## get_agent_profiles
|
|
797
908
|
|
|
798
909
|
> <ConversationAgentProfilesResponse> get_agent_profiles
|
|
@@ -1267,6 +1378,60 @@ This endpoint does not need any parameter.
|
|
|
1267
1378
|
- **Accept**: application/json
|
|
1268
1379
|
|
|
1269
1380
|
|
|
1381
|
+
## get_conversation_knowledge_base_document_upload_url
|
|
1382
|
+
|
|
1383
|
+
> <ConversationKnowledgeBaseDocumentUploadUrlResponse> get_conversation_knowledge_base_document_upload_url(user_id, extension)
|
|
1384
|
+
|
|
1385
|
+
Get a pre-signed conversation knowledge base document upload URL
|
|
1386
|
+
|
|
1387
|
+
Get a pre-signed conversation knowledge base document upload URL
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
### Examples
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
(No example for this operation).
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
#### Using the get_conversation_knowledge_base_document_upload_url_with_http_info variant
|
|
1397
|
+
|
|
1398
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1399
|
+
|
|
1400
|
+
> <Array(<ConversationKnowledgeBaseDocumentUploadUrlResponse>, Integer, Hash)> get_conversation_knowledge_base_document_upload_url_with_http_info(user_id, extension)
|
|
1401
|
+
|
|
1402
|
+
```ruby
|
|
1403
|
+
begin
|
|
1404
|
+
# Get a pre-signed conversation knowledge base document upload URL
|
|
1405
|
+
data, status_code, headers = api_instance.get_conversation_knowledge_base_document_upload_url_with_http_info(user_id, extension)
|
|
1406
|
+
p status_code # => 2xx
|
|
1407
|
+
p headers # => { ... }
|
|
1408
|
+
p data # => <ConversationKnowledgeBaseDocumentUploadUrlResponse>
|
|
1409
|
+
rescue UltracartClient::ApiError => e
|
|
1410
|
+
puts "Error when calling ConversationApi->get_conversation_knowledge_base_document_upload_url_with_http_info: #{e}"
|
|
1411
|
+
end
|
|
1412
|
+
```
|
|
1413
|
+
|
|
1414
|
+
### Parameters
|
|
1415
|
+
|
|
1416
|
+
| Name | Type | Description | Notes |
|
|
1417
|
+
| ---- | ---- | ----------- | ----- |
|
|
1418
|
+
| **user_id** | **Integer** | | |
|
|
1419
|
+
| **extension** | **String** | | |
|
|
1420
|
+
|
|
1421
|
+
### Return type
|
|
1422
|
+
|
|
1423
|
+
[**ConversationKnowledgeBaseDocumentUploadUrlResponse**](ConversationKnowledgeBaseDocumentUploadUrlResponse.md)
|
|
1424
|
+
|
|
1425
|
+
### Authorization
|
|
1426
|
+
|
|
1427
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1428
|
+
|
|
1429
|
+
### HTTP request headers
|
|
1430
|
+
|
|
1431
|
+
- **Content-Type**: Not defined
|
|
1432
|
+
- **Accept**: application/json
|
|
1433
|
+
|
|
1434
|
+
|
|
1270
1435
|
## get_conversation_messages
|
|
1271
1436
|
|
|
1272
1437
|
> <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
|
|
@@ -3025,6 +3190,60 @@ This endpoint does not need any parameter.
|
|
|
3025
3190
|
- **Accept**: application/json
|
|
3026
3191
|
|
|
3027
3192
|
|
|
3193
|
+
## insert_agent_profile_knowledge_base_document
|
|
3194
|
+
|
|
3195
|
+
> <ConversationInsertKnowledgeBaseDocumentResponse> insert_agent_profile_knowledge_base_document(user_id, knowledge_base_document_request)
|
|
3196
|
+
|
|
3197
|
+
Insert a knowledge base document
|
|
3198
|
+
|
|
3199
|
+
Insert a knowledge base document
|
|
3200
|
+
|
|
3201
|
+
|
|
3202
|
+
### Examples
|
|
3203
|
+
|
|
3204
|
+
|
|
3205
|
+
(No example for this operation).
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
#### Using the insert_agent_profile_knowledge_base_document_with_http_info variant
|
|
3209
|
+
|
|
3210
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3211
|
+
|
|
3212
|
+
> <Array(<ConversationInsertKnowledgeBaseDocumentResponse>, Integer, Hash)> insert_agent_profile_knowledge_base_document_with_http_info(user_id, knowledge_base_document_request)
|
|
3213
|
+
|
|
3214
|
+
```ruby
|
|
3215
|
+
begin
|
|
3216
|
+
# Insert a knowledge base document
|
|
3217
|
+
data, status_code, headers = api_instance.insert_agent_profile_knowledge_base_document_with_http_info(user_id, knowledge_base_document_request)
|
|
3218
|
+
p status_code # => 2xx
|
|
3219
|
+
p headers # => { ... }
|
|
3220
|
+
p data # => <ConversationInsertKnowledgeBaseDocumentResponse>
|
|
3221
|
+
rescue UltracartClient::ApiError => e
|
|
3222
|
+
puts "Error when calling ConversationApi->insert_agent_profile_knowledge_base_document_with_http_info: #{e}"
|
|
3223
|
+
end
|
|
3224
|
+
```
|
|
3225
|
+
|
|
3226
|
+
### Parameters
|
|
3227
|
+
|
|
3228
|
+
| Name | Type | Description | Notes |
|
|
3229
|
+
| ---- | ---- | ----------- | ----- |
|
|
3230
|
+
| **user_id** | **Integer** | | |
|
|
3231
|
+
| **knowledge_base_document_request** | [**ConversationInsertKnowledgeBaseDocumentRequest**](ConversationInsertKnowledgeBaseDocumentRequest.md) | Insert request | |
|
|
3232
|
+
|
|
3233
|
+
### Return type
|
|
3234
|
+
|
|
3235
|
+
[**ConversationInsertKnowledgeBaseDocumentResponse**](ConversationInsertKnowledgeBaseDocumentResponse.md)
|
|
3236
|
+
|
|
3237
|
+
### Authorization
|
|
3238
|
+
|
|
3239
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3240
|
+
|
|
3241
|
+
### HTTP request headers
|
|
3242
|
+
|
|
3243
|
+
- **Content-Type**: application/json
|
|
3244
|
+
- **Accept**: application/json
|
|
3245
|
+
|
|
3246
|
+
|
|
3028
3247
|
## insert_conversation_canned_message
|
|
3029
3248
|
|
|
3030
3249
|
> <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **document_id** | **String** | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationDeleteKnowledgeBaseDocumentResponse.new(
|
|
19
|
+
document_id: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::ConversationInsertKnowledgeBaseDocumentRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **presigned_url** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::ConversationInsertKnowledgeBaseDocumentRequest.new(
|
|
15
|
+
presigned_url: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::ConversationInsertKnowledgeBaseDocumentResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **document_uuid** | **String** | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **s3_key** | **String** | | [optional] |
|
|
11
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
12
|
+
| **vector_keys** | **Array<String>** | | [optional] |
|
|
13
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::ConversationInsertKnowledgeBaseDocumentResponse.new(
|
|
21
|
+
document_uuid: null,
|
|
22
|
+
error: null,
|
|
23
|
+
metadata: null,
|
|
24
|
+
s3_key: null,
|
|
25
|
+
success: null,
|
|
26
|
+
vector_keys: null,
|
|
27
|
+
warning: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocument
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **chunk_count** | **Integer** | | [optional] |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **document_id** | **String** | Human readable identifier. Filename is recommended. | [optional] |
|
|
10
|
+
| **document_uuid** | **String** | | [optional] |
|
|
11
|
+
| **metadata** | **String** | | [optional] |
|
|
12
|
+
| **mime_type** | **String** | | [optional] |
|
|
13
|
+
| **s3_key** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'ultracart_api'
|
|
19
|
+
|
|
20
|
+
instance = UltracartClient::ConversationKnowledgeBaseDocument.new(
|
|
21
|
+
chunk_count: null,
|
|
22
|
+
description: null,
|
|
23
|
+
document_id: null,
|
|
24
|
+
document_uuid: null,
|
|
25
|
+
metadata: null,
|
|
26
|
+
mime_type: null,
|
|
27
|
+
s3_key: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocumentUploadUrl
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | [optional] |
|
|
8
|
+
| **url** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::ConversationKnowledgeBaseDocumentUploadUrl.new(
|
|
16
|
+
key: null,
|
|
17
|
+
url: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocumentUploadUrlResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conversation_pbx_audio_upload_url** | [**ConversationKnowledgeBaseDocumentUploadUrl**](ConversationKnowledgeBaseDocumentUploadUrl.md) | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationKnowledgeBaseDocumentUploadUrlResponse.new(
|
|
19
|
+
conversation_pbx_audio_upload_url: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::ConversationKnowledgeBaseDocumentsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **documents** | [**Array<ConversationKnowledgeBaseDocument>**](ConversationKnowledgeBaseDocument.md) | documents | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::ConversationKnowledgeBaseDocumentsResponse.new(
|
|
19
|
+
documents: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **ai_budget** | **Float** | | [optional] |
|
|
8
8
|
| **ai_usage** | **Float** | Current AI usage creating reports | [optional] |
|
|
9
|
+
| **ai_usage_breakdowns** | [**Array<CustomReportUsageBreakdown>**](CustomReportUsageBreakdown.md) | | [optional] |
|
|
9
10
|
| **merchant_id** | **String** | Current BigQuery SQL usage running reports | [optional] |
|
|
10
11
|
| **novice_sql_comments** | **Boolean** | | [optional] |
|
|
11
12
|
| **opt_in** | **Boolean** | True if they have opted into custom reports | [optional] |
|
|
@@ -23,6 +24,7 @@ require 'ultracart_api'
|
|
|
23
24
|
instance = UltracartClient::CustomReportAccountConfig.new(
|
|
24
25
|
ai_budget: null,
|
|
25
26
|
ai_usage: null,
|
|
27
|
+
ai_usage_breakdowns: null,
|
|
26
28
|
merchant_id: null,
|
|
27
29
|
novice_sql_comments: null,
|
|
28
30
|
opt_in: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::CustomReportUsageBreakdown
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **usage** | **Float** | | [optional] |
|
|
8
|
+
| **usage_date** | **String** | Date/time that usage occurred | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::CustomReportUsageBreakdown.new(
|
|
16
|
+
usage: null,
|
|
17
|
+
usage_date: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/CustomerApi.md
CHANGED
|
@@ -321,7 +321,7 @@ nil (empty response body)
|
|
|
321
321
|
|
|
322
322
|
## delete_wish_list_item
|
|
323
323
|
|
|
324
|
-
>
|
|
324
|
+
> delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
|
325
325
|
|
|
326
326
|
Delete a customer wishlist item
|
|
327
327
|
|
|
@@ -424,9 +424,9 @@ end
|
|
|
424
424
|
|
|
425
425
|
#### Using the delete_wish_list_item_with_http_info variant
|
|
426
426
|
|
|
427
|
-
This returns an Array which contains the response data, status code and headers.
|
|
427
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
428
428
|
|
|
429
|
-
> <Array(
|
|
429
|
+
> <Array(nil, Integer, Hash)> delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
|
430
430
|
|
|
431
431
|
```ruby
|
|
432
432
|
begin
|
|
@@ -434,7 +434,7 @@ begin
|
|
|
434
434
|
data, status_code, headers = api_instance.delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
|
435
435
|
p status_code # => 2xx
|
|
436
436
|
p headers # => { ... }
|
|
437
|
-
p data # =>
|
|
437
|
+
p data # => nil
|
|
438
438
|
rescue UltracartClient::ApiError => e
|
|
439
439
|
puts "Error when calling CustomerApi->delete_wish_list_item_with_http_info: #{e}"
|
|
440
440
|
end
|
|
@@ -449,7 +449,7 @@ end
|
|
|
449
449
|
|
|
450
450
|
### Return type
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
nil (empty response body)
|
|
453
453
|
|
|
454
454
|
### Authorization
|
|
455
455
|
|