@stream-io/node-sdk 0.2.6 → 0.3.1

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 (67) hide show
  1. package/README.md +1 -1
  2. package/dist/index.cjs.js +2461 -2124
  3. package/dist/index.cjs.js.map +1 -1
  4. package/dist/index.es.js +2450 -2109
  5. package/dist/index.es.js.map +1 -1
  6. package/dist/src/StreamCall.d.ts +1 -1
  7. package/dist/src/StreamChannel.d.ts +7 -9
  8. package/dist/src/StreamChatClient.d.ts +2 -5
  9. package/dist/src/StreamClient.d.ts +15 -26
  10. package/dist/src/gen/chat/apis/ProductchatApi.d.ts +1750 -0
  11. package/dist/src/gen/chat/apis/index.d.ts +1 -27
  12. package/dist/src/gen/chat/models/index.d.ts +5101 -5891
  13. package/dist/src/gen/chat/runtime.d.ts +2 -2
  14. package/dist/src/gen/video/apis/ProductvideoApi.d.ts +1 -1
  15. package/dist/src/gen/video/models/index.d.ts +189 -35
  16. package/dist/src/gen/video/runtime.d.ts +1 -1
  17. package/package.json +8 -1
  18. package/src/StreamCall.ts +7 -7
  19. package/src/StreamChannel.ts +44 -49
  20. package/src/StreamChatClient.ts +23 -35
  21. package/src/StreamClient.ts +71 -232
  22. package/src/gen/chat/.openapi-generator/FILES +1 -19
  23. package/src/gen/chat/apis/ProductchatApi.ts +7007 -0
  24. package/src/gen/chat/apis/index.ts +1 -27
  25. package/src/gen/chat/models/index.ts +5758 -6564
  26. package/src/gen/chat/runtime.ts +3 -3
  27. package/src/gen/video/apis/ProductvideoApi.ts +1 -1
  28. package/src/gen/video/models/index.ts +184 -36
  29. package/src/gen/video/runtime.ts +1 -1
  30. package/dist/src/gen/chat/apis/ChannelTypesApi.d.ts +0 -81
  31. package/dist/src/gen/chat/apis/ChannelsApi.d.ts +0 -280
  32. package/dist/src/gen/chat/apis/CustomCommandsApi.d.ts +0 -81
  33. package/dist/src/gen/chat/apis/DefaultApi.d.ts +0 -60
  34. package/dist/src/gen/chat/apis/DevicesApi.d.ts +0 -58
  35. package/dist/src/gen/chat/apis/EventsApi.d.ts +0 -47
  36. package/dist/src/gen/chat/apis/FilesApi.d.ts +0 -85
  37. package/dist/src/gen/chat/apis/GDPRApi.d.ts +0 -114
  38. package/dist/src/gen/chat/apis/ImportsApi.d.ts +0 -67
  39. package/dist/src/gen/chat/apis/MessagesApi.d.ts +0 -374
  40. package/dist/src/gen/chat/apis/ModerationApi.d.ts +0 -271
  41. package/dist/src/gen/chat/apis/PermissionsV2Api.d.ts +0 -77
  42. package/dist/src/gen/chat/apis/PushApi.d.ts +0 -65
  43. package/dist/src/gen/chat/apis/ReactionsApi.d.ts +0 -62
  44. package/dist/src/gen/chat/apis/ServerSideApi.d.ts +0 -31
  45. package/dist/src/gen/chat/apis/SettingsApi.d.ts +0 -257
  46. package/dist/src/gen/chat/apis/TasksApi.d.ts +0 -31
  47. package/dist/src/gen/chat/apis/TestingApi.d.ts +0 -57
  48. package/dist/src/gen/chat/apis/UsersApi.d.ts +0 -313
  49. package/src/gen/chat/apis/ChannelTypesApi.ts +0 -275
  50. package/src/gen/chat/apis/ChannelsApi.ts +0 -1096
  51. package/src/gen/chat/apis/CustomCommandsApi.ts +0 -276
  52. package/src/gen/chat/apis/DefaultApi.ts +0 -196
  53. package/src/gen/chat/apis/DevicesApi.ts +0 -180
  54. package/src/gen/chat/apis/EventsApi.ts +0 -147
  55. package/src/gen/chat/apis/FilesApi.ts +0 -312
  56. package/src/gen/chat/apis/GDPRApi.ts +0 -418
  57. package/src/gen/chat/apis/ImportsApi.ts +0 -222
  58. package/src/gen/chat/apis/MessagesApi.ts +0 -1475
  59. package/src/gen/chat/apis/ModerationApi.ts +0 -1038
  60. package/src/gen/chat/apis/PermissionsV2Api.ts +0 -259
  61. package/src/gen/chat/apis/PushApi.ts +0 -183
  62. package/src/gen/chat/apis/ReactionsApi.ts +0 -202
  63. package/src/gen/chat/apis/ServerSideApi.ts +0 -79
  64. package/src/gen/chat/apis/SettingsApi.ts +0 -948
  65. package/src/gen/chat/apis/TasksApi.ts +0 -75
  66. package/src/gen/chat/apis/TestingApi.ts +0 -185
  67. package/src/gen/chat/apis/UsersApi.ts +0 -1203
@@ -1,257 +0,0 @@
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: v92.7.0
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 { CheckPushRequest, CheckPushResponse, CheckSNSRequest, CheckSNSResponse, CheckSQSRequest, CheckSQSResponse, CreateBlockListRequest, CreateChannelTypeRequest, CreateChannelTypeResponse, GetApplicationResponse, GetBlockListResponse, GetRateLimitsResponse, ListBlockListResponse, ListChannelTypesResponse, ListPushProvidersResponse, Response, UpdateAppRequest, UpdateBlockListRequest, UpdateChannelTypeRequest, UpdateChannelTypeResponse } from '../models';
14
- export interface CheckPushOperationRequest {
15
- checkPushRequest: CheckPushRequest | null;
16
- }
17
- export interface CheckSNSOperationRequest {
18
- checkSNSRequest: CheckSNSRequest | null;
19
- }
20
- export interface CheckSQSOperationRequest {
21
- checkSQSRequest: CheckSQSRequest | null;
22
- }
23
- export interface CreateBlockListOperationRequest {
24
- createBlockListRequest: CreateBlockListRequest | null;
25
- }
26
- export interface CreateChannelTypeOperationRequest {
27
- createChannelTypeRequest: CreateChannelTypeRequest | null;
28
- }
29
- export interface DeleteBlockListRequest {
30
- name: string;
31
- }
32
- export interface DeleteChannelTypeRequest {
33
- name: string;
34
- }
35
- export interface DeletePushProviderRequest {
36
- type: DeletePushProviderTypeEnum;
37
- name: string;
38
- }
39
- export interface GetBlockListRequest {
40
- name: string;
41
- }
42
- export interface GetChannelTypeRequest {
43
- name: string;
44
- }
45
- export interface GetRateLimitsRequest {
46
- serverSide?: boolean;
47
- android?: boolean;
48
- ios?: boolean;
49
- web?: boolean;
50
- endpoints?: string;
51
- }
52
- export interface UpdateAppOperationRequest {
53
- updateAppRequest: UpdateAppRequest | null;
54
- }
55
- export interface UpdateBlockListOperationRequest {
56
- name: string;
57
- updateBlockListRequest: UpdateBlockListRequest | null;
58
- }
59
- export interface UpdateChannelTypeOperationRequest {
60
- name: string;
61
- updateChannelTypeRequest: UpdateChannelTypeRequest | null;
62
- }
63
- /**
64
- *
65
- */
66
- export declare class SettingsApi extends runtime.BaseAPI {
67
- /**
68
- * Sends a test message via push, this is a test endpoint to verify your push settings
69
- * Check push
70
- */
71
- checkPushRaw(requestParameters: CheckPushOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckPushResponse>>;
72
- /**
73
- * Sends a test message via push, this is a test endpoint to verify your push settings
74
- * Check push
75
- */
76
- checkPush(requestParameters: CheckPushOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckPushResponse>;
77
- /**
78
- * Validates Amazon SNS configuration
79
- * Check SNS
80
- */
81
- checkSNSRaw(requestParameters: CheckSNSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckSNSResponse>>;
82
- /**
83
- * Validates Amazon SNS configuration
84
- * Check SNS
85
- */
86
- checkSNS(requestParameters: CheckSNSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckSNSResponse>;
87
- /**
88
- * Validates Amazon SQS credentials
89
- * Check SQS
90
- */
91
- checkSQSRaw(requestParameters: CheckSQSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckSQSResponse>>;
92
- /**
93
- * Validates Amazon SQS credentials
94
- * Check SQS
95
- */
96
- checkSQS(requestParameters: CheckSQSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckSQSResponse>;
97
- /**
98
- * Creates a new application blocklist, once created the blocklist can be used by any channel type
99
- * Create block list
100
- */
101
- createBlockListRaw(requestParameters: CreateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
102
- /**
103
- * Creates a new application blocklist, once created the blocklist can be used by any channel type
104
- * Create block list
105
- */
106
- createBlockList(requestParameters: CreateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
107
- /**
108
- * Creates new channel type
109
- * Create channel type
110
- */
111
- createChannelTypeRaw(requestParameters: CreateChannelTypeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateChannelTypeResponse>>;
112
- /**
113
- * Creates new channel type
114
- * Create channel type
115
- */
116
- createChannelType(requestParameters: CreateChannelTypeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateChannelTypeResponse>;
117
- /**
118
- * Deletes previously created application blocklist
119
- * Delete block list
120
- */
121
- deleteBlockListRaw(requestParameters: DeleteBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
122
- /**
123
- * Deletes previously created application blocklist
124
- * Delete block list
125
- */
126
- deleteBlockList(requestParameters: DeleteBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
127
- /**
128
- * Deletes channel type
129
- * Delete channel type
130
- */
131
- deleteChannelTypeRaw(requestParameters: DeleteChannelTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
132
- /**
133
- * Deletes channel type
134
- * Delete channel type
135
- */
136
- deleteChannelType(requestParameters: DeleteChannelTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
137
- /**
138
- * Delete a push provider from v2 with multi bundle/package support. v1 isn\'t supported in this endpoint
139
- * Delete a push provider
140
- */
141
- deletePushProviderRaw(requestParameters: DeletePushProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
142
- /**
143
- * Delete a push provider from v2 with multi bundle/package support. v1 isn\'t supported in this endpoint
144
- * Delete a push provider
145
- */
146
- deletePushProvider(requestParameters: DeletePushProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
147
- /**
148
- * This method returns the application settings
149
- * Get App Settings
150
- */
151
- getAppRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetApplicationResponse>>;
152
- /**
153
- * This method returns the application settings
154
- * Get App Settings
155
- */
156
- getApp(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetApplicationResponse>;
157
- /**
158
- * Returns block list by given name
159
- * Get block list
160
- */
161
- getBlockListRaw(requestParameters: GetBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockListResponse>>;
162
- /**
163
- * Returns block list by given name
164
- * Get block list
165
- */
166
- getBlockList(requestParameters: GetBlockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockListResponse>;
167
- /**
168
- * Gets channel type
169
- * Get channel type
170
- */
171
- getChannelTypeRaw(requestParameters: GetChannelTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
172
- /**
173
- * Gets channel type
174
- * Get channel type
175
- */
176
- getChannelType(requestParameters: GetChannelTypeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
177
- /**
178
- * Get rate limits usage and quotas
179
- * Get rate limits
180
- */
181
- getRateLimitsRaw(requestParameters: GetRateLimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetRateLimitsResponse>>;
182
- /**
183
- * Get rate limits usage and quotas
184
- * Get rate limits
185
- */
186
- getRateLimits(requestParameters?: GetRateLimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetRateLimitsResponse>;
187
- /**
188
- * Returns all available block lists
189
- * List block lists
190
- */
191
- listBlockListsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListBlockListResponse>>;
192
- /**
193
- * Returns all available block lists
194
- * List block lists
195
- */
196
- listBlockLists(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListBlockListResponse>;
197
- /**
198
- * Lists all available channel types
199
- * List channel types
200
- */
201
- listChannelTypesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListChannelTypesResponse>>;
202
- /**
203
- * Lists all available channel types
204
- * List channel types
205
- */
206
- listChannelTypes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListChannelTypesResponse>;
207
- /**
208
- * List details of all push providers.
209
- * List push providers
210
- */
211
- listPushProvidersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPushProvidersResponse>>;
212
- /**
213
- * List details of all push providers.
214
- * List push providers
215
- */
216
- listPushProviders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPushProvidersResponse>;
217
- /**
218
- * This method updates one or more application settings
219
- * Update App Settings
220
- */
221
- updateAppRaw(requestParameters: UpdateAppOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
222
- /**
223
- * This method updates one or more application settings
224
- * Update App Settings
225
- */
226
- updateApp(requestParameters: UpdateAppOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
227
- /**
228
- * Updates contents of the block list
229
- * Update block list
230
- */
231
- updateBlockListRaw(requestParameters: UpdateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
232
- /**
233
- * Updates contents of the block list
234
- * Update block list
235
- */
236
- updateBlockList(requestParameters: UpdateBlockListOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
237
- /**
238
- * Updates channel type
239
- * Update channel type
240
- */
241
- updateChannelTypeRaw(requestParameters: UpdateChannelTypeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateChannelTypeResponse>>;
242
- /**
243
- * Updates channel type
244
- * Update channel type
245
- */
246
- updateChannelType(requestParameters: UpdateChannelTypeOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateChannelTypeResponse>;
247
- }
248
- /**
249
- * @export
250
- */
251
- export declare const DeletePushProviderTypeEnum: {
252
- readonly APN: "apn";
253
- readonly FIREBASE: "firebase";
254
- readonly HUAWEI: "huawei";
255
- readonly XIAOMI: "xiaomi";
256
- };
257
- export type DeletePushProviderTypeEnum = typeof DeletePushProviderTypeEnum[keyof typeof DeletePushProviderTypeEnum];
@@ -1,31 +0,0 @@
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: v92.7.0
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 { GetTaskResponse } from '../models';
14
- export interface GetTaskRequest {
15
- id: string;
16
- }
17
- /**
18
- *
19
- */
20
- export declare class TasksApi extends runtime.BaseAPI {
21
- /**
22
- * Gets status of a task
23
- * Get status of a task
24
- */
25
- getTaskRaw(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTaskResponse>>;
26
- /**
27
- * Gets status of a task
28
- * Get status of a task
29
- */
30
- getTask(requestParameters: GetTaskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTaskResponse>;
31
- }
@@ -1,57 +0,0 @@
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: v92.7.0
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 { CheckPushRequest, CheckPushResponse, CheckSNSRequest, CheckSNSResponse, CheckSQSRequest, CheckSQSResponse } from '../models';
14
- export interface CheckPushOperationRequest {
15
- checkPushRequest: CheckPushRequest | null;
16
- }
17
- export interface CheckSNSOperationRequest {
18
- checkSNSRequest: CheckSNSRequest | null;
19
- }
20
- export interface CheckSQSOperationRequest {
21
- checkSQSRequest: CheckSQSRequest | null;
22
- }
23
- /**
24
- *
25
- */
26
- export declare class TestingApi extends runtime.BaseAPI {
27
- /**
28
- * Sends a test message via push, this is a test endpoint to verify your push settings
29
- * Check push
30
- */
31
- checkPushRaw(requestParameters: CheckPushOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckPushResponse>>;
32
- /**
33
- * Sends a test message via push, this is a test endpoint to verify your push settings
34
- * Check push
35
- */
36
- checkPush(requestParameters: CheckPushOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckPushResponse>;
37
- /**
38
- * Validates Amazon SNS configuration
39
- * Check SNS
40
- */
41
- checkSNSRaw(requestParameters: CheckSNSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckSNSResponse>>;
42
- /**
43
- * Validates Amazon SNS configuration
44
- * Check SNS
45
- */
46
- checkSNS(requestParameters: CheckSNSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckSNSResponse>;
47
- /**
48
- * Validates Amazon SQS credentials
49
- * Check SQS
50
- */
51
- checkSQSRaw(requestParameters: CheckSQSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckSQSResponse>>;
52
- /**
53
- * Validates Amazon SQS credentials
54
- * Check SQS
55
- */
56
- checkSQS(requestParameters: CheckSQSOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckSQSResponse>;
57
- }
@@ -1,313 +0,0 @@
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: v92.7.0
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, ConnectRequest, DeactivateUserRequest, DeactivateUserResponse, DeactivateUsersRequest, DeactivateUsersResponse, DeleteUserResponse, DeleteUsersRequest, DeleteUsersResponse, ExportUserResponse, ExportUsersRequest, ExportUsersResponse, FlagRequest, FlagResponse, GuestRequest, GuestResponse, MuteUserRequest, MuteUserResponse, QueryBannedUsersRequest, QueryBannedUsersResponse, QueryUsersRequest, ReactivateUserRequest, ReactivateUserResponse, ReactivateUsersRequest, ReactivateUsersResponse, Response, RestoreUsersRequest, UnmuteResponse, UnmuteUserRequest, UpdateUserPartialRequest, UpdateUsersRequest, UpdateUsersResponse, UsersResponse } from '../models';
14
- export interface BanOperationRequest {
15
- banRequest: BanRequest | null;
16
- }
17
- export interface ConnectOperationRequest {
18
- json?: ConnectRequest;
19
- }
20
- export interface CreateGuestRequest {
21
- guestRequest: GuestRequest | null;
22
- }
23
- export interface DeactivateUserOperationRequest {
24
- userId: string;
25
- deactivateUserRequest: DeactivateUserRequest | null;
26
- }
27
- export interface DeactivateUsersOperationRequest {
28
- deactivateUsersRequest: DeactivateUsersRequest | null;
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 ExportUserRequest {
40
- userId: string;
41
- }
42
- export interface ExportUsersOperationRequest {
43
- exportUsersRequest: ExportUsersRequest | null;
44
- }
45
- export interface FlagOperationRequest {
46
- flagRequest: FlagRequest | null;
47
- }
48
- export interface LongPollRequest {
49
- json?: ConnectRequest;
50
- connectionId?: string;
51
- }
52
- export interface MuteUserOperationRequest {
53
- muteUserRequest: MuteUserRequest | null;
54
- }
55
- export interface QueryBannedUsersOperationRequest {
56
- payload?: QueryBannedUsersRequest;
57
- }
58
- export interface QueryUsersOperationRequest {
59
- payload?: QueryUsersRequest;
60
- }
61
- export interface ReactivateUserOperationRequest {
62
- userId: string;
63
- reactivateUserRequest: ReactivateUserRequest | null;
64
- }
65
- export interface ReactivateUsersOperationRequest {
66
- reactivateUsersRequest: ReactivateUsersRequest | null;
67
- }
68
- export interface RestoreUsersOperationRequest {
69
- restoreUsersRequest: RestoreUsersRequest | null;
70
- }
71
- export interface UnbanRequest {
72
- targetUserId?: string;
73
- type?: string;
74
- id?: string;
75
- createdBy?: string;
76
- }
77
- export interface UnflagRequest {
78
- flagRequest: FlagRequest | null;
79
- }
80
- export interface UnmuteUserOperationRequest {
81
- unmuteUserRequest: UnmuteUserRequest | null;
82
- }
83
- export interface UpdateUsersOperationRequest {
84
- updateUsersRequest: UpdateUsersRequest | null;
85
- }
86
- export interface UpdateUsersPartialRequest {
87
- updateUserPartialRequest: UpdateUserPartialRequest | null;
88
- }
89
- /**
90
- *
91
- */
92
- export declare class UsersApi extends runtime.BaseAPI {
93
- /**
94
- * Restricts user activity either in specific channel or globally Sends events: - user.banned Required permissions: - BanChannelMember - BanUser
95
- * Ban user
96
- */
97
- banRaw(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
98
- /**
99
- * Restricts user activity either in specific channel or globally Sends events: - user.banned Required permissions: - BanChannelMember - BanUser
100
- * Ban user
101
- */
102
- ban(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
103
- /**
104
- * Establishes WebSocket connection for user Sends events: - user.updated
105
- * Connect (WebSocket)
106
- */
107
- connectRaw(requestParameters: ConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
108
- /**
109
- * Establishes WebSocket connection for user Sends events: - user.updated
110
- * Connect (WebSocket)
111
- */
112
- connect(requestParameters?: ConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
113
- /**
114
- * Creates guest user
115
- * Create guest
116
- */
117
- createGuestRaw(requestParameters: CreateGuestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestResponse>>;
118
- /**
119
- * Creates guest user
120
- * Create guest
121
- */
122
- createGuest(requestParameters: CreateGuestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestResponse>;
123
- /**
124
- * Deactivates user with possibility to activate it back Sends events: - user.deactivated
125
- * Deactivate user
126
- */
127
- deactivateUserRaw(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUserResponse>>;
128
- /**
129
- * Deactivates user with possibility to activate it back Sends events: - user.deactivated
130
- * Deactivate user
131
- */
132
- deactivateUser(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUserResponse>;
133
- /**
134
- * Deactivate users in batches Sends events: - user.deactivated
135
- * Deactivate users
136
- */
137
- deactivateUsersRaw(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUsersResponse>>;
138
- /**
139
- * Deactivate users in batches Sends events: - user.deactivated
140
- * Deactivate users
141
- */
142
- deactivateUsers(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUsersResponse>;
143
- /**
144
- * 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
145
- * Delete user
146
- */
147
- deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUserResponse>>;
148
- /**
149
- * 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
150
- * Delete user
151
- */
152
- deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUserResponse>;
153
- /**
154
- * Deletes users and optionally all their belongings asynchronously. Sends events: - channel.deleted - user.deleted
155
- * Delete Users
156
- */
157
- deleteUsersRaw(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUsersResponse>>;
158
- /**
159
- * Deletes users and optionally all their belongings asynchronously. Sends events: - channel.deleted - user.deleted
160
- * Delete Users
161
- */
162
- deleteUsers(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUsersResponse>;
163
- /**
164
- * Exports the user\'s profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
165
- * Export user
166
- */
167
- exportUserRaw(requestParameters: ExportUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExportUserResponse>>;
168
- /**
169
- * Exports the user\'s profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
170
- * Export user
171
- */
172
- exportUser(requestParameters: ExportUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExportUserResponse>;
173
- /**
174
- * Exports user profile, reactions and messages for list of given users
175
- * Export users
176
- */
177
- exportUsersRaw(requestParameters: ExportUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExportUsersResponse>>;
178
- /**
179
- * Exports user profile, reactions and messages for list of given users
180
- * Export users
181
- */
182
- exportUsers(requestParameters: ExportUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExportUsersResponse>;
183
- /**
184
- * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
185
- * Flag
186
- */
187
- flagRaw(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
188
- /**
189
- * Reports message or user for review by moderators Sends events: - message.flagged - user.flagged Required permissions: - FlagMessage - FlagUser
190
- * Flag
191
- */
192
- flag(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
193
- /**
194
- * WebSocket fallback transport endpoint Sends events: - user.updated
195
- * Long Poll (Transport)
196
- */
197
- longPollRaw(requestParameters: LongPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
198
- /**
199
- * WebSocket fallback transport endpoint Sends events: - user.updated
200
- * Long Poll (Transport)
201
- */
202
- longPoll(requestParameters?: LongPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
203
- /**
204
- * Mutes one or several users Sends events: - user.muted Required permissions: - MuteUser
205
- * Mute user
206
- */
207
- muteUserRaw(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MuteUserResponse>>;
208
- /**
209
- * Mutes one or several users Sends events: - user.muted Required permissions: - MuteUser
210
- * Mute user
211
- */
212
- muteUser(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MuteUserResponse>;
213
- /**
214
- * Find and filter channel scoped or global user bans Required permissions: - ReadChannel
215
- * Query Banned Users
216
- */
217
- queryBannedUsersRaw(requestParameters: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBannedUsersResponse>>;
218
- /**
219
- * Find and filter channel scoped or global user bans Required permissions: - ReadChannel
220
- * Query Banned Users
221
- */
222
- queryBannedUsers(requestParameters?: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBannedUsersResponse>;
223
- /**
224
- * Find and filter users Required permissions: - SearchUser
225
- * Query users
226
- */
227
- queryUsersRaw(requestParameters: QueryUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsersResponse>>;
228
- /**
229
- * Find and filter users Required permissions: - SearchUser
230
- * Query users
231
- */
232
- queryUsers(requestParameters?: QueryUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsersResponse>;
233
- /**
234
- * Activates user who\'s been deactivated previously Sends events: - user.reactivated
235
- * Reactivate user
236
- */
237
- reactivateUserRaw(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUserResponse>>;
238
- /**
239
- * Activates user who\'s been deactivated previously Sends events: - user.reactivated
240
- * Reactivate user
241
- */
242
- reactivateUser(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUserResponse>;
243
- /**
244
- * Reactivate users in batches Sends events: - user.reactivated
245
- * Reactivate users
246
- */
247
- reactivateUsersRaw(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUsersResponse>>;
248
- /**
249
- * Reactivate users in batches Sends events: - user.reactivated
250
- * Reactivate users
251
- */
252
- reactivateUsers(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUsersResponse>;
253
- /**
254
- * Restore soft deleted users
255
- * Restore users
256
- */
257
- restoreUsersRaw(requestParameters: RestoreUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
258
- /**
259
- * Restore soft deleted users
260
- * Restore users
261
- */
262
- restoreUsers(requestParameters: RestoreUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
263
- /**
264
- * Removes previously applied ban Sends events: - user.unbanned Required permissions: - BanChannelMember - BanUser
265
- * Unban user
266
- */
267
- unbanRaw(requestParameters: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
268
- /**
269
- * Removes previously applied ban Sends events: - user.unbanned Required permissions: - BanChannelMember - BanUser
270
- * Unban user
271
- */
272
- unban(requestParameters?: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
273
- /**
274
- * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
275
- * Unflag
276
- */
277
- unflagRaw(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
278
- /**
279
- * Removes previously created user or message flag Required permissions: - FlagMessage - FlagUser
280
- * Unflag
281
- */
282
- unflag(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
283
- /**
284
- * Unmutes previously muted user Sends events: - user.unmuted Required permissions: - MuteUser
285
- * Unmute user
286
- */
287
- unmuteUserRaw(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnmuteResponse>>;
288
- /**
289
- * Unmutes previously muted user Sends events: - user.unmuted Required permissions: - MuteUser
290
- * Unmute user
291
- */
292
- unmuteUser(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnmuteResponse>;
293
- /**
294
- * Update or create users in bulk Sends events: - user.updated
295
- * Upsert users
296
- */
297
- updateUsersRaw(requestParameters: UpdateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateUsersResponse>>;
298
- /**
299
- * Update or create users in bulk Sends events: - user.updated
300
- * Upsert users
301
- */
302
- updateUsers(requestParameters: UpdateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateUsersResponse>;
303
- /**
304
- * Updates certain fields of the user Sends events: - user.presence.changed - user.updated
305
- * Partially update user
306
- */
307
- updateUsersPartialRaw(requestParameters: UpdateUsersPartialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateUsersResponse>>;
308
- /**
309
- * Updates certain fields of the user Sends events: - user.presence.changed - user.updated
310
- * Partially update user
311
- */
312
- updateUsersPartial(requestParameters: UpdateUsersPartialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateUsersResponse>;
313
- }