-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.ts
502 lines (440 loc) · 17.7 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import * as coreHttp from "@azure/core-http";
/** A paged collection of chat message read receipts. */
export interface ChatMessageReadReceiptsCollection {
/** Collection of chat message read receipts. */
value: ChatMessageReadReceipt[];
/**
* If there are more chat message read receipts that can be retrieved, the next link will be populated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** A chat message read receipt indicates the time a chat message was read by a recipient. */
export interface ChatMessageReadReceipt {
/** Id of the participant who read the message. */
senderId: string;
/** Id of the chat message that has been read. This id is generated by the server. */
chatMessageId: string;
/** The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
readOn: Date;
}
/** The Communication Services error. */
export interface CommunicationErrorResponse {
/** The Communication Services error. */
error: CommunicationError | null;
}
/** The Communication Services error. */
export interface CommunicationError {
/** The error code. */
code: string;
/** The error message. */
message: string;
/**
* The error target.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly target?: string;
/**
* Further details about specific errors that led to this error.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly details?: (CommunicationError | null)[];
/**
* The inner error if any.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly innerError?: CommunicationError | null;
}
/** Request payload for sending a read receipt. */
export interface SendReadReceiptRequest {
/** Id of the latest chat message read by the user. */
chatMessageId: string;
}
/** Details of the message to send. */
export interface SendChatMessageRequest {
/** Chat message content. */
content: string;
/** The display name of the chat message sender. This property is used to populate sender name for push notifications. */
senderDisplayName?: string;
/** The chat message type. */
type?: ChatMessageType;
}
/** Result of the send message operation. */
export interface SendChatMessageResult {
/** A server-generated message id. */
id: string;
}
/** Collection of chat messages for a particular chat thread. */
export interface ChatMessagesCollection {
/** Collection of chat messages. */
value: ChatMessage[];
/**
* If there are more chat messages that can be retrieved, the next link will be populated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Chat message. */
export interface ChatMessage {
/** The id of the chat message. This id is server generated. */
id: string;
/** The chat message type. */
type: ChatMessageType;
/** Sequence of the chat message in the conversation. */
sequenceId: string;
/** Version of the chat message. */
version: string;
/** Content of a chat message. */
content?: ChatMessageContent;
/** The display name of the chat message sender. This property is used to populate sender name for push notifications. */
senderDisplayName?: string;
/** The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
createdOn: Date;
/** The id of the chat message sender. */
senderId?: string;
/** The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
deletedOn?: Date;
/** The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
editedOn?: Date;
}
/** Content of a chat message. */
export interface ChatMessageContent {
/** Chat message content for messages of types text or html. */
message?: string;
/** Chat message content for messages of type topicUpdated. */
topic?: string;
/** Chat message content for messages of types participantAdded or participantRemoved. */
participants?: ChatParticipant[];
/** Chat message content for messages of types participantAdded or participantRemoved. */
initiator?: string;
}
/** A participant of the chat thread. */
export interface ChatParticipant {
/** The id of the chat participant. */
id: string;
/** Display name for the chat participant. */
displayName?: string;
/** Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
shareHistoryTime?: Date;
}
/** Request payload for updating a chat message. */
export interface UpdateChatMessageRequest {
/** Chat message content. */
content?: string;
}
/** Collection of participants belong to a particular thread. */
export interface ChatParticipantsCollection {
/** Chat participants. */
value: ChatParticipant[];
/**
* If there are more chat participants that can be retrieved, the next link will be populated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Participants to be added to the thread. */
export interface AddChatParticipantsRequest {
/** Participants to add to a chat thread. */
participants: ChatParticipant[];
}
/** Result of the add chat participants operation. */
export interface AddChatParticipantsResult {
/** Errors encountered during the addition of the chat participant to the chat thread. */
errors?: AddChatParticipantsErrors;
}
/** Errors encountered during the addition of the chat participant to the chat thread. */
export interface AddChatParticipantsErrors {
/** The participants that failed to be added to the chat thread. */
invalidParticipants: (CommunicationError | null)[];
}
/** Request payload for creating a chat thread. */
export interface CreateChatThreadRequest {
/** The chat thread topic. */
topic: string;
/** Participants to be added to the chat thread. */
participants: ChatParticipant[];
}
/** Result of the create chat thread operation. */
export interface CreateChatThreadResult {
/** Chat thread. */
chatThread?: ChatThread;
/** Errors encountered during the creation of the chat thread. */
errors?: CreateChatThreadErrors;
}
/** Chat thread. */
export interface ChatThread {
/** Chat thread id. */
id: string;
/** Chat thread topic. */
topic: string;
/** The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
createdOn: Date;
/** Id of the chat thread owner. */
createdBy: string;
/** The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
deletedOn?: Date;
}
/** Errors encountered during the creation of the chat thread. */
export interface CreateChatThreadErrors {
/**
* The participants that failed to be added to the chat thread.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly invalidParticipants?: (CommunicationError | null)[];
}
/** Collection of chat threads. */
export interface ChatThreadsInfoCollection {
/** Collection of chat threads. */
value: ChatThreadInfo[];
/**
* If there are more chat threads that can be retrieved, the next link will be populated.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly nextLink?: string;
}
/** Summary information of a chat thread. */
export interface ChatThreadInfo {
/** Chat thread id. */
id: string;
/** Chat thread topic. */
topic: string;
/** The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
deletedOn?: Date;
/**
* The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
* NOTE: This property will not be serialized. It can only be populated by the server.
*/
readonly lastMessageReceivedOn?: Date;
}
/** Request payload for updating a chat thread. */
export interface UpdateChatThreadRequest {
/** Chat thread topic. */
topic?: string;
}
/** Known values of {@link ChatMessageType} that the service accepts. */
export const enum KnownChatMessageType {
Text = "text",
Html = "html",
TopicUpdated = "topicUpdated",
ParticipantAdded = "participantAdded",
ParticipantRemoved = "participantRemoved"
}
/**
* Defines values for ChatMessageType. \
* {@link KnownChatMessageType} can be used interchangeably with ChatMessageType,
* this enum contains the known values that the service supports.
* ### Know values supported by the service
* **text** \
* **html** \
* **topicUpdated** \
* **participantAdded** \
* **participantRemoved**
*/
export type ChatMessageType = string;
/** Optional parameters. */
export interface ChatThreadListChatReadReceiptsOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of chat message read receipts to be returned per page. */
maxPageSize?: number;
/** Skips chat message read receipts up to a specified position in response. */
skip?: number;
}
/** Contains response data for the listChatReadReceipts operation. */
export type ChatThreadListChatReadReceiptsResponse = ChatMessageReadReceiptsCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatMessageReadReceiptsCollection;
};
};
/** Contains response data for the sendChatMessage operation. */
export type ChatThreadSendChatMessageResponse = SendChatMessageResult & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: SendChatMessageResult;
};
};
/** Optional parameters. */
export interface ChatThreadListChatMessagesOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of messages to be returned per page. */
maxPageSize?: number;
/** The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
startTime?: Date;
}
/** Contains response data for the listChatMessages operation. */
export type ChatThreadListChatMessagesResponse = ChatMessagesCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatMessagesCollection;
};
};
/** Contains response data for the getChatMessage operation. */
export type ChatThreadGetChatMessageResponse = ChatMessage & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatMessage;
};
};
/** Optional parameters. */
export interface ChatThreadListChatParticipantsOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of participants to be returned per page. */
maxPageSize?: number;
/** Skips participants up to a specified position in response. */
skip?: number;
}
/** Contains response data for the listChatParticipants operation. */
export type ChatThreadListChatParticipantsResponse = ChatParticipantsCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatParticipantsCollection;
};
};
/** Contains response data for the addChatParticipants operation. */
export type ChatThreadAddChatParticipantsResponse = AddChatParticipantsResult & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: AddChatParticipantsResult;
};
};
/** Optional parameters. */
export interface ChatThreadListChatReadReceiptsNextOptionalParams
extends coreHttp.OperationOptions {
/** The maximum number of chat message read receipts to be returned per page. */
maxPageSize?: number;
/** Skips chat message read receipts up to a specified position in response. */
skip?: number;
}
/** Contains response data for the listChatReadReceiptsNext operation. */
export type ChatThreadListChatReadReceiptsNextResponse = ChatMessageReadReceiptsCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatMessageReadReceiptsCollection;
};
};
/** Optional parameters. */
export interface ChatThreadListChatMessagesNextOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of messages to be returned per page. */
maxPageSize?: number;
/** The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
startTime?: Date;
}
/** Contains response data for the listChatMessagesNext operation. */
export type ChatThreadListChatMessagesNextResponse = ChatMessagesCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatMessagesCollection;
};
};
/** Optional parameters. */
export interface ChatThreadListChatParticipantsNextOptionalParams
extends coreHttp.OperationOptions {
/** The maximum number of participants to be returned per page. */
maxPageSize?: number;
/** Skips participants up to a specified position in response. */
skip?: number;
}
/** Contains response data for the listChatParticipantsNext operation. */
export type ChatThreadListChatParticipantsNextResponse = ChatParticipantsCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatParticipantsCollection;
};
};
/** Optional parameters. */
export interface ChatCreateChatThreadOptionalParams extends coreHttp.OperationOptions {
/** If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. */
repeatabilityRequestID?: string;
}
/** Contains response data for the createChatThread operation. */
export type ChatCreateChatThreadResponse = CreateChatThreadResult & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: CreateChatThreadResult;
};
};
/** Optional parameters. */
export interface ChatListChatThreadsOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of chat threads returned per page. */
maxPageSize?: number;
/** The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
startTime?: Date;
}
/** Contains response data for the listChatThreads operation. */
export type ChatListChatThreadsResponse = ChatThreadsInfoCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatThreadsInfoCollection;
};
};
/** Contains response data for the getChatThread operation. */
export type ChatGetChatThreadResponse = ChatThread & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatThread;
};
};
/** Optional parameters. */
export interface ChatListChatThreadsNextOptionalParams extends coreHttp.OperationOptions {
/** The maximum number of chat threads returned per page. */
maxPageSize?: number;
/** The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`. */
startTime?: Date;
}
/** Contains response data for the listChatThreadsNext operation. */
export type ChatListChatThreadsNextResponse = ChatThreadsInfoCollection & {
/** The underlying HTTP response. */
_response: coreHttp.HttpResponse & {
/** The response body as text (string format) */
bodyAsText: string;
/** The response body as parsed JSON or XML */
parsedBody: ChatThreadsInfoCollection;
};
};
/** Optional parameters. */
export interface ChatApiClientOptionalParams extends coreHttp.ServiceClientOptions {
/** Api Version */
apiVersion?: string;
/** Overrides client endpoint. */
endpoint?: string;
}