@wokuapp/sdk 0.4.0 → 0.5.0
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/README.md +120 -2
- package/dist/index.cjs +312 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1164 -34
- package/dist/index.d.ts +1164 -34
- package/dist/index.js +309 -4
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -60,6 +60,8 @@ type FetchLike = (input: string, init: {
|
|
|
60
60
|
get(name: string): string | null;
|
|
61
61
|
};
|
|
62
62
|
text(): Promise<string>;
|
|
63
|
+
/** Needed only by binary downloads such as the folder PDF. */
|
|
64
|
+
arrayBuffer?(): Promise<ArrayBuffer>;
|
|
63
65
|
}>;
|
|
64
66
|
interface WokuClientOptions {
|
|
65
67
|
/** Company secret key. Defaults to `process.env.WOKU_API_KEY`. */
|
|
@@ -89,6 +91,11 @@ interface RequestArgs extends RequestOptions {
|
|
|
89
91
|
* (send/approve/test) so they are never silently replayed.
|
|
90
92
|
*/
|
|
91
93
|
idempotent?: boolean;
|
|
94
|
+
/**
|
|
95
|
+
* Return a successful response as raw bytes (`Uint8Array`) instead of parsed
|
|
96
|
+
* JSON. Error responses are still parsed and mapped to API errors.
|
|
97
|
+
*/
|
|
98
|
+
binary?: boolean;
|
|
92
99
|
}
|
|
93
100
|
/**
|
|
94
101
|
* Transport core: turns a resource call into an authenticated HTTP request
|
|
@@ -987,6 +994,29 @@ interface components {
|
|
|
987
994
|
*/
|
|
988
995
|
dispatchToken?: string;
|
|
989
996
|
};
|
|
997
|
+
FlowStepBodyDTO: {
|
|
998
|
+
/**
|
|
999
|
+
* @description Kind of tool the respondent answers in this step.
|
|
1000
|
+
* @enum {string}
|
|
1001
|
+
*/
|
|
1002
|
+
type: "woku" | "nps" | "csat" | "ces";
|
|
1003
|
+
/**
|
|
1004
|
+
* Format: ObjectId
|
|
1005
|
+
* @description Tool id (woku, NPS tool, CSAT tool or CES tool). For an nps step, your company id means the company-level NPS.
|
|
1006
|
+
*/
|
|
1007
|
+
toolId: string;
|
|
1008
|
+
};
|
|
1009
|
+
CreateFlowBodyDTO: {
|
|
1010
|
+
/** @example Post-purchase journey */
|
|
1011
|
+
name: string;
|
|
1012
|
+
/** @description Ordered steps. A tool can appear once. Flows live outside folders. */
|
|
1013
|
+
steps: components["schemas"]["FlowStepBodyDTO"][];
|
|
1014
|
+
};
|
|
1015
|
+
UpdateFlowBodyDTO: {
|
|
1016
|
+
name?: string;
|
|
1017
|
+
/** @description The new full ordered list of steps. */
|
|
1018
|
+
steps?: components["schemas"]["FlowStepBodyDTO"][];
|
|
1019
|
+
};
|
|
990
1020
|
NpsToolLocalizedContentBodyDTO: {
|
|
991
1021
|
/**
|
|
992
1022
|
* @example en
|
|
@@ -1005,6 +1035,11 @@ interface components {
|
|
|
1005
1035
|
audienceType?: string;
|
|
1006
1036
|
};
|
|
1007
1037
|
CreateNpsToolBodyDTO: {
|
|
1038
|
+
/**
|
|
1039
|
+
* Format: ObjectId
|
|
1040
|
+
* @description Folder to create the tool in. Must belong to your company. Omit for the root.
|
|
1041
|
+
*/
|
|
1042
|
+
folderId?: string;
|
|
1008
1043
|
/**
|
|
1009
1044
|
* @description Tool name for identification.
|
|
1010
1045
|
* @example Post-Purchase Survey
|
|
@@ -1059,6 +1094,13 @@ interface components {
|
|
|
1059
1094
|
defaultLocale?: "es" | "en";
|
|
1060
1095
|
localizedContent?: components["schemas"]["NpsToolLocalizedContentBodyDTO"][];
|
|
1061
1096
|
};
|
|
1097
|
+
MoveToolBodyDTO: {
|
|
1098
|
+
/**
|
|
1099
|
+
* Format: ObjectId
|
|
1100
|
+
* @description Target folder id, or null to move the tool to the root.
|
|
1101
|
+
*/
|
|
1102
|
+
folderId: string | null;
|
|
1103
|
+
};
|
|
1062
1104
|
CsatToolLocalizedContentBodyDTO: {
|
|
1063
1105
|
/**
|
|
1064
1106
|
* @example en
|
|
@@ -1077,6 +1119,11 @@ interface components {
|
|
|
1077
1119
|
subject?: string;
|
|
1078
1120
|
};
|
|
1079
1121
|
CreateCsatToolBodyDTO: {
|
|
1122
|
+
/**
|
|
1123
|
+
* Format: ObjectId
|
|
1124
|
+
* @description Folder to create the tool in. Must belong to your company. Omit for the root.
|
|
1125
|
+
*/
|
|
1126
|
+
folderId?: string;
|
|
1080
1127
|
/**
|
|
1081
1128
|
* @description Tool name for identification.
|
|
1082
1129
|
* @example Post-Purchase CSAT
|
|
@@ -1141,6 +1188,11 @@ interface components {
|
|
|
1141
1188
|
action?: string;
|
|
1142
1189
|
};
|
|
1143
1190
|
CreateCesToolBodyDTO: {
|
|
1191
|
+
/**
|
|
1192
|
+
* Format: ObjectId
|
|
1193
|
+
* @description Folder to create the tool in. Must belong to your company. Omit for the root.
|
|
1194
|
+
*/
|
|
1195
|
+
folderId?: string;
|
|
1144
1196
|
/**
|
|
1145
1197
|
* @description Tool name for identification.
|
|
1146
1198
|
* @example Post-Purchase Effort
|
|
@@ -1757,6 +1809,59 @@ interface components {
|
|
|
1757
1809
|
V1JourneyEventResponseDto: {
|
|
1758
1810
|
journeys: number;
|
|
1759
1811
|
};
|
|
1812
|
+
CreateFolderBodyDTO: {
|
|
1813
|
+
/** @example Post-sale */
|
|
1814
|
+
name: string;
|
|
1815
|
+
/**
|
|
1816
|
+
* Format: ObjectId
|
|
1817
|
+
* @description Parent folder. Omit to create the folder at the root.
|
|
1818
|
+
*/
|
|
1819
|
+
parentFolderId?: string;
|
|
1820
|
+
/** @example #3498db */
|
|
1821
|
+
color?: string;
|
|
1822
|
+
};
|
|
1823
|
+
WhatsappAlertRecipientDTO: {
|
|
1824
|
+
/**
|
|
1825
|
+
* @description E.164 phone number without the leading +.
|
|
1826
|
+
* @example 56912345678
|
|
1827
|
+
*/
|
|
1828
|
+
whatsappId: string;
|
|
1829
|
+
/** @example Ana (support) */
|
|
1830
|
+
name: string;
|
|
1831
|
+
/** @description Kinds of comment that alert this number. Defaults to all four. */
|
|
1832
|
+
sources?: ("woku" | "nps" | "csat" | "ces")[];
|
|
1833
|
+
};
|
|
1834
|
+
UpdateFolderBodyDTO: {
|
|
1835
|
+
name?: string;
|
|
1836
|
+
/**
|
|
1837
|
+
* @description Hex color, or null to clear it.
|
|
1838
|
+
* @example #3498db
|
|
1839
|
+
*/
|
|
1840
|
+
color?: string | null;
|
|
1841
|
+
/** @description Replaces the WhatsApp numbers alerted when a comment of any tool in this folder is an improvement (wokus, NPS, CSAT, CES). Send [] to clear. */
|
|
1842
|
+
whatsappAlertRecipients?: components["schemas"]["WhatsappAlertRecipientDTO"][];
|
|
1843
|
+
};
|
|
1844
|
+
MoveFolderBodyDTO: {
|
|
1845
|
+
/**
|
|
1846
|
+
* Format: ObjectId
|
|
1847
|
+
* @description New parent folder, or null to move the folder to the root. A folder cannot move into itself or one of its subfolders.
|
|
1848
|
+
*/
|
|
1849
|
+
parentFolderId: string | null;
|
|
1850
|
+
};
|
|
1851
|
+
MoveItemDTO: {
|
|
1852
|
+
/** @enum {string} */
|
|
1853
|
+
type: "woku" | "nps" | "csat" | "ces" | "folder";
|
|
1854
|
+
/** Format: ObjectId */
|
|
1855
|
+
id: string;
|
|
1856
|
+
};
|
|
1857
|
+
MoveToolItemsBodyDTO: {
|
|
1858
|
+
items: components["schemas"]["MoveItemDTO"][];
|
|
1859
|
+
/**
|
|
1860
|
+
* Format: ObjectId
|
|
1861
|
+
* @description Destination folder. `null` moves the items to the root.
|
|
1862
|
+
*/
|
|
1863
|
+
folderId: string | null;
|
|
1864
|
+
};
|
|
1760
1865
|
JourneyEntryInfoDto: {
|
|
1761
1866
|
name?: string;
|
|
1762
1867
|
momentName?: string;
|
|
@@ -4640,6 +4745,40 @@ interface operations {
|
|
|
4640
4745
|
};
|
|
4641
4746
|
};
|
|
4642
4747
|
};
|
|
4748
|
+
V1FlowsController_createFlow: {
|
|
4749
|
+
parameters: {
|
|
4750
|
+
query?: never;
|
|
4751
|
+
header?: {
|
|
4752
|
+
/** @description Client-generated key to make the create safe to retry. A retry with the same key returns the original result instead of creating again. */
|
|
4753
|
+
"X-Woku-Idempotency-Key"?: string;
|
|
4754
|
+
};
|
|
4755
|
+
path?: never;
|
|
4756
|
+
cookie?: never;
|
|
4757
|
+
};
|
|
4758
|
+
requestBody: {
|
|
4759
|
+
content: {
|
|
4760
|
+
"application/json": components["schemas"]["CreateFlowBodyDTO"];
|
|
4761
|
+
};
|
|
4762
|
+
};
|
|
4763
|
+
responses: {
|
|
4764
|
+
/** @description Flow created */
|
|
4765
|
+
201: {
|
|
4766
|
+
headers: {
|
|
4767
|
+
[name: string]: unknown;
|
|
4768
|
+
};
|
|
4769
|
+
content?: never;
|
|
4770
|
+
};
|
|
4771
|
+
/** @description Validation error or a step is not a tool of your company */
|
|
4772
|
+
400: {
|
|
4773
|
+
headers: {
|
|
4774
|
+
[name: string]: unknown;
|
|
4775
|
+
};
|
|
4776
|
+
content: {
|
|
4777
|
+
"application/json": components["schemas"]["ValidationErrorResponseDto"];
|
|
4778
|
+
};
|
|
4779
|
+
};
|
|
4780
|
+
};
|
|
4781
|
+
};
|
|
4643
4782
|
V1FlowsController_getFlow: {
|
|
4644
4783
|
parameters: {
|
|
4645
4784
|
query?: never;
|
|
@@ -4675,6 +4814,64 @@ interface operations {
|
|
|
4675
4814
|
};
|
|
4676
4815
|
};
|
|
4677
4816
|
};
|
|
4817
|
+
V1FlowsController_deleteFlow: {
|
|
4818
|
+
parameters: {
|
|
4819
|
+
query?: never;
|
|
4820
|
+
header?: never;
|
|
4821
|
+
path: {
|
|
4822
|
+
id: string;
|
|
4823
|
+
};
|
|
4824
|
+
cookie?: never;
|
|
4825
|
+
};
|
|
4826
|
+
requestBody?: never;
|
|
4827
|
+
responses: {
|
|
4828
|
+
/** @description Flow deleted */
|
|
4829
|
+
200: {
|
|
4830
|
+
headers: {
|
|
4831
|
+
[name: string]: unknown;
|
|
4832
|
+
};
|
|
4833
|
+
content?: never;
|
|
4834
|
+
};
|
|
4835
|
+
/** @description Flow not found */
|
|
4836
|
+
404: {
|
|
4837
|
+
headers: {
|
|
4838
|
+
[name: string]: unknown;
|
|
4839
|
+
};
|
|
4840
|
+
content?: never;
|
|
4841
|
+
};
|
|
4842
|
+
};
|
|
4843
|
+
};
|
|
4844
|
+
V1FlowsController_updateFlow: {
|
|
4845
|
+
parameters: {
|
|
4846
|
+
query?: never;
|
|
4847
|
+
header?: never;
|
|
4848
|
+
path: {
|
|
4849
|
+
id: string;
|
|
4850
|
+
};
|
|
4851
|
+
cookie?: never;
|
|
4852
|
+
};
|
|
4853
|
+
requestBody: {
|
|
4854
|
+
content: {
|
|
4855
|
+
"application/json": components["schemas"]["UpdateFlowBodyDTO"];
|
|
4856
|
+
};
|
|
4857
|
+
};
|
|
4858
|
+
responses: {
|
|
4859
|
+
/** @description Flow updated */
|
|
4860
|
+
200: {
|
|
4861
|
+
headers: {
|
|
4862
|
+
[name: string]: unknown;
|
|
4863
|
+
};
|
|
4864
|
+
content?: never;
|
|
4865
|
+
};
|
|
4866
|
+
/** @description Flow not found */
|
|
4867
|
+
404: {
|
|
4868
|
+
headers: {
|
|
4869
|
+
[name: string]: unknown;
|
|
4870
|
+
};
|
|
4871
|
+
content?: never;
|
|
4872
|
+
};
|
|
4873
|
+
};
|
|
4874
|
+
};
|
|
4678
4875
|
V1NpsDataController_listNpsTools: {
|
|
4679
4876
|
parameters: {
|
|
4680
4877
|
query?: {
|
|
@@ -5016,6 +5213,37 @@ interface operations {
|
|
|
5016
5213
|
};
|
|
5017
5214
|
};
|
|
5018
5215
|
};
|
|
5216
|
+
V1NpsToolsController_moveNpsTool: {
|
|
5217
|
+
parameters: {
|
|
5218
|
+
query?: never;
|
|
5219
|
+
header?: never;
|
|
5220
|
+
path: {
|
|
5221
|
+
id: string;
|
|
5222
|
+
};
|
|
5223
|
+
cookie?: never;
|
|
5224
|
+
};
|
|
5225
|
+
requestBody: {
|
|
5226
|
+
content: {
|
|
5227
|
+
"application/json": components["schemas"]["MoveToolBodyDTO"];
|
|
5228
|
+
};
|
|
5229
|
+
};
|
|
5230
|
+
responses: {
|
|
5231
|
+
/** @description NPS tool moved */
|
|
5232
|
+
200: {
|
|
5233
|
+
headers: {
|
|
5234
|
+
[name: string]: unknown;
|
|
5235
|
+
};
|
|
5236
|
+
content?: never;
|
|
5237
|
+
};
|
|
5238
|
+
/** @description Tool or folder not found */
|
|
5239
|
+
404: {
|
|
5240
|
+
headers: {
|
|
5241
|
+
[name: string]: unknown;
|
|
5242
|
+
};
|
|
5243
|
+
content?: never;
|
|
5244
|
+
};
|
|
5245
|
+
};
|
|
5246
|
+
};
|
|
5019
5247
|
V1CsatToolsController_deleteCsatTool: {
|
|
5020
5248
|
parameters: {
|
|
5021
5249
|
query?: never;
|
|
@@ -5083,6 +5311,37 @@ interface operations {
|
|
|
5083
5311
|
};
|
|
5084
5312
|
};
|
|
5085
5313
|
};
|
|
5314
|
+
V1CsatToolsController_moveCsatTool: {
|
|
5315
|
+
parameters: {
|
|
5316
|
+
query?: never;
|
|
5317
|
+
header?: never;
|
|
5318
|
+
path: {
|
|
5319
|
+
id: string;
|
|
5320
|
+
};
|
|
5321
|
+
cookie?: never;
|
|
5322
|
+
};
|
|
5323
|
+
requestBody: {
|
|
5324
|
+
content: {
|
|
5325
|
+
"application/json": components["schemas"]["MoveToolBodyDTO"];
|
|
5326
|
+
};
|
|
5327
|
+
};
|
|
5328
|
+
responses: {
|
|
5329
|
+
/** @description Csat tool moved */
|
|
5330
|
+
200: {
|
|
5331
|
+
headers: {
|
|
5332
|
+
[name: string]: unknown;
|
|
5333
|
+
};
|
|
5334
|
+
content?: never;
|
|
5335
|
+
};
|
|
5336
|
+
/** @description Tool or folder not found */
|
|
5337
|
+
404: {
|
|
5338
|
+
headers: {
|
|
5339
|
+
[name: string]: unknown;
|
|
5340
|
+
};
|
|
5341
|
+
content?: never;
|
|
5342
|
+
};
|
|
5343
|
+
};
|
|
5344
|
+
};
|
|
5086
5345
|
V1CesToolsController_deleteCesTool: {
|
|
5087
5346
|
parameters: {
|
|
5088
5347
|
query?: never;
|
|
@@ -5150,6 +5409,37 @@ interface operations {
|
|
|
5150
5409
|
};
|
|
5151
5410
|
};
|
|
5152
5411
|
};
|
|
5412
|
+
V1CesToolsController_moveCesTool: {
|
|
5413
|
+
parameters: {
|
|
5414
|
+
query?: never;
|
|
5415
|
+
header?: never;
|
|
5416
|
+
path: {
|
|
5417
|
+
id: string;
|
|
5418
|
+
};
|
|
5419
|
+
cookie?: never;
|
|
5420
|
+
};
|
|
5421
|
+
requestBody: {
|
|
5422
|
+
content: {
|
|
5423
|
+
"application/json": components["schemas"]["MoveToolBodyDTO"];
|
|
5424
|
+
};
|
|
5425
|
+
};
|
|
5426
|
+
responses: {
|
|
5427
|
+
/** @description Ces tool moved */
|
|
5428
|
+
200: {
|
|
5429
|
+
headers: {
|
|
5430
|
+
[name: string]: unknown;
|
|
5431
|
+
};
|
|
5432
|
+
content?: never;
|
|
5433
|
+
};
|
|
5434
|
+
/** @description Tool or folder not found */
|
|
5435
|
+
404: {
|
|
5436
|
+
headers: {
|
|
5437
|
+
[name: string]: unknown;
|
|
5438
|
+
};
|
|
5439
|
+
content?: never;
|
|
5440
|
+
};
|
|
5441
|
+
};
|
|
5442
|
+
};
|
|
5153
5443
|
V1TicketsController_listTickets: {
|
|
5154
5444
|
parameters: {
|
|
5155
5445
|
query?: {
|
|
@@ -6132,34 +6422,22 @@ interface operations {
|
|
|
6132
6422
|
};
|
|
6133
6423
|
};
|
|
6134
6424
|
};
|
|
6135
|
-
|
|
6425
|
+
V1FoldersController_listFolders: {
|
|
6136
6426
|
parameters: {
|
|
6137
|
-
query?:
|
|
6138
|
-
|
|
6139
|
-
|
|
6140
|
-
|
|
6427
|
+
query?: {
|
|
6428
|
+
/** @description List only the direct subfolders of this folder. Omit to list every folder of the company. */
|
|
6429
|
+
parentFolderId?: string;
|
|
6430
|
+
/** @description Case and accent insensitive match on the folder name. */
|
|
6431
|
+
q?: string;
|
|
6141
6432
|
};
|
|
6433
|
+
header?: never;
|
|
6434
|
+
path?: never;
|
|
6142
6435
|
cookie?: never;
|
|
6143
6436
|
};
|
|
6144
6437
|
requestBody?: never;
|
|
6145
6438
|
responses: {
|
|
6439
|
+
/** @description Folders */
|
|
6146
6440
|
200: {
|
|
6147
|
-
headers: {
|
|
6148
|
-
[name: string]: unknown;
|
|
6149
|
-
};
|
|
6150
|
-
content: {
|
|
6151
|
-
"application/json": components["schemas"]["JourneyEntryInfoDto"];
|
|
6152
|
-
};
|
|
6153
|
-
};
|
|
6154
|
-
/** @description Invalid contact, case reference or request ID */
|
|
6155
|
-
400: {
|
|
6156
|
-
headers: {
|
|
6157
|
-
[name: string]: unknown;
|
|
6158
|
-
};
|
|
6159
|
-
content?: never;
|
|
6160
|
-
};
|
|
6161
|
-
/** @description This evaluation is not available */
|
|
6162
|
-
404: {
|
|
6163
6441
|
headers: {
|
|
6164
6442
|
[name: string]: unknown;
|
|
6165
6443
|
};
|
|
@@ -6167,30 +6445,501 @@ interface operations {
|
|
|
6167
6445
|
};
|
|
6168
6446
|
};
|
|
6169
6447
|
};
|
|
6170
|
-
|
|
6448
|
+
V1FoldersController_createFolder: {
|
|
6171
6449
|
parameters: {
|
|
6172
6450
|
query?: never;
|
|
6173
|
-
header?:
|
|
6174
|
-
|
|
6175
|
-
|
|
6451
|
+
header?: {
|
|
6452
|
+
/** @description Client-generated key to make the create safe to retry. A retry with the same key returns the original result instead of creating again. */
|
|
6453
|
+
"X-Woku-Idempotency-Key"?: string;
|
|
6176
6454
|
};
|
|
6455
|
+
path?: never;
|
|
6177
6456
|
cookie?: never;
|
|
6178
6457
|
};
|
|
6179
6458
|
requestBody: {
|
|
6180
6459
|
content: {
|
|
6181
|
-
"application/json": components["schemas"]["
|
|
6460
|
+
"application/json": components["schemas"]["CreateFolderBodyDTO"];
|
|
6182
6461
|
};
|
|
6183
6462
|
};
|
|
6184
6463
|
responses: {
|
|
6464
|
+
/** @description Folder created */
|
|
6185
6465
|
201: {
|
|
6186
6466
|
headers: {
|
|
6187
6467
|
[name: string]: unknown;
|
|
6188
6468
|
};
|
|
6189
|
-
content
|
|
6190
|
-
"application/json": components["schemas"]["PreparedJourneyEntryDto"];
|
|
6191
|
-
};
|
|
6469
|
+
content?: never;
|
|
6192
6470
|
};
|
|
6193
|
-
/** @description
|
|
6471
|
+
/** @description Validation error */
|
|
6472
|
+
400: {
|
|
6473
|
+
headers: {
|
|
6474
|
+
[name: string]: unknown;
|
|
6475
|
+
};
|
|
6476
|
+
content: {
|
|
6477
|
+
"application/json": components["schemas"]["ValidationErrorResponseDto"];
|
|
6478
|
+
};
|
|
6479
|
+
};
|
|
6480
|
+
/** @description Parent folder not found */
|
|
6481
|
+
404: {
|
|
6482
|
+
headers: {
|
|
6483
|
+
[name: string]: unknown;
|
|
6484
|
+
};
|
|
6485
|
+
content?: never;
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
};
|
|
6489
|
+
V1FoldersController_getFolder: {
|
|
6490
|
+
parameters: {
|
|
6491
|
+
query?: never;
|
|
6492
|
+
header?: never;
|
|
6493
|
+
path: {
|
|
6494
|
+
id: string;
|
|
6495
|
+
};
|
|
6496
|
+
cookie?: never;
|
|
6497
|
+
};
|
|
6498
|
+
requestBody?: never;
|
|
6499
|
+
responses: {
|
|
6500
|
+
/** @description Folder */
|
|
6501
|
+
200: {
|
|
6502
|
+
headers: {
|
|
6503
|
+
[name: string]: unknown;
|
|
6504
|
+
};
|
|
6505
|
+
content?: never;
|
|
6506
|
+
};
|
|
6507
|
+
/** @description Folder not found */
|
|
6508
|
+
404: {
|
|
6509
|
+
headers: {
|
|
6510
|
+
[name: string]: unknown;
|
|
6511
|
+
};
|
|
6512
|
+
content?: never;
|
|
6513
|
+
};
|
|
6514
|
+
};
|
|
6515
|
+
};
|
|
6516
|
+
V1FoldersController_deleteFolder: {
|
|
6517
|
+
parameters: {
|
|
6518
|
+
query?: never;
|
|
6519
|
+
header?: never;
|
|
6520
|
+
path: {
|
|
6521
|
+
id: string;
|
|
6522
|
+
};
|
|
6523
|
+
cookie?: never;
|
|
6524
|
+
};
|
|
6525
|
+
requestBody?: never;
|
|
6526
|
+
responses: {
|
|
6527
|
+
/** @description Folder deleted */
|
|
6528
|
+
200: {
|
|
6529
|
+
headers: {
|
|
6530
|
+
[name: string]: unknown;
|
|
6531
|
+
};
|
|
6532
|
+
content?: never;
|
|
6533
|
+
};
|
|
6534
|
+
/** @description Folder not found */
|
|
6535
|
+
404: {
|
|
6536
|
+
headers: {
|
|
6537
|
+
[name: string]: unknown;
|
|
6538
|
+
};
|
|
6539
|
+
content?: never;
|
|
6540
|
+
};
|
|
6541
|
+
};
|
|
6542
|
+
};
|
|
6543
|
+
V1FoldersController_updateFolder: {
|
|
6544
|
+
parameters: {
|
|
6545
|
+
query?: never;
|
|
6546
|
+
header?: never;
|
|
6547
|
+
path: {
|
|
6548
|
+
id: string;
|
|
6549
|
+
};
|
|
6550
|
+
cookie?: never;
|
|
6551
|
+
};
|
|
6552
|
+
requestBody: {
|
|
6553
|
+
content: {
|
|
6554
|
+
"application/json": components["schemas"]["UpdateFolderBodyDTO"];
|
|
6555
|
+
};
|
|
6556
|
+
};
|
|
6557
|
+
responses: {
|
|
6558
|
+
/** @description Folder updated */
|
|
6559
|
+
200: {
|
|
6560
|
+
headers: {
|
|
6561
|
+
[name: string]: unknown;
|
|
6562
|
+
};
|
|
6563
|
+
content?: never;
|
|
6564
|
+
};
|
|
6565
|
+
/** @description Folder not found */
|
|
6566
|
+
404: {
|
|
6567
|
+
headers: {
|
|
6568
|
+
[name: string]: unknown;
|
|
6569
|
+
};
|
|
6570
|
+
content?: never;
|
|
6571
|
+
};
|
|
6572
|
+
};
|
|
6573
|
+
};
|
|
6574
|
+
V1FoldersController_getFolderReport: {
|
|
6575
|
+
parameters: {
|
|
6576
|
+
query?: {
|
|
6577
|
+
/** @description Regenerate the report even if the number of reviews did not change. */
|
|
6578
|
+
regenerate?: boolean;
|
|
6579
|
+
/** @description Language of the report narrative. */
|
|
6580
|
+
lang?: "es" | "en";
|
|
6581
|
+
};
|
|
6582
|
+
header?: never;
|
|
6583
|
+
path: {
|
|
6584
|
+
id: string;
|
|
6585
|
+
};
|
|
6586
|
+
cookie?: never;
|
|
6587
|
+
};
|
|
6588
|
+
requestBody?: never;
|
|
6589
|
+
responses: {
|
|
6590
|
+
/** @description Folder report */
|
|
6591
|
+
200: {
|
|
6592
|
+
headers: {
|
|
6593
|
+
[name: string]: unknown;
|
|
6594
|
+
};
|
|
6595
|
+
content?: never;
|
|
6596
|
+
};
|
|
6597
|
+
/** @description Folder not found */
|
|
6598
|
+
404: {
|
|
6599
|
+
headers: {
|
|
6600
|
+
[name: string]: unknown;
|
|
6601
|
+
};
|
|
6602
|
+
content?: never;
|
|
6603
|
+
};
|
|
6604
|
+
};
|
|
6605
|
+
};
|
|
6606
|
+
V1FoldersController_getFolderPdf: {
|
|
6607
|
+
parameters: {
|
|
6608
|
+
query?: {
|
|
6609
|
+
/** @description Language of the PDF. Defaults to the report language. */
|
|
6610
|
+
lang?: "es" | "en";
|
|
6611
|
+
};
|
|
6612
|
+
header?: never;
|
|
6613
|
+
path: {
|
|
6614
|
+
id: string;
|
|
6615
|
+
};
|
|
6616
|
+
cookie?: never;
|
|
6617
|
+
};
|
|
6618
|
+
requestBody?: never;
|
|
6619
|
+
responses: {
|
|
6620
|
+
/** @description PDF file */
|
|
6621
|
+
200: {
|
|
6622
|
+
headers: {
|
|
6623
|
+
[name: string]: unknown;
|
|
6624
|
+
};
|
|
6625
|
+
content: {
|
|
6626
|
+
"application/pdf": string;
|
|
6627
|
+
};
|
|
6628
|
+
};
|
|
6629
|
+
/** @description Folder not found */
|
|
6630
|
+
404: {
|
|
6631
|
+
headers: {
|
|
6632
|
+
[name: string]: unknown;
|
|
6633
|
+
};
|
|
6634
|
+
content?: never;
|
|
6635
|
+
};
|
|
6636
|
+
};
|
|
6637
|
+
};
|
|
6638
|
+
V1FoldersController_getFolderMetrics: {
|
|
6639
|
+
parameters: {
|
|
6640
|
+
query?: {
|
|
6641
|
+
/** @description Period in days: 7, 30 or 90, or 0 for the whole history. Defaults to 30. */
|
|
6642
|
+
days?: 0 | 7 | 30 | 90;
|
|
6643
|
+
};
|
|
6644
|
+
header?: never;
|
|
6645
|
+
path: {
|
|
6646
|
+
id: string;
|
|
6647
|
+
};
|
|
6648
|
+
cookie?: never;
|
|
6649
|
+
};
|
|
6650
|
+
requestBody?: never;
|
|
6651
|
+
responses: {
|
|
6652
|
+
/** @description Folder tool metrics */
|
|
6653
|
+
200: {
|
|
6654
|
+
headers: {
|
|
6655
|
+
[name: string]: unknown;
|
|
6656
|
+
};
|
|
6657
|
+
content?: never;
|
|
6658
|
+
};
|
|
6659
|
+
/** @description Folder not found */
|
|
6660
|
+
404: {
|
|
6661
|
+
headers: {
|
|
6662
|
+
[name: string]: unknown;
|
|
6663
|
+
};
|
|
6664
|
+
content?: never;
|
|
6665
|
+
};
|
|
6666
|
+
};
|
|
6667
|
+
};
|
|
6668
|
+
V1FoldersController_getFolderCsv: {
|
|
6669
|
+
parameters: {
|
|
6670
|
+
query?: never;
|
|
6671
|
+
header?: never;
|
|
6672
|
+
path: {
|
|
6673
|
+
id: string;
|
|
6674
|
+
};
|
|
6675
|
+
cookie?: never;
|
|
6676
|
+
};
|
|
6677
|
+
requestBody?: never;
|
|
6678
|
+
responses: {
|
|
6679
|
+
/** @description CSV file */
|
|
6680
|
+
200: {
|
|
6681
|
+
headers: {
|
|
6682
|
+
[name: string]: unknown;
|
|
6683
|
+
};
|
|
6684
|
+
content: {
|
|
6685
|
+
"text/csv": string;
|
|
6686
|
+
};
|
|
6687
|
+
};
|
|
6688
|
+
/** @description Folder not found */
|
|
6689
|
+
404: {
|
|
6690
|
+
headers: {
|
|
6691
|
+
[name: string]: unknown;
|
|
6692
|
+
};
|
|
6693
|
+
content?: never;
|
|
6694
|
+
};
|
|
6695
|
+
};
|
|
6696
|
+
};
|
|
6697
|
+
V1FoldersController_moveFolder: {
|
|
6698
|
+
parameters: {
|
|
6699
|
+
query?: never;
|
|
6700
|
+
header?: never;
|
|
6701
|
+
path: {
|
|
6702
|
+
id: string;
|
|
6703
|
+
};
|
|
6704
|
+
cookie?: never;
|
|
6705
|
+
};
|
|
6706
|
+
requestBody: {
|
|
6707
|
+
content: {
|
|
6708
|
+
"application/json": components["schemas"]["MoveFolderBodyDTO"];
|
|
6709
|
+
};
|
|
6710
|
+
};
|
|
6711
|
+
responses: {
|
|
6712
|
+
/** @description Folder moved */
|
|
6713
|
+
200: {
|
|
6714
|
+
headers: {
|
|
6715
|
+
[name: string]: unknown;
|
|
6716
|
+
};
|
|
6717
|
+
content?: never;
|
|
6718
|
+
};
|
|
6719
|
+
/** @description A folder cannot move into itself or one of its subfolders */
|
|
6720
|
+
400: {
|
|
6721
|
+
headers: {
|
|
6722
|
+
[name: string]: unknown;
|
|
6723
|
+
};
|
|
6724
|
+
content: {
|
|
6725
|
+
"application/json": components["schemas"]["ValidationErrorResponseDto"];
|
|
6726
|
+
};
|
|
6727
|
+
};
|
|
6728
|
+
/** @description Folder not found */
|
|
6729
|
+
404: {
|
|
6730
|
+
headers: {
|
|
6731
|
+
[name: string]: unknown;
|
|
6732
|
+
};
|
|
6733
|
+
content?: never;
|
|
6734
|
+
};
|
|
6735
|
+
};
|
|
6736
|
+
};
|
|
6737
|
+
V1ToolsController_listTools: {
|
|
6738
|
+
parameters: {
|
|
6739
|
+
query?: {
|
|
6740
|
+
/** @description `level` (default) lists one folder level; `company` is a flat list of every tool of the company. */
|
|
6741
|
+
scope?: "level" | "company";
|
|
6742
|
+
/** @description Comma separated tool types: woku, nps, csat, ces. */
|
|
6743
|
+
types?: string[];
|
|
6744
|
+
/** @description Case and accent insensitive search over names and questions. A search is company-wide and also matches folder names. */
|
|
6745
|
+
q?: string;
|
|
6746
|
+
sort?: "name" | "-name" | "created" | "-created";
|
|
6747
|
+
/** @description Opaque `nextCursor` of the previous page. */
|
|
6748
|
+
cursor?: string;
|
|
6749
|
+
limit?: number;
|
|
6750
|
+
/** @description Folders per page ("see more"). Omitted returns every folder of the level. */
|
|
6751
|
+
foldersLimit?: number;
|
|
6752
|
+
/** @description Opaque `foldersNextCursor` of a previous page. Returns only that page of folders, without tools. */
|
|
6753
|
+
foldersCursor?: string;
|
|
6754
|
+
/** @description Only tools created on or after this date (ISO 8601). */
|
|
6755
|
+
createdFrom?: string;
|
|
6756
|
+
/** @description Only tools created on or before this date (ISO 8601). */
|
|
6757
|
+
createdTo?: string;
|
|
6758
|
+
/** @description Tracker chips as `name:value`, repeatable (`?trackers=TRR:00482&trackers=OC:2024`, up to 10). A tool matches when it has every one: the tracker name is matched exactly, the value partially and ignoring case (`482` also matches `00482`). Like a search, it is company-wide and lists no folders. A chip without name or value is a 400. */
|
|
6759
|
+
trackers?: string[];
|
|
6760
|
+
/** @description Folder whose direct content is listed. Omit for the root. Ignored when `scope=company` or when searching. */
|
|
6761
|
+
folderId?: string;
|
|
6762
|
+
};
|
|
6763
|
+
header?: never;
|
|
6764
|
+
path?: never;
|
|
6765
|
+
cookie?: never;
|
|
6766
|
+
};
|
|
6767
|
+
requestBody?: never;
|
|
6768
|
+
responses: {
|
|
6769
|
+
/** @description Folders, tools and facets */
|
|
6770
|
+
200: {
|
|
6771
|
+
headers: {
|
|
6772
|
+
[name: string]: unknown;
|
|
6773
|
+
};
|
|
6774
|
+
content?: never;
|
|
6775
|
+
};
|
|
6776
|
+
};
|
|
6777
|
+
};
|
|
6778
|
+
V1ToolsController_getToolsStats: {
|
|
6779
|
+
parameters: {
|
|
6780
|
+
query?: {
|
|
6781
|
+
/** @description Scope the figures to this folder and its subfolders. Omit for the whole company. */
|
|
6782
|
+
folderId?: string;
|
|
6783
|
+
/** @description Only responses on or after this date (ISO 8601). */
|
|
6784
|
+
from?: string;
|
|
6785
|
+
/** @description Only responses on or before this date (ISO 8601). */
|
|
6786
|
+
to?: string;
|
|
6787
|
+
};
|
|
6788
|
+
header?: never;
|
|
6789
|
+
path?: never;
|
|
6790
|
+
cookie?: never;
|
|
6791
|
+
};
|
|
6792
|
+
requestBody?: never;
|
|
6793
|
+
responses: {
|
|
6794
|
+
/** @description Figures per type */
|
|
6795
|
+
200: {
|
|
6796
|
+
headers: {
|
|
6797
|
+
[name: string]: unknown;
|
|
6798
|
+
};
|
|
6799
|
+
content?: never;
|
|
6800
|
+
};
|
|
6801
|
+
};
|
|
6802
|
+
};
|
|
6803
|
+
V1ToolsController_moveTools: {
|
|
6804
|
+
parameters: {
|
|
6805
|
+
query?: never;
|
|
6806
|
+
header?: never;
|
|
6807
|
+
path?: never;
|
|
6808
|
+
cookie?: never;
|
|
6809
|
+
};
|
|
6810
|
+
requestBody: {
|
|
6811
|
+
content: {
|
|
6812
|
+
"application/json": components["schemas"]["MoveToolItemsBodyDTO"];
|
|
6813
|
+
};
|
|
6814
|
+
};
|
|
6815
|
+
responses: {
|
|
6816
|
+
/** @description Items moved */
|
|
6817
|
+
200: {
|
|
6818
|
+
headers: {
|
|
6819
|
+
[name: string]: unknown;
|
|
6820
|
+
};
|
|
6821
|
+
content?: never;
|
|
6822
|
+
};
|
|
6823
|
+
/** @description Invalid move (for example a folder into its own subtree) */
|
|
6824
|
+
400: {
|
|
6825
|
+
headers: {
|
|
6826
|
+
[name: string]: unknown;
|
|
6827
|
+
};
|
|
6828
|
+
content: {
|
|
6829
|
+
"application/json": components["schemas"]["ValidationErrorResponseDto"];
|
|
6830
|
+
};
|
|
6831
|
+
};
|
|
6832
|
+
/** @description Folder or item not found */
|
|
6833
|
+
404: {
|
|
6834
|
+
headers: {
|
|
6835
|
+
[name: string]: unknown;
|
|
6836
|
+
};
|
|
6837
|
+
content?: never;
|
|
6838
|
+
};
|
|
6839
|
+
};
|
|
6840
|
+
};
|
|
6841
|
+
V1JourneyFoldersController_getJourneyFolders: {
|
|
6842
|
+
parameters: {
|
|
6843
|
+
query?: never;
|
|
6844
|
+
header?: never;
|
|
6845
|
+
path?: never;
|
|
6846
|
+
cookie?: never;
|
|
6847
|
+
};
|
|
6848
|
+
requestBody?: never;
|
|
6849
|
+
responses: {
|
|
6850
|
+
/** @description Status */
|
|
6851
|
+
200: {
|
|
6852
|
+
headers: {
|
|
6853
|
+
[name: string]: unknown;
|
|
6854
|
+
};
|
|
6855
|
+
content?: never;
|
|
6856
|
+
};
|
|
6857
|
+
};
|
|
6858
|
+
};
|
|
6859
|
+
V1JourneyFoldersController_organizeJourneyFolders: {
|
|
6860
|
+
parameters: {
|
|
6861
|
+
query?: never;
|
|
6862
|
+
header?: never;
|
|
6863
|
+
path?: never;
|
|
6864
|
+
cookie?: never;
|
|
6865
|
+
};
|
|
6866
|
+
requestBody?: never;
|
|
6867
|
+
responses: {
|
|
6868
|
+
/** @description Organization started */
|
|
6869
|
+
202: {
|
|
6870
|
+
headers: {
|
|
6871
|
+
[name: string]: unknown;
|
|
6872
|
+
};
|
|
6873
|
+
content?: never;
|
|
6874
|
+
};
|
|
6875
|
+
/** @description Already organizing */
|
|
6876
|
+
409: {
|
|
6877
|
+
headers: {
|
|
6878
|
+
[name: string]: unknown;
|
|
6879
|
+
};
|
|
6880
|
+
content?: never;
|
|
6881
|
+
};
|
|
6882
|
+
};
|
|
6883
|
+
};
|
|
6884
|
+
CustomJourneyEntryController_info: {
|
|
6885
|
+
parameters: {
|
|
6886
|
+
query?: never;
|
|
6887
|
+
header?: never;
|
|
6888
|
+
path: {
|
|
6889
|
+
journeyId: string;
|
|
6890
|
+
};
|
|
6891
|
+
cookie?: never;
|
|
6892
|
+
};
|
|
6893
|
+
requestBody?: never;
|
|
6894
|
+
responses: {
|
|
6895
|
+
200: {
|
|
6896
|
+
headers: {
|
|
6897
|
+
[name: string]: unknown;
|
|
6898
|
+
};
|
|
6899
|
+
content: {
|
|
6900
|
+
"application/json": components["schemas"]["JourneyEntryInfoDto"];
|
|
6901
|
+
};
|
|
6902
|
+
};
|
|
6903
|
+
/** @description Invalid contact, case reference or request ID */
|
|
6904
|
+
400: {
|
|
6905
|
+
headers: {
|
|
6906
|
+
[name: string]: unknown;
|
|
6907
|
+
};
|
|
6908
|
+
content?: never;
|
|
6909
|
+
};
|
|
6910
|
+
/** @description This evaluation is not available */
|
|
6911
|
+
404: {
|
|
6912
|
+
headers: {
|
|
6913
|
+
[name: string]: unknown;
|
|
6914
|
+
};
|
|
6915
|
+
content?: never;
|
|
6916
|
+
};
|
|
6917
|
+
};
|
|
6918
|
+
};
|
|
6919
|
+
CustomJourneyEntryController_prepare: {
|
|
6920
|
+
parameters: {
|
|
6921
|
+
query?: never;
|
|
6922
|
+
header?: never;
|
|
6923
|
+
path: {
|
|
6924
|
+
journeyId: string;
|
|
6925
|
+
};
|
|
6926
|
+
cookie?: never;
|
|
6927
|
+
};
|
|
6928
|
+
requestBody: {
|
|
6929
|
+
content: {
|
|
6930
|
+
"application/json": components["schemas"]["PrepareJourneyEntryDto"];
|
|
6931
|
+
};
|
|
6932
|
+
};
|
|
6933
|
+
responses: {
|
|
6934
|
+
201: {
|
|
6935
|
+
headers: {
|
|
6936
|
+
[name: string]: unknown;
|
|
6937
|
+
};
|
|
6938
|
+
content: {
|
|
6939
|
+
"application/json": components["schemas"]["PreparedJourneyEntryDto"];
|
|
6940
|
+
};
|
|
6941
|
+
};
|
|
6942
|
+
/** @description Invalid contact, case reference or request ID */
|
|
6194
6943
|
400: {
|
|
6195
6944
|
headers: {
|
|
6196
6945
|
[name: string]: unknown;
|
|
@@ -6228,6 +6977,11 @@ type CreateTrackerParams = Schemas['CreateExternalTrackerDefinitionDTO'];
|
|
|
6228
6977
|
type UpdateTrackerParams = Schemas['UpdateExternalTrackerDefinitionDTO'];
|
|
6229
6978
|
type SearchEntitiesByTrackersParams = Schemas['SearchEntitiesByTrackersDTO'];
|
|
6230
6979
|
type AssignTrackerByNameParams = Schemas['AssignExternalTrackerByNameDTO'];
|
|
6980
|
+
type CreateFlowParams = Schemas['CreateFlowBodyDTO'];
|
|
6981
|
+
type UpdateFlowParams = Schemas['UpdateFlowBodyDTO'];
|
|
6982
|
+
type CreateFolderParams = Schemas['CreateFolderBodyDTO'];
|
|
6983
|
+
type UpdateFolderParams = Schemas['UpdateFolderBodyDTO'];
|
|
6984
|
+
type MoveToolItemsParams = Schemas['MoveToolItemsBodyDTO'];
|
|
6231
6985
|
type CreateNpsToolParams = Schemas['CreateNpsToolBodyDTO'];
|
|
6232
6986
|
type UpdateNpsToolParams = Schemas['UpdateNpsToolBodyDTO'];
|
|
6233
6987
|
type CreateCsatToolParams = Schemas['CreateCsatToolBodyDTO'];
|
|
@@ -6317,6 +7071,8 @@ interface ToolLocalizedContent {
|
|
|
6317
7071
|
/** NPS tool definition (curated, no internal fields). */
|
|
6318
7072
|
interface NpsTool {
|
|
6319
7073
|
_id: string;
|
|
7074
|
+
/** Folder the tool lives in, `null` at the root. */
|
|
7075
|
+
folderId?: string | null;
|
|
6320
7076
|
name: string;
|
|
6321
7077
|
npsMessage: string;
|
|
6322
7078
|
audienceType?: string;
|
|
@@ -6328,6 +7084,8 @@ interface NpsTool {
|
|
|
6328
7084
|
/** CSAT tool definition (curated). */
|
|
6329
7085
|
interface CsatTool {
|
|
6330
7086
|
_id: string;
|
|
7087
|
+
/** Folder the tool lives in, `null` at the root. */
|
|
7088
|
+
folderId?: string | null;
|
|
6331
7089
|
name: string;
|
|
6332
7090
|
question: string;
|
|
6333
7091
|
subject?: string;
|
|
@@ -6339,6 +7097,8 @@ interface CsatTool {
|
|
|
6339
7097
|
/** CES tool definition (curated). */
|
|
6340
7098
|
interface CesTool {
|
|
6341
7099
|
_id: string;
|
|
7100
|
+
/** Folder the tool lives in, `null` at the root. */
|
|
7101
|
+
folderId?: string | null;
|
|
6342
7102
|
name: string;
|
|
6343
7103
|
question: string;
|
|
6344
7104
|
action?: string;
|
|
@@ -6565,6 +7325,176 @@ interface ApiKeyResult {
|
|
|
6565
7325
|
secretKey: string;
|
|
6566
7326
|
[key: string]: unknown;
|
|
6567
7327
|
}
|
|
7328
|
+
/** Kinds of item the Tools view mixes. */
|
|
7329
|
+
type ToolType = 'woku' | 'nps' | 'csat' | 'ces';
|
|
7330
|
+
/** Headline figure of a tool, always in its native scale (scales are never mixed). */
|
|
7331
|
+
interface ToolHeadline {
|
|
7332
|
+
kind: 'stars' | 'nps' | 'csat' | 'ces';
|
|
7333
|
+
/** Stars 1-5, NPS -100..100, CSAT satisfied %, CES mean 1-5. `null` without responses. */
|
|
7334
|
+
value: number | null;
|
|
7335
|
+
scale: string;
|
|
7336
|
+
}
|
|
7337
|
+
/** A woku, NPS, CSAT or CES tool as listed by `tools.list`. */
|
|
7338
|
+
interface ToolItem {
|
|
7339
|
+
type: ToolType;
|
|
7340
|
+
id: string;
|
|
7341
|
+
name: string;
|
|
7342
|
+
folderId: string | null;
|
|
7343
|
+
createdAt: string | null;
|
|
7344
|
+
reviewCount: number;
|
|
7345
|
+
lastResponseAt: string | null;
|
|
7346
|
+
headline: ToolHeadline;
|
|
7347
|
+
}
|
|
7348
|
+
/** Subtree figures of a folder. */
|
|
7349
|
+
interface FolderStats {
|
|
7350
|
+
toolCounts: Record<ToolType, number>;
|
|
7351
|
+
subfolderCount: number;
|
|
7352
|
+
reviewCount: number;
|
|
7353
|
+
}
|
|
7354
|
+
/**
|
|
7355
|
+
* Kind of a system folder created by woku: the `Viajes` root, one journey, one
|
|
7356
|
+
* journey moment or an integration (Shopify, Pancake). `null` for your own folders.
|
|
7357
|
+
*/
|
|
7358
|
+
type FolderOrigin = 'journeys-root' | 'journey' | 'journey-moment' | 'integration';
|
|
7359
|
+
/** A WhatsApp number that receives improvement alerts of a folder. */
|
|
7360
|
+
interface WhatsappAlertRecipient {
|
|
7361
|
+
/** E.164 phone number without the leading +. */
|
|
7362
|
+
whatsappId: string;
|
|
7363
|
+
name: string;
|
|
7364
|
+
/** Kinds of comment that alert this number (numbers created before this feature only get `woku`). */
|
|
7365
|
+
sources: ToolType[];
|
|
7366
|
+
}
|
|
7367
|
+
/** A folder with its breadcrumb path and subtree stats. */
|
|
7368
|
+
interface Folder {
|
|
7369
|
+
id: string;
|
|
7370
|
+
name: string;
|
|
7371
|
+
color: string | null;
|
|
7372
|
+
parentFolderId: string | null;
|
|
7373
|
+
/** Breadcrumb from the root, for example `Journeys > Post-sale`. */
|
|
7374
|
+
path: string;
|
|
7375
|
+
/** System folder kind, `null` for a folder you created. */
|
|
7376
|
+
origin: FolderOrigin | null;
|
|
7377
|
+
/** Provider of an integration folder (`shopify`, `pancake`), otherwise `null`. */
|
|
7378
|
+
integrationProvider?: string | null;
|
|
7379
|
+
/** WhatsApp numbers alerted when a comment of any tool in the folder is an improvement. */
|
|
7380
|
+
whatsappAlertRecipients: WhatsappAlertRecipient[];
|
|
7381
|
+
createdAt: string | null;
|
|
7382
|
+
stats: FolderStats;
|
|
7383
|
+
}
|
|
7384
|
+
/** One page of `tools.list`: folders, tools, facet counts and the cursor. */
|
|
7385
|
+
interface ToolItemsPageResponse {
|
|
7386
|
+
folders: Folder[];
|
|
7387
|
+
/** Cursor of the next page of folders; null when they were all returned. */
|
|
7388
|
+
foldersNextCursor: string | null;
|
|
7389
|
+
tools: ToolItem[];
|
|
7390
|
+
nextCursor: string | null;
|
|
7391
|
+
facets: {
|
|
7392
|
+
types: Record<ToolType, number>;
|
|
7393
|
+
};
|
|
7394
|
+
}
|
|
7395
|
+
/** Headline figures of one tool type for the company or a folder. */
|
|
7396
|
+
interface ToolTypeStats {
|
|
7397
|
+
toolCount: number;
|
|
7398
|
+
reviewCount: number;
|
|
7399
|
+
headline: ToolHeadline;
|
|
7400
|
+
lastResponseAt: string | null;
|
|
7401
|
+
/** NPS only. */
|
|
7402
|
+
distribution?: {
|
|
7403
|
+
promoters: number;
|
|
7404
|
+
passives: number;
|
|
7405
|
+
detractors: number;
|
|
7406
|
+
};
|
|
7407
|
+
}
|
|
7408
|
+
/** A type that failed to compute reports `{ error: true }`; the others stay valid. */
|
|
7409
|
+
type ToolsStats = Record<ToolType, ToolTypeStats | {
|
|
7410
|
+
error: true;
|
|
7411
|
+
}>;
|
|
7412
|
+
/** One window (the period, or the one before it) of one tool. */
|
|
7413
|
+
interface ToolWindow {
|
|
7414
|
+
count: number;
|
|
7415
|
+
headline: ToolHeadline;
|
|
7416
|
+
/** Share (0-100) of positive responses: 4-5, or NPS promoters; `null` with no responses. */
|
|
7417
|
+
positive: number | null;
|
|
7418
|
+
/** Share (0-100) of negative responses: 1-2, or NPS detractors; `null` with no responses. */
|
|
7419
|
+
negative: number | null;
|
|
7420
|
+
/** The raw counts and score sum behind the shares, to combine tools without rounding drift. */
|
|
7421
|
+
positiveCount: number;
|
|
7422
|
+
negativeCount: number;
|
|
7423
|
+
scoreSum: number;
|
|
7424
|
+
}
|
|
7425
|
+
/** Per-tool figures of `folders.metrics`: the period against the one before it. */
|
|
7426
|
+
interface ToolMetrics {
|
|
7427
|
+
type: ToolType;
|
|
7428
|
+
id: string;
|
|
7429
|
+
name: string;
|
|
7430
|
+
/** Responses ever received. */
|
|
7431
|
+
totalResponses: number;
|
|
7432
|
+
lastResponseAt: string | null;
|
|
7433
|
+
current: ToolWindow;
|
|
7434
|
+
previous: ToolWindow;
|
|
7435
|
+
}
|
|
7436
|
+
/** Sums of one day (UTC) and tool type, enough to rebuild any score on any bucket. */
|
|
7437
|
+
interface DailyPoint {
|
|
7438
|
+
date: string;
|
|
7439
|
+
type: ToolType;
|
|
7440
|
+
count: number;
|
|
7441
|
+
scoreSum: number;
|
|
7442
|
+
positive: number;
|
|
7443
|
+
negative: number;
|
|
7444
|
+
}
|
|
7445
|
+
/** Result of `folders.metrics`. */
|
|
7446
|
+
interface FolderToolMetrics {
|
|
7447
|
+
/** Period in days; `0` is the whole history (then every `previous` window is empty). */
|
|
7448
|
+
days: number;
|
|
7449
|
+
tools: ToolMetrics[];
|
|
7450
|
+
/** Daily sums of both windows (2 x `days`). */
|
|
7451
|
+
daily: DailyPoint[];
|
|
7452
|
+
/** Responses per score in the period: 0-10 for NPS, 1-5 for the rest. */
|
|
7453
|
+
distribution: Record<ToolType, number[]>;
|
|
7454
|
+
}
|
|
7455
|
+
/** Result of `tools.move` and `folders.move` batches. */
|
|
7456
|
+
interface MoveResult {
|
|
7457
|
+
moved: number;
|
|
7458
|
+
folderId: string | null;
|
|
7459
|
+
items: {
|
|
7460
|
+
type: ToolType | 'folder';
|
|
7461
|
+
id: string;
|
|
7462
|
+
}[];
|
|
7463
|
+
}
|
|
7464
|
+
/** The CSV of a folder: the raw text, one row per response. */
|
|
7465
|
+
type FolderCsv = string;
|
|
7466
|
+
/** Whether the company keeps its journeys in folders (`Viajes > journey > moment`). */
|
|
7467
|
+
interface JourneyFoldersStatus {
|
|
7468
|
+
enabled: boolean;
|
|
7469
|
+
enabledAt: string | null;
|
|
7470
|
+
organizedAt: string | null;
|
|
7471
|
+
/** True while the one-off organization is running in the background. */
|
|
7472
|
+
organizing: boolean;
|
|
7473
|
+
/** Journeys and tools still without a folder. */
|
|
7474
|
+
pending: {
|
|
7475
|
+
journeys: number;
|
|
7476
|
+
tools: number;
|
|
7477
|
+
};
|
|
7478
|
+
}
|
|
7479
|
+
/** One step of a flow: the tool the respondent answers at that point. */
|
|
7480
|
+
interface FlowStep {
|
|
7481
|
+
type: ToolType;
|
|
7482
|
+
/** Tool id. For an `nps` step, your company id means the company-level NPS. */
|
|
7483
|
+
toolId: string;
|
|
7484
|
+
}
|
|
7485
|
+
/** A survey flow: an ordered sequence of woku, NPS, CSAT and CES steps. */
|
|
7486
|
+
interface Flow {
|
|
7487
|
+
_id: string;
|
|
7488
|
+
name: string;
|
|
7489
|
+
/** Ordered steps. Flows live outside folders. */
|
|
7490
|
+
steps: FlowStep[];
|
|
7491
|
+
/** Woku ids of the `woku` steps, in order (kept for compatibility). */
|
|
7492
|
+
wokusIds?: string[];
|
|
7493
|
+
npsToolId?: string | null;
|
|
7494
|
+
companyIdNps?: string | null;
|
|
7495
|
+
createdAt?: string;
|
|
7496
|
+
updatedAt?: string;
|
|
7497
|
+
}
|
|
6568
7498
|
|
|
6569
7499
|
/** Read authorized follow-up conversations with a company management secret. */
|
|
6570
7500
|
declare class FollowUps {
|
|
@@ -6632,6 +7562,10 @@ declare class NpsTools {
|
|
|
6632
7562
|
create(body: CreateNpsToolParams, opts?: RequestOptions): Promise<NpsTool>;
|
|
6633
7563
|
get(id: string, opts?: RequestOptions): Promise<NpsTool>;
|
|
6634
7564
|
update(id: string, body: UpdateNpsToolParams, opts?: RequestOptions): Promise<NpsTool>;
|
|
7565
|
+
/** Move the tool into a folder, or to the root with `folderId: null`. */
|
|
7566
|
+
move(id: string, body: {
|
|
7567
|
+
folderId: string | null;
|
|
7568
|
+
}, opts?: RequestOptions): Promise<NpsTool>;
|
|
6635
7569
|
delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
|
|
6636
7570
|
}
|
|
6637
7571
|
/** Manage CSAT tool definitions (`/v1/csat-tools`). */
|
|
@@ -6645,6 +7579,10 @@ declare class CsatTools {
|
|
|
6645
7579
|
create(body: CreateCsatToolParams, opts?: RequestOptions): Promise<CsatTool>;
|
|
6646
7580
|
get(id: string, opts?: RequestOptions): Promise<CsatTool>;
|
|
6647
7581
|
update(id: string, body: UpdateCsatToolParams, opts?: RequestOptions): Promise<CsatTool>;
|
|
7582
|
+
/** Move the tool into a folder, or to the root with `folderId: null`. */
|
|
7583
|
+
move(id: string, body: {
|
|
7584
|
+
folderId: string | null;
|
|
7585
|
+
}, opts?: RequestOptions): Promise<CsatTool>;
|
|
6648
7586
|
delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
|
|
6649
7587
|
}
|
|
6650
7588
|
/** Manage CES tool definitions (`/v1/ces-tools`). */
|
|
@@ -6658,6 +7596,10 @@ declare class CesTools {
|
|
|
6658
7596
|
create(body: CreateCesToolParams, opts?: RequestOptions): Promise<CesTool>;
|
|
6659
7597
|
get(id: string, opts?: RequestOptions): Promise<CesTool>;
|
|
6660
7598
|
update(id: string, body: UpdateCesToolParams, opts?: RequestOptions): Promise<CesTool>;
|
|
7599
|
+
/** Move the tool into a folder, or to the root with `folderId: null`. */
|
|
7600
|
+
move(id: string, body: {
|
|
7601
|
+
folderId: string | null;
|
|
7602
|
+
}, opts?: RequestOptions): Promise<CesTool>;
|
|
6661
7603
|
delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
|
|
6662
7604
|
}
|
|
6663
7605
|
|
|
@@ -6740,15 +7682,29 @@ declare class Forms {
|
|
|
6740
7682
|
sendInvitations(id: string, body: SendInvitationsParams, opts?: RequestOptions): Promise<InvitationsResult>;
|
|
6741
7683
|
}
|
|
6742
7684
|
|
|
6743
|
-
/**
|
|
7685
|
+
/**
|
|
7686
|
+
* Survey flows (`/v1/flows`): an ordered sequence of steps, each a woku or an
|
|
7687
|
+
* NPS, CSAT or CES tool, that a respondent answers one after the other.
|
|
7688
|
+
*/
|
|
6744
7689
|
declare class Flows {
|
|
6745
7690
|
private readonly client;
|
|
6746
7691
|
constructor(client: WokuClient);
|
|
7692
|
+
/** List the flows of the company, with their ordered `steps`. */
|
|
6747
7693
|
list(params?: {
|
|
6748
7694
|
page?: number;
|
|
6749
7695
|
limit?: number;
|
|
6750
|
-
}, opts?: RequestOptions): Promise<Page<
|
|
7696
|
+
}, opts?: RequestOptions): Promise<Page<Flow>>;
|
|
7697
|
+
/** The data of a flow: ordered steps with their tools, wokus and branding. */
|
|
6751
7698
|
get(id: string, opts?: RequestOptions): Promise<WokuRecord>;
|
|
7699
|
+
/**
|
|
7700
|
+
* Create a flow from 1 to 20 ordered steps (each tool once, all of your
|
|
7701
|
+
* company). Flows live outside folders.
|
|
7702
|
+
*/
|
|
7703
|
+
create(body: CreateFlowParams, opts?: RequestOptions): Promise<Flow>;
|
|
7704
|
+
/** Rename a flow or replace its full ordered list of steps. */
|
|
7705
|
+
update(id: string, body: UpdateFlowParams, opts?: RequestOptions): Promise<Flow>;
|
|
7706
|
+
/** Delete a flow. Its tools and their responses stay. */
|
|
7707
|
+
delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
|
|
6752
7708
|
}
|
|
6753
7709
|
|
|
6754
7710
|
interface ListActionPlansParams {
|
|
@@ -6903,7 +7859,16 @@ type JourneyMomentPreview = Schemas['V1JourneyPreviewResponseDto'];
|
|
|
6903
7859
|
type JourneyMomentTrigger = Schemas['V1JourneyTriggerDto'];
|
|
6904
7860
|
type JourneyMoment = Schemas['V1JourneyMomentDto'];
|
|
6905
7861
|
type JourneyInput = Schemas['V1UpdateJourneyBodyDto'];
|
|
6906
|
-
|
|
7862
|
+
/**
|
|
7863
|
+
* A journey as returned by `/v1/journeys`. `folderId` and `momentFolders`
|
|
7864
|
+
* (moment key to folder id) point at the folders that hold the journey's tools
|
|
7865
|
+
* once the company organized its journeys in folders; they are `null` and `{}`
|
|
7866
|
+
* before that. Reads only: they are not part of the journey definition.
|
|
7867
|
+
*/
|
|
7868
|
+
type Journey = Schemas['V1JourneyResponseDto'] & {
|
|
7869
|
+
folderId?: string | null;
|
|
7870
|
+
momentFolders?: Record<string, string>;
|
|
7871
|
+
};
|
|
6907
7872
|
type CreatedJourney = Schemas['V1CreatedJourneyResponseDto'];
|
|
6908
7873
|
type JourneyEnrollment = Schemas['V1JourneyParticipationDto'];
|
|
6909
7874
|
type JourneyEnrollmentPage = Schemas['V1JourneyParticipationPageDto'];
|
|
@@ -6995,6 +7960,165 @@ declare class Quarantines {
|
|
|
6995
7960
|
}, opts?: RequestOptions): Promise<WokuRecord>;
|
|
6996
7961
|
}
|
|
6997
7962
|
|
|
7963
|
+
/**
|
|
7964
|
+
* Folders that organize wokus and NPS, CSAT and CES tools (`/v1/folders`).
|
|
7965
|
+
* To list what a folder contains use `woku.tools.list({ folderId })`.
|
|
7966
|
+
*/
|
|
7967
|
+
declare class Folders {
|
|
7968
|
+
private readonly client;
|
|
7969
|
+
constructor(client: WokuClient);
|
|
7970
|
+
/** Every folder of the company, or the direct subfolders of `parentFolderId`. */
|
|
7971
|
+
list(params?: {
|
|
7972
|
+
parentFolderId?: string;
|
|
7973
|
+
q?: string;
|
|
7974
|
+
}, opts?: RequestOptions): Promise<Folder[]>;
|
|
7975
|
+
get(id: string, opts?: RequestOptions): Promise<Folder>;
|
|
7976
|
+
create(body: CreateFolderParams, opts?: RequestOptions): Promise<Folder>;
|
|
7977
|
+
/**
|
|
7978
|
+
* Rename or recolor a folder (`color: null` clears the color) and/or replace
|
|
7979
|
+
* its WhatsApp alert recipients (`whatsappAlertRecipients`, `[]` clears them).
|
|
7980
|
+
*/
|
|
7981
|
+
update(id: string, body: UpdateFolderParams, opts?: RequestOptions): Promise<Folder>;
|
|
7982
|
+
/**
|
|
7983
|
+
* Move a folder under another folder, or to the root with
|
|
7984
|
+
* `parentFolderId: null`. A folder cannot move into its own subtree.
|
|
7985
|
+
*/
|
|
7986
|
+
move(id: string, body: {
|
|
7987
|
+
parentFolderId: string | null;
|
|
7988
|
+
}, opts?: RequestOptions): Promise<Folder>;
|
|
7989
|
+
/**
|
|
7990
|
+
* Delete a folder. Nothing inside is deleted: subfolders, wokus and tools
|
|
7991
|
+
* move up to the parent folder (or the root).
|
|
7992
|
+
*/
|
|
7993
|
+
delete(id: string, opts?: RequestOptions): Promise<DeletedResult>;
|
|
7994
|
+
/**
|
|
7995
|
+
* AI report over every woku, NPS, CSAT and CES tool of the folder and its
|
|
7996
|
+
* subfolders. Scales differ per type, so there is no rating distribution.
|
|
7997
|
+
*/
|
|
7998
|
+
report(id: string, params?: {
|
|
7999
|
+
regenerate?: boolean;
|
|
8000
|
+
lang?: 'es' | 'en';
|
|
8001
|
+
}, opts?: RequestOptions): Promise<WokuRecord>;
|
|
8002
|
+
/**
|
|
8003
|
+
* Per-tool figures of the woku, NPS, CSAT and CES tools of the folder and its
|
|
8004
|
+
* subfolders for a period against the one before it, with the daily sums and
|
|
8005
|
+
* the histogram of scores. `days` is 7, 30 (default) or 90, or 0 for the whole
|
|
8006
|
+
* history (every `previous` window is then empty). The period is the last
|
|
8007
|
+
* `days` calendar days in UTC, today included. Scales are never mixed across
|
|
8008
|
+
* types.
|
|
8009
|
+
*/
|
|
8010
|
+
metrics(id: string, params?: {
|
|
8011
|
+
days?: 0 | 7 | 30 | 90;
|
|
8012
|
+
}, opts?: RequestOptions): Promise<FolderToolMetrics>;
|
|
8013
|
+
/** CSV text with one row per response of every tool of the folder subtree. */
|
|
8014
|
+
csv(id: string, opts?: RequestOptions): Promise<FolderCsv>;
|
|
8015
|
+
/**
|
|
8016
|
+
* PDF of the folder report (every woku, NPS, CSAT and CES tool of the folder
|
|
8017
|
+
* and its subfolders) with a breakdown per type on each native scale.
|
|
8018
|
+
* Returns the file bytes: write them to disk or send them as is.
|
|
8019
|
+
*/
|
|
8020
|
+
pdf(id: string, params?: {
|
|
8021
|
+
lang?: 'es' | 'en';
|
|
8022
|
+
}, opts?: RequestOptions): Promise<Uint8Array>;
|
|
8023
|
+
}
|
|
8024
|
+
|
|
8025
|
+
/** Filters of `tools.list`. */
|
|
8026
|
+
interface ListToolsParams {
|
|
8027
|
+
/** Folder whose direct content is listed. Omit for the root. */
|
|
8028
|
+
folderId?: string;
|
|
8029
|
+
/** `level` (default) lists one folder level; `company` lists every tool flat. */
|
|
8030
|
+
scope?: 'level' | 'company';
|
|
8031
|
+
/** Only these tool types. */
|
|
8032
|
+
types?: ToolType[];
|
|
8033
|
+
/** Case and accent insensitive search (company-wide, also matches folders). */
|
|
8034
|
+
q?: string;
|
|
8035
|
+
sort?: 'name' | '-name' | 'created' | '-created';
|
|
8036
|
+
/** Page size, 1-100 (default 50). */
|
|
8037
|
+
limit?: number;
|
|
8038
|
+
/** Folders per page, 1-100 (omit to receive every folder of the level). */
|
|
8039
|
+
foldersLimit?: number;
|
|
8040
|
+
createdFrom?: string;
|
|
8041
|
+
createdTo?: string;
|
|
8042
|
+
/**
|
|
8043
|
+
* Tracker chips as `name:value` (for example `TRR:00482`, up to 10); a tool
|
|
8044
|
+
* matches when it has every one: the tracker name is matched exactly, the value
|
|
8045
|
+
* partially and ignoring case (`482` also matches `00482`). Like a search it is
|
|
8046
|
+
* company-wide and lists no folders. A chip without name or value is a 400.
|
|
8047
|
+
*/
|
|
8048
|
+
trackers?: string[];
|
|
8049
|
+
}
|
|
8050
|
+
/**
|
|
8051
|
+
* One page of `tools.list`. Iterate every tool across all pages with
|
|
8052
|
+
* `for await (const tool of page)`, or page by page with `page.iterPages()`.
|
|
8053
|
+
*/
|
|
8054
|
+
declare class ToolsPage implements AsyncIterable<ToolItem> {
|
|
8055
|
+
private readonly fetchNext;
|
|
8056
|
+
private readonly fetchMoreFolders;
|
|
8057
|
+
readonly folders: Folder[];
|
|
8058
|
+
readonly tools: ToolItem[];
|
|
8059
|
+
readonly nextCursor: string | null;
|
|
8060
|
+
/** Cursor of the next page of folders (only set when `foldersLimit` was used). */
|
|
8061
|
+
readonly foldersNextCursor: string | null;
|
|
8062
|
+
readonly facets: ToolItemsPageResponse['facets'];
|
|
8063
|
+
constructor(response: ToolItemsPageResponse, fetchNext: (cursor: string) => Promise<ToolsPage>, fetchMoreFolders?: (cursor: string) => Promise<ToolsPage>);
|
|
8064
|
+
hasMoreFolders(): boolean;
|
|
8065
|
+
/** The next page of folders ("see more"): a page with those folders and no tools. */
|
|
8066
|
+
getMoreFolders(): Promise<ToolsPage>;
|
|
8067
|
+
hasNextPage(): boolean;
|
|
8068
|
+
getNextPage(): Promise<ToolsPage>;
|
|
8069
|
+
iterPages(): AsyncGenerator<ToolsPage>;
|
|
8070
|
+
[Symbol.asyncIterator](): AsyncIterator<ToolItem>;
|
|
8071
|
+
}
|
|
8072
|
+
/**
|
|
8073
|
+
* The unified view over wokus and NPS, CSAT and CES tools (`/v1/tools`):
|
|
8074
|
+
* search and filters, headline figures per type and batch moves.
|
|
8075
|
+
*/
|
|
8076
|
+
declare class Tools {
|
|
8077
|
+
private readonly client;
|
|
8078
|
+
constructor(client: WokuClient);
|
|
8079
|
+
/**
|
|
8080
|
+
* List one folder level (or search the company). Folders and tools of every
|
|
8081
|
+
* type come together; the first page also carries the folders and facets.
|
|
8082
|
+
*/
|
|
8083
|
+
list(params?: ListToolsParams, opts?: RequestOptions): Promise<ToolsPage>;
|
|
8084
|
+
/**
|
|
8085
|
+
* Headline figures per type (woku stars, NPS score, CSAT satisfied %, CES
|
|
8086
|
+
* mean) for the company or one folder and its subfolders, in a period.
|
|
8087
|
+
* A type that fails reports `{ error: true }`; the others stay valid.
|
|
8088
|
+
*/
|
|
8089
|
+
stats(params?: {
|
|
8090
|
+
folderId?: string;
|
|
8091
|
+
from?: string;
|
|
8092
|
+
to?: string;
|
|
8093
|
+
}, opts?: RequestOptions): Promise<ToolsStats>;
|
|
8094
|
+
/**
|
|
8095
|
+
* Move up to 200 items of mixed types (`woku`, `nps`, `csat`, `ces`,
|
|
8096
|
+
* `folder`) into a folder, or to the root with `folderId: null`. Idempotent;
|
|
8097
|
+
* nothing moves if one item or the destination is not found.
|
|
8098
|
+
*/
|
|
8099
|
+
move(body: MoveToolItemsParams, opts?: RequestOptions): Promise<MoveResult>;
|
|
8100
|
+
}
|
|
8101
|
+
|
|
8102
|
+
/**
|
|
8103
|
+
* Keep customer journeys in folders (`/v1/journey-folders`): `Viajes > journey >
|
|
8104
|
+
* moment`. Each journey and moment exposes its folder in `journeys.get`
|
|
8105
|
+
* (`folderId`, `momentFolders`).
|
|
8106
|
+
*/
|
|
8107
|
+
declare class JourneyFolders {
|
|
8108
|
+
private readonly client;
|
|
8109
|
+
constructor(client: WokuClient);
|
|
8110
|
+
/** Whether the organization is on, running, and how much is still without a folder. */
|
|
8111
|
+
status(opts?: RequestOptions): Promise<JourneyFoldersStatus>;
|
|
8112
|
+
/**
|
|
8113
|
+
* Switch the organization on and run the one-off pass in the background: tools
|
|
8114
|
+
* of existing journeys without a folder move into their moment folder, and
|
|
8115
|
+
* tools journeys create from now on are placed there. Tools that already have
|
|
8116
|
+
* a folder are never touched. Rejects with a conflict (409) while a pass is
|
|
8117
|
+
* already running; poll {@link status} for progress.
|
|
8118
|
+
*/
|
|
8119
|
+
organize(opts?: RequestOptions): Promise<JourneyFoldersStatus>;
|
|
8120
|
+
}
|
|
8121
|
+
|
|
6998
8122
|
/**
|
|
6999
8123
|
* Entry point to the Woku management API.
|
|
7000
8124
|
*
|
|
@@ -7031,6 +8155,12 @@ declare class Woku {
|
|
|
7031
8155
|
/** Customer journeys: moments, their tools and how each one starts. */
|
|
7032
8156
|
readonly journeys: Journeys;
|
|
7033
8157
|
readonly quarantines: Quarantines;
|
|
8158
|
+
/** Folders that organize wokus and NPS, CSAT and CES tools. */
|
|
8159
|
+
readonly folders: Folders;
|
|
8160
|
+
/** Unified search, headline figures and batch moves across every tool type. */
|
|
8161
|
+
readonly tools: Tools;
|
|
8162
|
+
/** Keep journeys and their moments in folders (`Viajes > journey > moment`). */
|
|
8163
|
+
readonly journeyFolders: JourneyFolders;
|
|
7034
8164
|
constructor(options?: WokuClientOptions | string);
|
|
7035
8165
|
}
|
|
7036
8166
|
|
|
@@ -7130,4 +8260,4 @@ declare class InternalServerError extends WokuAPIError {
|
|
|
7130
8260
|
constructor(...args: ConstructorParameters<typeof WokuAPIError>);
|
|
7131
8261
|
}
|
|
7132
8262
|
|
|
7133
|
-
export { type ApiKeyResult, type AssignTrackerByNameParams, AuthenticationError, BadRequestError, type CesTool, type Channel, ConflictError, type CreateActionPlanGroupParams, type CreateActionPlanTaskParams, type CreateCesToolParams, type CreateCsatToolParams, type CreateNpsToolParams, type CreateTicketDestinationParams, type CreateTrackerParams, type CreateWokuParams, type CreatedJourney, type CsatTool, type CustomTicketDestinationConfig, type CustomTicketUpdateConfig, type DeletedResult, type Dispatch, type DispatchStats, type EnrollInput, type EntitiesByTrackers, type FeedbackType, type FetchLike, type FollowUp, type FollowUpAttachment, type FollowUpCitation, type FollowUpConversation, type FollowUpLine, type FollowUpMessage, type FollowUpMessagePhase, type FollowUpOrigin, type FollowUpState, FollowUps, InternalServerError, type InvitationsResult, type Journey, type JourneyConnection, type JourneyEnrollment, type JourneyEnrollmentPage, type JourneyEntryInfo, type JourneyEventInput, type JourneyInput, type JourneyMoment, type JourneyMomentPreview, type JourneyMomentTrigger, type JourneyRecipients, type JourneySendWindow, type JourneyStartMode, type JourneyWebhook, Journeys, type ListJourneyEnrollmentsParams, type Locale, Media, type MediaUploadParams, type MediaUploadResult, type MoveWokuParams, NotFoundError, type NpsTool, Page, type PageResponse, PayloadTooLargeError, PermissionDeniedError, type PostPlanReplyParams, type PrepareJourneyEntryInput, type PreparedJourneyEntry, RateLimitError, type ReorderActionPlanTasksParams, type RequestOptions, type Schemas, type SearchEntitiesByTrackersParams, type SendCesInvitationsParams, type SendCsatInvitationsParams, type SendInvitationsParams, type SendNpsInvitationsParams, type Severity, type ShareWokuParams, type TestConnectionResult, type Ticket, type TicketOrigin, type TicketOriginTracker, type TicketStats, type Tracker, UnprocessableEntityError, type UpdateActionPlanGroupParams, type UpdateActionPlanTaskParams, type UpdateCesToolParams, type UpdateCsatToolParams, type UpdateNpsToolParams, type UpdateTicketDestinationParams, type UpdateTicketParams, type UpdateTrackerParams, type UpdateWokuParams, type UpdateWokuSettingsParams, Woku, WokuAPIError, WokuClient, type WokuClientOptions, WokuConnectionError, WokuError, type WokuErrorBody, type WokuRecord, type WokuResource, WokuTimeoutError };
|
|
8263
|
+
export { type ApiKeyResult, type AssignTrackerByNameParams, AuthenticationError, BadRequestError, type CesTool, type Channel, ConflictError, type CreateActionPlanGroupParams, type CreateActionPlanTaskParams, type CreateCesToolParams, type CreateCsatToolParams, type CreateFlowParams, type CreateFolderParams, type CreateNpsToolParams, type CreateTicketDestinationParams, type CreateTrackerParams, type CreateWokuParams, type CreatedJourney, type CsatTool, type CustomTicketDestinationConfig, type CustomTicketUpdateConfig, type DailyPoint, type DeletedResult, type Dispatch, type DispatchStats, type EnrollInput, type EntitiesByTrackers, type FeedbackType, type FetchLike, type Flow, type FlowStep, type Folder, type FolderCsv, type FolderOrigin, type FolderStats, type FolderToolMetrics, Folders, type FollowUp, type FollowUpAttachment, type FollowUpCitation, type FollowUpConversation, type FollowUpLine, type FollowUpMessage, type FollowUpMessagePhase, type FollowUpOrigin, type FollowUpState, FollowUps, InternalServerError, type InvitationsResult, type Journey, type JourneyConnection, type JourneyEnrollment, type JourneyEnrollmentPage, type JourneyEntryInfo, type JourneyEventInput, JourneyFolders, type JourneyFoldersStatus, type JourneyInput, type JourneyMoment, type JourneyMomentPreview, type JourneyMomentTrigger, type JourneyRecipients, type JourneySendWindow, type JourneyStartMode, type JourneyWebhook, Journeys, type ListJourneyEnrollmentsParams, type ListToolsParams, type Locale, Media, type MediaUploadParams, type MediaUploadResult, type MoveResult, type MoveToolItemsParams, type MoveWokuParams, NotFoundError, type NpsTool, Page, type PageResponse, PayloadTooLargeError, PermissionDeniedError, type PostPlanReplyParams, type PrepareJourneyEntryInput, type PreparedJourneyEntry, RateLimitError, type ReorderActionPlanTasksParams, type RequestOptions, type Schemas, type SearchEntitiesByTrackersParams, type SendCesInvitationsParams, type SendCsatInvitationsParams, type SendInvitationsParams, type SendNpsInvitationsParams, type Severity, type ShareWokuParams, type TestConnectionResult, type Ticket, type TicketOrigin, type TicketOriginTracker, type TicketStats, type ToolHeadline, type ToolItem, type ToolItemsPageResponse, type ToolMetrics, type ToolType, type ToolTypeStats, type ToolWindow, Tools, ToolsPage, type ToolsStats, type Tracker, UnprocessableEntityError, type UpdateActionPlanGroupParams, type UpdateActionPlanTaskParams, type UpdateCesToolParams, type UpdateCsatToolParams, type UpdateFlowParams, type UpdateFolderParams, type UpdateNpsToolParams, type UpdateTicketDestinationParams, type UpdateTicketParams, type UpdateTrackerParams, type UpdateWokuParams, type UpdateWokuSettingsParams, type WhatsappAlertRecipient, Woku, WokuAPIError, WokuClient, type WokuClientOptions, WokuConnectionError, WokuError, type WokuErrorBody, type WokuRecord, type WokuResource, WokuTimeoutError };
|