loop-client 0.0.5 → 0.0.7
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.
- package/build/methods.d.ts +333 -333
- package/build/methods.d.ts.map +1 -1
- package/build/methods.js +753 -753
- package/build/methods.js.map +1 -1
- package/build/types/apps.d.ts +2 -2
- package/build/types/apps.d.ts.map +1 -1
- package/build/types/index.d.ts +0 -1
- package/build/types/index.d.ts.map +1 -1
- package/build/types/index.js +0 -1
- package/build/types/index.js.map +1 -1
- package/build/types/methods/posts.methods.d.ts +6 -4
- package/build/types/methods/posts.methods.d.ts.map +1 -1
- package/build/types/posts.d.ts +69 -41
- package/build/types/posts.d.ts.map +1 -1
- package/build/types/posts.js.map +1 -1
- package/build/types/responses/posts.responses.d.ts +2 -2
- package/build/types/responses/posts.responses.d.ts.map +1 -1
- package/build/web-client.js +10 -10
- package/build/web-client.js.map +1 -1
- package/package.json +1 -1
- package/build/types/common.d.ts +0 -5
- package/build/types/common.d.ts.map +0 -1
- package/build/types/common.js +0 -3
- package/build/types/common.js.map +0 -1
package/build/methods.d.ts
CHANGED
|
@@ -74,6 +74,7 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
74
74
|
* ============================================================================
|
|
75
75
|
*/
|
|
76
76
|
readonly bots: {
|
|
77
|
+
readonly assign: MethodWithRequiredArgument<BotsAssignArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
77
78
|
readonly convert: {
|
|
78
79
|
/**
|
|
79
80
|
* @description Convert a user to a bot.
|
|
@@ -91,17 +92,16 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
91
92
|
* Requires `create_bot` permission.
|
|
92
93
|
*/
|
|
93
94
|
readonly create: MethodWithRequiredArgument<BotsCreateArguments, Bot, WebAPICallResult<Bot>>;
|
|
94
|
-
readonly get: MethodWithRequiredArgument<BotsGetArguments, Bot, WebAPICallResult<Bot>>;
|
|
95
|
-
readonly list: MethodWithOptionalArgument<BotsListArguments, Bot[], WebAPICallResult<Bot[]>>;
|
|
96
|
-
readonly patch: MethodWithRequiredArgument<BotsPatchArguments, Bot, WebAPICallResult<Bot>>;
|
|
97
95
|
readonly disable: MethodWithRequiredArgument<BotsDisableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
98
96
|
readonly enable: MethodWithRequiredArgument<BotsEnableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
99
|
-
readonly
|
|
97
|
+
readonly get: MethodWithRequiredArgument<BotsGetArguments, Bot, WebAPICallResult<Bot>>;
|
|
100
98
|
readonly icon: {
|
|
99
|
+
readonly delete: MethodWithRequiredArgument<BotsDeleteIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
101
100
|
readonly get: MethodWithRequiredArgument<BotsGetIconArguments, Blob, WebAPICallResult<Blob>>;
|
|
102
101
|
readonly set: MethodWithRequiredArgument<BotsSetIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
103
|
-
readonly delete: MethodWithRequiredArgument<BotsDeleteIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
104
102
|
};
|
|
103
|
+
readonly list: MethodWithOptionalArgument<BotsListArguments, Bot[], WebAPICallResult<Bot[]>>;
|
|
104
|
+
readonly patch: MethodWithRequiredArgument<BotsPatchArguments, Bot, WebAPICallResult<Bot>>;
|
|
105
105
|
};
|
|
106
106
|
/**
|
|
107
107
|
* ============================================================================
|
|
@@ -110,8 +110,8 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
110
110
|
*/
|
|
111
111
|
readonly brand: {
|
|
112
112
|
readonly image: {
|
|
113
|
-
readonly get: MethodWithRequiredArgument<BrandGetImageArguments, Stream | Buffer<ArrayBufferLike>, WebAPICallResult<Stream | Buffer<ArrayBufferLike>>>;
|
|
114
113
|
readonly delete: MethodWithOptionalArgument<never, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
114
|
+
readonly get: MethodWithRequiredArgument<BrandGetImageArguments, Stream | Buffer<ArrayBufferLike>, WebAPICallResult<Stream | Buffer<ArrayBufferLike>>>;
|
|
115
115
|
readonly upload: MethodWithRequiredArgument<BrandUploadImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
116
116
|
};
|
|
117
117
|
};
|
|
@@ -138,20 +138,47 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
138
138
|
* If creating a private channel, create_private_channel permission is required.
|
|
139
139
|
*/
|
|
140
140
|
readonly create: {
|
|
141
|
-
readonly regular: MethodWithRequiredArgument<ChannelsCreateArguments, Channel, WebAPICallResult<Channel>>;
|
|
142
141
|
readonly direct: MethodWithRequiredArgument<ChannelsCreateDirectArguments, Channel, WebAPICallResult<Channel>>;
|
|
143
142
|
readonly group: MethodWithRequiredArgument<ChannelsCreateGroupArguments, Channel, WebAPICallResult<Channel>>;
|
|
143
|
+
readonly regular: MethodWithRequiredArgument<ChannelsCreateArguments, Channel, WebAPICallResult<Channel>>;
|
|
144
144
|
};
|
|
145
|
+
/**
|
|
146
|
+
* @description Delete a channel.
|
|
147
|
+
*/
|
|
148
|
+
readonly delete: MethodWithRequiredArgument<ChannelsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
149
|
+
readonly get: {
|
|
150
|
+
/**
|
|
151
|
+
* @description Get a channel by ID.
|
|
152
|
+
*/
|
|
153
|
+
readonly byId: MethodWithRequiredArgument<ChannelsGetByIdArguments, Channel, WebAPICallResult<Channel>>;
|
|
154
|
+
/**
|
|
155
|
+
* @description Get a channel by name.
|
|
156
|
+
*/
|
|
157
|
+
readonly byName: MethodWithRequiredArgument<ChannelsGetByNameArguments, Channel, WebAPICallResult<Channel>>;
|
|
158
|
+
};
|
|
159
|
+
/**
|
|
160
|
+
* @description Get pinned posts in a channel.
|
|
161
|
+
*/
|
|
162
|
+
readonly getPinned: MethodWithRequiredArgument<ChannelsGetPinnedArguments, PostListResponse<Record<string, unknown>>, WebAPICallResult<PostListResponse<Record<string, unknown>>>>;
|
|
163
|
+
readonly getStats: MethodWithRequiredArgument<ChannelsGetStatsArguments, ChannelStats, WebAPICallResult<ChannelStats>>;
|
|
164
|
+
/**
|
|
165
|
+
* @description Get timezones of users in a channel.
|
|
166
|
+
*/
|
|
167
|
+
readonly getTimezones: MethodWithRequiredArgument<ChannelsGetTimezonesArguments, string[], WebAPICallResult<string[]>>;
|
|
168
|
+
/**
|
|
169
|
+
* @description Get unread message and mention counts for a user in a channel.
|
|
170
|
+
*/
|
|
171
|
+
readonly getUnread: MethodWithRequiredArgument<ChannelsGetUnreadArguments, ChannelUnreadResponse, WebAPICallResult<ChannelUnreadResponse>>;
|
|
145
172
|
readonly list: {
|
|
146
173
|
/**
|
|
147
174
|
* @description List all channels
|
|
148
175
|
*/
|
|
149
176
|
readonly all: MethodWithOptionalArgument<ChannelsListAllArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
177
|
+
readonly byIds: MethodWithRequiredArgument<ChannelsGetByIdsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
150
178
|
/**
|
|
151
|
-
* @description
|
|
179
|
+
* @description Get deleted channels for a team.
|
|
152
180
|
*/
|
|
153
|
-
readonly
|
|
154
|
-
readonly byIds: MethodWithRequiredArgument<ChannelsGetByIdsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
181
|
+
readonly deleted: MethodWithRequiredArgument<ChannelsListDeletedArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
155
182
|
/**
|
|
156
183
|
* @description Get all channels for a user across all teams.
|
|
157
184
|
*/
|
|
@@ -161,50 +188,30 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
161
188
|
*/
|
|
162
189
|
readonly forUserInTeam: MethodWithRequiredArgument<ChannelsGetForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
163
190
|
/**
|
|
164
|
-
* @description
|
|
165
|
-
*/
|
|
166
|
-
readonly private: MethodWithRequiredArgument<ChannelsListPrivateArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
167
|
-
/**
|
|
168
|
-
* @description Get deleted channels for a team.
|
|
169
|
-
*/
|
|
170
|
-
readonly deleted: MethodWithRequiredArgument<ChannelsListDeletedArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
171
|
-
};
|
|
172
|
-
readonly search: {
|
|
173
|
-
readonly team: MethodWithRequiredArgument<ChannelsSearchArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
174
|
-
readonly all: MethodWithRequiredArgument<ChannelsSearchAllArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
175
|
-
readonly archived: MethodWithRequiredArgument<ChannelsSearchArchivedArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
176
|
-
/**
|
|
177
|
-
* @description Autocomplete channels for search in a team.
|
|
191
|
+
* @description List channels for a team.
|
|
178
192
|
*/
|
|
179
|
-
readonly
|
|
193
|
+
readonly inTeam: MethodWithRequiredArgument<ChannelsListInTeamArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
180
194
|
/**
|
|
181
|
-
* @description
|
|
195
|
+
* @description Get private channels for a team.
|
|
182
196
|
*/
|
|
183
|
-
readonly
|
|
197
|
+
readonly private: MethodWithRequiredArgument<ChannelsListPrivateArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
184
198
|
};
|
|
185
|
-
readonly
|
|
199
|
+
readonly members: {
|
|
186
200
|
/**
|
|
187
|
-
* @description
|
|
201
|
+
* @description Add a user to a channel.
|
|
202
|
+
* Requires `join_public_channels` for public channels.
|
|
188
203
|
*/
|
|
189
|
-
readonly
|
|
204
|
+
readonly add: MethodWithRequiredArgument<ChannelsMemberAddArguments, ChannelMembership, WebAPICallResult<ChannelMembership>>;
|
|
190
205
|
/**
|
|
191
|
-
* @description Get
|
|
206
|
+
* @description Get member counts by group for a channel.
|
|
192
207
|
*/
|
|
193
|
-
readonly
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
* @description Delete a channel.
|
|
201
|
-
*/
|
|
202
|
-
readonly delete: MethodWithRequiredArgument<ChannelsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
203
|
-
readonly patch: MethodWithRequiredArgument<ChannelsPatchArguments, Channel, WebAPICallResult<Channel>>;
|
|
204
|
-
readonly restore: MethodWithRequiredArgument<ChannelsRestoreArguments, Channel, WebAPICallResult<Channel>>;
|
|
205
|
-
readonly getStats: MethodWithRequiredArgument<ChannelsGetStatsArguments, ChannelStats, WebAPICallResult<ChannelStats>>;
|
|
206
|
-
readonly view: MethodWithRequiredArgument<ChannelsViewArguments, ChannelViewResponse, WebAPICallResult<ChannelViewResponse>>;
|
|
207
|
-
readonly members: {
|
|
208
|
+
readonly countByGroup: MethodWithRequiredArgument<ChannelsCountByGroupArguments, {
|
|
209
|
+
group_id: string;
|
|
210
|
+
channel_member_count: number;
|
|
211
|
+
}[], WebAPICallResult<{
|
|
212
|
+
group_id: string;
|
|
213
|
+
channel_member_count: number;
|
|
214
|
+
}[]>>;
|
|
208
215
|
/**
|
|
209
216
|
* @description Get channel members.
|
|
210
217
|
*/
|
|
@@ -213,31 +220,10 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
213
220
|
* @description Get a specific channel member.
|
|
214
221
|
*/
|
|
215
222
|
readonly getById: MethodWithRequiredArgument<ChannelsMemberArguments, ChannelMembership, WebAPICallResult<ChannelMembership>>;
|
|
216
|
-
/**
|
|
217
|
-
* @description Add a user to a channel.
|
|
218
|
-
* Requires `join_public_channels` for public channels.
|
|
219
|
-
*/
|
|
220
|
-
readonly add: MethodWithRequiredArgument<ChannelsMemberAddArguments, ChannelMembership, WebAPICallResult<ChannelMembership>>;
|
|
221
|
-
/**
|
|
222
|
-
* @description Remove a user from a channel.
|
|
223
|
-
*/
|
|
224
|
-
readonly remove: MethodWithRequiredArgument<ChannelsMemberRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
225
223
|
/**
|
|
226
224
|
* @description Get channel members by user IDs.
|
|
227
225
|
*/
|
|
228
226
|
readonly getByIds: MethodWithRequiredArgument<ChannelsMembersGetByIdsArguments, ChannelMembership[], WebAPICallResult<ChannelMembership[]>>;
|
|
229
|
-
/**
|
|
230
|
-
* @description Update the roles of a channel member.
|
|
231
|
-
*/
|
|
232
|
-
readonly updateRoles: MethodWithRequiredArgument<ChannelsMemberUpdateRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
233
|
-
/**
|
|
234
|
-
* @description Update the scheme-derived roles of a channel member.
|
|
235
|
-
*/
|
|
236
|
-
readonly updateSchemeRoles: MethodWithRequiredArgument<ChannelsMemberUpdateSchemeRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
237
|
-
/**
|
|
238
|
-
* @description Update a user's notification properties for a channel.
|
|
239
|
-
*/
|
|
240
|
-
readonly updateNotifyProps: MethodWithRequiredArgument<ChannelsMemberUpdateNotifyPropsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
241
227
|
/**
|
|
242
228
|
* @description Get channel members minus group members.
|
|
243
229
|
* @permission Must have manage_system permission.
|
|
@@ -252,41 +238,22 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
252
238
|
next_page_id: string;
|
|
253
239
|
}>>;
|
|
254
240
|
/**
|
|
255
|
-
* @description
|
|
241
|
+
* @description Remove a user from a channel.
|
|
256
242
|
*/
|
|
257
|
-
readonly
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
243
|
+
readonly remove: MethodWithRequiredArgument<ChannelsMemberRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
244
|
+
/**
|
|
245
|
+
* @description Update a user's notification properties for a channel.
|
|
246
|
+
*/
|
|
247
|
+
readonly updateNotifyProps: MethodWithRequiredArgument<ChannelsMemberUpdateNotifyPropsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
248
|
+
/**
|
|
249
|
+
* @description Update the roles of a channel member.
|
|
250
|
+
*/
|
|
251
|
+
readonly updateRoles: MethodWithRequiredArgument<ChannelsMemberUpdateRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
252
|
+
/**
|
|
253
|
+
* @description Update the scheme-derived roles of a channel member.
|
|
254
|
+
*/
|
|
255
|
+
readonly updateSchemeRoles: MethodWithRequiredArgument<ChannelsMemberUpdateSchemeRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
264
256
|
};
|
|
265
|
-
/**
|
|
266
|
-
* @description Update a channel's privacy setting.
|
|
267
|
-
* Converts a public channel to private or vice-versa.
|
|
268
|
-
*/
|
|
269
|
-
readonly updatePrivacy: MethodWithRequiredArgument<ChannelsUpdatePrivacyArguments, Channel, WebAPICallResult<Channel>>;
|
|
270
|
-
/**
|
|
271
|
-
* @description Move a channel to a different team.
|
|
272
|
-
*/
|
|
273
|
-
readonly move: MethodWithRequiredArgument<ChannelsMoveArguments, Channel, WebAPICallResult<Channel>>;
|
|
274
|
-
/**
|
|
275
|
-
* @description Get pinned posts in a channel.
|
|
276
|
-
*/
|
|
277
|
-
readonly getPinned: MethodWithRequiredArgument<ChannelsGetPinnedArguments, PostListResponse, WebAPICallResult<PostListResponse>>;
|
|
278
|
-
/**
|
|
279
|
-
* @description Get timezones of users in a channel.
|
|
280
|
-
*/
|
|
281
|
-
readonly getTimezones: MethodWithRequiredArgument<ChannelsGetTimezonesArguments, string[], WebAPICallResult<string[]>>;
|
|
282
|
-
/**
|
|
283
|
-
* @description Get unread message and mention counts for a user in a channel.
|
|
284
|
-
*/
|
|
285
|
-
readonly getUnread: MethodWithRequiredArgument<ChannelsGetUnreadArguments, ChannelUnreadResponse, WebAPICallResult<ChannelUnreadResponse>>;
|
|
286
|
-
/**
|
|
287
|
-
* @description Set a channel's scheme.
|
|
288
|
-
*/
|
|
289
|
-
readonly setScheme: MethodWithRequiredArgument<ChannelsSetSchemeArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
290
257
|
readonly moderation: {
|
|
291
258
|
/**
|
|
292
259
|
* @description Get moderation settings for a channel.
|
|
@@ -321,6 +288,39 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
321
288
|
};
|
|
322
289
|
}[]>>;
|
|
323
290
|
};
|
|
291
|
+
/**
|
|
292
|
+
* @description Move a channel to a different team.
|
|
293
|
+
*/
|
|
294
|
+
readonly move: MethodWithRequiredArgument<ChannelsMoveArguments, Channel, WebAPICallResult<Channel>>;
|
|
295
|
+
readonly patch: MethodWithRequiredArgument<ChannelsPatchArguments, Channel, WebAPICallResult<Channel>>;
|
|
296
|
+
readonly restore: MethodWithRequiredArgument<ChannelsRestoreArguments, Channel, WebAPICallResult<Channel>>;
|
|
297
|
+
readonly search: {
|
|
298
|
+
readonly all: MethodWithRequiredArgument<ChannelsSearchAllArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
299
|
+
readonly archived: MethodWithRequiredArgument<ChannelsSearchArchivedArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
300
|
+
/**
|
|
301
|
+
* @description Autocomplete channels for search in a team.
|
|
302
|
+
*/
|
|
303
|
+
readonly autocomplete: MethodWithRequiredArgument<ChannelsSearchAutocompleteArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
304
|
+
/**
|
|
305
|
+
* @description Search for group message channels.
|
|
306
|
+
*/
|
|
307
|
+
readonly groups: MethodWithRequiredArgument<ChannelsSearchGroupsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
308
|
+
readonly team: MethodWithRequiredArgument<ChannelsSearchArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
309
|
+
};
|
|
310
|
+
/**
|
|
311
|
+
* @description Set a channel's scheme.
|
|
312
|
+
*/
|
|
313
|
+
readonly setScheme: MethodWithRequiredArgument<ChannelsSetSchemeArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
314
|
+
/**
|
|
315
|
+
* @description Update a channel.
|
|
316
|
+
*/
|
|
317
|
+
readonly update: MethodWithRequiredArgument<ChannelsUpdateArguments, Channel, WebAPICallResult<Channel>>;
|
|
318
|
+
/**
|
|
319
|
+
* @description Update a channel's privacy setting.
|
|
320
|
+
* Converts a public channel to private or vice-versa.
|
|
321
|
+
*/
|
|
322
|
+
readonly updatePrivacy: MethodWithRequiredArgument<ChannelsUpdatePrivacyArguments, Channel, WebAPICallResult<Channel>>;
|
|
323
|
+
readonly view: MethodWithRequiredArgument<ChannelsViewArguments, ChannelViewResponse, WebAPICallResult<ChannelViewResponse>>;
|
|
324
324
|
};
|
|
325
325
|
/**
|
|
326
326
|
* ============================================================================
|
|
@@ -329,6 +329,7 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
329
329
|
*/
|
|
330
330
|
readonly cloud: {
|
|
331
331
|
readonly customer: {
|
|
332
|
+
readonly confirmPayment: MethodWithRequiredArgument<CloudConfirmCustomerPaymentArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
332
333
|
readonly get: MethodWithOptionalArgument<never, CloudCustomer, WebAPICallResult<CloudCustomer>>;
|
|
333
334
|
/**
|
|
334
335
|
* Updates the customer information for the LOOP Cloud customer bound to this installation.
|
|
@@ -343,20 +344,19 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
343
344
|
*/
|
|
344
345
|
readonly updateAddress: MethodWithRequiredArgument<CloudUpdateAddressArguments, CloudCustomer, WebAPICallResult<CloudCustomer>>;
|
|
345
346
|
readonly validateBusinessEmail: MethodWithRequiredArgument<CloudValidateBusinessEmailArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
346
|
-
readonly confirmPayment: MethodWithRequiredArgument<CloudConfirmCustomerPaymentArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
347
347
|
};
|
|
348
348
|
readonly invoices: {
|
|
349
349
|
readonly get: MethodWithOptionalArgument<never, CloudInvoice[], WebAPICallResult<CloudInvoice[]>>;
|
|
350
350
|
};
|
|
351
|
-
readonly
|
|
352
|
-
readonly get: MethodWithOptionalArgument<never,
|
|
353
|
-
readonly update: MethodWithOptionalArgument<never, CloudSubscription, WebAPICallResult<CloudSubscription>>;
|
|
351
|
+
readonly limits: {
|
|
352
|
+
readonly get: MethodWithOptionalArgument<never, CloudLimits, WebAPICallResult<CloudLimits>>;
|
|
354
353
|
};
|
|
355
354
|
readonly products: {
|
|
356
355
|
readonly get: MethodWithOptionalArgument<never, CloudProduct[], WebAPICallResult<CloudProduct[]>>;
|
|
357
356
|
};
|
|
358
|
-
readonly
|
|
359
|
-
readonly get: MethodWithOptionalArgument<never,
|
|
357
|
+
readonly subscription: {
|
|
358
|
+
readonly get: MethodWithOptionalArgument<never, CloudSubscription, WebAPICallResult<CloudSubscription>>;
|
|
359
|
+
readonly update: MethodWithOptionalArgument<never, CloudSubscription, WebAPICallResult<CloudSubscription>>;
|
|
360
360
|
};
|
|
361
361
|
};
|
|
362
362
|
/**
|
|
@@ -366,31 +366,24 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
366
366
|
*/
|
|
367
367
|
readonly dataRetention: {
|
|
368
368
|
readonly policies: {
|
|
369
|
+
readonly channels: {
|
|
370
|
+
readonly add: MethodWithRequiredArgument<DataRetentionAddPolicyChannelsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
371
|
+
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyChannelsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
372
|
+
readonly remove: MethodWithRequiredArgument<DataRetentionRemovePolicyChannelsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
373
|
+
readonly search: MethodWithRequiredArgument<DataRetentionSearchPolicyChannelsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
374
|
+
};
|
|
369
375
|
readonly create: MethodWithRequiredArgument<DataRetentionCreatePolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
370
|
-
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
371
376
|
readonly delete: MethodWithRequiredArgument<DataRetentionDeletePolicyArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
372
|
-
readonly
|
|
373
|
-
readonly patch: MethodWithRequiredArgument<DataRetentionPatchPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
377
|
+
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
374
378
|
readonly list: MethodWithRequiredArgument<DataRetentionGetPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
379
|
+
readonly patch: MethodWithRequiredArgument<DataRetentionPatchPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
375
380
|
readonly teams: {
|
|
376
|
-
readonly search: MethodWithRequiredArgument<DataRetentionSearchPolicyTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
377
381
|
readonly add: MethodWithRequiredArgument<DataRetentionAddPolicyTeamsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
378
|
-
readonly remove: MethodWithRequiredArgument<DataRetentionRemovePolicyTeamsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
379
382
|
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
383
|
+
readonly remove: MethodWithRequiredArgument<DataRetentionRemovePolicyTeamsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
384
|
+
readonly search: MethodWithRequiredArgument<DataRetentionSearchPolicyTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
380
385
|
};
|
|
381
|
-
readonly
|
|
382
|
-
readonly search: MethodWithRequiredArgument<DataRetentionSearchPolicyChannelsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
383
|
-
readonly add: MethodWithRequiredArgument<DataRetentionAddPolicyChannelsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
384
|
-
readonly remove: MethodWithRequiredArgument<DataRetentionRemovePolicyChannelsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
385
|
-
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyChannelsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
386
|
-
};
|
|
387
|
-
};
|
|
388
|
-
readonly users: {
|
|
389
|
-
readonly getTeams: MethodWithRequiredArgument<DataRetentionGetUserTeamPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
390
|
-
readonly getChannels: MethodWithRequiredArgument<DataRetentionGetUserChannelPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
391
|
-
};
|
|
392
|
-
readonly policy: {
|
|
393
|
-
readonly get: MethodWithOptionalArgument<never, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
386
|
+
readonly update: MethodWithRequiredArgument<DataRetentionUpdatePolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
394
387
|
};
|
|
395
388
|
readonly policiesCount: {
|
|
396
389
|
readonly get: MethodWithOptionalArgument<never, {
|
|
@@ -399,6 +392,13 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
399
392
|
count: number;
|
|
400
393
|
}>>;
|
|
401
394
|
};
|
|
395
|
+
readonly policy: {
|
|
396
|
+
readonly get: MethodWithOptionalArgument<never, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
397
|
+
};
|
|
398
|
+
readonly users: {
|
|
399
|
+
readonly getChannels: MethodWithRequiredArgument<DataRetentionGetUserChannelPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
400
|
+
readonly getTeams: MethodWithRequiredArgument<DataRetentionGetUserTeamPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
401
|
+
};
|
|
402
402
|
};
|
|
403
403
|
/**
|
|
404
404
|
* ============================================================================
|
|
@@ -408,13 +408,13 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
408
408
|
readonly emojis: {
|
|
409
409
|
readonly autocomplete: MethodWithRequiredArgument<EmojisAutocompleteArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
410
410
|
readonly create: MethodWithRequiredArgument<EmojisCreateArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
411
|
-
readonly
|
|
411
|
+
readonly delete: MethodWithRequiredArgument<EmojisDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
412
412
|
readonly get: {
|
|
413
413
|
readonly byId: MethodWithRequiredArgument<EmojisGetArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
414
414
|
readonly byName: MethodWithRequiredArgument<EmojisGetByNameArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
415
415
|
};
|
|
416
|
-
readonly delete: MethodWithRequiredArgument<EmojisDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
417
416
|
readonly getImage: MethodWithRequiredArgument<EmojisGetImageArguments, Blob, WebAPICallResult<Blob>>;
|
|
417
|
+
readonly list: MethodWithRequiredArgument<EmojisGetListArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
418
418
|
readonly search: MethodWithRequiredArgument<EmojisSearchArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
419
419
|
};
|
|
420
420
|
/**
|
|
@@ -423,22 +423,6 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
423
423
|
* ============================================================================
|
|
424
424
|
*/
|
|
425
425
|
readonly files: {
|
|
426
|
-
/**
|
|
427
|
-
* Upload a file
|
|
428
|
-
*
|
|
429
|
-
* @description Uploads a file that can later be attached to a post.
|
|
430
|
-
* This request can either be a multipart/form-data request with a channel_id,
|
|
431
|
-
* files and optional client_ids defined in the FormData, or it can be a request
|
|
432
|
-
* with the channel_id and filename defined as query parameters with the contents of a single file in the body of the request.
|
|
433
|
-
*
|
|
434
|
-
* Only multipart/form-data requests are supported by server versions up to and including 4.7.
|
|
435
|
-
* Server versions 4.8 and higher support both types of requests.
|
|
436
|
-
*
|
|
437
|
-
* Must have upload_file permission.
|
|
438
|
-
*
|
|
439
|
-
* @see https://developers.loop.ru/API/4.0.0/upload-file
|
|
440
|
-
*/
|
|
441
|
-
readonly upload: MethodWithRequiredArgument<FilesUploadArguments, FileUploadResponse, WebAPICallResult<FileUploadResponse>>;
|
|
442
426
|
/**
|
|
443
427
|
* @description Get file and various file-related data
|
|
444
428
|
*/
|
|
@@ -467,6 +451,12 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
467
451
|
* Must have read_channel permission or be uploader of the file.
|
|
468
452
|
*/
|
|
469
453
|
readonly preview: MethodWithRequiredArgument<FilesGetPreviewArguments, Blob, WebAPICallResult<Blob>>;
|
|
454
|
+
/**
|
|
455
|
+
* Get a public file
|
|
456
|
+
*
|
|
457
|
+
* No permissions required.
|
|
458
|
+
*/
|
|
459
|
+
readonly publicFile: MethodWithRequiredArgument<FilesGetPublicArguments, Blob, WebAPICallResult<Blob>>;
|
|
470
460
|
/**
|
|
471
461
|
* Get a public file link
|
|
472
462
|
*
|
|
@@ -479,12 +469,6 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
479
469
|
}, WebAPICallResult<{
|
|
480
470
|
link: string;
|
|
481
471
|
}>>;
|
|
482
|
-
/**
|
|
483
|
-
* Get a public file
|
|
484
|
-
*
|
|
485
|
-
* No permissions required.
|
|
486
|
-
*/
|
|
487
|
-
readonly publicFile: MethodWithRequiredArgument<FilesGetPublicArguments, Blob, WebAPICallResult<Blob>>;
|
|
488
472
|
/**
|
|
489
473
|
* Get a file's thumbnail
|
|
490
474
|
*
|
|
@@ -506,6 +490,22 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
506
490
|
* @see https://developers.loop.ru/API/4.0.0/search-files
|
|
507
491
|
*/
|
|
508
492
|
readonly search: MethodWithRequiredArgument<FilesSearchArguments, FileSearchResponse, WebAPICallResult<FileSearchResponse>>;
|
|
493
|
+
/**
|
|
494
|
+
* Upload a file
|
|
495
|
+
*
|
|
496
|
+
* @description Uploads a file that can later be attached to a post.
|
|
497
|
+
* This request can either be a multipart/form-data request with a channel_id,
|
|
498
|
+
* files and optional client_ids defined in the FormData, or it can be a request
|
|
499
|
+
* with the channel_id and filename defined as query parameters with the contents of a single file in the body of the request.
|
|
500
|
+
*
|
|
501
|
+
* Only multipart/form-data requests are supported by server versions up to and including 4.7.
|
|
502
|
+
* Server versions 4.8 and higher support both types of requests.
|
|
503
|
+
*
|
|
504
|
+
* Must have upload_file permission.
|
|
505
|
+
*
|
|
506
|
+
* @see https://developers.loop.ru/API/4.0.0/upload-file
|
|
507
|
+
*/
|
|
508
|
+
readonly upload: MethodWithRequiredArgument<FilesUploadArguments, FileUploadResponse, WebAPICallResult<FileUploadResponse>>;
|
|
509
509
|
};
|
|
510
510
|
/**
|
|
511
511
|
* ============================================================================
|
|
@@ -513,6 +513,36 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
513
513
|
* ============================================================================
|
|
514
514
|
*/
|
|
515
515
|
readonly integrations: {
|
|
516
|
+
/**
|
|
517
|
+
* ============================================================================
|
|
518
|
+
* @description Integration commands methods
|
|
519
|
+
* ============================================================================
|
|
520
|
+
*/
|
|
521
|
+
readonly commands: {
|
|
522
|
+
/**
|
|
523
|
+
* @description Create a command for a team.
|
|
524
|
+
* `manage_slash_commands` for the team the command is in.
|
|
525
|
+
*/
|
|
526
|
+
readonly create: MethodWithRequiredArgument<CommandsCreateArguments, Command, WebAPICallResult<Command>>;
|
|
527
|
+
/**
|
|
528
|
+
* @description List autocomplete commands in the team.
|
|
529
|
+
* @permisstion `view_team` for the team.
|
|
530
|
+
*/
|
|
531
|
+
readonly delete: MethodWithRequiredArgument<CommandsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
532
|
+
readonly execute: MethodWithRequiredArgument<CommandsExecuteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
533
|
+
readonly list: MethodWithRequiredArgument<CommandsListArguments, Command[], WebAPICallResult<Command[]>>;
|
|
534
|
+
readonly listAutocomplete: MethodWithRequiredArgument<CommandsListAutocompleteArguments, Command[], WebAPICallResult<Command[]>>;
|
|
535
|
+
readonly regenerateToken: MethodWithRequiredArgument<CommandsRegenerateTokenArguments, {
|
|
536
|
+
token: string;
|
|
537
|
+
}, WebAPICallResult<{
|
|
538
|
+
token: string;
|
|
539
|
+
}>>;
|
|
540
|
+
/**
|
|
541
|
+
* @description List commands for a team.
|
|
542
|
+
* @permission `manage_slash_commands` if need to list custom commands.
|
|
543
|
+
*/
|
|
544
|
+
readonly update: MethodWithRequiredArgument<CommandsUpdateArguments, Command, WebAPICallResult<Command>>;
|
|
545
|
+
};
|
|
516
546
|
/**
|
|
517
547
|
* ============================================================================
|
|
518
548
|
* @description Integration interactive dialogs methods
|
|
@@ -537,33 +567,19 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
537
567
|
};
|
|
538
568
|
/**
|
|
539
569
|
* ============================================================================
|
|
540
|
-
* @description
|
|
570
|
+
* @description OAuth apps methods
|
|
541
571
|
* ============================================================================
|
|
542
572
|
*/
|
|
543
|
-
readonly
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
readonly update: MethodWithRequiredArgument<CommandsUpdateArguments, Command, WebAPICallResult<Command>>;
|
|
554
|
-
/**
|
|
555
|
-
* @description List autocomplete commands in the team.
|
|
556
|
-
* @permisstion `view_team` for the team.
|
|
557
|
-
*/
|
|
558
|
-
readonly delete: MethodWithRequiredArgument<CommandsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
559
|
-
readonly list: MethodWithRequiredArgument<CommandsListArguments, Command[], WebAPICallResult<Command[]>>;
|
|
560
|
-
readonly regenerateToken: MethodWithRequiredArgument<CommandsRegenerateTokenArguments, {
|
|
561
|
-
token: string;
|
|
562
|
-
}, WebAPICallResult<{
|
|
563
|
-
token: string;
|
|
564
|
-
}>>;
|
|
565
|
-
readonly execute: MethodWithRequiredArgument<CommandsExecuteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
566
|
-
readonly listAutocomplete: MethodWithRequiredArgument<CommandsListAutocompleteArguments, Command[], WebAPICallResult<Command[]>>;
|
|
573
|
+
readonly oauth: {
|
|
574
|
+
readonly apps: {
|
|
575
|
+
readonly create: MethodWithRequiredArgument<OAuthAppsCreateArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
576
|
+
readonly delete: MethodWithRequiredArgument<OAuthAppsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
577
|
+
readonly get: MethodWithRequiredArgument<OAuthAppsGetArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
578
|
+
readonly getInfo: MethodWithRequiredArgument<OAuthAppsGetInfoArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
579
|
+
readonly list: MethodWithRequiredArgument<OAuthAppsListArguments, OAuthApp[], WebAPICallResult<OAuthApp[]>>;
|
|
580
|
+
readonly regenerateSecret: MethodWithRequiredArgument<OAuthAppsRegenerateSecretArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
581
|
+
readonly update: MethodWithRequiredArgument<OAuthAppsUpdateArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
582
|
+
};
|
|
567
583
|
};
|
|
568
584
|
/**
|
|
569
585
|
* ============================================================================
|
|
@@ -573,38 +589,22 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
573
589
|
readonly webhooks: {
|
|
574
590
|
readonly incoming: {
|
|
575
591
|
readonly create: MethodWithRequiredArgument<IncomingWebhooksCreateArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
576
|
-
readonly update: MethodWithRequiredArgument<IncomingWebhooksUpdateArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
577
592
|
readonly delete: MethodWithRequiredArgument<IncomingWebhooksDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
578
|
-
readonly list: MethodWithRequiredArgument<IncomingWebhooksListArguments, IncomingWebhook[], WebAPICallResult<IncomingWebhook[]>>;
|
|
579
593
|
readonly get: MethodWithRequiredArgument<IncomingWebhooksGetArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
594
|
+
readonly list: MethodWithRequiredArgument<IncomingWebhooksListArguments, IncomingWebhook[], WebAPICallResult<IncomingWebhook[]>>;
|
|
595
|
+
readonly update: MethodWithRequiredArgument<IncomingWebhooksUpdateArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
580
596
|
};
|
|
581
597
|
readonly outgoing: {
|
|
582
598
|
readonly create: MethodWithRequiredArgument<OutgoingWebhooksCreateArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
583
|
-
readonly update: MethodWithRequiredArgument<OutgoingWebhooksUpdateArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
584
599
|
readonly delete: MethodWithRequiredArgument<OutgoingWebhooksDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
585
|
-
readonly list: MethodWithRequiredArgument<OutgoingWebhooksListArguments, OutgoingWebhook[], WebAPICallResult<OutgoingWebhook[]>>;
|
|
586
600
|
readonly get: MethodWithRequiredArgument<OutgoingWebhooksGetArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
601
|
+
readonly list: MethodWithRequiredArgument<OutgoingWebhooksListArguments, OutgoingWebhook[], WebAPICallResult<OutgoingWebhook[]>>;
|
|
587
602
|
readonly regenerateToken: MethodWithRequiredArgument<OutgoingWebhooksRegenerateTokenArguments, {
|
|
588
603
|
token: string;
|
|
589
604
|
}, WebAPICallResult<{
|
|
590
605
|
token: string;
|
|
591
606
|
}>>;
|
|
592
|
-
|
|
593
|
-
};
|
|
594
|
-
/**
|
|
595
|
-
* ============================================================================
|
|
596
|
-
* @description OAuth apps methods
|
|
597
|
-
* ============================================================================
|
|
598
|
-
*/
|
|
599
|
-
readonly oauth: {
|
|
600
|
-
readonly apps: {
|
|
601
|
-
readonly create: MethodWithRequiredArgument<OAuthAppsCreateArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
602
|
-
readonly update: MethodWithRequiredArgument<OAuthAppsUpdateArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
603
|
-
readonly delete: MethodWithRequiredArgument<OAuthAppsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
604
|
-
readonly get: MethodWithRequiredArgument<OAuthAppsGetArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
605
|
-
readonly getInfo: MethodWithRequiredArgument<OAuthAppsGetInfoArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
606
|
-
readonly list: MethodWithRequiredArgument<OAuthAppsListArguments, OAuthApp[], WebAPICallResult<OAuthApp[]>>;
|
|
607
|
-
readonly regenerateSecret: MethodWithRequiredArgument<OAuthAppsRegenerateSecretArguments, OAuthApp, WebAPICallResult<OAuthApp>>;
|
|
607
|
+
readonly update: MethodWithRequiredArgument<OutgoingWebhooksUpdateArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
608
608
|
};
|
|
609
609
|
};
|
|
610
610
|
};
|
|
@@ -614,32 +614,30 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
614
614
|
* ============================================================================
|
|
615
615
|
*/
|
|
616
616
|
readonly groups: {
|
|
617
|
+
readonly channels: {
|
|
618
|
+
/**
|
|
619
|
+
* @description Get a group's channels.
|
|
620
|
+
*/
|
|
621
|
+
readonly get: MethodWithRequiredArgument<GroupsChannelsGetArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
622
|
+
};
|
|
617
623
|
/**
|
|
618
624
|
* @description Create a new group.
|
|
619
625
|
* Requires `manage_system` permission.
|
|
620
626
|
*/
|
|
621
627
|
readonly create: MethodWithRequiredArgument<GroupsCreateArguments, Group, WebAPICallResult<Group>>;
|
|
628
|
+
readonly delete: MethodWithRequiredArgument<GroupsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
629
|
+
readonly deleteLdapLink: MethodWithRequiredArgument<GroupsDeleteLdapLinkArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
622
630
|
/**
|
|
623
631
|
* @description Retrieve a group by its ID.
|
|
624
632
|
* Requires `manage_system` permission.
|
|
625
633
|
*/
|
|
626
634
|
readonly get: MethodWithRequiredArgument<GroupsGetArguments, Group, WebAPICallResult<Group>>;
|
|
635
|
+
readonly getStats: MethodWithRequiredArgument<GroupsGetStatsArguments, GroupStats, WebAPICallResult<GroupStats>>;
|
|
627
636
|
/**
|
|
628
637
|
* @description List all groups.
|
|
629
638
|
* Requires `manage_system` permission.
|
|
630
639
|
*/
|
|
631
640
|
readonly list: MethodWithRequiredArgument<GroupsListArguments, Group[], WebAPICallResult<Group[]>>;
|
|
632
|
-
readonly update: MethodWithRequiredArgument<GroupsUpdateArguments, Group, WebAPICallResult<Group>>;
|
|
633
|
-
readonly delete: MethodWithRequiredArgument<GroupsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
634
|
-
readonly patch: MethodWithRequiredArgument<GroupsPatchArguments, Group, WebAPICallResult<Group>>;
|
|
635
|
-
readonly restore: MethodWithRequiredArgument<GroupsRestoreArguments, Group, WebAPICallResult<Group>>;
|
|
636
|
-
readonly getStats: MethodWithRequiredArgument<GroupsGetStatsArguments, GroupStats, WebAPICallResult<GroupStats>>;
|
|
637
|
-
readonly syncables: {
|
|
638
|
-
readonly list: MethodWithRequiredArgument<GroupsListSyncablesArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
639
|
-
readonly add: MethodWithRequiredArgument<GroupsAddSyncableArguments, GroupSyncable, WebAPICallResult<GroupSyncable>>;
|
|
640
|
-
readonly remove: MethodWithRequiredArgument<GroupsRemoveSyncableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
641
|
-
readonly patch: MethodWithRequiredArgument<GroupsPatchSyncableArguments, GroupSyncable, WebAPICallResult<GroupSyncable>>;
|
|
642
|
-
};
|
|
643
641
|
/**
|
|
644
642
|
* ============================================================================
|
|
645
643
|
* @description Group members methods
|
|
@@ -647,9 +645,13 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
647
645
|
*/
|
|
648
646
|
readonly members: {
|
|
649
647
|
/**
|
|
650
|
-
* @description
|
|
648
|
+
* @description Add members to a custom group.
|
|
651
649
|
*/
|
|
652
|
-
readonly
|
|
650
|
+
readonly add: MethodWithRequiredArgument<GroupsMembersAddArguments, {
|
|
651
|
+
members: GroupMembership[];
|
|
652
|
+
}, WebAPICallResult<{
|
|
653
|
+
members: GroupMembership[];
|
|
654
|
+
}>>;
|
|
653
655
|
/**
|
|
654
656
|
* @description Get members of a group.
|
|
655
657
|
*/
|
|
@@ -661,31 +663,29 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
661
663
|
total_member_count: number;
|
|
662
664
|
}>>;
|
|
663
665
|
/**
|
|
664
|
-
* @description
|
|
666
|
+
* @description Get groups for a user.
|
|
665
667
|
*/
|
|
666
|
-
readonly
|
|
667
|
-
members: GroupMembership[];
|
|
668
|
-
}, WebAPICallResult<{
|
|
669
|
-
members: GroupMembership[];
|
|
670
|
-
}>>;
|
|
668
|
+
readonly listForUser: MethodWithRequiredArgument<GroupsListForUserArguments, Group[], WebAPICallResult<Group[]>>;
|
|
671
669
|
/**
|
|
672
670
|
* @description Remove members from a custom group.
|
|
673
671
|
*/
|
|
674
672
|
readonly remove: MethodWithRequiredArgument<GroupsMembersRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
675
673
|
};
|
|
674
|
+
readonly patch: MethodWithRequiredArgument<GroupsPatchArguments, Group, WebAPICallResult<Group>>;
|
|
675
|
+
readonly restore: MethodWithRequiredArgument<GroupsRestoreArguments, Group, WebAPICallResult<Group>>;
|
|
676
|
+
readonly syncables: {
|
|
677
|
+
readonly add: MethodWithRequiredArgument<GroupsAddSyncableArguments, GroupSyncable, WebAPICallResult<GroupSyncable>>;
|
|
678
|
+
readonly list: MethodWithRequiredArgument<GroupsListSyncablesArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
679
|
+
readonly patch: MethodWithRequiredArgument<GroupsPatchSyncableArguments, GroupSyncable, WebAPICallResult<GroupSyncable>>;
|
|
680
|
+
readonly remove: MethodWithRequiredArgument<GroupsRemoveSyncableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
681
|
+
};
|
|
676
682
|
readonly teams: {
|
|
677
683
|
/**
|
|
678
684
|
* @description Get a group's teams.
|
|
679
685
|
*/
|
|
680
686
|
readonly get: MethodWithRequiredArgument<GroupsTeamsGetArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
681
687
|
};
|
|
682
|
-
readonly
|
|
683
|
-
/**
|
|
684
|
-
* @description Get a group's channels.
|
|
685
|
-
*/
|
|
686
|
-
readonly get: MethodWithRequiredArgument<GroupsChannelsGetArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
687
|
-
};
|
|
688
|
-
readonly deleteLdapLink: MethodWithRequiredArgument<GroupsDeleteLdapLinkArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
688
|
+
readonly update: MethodWithRequiredArgument<GroupsUpdateArguments, Group, WebAPICallResult<Group>>;
|
|
689
689
|
};
|
|
690
690
|
/**
|
|
691
691
|
* ============================================================================
|
|
@@ -693,6 +693,10 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
693
693
|
* ============================================================================
|
|
694
694
|
*/
|
|
695
695
|
readonly jobs: {
|
|
696
|
+
/**
|
|
697
|
+
* @description Cancel a job.
|
|
698
|
+
*/
|
|
699
|
+
readonly cancel: MethodWithRequiredArgument<JobsCancelArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
696
700
|
/**
|
|
697
701
|
* @description Create a new job.
|
|
698
702
|
* Requires `manage_jobs` permission.
|
|
@@ -711,10 +715,6 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
711
715
|
*/
|
|
712
716
|
readonly byType: MethodWithRequiredArgument<JobsListByTypeArguments, Job[], WebAPICallResult<Job[]>>;
|
|
713
717
|
};
|
|
714
|
-
/**
|
|
715
|
-
* @description Cancel a job.
|
|
716
|
-
*/
|
|
717
|
-
readonly cancel: MethodWithRequiredArgument<JobsCancelArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
718
718
|
};
|
|
719
719
|
/**
|
|
720
720
|
* ============================================================================
|
|
@@ -722,22 +722,22 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
722
722
|
* ============================================================================
|
|
723
723
|
*/
|
|
724
724
|
readonly plugins: {
|
|
725
|
+
readonly disable: MethodWithRequiredArgument<PluginsDisableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
726
|
+
readonly enable: MethodWithRequiredArgument<PluginsEnableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
727
|
+
readonly get: MethodWithOptionalArgument<never, PluginsGetResponse, WebAPICallResult<PluginsGetResponse>>;
|
|
728
|
+
readonly getMarketplace: MethodWithRequiredArgument<PluginsGetMarketplaceArguments, PluginManifest[], WebAPICallResult<PluginManifest[]>>;
|
|
729
|
+
readonly getStatuses: MethodWithOptionalArgument<never, PluginStatus[], WebAPICallResult<PluginStatus[]>>;
|
|
730
|
+
readonly getWebapp: MethodWithOptionalArgument<never, PluginManifest[], WebAPICallResult<PluginManifest[]>>;
|
|
731
|
+
readonly install: {
|
|
732
|
+
readonly fromMarketplace: MethodWithRequiredArgument<PluginsInstallFromMarketplaceArguments, PluginManifest, WebAPICallResult<PluginManifest>>;
|
|
733
|
+
readonly fromUrl: MethodWithRequiredArgument<PluginsInstallFromUrlArguments, PluginManifest, WebAPICallResult<PluginManifest>>;
|
|
734
|
+
};
|
|
735
|
+
readonly remove: MethodWithRequiredArgument<PluginsRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
725
736
|
/**
|
|
726
737
|
* @description Upload a plugin.
|
|
727
738
|
* Requires `manage_system` permission.
|
|
728
739
|
*/
|
|
729
740
|
readonly upload: MethodWithRequiredArgument<PluginsUploadArguments, PluginManifest, WebAPICallResult<PluginManifest>>;
|
|
730
|
-
readonly install: {
|
|
731
|
-
readonly fromUrl: MethodWithRequiredArgument<PluginsInstallFromUrlArguments, PluginManifest, WebAPICallResult<PluginManifest>>;
|
|
732
|
-
readonly fromMarketplace: MethodWithRequiredArgument<PluginsInstallFromMarketplaceArguments, PluginManifest, WebAPICallResult<PluginManifest>>;
|
|
733
|
-
};
|
|
734
|
-
readonly remove: MethodWithRequiredArgument<PluginsRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
735
|
-
readonly enable: MethodWithRequiredArgument<PluginsEnableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
736
|
-
readonly disable: MethodWithRequiredArgument<PluginsDisableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
737
|
-
readonly get: MethodWithOptionalArgument<never, PluginsGetResponse, WebAPICallResult<PluginsGetResponse>>;
|
|
738
|
-
readonly getWebapp: MethodWithOptionalArgument<never, PluginManifest[], WebAPICallResult<PluginManifest[]>>;
|
|
739
|
-
readonly getStatuses: MethodWithOptionalArgument<never, PluginStatus[], WebAPICallResult<PluginStatus[]>>;
|
|
740
|
-
readonly getMarketplace: MethodWithRequiredArgument<PluginsGetMarketplaceArguments, PluginManifest[], WebAPICallResult<PluginManifest[]>>;
|
|
741
741
|
};
|
|
742
742
|
/**
|
|
743
743
|
* ============================================================================
|
|
@@ -775,39 +775,30 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
775
775
|
* ============================================================================
|
|
776
776
|
*/
|
|
777
777
|
readonly teams: {
|
|
778
|
+
readonly checkNameExists: MethodWithRequiredArgument<TeamsCheckNameExistsArguments, {
|
|
779
|
+
exists: boolean;
|
|
780
|
+
}, WebAPICallResult<{
|
|
781
|
+
exists: boolean;
|
|
782
|
+
}>>;
|
|
778
783
|
readonly create: MethodWithRequiredArgument<TeamsCreateArguments, Team, WebAPICallResult<Team>>;
|
|
779
|
-
readonly
|
|
784
|
+
readonly delete: MethodWithRequiredArgument<TeamsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
780
785
|
readonly get: {
|
|
781
786
|
readonly byId: MethodWithRequiredArgument<TeamsGetByIdArguments, Team, WebAPICallResult<Team>>;
|
|
782
787
|
readonly byName: MethodWithRequiredArgument<TeamsGetByNameArguments, Team, WebAPICallResult<Team>>;
|
|
783
788
|
};
|
|
784
|
-
readonly update: MethodWithRequiredArgument<TeamsUpdateArguments, Team, WebAPICallResult<Team>>;
|
|
785
|
-
readonly delete: MethodWithRequiredArgument<TeamsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
786
|
-
readonly patch: MethodWithRequiredArgument<TeamsPatchArguments, Team, WebAPICallResult<Team>>;
|
|
787
|
-
readonly regenerateInviteId: MethodWithRequiredArgument<TeamsRegenerateInviteIdArguments, Team, WebAPICallResult<Team>>;
|
|
788
789
|
readonly getStats: MethodWithRequiredArgument<TeamsGetStatsArguments, TeamStats, WebAPICallResult<TeamStats>>;
|
|
789
|
-
readonly
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
}>>;
|
|
790
|
+
readonly icon: {
|
|
791
|
+
readonly get: MethodWithRequiredArgument<TeamsGetIconArguments, Blob, WebAPICallResult<Blob>>;
|
|
792
|
+
readonly remove: MethodWithRequiredArgument<TeamsRemoveIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
793
|
+
readonly set: MethodWithRequiredArgument<TeamsSetIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
794
|
+
};
|
|
795
795
|
readonly import: MethodWithRequiredArgument<TeamsImportArguments, {
|
|
796
796
|
results: string;
|
|
797
797
|
}, WebAPICallResult<{
|
|
798
798
|
results: string;
|
|
799
799
|
}>>;
|
|
800
|
-
readonly
|
|
801
|
-
readonly set: MethodWithRequiredArgument<TeamsSetIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
802
|
-
readonly remove: MethodWithRequiredArgument<TeamsRemoveIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
803
|
-
readonly get: MethodWithRequiredArgument<TeamsGetIconArguments, Blob, WebAPICallResult<Blob>>;
|
|
804
|
-
};
|
|
800
|
+
readonly list: MethodWithOptionalArgument<TeamsGetArguments, Team[], WebAPICallResult<Team[]>>;
|
|
805
801
|
readonly members: {
|
|
806
|
-
/**
|
|
807
|
-
* @description Get a page of team members list.
|
|
808
|
-
* Requires `view_team` permission.
|
|
809
|
-
*/
|
|
810
|
-
readonly list: MethodWithRequiredArgument<TeamsMembersListArguments, TeamMembership[], WebAPICallResult<TeamMembership[]>>;
|
|
811
802
|
/**
|
|
812
803
|
* @description Add a user to a team.
|
|
813
804
|
* Requires `add_user_to_team` permission.
|
|
@@ -822,15 +813,20 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
822
813
|
* @description Get a team member.
|
|
823
814
|
*/
|
|
824
815
|
readonly get: MethodWithRequiredArgument<TeamsMemberGetArguments, TeamMembership, WebAPICallResult<TeamMembership>>;
|
|
816
|
+
/**
|
|
817
|
+
* @description Get a list of team members based on user IDs.
|
|
818
|
+
*/
|
|
819
|
+
readonly getByIds: MethodWithRequiredArgument<TeamsMembersGetByIdsArguments, TeamMembership[], WebAPICallResult<TeamMembership[]>>;
|
|
820
|
+
/**
|
|
821
|
+
* @description Get a page of team members list.
|
|
822
|
+
* Requires `view_team` permission.
|
|
823
|
+
*/
|
|
824
|
+
readonly list: MethodWithRequiredArgument<TeamsMembersListArguments, TeamMembership[], WebAPICallResult<TeamMembership[]>>;
|
|
825
825
|
/**
|
|
826
826
|
* @description Remove a user from a team.
|
|
827
827
|
* Requires `remove_user_from_team` permission.
|
|
828
828
|
*/
|
|
829
829
|
readonly remove: MethodWithRequiredArgument<TeamsMemberRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
830
|
-
/**
|
|
831
|
-
* @description Get a list of team members based on user IDs.
|
|
832
|
-
*/
|
|
833
|
-
readonly getByIds: MethodWithRequiredArgument<TeamsMembersGetByIdsArguments, TeamMembership[], WebAPICallResult<TeamMembership[]>>;
|
|
834
830
|
/**
|
|
835
831
|
* @description Update the roles of a team member.
|
|
836
832
|
*/
|
|
@@ -840,18 +836,22 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
840
836
|
*/
|
|
841
837
|
readonly updateSchemeRoles: MethodWithRequiredArgument<TeamsMemberUpdateSchemeRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
842
838
|
};
|
|
839
|
+
readonly patch: MethodWithRequiredArgument<TeamsPatchArguments, Team, WebAPICallResult<Team>>;
|
|
840
|
+
readonly regenerateInviteId: MethodWithRequiredArgument<TeamsRegenerateInviteIdArguments, Team, WebAPICallResult<Team>>;
|
|
841
|
+
readonly search: MethodWithRequiredArgument<TeamsSearchArguments, Team[], WebAPICallResult<Team[]>>;
|
|
842
|
+
readonly update: MethodWithRequiredArgument<TeamsUpdateArguments, Team, WebAPICallResult<Team>>;
|
|
843
843
|
};
|
|
844
844
|
readonly playbooks: {
|
|
845
|
-
readonly list: MethodWithRequiredArgument<PlaybooksListArguments, PlaybooksListResponse, WebAPICallResult<PlaybooksListResponse>>;
|
|
846
|
-
readonly get: MethodWithRequiredArgument<PlaybooksGetArguments, PlaybooksGetResponse, WebAPICallResult<PlaybooksGetResponse>>;
|
|
847
845
|
readonly create: MethodWithRequiredArgument<PlaybooksCreateArguments, PlaybooksCreateResponse, WebAPICallResult<PlaybooksCreateResponse>>;
|
|
848
|
-
readonly update: MethodWithRequiredArgument<PlaybooksUpdateArguments, PlaybooksUpdateResponse, WebAPICallResult<PlaybooksUpdateResponse>>;
|
|
849
846
|
readonly delete: MethodWithRequiredArgument<PlaybooksDeleteArguments, never, WebAPICallResult<never>>;
|
|
847
|
+
readonly get: MethodWithRequiredArgument<PlaybooksGetArguments, PlaybooksGetResponse, WebAPICallResult<PlaybooksGetResponse>>;
|
|
848
|
+
readonly list: MethodWithRequiredArgument<PlaybooksListArguments, PlaybooksListResponse, WebAPICallResult<PlaybooksListResponse>>;
|
|
850
849
|
readonly runs: {
|
|
851
|
-
readonly get: MethodWithRequiredArgument<PlaybookRunsGetArguments, PlaybookRunsGetResponse, WebAPICallResult<PlaybookRunsGetResponse>>;
|
|
852
850
|
readonly create: MethodWithRequiredArgument<PlaybookRunsCreateArguments, PlaybookRunsCreateResponse, WebAPICallResult<PlaybookRunsCreateResponse>>;
|
|
851
|
+
readonly get: MethodWithRequiredArgument<PlaybookRunsGetArguments, PlaybookRunsGetResponse, WebAPICallResult<PlaybookRunsGetResponse>>;
|
|
853
852
|
readonly list: MethodWithRequiredArgument<PlaybookRunsListArguments, PlaybooksRunsListResponse, WebAPICallResult<PlaybooksRunsListResponse>>;
|
|
854
853
|
};
|
|
854
|
+
readonly update: MethodWithRequiredArgument<PlaybooksUpdateArguments, PlaybooksUpdateResponse, WebAPICallResult<PlaybooksUpdateResponse>>;
|
|
855
855
|
};
|
|
856
856
|
/**
|
|
857
857
|
* ============================================================================
|
|
@@ -859,65 +859,65 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
859
859
|
* ============================================================================
|
|
860
860
|
*/
|
|
861
861
|
readonly posts: {
|
|
862
|
-
readonly create: MethodWithRequiredArgument<PostsCreateArguments, Post<
|
|
862
|
+
readonly create: MethodWithRequiredArgument<PostsCreateArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
863
863
|
/**
|
|
864
864
|
* @description Create an ephemeral post.
|
|
865
865
|
* Creates a new ephemeral post that is visible only to the specified user.
|
|
866
866
|
*/
|
|
867
|
-
readonly createEphemeral: MethodWithRequiredArgument<PostsCreateEphemeralArguments, Post<
|
|
868
|
-
readonly update: MethodWithRequiredArgument<PostsUpdateArguments, Post<undefined>, WebAPICallResult<Post<undefined>>>;
|
|
869
|
-
readonly get: MethodWithRequiredArgument<PostsGetArguments, Post<undefined>, WebAPICallResult<Post<undefined>>>;
|
|
867
|
+
readonly createEphemeral: MethodWithRequiredArgument<PostsCreateEphemeralArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
870
868
|
readonly delete: MethodWithRequiredArgument<PostsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
871
|
-
readonly getThread: MethodWithRequiredArgument<PostsGetThreadArguments, PostListResponse, WebAPICallResult<PostListResponse>>;
|
|
872
|
-
readonly getForChannel: MethodWithRequiredArgument<PostsGetForChannelArguments, PostListResponse, WebAPICallResult<PostListResponse>>;
|
|
873
|
-
readonly pin: MethodWithRequiredArgument<PostsPinArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
874
|
-
readonly unpin: MethodWithRequiredArgument<PostsUnpinArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
875
|
-
readonly move: MethodWithRequiredArgument<PostsMoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
876
869
|
/**
|
|
877
|
-
* @description
|
|
878
|
-
*
|
|
870
|
+
* @description Perform a post action.
|
|
871
|
+
* Perform an action on a post, such as clicking an interactive button.
|
|
879
872
|
*/
|
|
880
|
-
readonly
|
|
873
|
+
readonly doAction: MethodWithRequiredArgument<PostsDoActionArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
874
|
+
readonly get: MethodWithRequiredArgument<PostsGetArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
881
875
|
/**
|
|
882
|
-
* @description
|
|
883
|
-
*
|
|
876
|
+
* @description Get posts around the last unread.
|
|
877
|
+
* Get the posts around the oldest unread post in a channel for a given user.
|
|
884
878
|
*/
|
|
885
|
-
readonly
|
|
879
|
+
readonly getAroundUnread: MethodWithRequiredArgument<PostsGetAroundLastUnreadArguments, PostListResponse<Record<string, unknown>>, WebAPICallResult<PostListResponse<Record<string, unknown>>>>;
|
|
886
880
|
/**
|
|
887
|
-
* @description Get
|
|
888
|
-
*
|
|
881
|
+
* @description Get posts by IDs.
|
|
882
|
+
* Get a list of posts based on a provided list of post IDs.
|
|
889
883
|
*/
|
|
890
|
-
readonly
|
|
884
|
+
readonly getByIds: MethodWithRequiredArgument<PostsGetByIdsArguments, Post<Record<string, unknown>>[], WebAPICallResult<Post<Record<string, unknown>>[]>>;
|
|
891
885
|
/**
|
|
892
886
|
* @description Get file info for a post.
|
|
893
887
|
* Gets a list of file information objects for the files attached to a post.
|
|
894
888
|
*/
|
|
895
889
|
readonly getFilesInfo: MethodWithRequiredArgument<PostsGetFileInfoArguments, FileInfo[], WebAPICallResult<FileInfo[]>>;
|
|
896
890
|
/**
|
|
897
|
-
* @description Get posts
|
|
898
|
-
*
|
|
891
|
+
* @description Get a list of flagged posts for a user.
|
|
892
|
+
* Retrieves posts that the specified user has flagged/saved.
|
|
893
|
+
*/
|
|
894
|
+
readonly getFlagged: MethodWithRequiredArgument<PostsGetFlaggedArguments, PostListResponse<Record<string, unknown>>, WebAPICallResult<PostListResponse<Record<string, unknown>>>>;
|
|
895
|
+
readonly getForChannel: MethodWithRequiredArgument<PostsGetForChannelArguments, PostListResponse<Record<string, unknown>>, WebAPICallResult<PostListResponse<Record<string, unknown>>>>;
|
|
896
|
+
readonly getThread: MethodWithRequiredArgument<PostsGetThreadArguments, PostListResponse<Record<string, unknown>>, WebAPICallResult<PostListResponse<Record<string, unknown>>>>;
|
|
897
|
+
readonly move: MethodWithRequiredArgument<PostsMoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
898
|
+
/**
|
|
899
|
+
* @description Partially update a post.
|
|
900
|
+
* Updates a post by providing only the fields that need to change.
|
|
899
901
|
*/
|
|
900
|
-
readonly
|
|
902
|
+
readonly patch: MethodWithRequiredArgument<PostsPatchArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
903
|
+
readonly pin: MethodWithRequiredArgument<PostsPinArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
901
904
|
/**
|
|
902
905
|
* @description Search posts in a team.
|
|
903
906
|
* Search posts in the specified team using the provided terms.
|
|
904
907
|
*/
|
|
905
908
|
readonly search: MethodWithRequiredArgument<PostsSearchArguments, PostSearchResponse, WebAPICallResult<PostSearchResponse>>;
|
|
906
|
-
/**
|
|
907
|
-
* @description Perform a post action.
|
|
908
|
-
* Perform an action on a post, such as clicking an interactive button.
|
|
909
|
-
*/
|
|
910
|
-
readonly doAction: MethodWithRequiredArgument<PostsDoActionArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
911
|
-
/**
|
|
912
|
-
* @description Get posts by IDs.
|
|
913
|
-
* Get a list of posts based on a provided list of post IDs.
|
|
914
|
-
*/
|
|
915
|
-
readonly getByIds: MethodWithRequiredArgument<PostsGetByIdsArguments, Post<undefined>[], WebAPICallResult<Post<undefined>[]>>;
|
|
916
909
|
/**
|
|
917
910
|
* @description Set a reminder for a post.
|
|
918
911
|
* Set a reminder for the specified user on the specified post.
|
|
919
912
|
*/
|
|
920
913
|
readonly setReminder: MethodWithRequiredArgument<PostsSetReminderArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
914
|
+
/**
|
|
915
|
+
* @description Mark a channel as being unread from a given post.
|
|
916
|
+
* Sets the last viewed at timestamp for the user's channel to the post's create_at timestamp.
|
|
917
|
+
*/
|
|
918
|
+
readonly setUnread: MethodWithRequiredArgument<PostsMarkAsUnreadArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
919
|
+
readonly unpin: MethodWithRequiredArgument<PostsUnpinArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
920
|
+
readonly update: MethodWithRequiredArgument<PostsUpdateArguments<Record<string, unknown>>, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
921
921
|
};
|
|
922
922
|
/**
|
|
923
923
|
* ============================================================================
|
|
@@ -926,9 +926,9 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
926
926
|
*/
|
|
927
927
|
readonly reactions: {
|
|
928
928
|
readonly create: MethodWithRequiredArgument<ReactionsCreateArguments, Reaction, WebAPICallResult<Reaction>>;
|
|
929
|
-
readonly getForPost: MethodWithRequiredArgument<ReactionsGetForPostArguments, Reaction[], WebAPICallResult<Reaction[]>>;
|
|
930
929
|
readonly delete: MethodWithRequiredArgument<ReactionsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
931
930
|
readonly getBulk: MethodWithRequiredArgument<ReactionsGetBulkArguments, Record<string, Reaction[]>, WebAPICallResult<Record<string, Reaction[]>>>;
|
|
931
|
+
readonly getForPost: MethodWithRequiredArgument<ReactionsGetForPostArguments, Reaction[], WebAPICallResult<Reaction[]>>;
|
|
932
932
|
};
|
|
933
933
|
/**
|
|
934
934
|
* ============================================================================
|
|
@@ -936,8 +936,8 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
936
936
|
* ============================================================================
|
|
937
937
|
*/
|
|
938
938
|
readonly system: {
|
|
939
|
-
readonly checkHealth: MethodWithOptionalArgument<SystemCheckHealthArguments, SystemCheckHealthResponse, WebAPICallResult<SystemCheckHealthResponse>>;
|
|
940
939
|
readonly checkDatabaseIntegrity: MethodWithOptionalArgument<never, SystemCheckDatabaseIntegrityResponse, WebAPICallResult<SystemCheckDatabaseIntegrityResponse>>;
|
|
940
|
+
readonly checkHealth: MethodWithOptionalArgument<SystemCheckHealthArguments, SystemCheckHealthResponse, WebAPICallResult<SystemCheckHealthResponse>>;
|
|
941
941
|
readonly getAnalytics: MethodWithRequiredArgument<SystemGetAnalyticsArguments, AnalyticsRow[], WebAPICallResult<AnalyticsRow[]>>;
|
|
942
942
|
readonly getLogs: MethodWithRequiredArgument<SystemGetLogsArguments, string[], WebAPICallResult<string[]>>;
|
|
943
943
|
readonly testEmail: MethodWithRequiredArgument<SystemTestEmailArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
@@ -967,7 +967,6 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
967
967
|
* ============================================================================
|
|
968
968
|
*/
|
|
969
969
|
readonly users: {
|
|
970
|
-
readonly list: MethodWithOptionalArgument<UsersListArguments, UserProfile[], WebAPICallResult<UserProfile[]>>;
|
|
971
970
|
readonly autocomplete: MethodWithRequiredArgument<UsersAutocompleteArguments, {
|
|
972
971
|
users: UserProfile[];
|
|
973
972
|
out_of_channel?: UserProfile[];
|
|
@@ -977,45 +976,45 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
977
976
|
}>>;
|
|
978
977
|
readonly channels: {
|
|
979
978
|
readonly list: {
|
|
980
|
-
readonly inTeam: MethodWithRequiredArgument<ChannelsGetForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
981
979
|
readonly all: MethodWithRequiredArgument<ChannelsGetAllForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
980
|
+
readonly inTeam: MethodWithRequiredArgument<ChannelsGetForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
982
981
|
};
|
|
983
982
|
readonly sidebar: {
|
|
984
983
|
readonly categories: {
|
|
985
|
-
/**
|
|
986
|
-
* @description Get sidebar categories for a user in a team.
|
|
987
|
-
*/
|
|
988
|
-
readonly list: MethodWithRequiredArgument<ChannelsCategoriesListArguments, {
|
|
989
|
-
order: string[];
|
|
990
|
-
categories: SidebarCategory[];
|
|
991
|
-
}, WebAPICallResult<{
|
|
992
|
-
order: string[];
|
|
993
|
-
categories: SidebarCategory[];
|
|
994
|
-
}>>;
|
|
995
984
|
/**
|
|
996
985
|
* @description Create a new sidebar category.
|
|
997
986
|
*/
|
|
998
987
|
readonly create: MethodWithRequiredArgument<ChannelsCategoriesCreateArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
999
988
|
/**
|
|
1000
|
-
* @description
|
|
989
|
+
* @description Delete a sidebar category.
|
|
1001
990
|
*/
|
|
1002
|
-
readonly
|
|
991
|
+
readonly delete: MethodWithRequiredArgument<ChannelsCategoryDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1003
992
|
/**
|
|
1004
993
|
* @description Get a specific sidebar category.
|
|
1005
994
|
*/
|
|
1006
995
|
readonly get: MethodWithRequiredArgument<ChannelsCategoryGetArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
1007
996
|
/**
|
|
1008
|
-
* @description
|
|
997
|
+
* @description Get sidebar category order.
|
|
1009
998
|
*/
|
|
1010
|
-
readonly
|
|
999
|
+
readonly getOrder: MethodWithRequiredArgument<ChannelsCategoriesOrderGetArguments, string[], WebAPICallResult<string[]>>;
|
|
1011
1000
|
/**
|
|
1012
|
-
* @description
|
|
1001
|
+
* @description Get sidebar categories for a user in a team.
|
|
1013
1002
|
*/
|
|
1014
|
-
readonly
|
|
1003
|
+
readonly list: MethodWithRequiredArgument<ChannelsCategoriesListArguments, {
|
|
1004
|
+
order: string[];
|
|
1005
|
+
categories: SidebarCategory[];
|
|
1006
|
+
}, WebAPICallResult<{
|
|
1007
|
+
order: string[];
|
|
1008
|
+
categories: SidebarCategory[];
|
|
1009
|
+
}>>;
|
|
1015
1010
|
/**
|
|
1016
|
-
* @description
|
|
1011
|
+
* @description Update a specific sidebar category.
|
|
1017
1012
|
*/
|
|
1018
|
-
readonly
|
|
1013
|
+
readonly update: MethodWithRequiredArgument<ChannelsCategoryUpdateArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
1014
|
+
/**
|
|
1015
|
+
* @description Update all sidebar categories for a user.
|
|
1016
|
+
*/
|
|
1017
|
+
readonly updateAll: MethodWithRequiredArgument<ChannelsCategoriesUpdateAllArguments, SidebarCategory[], WebAPICallResult<SidebarCategory[]>>;
|
|
1019
1018
|
/**
|
|
1020
1019
|
* @description Update sidebar category order.
|
|
1021
1020
|
*/
|
|
@@ -1030,8 +1029,14 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
1030
1029
|
* ============================================================================
|
|
1031
1030
|
*/
|
|
1032
1031
|
readonly guest: {
|
|
1033
|
-
readonly toUser: MethodWithRequiredArgument<UserID, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1034
1032
|
readonly fromUser: MethodWithRequiredArgument<UserID, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1033
|
+
readonly toUser: MethodWithRequiredArgument<UserID, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1034
|
+
};
|
|
1035
|
+
readonly list: MethodWithOptionalArgument<UsersListArguments, UserProfile[], WebAPICallResult<UserProfile[]>>;
|
|
1036
|
+
readonly preferences: {
|
|
1037
|
+
readonly delete: MethodWithRequiredArgument<PreferencesDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1038
|
+
readonly get: MethodWithRequiredArgument<PreferencesGetArguments, Preference[], WebAPICallResult<Preference[]>>;
|
|
1039
|
+
readonly save: MethodWithRequiredArgument<PreferencesSaveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1035
1040
|
};
|
|
1036
1041
|
/**
|
|
1037
1042
|
* ============================================================================
|
|
@@ -1041,9 +1046,9 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
1041
1046
|
readonly profile: {
|
|
1042
1047
|
readonly get: {
|
|
1043
1048
|
/**
|
|
1044
|
-
* @description
|
|
1049
|
+
* @description Find a user with an email address.
|
|
1045
1050
|
*/
|
|
1046
|
-
readonly
|
|
1051
|
+
readonly byEmail: MethodWithRequiredArgument<UsersGetByEmailArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1047
1052
|
/**
|
|
1048
1053
|
* @description Retrieve a user's profile information, including their custom status.
|
|
1049
1054
|
*/
|
|
@@ -1051,29 +1056,29 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
1051
1056
|
/**
|
|
1052
1057
|
* @description Find a user with an email address.
|
|
1053
1058
|
*/
|
|
1054
|
-
readonly
|
|
1059
|
+
readonly byUsername: MethodWithRequiredArgument<UsersGetByUsernameArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1055
1060
|
/**
|
|
1056
|
-
* @description
|
|
1061
|
+
* @description Retrieve a user's profile information, including their custom status.
|
|
1057
1062
|
*/
|
|
1058
|
-
readonly
|
|
1063
|
+
readonly me: MethodWithOptionalArgument<TokenOverridable, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1059
1064
|
};
|
|
1060
|
-
/**
|
|
1061
|
-
* @description Set a user's profile information, including custom status.
|
|
1062
|
-
* @see {@link https://docs.slack.dev/reference/methods/users.profile.set `users.profile.set` API reference}.
|
|
1063
|
-
*/
|
|
1064
|
-
readonly patch: MethodWithRequiredArgument<UsersProfileSetArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1065
1065
|
/**
|
|
1066
1066
|
* @description Profile image methods
|
|
1067
1067
|
*/
|
|
1068
1068
|
readonly image: {
|
|
1069
|
+
readonly delete: MethodWithOptionalArgument<UsersDeleteImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1069
1070
|
/**
|
|
1070
1071
|
* @description Set the user profile image.
|
|
1071
1072
|
*/
|
|
1072
1073
|
readonly set: MethodWithRequiredArgument<UsersSetImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>; /**
|
|
1073
1074
|
* @description Delete the user profile image.
|
|
1074
1075
|
*/
|
|
1075
|
-
readonly delete: MethodWithOptionalArgument<UsersDeleteImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1076
1076
|
};
|
|
1077
|
+
/**
|
|
1078
|
+
* @description Set a user's profile information, including custom status.
|
|
1079
|
+
* @see {@link https://docs.slack.dev/reference/methods/users.profile.set `users.profile.set` API reference}.
|
|
1080
|
+
*/
|
|
1081
|
+
readonly patch: MethodWithRequiredArgument<UsersProfileSetArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1077
1082
|
};
|
|
1078
1083
|
readonly search: MethodWithRequiredArgument<UsersSearchArguments, UserProfile[], WebAPICallResult<UserProfile[]>>;
|
|
1079
1084
|
readonly status: {
|
|
@@ -1089,11 +1094,6 @@ export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
|
1089
1094
|
readonly setCustom: MethodWithRequiredArgument<UsersCustomStatusSetArguments, UserCustomStatus, WebAPICallResult<UserCustomStatus>>;
|
|
1090
1095
|
readonly unsetCustom: MethodWithRequiredArgument<UsersCustomStatusUnsetArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1091
1096
|
};
|
|
1092
|
-
readonly preferences: {
|
|
1093
|
-
readonly get: MethodWithRequiredArgument<PreferencesGetArguments, Preference[], WebAPICallResult<Preference[]>>;
|
|
1094
|
-
readonly save: MethodWithRequiredArgument<PreferencesSaveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1095
|
-
readonly delete: MethodWithRequiredArgument<PreferencesDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1096
|
-
};
|
|
1097
1097
|
readonly updateRoles: MethodWithRequiredArgument<UsersUpdateRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1098
1098
|
};
|
|
1099
1099
|
}
|