ultracart_rest_api_v2_typescript 4.1.80 → 4.1.83
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.
- package/.openapi-generator/FILES +19 -0
- package/README.md +5 -2
- package/dist/apis/ConversationApi.d.ts +310 -1
- package/dist/apis/ConversationApi.js +693 -1
- package/dist/models/AgentSummary.d.ts +67 -0
- package/dist/models/AgentSummary.js +62 -0
- package/dist/models/AutoOrderItemCancelRequest.d.ts +8 -1
- package/dist/models/AutoOrderItemCancelRequest.js +3 -0
- package/dist/models/ConversationAgentCallEvent.d.ts +75 -0
- package/dist/models/ConversationAgentCallEvent.js +69 -0
- package/dist/models/ConversationAgentChatEvent.d.ts +55 -0
- package/dist/models/ConversationAgentChatEvent.js +58 -0
- package/dist/models/ConversationAgentStatusConfig.d.ts +121 -0
- package/dist/models/ConversationAgentStatusConfig.js +90 -0
- package/dist/models/ConversationAgentStatusConfigResponse.d.ts +59 -0
- package/dist/models/ConversationAgentStatusConfigResponse.js +62 -0
- package/dist/models/ConversationAgentStatusConfigsResponse.d.ts +59 -0
- package/dist/models/ConversationAgentStatusConfigsResponse.js +62 -0
- package/dist/models/ConversationAgentStatusEvent.d.ts +170 -0
- package/dist/models/ConversationAgentStatusEvent.js +120 -0
- package/dist/models/ConversationAgentStatusHeatmapRequest.d.ts +66 -0
- package/dist/models/ConversationAgentStatusHeatmapRequest.js +71 -0
- package/dist/models/ConversationAgentStatusHeatmapResponse.d.ts +70 -0
- package/dist/models/ConversationAgentStatusHeatmapResponse.js +65 -0
- package/dist/models/ConversationAgentStatusHistorySearchRequest.d.ts +78 -0
- package/dist/models/ConversationAgentStatusHistorySearchRequest.js +75 -0
- package/dist/models/ConversationAgentStatusHistorySearchResponse.d.ts +65 -0
- package/dist/models/ConversationAgentStatusHistorySearchResponse.js +64 -0
- package/dist/models/ConversationAgentStatusRollup.d.ts +99 -0
- package/dist/models/ConversationAgentStatusRollup.js +77 -0
- package/dist/models/ConversationAgentStatusRollupSearchRequest.d.ts +57 -0
- package/dist/models/ConversationAgentStatusRollupSearchRequest.js +63 -0
- package/dist/models/ConversationAgentStatusRollupSearchResponse.d.ts +59 -0
- package/dist/models/ConversationAgentStatusRollupSearchResponse.js +62 -0
- package/dist/models/ConversationAgentStatusSummaryResponse.d.ts +77 -0
- package/dist/models/ConversationAgentStatusSummaryResponse.js +68 -0
- package/dist/models/ConversationAgentStatusTimelineResponse.d.ts +80 -0
- package/dist/models/ConversationAgentStatusTimelineResponse.js +71 -0
- package/dist/models/ConversationPbxCallAgent.d.ts +6 -0
- package/dist/models/ConversationPbxCallAgent.js +2 -0
- package/dist/models/ConversationPbxDefaultTimezoneResponse.d.ts +58 -0
- package/dist/models/ConversationPbxDefaultTimezoneResponse.js +61 -0
- package/dist/models/ConversationPbxDefaultTimezoneUpdateRequest.d.ts +31 -0
- package/dist/models/ConversationPbxDefaultTimezoneUpdateRequest.js +50 -0
- package/dist/models/ConversationWebchatQueueStatusAgent.d.ts +18 -0
- package/dist/models/ConversationWebchatQueueStatusAgent.js +6 -0
- package/dist/models/ConversationWebchatQueueStatusUpdateRequest.d.ts +12 -0
- package/dist/models/ConversationWebchatQueueStatusUpdateRequest.js +4 -0
- package/dist/models/TimelineSummary.d.ts +55 -0
- package/dist/models/TimelineSummary.js +58 -0
- package/dist/models/index.d.ts +19 -0
- package/dist/models/index.js +19 -0
- package/package.json +1 -1
- package/src/apis/ConversationApi.ts +781 -0
- package/src/models/AgentSummary.ts +115 -0
- package/src/models/AutoOrderItemCancelRequest.ts +16 -1
- package/src/models/ConversationAgentCallEvent.ts +125 -0
- package/src/models/ConversationAgentChatEvent.ts +99 -0
- package/src/models/ConversationAgentStatusConfig.ts +184 -0
- package/src/models/ConversationAgentStatusConfigResponse.ts +124 -0
- package/src/models/ConversationAgentStatusConfigsResponse.ts +124 -0
- package/src/models/ConversationAgentStatusEvent.ts +244 -0
- package/src/models/ConversationAgentStatusHeatmapRequest.ts +111 -0
- package/src/models/ConversationAgentStatusHeatmapResponse.ts +134 -0
- package/src/models/ConversationAgentStatusHistorySearchRequest.ts +127 -0
- package/src/models/ConversationAgentStatusHistorySearchResponse.ts +132 -0
- package/src/models/ConversationAgentStatusRollup.ts +157 -0
- package/src/models/ConversationAgentStatusRollupSearchRequest.ts +101 -0
- package/src/models/ConversationAgentStatusRollupSearchResponse.ts +124 -0
- package/src/models/ConversationAgentStatusSummaryResponse.ts +148 -0
- package/src/models/ConversationAgentStatusTimelineResponse.ts +166 -0
- package/src/models/ConversationPbxCallAgent.ts +8 -0
- package/src/models/ConversationPbxDefaultTimezoneResponse.ts +118 -0
- package/src/models/ConversationPbxDefaultTimezoneUpdateRequest.ts +67 -0
- package/src/models/ConversationWebchatQueueStatusAgent.ts +24 -0
- package/src/models/ConversationWebchatQueueStatusUpdateRequest.ts +16 -0
- package/src/models/TimelineSummary.ts +99 -0
- package/src/models/index.ts +19 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -44,6 +44,7 @@ src/models/AffiliateLedger.ts
|
|
|
44
44
|
src/models/AffiliateLedgerQuery.ts
|
|
45
45
|
src/models/AffiliateLedgersResponse.ts
|
|
46
46
|
src/models/AffiliateLink.ts
|
|
47
|
+
src/models/AgentSummary.ts
|
|
47
48
|
src/models/ApiUserApplicationProfile.ts
|
|
48
49
|
src/models/ApplyLibraryItemRequest.ts
|
|
49
50
|
src/models/ApplyLibraryItemResponse.ts
|
|
@@ -161,9 +162,24 @@ src/models/Conversation.ts
|
|
|
161
162
|
src/models/ConversationAgentAuth.ts
|
|
162
163
|
src/models/ConversationAgentAuthMerchant.ts
|
|
163
164
|
src/models/ConversationAgentAuthResponse.ts
|
|
165
|
+
src/models/ConversationAgentCallEvent.ts
|
|
166
|
+
src/models/ConversationAgentChatEvent.ts
|
|
164
167
|
src/models/ConversationAgentProfile.ts
|
|
165
168
|
src/models/ConversationAgentProfileResponse.ts
|
|
166
169
|
src/models/ConversationAgentProfilesResponse.ts
|
|
170
|
+
src/models/ConversationAgentStatusConfig.ts
|
|
171
|
+
src/models/ConversationAgentStatusConfigResponse.ts
|
|
172
|
+
src/models/ConversationAgentStatusConfigsResponse.ts
|
|
173
|
+
src/models/ConversationAgentStatusEvent.ts
|
|
174
|
+
src/models/ConversationAgentStatusHeatmapRequest.ts
|
|
175
|
+
src/models/ConversationAgentStatusHeatmapResponse.ts
|
|
176
|
+
src/models/ConversationAgentStatusHistorySearchRequest.ts
|
|
177
|
+
src/models/ConversationAgentStatusHistorySearchResponse.ts
|
|
178
|
+
src/models/ConversationAgentStatusRollup.ts
|
|
179
|
+
src/models/ConversationAgentStatusRollupSearchRequest.ts
|
|
180
|
+
src/models/ConversationAgentStatusRollupSearchResponse.ts
|
|
181
|
+
src/models/ConversationAgentStatusSummaryResponse.ts
|
|
182
|
+
src/models/ConversationAgentStatusTimelineResponse.ts
|
|
167
183
|
src/models/ConversationAutocompleteRequest.ts
|
|
168
184
|
src/models/ConversationAutocompleteResponse.ts
|
|
169
185
|
src/models/ConversationAutocompleteValue.ts
|
|
@@ -253,6 +269,8 @@ src/models/ConversationPbxCosAuditLog.ts
|
|
|
253
269
|
src/models/ConversationPbxCosAuditLogsResponse.ts
|
|
254
270
|
src/models/ConversationPbxCustomerSnapshotRequest.ts
|
|
255
271
|
src/models/ConversationPbxCustomerSnapshotResponse.ts
|
|
272
|
+
src/models/ConversationPbxDefaultTimezoneResponse.ts
|
|
273
|
+
src/models/ConversationPbxDefaultTimezoneUpdateRequest.ts
|
|
256
274
|
src/models/ConversationPbxHardwarePhone.ts
|
|
257
275
|
src/models/ConversationPbxHardwarePhoneResponse.ts
|
|
258
276
|
src/models/ConversationPbxHardwarePhonesResponse.ts
|
|
@@ -932,6 +950,7 @@ src/models/TempMultimedia.ts
|
|
|
932
950
|
src/models/TempMultimediaResponse.ts
|
|
933
951
|
src/models/ThumbnailParametersRequest.ts
|
|
934
952
|
src/models/ThumbnailParametersResponse.ts
|
|
953
|
+
src/models/TimelineSummary.ts
|
|
935
954
|
src/models/TransactionEmail.ts
|
|
936
955
|
src/models/TransactionEmailListResponse.ts
|
|
937
956
|
src/models/TransactionEmailOption.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.83
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.83 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,9 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
|
|
89
|
+
| 4.1.82 | 04/27/2026 | converation - agent status and availability |
|
|
90
|
+
| 4.1.81 | 04/27/2026 | conversations - agent status and availability |
|
|
88
91
|
| 4.1.80 | 04/22/2026 | customer - e.164 read only fields on billing/shipping child objects |
|
|
89
92
|
| 4.1.79 | 04/21/2026 | item - one line per unit flag support |
|
|
90
93
|
| 4.1.78 | 04/20/2026 | conversation pbx - objects have context_merchant_id fields to linked account configs |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
|
|
13
|
+
import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAgentStatusConfig, ConversationAgentStatusConfigResponse, ConversationAgentStatusConfigsResponse, ConversationAgentStatusHeatmapRequest, ConversationAgentStatusHeatmapResponse, ConversationAgentStatusHistorySearchRequest, ConversationAgentStatusHistorySearchResponse, ConversationAgentStatusRollupSearchRequest, ConversationAgentStatusRollupSearchResponse, ConversationAgentStatusSummaryResponse, ConversationAgentStatusTimelineResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxDefaultTimezoneResponse, ConversationPbxDefaultTimezoneUpdateRequest, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
|
|
14
14
|
export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
|
|
15
15
|
userId: number;
|
|
16
16
|
documentUuid: string;
|
|
@@ -19,6 +19,9 @@ export interface DeleteAgentProfileMcpRequest {
|
|
|
19
19
|
userId: number;
|
|
20
20
|
mcpServerUuid: string;
|
|
21
21
|
}
|
|
22
|
+
export interface DeleteAgentStatusConfigRequest {
|
|
23
|
+
conversationStatusUuid: string;
|
|
24
|
+
}
|
|
22
25
|
export interface DeleteConversationCannedMessageRequest {
|
|
23
26
|
conversationCannedMessageOid: number;
|
|
24
27
|
}
|
|
@@ -82,6 +85,22 @@ export interface GetAgentProfileMcpToolsRequest {
|
|
|
82
85
|
export interface GetAgentProfileMcpsRequest {
|
|
83
86
|
userId: number;
|
|
84
87
|
}
|
|
88
|
+
export interface GetAgentStatusHeatmapRequest {
|
|
89
|
+
heatmapRequest: ConversationAgentStatusHeatmapRequest;
|
|
90
|
+
}
|
|
91
|
+
export interface GetAgentStatusSummaryRequest {
|
|
92
|
+
dateStart2: string;
|
|
93
|
+
dateEnd2: string;
|
|
94
|
+
dateStart?: string;
|
|
95
|
+
dateEnd?: string;
|
|
96
|
+
}
|
|
97
|
+
export interface GetAgentStatusTimelineRequest {
|
|
98
|
+
agentUserId: string;
|
|
99
|
+
date2: string;
|
|
100
|
+
date?: string;
|
|
101
|
+
channel?: string;
|
|
102
|
+
channel2?: string;
|
|
103
|
+
}
|
|
85
104
|
export interface GetConversationRequest {
|
|
86
105
|
conversationUuid: string;
|
|
87
106
|
limit?: number;
|
|
@@ -191,6 +210,9 @@ export interface InsertAgentProfileMcpRequest {
|
|
|
191
210
|
userId: number;
|
|
192
211
|
mcpServer: ConversationMcpServer;
|
|
193
212
|
}
|
|
213
|
+
export interface InsertAgentStatusConfigRequest {
|
|
214
|
+
statusConfig: ConversationAgentStatusConfig;
|
|
215
|
+
}
|
|
194
216
|
export interface InsertConversationCannedMessageRequest {
|
|
195
217
|
cannedMessage: ConversationCannedMessage;
|
|
196
218
|
}
|
|
@@ -260,6 +282,14 @@ export interface RegeneratePasswordForPbxHardwarePhoneRequest {
|
|
|
260
282
|
export interface ResetConversationPbxQueueStatisticsRequest {
|
|
261
283
|
queueUuid: string;
|
|
262
284
|
}
|
|
285
|
+
export interface SearchAgentStatusHistoryRequest {
|
|
286
|
+
searchRequest: ConversationAgentStatusHistorySearchRequest;
|
|
287
|
+
limit?: number;
|
|
288
|
+
offset?: number;
|
|
289
|
+
}
|
|
290
|
+
export interface SearchAgentStatusRollupsRequest {
|
|
291
|
+
searchRequest: ConversationAgentStatusRollupSearchRequest;
|
|
292
|
+
}
|
|
263
293
|
export interface SearchConversationCannedMessagesRequest {
|
|
264
294
|
searchRequest: ConversationCannedMessagesSearch;
|
|
265
295
|
}
|
|
@@ -292,6 +322,10 @@ export interface UpdateAgentProfileMcpRequest {
|
|
|
292
322
|
mcpServerUuid: string;
|
|
293
323
|
mcpServer: ConversationMcpServer;
|
|
294
324
|
}
|
|
325
|
+
export interface UpdateAgentStatusConfigRequest {
|
|
326
|
+
conversationStatusUuid: string;
|
|
327
|
+
statusConfig: ConversationAgentStatusConfig;
|
|
328
|
+
}
|
|
295
329
|
export interface UpdateConversationCannedMessageRequest {
|
|
296
330
|
conversationCannedMessageOid: number;
|
|
297
331
|
cannedMessage: ConversationCannedMessage;
|
|
@@ -324,6 +358,9 @@ export interface UpdatePbxClassOfServiceRequest {
|
|
|
324
358
|
classOfServiceUuid: string;
|
|
325
359
|
classOfService: ConversationPbxClassOfService;
|
|
326
360
|
}
|
|
361
|
+
export interface UpdatePbxDefaultTimezoneRequest {
|
|
362
|
+
timezoneUpdate: ConversationPbxDefaultTimezoneUpdateRequest;
|
|
363
|
+
}
|
|
327
364
|
export interface UpdatePbxHardwarePhoneRequest {
|
|
328
365
|
conversationPbxHardwarePhoneUuid: string;
|
|
329
366
|
pbxHardwarePhone: ConversationPbxHardwarePhone;
|
|
@@ -399,6 +436,20 @@ export interface ConversationApiInterface {
|
|
|
399
436
|
* Delete an agent MCP server
|
|
400
437
|
*/
|
|
401
438
|
deleteAgentProfileMcp(requestParameters: DeleteAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
439
|
+
/**
|
|
440
|
+
* Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.
|
|
441
|
+
* @summary Soft-deactivate a custom agent status
|
|
442
|
+
* @param {string} conversationStatusUuid
|
|
443
|
+
* @param {*} [options] Override http request option.
|
|
444
|
+
* @throws {RequiredError}
|
|
445
|
+
* @memberof ConversationApiInterface
|
|
446
|
+
*/
|
|
447
|
+
deleteAgentStatusConfigRaw(requestParameters: DeleteAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
448
|
+
/**
|
|
449
|
+
* Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.
|
|
450
|
+
* Soft-deactivate a custom agent status
|
|
451
|
+
*/
|
|
452
|
+
deleteAgentStatusConfig(requestParameters: DeleteAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
402
453
|
/**
|
|
403
454
|
* Delete a conversation canned message
|
|
404
455
|
* @summary Delete a conversation canned message
|
|
@@ -721,6 +772,68 @@ export interface ConversationApiInterface {
|
|
|
721
772
|
* Get agent profiles
|
|
722
773
|
*/
|
|
723
774
|
getAgentProfiles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfilesResponse>;
|
|
775
|
+
/**
|
|
776
|
+
* Returns all custom statuses (active and soft-deactivated) for the merchant.
|
|
777
|
+
* @summary List custom agent statuses
|
|
778
|
+
* @param {*} [options] Override http request option.
|
|
779
|
+
* @throws {RequiredError}
|
|
780
|
+
* @memberof ConversationApiInterface
|
|
781
|
+
*/
|
|
782
|
+
getAgentStatusConfigsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigsResponse>>;
|
|
783
|
+
/**
|
|
784
|
+
* Returns all custom statuses (active and soft-deactivated) for the merchant.
|
|
785
|
+
* List custom agent statuses
|
|
786
|
+
*/
|
|
787
|
+
getAgentStatusConfigs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigsResponse>;
|
|
788
|
+
/**
|
|
789
|
+
* Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.
|
|
790
|
+
* @summary Agent x hour-of-day heatmap
|
|
791
|
+
* @param {ConversationAgentStatusHeatmapRequest} heatmapRequest Heatmap request
|
|
792
|
+
* @param {*} [options] Override http request option.
|
|
793
|
+
* @throws {RequiredError}
|
|
794
|
+
* @memberof ConversationApiInterface
|
|
795
|
+
*/
|
|
796
|
+
getAgentStatusHeatmapRaw(requestParameters: GetAgentStatusHeatmapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusHeatmapResponse>>;
|
|
797
|
+
/**
|
|
798
|
+
* Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.
|
|
799
|
+
* Agent x hour-of-day heatmap
|
|
800
|
+
*/
|
|
801
|
+
getAgentStatusHeatmap(requestParameters: GetAgentStatusHeatmapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusHeatmapResponse>;
|
|
802
|
+
/**
|
|
803
|
+
* Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.
|
|
804
|
+
* @summary Dashboard summary for a date range
|
|
805
|
+
* @param {string} dateStart2 Range start (YYYY-MM-DD)
|
|
806
|
+
* @param {string} dateEnd2 Range end (YYYY-MM-DD)
|
|
807
|
+
* @param {string} [dateStart]
|
|
808
|
+
* @param {string} [dateEnd]
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
* @memberof ConversationApiInterface
|
|
812
|
+
*/
|
|
813
|
+
getAgentStatusSummaryRaw(requestParameters: GetAgentStatusSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusSummaryResponse>>;
|
|
814
|
+
/**
|
|
815
|
+
* Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.
|
|
816
|
+
* Dashboard summary for a date range
|
|
817
|
+
*/
|
|
818
|
+
getAgentStatusSummary(requestParameters: GetAgentStatusSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusSummaryResponse>;
|
|
819
|
+
/**
|
|
820
|
+
* Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.
|
|
821
|
+
* @summary Day timeline for a single agent
|
|
822
|
+
* @param {string} agentUserId
|
|
823
|
+
* @param {string} date2 Day to retrieve (YYYY-MM-DD)
|
|
824
|
+
* @param {string} [date]
|
|
825
|
+
* @param {string} [channel]
|
|
826
|
+
* @param {string} [channel2] Restrict to one channel (omit for both)
|
|
827
|
+
* @param {*} [options] Override http request option.
|
|
828
|
+
* @throws {RequiredError}
|
|
829
|
+
* @memberof ConversationApiInterface
|
|
830
|
+
*/
|
|
831
|
+
getAgentStatusTimelineRaw(requestParameters: GetAgentStatusTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusTimelineResponse>>;
|
|
832
|
+
/**
|
|
833
|
+
* Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.
|
|
834
|
+
* Day timeline for a single agent
|
|
835
|
+
*/
|
|
836
|
+
getAgentStatusTimeline(requestParameters: GetAgentStatusTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusTimelineResponse>;
|
|
724
837
|
/**
|
|
725
838
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
726
839
|
* @summary Get agent websocket authorization
|
|
@@ -1180,6 +1293,19 @@ export interface ConversationApiInterface {
|
|
|
1180
1293
|
* Get pbx class of service audit logs
|
|
1181
1294
|
*/
|
|
1182
1295
|
getPbxCosAuditLogs(requestParameters: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCosAuditLogsResponse>;
|
|
1296
|
+
/**
|
|
1297
|
+
* Returns the merchant\'s stored default timezone (IANA name). Falls back to America/New_York when unset.
|
|
1298
|
+
* @summary Get the merchant default timezone
|
|
1299
|
+
* @param {*} [options] Override http request option.
|
|
1300
|
+
* @throws {RequiredError}
|
|
1301
|
+
* @memberof ConversationApiInterface
|
|
1302
|
+
*/
|
|
1303
|
+
getPbxDefaultTimezoneRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxDefaultTimezoneResponse>>;
|
|
1304
|
+
/**
|
|
1305
|
+
* Returns the merchant\'s stored default timezone (IANA name). Falls back to America/New_York when unset.
|
|
1306
|
+
* Get the merchant default timezone
|
|
1307
|
+
*/
|
|
1308
|
+
getPbxDefaultTimezone(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxDefaultTimezoneResponse>;
|
|
1183
1309
|
/**
|
|
1184
1310
|
* Retrieve a pbx hardware phone
|
|
1185
1311
|
* @summary Get pbx hardware phone
|
|
@@ -1507,6 +1633,20 @@ export interface ConversationApiInterface {
|
|
|
1507
1633
|
* Insert an agent MCP server
|
|
1508
1634
|
*/
|
|
1509
1635
|
insertAgentProfileMcp(requestParameters: InsertAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
|
|
1636
|
+
/**
|
|
1637
|
+
* Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.
|
|
1638
|
+
* @summary Create a custom agent status
|
|
1639
|
+
* @param {ConversationAgentStatusConfig} statusConfig Status config
|
|
1640
|
+
* @param {*} [options] Override http request option.
|
|
1641
|
+
* @throws {RequiredError}
|
|
1642
|
+
* @memberof ConversationApiInterface
|
|
1643
|
+
*/
|
|
1644
|
+
insertAgentStatusConfigRaw(requestParameters: InsertAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigResponse>>;
|
|
1645
|
+
/**
|
|
1646
|
+
* Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.
|
|
1647
|
+
* Create a custom agent status
|
|
1648
|
+
*/
|
|
1649
|
+
insertAgentStatusConfig(requestParameters: InsertAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigResponse>;
|
|
1510
1650
|
/**
|
|
1511
1651
|
* Insert a canned message
|
|
1512
1652
|
* @summary Insert a canned message
|
|
@@ -1818,6 +1958,36 @@ export interface ConversationApiInterface {
|
|
|
1818
1958
|
* reset statistics within the queue
|
|
1819
1959
|
*/
|
|
1820
1960
|
resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1961
|
+
/**
|
|
1962
|
+
* Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.
|
|
1963
|
+
* @summary Search agent status history
|
|
1964
|
+
* @param {ConversationAgentStatusHistorySearchRequest} searchRequest Search request
|
|
1965
|
+
* @param {number} [limit] Maximum records per call (max 200)
|
|
1966
|
+
* @param {number} [offset] Pagination offset (zero-based)
|
|
1967
|
+
* @param {*} [options] Override http request option.
|
|
1968
|
+
* @throws {RequiredError}
|
|
1969
|
+
* @memberof ConversationApiInterface
|
|
1970
|
+
*/
|
|
1971
|
+
searchAgentStatusHistoryRaw(requestParameters: SearchAgentStatusHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusHistorySearchResponse>>;
|
|
1972
|
+
/**
|
|
1973
|
+
* Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.
|
|
1974
|
+
* Search agent status history
|
|
1975
|
+
*/
|
|
1976
|
+
searchAgentStatusHistory(requestParameters: SearchAgentStatusHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusHistorySearchResponse>;
|
|
1977
|
+
/**
|
|
1978
|
+
* Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).
|
|
1979
|
+
* @summary Search per-(agent, day) rollups
|
|
1980
|
+
* @param {ConversationAgentStatusRollupSearchRequest} searchRequest Search request
|
|
1981
|
+
* @param {*} [options] Override http request option.
|
|
1982
|
+
* @throws {RequiredError}
|
|
1983
|
+
* @memberof ConversationApiInterface
|
|
1984
|
+
*/
|
|
1985
|
+
searchAgentStatusRollupsRaw(requestParameters: SearchAgentStatusRollupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusRollupSearchResponse>>;
|
|
1986
|
+
/**
|
|
1987
|
+
* Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).
|
|
1988
|
+
* Search per-(agent, day) rollups
|
|
1989
|
+
*/
|
|
1990
|
+
searchAgentStatusRollups(requestParameters: SearchAgentStatusRollupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusRollupSearchResponse>;
|
|
1821
1991
|
/**
|
|
1822
1992
|
* Search for canned messages by short_code
|
|
1823
1993
|
* @summary Search for canned messages by short_code
|
|
@@ -1927,6 +2097,21 @@ export interface ConversationApiInterface {
|
|
|
1927
2097
|
* Update an agent MCP server
|
|
1928
2098
|
*/
|
|
1929
2099
|
updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
|
|
2100
|
+
/**
|
|
2101
|
+
* Update a custom status. Renaming flows through to the Twilio Activity.
|
|
2102
|
+
* @summary Update a custom agent status
|
|
2103
|
+
* @param {string} conversationStatusUuid
|
|
2104
|
+
* @param {ConversationAgentStatusConfig} statusConfig Status config
|
|
2105
|
+
* @param {*} [options] Override http request option.
|
|
2106
|
+
* @throws {RequiredError}
|
|
2107
|
+
* @memberof ConversationApiInterface
|
|
2108
|
+
*/
|
|
2109
|
+
updateAgentStatusConfigRaw(requestParameters: UpdateAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigResponse>>;
|
|
2110
|
+
/**
|
|
2111
|
+
* Update a custom status. Renaming flows through to the Twilio Activity.
|
|
2112
|
+
* Update a custom agent status
|
|
2113
|
+
*/
|
|
2114
|
+
updateAgentStatusConfig(requestParameters: UpdateAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigResponse>;
|
|
1930
2115
|
/**
|
|
1931
2116
|
* Update a canned message
|
|
1932
2117
|
* @summary Update a canned message
|
|
@@ -2047,6 +2232,20 @@ export interface ConversationApiInterface {
|
|
|
2047
2232
|
* Update pbx class of service
|
|
2048
2233
|
*/
|
|
2049
2234
|
updatePbxClassOfService(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
|
|
2235
|
+
/**
|
|
2236
|
+
* Persists the IANA timezone on the Config#<merchant_id>/default DDB record (creates on first PUT).
|
|
2237
|
+
* @summary Set the merchant default timezone
|
|
2238
|
+
* @param {ConversationPbxDefaultTimezoneUpdateRequest} timezoneUpdate Timezone update
|
|
2239
|
+
* @param {*} [options] Override http request option.
|
|
2240
|
+
* @throws {RequiredError}
|
|
2241
|
+
* @memberof ConversationApiInterface
|
|
2242
|
+
*/
|
|
2243
|
+
updatePbxDefaultTimezoneRaw(requestParameters: UpdatePbxDefaultTimezoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxDefaultTimezoneResponse>>;
|
|
2244
|
+
/**
|
|
2245
|
+
* Persists the IANA timezone on the Config#<merchant_id>/default DDB record (creates on first PUT).
|
|
2246
|
+
* Set the merchant default timezone
|
|
2247
|
+
*/
|
|
2248
|
+
updatePbxDefaultTimezone(requestParameters: UpdatePbxDefaultTimezoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxDefaultTimezoneResponse>;
|
|
2050
2249
|
/**
|
|
2051
2250
|
* Update a pbx hardware phone
|
|
2052
2251
|
* @summary Update pbx hardware phone
|
|
@@ -2220,6 +2419,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
2220
2419
|
* Delete an agent MCP server
|
|
2221
2420
|
*/
|
|
2222
2421
|
deleteAgentProfileMcp(requestParameters: DeleteAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2422
|
+
/**
|
|
2423
|
+
* Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.
|
|
2424
|
+
* Soft-deactivate a custom agent status
|
|
2425
|
+
*/
|
|
2426
|
+
deleteAgentStatusConfigRaw(requestParameters: DeleteAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
2427
|
+
/**
|
|
2428
|
+
* Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.
|
|
2429
|
+
* Soft-deactivate a custom agent status
|
|
2430
|
+
*/
|
|
2431
|
+
deleteAgentStatusConfig(requestParameters: DeleteAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
2223
2432
|
/**
|
|
2224
2433
|
* Delete a conversation canned message
|
|
2225
2434
|
* Delete a conversation canned message
|
|
@@ -2450,6 +2659,46 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
2450
2659
|
* Get agent profiles
|
|
2451
2660
|
*/
|
|
2452
2661
|
getAgentProfiles(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfilesResponse>;
|
|
2662
|
+
/**
|
|
2663
|
+
* Returns all custom statuses (active and soft-deactivated) for the merchant.
|
|
2664
|
+
* List custom agent statuses
|
|
2665
|
+
*/
|
|
2666
|
+
getAgentStatusConfigsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigsResponse>>;
|
|
2667
|
+
/**
|
|
2668
|
+
* Returns all custom statuses (active and soft-deactivated) for the merchant.
|
|
2669
|
+
* List custom agent statuses
|
|
2670
|
+
*/
|
|
2671
|
+
getAgentStatusConfigs(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigsResponse>;
|
|
2672
|
+
/**
|
|
2673
|
+
* Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.
|
|
2674
|
+
* Agent x hour-of-day heatmap
|
|
2675
|
+
*/
|
|
2676
|
+
getAgentStatusHeatmapRaw(requestParameters: GetAgentStatusHeatmapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusHeatmapResponse>>;
|
|
2677
|
+
/**
|
|
2678
|
+
* Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.
|
|
2679
|
+
* Agent x hour-of-day heatmap
|
|
2680
|
+
*/
|
|
2681
|
+
getAgentStatusHeatmap(requestParameters: GetAgentStatusHeatmapRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusHeatmapResponse>;
|
|
2682
|
+
/**
|
|
2683
|
+
* Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.
|
|
2684
|
+
* Dashboard summary for a date range
|
|
2685
|
+
*/
|
|
2686
|
+
getAgentStatusSummaryRaw(requestParameters: GetAgentStatusSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusSummaryResponse>>;
|
|
2687
|
+
/**
|
|
2688
|
+
* Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.
|
|
2689
|
+
* Dashboard summary for a date range
|
|
2690
|
+
*/
|
|
2691
|
+
getAgentStatusSummary(requestParameters: GetAgentStatusSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusSummaryResponse>;
|
|
2692
|
+
/**
|
|
2693
|
+
* Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.
|
|
2694
|
+
* Day timeline for a single agent
|
|
2695
|
+
*/
|
|
2696
|
+
getAgentStatusTimelineRaw(requestParameters: GetAgentStatusTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusTimelineResponse>>;
|
|
2697
|
+
/**
|
|
2698
|
+
* Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.
|
|
2699
|
+
* Day timeline for a single agent
|
|
2700
|
+
*/
|
|
2701
|
+
getAgentStatusTimeline(requestParameters: GetAgentStatusTimelineRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusTimelineResponse>;
|
|
2453
2702
|
/**
|
|
2454
2703
|
* Retrieve a JWT to authorize an agent to make a websocket connection.
|
|
2455
2704
|
* Get agent websocket authorization
|
|
@@ -2780,6 +3029,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
2780
3029
|
* Get pbx class of service audit logs
|
|
2781
3030
|
*/
|
|
2782
3031
|
getPbxCosAuditLogs(requestParameters?: GetPbxCosAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxCosAuditLogsResponse>;
|
|
3032
|
+
/**
|
|
3033
|
+
* Returns the merchant\'s stored default timezone (IANA name). Falls back to America/New_York when unset.
|
|
3034
|
+
* Get the merchant default timezone
|
|
3035
|
+
*/
|
|
3036
|
+
getPbxDefaultTimezoneRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxDefaultTimezoneResponse>>;
|
|
3037
|
+
/**
|
|
3038
|
+
* Returns the merchant\'s stored default timezone (IANA name). Falls back to America/New_York when unset.
|
|
3039
|
+
* Get the merchant default timezone
|
|
3040
|
+
*/
|
|
3041
|
+
getPbxDefaultTimezone(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxDefaultTimezoneResponse>;
|
|
2783
3042
|
/**
|
|
2784
3043
|
* Retrieve a pbx hardware phone
|
|
2785
3044
|
* Get pbx hardware phone
|
|
@@ -3020,6 +3279,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
3020
3279
|
* Insert an agent MCP server
|
|
3021
3280
|
*/
|
|
3022
3281
|
insertAgentProfileMcp(requestParameters: InsertAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
|
|
3282
|
+
/**
|
|
3283
|
+
* Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.
|
|
3284
|
+
* Create a custom agent status
|
|
3285
|
+
*/
|
|
3286
|
+
insertAgentStatusConfigRaw(requestParameters: InsertAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigResponse>>;
|
|
3287
|
+
/**
|
|
3288
|
+
* Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.
|
|
3289
|
+
* Create a custom agent status
|
|
3290
|
+
*/
|
|
3291
|
+
insertAgentStatusConfig(requestParameters: InsertAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigResponse>;
|
|
3023
3292
|
/**
|
|
3024
3293
|
* Insert a canned message
|
|
3025
3294
|
* Insert a canned message
|
|
@@ -3240,6 +3509,26 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
3240
3509
|
* reset statistics within the queue
|
|
3241
3510
|
*/
|
|
3242
3511
|
resetConversationPbxQueueStatistics(requestParameters: ResetConversationPbxQueueStatisticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
3512
|
+
/**
|
|
3513
|
+
* Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.
|
|
3514
|
+
* Search agent status history
|
|
3515
|
+
*/
|
|
3516
|
+
searchAgentStatusHistoryRaw(requestParameters: SearchAgentStatusHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusHistorySearchResponse>>;
|
|
3517
|
+
/**
|
|
3518
|
+
* Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.
|
|
3519
|
+
* Search agent status history
|
|
3520
|
+
*/
|
|
3521
|
+
searchAgentStatusHistory(requestParameters: SearchAgentStatusHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusHistorySearchResponse>;
|
|
3522
|
+
/**
|
|
3523
|
+
* Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).
|
|
3524
|
+
* Search per-(agent, day) rollups
|
|
3525
|
+
*/
|
|
3526
|
+
searchAgentStatusRollupsRaw(requestParameters: SearchAgentStatusRollupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusRollupSearchResponse>>;
|
|
3527
|
+
/**
|
|
3528
|
+
* Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).
|
|
3529
|
+
* Search per-(agent, day) rollups
|
|
3530
|
+
*/
|
|
3531
|
+
searchAgentStatusRollups(requestParameters: SearchAgentStatusRollupsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusRollupSearchResponse>;
|
|
3243
3532
|
/**
|
|
3244
3533
|
* Search for canned messages by short_code
|
|
3245
3534
|
* Search for canned messages by short_code
|
|
@@ -3310,6 +3599,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
3310
3599
|
* Update an agent MCP server
|
|
3311
3600
|
*/
|
|
3312
3601
|
updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
|
|
3602
|
+
/**
|
|
3603
|
+
* Update a custom status. Renaming flows through to the Twilio Activity.
|
|
3604
|
+
* Update a custom agent status
|
|
3605
|
+
*/
|
|
3606
|
+
updateAgentStatusConfigRaw(requestParameters: UpdateAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentStatusConfigResponse>>;
|
|
3607
|
+
/**
|
|
3608
|
+
* Update a custom status. Renaming flows through to the Twilio Activity.
|
|
3609
|
+
* Update a custom agent status
|
|
3610
|
+
*/
|
|
3611
|
+
updateAgentStatusConfig(requestParameters: UpdateAgentStatusConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentStatusConfigResponse>;
|
|
3313
3612
|
/**
|
|
3314
3613
|
* Update a canned message
|
|
3315
3614
|
* Update a canned message
|
|
@@ -3390,6 +3689,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
|
|
|
3390
3689
|
* Update pbx class of service
|
|
3391
3690
|
*/
|
|
3392
3691
|
updatePbxClassOfService(requestParameters: UpdatePbxClassOfServiceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxClassOfServiceResponse>;
|
|
3692
|
+
/**
|
|
3693
|
+
* Persists the IANA timezone on the Config#<merchant_id>/default DDB record (creates on first PUT).
|
|
3694
|
+
* Set the merchant default timezone
|
|
3695
|
+
*/
|
|
3696
|
+
updatePbxDefaultTimezoneRaw(requestParameters: UpdatePbxDefaultTimezoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationPbxDefaultTimezoneResponse>>;
|
|
3697
|
+
/**
|
|
3698
|
+
* Persists the IANA timezone on the Config#<merchant_id>/default DDB record (creates on first PUT).
|
|
3699
|
+
* Set the merchant default timezone
|
|
3700
|
+
*/
|
|
3701
|
+
updatePbxDefaultTimezone(requestParameters: UpdatePbxDefaultTimezoneRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxDefaultTimezoneResponse>;
|
|
3393
3702
|
/**
|
|
3394
3703
|
* Update a pbx hardware phone
|
|
3395
3704
|
* Update pbx hardware phone
|