@memori.ai/memori-api-client 0.1.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.
Files changed (70) hide show
  1. package/LICENSE +18 -0
  2. package/README.md +188 -0
  3. package/dist/apiFetcher.d.ts +13 -0
  4. package/dist/backend/asset.d.ts +44 -0
  5. package/dist/backend/integration.d.ts +55 -0
  6. package/dist/backend/invitation.d.ts +82 -0
  7. package/dist/backend/memori.d.ts +125 -0
  8. package/dist/backend/user.d.ts +109 -0
  9. package/dist/backend.d.ts +273 -0
  10. package/dist/constants.d.ts +2 -0
  11. package/dist/engine/correlationPairs.d.ts +20 -0
  12. package/dist/engine/dialog.d.ts +88 -0
  13. package/dist/engine/importExport.d.ts +34 -0
  14. package/dist/engine/intents.d.ts +65 -0
  15. package/dist/engine/localizationKeys.d.ts +50 -0
  16. package/dist/engine/media.d.ts +48 -0
  17. package/dist/engine/memori.d.ts +30 -0
  18. package/dist/engine/memories.d.ts +50 -0
  19. package/dist/engine/nlp.d.ts +25 -0
  20. package/dist/engine/people.d.ts +46 -0
  21. package/dist/engine/promptedQuestions.d.ts +37 -0
  22. package/dist/engine/search.d.ts +30 -0
  23. package/dist/engine/session.d.ts +28 -0
  24. package/dist/engine/stats.d.ts +25 -0
  25. package/dist/engine/unansweredQuestions.d.ts +22 -0
  26. package/dist/engine/webhooks.d.ts +21 -0
  27. package/dist/engine.d.ts +297 -0
  28. package/dist/helpers/asset.d.ts +20 -0
  29. package/dist/helpers/getApiUrl.d.ts +1 -0
  30. package/dist/index.d.ts +582 -0
  31. package/dist/index.js +8 -0
  32. package/dist/memori-api-client.cjs.development.js +3666 -0
  33. package/dist/memori-api-client.cjs.development.js.map +1 -0
  34. package/dist/memori-api-client.cjs.production.min.js +2 -0
  35. package/dist/memori-api-client.cjs.production.min.js.map +1 -0
  36. package/dist/memori-api-client.esm.js +3660 -0
  37. package/dist/memori-api-client.esm.js.map +1 -0
  38. package/dist/speech.d.ts +10 -0
  39. package/dist/types.d.ts +410 -0
  40. package/package.json +125 -0
  41. package/src/apiFetcher.ts +29 -0
  42. package/src/backend/asset.ts +86 -0
  43. package/src/backend/integration.ts +98 -0
  44. package/src/backend/invitation.ts +115 -0
  45. package/src/backend/memori.ts +223 -0
  46. package/src/backend/user.ts +186 -0
  47. package/src/backend.ts +20 -0
  48. package/src/constants.ts +21 -0
  49. package/src/engine/correlationPairs.ts +31 -0
  50. package/src/engine/dialog.ts +158 -0
  51. package/src/engine/importExport.ts +43 -0
  52. package/src/engine/intents.ts +116 -0
  53. package/src/engine/localizationKeys.ts +94 -0
  54. package/src/engine/media.ts +79 -0
  55. package/src/engine/memori.ts +51 -0
  56. package/src/engine/memories.ts +89 -0
  57. package/src/engine/nlp.ts +39 -0
  58. package/src/engine/people.ts +82 -0
  59. package/src/engine/promptedQuestions.ts +63 -0
  60. package/src/engine/search.ts +49 -0
  61. package/src/engine/session.ts +49 -0
  62. package/src/engine/stats.ts +44 -0
  63. package/src/engine/unansweredQuestions.ts +38 -0
  64. package/src/engine/webhooks.ts +32 -0
  65. package/src/engine.ts +51 -0
  66. package/src/helpers/asset.ts +52 -0
  67. package/src/helpers/getApiUrl.ts +6 -0
  68. package/src/index.ts +20 -0
  69. package/src/speech.ts +242 -0
  70. package/src/types.ts +440 -0
@@ -0,0 +1,273 @@
1
+ declare const backendAPI: (apiUrl: string) => {
2
+ getSentInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
3
+ invitations: import("./types").Invitation[];
4
+ }>;
5
+ getReceivedInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
6
+ invitations: import("./types").Invitation[];
7
+ }>;
8
+ getAllInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
9
+ invitations: import("./types").Invitation[];
10
+ }>;
11
+ getInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
12
+ invitation: import("./types").Invitation;
13
+ }>;
14
+ updateInvitation: (authToken: string, invitation: Partial<Pick<import("./types").Invitation, "memoriID" | "isInviter" | "isInvitee" | "text" | "destinationEMail" | "destinationName" | "tag" | "pin" | "type" | "state" | "creationTimestamp" | "lastChangeTimestamp">> & {
15
+ invitationID: string;
16
+ }) => Promise<import("./types").ResponseSpec & {
17
+ invitation: import("./types").Invitation;
18
+ }>;
19
+ deleteInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec>;
20
+ acceptInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
21
+ invitation: import("./types").Invitation;
22
+ }>;
23
+ rejectInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
24
+ invitation: import("./types").Invitation;
25
+ }>;
26
+ sendInvitation: (authToken: string, invitation: Partial<Pick<import("./types").Invitation, "memoriID" | "isInviter" | "isInvitee" | "text" | "destinationEMail" | "destinationName" | "tag" | "pin" | "type" | "state" | "creationTimestamp" | "lastChangeTimestamp">>) => Promise<import("./types").ResponseSpec & {
27
+ invitation: import("./types").Invitation;
28
+ }>;
29
+ getMemoriIntegrationsList: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec & {
30
+ integrations: import("./types").Integration[];
31
+ }>;
32
+ getAllIntegrationsList: (authToken: string) => Promise<import("./types").ResponseSpec & {
33
+ integrations: import("./types").Integration[];
34
+ }>;
35
+ getIntegration: (authToken: string, integrationID: string) => Promise<import("./types").ResponseSpec & {
36
+ integration: import("./types").Integration;
37
+ }>;
38
+ deleteIntegration: (authToken: string, integrationID: string) => Promise<import("./types").ResponseSpec>;
39
+ createIntegration: (authToken: string, integration: import("./types").Integration) => Promise<import("./types").ResponseSpec & {
40
+ integration: import("./types").Integration;
41
+ }>;
42
+ updateIntegration: (authToken: string, integrationID: string, integration: import("./types").Integration) => Promise<import("./types").ResponseSpec & {
43
+ integration: import("./types").Integration;
44
+ }>;
45
+ userSignIn: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
46
+ user: import("./types").User;
47
+ }>;
48
+ userConfirmSignIn: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
49
+ user: import("./types").User;
50
+ token?: string | undefined;
51
+ }>;
52
+ userLogin: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
53
+ user: import("./types").User;
54
+ token?: string | undefined;
55
+ flowID?: string | undefined;
56
+ }>;
57
+ userLogout: (authToken: string) => Promise<import("./types").ResponseSpec>;
58
+ getUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec & {
59
+ user: import("./types").User;
60
+ }>;
61
+ getUsersList: (authToken: string) => Promise<import("./types").ResponseSpec & {
62
+ users: import("./types").User[];
63
+ }>;
64
+ deleteUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec>;
65
+ updateUser: (authToken: string, userID: string, user: import("./types").User) => Promise<import("./types").ResponseSpec & {
66
+ user: import("./types").User;
67
+ }>;
68
+ resetPassword: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
69
+ resetConfirm: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
70
+ user: import("./types").User;
71
+ token?: string | undefined;
72
+ flowID?: string | undefined;
73
+ }>;
74
+ recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
75
+ getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
76
+ tenant: import("./types").Tenant;
77
+ }>;
78
+ resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
79
+ createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
80
+ user: import("./types").User;
81
+ }>;
82
+ getTenantPublicMemoriList: (tenant: string) => Promise<import("./types").ResponseSpec & {
83
+ memori: import("./types").Memori[];
84
+ }>;
85
+ getPublicMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
86
+ memori: import("./types").Memori[];
87
+ }>;
88
+ getAllMemori: (authToken: string) => Promise<import("./types").ResponseSpec & {
89
+ memori: import("./types").Memori[];
90
+ }>;
91
+ getUserMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
92
+ memori: import("./types").Memori[];
93
+ }>;
94
+ getSharedMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
95
+ memori: import("./types").Memori[];
96
+ }>;
97
+ getTenantCategories: (tenant: string) => Promise<import("./types").ResponseSpec & {
98
+ memoriCategories: string[];
99
+ }>;
100
+ getMemoriConfigs: (authToken: string) => Promise<import("./types").ResponseSpec & {
101
+ memoriConfigs: import("./types").MemoriConfig[];
102
+ }>;
103
+ createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
104
+ memori: import("./types").Memori;
105
+ }>;
106
+ updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
107
+ memori: import("./types").Memori;
108
+ }>;
109
+ deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;
110
+ getMemoriById: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec & {
111
+ memori: import("./types").Memori;
112
+ }>;
113
+ getMemoriByUserAndId: (tenantName: string, userID: string, memoriID: string, authToken?: string | undefined) => Promise<import("./types").ResponseSpec & {
114
+ memori: import("./types").Memori;
115
+ }>;
116
+ getMemori: (tenant: string, userName: string, memoriName: string, authToken?: string | undefined) => Promise<import("./types").ResponseSpec & {
117
+ memori: import("./types").Memori;
118
+ }>;
119
+ getMemoriSessions: (authToken: string, memoriID: string, dateFrom?: string | undefined, dateTo?: string | undefined) => Promise<import("./types").ResponseSpec & {
120
+ totalSessions: number;
121
+ validSessions: number;
122
+ }>;
123
+ getUploadAssetURL: (authToken: string, memoriID: string, memoryID?: string | undefined) => string;
124
+ uploadAsset: (fileName: string, fileUrl: string, authToken: string, memoriID: string, memoryID?: string | undefined) => Promise<import("./types").ResponseSpec & {
125
+ asset: import("./types").Asset;
126
+ }>;
127
+ getAsset: (fileName: string, sessionID: string) => Promise<any>;
128
+ updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
129
+ asset: import("./types").Asset;
130
+ }>;
131
+ deleteAsset: (authToken: string, assetURL: string) => Promise<import("./types").ResponseSpec>;
132
+ asset: {
133
+ getUploadAssetURL: (authToken: string, memoriID: string, memoryID?: string | undefined) => string;
134
+ uploadAsset: (fileName: string, fileUrl: string, authToken: string, memoriID: string, memoryID?: string | undefined) => Promise<import("./types").ResponseSpec & {
135
+ asset: import("./types").Asset;
136
+ }>;
137
+ getAsset: (fileName: string, sessionID: string) => Promise<any>;
138
+ updateAsset: (authToken: string, assetURL: string, asset: import("./types").Asset) => Promise<import("./types").ResponseSpec & {
139
+ asset: import("./types").Asset;
140
+ }>;
141
+ deleteAsset: (authToken: string, assetURL: string) => Promise<import("./types").ResponseSpec>;
142
+ };
143
+ memori: {
144
+ getTenantPublicMemoriList: (tenant: string) => Promise<import("./types").ResponseSpec & {
145
+ memori: import("./types").Memori[];
146
+ }>;
147
+ getPublicMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
148
+ memori: import("./types").Memori[];
149
+ }>;
150
+ getAllMemori: (authToken: string) => Promise<import("./types").ResponseSpec & {
151
+ memori: import("./types").Memori[];
152
+ }>;
153
+ getUserMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
154
+ memori: import("./types").Memori[];
155
+ }>;
156
+ getSharedMemoriList: (authToken: string) => Promise<import("./types").ResponseSpec & {
157
+ memori: import("./types").Memori[];
158
+ }>;
159
+ getTenantCategories: (tenant: string) => Promise<import("./types").ResponseSpec & {
160
+ memoriCategories: string[];
161
+ }>;
162
+ getMemoriConfigs: (authToken: string) => Promise<import("./types").ResponseSpec & {
163
+ memoriConfigs: import("./types").MemoriConfig[];
164
+ }>;
165
+ createMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
166
+ memori: import("./types").Memori;
167
+ }>;
168
+ updateMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec & {
169
+ memori: import("./types").Memori;
170
+ }>;
171
+ deleteMemori: (authToken: string, memori: import("./types").Memori) => Promise<import("./types").ResponseSpec>;
172
+ getMemoriById: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec & {
173
+ memori: import("./types").Memori;
174
+ }>;
175
+ getMemoriByUserAndId: (tenantName: string, userID: string, memoriID: string, authToken?: string | undefined) => Promise<import("./types").ResponseSpec & {
176
+ memori: import("./types").Memori;
177
+ }>;
178
+ getMemori: (tenant: string, userName: string, memoriName: string, authToken?: string | undefined) => Promise<import("./types").ResponseSpec & {
179
+ memori: import("./types").Memori;
180
+ }>;
181
+ getMemoriSessions: (authToken: string, memoriID: string, dateFrom?: string | undefined, dateTo?: string | undefined) => Promise<import("./types").ResponseSpec & {
182
+ totalSessions: number;
183
+ validSessions: number;
184
+ }>;
185
+ };
186
+ user: {
187
+ userSignIn: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
188
+ user: import("./types").User;
189
+ }>;
190
+ userConfirmSignIn: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
191
+ user: import("./types").User;
192
+ token?: string | undefined;
193
+ }>;
194
+ userLogin: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
195
+ user: import("./types").User;
196
+ token?: string | undefined;
197
+ flowID?: string | undefined;
198
+ }>;
199
+ userLogout: (authToken: string) => Promise<import("./types").ResponseSpec>;
200
+ getUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec & {
201
+ user: import("./types").User;
202
+ }>;
203
+ getUsersList: (authToken: string) => Promise<import("./types").ResponseSpec & {
204
+ users: import("./types").User[];
205
+ }>;
206
+ deleteUser: (authToken: string, userID: string) => Promise<import("./types").ResponseSpec>;
207
+ updateUser: (authToken: string, userID: string, user: import("./types").User) => Promise<import("./types").ResponseSpec & {
208
+ user: import("./types").User;
209
+ }>;
210
+ resetPassword: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
211
+ resetConfirm: (user: import("./types").User) => Promise<import("./types").ResponseSpec & {
212
+ user: import("./types").User;
213
+ token?: string | undefined;
214
+ flowID?: string | undefined;
215
+ }>;
216
+ recoverUsername: (user: import("./types").User) => Promise<import("./types").ResponseSpec>;
217
+ getTenantConfig: (tenantName: string) => Promise<import("./types").ResponseSpec & {
218
+ tenant: import("./types").Tenant;
219
+ }>;
220
+ resendVerificationCode: (user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec>;
221
+ createUser: (authToken: string, user: Partial<import("./types").User>) => Promise<import("./types").ResponseSpec & {
222
+ user: import("./types").User;
223
+ }>;
224
+ };
225
+ integration: {
226
+ getMemoriIntegrationsList: (authToken: string, memoriID: string) => Promise<import("./types").ResponseSpec & {
227
+ integrations: import("./types").Integration[];
228
+ }>;
229
+ getAllIntegrationsList: (authToken: string) => Promise<import("./types").ResponseSpec & {
230
+ integrations: import("./types").Integration[];
231
+ }>;
232
+ getIntegration: (authToken: string, integrationID: string) => Promise<import("./types").ResponseSpec & {
233
+ integration: import("./types").Integration;
234
+ }>;
235
+ deleteIntegration: (authToken: string, integrationID: string) => Promise<import("./types").ResponseSpec>;
236
+ createIntegration: (authToken: string, integration: import("./types").Integration) => Promise<import("./types").ResponseSpec & {
237
+ integration: import("./types").Integration;
238
+ }>;
239
+ updateIntegration: (authToken: string, integrationID: string, integration: import("./types").Integration) => Promise<import("./types").ResponseSpec & {
240
+ integration: import("./types").Integration;
241
+ }>;
242
+ };
243
+ invitation: {
244
+ getSentInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
245
+ invitations: import("./types").Invitation[];
246
+ }>;
247
+ getReceivedInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
248
+ invitations: import("./types").Invitation[];
249
+ }>;
250
+ getAllInvitations: (authToken: string) => Promise<import("./types").ResponseSpec & {
251
+ invitations: import("./types").Invitation[];
252
+ }>;
253
+ getInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
254
+ invitation: import("./types").Invitation;
255
+ }>;
256
+ updateInvitation: (authToken: string, invitation: Partial<Pick<import("./types").Invitation, "memoriID" | "isInviter" | "isInvitee" | "text" | "destinationEMail" | "destinationName" | "tag" | "pin" | "type" | "state" | "creationTimestamp" | "lastChangeTimestamp">> & {
257
+ invitationID: string;
258
+ }) => Promise<import("./types").ResponseSpec & {
259
+ invitation: import("./types").Invitation;
260
+ }>;
261
+ deleteInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec>;
262
+ acceptInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
263
+ invitation: import("./types").Invitation;
264
+ }>;
265
+ rejectInvitation: (authToken: string, invitationId: string) => Promise<import("./types").ResponseSpec & {
266
+ invitation: import("./types").Invitation;
267
+ }>;
268
+ sendInvitation: (authToken: string, invitation: Partial<Pick<import("./types").Invitation, "memoriID" | "isInviter" | "isInvitee" | "text" | "destinationEMail" | "destinationName" | "tag" | "pin" | "type" | "state" | "creationTimestamp" | "lastChangeTimestamp">>) => Promise<import("./types").ResponseSpec & {
269
+ invitation: import("./types").Invitation;
270
+ }>;
271
+ };
272
+ };
273
+ export default backendAPI;
@@ -0,0 +1,2 @@
1
+ export declare const allowedMediaTypes: string[];
2
+ export declare const anonTag = "\uD83D\uDC64";
@@ -0,0 +1,20 @@
1
+ import { ResponseSpec } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Lists all Correlation Pair objects.
5
+ * @param {string} sessionId The session ID
6
+ */
7
+ getCorrelationPairs: (sessionId: string) => Promise<ResponseSpec>;
8
+ /**
9
+ * Removes an existing Correlation Pair object.
10
+ * @param {string} sessionId The session ID
11
+ * @param {string} pairId The Correlation Pair object ID
12
+ */
13
+ deleteCorrelationPair: (sessionId: string, pairId: string) => Promise<ResponseSpec>;
14
+ };
15
+ /****************************
16
+ * *
17
+ * CorrelationPairs *
18
+ * *
19
+ ****************************/
20
+ export default _default;
@@ -0,0 +1,88 @@
1
+ import { DialogState, Medium, ResponseSpec } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Submits a Text Entered event to the session's Dialog State Machine.
5
+ * @param {object} params
6
+ * @param {string} params.sessionId The session ID
7
+ * @param {string} params.text The text entered by the user
8
+ */
9
+ postTextEnteredEvent: ({ sessionId, text, }: {
10
+ sessionId: string;
11
+ text: string;
12
+ }) => Promise<ResponseSpec & {
13
+ currentState: DialogState;
14
+ }>;
15
+ /**
16
+ * Submits a Place Changed event to the session's Dialog State Machine.
17
+ * @param {object} params
18
+ * @param {string} params.sessionId - The session ID
19
+ * @param {string} params.placeName - The name of the place
20
+ * @param {number} params.latitude - The latitude of the place
21
+ * @param {number} params.longitude - The longitude of the place
22
+ * @param {number} params.uncertaintyKm - The uncertainty of the place in kilometers
23
+ */
24
+ postPlaceChangedEvent: ({ sessionId, placeName, latitude, longitude, uncertaintyKm, }: {
25
+ sessionId: string;
26
+ placeName: string;
27
+ latitude: number;
28
+ longitude: number;
29
+ uncertaintyKm?: number | undefined;
30
+ }) => Promise<ResponseSpec & {
31
+ currentState: DialogState;
32
+ }>;
33
+ /**
34
+ * Submits a Date Changed event to the session's Dialog State Machine.
35
+ * @param {string} sessionId The session ID
36
+ */
37
+ postDateChangedEvent: (sessionId: string) => Promise<ResponseSpec>;
38
+ /**
39
+ * Submits a Tag Changed event to the session's Dialog State Machine.
40
+ * @param {string} sessionId The session ID
41
+ * @param {string} tag The tag to set
42
+ */
43
+ postTagChangedEvent: (sessionId: string, tag: string) => Promise<ResponseSpec & {
44
+ currentState: DialogState;
45
+ }>;
46
+ /**
47
+ * Submits a Timeout event to the session's Dialog State Machine.
48
+ * @param {string} sessionId The session ID
49
+ */
50
+ postTimeoutEvent: (sessionId: string) => Promise<ResponseSpec & {
51
+ currentState: DialogState;
52
+ }>;
53
+ /**
54
+ * Submits a Medium Selected event to the session's Dialog State Machine.
55
+ * @param {string} sessionId The session ID
56
+ * @param {Medium} medium The medium to set
57
+ */
58
+ postMediumSelectedEvent: (sessionId: string, medium: Medium) => Promise<ResponseSpec & {
59
+ currentState: DialogState;
60
+ }>;
61
+ /**
62
+ * Submits a Date Selected event to the session's Dialog State Machine.
63
+ * @param {string} sessionId The session ID
64
+ */
65
+ postDateSelectedEvent: ({ sessionId }: {
66
+ sessionId: string;
67
+ }) => Promise<ResponseSpec>;
68
+ /**
69
+ * Submits a Place Selected event to the session's Dialog State Machine.
70
+ * @param {string} sessionId The session ID
71
+ */
72
+ postPlaceSelectedEvent: ({ sessionId }: {
73
+ sessionId: string;
74
+ }) => Promise<ResponseSpec>;
75
+ /**
76
+ * Submits a Tag Selected event to the session's Dialog State Machine.
77
+ * @param {string} sessionId The session ID
78
+ */
79
+ postTagSelectedEvent: ({ sessionId }: {
80
+ sessionId: string;
81
+ }) => Promise<ResponseSpec>;
82
+ };
83
+ /******************
84
+ * *
85
+ * Dialog *
86
+ * *
87
+ ******************/
88
+ export default _default;
@@ -0,0 +1,34 @@
1
+ import { ResponseSpec } from '../types';
2
+ export interface ImportExportBody {
3
+ csvRows: string[];
4
+ questionColumnName: string;
5
+ answerColumnName: string;
6
+ propertyColumnNames: string[];
7
+ includedRows: number[];
8
+ csvSeparator: string;
9
+ questionTitleVariantsSeparator: string;
10
+ hasHeaders: boolean;
11
+ forceImport: boolean;
12
+ headerNames: string[];
13
+ }
14
+ export interface ImportExportReponse {
15
+ importID: string;
16
+ importedMemories: number;
17
+ importWarnings?: {
18
+ warningType: string;
19
+ }[];
20
+ }
21
+ declare const _default: (apiUrl: string) => {
22
+ /**
23
+ * Imports memories from a CSV file.
24
+ * @param {string} sessionId The session ID
25
+ * @param {ImportExportBody} csvData The CSV content info to import
26
+ */
27
+ postImportExport: (sessionId: string, csvData: ImportExportBody) => Promise<ResponseSpec & ImportExportReponse>;
28
+ };
29
+ /************************
30
+ * *
31
+ * ImportExport *
32
+ * *
33
+ ************************/
34
+ export default _default;
@@ -0,0 +1,65 @@
1
+ import { ResponseSpec } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Lists all Intent objects.
5
+ * @param {string} sessionId The session ID
6
+ */
7
+ getIntents: (sessionId: string) => Promise<ResponseSpec>;
8
+ /**
9
+ * Gets the details of an Intent object.
10
+ * @param {string} sessionId The session ID
11
+ * @param {string} intentId The Intent object ID
12
+ */
13
+ getIntent: (sessionId: string, intentId: string) => Promise<ResponseSpec>;
14
+ /**
15
+ * Updates an existing Intent object.
16
+ * @param {string} sessionId The session ID
17
+ * @param {string} intentId The Intent object ID
18
+ */
19
+ patchIntent: (sessionId: string, intentId: string) => Promise<ResponseSpec>;
20
+ /**
21
+ * Removes an existing Intent object.
22
+ * @param {string} sessionId The session ID
23
+ * @param {string} intentId The Intent object ID
24
+ */
25
+ deleteIntent: (sessionId: string, intentId: string) => Promise<ResponseSpec>;
26
+ /**
27
+ * Adds a new Intent object.
28
+ * @param {string} sessionId The session ID
29
+ */
30
+ postIntent: (sessionId: string) => Promise<ResponseSpec>;
31
+ /**
32
+ * Lists all Intent Slot objects.
33
+ * @param {string} sessionId The session ID
34
+ */
35
+ getIntentSlots: (sessionId: string) => Promise<ResponseSpec>;
36
+ /**
37
+ * Gets the details of an Intent Slot object.
38
+ * @param {string} sessionId The session ID
39
+ * @param {string} slotId The Intent Slot object ID
40
+ */
41
+ getIntentSlot: (sessionId: string, slotId: string) => Promise<ResponseSpec>;
42
+ /**
43
+ * Updates an existing Intent Slot object.
44
+ * @param {string} sessionId The session ID
45
+ * @param {string} slotId The Intent Slot object ID
46
+ */
47
+ patchIntentSlot: (sessionId: string, slotId: string) => Promise<ResponseSpec>;
48
+ /**
49
+ * Removes an existing Intent Slot object.
50
+ * @param {string} sessionId The session ID
51
+ * @param {string} slotId The Intent Slot object ID
52
+ */
53
+ deleteIntentSlot: (sessionId: string, slotId: string) => Promise<ResponseSpec>;
54
+ /**
55
+ * Adds a new Intent Slot object.
56
+ * @param {string} sessionId The session ID
57
+ */
58
+ postIntentSlot: (sessionId: string) => Promise<ResponseSpec>;
59
+ };
60
+ /*******************
61
+ * *
62
+ * Intents *
63
+ * *
64
+ *******************/
65
+ export default _default;
@@ -0,0 +1,50 @@
1
+ import { ResponseSpec, LocalizationKey, LocalizationKeyContent } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Lists all Localizaiton Keys.
5
+ * @param {string} sessionId The session ID
6
+ */
7
+ getLocalizationKeys: (sessionId: string) => Promise<ResponseSpec & {
8
+ localizationKeys: LocalizationKey[];
9
+ }>;
10
+ /**
11
+ * Get an existing Localizaiton Key.
12
+ * @param {string} sessionId The session ID
13
+ * @param {string} key The key of the Localization Key
14
+ */
15
+ getLocalizationKey: (sessionId: string, key: string) => Promise<ResponseSpec & {
16
+ localizationKey: LocalizationKey;
17
+ }>;
18
+ /**
19
+ * Removes an existing Localizaiton Key. This is only possible if the key is part of
20
+ * a key set, where a key set is a set of keys of a common prefix and an index,
21
+ * e.g.: <code>INPUT_QUIT_1</code>, <code>INPUT_QUIT_2</code> etc.
22
+ * Any index can be specified, the key set will be reordered appropriately.
23
+ * @param {string} sessionId The session ID
24
+ * @param {string} key The key of the Localization Key
25
+ */
26
+ deleteLocalizationKey: (sessionId: string, key: string) => Promise<ResponseSpec>;
27
+ /**
28
+ * Add an new Localization Key. This is only possible if the key is part of
29
+ * a key set, where a key set is a set of keys of a common prefix and an index,
30
+ * e.g.: <code>INPUT_QUIT_1</code>, <code>INPUT_QUIT_2</code> etc.
31
+ * Any index can be specified, the key set will be reordered appropriately.
32
+ * @param {string} sessionId The session ID
33
+ * @param {LocalizaitonKeyContent} localizationKey Localization Key
34
+ */
35
+ postLocalizationKey: (sessionId: string, localizationKey: LocalizationKeyContent) => Promise<ResponseSpec & {
36
+ localizationKey: LocalizationKey;
37
+ }>;
38
+ /**
39
+ * Updates an existing Localization Key.
40
+ * @param {string} sessionId The session ID
41
+ * @param {LocalizationKey} localizationKey Localization Key
42
+ */
43
+ patchLocalizationKey: (sessionId: string, localizationKey: LocalizationKey) => Promise<ResponseSpec>;
44
+ };
45
+ /****************************
46
+ * *
47
+ * LocalizationKeys *
48
+ * *
49
+ ****************************/
50
+ export default _default;
@@ -0,0 +1,48 @@
1
+ import { ResponseSpec } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Lists all Medium objects of a Memory.
5
+ * @param {string} sessionId The session ID
6
+ * @param {string} memoryId The Memory object ID
7
+ */
8
+ getMedia: (sessionId: string, memoryId: string) => Promise<ResponseSpec>;
9
+ /**
10
+ * Removes all Medium objects from a Memory.
11
+ * @param {string} sessionId The session ID
12
+ * @param {string} memoryId The Memory object ID
13
+ */
14
+ deleteMedia: (sessionId: string, memoryId: string) => Promise<ResponseSpec>;
15
+ /**
16
+ * Gets the details of a Medium object of a Memory.
17
+ * @param {string} sessionId The session ID
18
+ * @param {string} memoryId The Memory object ID
19
+ * @param {string} mediumId The Medium object ID
20
+ */
21
+ getMedium: (sessionId: string, memoryId: string, mediumId: string) => Promise<ResponseSpec>;
22
+ /**
23
+ * Updates an existing Medium object of a Memory.
24
+ * @param {string} sessionId The session ID
25
+ * @param {string} memoryId The Memory object ID
26
+ * @param {string} mediumId The Medium object ID
27
+ */
28
+ patchMedium: (sessionId: string, memoryId: string, mediumId: string) => Promise<ResponseSpec>;
29
+ /**
30
+ * Removes an existing Medium object from a Memory.
31
+ * @param {string} sessionId The session ID
32
+ * @param {string} memoryId The Memory object ID
33
+ * @param {string} mediumId The Medium object ID
34
+ */
35
+ deleteMedium: (sessionId: string, memoryId: string, mediumId: string) => Promise<ResponseSpec>;
36
+ /**
37
+ * Adds a new Medium object to a Memory.
38
+ * @param {string} sessionId The session ID
39
+ * @param {string} memoryId The Memory object ID
40
+ */
41
+ postMedium: (sessionId: string, memoryId: string) => Promise<ResponseSpec>;
42
+ };
43
+ /*****************
44
+ * *
45
+ * Media *
46
+ * *
47
+ *****************/
48
+ export default _default;
@@ -0,0 +1,30 @@
1
+ import { ResponseSpec, Memori } from '../types';
2
+ declare const _default: (apiUrl: string) => {
3
+ /**
4
+ * Registration of a new Memori object.
5
+ * @param {Memori} memori - The Memori object
6
+ */
7
+ postMemori: (memori: Partial<Omit<Memori, 'memoriID'>>) => Promise<ResponseSpec>;
8
+ /**
9
+ * Updates an existing Memori object.
10
+ * @param {Memori} memori - The Memori object
11
+ */
12
+ patchMemori: (memori: Partial<Memori> & {
13
+ memoriID: string;
14
+ }) => Promise<ResponseSpec>;
15
+ /**
16
+ * Deletes an existing Memori object.
17
+ * @param {string} memoriId The Memori object ID
18
+ */
19
+ deleteMemori: (memoriId: string) => Promise<ResponseSpec>;
20
+ /**
21
+ * Lists Memori objects, with optional filtering.
22
+ */
23
+ postSearchMemori: () => Promise<ResponseSpec>;
24
+ };
25
+ /******************
26
+ * *
27
+ * Memori *
28
+ * *
29
+ ******************/
30
+ export default _default;