@stream-io/node-sdk 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 (101) hide show
  1. package/.readme-assets/Github-Graphic-JS.jpg +0 -0
  2. package/LICENSE +219 -0
  3. package/README.md +29 -0
  4. package/dist/__tests__/block-lists.test.d.ts +1 -0
  5. package/dist/__tests__/call-members.test.d.ts +1 -0
  6. package/dist/__tests__/call-types.test.d.ts +1 -0
  7. package/dist/__tests__/call.test.d.ts +1 -0
  8. package/dist/__tests__/channel-types.test.d.ts +1 -0
  9. package/dist/__tests__/channel.test.d.ts +1 -0
  10. package/dist/__tests__/command.test.d.ts +1 -0
  11. package/dist/__tests__/create-token.test.d.ts +1 -0
  12. package/dist/__tests__/devices-push.test.d.ts +1 -0
  13. package/dist/__tests__/messages.test.d.ts +1 -0
  14. package/dist/__tests__/permissions-app-settings.test.d.ts +1 -0
  15. package/dist/__tests__/user-compat.test.d.ts +1 -0
  16. package/dist/__tests__/users.test.d.ts +1 -0
  17. package/dist/index.cjs.js +8789 -0
  18. package/dist/index.cjs.js.map +1 -0
  19. package/dist/index.d.ts +7 -0
  20. package/dist/index.es.js +8708 -0
  21. package/dist/index.es.js.map +1 -0
  22. package/dist/src/StreamCall.d.ts +37 -0
  23. package/dist/src/StreamChannel.d.ts +39 -0
  24. package/dist/src/StreamChatClient.d.ts +31 -0
  25. package/dist/src/StreamClient.d.ts +68 -0
  26. package/dist/src/StreamVideoClient.d.ts +16 -0
  27. package/dist/src/gen/chat/apis/ChannelTypesApi.d.ts +81 -0
  28. package/dist/src/gen/chat/apis/ChannelsApi.d.ts +308 -0
  29. package/dist/src/gen/chat/apis/CustomCommandsApi.d.ts +81 -0
  30. package/dist/src/gen/chat/apis/DefaultApi.d.ts +60 -0
  31. package/dist/src/gen/chat/apis/DevicesApi.d.ts +58 -0
  32. package/dist/src/gen/chat/apis/EventsApi.d.ts +64 -0
  33. package/dist/src/gen/chat/apis/FilesApi.d.ts +81 -0
  34. package/dist/src/gen/chat/apis/GDPRApi.d.ts +114 -0
  35. package/dist/src/gen/chat/apis/ImportsApi.d.ts +67 -0
  36. package/dist/src/gen/chat/apis/MessagesApi.d.ts +370 -0
  37. package/dist/src/gen/chat/apis/ModerationApi.d.ts +271 -0
  38. package/dist/src/gen/chat/apis/PermissionsV2Api.d.ts +77 -0
  39. package/dist/src/gen/chat/apis/PushApi.d.ts +65 -0
  40. package/dist/src/gen/chat/apis/ReactionsApi.d.ts +62 -0
  41. package/dist/src/gen/chat/apis/ServerSideApi.d.ts +31 -0
  42. package/dist/src/gen/chat/apis/SettingsApi.d.ts +257 -0
  43. package/dist/src/gen/chat/apis/TasksApi.d.ts +31 -0
  44. package/dist/src/gen/chat/apis/TestingApi.d.ts +57 -0
  45. package/dist/src/gen/chat/apis/UsersApi.d.ts +313 -0
  46. package/dist/src/gen/chat/apis/index.d.ts +19 -0
  47. package/dist/src/gen/chat/index.d.ts +3 -0
  48. package/dist/src/gen/chat/models/index.d.ts +15624 -0
  49. package/dist/src/gen/chat/runtime.d.ts +180 -0
  50. package/dist/src/gen/video/apis/DefaultApi.d.ts +505 -0
  51. package/dist/src/gen/video/apis/ServerSideApi.d.ts +81 -0
  52. package/dist/src/gen/video/apis/index.d.ts +2 -0
  53. package/dist/src/gen/video/index.d.ts +3 -0
  54. package/dist/src/gen/video/models/index.d.ts +4733 -0
  55. package/dist/src/gen/video/runtime.d.ts +180 -0
  56. package/dist/src/types.d.ts +1 -0
  57. package/dist/src/utils/create-token.d.ts +3 -0
  58. package/index.ts +7 -0
  59. package/package.json +47 -0
  60. package/src/StreamCall.ts +161 -0
  61. package/src/StreamChannel.ts +165 -0
  62. package/src/StreamChatClient.ts +102 -0
  63. package/src/StreamClient.ts +440 -0
  64. package/src/StreamVideoClient.ts +63 -0
  65. package/src/gen/chat/.openapi-generator/FILES +24 -0
  66. package/src/gen/chat/.openapi-generator/VERSION +1 -0
  67. package/src/gen/chat/.openapi-generator-ignore +23 -0
  68. package/src/gen/chat/apis/ChannelTypesApi.ts +275 -0
  69. package/src/gen/chat/apis/ChannelsApi.ts +1221 -0
  70. package/src/gen/chat/apis/CustomCommandsApi.ts +276 -0
  71. package/src/gen/chat/apis/DefaultApi.ts +196 -0
  72. package/src/gen/chat/apis/DevicesApi.ts +180 -0
  73. package/src/gen/chat/apis/EventsApi.ts +220 -0
  74. package/src/gen/chat/apis/FilesApi.ts +312 -0
  75. package/src/gen/chat/apis/GDPRApi.ts +418 -0
  76. package/src/gen/chat/apis/ImportsApi.ts +222 -0
  77. package/src/gen/chat/apis/MessagesApi.ts +1475 -0
  78. package/src/gen/chat/apis/ModerationApi.ts +1038 -0
  79. package/src/gen/chat/apis/PermissionsV2Api.ts +259 -0
  80. package/src/gen/chat/apis/PushApi.ts +183 -0
  81. package/src/gen/chat/apis/ReactionsApi.ts +202 -0
  82. package/src/gen/chat/apis/ServerSideApi.ts +79 -0
  83. package/src/gen/chat/apis/SettingsApi.ts +948 -0
  84. package/src/gen/chat/apis/TasksApi.ts +75 -0
  85. package/src/gen/chat/apis/TestingApi.ts +185 -0
  86. package/src/gen/chat/apis/UsersApi.ts +1203 -0
  87. package/src/gen/chat/apis/index.ts +30 -0
  88. package/src/gen/chat/index.ts +5 -0
  89. package/src/gen/chat/models/index.ts +15541 -0
  90. package/src/gen/chat/runtime.ts +415 -0
  91. package/src/gen/video/.openapi-generator/FILES +7 -0
  92. package/src/gen/video/.openapi-generator/VERSION +1 -0
  93. package/src/gen/video/.openapi-generator-ignore +23 -0
  94. package/src/gen/video/apis/DefaultApi.ts +1997 -0
  95. package/src/gen/video/apis/ServerSideApi.ts +276 -0
  96. package/src/gen/video/apis/index.ts +4 -0
  97. package/src/gen/video/index.ts +5 -0
  98. package/src/gen/video/models/index.ts +4642 -0
  99. package/src/gen/video/runtime.ts +415 -0
  100. package/src/types.ts +1 -0
  101. package/src/utils/create-token.ts +49 -0
@@ -0,0 +1,370 @@
1
+ /**
2
+ * Stream Chat API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: v89.9.2
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { FileDeleteResponse, FileUploadResponse, FlagRequest, FlagResponse, GetManyMessagesResponse, GetOGResponse, GetReactionsResponse, GetRepliesResponse, ImageSizeRequest, ImageUploadResponse, MarkChannelsReadRequest, MarkReadRequest, MarkReadResponse, MarkUnreadRequest, MessageActionRequest, MessageResponse, MessageWithPendingMetadataResponse, OnlyUserIDRequest, QueryMessageFlagsRequest, QueryMessageFlagsResponse, ReactionRemovalResponse, ReactionResponse, Response, SearchRequest, SearchResponse, SendMessageRequest, SendReactionRequest, TranslateMessageRequest, UpdateMessagePartialRequest, UpdateMessageRequest } from '../models';
14
+ export interface DeleteFileRequest {
15
+ type: string;
16
+ id: string;
17
+ url?: string;
18
+ }
19
+ export interface DeleteImageRequest {
20
+ type: string;
21
+ id: string;
22
+ url?: string;
23
+ }
24
+ export interface DeleteMessageRequest {
25
+ id: string;
26
+ hard?: boolean;
27
+ createdBy?: string;
28
+ }
29
+ export interface DeleteReactionRequest {
30
+ id: string;
31
+ type: string;
32
+ userId?: string;
33
+ }
34
+ export interface FlagOperationRequest {
35
+ flagRequest: FlagRequest | null;
36
+ }
37
+ export interface GetManyMessagesRequest {
38
+ type: string;
39
+ id: string;
40
+ ids?: Array<string>;
41
+ }
42
+ export interface GetMessageRequest {
43
+ id: string;
44
+ }
45
+ export interface GetOGRequest {
46
+ url?: string;
47
+ }
48
+ export interface GetReactionsRequest {
49
+ id: string;
50
+ limit?: number;
51
+ offset?: number;
52
+ }
53
+ export interface GetRepliesRequest {
54
+ parentId: string;
55
+ idGte?: string;
56
+ idGt?: string;
57
+ idLte?: string;
58
+ idLt?: string;
59
+ createdAtAfterOrEqual?: string;
60
+ createdAtAfter?: string;
61
+ createdAtBeforeOrEqual?: string;
62
+ createdAtBefore?: string;
63
+ idAround?: string;
64
+ createdAtAround?: string;
65
+ }
66
+ export interface MarkChannelsReadOperationRequest {
67
+ markChannelsReadRequest: MarkChannelsReadRequest | null;
68
+ }
69
+ export interface MarkReadOperationRequest {
70
+ type: string;
71
+ id: string;
72
+ markReadRequest: MarkReadRequest | null;
73
+ }
74
+ export interface MarkUnreadOperationRequest {
75
+ type: string;
76
+ id: string;
77
+ markUnreadRequest: MarkUnreadRequest | null;
78
+ }
79
+ export interface QueryMessageFlagsOperationRequest {
80
+ payload?: QueryMessageFlagsRequest;
81
+ }
82
+ export interface RunMessageActionRequest {
83
+ id: string;
84
+ messageActionRequest: MessageActionRequest | null;
85
+ }
86
+ export interface SearchOperationRequest {
87
+ payload?: SearchRequest;
88
+ }
89
+ export interface SendMessageOperationRequest {
90
+ type: string;
91
+ id: string;
92
+ sendMessageRequest: SendMessageRequest | null;
93
+ }
94
+ export interface SendReactionOperationRequest {
95
+ id: string;
96
+ sendReactionRequest: SendReactionRequest | null;
97
+ }
98
+ export interface TranslateMessageOperationRequest {
99
+ id: string;
100
+ translateMessageRequest: TranslateMessageRequest | null;
101
+ }
102
+ export interface UnflagRequest {
103
+ flagRequest: FlagRequest | null;
104
+ }
105
+ export interface UpdateMessageOperationRequest {
106
+ id: string;
107
+ updateMessageRequest: UpdateMessageRequest | null;
108
+ }
109
+ export interface UpdateMessagePartialOperationRequest {
110
+ id: string;
111
+ updateMessagePartialRequest: UpdateMessagePartialRequest | null;
112
+ }
113
+ export interface UploadFileRequest {
114
+ type: string;
115
+ id: string;
116
+ file?: string;
117
+ user?: OnlyUserIDRequest;
118
+ }
119
+ export interface UploadImageRequest {
120
+ type: string;
121
+ id: string;
122
+ file?: string;
123
+ uploadSizes?: Array<ImageSizeRequest>;
124
+ user?: OnlyUserIDRequest;
125
+ }
126
+ /**
127
+ *
128
+ */
129
+ export declare class MessagesApi extends runtime.BaseAPI {
130
+ /**
131
+ * Deletes previously uploaded file Required permissions: - DeleteAttachment
132
+ * Delete file
133
+ */
134
+ deleteFileRaw(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileDeleteResponse>>;
135
+ /**
136
+ * Deletes previously uploaded file Required permissions: - DeleteAttachment
137
+ * Delete file
138
+ */
139
+ deleteFile(requestParameters: DeleteFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDeleteResponse>;
140
+ /**
141
+ * Deletes previously uploaded image Required permissions: - DeleteAttachment
142
+ * Delete image
143
+ */
144
+ deleteImageRaw(requestParameters: DeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileDeleteResponse>>;
145
+ /**
146
+ * Deletes previously uploaded image Required permissions: - DeleteAttachment
147
+ * Delete image
148
+ */
149
+ deleteImage(requestParameters: DeleteImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileDeleteResponse>;
150
+ /**
151
+ * Deletes message Sends events: - message.deleted Required permissions: - DeleteMessage
152
+ * Delete message
153
+ */
154
+ deleteMessageRaw(requestParameters: DeleteMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
155
+ /**
156
+ * Deletes message Sends events: - message.deleted Required permissions: - DeleteMessage
157
+ * Delete message
158
+ */
159
+ deleteMessage(requestParameters: DeleteMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
160
+ /**
161
+ * Removes user reaction from the message Sends events: - reaction.deleted Required permissions: - DeleteReaction
162
+ * Delete reaction
163
+ */
164
+ deleteReactionRaw(requestParameters: DeleteReactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactionRemovalResponse>>;
165
+ /**
166
+ * Removes user reaction from the message Sends events: - reaction.deleted Required permissions: - DeleteReaction
167
+ * Delete reaction
168
+ */
169
+ deleteReaction(requestParameters: DeleteReactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactionRemovalResponse>;
170
+ /**
171
+ * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
172
+ * Flag
173
+ */
174
+ flagRaw(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
175
+ /**
176
+ * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
177
+ * Flag
178
+ */
179
+ flag(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
180
+ /**
181
+ * Returns list messages found by IDs Required permissions: - ReadChannel
182
+ * Get many messages
183
+ */
184
+ getManyMessagesRaw(requestParameters: GetManyMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetManyMessagesResponse>>;
185
+ /**
186
+ * Returns list messages found by IDs Required permissions: - ReadChannel
187
+ * Get many messages
188
+ */
189
+ getManyMessages(requestParameters: GetManyMessagesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetManyMessagesResponse>;
190
+ /**
191
+ * Returns message by ID Required permissions: - ReadChannel
192
+ * Get message
193
+ */
194
+ getMessageRaw(requestParameters: GetMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageWithPendingMetadataResponse>>;
195
+ /**
196
+ * Returns message by ID Required permissions: - ReadChannel
197
+ * Get message
198
+ */
199
+ getMessage(requestParameters: GetMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageWithPendingMetadataResponse>;
200
+ /**
201
+ * Get an OpenGraph attachment for a link
202
+ * Get OG
203
+ */
204
+ getOGRaw(requestParameters: GetOGRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetOGResponse>>;
205
+ /**
206
+ * Get an OpenGraph attachment for a link
207
+ * Get OG
208
+ */
209
+ getOG(requestParameters?: GetOGRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetOGResponse>;
210
+ /**
211
+ * Returns list of reactions of specific message Required permissions: - ReadChannel
212
+ * Get reactions
213
+ */
214
+ getReactionsRaw(requestParameters: GetReactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReactionsResponse>>;
215
+ /**
216
+ * Returns list of reactions of specific message Required permissions: - ReadChannel
217
+ * Get reactions
218
+ */
219
+ getReactions(requestParameters: GetReactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReactionsResponse>;
220
+ /**
221
+ * Returns replies (thread) of the message Required permissions: - ReadChannel
222
+ * Get replies
223
+ */
224
+ getRepliesRaw(requestParameters: GetRepliesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRepliesResponse>>;
225
+ /**
226
+ * Returns replies (thread) of the message Required permissions: - ReadChannel
227
+ * Get replies
228
+ */
229
+ getReplies(requestParameters: GetRepliesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRepliesResponse>;
230
+ /**
231
+ * Marks channels as read up to the specific message. If no channels is given, mark all channel as read Sends events: - message.read Required permissions: - ReadChannel
232
+ * Mark channels as read
233
+ */
234
+ markChannelsReadRaw(requestParameters: MarkChannelsReadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MarkReadResponse>>;
235
+ /**
236
+ * Marks channels as read up to the specific message. If no channels is given, mark all channel as read Sends events: - message.read Required permissions: - ReadChannel
237
+ * Mark channels as read
238
+ */
239
+ markChannelsRead(requestParameters: MarkChannelsReadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MarkReadResponse>;
240
+ /**
241
+ * Marks channel as read up to the specific message Sends events: - message.read Required permissions: - ReadChannel
242
+ * Mark read
243
+ */
244
+ markReadRaw(requestParameters: MarkReadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MarkReadResponse>>;
245
+ /**
246
+ * Marks channel as read up to the specific message Sends events: - message.read Required permissions: - ReadChannel
247
+ * Mark read
248
+ */
249
+ markRead(requestParameters: MarkReadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MarkReadResponse>;
250
+ /**
251
+ * Marks channel as unread from a specific message Required permissions: - ReadChannel
252
+ * Mark unread
253
+ */
254
+ markUnreadRaw(requestParameters: MarkUnreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
255
+ /**
256
+ * Marks channel as unread from a specific message Required permissions: - ReadChannel
257
+ * Mark unread
258
+ */
259
+ markUnread(requestParameters: MarkUnreadOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
260
+ /**
261
+ * Find and filter message flags Required permissions: - ReadMessageFlags
262
+ * Query Message Flags
263
+ */
264
+ queryMessageFlagsRaw(requestParameters: QueryMessageFlagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryMessageFlagsResponse>>;
265
+ /**
266
+ * Find and filter message flags Required permissions: - ReadMessageFlags
267
+ * Query Message Flags
268
+ */
269
+ queryMessageFlags(requestParameters?: QueryMessageFlagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryMessageFlagsResponse>;
270
+ /**
271
+ * Executes message command action with given parameters Sends events: - message.new Required permissions: - RunMessageAction
272
+ * Run message command action
273
+ */
274
+ runMessageActionRaw(requestParameters: RunMessageActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
275
+ /**
276
+ * Executes message command action with given parameters Sends events: - message.new Required permissions: - RunMessageAction
277
+ * Run message command action
278
+ */
279
+ runMessageAction(requestParameters: RunMessageActionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
280
+ /**
281
+ * Search messages across channels Required permissions: - ReadChannel
282
+ * Search messages
283
+ */
284
+ searchRaw(requestParameters: SearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResponse>>;
285
+ /**
286
+ * Search messages across channels Required permissions: - ReadChannel
287
+ * Search messages
288
+ */
289
+ search(requestParameters?: SearchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResponse>;
290
+ /**
291
+ * Sends new message to the specified channel Sends events: - message.new - message.updated Required permissions: - AddLinks - CreateMessage - PinMessage - SkipChannelCooldown - SkipMessageModeration - UseFrozenChannel
292
+ * Send new message
293
+ */
294
+ sendMessageRaw(requestParameters: SendMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageWithPendingMetadataResponse>>;
295
+ /**
296
+ * Sends new message to the specified channel Sends events: - message.new - message.updated Required permissions: - AddLinks - CreateMessage - PinMessage - SkipChannelCooldown - SkipMessageModeration - UseFrozenChannel
297
+ * Send new message
298
+ */
299
+ sendMessage(requestParameters: SendMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageWithPendingMetadataResponse>;
300
+ /**
301
+ * Sends reaction to specified message Sends events: - reaction.new - reaction.updated Required permissions: - CreateReaction - UseFrozenChannel
302
+ * Send reaction
303
+ */
304
+ sendReactionRaw(requestParameters: SendReactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactionResponse>>;
305
+ /**
306
+ * Sends reaction to specified message Sends events: - reaction.new - reaction.updated Required permissions: - CreateReaction - UseFrozenChannel
307
+ * Send reaction
308
+ */
309
+ sendReaction(requestParameters: SendReactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactionResponse>;
310
+ /**
311
+ * Translates message to a given language using automated translation software Sends events: - message.updated Required permissions: - ReadChannel
312
+ * Translate message
313
+ */
314
+ translateMessageRaw(requestParameters: TranslateMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
315
+ /**
316
+ * Translates message to a given language using automated translation software Sends events: - message.updated Required permissions: - ReadChannel
317
+ * Translate message
318
+ */
319
+ translateMessage(requestParameters: TranslateMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
320
+ /**
321
+ * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
322
+ * Unflag
323
+ */
324
+ unflagRaw(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
325
+ /**
326
+ * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
327
+ * Unflag
328
+ */
329
+ unflag(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
330
+ /**
331
+ * Updates message with new data Sends events: - message.updated Required permissions: - AddLinks - PinMessage - SkipMessageModeration - UpdateMessage
332
+ * Update message
333
+ */
334
+ updateMessageRaw(requestParameters: UpdateMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
335
+ /**
336
+ * Updates message with new data Sends events: - message.updated Required permissions: - AddLinks - PinMessage - SkipMessageModeration - UpdateMessage
337
+ * Update message
338
+ */
339
+ updateMessage(requestParameters: UpdateMessageOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
340
+ /**
341
+ * Updates certain fields of the message Sends events: - message.updated Required permissions: - AddLinks - PinMessage - SkipMessageModeration - UpdateMessage
342
+ * Partially message update
343
+ */
344
+ updateMessagePartialRaw(requestParameters: UpdateMessagePartialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MessageResponse>>;
345
+ /**
346
+ * Updates certain fields of the message Sends events: - message.updated Required permissions: - AddLinks - PinMessage - SkipMessageModeration - UpdateMessage
347
+ * Partially message update
348
+ */
349
+ updateMessagePartial(requestParameters: UpdateMessagePartialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MessageResponse>;
350
+ /**
351
+ * Uploads file Required permissions: - UploadAttachment
352
+ * Upload file
353
+ */
354
+ uploadFileRaw(requestParameters: UploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileUploadResponse>>;
355
+ /**
356
+ * Uploads file Required permissions: - UploadAttachment
357
+ * Upload file
358
+ */
359
+ uploadFile(requestParameters: UploadFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileUploadResponse>;
360
+ /**
361
+ * Uploads image Required permissions: - UploadAttachment
362
+ * Upload image
363
+ */
364
+ uploadImageRaw(requestParameters: UploadImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ImageUploadResponse>>;
365
+ /**
366
+ * Uploads image Required permissions: - UploadAttachment
367
+ * Upload image
368
+ */
369
+ uploadImage(requestParameters: UploadImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ImageUploadResponse>;
370
+ }
@@ -0,0 +1,271 @@
1
+ /**
2
+ * Stream Chat API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: v89.9.2
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { BanRequest, CreateBlockListRequest, DeactivateUserRequest, DeactivateUserResponse, DeactivateUsersRequest, DeactivateUsersResponse, DeleteUserResponse, DeleteUsersRequest, DeleteUsersResponse, FlagRequest, FlagResponse, GetBlockListResponse, ListBlockListResponse, MuteUserRequest, MuteUserResponse, QueryBannedUsersRequest, QueryBannedUsersResponse, QueryMessageFlagsRequest, QueryMessageFlagsResponse, ReactivateUserRequest, ReactivateUserResponse, ReactivateUsersRequest, ReactivateUsersResponse, Response, UnmuteResponse, UnmuteUserRequest, UpdateBlockListRequest } from '../models';
14
+ export interface BanOperationRequest {
15
+ banRequest: BanRequest | null;
16
+ }
17
+ export interface CreateBlockListOperationRequest {
18
+ createBlockListRequest: CreateBlockListRequest | null;
19
+ }
20
+ export interface DeactivateUserOperationRequest {
21
+ userId: string;
22
+ deactivateUserRequest: DeactivateUserRequest | null;
23
+ }
24
+ export interface DeactivateUsersOperationRequest {
25
+ deactivateUsersRequest: DeactivateUsersRequest | null;
26
+ }
27
+ export interface DeleteBlockListRequest {
28
+ name: string;
29
+ }
30
+ export interface DeleteUserRequest {
31
+ userId: string;
32
+ markMessagesDeleted?: boolean;
33
+ hardDelete?: boolean;
34
+ deleteConversationChannels?: boolean;
35
+ }
36
+ export interface DeleteUsersOperationRequest {
37
+ deleteUsersRequest: DeleteUsersRequest | null;
38
+ }
39
+ export interface FlagOperationRequest {
40
+ flagRequest: FlagRequest | null;
41
+ }
42
+ export interface GetBlockListRequest {
43
+ name: string;
44
+ }
45
+ export interface MuteUserOperationRequest {
46
+ muteUserRequest: MuteUserRequest | null;
47
+ }
48
+ export interface QueryBannedUsersOperationRequest {
49
+ payload?: QueryBannedUsersRequest;
50
+ }
51
+ export interface QueryMessageFlagsOperationRequest {
52
+ payload?: QueryMessageFlagsRequest;
53
+ }
54
+ export interface ReactivateUserOperationRequest {
55
+ userId: string;
56
+ reactivateUserRequest: ReactivateUserRequest | null;
57
+ }
58
+ export interface ReactivateUsersOperationRequest {
59
+ reactivateUsersRequest: ReactivateUsersRequest | null;
60
+ }
61
+ export interface UnbanRequest {
62
+ targetUserId?: string;
63
+ type?: string;
64
+ id?: string;
65
+ createdBy?: string;
66
+ }
67
+ export interface UnflagRequest {
68
+ flagRequest: FlagRequest | null;
69
+ }
70
+ export interface UnmuteUserOperationRequest {
71
+ unmuteUserRequest: UnmuteUserRequest | null;
72
+ }
73
+ export interface UpdateBlockListOperationRequest {
74
+ name: string;
75
+ updateBlockListRequest: UpdateBlockListRequest | null;
76
+ }
77
+ /**
78
+ *
79
+ */
80
+ export declare class ModerationApi extends runtime.BaseAPI {
81
+ /**
82
+ * Restricts user activity either in specific channel or globally Sends events: - user.banned Required permissions: - BanChannelMember - BanUser
83
+ * Ban user
84
+ */
85
+ banRaw(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
86
+ /**
87
+ * Restricts user activity either in specific channel or globally Sends events: - user.banned Required permissions: - BanChannelMember - BanUser
88
+ * Ban user
89
+ */
90
+ ban(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
91
+ /**
92
+ * Creates a new application blocklist, once created the blocklist can be used by any channel type
93
+ * Create block list
94
+ */
95
+ createBlockListRaw(requestParameters: CreateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
96
+ /**
97
+ * Creates a new application blocklist, once created the blocklist can be used by any channel type
98
+ * Create block list
99
+ */
100
+ createBlockList(requestParameters: CreateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
101
+ /**
102
+ * Deactivates user with possibility to activate it back Sends events: - user.deactivated
103
+ * Deactivate user
104
+ */
105
+ deactivateUserRaw(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUserResponse>>;
106
+ /**
107
+ * Deactivates user with possibility to activate it back Sends events: - user.deactivated
108
+ * Deactivate user
109
+ */
110
+ deactivateUser(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUserResponse>;
111
+ /**
112
+ * Deactivate users in batches Sends events: - user.deactivated
113
+ * Deactivate users
114
+ */
115
+ deactivateUsersRaw(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUsersResponse>>;
116
+ /**
117
+ * Deactivate users in batches Sends events: - user.deactivated
118
+ * Deactivate users
119
+ */
120
+ deactivateUsers(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUsersResponse>;
121
+ /**
122
+ * Deletes previously created application blocklist
123
+ * Delete block list
124
+ */
125
+ deleteBlockListRaw(requestParameters: DeleteBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
126
+ /**
127
+ * Deletes previously created application blocklist
128
+ * Delete block list
129
+ */
130
+ deleteBlockList(requestParameters: DeleteBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
131
+ /**
132
+ * Deletes user and optionally all their belongings. The Endpoint is deprecated, please use \'Delete Users\' endpoint instead Sends events: - channel.deleted - message.deleted - user.deleted
133
+ * Delete user
134
+ */
135
+ deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUserResponse>>;
136
+ /**
137
+ * Deletes user and optionally all their belongings. The Endpoint is deprecated, please use \'Delete Users\' endpoint instead Sends events: - channel.deleted - message.deleted - user.deleted
138
+ * Delete user
139
+ */
140
+ deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUserResponse>;
141
+ /**
142
+ * Deletes users and optionally all their belongings asynchronously. Sends events: - channel.deleted - user.deleted
143
+ * Delete Users
144
+ */
145
+ deleteUsersRaw(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUsersResponse>>;
146
+ /**
147
+ * Deletes users and optionally all their belongings asynchronously. Sends events: - channel.deleted - user.deleted
148
+ * Delete Users
149
+ */
150
+ deleteUsers(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUsersResponse>;
151
+ /**
152
+ * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
153
+ * Flag
154
+ */
155
+ flagRaw(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
156
+ /**
157
+ * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
158
+ * Flag
159
+ */
160
+ flag(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
161
+ /**
162
+ * Returns block list by given name
163
+ * Get block list
164
+ */
165
+ getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockListResponse>>;
166
+ /**
167
+ * Returns block list by given name
168
+ * Get block list
169
+ */
170
+ getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockListResponse>;
171
+ /**
172
+ * Returns all available block lists
173
+ * List block lists
174
+ */
175
+ listBlockListsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBlockListResponse>>;
176
+ /**
177
+ * Returns all available block lists
178
+ * List block lists
179
+ */
180
+ listBlockLists(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBlockListResponse>;
181
+ /**
182
+ * Mutes one or several users Sends events: - user.muted Required permissions: - MuteUser
183
+ * Mute user
184
+ */
185
+ muteUserRaw(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MuteUserResponse>>;
186
+ /**
187
+ * Mutes one or several users Sends events: - user.muted Required permissions: - MuteUser
188
+ * Mute user
189
+ */
190
+ muteUser(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MuteUserResponse>;
191
+ /**
192
+ * Find and filter channel scoped or global user bans Required permissions: - ReadChannel
193
+ * Query Banned Users
194
+ */
195
+ queryBannedUsersRaw(requestParameters: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBannedUsersResponse>>;
196
+ /**
197
+ * Find and filter channel scoped or global user bans Required permissions: - ReadChannel
198
+ * Query Banned Users
199
+ */
200
+ queryBannedUsers(requestParameters?: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBannedUsersResponse>;
201
+ /**
202
+ * Find and filter message flags Required permissions: - ReadMessageFlags
203
+ * Query Message Flags
204
+ */
205
+ queryMessageFlagsRaw(requestParameters: QueryMessageFlagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryMessageFlagsResponse>>;
206
+ /**
207
+ * Find and filter message flags Required permissions: - ReadMessageFlags
208
+ * Query Message Flags
209
+ */
210
+ queryMessageFlags(requestParameters?: QueryMessageFlagsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryMessageFlagsResponse>;
211
+ /**
212
+ * Activates user who\'s been deactivated previously Sends events: - user.reactivated
213
+ * Reactivate user
214
+ */
215
+ reactivateUserRaw(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUserResponse>>;
216
+ /**
217
+ * Activates user who\'s been deactivated previously Sends events: - user.reactivated
218
+ * Reactivate user
219
+ */
220
+ reactivateUser(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUserResponse>;
221
+ /**
222
+ * Reactivate users in batches Sends events: - user.reactivated
223
+ * Reactivate users
224
+ */
225
+ reactivateUsersRaw(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUsersResponse>>;
226
+ /**
227
+ * Reactivate users in batches Sends events: - user.reactivated
228
+ * Reactivate users
229
+ */
230
+ reactivateUsers(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUsersResponse>;
231
+ /**
232
+ * Removes previously applied ban Sends events: - user.unbanned Required permissions: - BanChannelMember - BanUser
233
+ * Unban user
234
+ */
235
+ unbanRaw(requestParameters: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
236
+ /**
237
+ * Removes previously applied ban Sends events: - user.unbanned Required permissions: - BanChannelMember - BanUser
238
+ * Unban user
239
+ */
240
+ unban(requestParameters?: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
241
+ /**
242
+ * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
243
+ * Unflag
244
+ */
245
+ unflagRaw(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
246
+ /**
247
+ * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
248
+ * Unflag
249
+ */
250
+ unflag(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
251
+ /**
252
+ * Unmutes previously muted user Sends events: - user.unmuted Required permissions: - MuteUser
253
+ * Unmute user
254
+ */
255
+ unmuteUserRaw(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnmuteResponse>>;
256
+ /**
257
+ * Unmutes previously muted user Sends events: - user.unmuted Required permissions: - MuteUser
258
+ * Unmute user
259
+ */
260
+ unmuteUser(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnmuteResponse>;
261
+ /**
262
+ * Updates contents of the block list
263
+ * Update block list
264
+ */
265
+ updateBlockListRaw(requestParameters: UpdateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
266
+ /**
267
+ * Updates contents of the block list
268
+ * Update block list
269
+ */
270
+ updateBlockList(requestParameters: UpdateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
271
+ }