ch-chat-api-typescript-axios 1.1.2 → 1.1.4

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.
@@ -29,7 +29,8 @@ import type { TransferManagerCommand } from '../models';
29
29
  export declare const ChatApiAxiosParamCreator: (configuration?: Configuration) => {
30
30
  /**
31
31
  *
32
- * @param {string} tenantId
32
+ * @summary Get all chat sessions.
33
+ * @param {string} tenantId The tenant identifier.
33
34
  * @param {string} [id]
34
35
  * @param {string} [assigneeId]
35
36
  * @param {string} [title]
@@ -44,78 +45,97 @@ export declare const ChatApiAxiosParamCreator: (configuration?: Configuration) =
44
45
  apiV1ChatTenantIdSessionsGet: (tenantId: string, id?: string, assigneeId?: string, title?: string, userName?: string, userEmail?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
45
46
  /**
46
47
  *
47
- * @param {string} tenantId
48
- * @param {CreateChatSessionCommand} [createChatSessionCommand]
48
+ * @summary Create a chat session.
49
+ * @param {string} tenantId The tenant identifier.
50
+ * @param {CreateChatSessionCommand} [createChatSessionCommand] The command to create a chat session.
49
51
  * @param {*} [options] Override http request option.
50
52
  * @throws {RequiredError}
51
53
  */
52
54
  apiV1ChatTenantIdSessionsPost: (tenantId: string, createChatSessionCommand?: CreateChatSessionCommand, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
53
55
  /**
54
56
  *
55
- * @param {string} tenantId
56
- * @param {string} sessionId
57
+ * @summary Convert a guest to a signed-in user.
58
+ * @param {string} tenantId The tenant identifier.
59
+ * @param {string} sessionId The session identifier.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ apiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost: (tenantId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
64
+ /**
65
+ *
66
+ * @summary Delete a chat session.
67
+ * @param {string} tenantId The tenant identifier.
68
+ * @param {string} sessionId The session identifier.
57
69
  * @param {*} [options] Override http request option.
58
70
  * @throws {RequiredError}
59
71
  */
60
72
  apiV1ChatTenantIdSessionsSessionIdDelete: (tenantId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61
73
  /**
62
74
  *
63
- * @param {string} tenantId
64
- * @param {string} sessionId
75
+ * @summary Get chat session by session Id.
76
+ * @param {string} tenantId The tenant identifier.
77
+ * @param {string} sessionId The session identifier.
65
78
  * @param {*} [options] Override http request option.
66
79
  * @throws {RequiredError}
67
80
  */
68
81
  apiV1ChatTenantIdSessionsSessionIdGet: (tenantId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
69
82
  /**
70
83
  *
71
- * @param {string} tenantId
72
- * @param {string} sessionId
73
- * @param {JoinChatSessionCommand} [joinChatSessionCommand]
84
+ * @summary Join a chat session.
85
+ * @param {string} tenantId The tenant identifier.
86
+ * @param {string} sessionId The session identifier.
87
+ * @param {JoinChatSessionCommand} [joinChatSessionCommand] The command to join a chat session.
74
88
  * @param {*} [options] Override http request option.
75
89
  * @throws {RequiredError}
76
90
  */
77
91
  apiV1ChatTenantIdSessionsSessionIdJoinPost: (tenantId: string, sessionId: string, joinChatSessionCommand?: JoinChatSessionCommand, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
78
92
  /**
79
93
  *
80
- * @param {string} tenantId
81
- * @param {string} sessionId
94
+ * @summary Leave a chat session.
95
+ * @param {string} tenantId The tenant identifier.
96
+ * @param {string} sessionId The session identifier.
82
97
  * @param {*} [options] Override http request option.
83
98
  * @throws {RequiredError}
84
99
  */
85
100
  apiV1ChatTenantIdSessionsSessionIdLeaveDelete: (tenantId: string, sessionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
86
101
  /**
87
102
  *
88
- * @param {string} tenantId
89
- * @param {string} sessionId
90
- * @param {number} [skip]
91
- * @param {number} [take]
103
+ * @summary Get messages from a chat session.
104
+ * @param {string} tenantId The tenant identifier.
105
+ * @param {string} sessionId The session identifier.
106
+ * @param {number} [page]
107
+ * @param {number} [limit]
108
+ * @param {Date} [lastRetrieved]
92
109
  * @param {*} [options] Override http request option.
93
110
  * @throws {RequiredError}
94
111
  */
95
- apiV1ChatTenantIdSessionsSessionIdMessagesGet: (tenantId: string, sessionId: string, skip?: number, take?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
112
+ apiV1ChatTenantIdSessionsSessionIdMessagesGet: (tenantId: string, sessionId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
96
113
  /**
97
114
  *
98
- * @param {string} tenantId
99
- * @param {string} sessionId
100
- * @param {ChatSendMessageCommand} [chatSendMessageCommand]
115
+ * @summary Send a message in a chat session.
116
+ * @param {string} tenantId The tenant identifier.
117
+ * @param {string} sessionId The session identifier.
118
+ * @param {ChatSendMessageCommand} [chatSendMessageCommand] The command to send a message.
101
119
  * @param {*} [options] Override http request option.
102
120
  * @throws {RequiredError}
103
121
  */
104
122
  apiV1ChatTenantIdSessionsSessionIdMessagesPost: (tenantId: string, sessionId: string, chatSendMessageCommand?: ChatSendMessageCommand, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
105
123
  /**
106
124
  *
107
- * @param {string} tenantId
108
- * @param {string} sessionId
109
- * @param {PutChatSessionCommand} [putChatSessionCommand]
125
+ * @summary Update a chat session.
126
+ * @param {string} tenantId The tenant identifier.
127
+ * @param {string} sessionId The session identifier.
128
+ * @param {PutChatSessionCommand} [putChatSessionCommand] The command to update a chat session.
110
129
  * @param {*} [options] Override http request option.
111
130
  * @throws {RequiredError}
112
131
  */
113
132
  apiV1ChatTenantIdSessionsSessionIdPatch: (tenantId: string, sessionId: string, putChatSessionCommand?: PutChatSessionCommand, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
114
133
  /**
115
134
  *
116
- * @param {string} tenantId
117
- * @param {string} sessionId
118
- * @param {TransferManagerCommand} [transferManagerCommand]
135
+ * @summary Transfer a chat session agent.
136
+ * @param {string} tenantId The tenant identifier.
137
+ * @param {string} sessionId The session identifier.
138
+ * @param {TransferManagerCommand} [transferManagerCommand] The command to transfer a chat session.
119
139
  * @param {*} [options] Override http request option.
120
140
  * @throws {RequiredError}
121
141
  */
@@ -128,7 +148,8 @@ export declare const ChatApiAxiosParamCreator: (configuration?: Configuration) =
128
148
  export declare const ChatApiFp: (configuration?: Configuration) => {
129
149
  /**
130
150
  *
131
- * @param {string} tenantId
151
+ * @summary Get all chat sessions.
152
+ * @param {string} tenantId The tenant identifier.
132
153
  * @param {string} [id]
133
154
  * @param {string} [assigneeId]
134
155
  * @param {string} [title]
@@ -143,78 +164,97 @@ export declare const ChatApiFp: (configuration?: Configuration) => {
143
164
  apiV1ChatTenantIdSessionsGet(tenantId: string, id?: string, assigneeId?: string, title?: string, userName?: string, userEmail?: string, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatSessionsModel>>;
144
165
  /**
145
166
  *
146
- * @param {string} tenantId
147
- * @param {CreateChatSessionCommand} [createChatSessionCommand]
167
+ * @summary Create a chat session.
168
+ * @param {string} tenantId The tenant identifier.
169
+ * @param {CreateChatSessionCommand} [createChatSessionCommand] The command to create a chat session.
148
170
  * @param {*} [options] Override http request option.
149
171
  * @throws {RequiredError}
150
172
  */
151
173
  apiV1ChatTenantIdSessionsPost(tenantId: string, createChatSessionCommand?: CreateChatSessionCommand, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatSessionModel>>;
152
174
  /**
153
175
  *
154
- * @param {string} tenantId
155
- * @param {string} sessionId
176
+ * @summary Convert a guest to a signed-in user.
177
+ * @param {string} tenantId The tenant identifier.
178
+ * @param {string} sessionId The session identifier.
179
+ * @param {*} [options] Override http request option.
180
+ * @throws {RequiredError}
181
+ */
182
+ apiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost(tenantId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatParticipantModel>>;
183
+ /**
184
+ *
185
+ * @summary Delete a chat session.
186
+ * @param {string} tenantId The tenant identifier.
187
+ * @param {string} sessionId The session identifier.
156
188
  * @param {*} [options] Override http request option.
157
189
  * @throws {RequiredError}
158
190
  */
159
191
  apiV1ChatTenantIdSessionsSessionIdDelete(tenantId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>;
160
192
  /**
161
193
  *
162
- * @param {string} tenantId
163
- * @param {string} sessionId
194
+ * @summary Get chat session by session Id.
195
+ * @param {string} tenantId The tenant identifier.
196
+ * @param {string} sessionId The session identifier.
164
197
  * @param {*} [options] Override http request option.
165
198
  * @throws {RequiredError}
166
199
  */
167
200
  apiV1ChatTenantIdSessionsSessionIdGet(tenantId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatSessionModel>>;
168
201
  /**
169
202
  *
170
- * @param {string} tenantId
171
- * @param {string} sessionId
172
- * @param {JoinChatSessionCommand} [joinChatSessionCommand]
203
+ * @summary Join a chat session.
204
+ * @param {string} tenantId The tenant identifier.
205
+ * @param {string} sessionId The session identifier.
206
+ * @param {JoinChatSessionCommand} [joinChatSessionCommand] The command to join a chat session.
173
207
  * @param {*} [options] Override http request option.
174
208
  * @throws {RequiredError}
175
209
  */
176
210
  apiV1ChatTenantIdSessionsSessionIdJoinPost(tenantId: string, sessionId: string, joinChatSessionCommand?: JoinChatSessionCommand, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatParticipantModel>>;
177
211
  /**
178
212
  *
179
- * @param {string} tenantId
180
- * @param {string} sessionId
213
+ * @summary Leave a chat session.
214
+ * @param {string} tenantId The tenant identifier.
215
+ * @param {string} sessionId The session identifier.
181
216
  * @param {*} [options] Override http request option.
182
217
  * @throws {RequiredError}
183
218
  */
184
219
  apiV1ChatTenantIdSessionsSessionIdLeaveDelete(tenantId: string, sessionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatParticipantModel>>;
185
220
  /**
186
221
  *
187
- * @param {string} tenantId
188
- * @param {string} sessionId
189
- * @param {number} [skip]
190
- * @param {number} [take]
222
+ * @summary Get messages from a chat session.
223
+ * @param {string} tenantId The tenant identifier.
224
+ * @param {string} sessionId The session identifier.
225
+ * @param {number} [page]
226
+ * @param {number} [limit]
227
+ * @param {Date} [lastRetrieved]
191
228
  * @param {*} [options] Override http request option.
192
229
  * @throws {RequiredError}
193
230
  */
194
- apiV1ChatTenantIdSessionsSessionIdMessagesGet(tenantId: string, sessionId: string, skip?: number, take?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatMessagesModel>>;
231
+ apiV1ChatTenantIdSessionsSessionIdMessagesGet(tenantId: string, sessionId: string, page?: number, limit?: number, lastRetrieved?: Date, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatMessagesModel>>;
195
232
  /**
196
233
  *
197
- * @param {string} tenantId
198
- * @param {string} sessionId
199
- * @param {ChatSendMessageCommand} [chatSendMessageCommand]
234
+ * @summary Send a message in a chat session.
235
+ * @param {string} tenantId The tenant identifier.
236
+ * @param {string} sessionId The session identifier.
237
+ * @param {ChatSendMessageCommand} [chatSendMessageCommand] The command to send a message.
200
238
  * @param {*} [options] Override http request option.
201
239
  * @throws {RequiredError}
202
240
  */
203
241
  apiV1ChatTenantIdSessionsSessionIdMessagesPost(tenantId: string, sessionId: string, chatSendMessageCommand?: ChatSendMessageCommand, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatMessageModel>>;
204
242
  /**
205
243
  *
206
- * @param {string} tenantId
207
- * @param {string} sessionId
208
- * @param {PutChatSessionCommand} [putChatSessionCommand]
244
+ * @summary Update a chat session.
245
+ * @param {string} tenantId The tenant identifier.
246
+ * @param {string} sessionId The session identifier.
247
+ * @param {PutChatSessionCommand} [putChatSessionCommand] The command to update a chat session.
209
248
  * @param {*} [options] Override http request option.
210
249
  * @throws {RequiredError}
211
250
  */
212
251
  apiV1ChatTenantIdSessionsSessionIdPatch(tenantId: string, sessionId: string, putChatSessionCommand?: PutChatSessionCommand, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatSessionsModel>>;
213
252
  /**
214
253
  *
215
- * @param {string} tenantId
216
- * @param {string} sessionId
217
- * @param {TransferManagerCommand} [transferManagerCommand]
254
+ * @summary Transfer a chat session agent.
255
+ * @param {string} tenantId The tenant identifier.
256
+ * @param {string} sessionId The session identifier.
257
+ * @param {TransferManagerCommand} [transferManagerCommand] The command to transfer a chat session.
218
258
  * @param {*} [options] Override http request option.
219
259
  * @throws {RequiredError}
220
260
  */
@@ -227,6 +267,7 @@ export declare const ChatApiFp: (configuration?: Configuration) => {
227
267
  export declare const ChatApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
228
268
  /**
229
269
  *
270
+ * @summary Get all chat sessions.
230
271
  * @param {ChatApiApiV1ChatTenantIdSessionsGetRequest} requestParameters Request parameters.
231
272
  * @param {*} [options] Override http request option.
232
273
  * @throws {RequiredError}
@@ -234,6 +275,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
234
275
  apiV1ChatTenantIdSessionsGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatSessionsModel>;
235
276
  /**
236
277
  *
278
+ * @summary Create a chat session.
237
279
  * @param {ChatApiApiV1ChatTenantIdSessionsPostRequest} requestParameters Request parameters.
238
280
  * @param {*} [options] Override http request option.
239
281
  * @throws {RequiredError}
@@ -241,6 +283,15 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
241
283
  apiV1ChatTenantIdSessionsPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatSessionModel>;
242
284
  /**
243
285
  *
286
+ * @summary Convert a guest to a signed-in user.
287
+ * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest} requestParameters Request parameters.
288
+ * @param {*} [options] Override http request option.
289
+ * @throws {RequiredError}
290
+ */
291
+ apiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatParticipantModel>;
292
+ /**
293
+ *
294
+ * @summary Delete a chat session.
244
295
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest} requestParameters Request parameters.
245
296
  * @param {*} [options] Override http request option.
246
297
  * @throws {RequiredError}
@@ -248,6 +299,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
248
299
  apiV1ChatTenantIdSessionsSessionIdDelete(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<boolean>;
249
300
  /**
250
301
  *
302
+ * @summary Get chat session by session Id.
251
303
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest} requestParameters Request parameters.
252
304
  * @param {*} [options] Override http request option.
253
305
  * @throws {RequiredError}
@@ -255,6 +307,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
255
307
  apiV1ChatTenantIdSessionsSessionIdGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatSessionModel>;
256
308
  /**
257
309
  *
310
+ * @summary Join a chat session.
258
311
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest} requestParameters Request parameters.
259
312
  * @param {*} [options] Override http request option.
260
313
  * @throws {RequiredError}
@@ -262,6 +315,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
262
315
  apiV1ChatTenantIdSessionsSessionIdJoinPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatParticipantModel>;
263
316
  /**
264
317
  *
318
+ * @summary Leave a chat session.
265
319
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest} requestParameters Request parameters.
266
320
  * @param {*} [options] Override http request option.
267
321
  * @throws {RequiredError}
@@ -269,6 +323,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
269
323
  apiV1ChatTenantIdSessionsSessionIdLeaveDelete(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatParticipantModel>;
270
324
  /**
271
325
  *
326
+ * @summary Get messages from a chat session.
272
327
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest} requestParameters Request parameters.
273
328
  * @param {*} [options] Override http request option.
274
329
  * @throws {RequiredError}
@@ -276,6 +331,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
276
331
  apiV1ChatTenantIdSessionsSessionIdMessagesGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatMessagesModel>;
277
332
  /**
278
333
  *
334
+ * @summary Send a message in a chat session.
279
335
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest} requestParameters Request parameters.
280
336
  * @param {*} [options] Override http request option.
281
337
  * @throws {RequiredError}
@@ -283,6 +339,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
283
339
  apiV1ChatTenantIdSessionsSessionIdMessagesPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatMessageModel>;
284
340
  /**
285
341
  *
342
+ * @summary Update a chat session.
286
343
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest} requestParameters Request parameters.
287
344
  * @param {*} [options] Override http request option.
288
345
  * @throws {RequiredError}
@@ -290,6 +347,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
290
347
  apiV1ChatTenantIdSessionsSessionIdPatch(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<ChatSessionsModel>;
291
348
  /**
292
349
  *
350
+ * @summary Transfer a chat session agent.
293
351
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPutRequest} requestParameters Request parameters.
294
352
  * @param {*} [options] Override http request option.
295
353
  * @throws {RequiredError}
@@ -303,7 +361,7 @@ export declare const ChatApiFactory: (configuration?: Configuration, basePath?:
303
361
  */
304
362
  export interface ChatApiApiV1ChatTenantIdSessionsGetRequest {
305
363
  /**
306
- *
364
+ * The tenant identifier.
307
365
  * @type {string}
308
366
  * @memberof ChatApiApiV1ChatTenantIdSessionsGet
309
367
  */
@@ -364,18 +422,37 @@ export interface ChatApiApiV1ChatTenantIdSessionsGetRequest {
364
422
  */
365
423
  export interface ChatApiApiV1ChatTenantIdSessionsPostRequest {
366
424
  /**
367
- *
425
+ * The tenant identifier.
368
426
  * @type {string}
369
427
  * @memberof ChatApiApiV1ChatTenantIdSessionsPost
370
428
  */
371
429
  readonly tenantId: string;
372
430
  /**
373
- *
431
+ * The command to create a chat session.
374
432
  * @type {CreateChatSessionCommand}
375
433
  * @memberof ChatApiApiV1ChatTenantIdSessionsPost
376
434
  */
377
435
  readonly createChatSessionCommand?: CreateChatSessionCommand;
378
436
  }
437
+ /**
438
+ * Request parameters for apiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost operation in ChatApi.
439
+ * @export
440
+ * @interface ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest
441
+ */
442
+ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest {
443
+ /**
444
+ * The tenant identifier.
445
+ * @type {string}
446
+ * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost
447
+ */
448
+ readonly tenantId: string;
449
+ /**
450
+ * The session identifier.
451
+ * @type {string}
452
+ * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost
453
+ */
454
+ readonly sessionId: string;
455
+ }
379
456
  /**
380
457
  * Request parameters for apiV1ChatTenantIdSessionsSessionIdDelete operation in ChatApi.
381
458
  * @export
@@ -383,13 +460,13 @@ export interface ChatApiApiV1ChatTenantIdSessionsPostRequest {
383
460
  */
384
461
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest {
385
462
  /**
386
- *
463
+ * The tenant identifier.
387
464
  * @type {string}
388
465
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdDelete
389
466
  */
390
467
  readonly tenantId: string;
391
468
  /**
392
- *
469
+ * The session identifier.
393
470
  * @type {string}
394
471
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdDelete
395
472
  */
@@ -402,13 +479,13 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest {
402
479
  */
403
480
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest {
404
481
  /**
405
- *
482
+ * The tenant identifier.
406
483
  * @type {string}
407
484
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdGet
408
485
  */
409
486
  readonly tenantId: string;
410
487
  /**
411
- *
488
+ * The session identifier.
412
489
  * @type {string}
413
490
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdGet
414
491
  */
@@ -421,19 +498,19 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest {
421
498
  */
422
499
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest {
423
500
  /**
424
- *
501
+ * The tenant identifier.
425
502
  * @type {string}
426
503
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPost
427
504
  */
428
505
  readonly tenantId: string;
429
506
  /**
430
- *
507
+ * The session identifier.
431
508
  * @type {string}
432
509
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPost
433
510
  */
434
511
  readonly sessionId: string;
435
512
  /**
436
- *
513
+ * The command to join a chat session.
437
514
  * @type {JoinChatSessionCommand}
438
515
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPost
439
516
  */
@@ -446,13 +523,13 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest {
446
523
  */
447
524
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest {
448
525
  /**
449
- *
526
+ * The tenant identifier.
450
527
  * @type {string}
451
528
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDelete
452
529
  */
453
530
  readonly tenantId: string;
454
531
  /**
455
- *
532
+ * The session identifier.
456
533
  * @type {string}
457
534
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDelete
458
535
  */
@@ -465,13 +542,13 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest {
465
542
  */
466
543
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest {
467
544
  /**
468
- *
545
+ * The tenant identifier.
469
546
  * @type {string}
470
547
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGet
471
548
  */
472
549
  readonly tenantId: string;
473
550
  /**
474
- *
551
+ * The session identifier.
475
552
  * @type {string}
476
553
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGet
477
554
  */
@@ -481,13 +558,19 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest {
481
558
  * @type {number}
482
559
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGet
483
560
  */
484
- readonly skip?: number;
561
+ readonly page?: number;
485
562
  /**
486
563
  *
487
564
  * @type {number}
488
565
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGet
489
566
  */
490
- readonly take?: number;
567
+ readonly limit?: number;
568
+ /**
569
+ *
570
+ * @type {Date}
571
+ * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGet
572
+ */
573
+ readonly lastRetrieved?: Date;
491
574
  }
492
575
  /**
493
576
  * Request parameters for apiV1ChatTenantIdSessionsSessionIdMessagesPost operation in ChatApi.
@@ -496,19 +579,19 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest {
496
579
  */
497
580
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest {
498
581
  /**
499
- *
582
+ * The tenant identifier.
500
583
  * @type {string}
501
584
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPost
502
585
  */
503
586
  readonly tenantId: string;
504
587
  /**
505
- *
588
+ * The session identifier.
506
589
  * @type {string}
507
590
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPost
508
591
  */
509
592
  readonly sessionId: string;
510
593
  /**
511
- *
594
+ * The command to send a message.
512
595
  * @type {ChatSendMessageCommand}
513
596
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPost
514
597
  */
@@ -521,19 +604,19 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest {
521
604
  */
522
605
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest {
523
606
  /**
524
- *
607
+ * The tenant identifier.
525
608
  * @type {string}
526
609
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdPatch
527
610
  */
528
611
  readonly tenantId: string;
529
612
  /**
530
- *
613
+ * The session identifier.
531
614
  * @type {string}
532
615
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdPatch
533
616
  */
534
617
  readonly sessionId: string;
535
618
  /**
536
- *
619
+ * The command to update a chat session.
537
620
  * @type {PutChatSessionCommand}
538
621
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdPatch
539
622
  */
@@ -546,19 +629,19 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest {
546
629
  */
547
630
  export interface ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPutRequest {
548
631
  /**
549
- *
632
+ * The tenant identifier.
550
633
  * @type {string}
551
634
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPut
552
635
  */
553
636
  readonly tenantId: string;
554
637
  /**
555
- *
638
+ * The session identifier.
556
639
  * @type {string}
557
640
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPut
558
641
  */
559
642
  readonly sessionId: string;
560
643
  /**
561
- *
644
+ * The command to transfer a chat session.
562
645
  * @type {TransferManagerCommand}
563
646
  * @memberof ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPut
564
647
  */
@@ -573,6 +656,7 @@ export interface ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPutRequest {
573
656
  export declare class ChatApi extends BaseAPI {
574
657
  /**
575
658
  *
659
+ * @summary Get all chat sessions.
576
660
  * @param {ChatApiApiV1ChatTenantIdSessionsGetRequest} requestParameters Request parameters.
577
661
  * @param {*} [options] Override http request option.
578
662
  * @throws {RequiredError}
@@ -581,6 +665,7 @@ export declare class ChatApi extends BaseAPI {
581
665
  apiV1ChatTenantIdSessionsGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatSessionsModel, any>>;
582
666
  /**
583
667
  *
668
+ * @summary Create a chat session.
584
669
  * @param {ChatApiApiV1ChatTenantIdSessionsPostRequest} requestParameters Request parameters.
585
670
  * @param {*} [options] Override http request option.
586
671
  * @throws {RequiredError}
@@ -589,6 +674,16 @@ export declare class ChatApi extends BaseAPI {
589
674
  apiV1ChatTenantIdSessionsPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatSessionModel, any>>;
590
675
  /**
591
676
  *
677
+ * @summary Convert a guest to a signed-in user.
678
+ * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest} requestParameters Request parameters.
679
+ * @param {*} [options] Override http request option.
680
+ * @throws {RequiredError}
681
+ * @memberof ChatApi
682
+ */
683
+ apiV1ChatTenantIdSessionsSessionIdConvertsigninuserPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdConvertsigninuserPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatParticipantModel, any>>;
684
+ /**
685
+ *
686
+ * @summary Delete a chat session.
592
687
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest} requestParameters Request parameters.
593
688
  * @param {*} [options] Override http request option.
594
689
  * @throws {RequiredError}
@@ -597,6 +692,7 @@ export declare class ChatApi extends BaseAPI {
597
692
  apiV1ChatTenantIdSessionsSessionIdDelete(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<boolean, any>>;
598
693
  /**
599
694
  *
695
+ * @summary Get chat session by session Id.
600
696
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest} requestParameters Request parameters.
601
697
  * @param {*} [options] Override http request option.
602
698
  * @throws {RequiredError}
@@ -605,6 +701,7 @@ export declare class ChatApi extends BaseAPI {
605
701
  apiV1ChatTenantIdSessionsSessionIdGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatSessionModel, any>>;
606
702
  /**
607
703
  *
704
+ * @summary Join a chat session.
608
705
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest} requestParameters Request parameters.
609
706
  * @param {*} [options] Override http request option.
610
707
  * @throws {RequiredError}
@@ -613,6 +710,7 @@ export declare class ChatApi extends BaseAPI {
613
710
  apiV1ChatTenantIdSessionsSessionIdJoinPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdJoinPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatParticipantModel, any>>;
614
711
  /**
615
712
  *
713
+ * @summary Leave a chat session.
616
714
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest} requestParameters Request parameters.
617
715
  * @param {*} [options] Override http request option.
618
716
  * @throws {RequiredError}
@@ -621,6 +719,7 @@ export declare class ChatApi extends BaseAPI {
621
719
  apiV1ChatTenantIdSessionsSessionIdLeaveDelete(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdLeaveDeleteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatParticipantModel, any>>;
622
720
  /**
623
721
  *
722
+ * @summary Get messages from a chat session.
624
723
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest} requestParameters Request parameters.
625
724
  * @param {*} [options] Override http request option.
626
725
  * @throws {RequiredError}
@@ -629,6 +728,7 @@ export declare class ChatApi extends BaseAPI {
629
728
  apiV1ChatTenantIdSessionsSessionIdMessagesGet(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesGetRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatMessagesModel, any>>;
630
729
  /**
631
730
  *
731
+ * @summary Send a message in a chat session.
632
732
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest} requestParameters Request parameters.
633
733
  * @param {*} [options] Override http request option.
634
734
  * @throws {RequiredError}
@@ -637,6 +737,7 @@ export declare class ChatApi extends BaseAPI {
637
737
  apiV1ChatTenantIdSessionsSessionIdMessagesPost(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdMessagesPostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatMessageModel, any>>;
638
738
  /**
639
739
  *
740
+ * @summary Update a chat session.
640
741
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest} requestParameters Request parameters.
641
742
  * @param {*} [options] Override http request option.
642
743
  * @throws {RequiredError}
@@ -645,6 +746,7 @@ export declare class ChatApi extends BaseAPI {
645
746
  apiV1ChatTenantIdSessionsSessionIdPatch(requestParameters: ChatApiApiV1ChatTenantIdSessionsSessionIdPatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatSessionsModel, any>>;
646
747
  /**
647
748
  *
749
+ * @summary Transfer a chat session agent.
648
750
  * @param {ChatApiApiV1ChatTenantIdSessionsSessionIdTransferPutRequest} requestParameters Request parameters.
649
751
  * @param {*} [options] Override http request option.
650
752
  * @throws {RequiredError}