ultracart_rest_api_v2_typescript 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.
Files changed (39) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +3 -2
  3. package/dist/apis/ConversationApi.d.ts +115 -1
  4. package/dist/apis/ConversationApi.js +247 -0
  5. package/dist/apis/CustomerApi.d.ts +4 -4
  6. package/dist/apis/CustomerApi.js +3 -5
  7. package/dist/models/ConversationDeleteKnowledgeBaseDocumentResponse.d.ts +58 -0
  8. package/dist/models/ConversationDeleteKnowledgeBaseDocumentResponse.js +61 -0
  9. package/dist/models/ConversationInsertKnowledgeBaseDocumentRequest.d.ts +31 -0
  10. package/dist/models/ConversationInsertKnowledgeBaseDocumentRequest.js +50 -0
  11. package/dist/models/ConversationInsertKnowledgeBaseDocumentResponse.d.ts +70 -0
  12. package/dist/models/ConversationInsertKnowledgeBaseDocumentResponse.js +65 -0
  13. package/dist/models/ConversationKnowledgeBaseDocument.d.ts +67 -0
  14. package/dist/models/ConversationKnowledgeBaseDocument.js +62 -0
  15. package/dist/models/ConversationKnowledgeBaseDocumentUploadUrl.d.ts +37 -0
  16. package/dist/models/ConversationKnowledgeBaseDocumentUploadUrl.js +52 -0
  17. package/dist/models/ConversationKnowledgeBaseDocumentUploadUrlResponse.d.ts +59 -0
  18. package/dist/models/ConversationKnowledgeBaseDocumentUploadUrlResponse.js +62 -0
  19. package/dist/models/ConversationKnowledgeBaseDocumentsResponse.d.ts +59 -0
  20. package/dist/models/ConversationKnowledgeBaseDocumentsResponse.js +62 -0
  21. package/dist/models/CustomReportAccountConfig.d.ts +7 -0
  22. package/dist/models/CustomReportAccountConfig.js +3 -0
  23. package/dist/models/CustomReportUsageBreakdown.d.ts +37 -0
  24. package/dist/models/CustomReportUsageBreakdown.js +52 -0
  25. package/dist/models/index.d.ts +8 -0
  26. package/dist/models/index.js +8 -0
  27. package/package.json +1 -1
  28. package/src/apis/ConversationApi.ts +280 -0
  29. package/src/apis/CustomerApi.ts +6 -7
  30. package/src/models/ConversationDeleteKnowledgeBaseDocumentResponse.ts +118 -0
  31. package/src/models/ConversationInsertKnowledgeBaseDocumentRequest.ts +67 -0
  32. package/src/models/ConversationInsertKnowledgeBaseDocumentResponse.ts +134 -0
  33. package/src/models/ConversationKnowledgeBaseDocument.ts +115 -0
  34. package/src/models/ConversationKnowledgeBaseDocumentUploadUrl.ts +75 -0
  35. package/src/models/ConversationKnowledgeBaseDocumentUploadUrlResponse.ts +124 -0
  36. package/src/models/ConversationKnowledgeBaseDocumentsResponse.ts +124 -0
  37. package/src/models/CustomReportAccountConfig.ts +15 -0
  38. package/src/models/CustomReportUsageBreakdown.ts +75 -0
  39. package/src/models/index.ts +8 -0
@@ -164,6 +164,7 @@ src/models/ConversationCannedMessage.ts
164
164
  src/models/ConversationCannedMessageResponse.ts
165
165
  src/models/ConversationCannedMessagesResponse.ts
166
166
  src/models/ConversationCannedMessagesSearch.ts
167
+ src/models/ConversationDeleteKnowledgeBaseDocumentResponse.ts
167
168
  src/models/ConversationDepartment.ts
168
169
  src/models/ConversationDepartmentMember.ts
169
170
  src/models/ConversationDepartmentMembersResponse.ts
@@ -182,7 +183,13 @@ src/models/ConversationEventRRWeb.ts
182
183
  src/models/ConversationEventReadMessage.ts
183
184
  src/models/ConversationEventTyping.ts
184
185
  src/models/ConversationEventWebchatContext.ts
186
+ src/models/ConversationInsertKnowledgeBaseDocumentRequest.ts
187
+ src/models/ConversationInsertKnowledgeBaseDocumentResponse.ts
185
188
  src/models/ConversationJoinRequest.ts
189
+ src/models/ConversationKnowledgeBaseDocument.ts
190
+ src/models/ConversationKnowledgeBaseDocumentUploadUrl.ts
191
+ src/models/ConversationKnowledgeBaseDocumentUploadUrlResponse.ts
192
+ src/models/ConversationKnowledgeBaseDocumentsResponse.ts
186
193
  src/models/ConversationLocationCountry.ts
187
194
  src/models/ConversationLocationStateProvince.ts
188
195
  src/models/ConversationLocationsResponse.ts
@@ -349,6 +356,7 @@ src/models/CustomReportParameterOption.ts
349
356
  src/models/CustomReportQuery.ts
350
357
  src/models/CustomReportResponse.ts
351
358
  src/models/CustomReportTooltip.ts
359
+ src/models/CustomReportUsageBreakdown.ts
352
360
  src/models/CustomReportsExecutionReportData.ts
353
361
  src/models/CustomReportsExecutionRequest.ts
354
362
  src/models/CustomReportsExecutionResponse.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.22
2
+ ## ultracart_rest_api_v2_typescript@4.1.23
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.22 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.23 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -85,6 +85,7 @@ Not every change is committed to every SDK.
85
85
 
86
86
  | Version | Date | Comments |
87
87
  | --: | :-: | --- |
88
+ | 4.1.23 | 10/14/2025 | CustomerApi.deleteWishlistItem bug fix for bad response type |
88
89
  | 4.1.22 | 10/06/2025 | added Customer.fax back into object model |
89
90
  | 4.1.21 | 09/09/2025 | added OrderRestApi.replaceOrderItemMerchantItemId |
90
91
  | 4.1.20 | 08/18/2025 | storefront communiations - campaign repeat flags |
@@ -10,7 +10,11 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationJoinRequest, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
13
+ import { ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse } from '../models';
14
+ export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
15
+ userId: number;
16
+ documentUuid: string;
17
+ }
14
18
  export interface DeleteConversationCannedMessageRequest {
15
19
  conversationCannedMessageOid: number;
16
20
  }
@@ -45,6 +49,9 @@ export interface DeletePbxTimeRangeRequest {
45
49
  export interface DeletePbxVoicemailMailboxRequest {
46
50
  conversationPbxVoicemailMailboxUuid: string;
47
51
  }
52
+ export interface GetAgentProfileKnowledgeBaseRequest {
53
+ userId: number;
54
+ }
48
55
  export interface GetConversationRequest {
49
56
  conversationUuid: string;
50
57
  limit?: number;
@@ -55,6 +62,10 @@ export interface GetConversationContextRequest {
55
62
  export interface GetConversationEngagementRequest {
56
63
  conversationEngagementOid: number;
57
64
  }
65
+ export interface GetConversationKnowledgeBaseDocumentUploadUrlRequest {
66
+ userId: number;
67
+ extension: string;
68
+ }
58
69
  export interface GetConversationMessagesRequest {
59
70
  conversationUuid: string;
60
71
  since: number;
@@ -118,6 +129,10 @@ export interface GetPbxTimeRangeRequest {
118
129
  export interface GetPbxVoicemailMailboxRequest {
119
130
  conversationPbxVoicemailMailboxUuid: string;
120
131
  }
132
+ export interface InsertAgentProfileKnowledgeBaseDocumentRequest {
133
+ userId: number;
134
+ knowledgeBaseDocumentRequest: ConversationInsertKnowledgeBaseDocumentRequest;
135
+ }
121
136
  export interface InsertConversationCannedMessageRequest {
122
137
  cannedMessage: ConversationCannedMessage;
123
138
  }
@@ -238,6 +253,21 @@ export interface UpdateVirtualAgentCapabilitiesRequest {
238
253
  * @interface ConversationApiInterface
239
254
  */
240
255
  export interface ConversationApiInterface {
256
+ /**
257
+ * Delete a knowledge base document
258
+ * @summary Delete a knowledge base document
259
+ * @param {number} userId
260
+ * @param {string} documentUuid
261
+ * @param {*} [options] Override http request option.
262
+ * @throws {RequiredError}
263
+ * @memberof ConversationApiInterface
264
+ */
265
+ deleteAgentProfileKnowledgeBaseDocumentRaw(requestParameters: DeleteAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDeleteKnowledgeBaseDocumentResponse>>;
266
+ /**
267
+ * Delete a knowledge base document
268
+ * Delete a knowledge base document
269
+ */
270
+ deleteAgentProfileKnowledgeBaseDocument(requestParameters: DeleteAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDeleteKnowledgeBaseDocumentResponse>;
241
271
  /**
242
272
  * Delete a conversation canned message
243
273
  * @summary Delete a conversation canned message
@@ -419,6 +449,20 @@ export interface ConversationApiInterface {
419
449
  * Get agent profile
420
450
  */
421
451
  getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
452
+ /**
453
+ * Retrieve knowledge base documents
454
+ * @summary Get the list of knowledge base documents associated with this agent profile
455
+ * @param {number} userId
456
+ * @param {*} [options] Override http request option.
457
+ * @throws {RequiredError}
458
+ * @memberof ConversationApiInterface
459
+ */
460
+ getAgentProfileKnowledgeBaseRaw(requestParameters: GetAgentProfileKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationKnowledgeBaseDocumentsResponse>>;
461
+ /**
462
+ * Retrieve knowledge base documents
463
+ * Get the list of knowledge base documents associated with this agent profile
464
+ */
465
+ getAgentProfileKnowledgeBase(requestParameters: GetAgentProfileKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationKnowledgeBaseDocumentsResponse>;
422
466
  /**
423
467
  * Retrieve the agents profile
424
468
  * @summary Get agent profiles
@@ -540,6 +584,21 @@ export interface ConversationApiInterface {
540
584
  * Retrieve a list of engagements ordered by name
541
585
  */
542
586
  getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
587
+ /**
588
+ * Get a pre-signed conversation knowledge base document upload URL
589
+ * @summary Get a pre-signed conversation knowledge base document upload URL
590
+ * @param {number} userId
591
+ * @param {string} extension
592
+ * @param {*} [options] Override http request option.
593
+ * @throws {RequiredError}
594
+ * @memberof ConversationApiInterface
595
+ */
596
+ getConversationKnowledgeBaseDocumentUploadUrlRaw(requestParameters: GetConversationKnowledgeBaseDocumentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationKnowledgeBaseDocumentUploadUrlResponse>>;
597
+ /**
598
+ * Get a pre-signed conversation knowledge base document upload URL
599
+ * Get a pre-signed conversation knowledge base document upload URL
600
+ */
601
+ getConversationKnowledgeBaseDocumentUploadUrl(requestParameters: GetConversationKnowledgeBaseDocumentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationKnowledgeBaseDocumentUploadUrlResponse>;
543
602
  /**
544
603
  * Retrieve conversation messages since a particular time
545
604
  * @summary Retrieve conversation messages
@@ -994,6 +1053,21 @@ export interface ConversationApiInterface {
994
1053
  * Get virtual agent capabilities
995
1054
  */
996
1055
  getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
1056
+ /**
1057
+ * Insert a knowledge base document
1058
+ * @summary Insert a knowledge base document
1059
+ * @param {number} userId
1060
+ * @param {ConversationInsertKnowledgeBaseDocumentRequest} knowledgeBaseDocumentRequest Insert request
1061
+ * @param {*} [options] Override http request option.
1062
+ * @throws {RequiredError}
1063
+ * @memberof ConversationApiInterface
1064
+ */
1065
+ insertAgentProfileKnowledgeBaseDocumentRaw(requestParameters: InsertAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationInsertKnowledgeBaseDocumentResponse>>;
1066
+ /**
1067
+ * Insert a knowledge base document
1068
+ * Insert a knowledge base document
1069
+ */
1070
+ insertAgentProfileKnowledgeBaseDocument(requestParameters: InsertAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationInsertKnowledgeBaseDocumentResponse>;
997
1071
  /**
998
1072
  * Insert a canned message
999
1073
  * @summary Insert a canned message
@@ -1475,6 +1549,16 @@ export interface ConversationApiInterface {
1475
1549
  *
1476
1550
  */
1477
1551
  export declare class ConversationApi extends runtime.BaseAPI implements ConversationApiInterface {
1552
+ /**
1553
+ * Delete a knowledge base document
1554
+ * Delete a knowledge base document
1555
+ */
1556
+ deleteAgentProfileKnowledgeBaseDocumentRaw(requestParameters: DeleteAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationDeleteKnowledgeBaseDocumentResponse>>;
1557
+ /**
1558
+ * Delete a knowledge base document
1559
+ * Delete a knowledge base document
1560
+ */
1561
+ deleteAgentProfileKnowledgeBaseDocument(requestParameters: DeleteAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationDeleteKnowledgeBaseDocumentResponse>;
1478
1562
  /**
1479
1563
  * Delete a conversation canned message
1480
1564
  * Delete a conversation canned message
@@ -1605,6 +1689,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1605
1689
  * Get agent profile
1606
1690
  */
1607
1691
  getAgentProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
1692
+ /**
1693
+ * Retrieve knowledge base documents
1694
+ * Get the list of knowledge base documents associated with this agent profile
1695
+ */
1696
+ getAgentProfileKnowledgeBaseRaw(requestParameters: GetAgentProfileKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationKnowledgeBaseDocumentsResponse>>;
1697
+ /**
1698
+ * Retrieve knowledge base documents
1699
+ * Get the list of knowledge base documents associated with this agent profile
1700
+ */
1701
+ getAgentProfileKnowledgeBase(requestParameters: GetAgentProfileKnowledgeBaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationKnowledgeBaseDocumentsResponse>;
1608
1702
  /**
1609
1703
  * Retrieve the agents profile
1610
1704
  * Get agent profiles
@@ -1695,6 +1789,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
1695
1789
  * Retrieve a list of engagements ordered by name
1696
1790
  */
1697
1791
  getConversationEngagements(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationEngagementsResponse>;
1792
+ /**
1793
+ * Get a pre-signed conversation knowledge base document upload URL
1794
+ * Get a pre-signed conversation knowledge base document upload URL
1795
+ */
1796
+ getConversationKnowledgeBaseDocumentUploadUrlRaw(requestParameters: GetConversationKnowledgeBaseDocumentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationKnowledgeBaseDocumentUploadUrlResponse>>;
1797
+ /**
1798
+ * Get a pre-signed conversation knowledge base document upload URL
1799
+ * Get a pre-signed conversation knowledge base document upload URL
1800
+ */
1801
+ getConversationKnowledgeBaseDocumentUploadUrl(requestParameters: GetConversationKnowledgeBaseDocumentUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationKnowledgeBaseDocumentUploadUrlResponse>;
1698
1802
  /**
1699
1803
  * Retrieve conversation messages since a particular time
1700
1804
  * Retrieve conversation messages
@@ -2025,6 +2129,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
2025
2129
  * Get virtual agent capabilities
2026
2130
  */
2027
2131
  getVirtualAgentCapabilities(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationVirtualAgentCapabilitiesResponse>;
2132
+ /**
2133
+ * Insert a knowledge base document
2134
+ * Insert a knowledge base document
2135
+ */
2136
+ insertAgentProfileKnowledgeBaseDocumentRaw(requestParameters: InsertAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationInsertKnowledgeBaseDocumentResponse>>;
2137
+ /**
2138
+ * Insert a knowledge base document
2139
+ * Insert a knowledge base document
2140
+ */
2141
+ insertAgentProfileKnowledgeBaseDocument(requestParameters: InsertAgentProfileKnowledgeBaseDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationInsertKnowledgeBaseDocumentResponse>;
2028
2142
  /**
2029
2143
  * Insert a canned message
2030
2144
  * Insert a canned message
@@ -75,6 +75,68 @@ var ConversationApi = /** @class */ (function (_super) {
75
75
  function ConversationApi() {
76
76
  return _super !== null && _super.apply(this, arguments) || this;
77
77
  }
78
+ /**
79
+ * Delete a knowledge base document
80
+ * Delete a knowledge base document
81
+ */
82
+ ConversationApi.prototype.deleteAgentProfileKnowledgeBaseDocumentRaw = function (requestParameters, initOverrides) {
83
+ return __awaiter(this, void 0, void 0, function () {
84
+ var queryParameters, headerParameters, _a, _b, response;
85
+ return __generator(this, function (_c) {
86
+ switch (_c.label) {
87
+ case 0:
88
+ if (requestParameters.userId === null || requestParameters.userId === undefined) {
89
+ throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling deleteAgentProfileKnowledgeBaseDocument.');
90
+ }
91
+ if (requestParameters.documentUuid === null || requestParameters.documentUuid === undefined) {
92
+ throw new runtime.RequiredError('documentUuid', 'Required parameter requestParameters.documentUuid was null or undefined when calling deleteAgentProfileKnowledgeBaseDocument.');
93
+ }
94
+ queryParameters = {};
95
+ headerParameters = {};
96
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
97
+ // oauth required
98
+ _a = headerParameters;
99
+ _b = "Authorization";
100
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
101
+ case 1:
102
+ // oauth required
103
+ _a[_b] = _c.sent();
104
+ _c.label = 2;
105
+ case 2:
106
+ if (this.configuration && this.configuration.apiKey) {
107
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
108
+ }
109
+ return [4 /*yield*/, this.request({
110
+ path: "/conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid}".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("document_uuid", "}"), encodeURIComponent(String(requestParameters.documentUuid))),
111
+ method: 'DELETE',
112
+ headers: headerParameters,
113
+ query: queryParameters,
114
+ }, initOverrides)];
115
+ case 3:
116
+ response = _c.sent();
117
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationDeleteKnowledgeBaseDocumentResponseFromJSON)(jsonValue); })];
118
+ }
119
+ });
120
+ });
121
+ };
122
+ /**
123
+ * Delete a knowledge base document
124
+ * Delete a knowledge base document
125
+ */
126
+ ConversationApi.prototype.deleteAgentProfileKnowledgeBaseDocument = function (requestParameters, initOverrides) {
127
+ return __awaiter(this, void 0, void 0, function () {
128
+ var response;
129
+ return __generator(this, function (_a) {
130
+ switch (_a.label) {
131
+ case 0: return [4 /*yield*/, this.deleteAgentProfileKnowledgeBaseDocumentRaw(requestParameters, initOverrides)];
132
+ case 1:
133
+ response = _a.sent();
134
+ return [4 /*yield*/, response.value()];
135
+ case 2: return [2 /*return*/, _a.sent()];
136
+ }
137
+ });
138
+ });
139
+ };
78
140
  /**
79
141
  * Delete a conversation canned message
80
142
  * Delete a conversation canned message
@@ -827,6 +889,65 @@ var ConversationApi = /** @class */ (function (_super) {
827
889
  });
828
890
  });
829
891
  };
892
+ /**
893
+ * Retrieve knowledge base documents
894
+ * Get the list of knowledge base documents associated with this agent profile
895
+ */
896
+ ConversationApi.prototype.getAgentProfileKnowledgeBaseRaw = function (requestParameters, initOverrides) {
897
+ return __awaiter(this, void 0, void 0, function () {
898
+ var queryParameters, headerParameters, _a, _b, response;
899
+ return __generator(this, function (_c) {
900
+ switch (_c.label) {
901
+ case 0:
902
+ if (requestParameters.userId === null || requestParameters.userId === undefined) {
903
+ throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling getAgentProfileKnowledgeBase.');
904
+ }
905
+ queryParameters = {};
906
+ headerParameters = {};
907
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
908
+ // oauth required
909
+ _a = headerParameters;
910
+ _b = "Authorization";
911
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_read"])];
912
+ case 1:
913
+ // oauth required
914
+ _a[_b] = _c.sent();
915
+ _c.label = 2;
916
+ case 2:
917
+ if (this.configuration && this.configuration.apiKey) {
918
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
919
+ }
920
+ return [4 /*yield*/, this.request({
921
+ path: "/conversation/agent/profiles/{user_id}/knowledge_base".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))),
922
+ method: 'GET',
923
+ headers: headerParameters,
924
+ query: queryParameters,
925
+ }, initOverrides)];
926
+ case 3:
927
+ response = _c.sent();
928
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationKnowledgeBaseDocumentsResponseFromJSON)(jsonValue); })];
929
+ }
930
+ });
931
+ });
932
+ };
933
+ /**
934
+ * Retrieve knowledge base documents
935
+ * Get the list of knowledge base documents associated with this agent profile
936
+ */
937
+ ConversationApi.prototype.getAgentProfileKnowledgeBase = function (requestParameters, initOverrides) {
938
+ return __awaiter(this, void 0, void 0, function () {
939
+ var response;
940
+ return __generator(this, function (_a) {
941
+ switch (_a.label) {
942
+ case 0: return [4 /*yield*/, this.getAgentProfileKnowledgeBaseRaw(requestParameters, initOverrides)];
943
+ case 1:
944
+ response = _a.sent();
945
+ return [4 /*yield*/, response.value()];
946
+ case 2: return [2 /*return*/, _a.sent()];
947
+ }
948
+ });
949
+ });
950
+ };
830
951
  /**
831
952
  * Retrieve the agents profile
832
953
  * Get agent profiles
@@ -1343,6 +1464,68 @@ var ConversationApi = /** @class */ (function (_super) {
1343
1464
  });
1344
1465
  });
1345
1466
  };
1467
+ /**
1468
+ * Get a pre-signed conversation knowledge base document upload URL
1469
+ * Get a pre-signed conversation knowledge base document upload URL
1470
+ */
1471
+ ConversationApi.prototype.getConversationKnowledgeBaseDocumentUploadUrlRaw = function (requestParameters, initOverrides) {
1472
+ return __awaiter(this, void 0, void 0, function () {
1473
+ var queryParameters, headerParameters, _a, _b, response;
1474
+ return __generator(this, function (_c) {
1475
+ switch (_c.label) {
1476
+ case 0:
1477
+ if (requestParameters.userId === null || requestParameters.userId === undefined) {
1478
+ throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling getConversationKnowledgeBaseDocumentUploadUrl.');
1479
+ }
1480
+ if (requestParameters.extension === null || requestParameters.extension === undefined) {
1481
+ throw new runtime.RequiredError('extension', 'Required parameter requestParameters.extension was null or undefined when calling getConversationKnowledgeBaseDocumentUploadUrl.');
1482
+ }
1483
+ queryParameters = {};
1484
+ headerParameters = {};
1485
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
1486
+ // oauth required
1487
+ _a = headerParameters;
1488
+ _b = "Authorization";
1489
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
1490
+ case 1:
1491
+ // oauth required
1492
+ _a[_b] = _c.sent();
1493
+ _c.label = 2;
1494
+ case 2:
1495
+ if (this.configuration && this.configuration.apiKey) {
1496
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
1497
+ }
1498
+ return [4 /*yield*/, this.request({
1499
+ path: "/conversation//rest/v2/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("extension", "}"), encodeURIComponent(String(requestParameters.extension))),
1500
+ method: 'GET',
1501
+ headers: headerParameters,
1502
+ query: queryParameters,
1503
+ }, initOverrides)];
1504
+ case 3:
1505
+ response = _c.sent();
1506
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationKnowledgeBaseDocumentUploadUrlResponseFromJSON)(jsonValue); })];
1507
+ }
1508
+ });
1509
+ });
1510
+ };
1511
+ /**
1512
+ * Get a pre-signed conversation knowledge base document upload URL
1513
+ * Get a pre-signed conversation knowledge base document upload URL
1514
+ */
1515
+ ConversationApi.prototype.getConversationKnowledgeBaseDocumentUploadUrl = function (requestParameters, initOverrides) {
1516
+ return __awaiter(this, void 0, void 0, function () {
1517
+ var response;
1518
+ return __generator(this, function (_a) {
1519
+ switch (_a.label) {
1520
+ case 0: return [4 /*yield*/, this.getConversationKnowledgeBaseDocumentUploadUrlRaw(requestParameters, initOverrides)];
1521
+ case 1:
1522
+ response = _a.sent();
1523
+ return [4 /*yield*/, response.value()];
1524
+ case 2: return [2 /*return*/, _a.sent()];
1525
+ }
1526
+ });
1527
+ });
1528
+ };
1346
1529
  /**
1347
1530
  * Retrieve conversation messages since a particular time
1348
1531
  * Retrieve conversation messages
@@ -3273,6 +3456,70 @@ var ConversationApi = /** @class */ (function (_super) {
3273
3456
  });
3274
3457
  });
3275
3458
  };
3459
+ /**
3460
+ * Insert a knowledge base document
3461
+ * Insert a knowledge base document
3462
+ */
3463
+ ConversationApi.prototype.insertAgentProfileKnowledgeBaseDocumentRaw = function (requestParameters, initOverrides) {
3464
+ return __awaiter(this, void 0, void 0, function () {
3465
+ var queryParameters, headerParameters, _a, _b, response;
3466
+ return __generator(this, function (_c) {
3467
+ switch (_c.label) {
3468
+ case 0:
3469
+ if (requestParameters.userId === null || requestParameters.userId === undefined) {
3470
+ throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling insertAgentProfileKnowledgeBaseDocument.');
3471
+ }
3472
+ if (requestParameters.knowledgeBaseDocumentRequest === null || requestParameters.knowledgeBaseDocumentRequest === undefined) {
3473
+ throw new runtime.RequiredError('knowledgeBaseDocumentRequest', 'Required parameter requestParameters.knowledgeBaseDocumentRequest was null or undefined when calling insertAgentProfileKnowledgeBaseDocument.');
3474
+ }
3475
+ queryParameters = {};
3476
+ headerParameters = {};
3477
+ headerParameters['Content-Type'] = 'application/json';
3478
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3479
+ // oauth required
3480
+ _a = headerParameters;
3481
+ _b = "Authorization";
3482
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["conversation_write"])];
3483
+ case 1:
3484
+ // oauth required
3485
+ _a[_b] = _c.sent();
3486
+ _c.label = 2;
3487
+ case 2:
3488
+ if (this.configuration && this.configuration.apiKey) {
3489
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
3490
+ }
3491
+ return [4 /*yield*/, this.request({
3492
+ path: "/conversation/agent/profiles/{user_id}/knowledge_base".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))),
3493
+ method: 'POST',
3494
+ headers: headerParameters,
3495
+ query: queryParameters,
3496
+ body: (0, models_1.ConversationInsertKnowledgeBaseDocumentRequestToJSON)(requestParameters.knowledgeBaseDocumentRequest),
3497
+ }, initOverrides)];
3498
+ case 3:
3499
+ response = _c.sent();
3500
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationInsertKnowledgeBaseDocumentResponseFromJSON)(jsonValue); })];
3501
+ }
3502
+ });
3503
+ });
3504
+ };
3505
+ /**
3506
+ * Insert a knowledge base document
3507
+ * Insert a knowledge base document
3508
+ */
3509
+ ConversationApi.prototype.insertAgentProfileKnowledgeBaseDocument = function (requestParameters, initOverrides) {
3510
+ return __awaiter(this, void 0, void 0, function () {
3511
+ var response;
3512
+ return __generator(this, function (_a) {
3513
+ switch (_a.label) {
3514
+ case 0: return [4 /*yield*/, this.insertAgentProfileKnowledgeBaseDocumentRaw(requestParameters, initOverrides)];
3515
+ case 1:
3516
+ response = _a.sent();
3517
+ return [4 /*yield*/, response.value()];
3518
+ case 2: return [2 /*return*/, _a.sent()];
3519
+ }
3520
+ });
3521
+ });
3522
+ };
3276
3523
  /**
3277
3524
  * Insert a canned message
3278
3525
  * Insert a canned message
@@ -189,12 +189,12 @@ export interface CustomerApiInterface {
189
189
  * @throws {RequiredError}
190
190
  * @memberof CustomerApiInterface
191
191
  */
192
- deleteWishListItemRaw(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerWishListItem>>;
192
+ deleteWishListItemRaw(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
193
193
  /**
194
194
  * Delete a customer wishlist item
195
195
  * Delete a customer wishlist item
196
196
  */
197
- deleteWishListItem(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerWishListItem>;
197
+ deleteWishListItem(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
198
198
  /**
199
199
  * Retrieves a single customer using the specified customer profile oid.
200
200
  * @summary Retrieve a customer
@@ -560,12 +560,12 @@ export declare class CustomerApi extends runtime.BaseAPI implements CustomerApiI
560
560
  * Delete a customer wishlist item
561
561
  * Delete a customer wishlist item
562
562
  */
563
- deleteWishListItemRaw(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CustomerWishListItem>>;
563
+ deleteWishListItemRaw(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
564
564
  /**
565
565
  * Delete a customer wishlist item
566
566
  * Delete a customer wishlist item
567
567
  */
568
- deleteWishListItem(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CustomerWishListItem>;
568
+ deleteWishListItem(requestParameters: DeleteWishListItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
569
569
  /**
570
570
  * Retrieves a single customer using the specified customer profile oid.
571
571
  * Retrieve a customer
@@ -299,7 +299,7 @@ var CustomerApi = /** @class */ (function (_super) {
299
299
  }, initOverrides)];
300
300
  case 3:
301
301
  response = _c.sent();
302
- return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.CustomerWishListItemFromJSON)(jsonValue); })];
302
+ return [2 /*return*/, new runtime.VoidApiResponse(response)];
303
303
  }
304
304
  });
305
305
  });
@@ -310,14 +310,12 @@ var CustomerApi = /** @class */ (function (_super) {
310
310
  */
311
311
  CustomerApi.prototype.deleteWishListItem = function (requestParameters, initOverrides) {
312
312
  return __awaiter(this, void 0, void 0, function () {
313
- var response;
314
313
  return __generator(this, function (_a) {
315
314
  switch (_a.label) {
316
315
  case 0: return [4 /*yield*/, this.deleteWishListItemRaw(requestParameters, initOverrides)];
317
316
  case 1:
318
- response = _a.sent();
319
- return [4 /*yield*/, response.value()];
320
- case 2: return [2 /*return*/, _a.sent()];
317
+ _a.sent();
318
+ return [2 /*return*/];
321
319
  }
322
320
  });
323
321
  });
@@ -0,0 +1,58 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { ModelError } from './ModelError';
13
+ import { ResponseMetadata } from './ResponseMetadata';
14
+ import { Warning } from './Warning';
15
+ /**
16
+ *
17
+ * @export
18
+ * @interface ConversationDeleteKnowledgeBaseDocumentResponse
19
+ */
20
+ export interface ConversationDeleteKnowledgeBaseDocumentResponse {
21
+ /**
22
+ *
23
+ * @type {string}
24
+ * @memberof ConversationDeleteKnowledgeBaseDocumentResponse
25
+ */
26
+ document_id?: string;
27
+ /**
28
+ *
29
+ * @type {ModelError}
30
+ * @memberof ConversationDeleteKnowledgeBaseDocumentResponse
31
+ */
32
+ error?: ModelError;
33
+ /**
34
+ *
35
+ * @type {ResponseMetadata}
36
+ * @memberof ConversationDeleteKnowledgeBaseDocumentResponse
37
+ */
38
+ metadata?: ResponseMetadata;
39
+ /**
40
+ * Indicates if API call was successful
41
+ * @type {boolean}
42
+ * @memberof ConversationDeleteKnowledgeBaseDocumentResponse
43
+ */
44
+ success?: boolean;
45
+ /**
46
+ *
47
+ * @type {Warning}
48
+ * @memberof ConversationDeleteKnowledgeBaseDocumentResponse
49
+ */
50
+ warning?: Warning;
51
+ }
52
+ /**
53
+ * Check if a given object implements the ConversationDeleteKnowledgeBaseDocumentResponse interface.
54
+ */
55
+ export declare function instanceOfConversationDeleteKnowledgeBaseDocumentResponse(value: object): boolean;
56
+ export declare function ConversationDeleteKnowledgeBaseDocumentResponseFromJSON(json: any): ConversationDeleteKnowledgeBaseDocumentResponse;
57
+ export declare function ConversationDeleteKnowledgeBaseDocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationDeleteKnowledgeBaseDocumentResponse;
58
+ export declare function ConversationDeleteKnowledgeBaseDocumentResponseToJSON(value?: ConversationDeleteKnowledgeBaseDocumentResponse | null): any;