loop-client 0.0.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.
- package/CHANGELOG.md +0 -0
- package/README.md +3 -0
- package/build/const.d.ts +31 -0
- package/build/const.d.ts.map +1 -0
- package/build/const.js +40 -0
- package/build/const.js.map +1 -0
- package/build/errors.d.ts +621 -0
- package/build/errors.d.ts.map +1 -0
- package/build/errors.js +665 -0
- package/build/errors.js.map +1 -0
- package/build/index.d.ts +6 -0
- package/build/index.d.ts.map +1 -0
- package/build/index.js +27 -0
- package/build/index.js.map +1 -0
- package/build/instrument.d.ts +14 -0
- package/build/instrument.d.ts.map +1 -0
- package/build/instrument.js +75 -0
- package/build/instrument.js.map +1 -0
- package/build/logger.d.ts +6 -0
- package/build/logger.d.ts.map +1 -0
- package/build/logger.js +24 -0
- package/build/logger.js.map +1 -0
- package/build/methods.d.ts +1101 -0
- package/build/methods.d.ts.map +1 -0
- package/build/methods.js +2080 -0
- package/build/methods.js.map +1 -0
- package/build/types/admin.d.ts +56 -0
- package/build/types/admin.d.ts.map +1 -0
- package/build/types/admin.js +18 -0
- package/build/types/admin.js.map +1 -0
- package/build/types/apps.d.ts +214 -0
- package/build/types/apps.d.ts.map +1 -0
- package/build/types/apps.js +81 -0
- package/build/types/apps.js.map +1 -0
- package/build/types/audits.d.ts +10 -0
- package/build/types/audits.d.ts.map +1 -0
- package/build/types/audits.js +3 -0
- package/build/types/audits.js.map +1 -0
- package/build/types/autocomplete.d.ts +13 -0
- package/build/types/autocomplete.d.ts.map +1 -0
- package/build/types/autocomplete.js +3 -0
- package/build/types/autocomplete.js.map +1 -0
- package/build/types/boards.d.ts +57 -0
- package/build/types/boards.d.ts.map +1 -0
- package/build/types/boards.js +28 -0
- package/build/types/boards.js.map +1 -0
- package/build/types/bots.d.ts +16 -0
- package/build/types/bots.d.ts.map +1 -0
- package/build/types/bots.js +3 -0
- package/build/types/bots.js.map +1 -0
- package/build/types/channels.d.ts +279 -0
- package/build/types/channels.d.ts.map +1 -0
- package/build/types/channels.js +62 -0
- package/build/types/channels.js.map +1 -0
- package/build/types/cloud.d.ts +155 -0
- package/build/types/cloud.d.ts.map +1 -0
- package/build/types/cloud.js +12 -0
- package/build/types/cloud.js.map +1 -0
- package/build/types/common.d.ts +5 -0
- package/build/types/common.d.ts.map +1 -0
- package/build/types/common.js +3 -0
- package/build/types/common.js.map +1 -0
- package/build/types/compliance.d.ts +14 -0
- package/build/types/compliance.d.ts.map +1 -0
- package/build/types/compliance.js +3 -0
- package/build/types/compliance.js.map +1 -0
- package/build/types/config.d.ts +966 -0
- package/build/types/config.d.ts.map +1 -0
- package/build/types/config.js +17 -0
- package/build/types/config.js.map +1 -0
- package/build/types/data-retention.d.ts +31 -0
- package/build/types/data-retention.d.ts.map +1 -0
- package/build/types/data-retention.js +3 -0
- package/build/types/data-retention.js.map +1 -0
- package/build/types/dialog.d.ts +63 -0
- package/build/types/dialog.d.ts.map +1 -0
- package/build/types/dialog.js +26 -0
- package/build/types/dialog.js.map +1 -0
- package/build/types/drafts.d.ts +15 -0
- package/build/types/drafts.d.ts.map +1 -0
- package/build/types/drafts.js +3 -0
- package/build/types/drafts.js.map +1 -0
- package/build/types/emojis.d.ts +52 -0
- package/build/types/emojis.d.ts.map +1 -0
- package/build/types/emojis.js +19 -0
- package/build/types/emojis.js.map +1 -0
- package/build/types/files.d.ts +53 -0
- package/build/types/files.d.ts.map +1 -0
- package/build/types/files.js +3 -0
- package/build/types/files.js.map +1 -0
- package/build/types/groups.d.ts +143 -0
- package/build/types/groups.d.ts.map +1 -0
- package/build/types/groups.js +14 -0
- package/build/types/groups.js.map +1 -0
- package/build/types/index.d.ts +46 -0
- package/build/types/index.d.ts.map +1 -0
- package/build/types/index.js +62 -0
- package/build/types/index.js.map +1 -0
- package/build/types/integrations.d.ts +108 -0
- package/build/types/integrations.d.ts.map +1 -0
- package/build/types/integrations.js +15 -0
- package/build/types/integrations.js.map +1 -0
- package/build/types/jobs.d.ts +28 -0
- package/build/types/jobs.d.ts.map +1 -0
- package/build/types/jobs.js +22 -0
- package/build/types/jobs.js.map +1 -0
- package/build/types/limits.d.ts +5 -0
- package/build/types/limits.d.ts.map +1 -0
- package/build/types/limits.js +3 -0
- package/build/types/limits.js.map +1 -0
- package/build/types/marketplace.d.ts +43 -0
- package/build/types/marketplace.d.ts.map +1 -0
- package/build/types/marketplace.js +21 -0
- package/build/types/marketplace.js.map +1 -0
- package/build/types/metadata.d.ts +16 -0
- package/build/types/metadata.d.ts.map +1 -0
- package/build/types/metadata.js +3 -0
- package/build/types/metadata.js.map +1 -0
- package/build/types/methods/bots.methods.d.ts +77 -0
- package/build/types/methods/bots.methods.d.ts.map +1 -0
- package/build/types/methods/bots.methods.js +3 -0
- package/build/types/methods/bots.methods.js.map +1 -0
- package/build/types/methods/brand.methods.d.ts +15 -0
- package/build/types/methods/brand.methods.d.ts.map +1 -0
- package/build/types/methods/brand.methods.js +3 -0
- package/build/types/methods/brand.methods.js.map +1 -0
- package/build/types/methods/channels.methods.d.ts +473 -0
- package/build/types/methods/channels.methods.d.ts.map +1 -0
- package/build/types/methods/channels.methods.js +3 -0
- package/build/types/methods/channels.methods.js.map +1 -0
- package/build/types/methods/cloud.methods.d.ts +14 -0
- package/build/types/methods/cloud.methods.d.ts.map +1 -0
- package/build/types/methods/cloud.methods.js +3 -0
- package/build/types/methods/cloud.methods.js.map +1 -0
- package/build/types/methods/common.methods.d.ts +87 -0
- package/build/types/methods/common.methods.d.ts.map +1 -0
- package/build/types/methods/common.methods.js +4 -0
- package/build/types/methods/common.methods.js.map +1 -0
- package/build/types/methods/compliance.methods.d.ts +32 -0
- package/build/types/methods/compliance.methods.d.ts.map +1 -0
- package/build/types/methods/compliance.methods.js +3 -0
- package/build/types/methods/compliance.methods.js.map +1 -0
- package/build/types/methods/data-retention.methods.d.ts +67 -0
- package/build/types/methods/data-retention.methods.d.ts.map +1 -0
- package/build/types/methods/data-retention.methods.js +3 -0
- package/build/types/methods/data-retention.methods.js.map +1 -0
- package/build/types/methods/emojis.methods.d.ts +32 -0
- package/build/types/methods/emojis.methods.d.ts.map +1 -0
- package/build/types/methods/emojis.methods.js +3 -0
- package/build/types/methods/emojis.methods.js.map +1 -0
- package/build/types/methods/files.methods.d.ts +139 -0
- package/build/types/methods/files.methods.d.ts.map +1 -0
- package/build/types/methods/files.methods.js +3 -0
- package/build/types/methods/files.methods.js.map +1 -0
- package/build/types/methods/groups.methods.d.ts +113 -0
- package/build/types/methods/groups.methods.d.ts.map +1 -0
- package/build/types/methods/groups.methods.js +3 -0
- package/build/types/methods/groups.methods.js.map +1 -0
- package/build/types/methods/index.d.ts +28 -0
- package/build/types/methods/index.d.ts.map +1 -0
- package/build/types/methods/index.js +44 -0
- package/build/types/methods/index.js.map +1 -0
- package/build/types/methods/integrations.methods.d.ts +191 -0
- package/build/types/methods/integrations.methods.d.ts.map +1 -0
- package/build/types/methods/integrations.methods.js +3 -0
- package/build/types/methods/integrations.methods.js.map +1 -0
- package/build/types/methods/interactive.methods.d.ts +38 -0
- package/build/types/methods/interactive.methods.d.ts.map +1 -0
- package/build/types/methods/interactive.methods.js +3 -0
- package/build/types/methods/interactive.methods.js.map +1 -0
- package/build/types/methods/jobs.methods.d.ts +20 -0
- package/build/types/methods/jobs.methods.d.ts.map +1 -0
- package/build/types/methods/jobs.methods.js +3 -0
- package/build/types/methods/jobs.methods.js.map +1 -0
- package/build/types/methods/playbook-runs.methods.d.ts +89 -0
- package/build/types/methods/playbook-runs.methods.d.ts.map +1 -0
- package/build/types/methods/playbook-runs.methods.js +3 -0
- package/build/types/methods/playbook-runs.methods.js.map +1 -0
- package/build/types/methods/playbooks.methods.d.ts +156 -0
- package/build/types/methods/playbooks.methods.d.ts.map +1 -0
- package/build/types/methods/playbooks.methods.js +3 -0
- package/build/types/methods/playbooks.methods.js.map +1 -0
- package/build/types/methods/plugins.methods.d.ts +31 -0
- package/build/types/methods/plugins.methods.d.ts.map +1 -0
- package/build/types/methods/plugins.methods.js +3 -0
- package/build/types/methods/plugins.methods.js.map +1 -0
- package/build/types/methods/posts.methods.d.ts +216 -0
- package/build/types/methods/posts.methods.d.ts.map +1 -0
- package/build/types/methods/posts.methods.js +3 -0
- package/build/types/methods/posts.methods.js.map +1 -0
- package/build/types/methods/preferences.methods.d.ts +12 -0
- package/build/types/methods/preferences.methods.d.ts.map +1 -0
- package/build/types/methods/preferences.methods.js +3 -0
- package/build/types/methods/preferences.methods.js.map +1 -0
- package/build/types/methods/reactions.methods.d.ts +15 -0
- package/build/types/methods/reactions.methods.d.ts.map +1 -0
- package/build/types/methods/reactions.methods.js +3 -0
- package/build/types/methods/reactions.methods.js.map +1 -0
- package/build/types/methods/reports.methods.d.ts +4 -0
- package/build/types/methods/reports.methods.d.ts.map +1 -0
- package/build/types/methods/reports.methods.js +3 -0
- package/build/types/methods/reports.methods.js.map +1 -0
- package/build/types/methods/roles.methods.d.ts +14 -0
- package/build/types/methods/roles.methods.d.ts.map +1 -0
- package/build/types/methods/roles.methods.js +3 -0
- package/build/types/methods/roles.methods.js.map +1 -0
- package/build/types/methods/schemes.methods.d.ts +30 -0
- package/build/types/methods/schemes.methods.d.ts.map +1 -0
- package/build/types/methods/schemes.methods.js +3 -0
- package/build/types/methods/schemes.methods.js.map +1 -0
- package/build/types/methods/system.methods.d.ts +107 -0
- package/build/types/methods/system.methods.d.ts.map +1 -0
- package/build/types/methods/system.methods.js +3 -0
- package/build/types/methods/system.methods.js.map +1 -0
- package/build/types/methods/teams.methods.d.ts +161 -0
- package/build/types/methods/teams.methods.d.ts.map +1 -0
- package/build/types/methods/teams.methods.js +3 -0
- package/build/types/methods/teams.methods.js.map +1 -0
- package/build/types/methods/terms-of-service.methods.d.ts +24 -0
- package/build/types/methods/terms-of-service.methods.d.ts.map +1 -0
- package/build/types/methods/terms-of-service.methods.js +3 -0
- package/build/types/methods/terms-of-service.methods.js.map +1 -0
- package/build/types/methods/uploads.methods.d.ts +13 -0
- package/build/types/methods/uploads.methods.d.ts.map +1 -0
- package/build/types/methods/uploads.methods.js +3 -0
- package/build/types/methods/uploads.methods.js.map +1 -0
- package/build/types/methods/users.methods.d.ts +257 -0
- package/build/types/methods/users.methods.d.ts.map +1 -0
- package/build/types/methods/users.methods.js +3 -0
- package/build/types/methods/users.methods.js.map +1 -0
- package/build/types/mfa.d.ts +5 -0
- package/build/types/mfa.d.ts.map +1 -0
- package/build/types/mfa.js +3 -0
- package/build/types/mfa.js.map +1 -0
- package/build/types/playbooks.d.ts +221 -0
- package/build/types/playbooks.d.ts.map +1 -0
- package/build/types/playbooks.js +3 -0
- package/build/types/playbooks.js.map +1 -0
- package/build/types/plugins.d.ts +101 -0
- package/build/types/plugins.d.ts.map +1 -0
- package/build/types/plugins.js +3 -0
- package/build/types/plugins.js.map +1 -0
- package/build/types/posts.d.ts +290 -0
- package/build/types/posts.d.ts.map +1 -0
- package/build/types/posts.js +88 -0
- package/build/types/posts.js.map +1 -0
- package/build/types/preferences.d.ts +7 -0
- package/build/types/preferences.d.ts.map +1 -0
- package/build/types/preferences.js +3 -0
- package/build/types/preferences.js.map +1 -0
- package/build/types/product-notices.d.ts +27 -0
- package/build/types/product-notices.d.ts.map +1 -0
- package/build/types/product-notices.js +8 -0
- package/build/types/product-notices.js.map +1 -0
- package/build/types/products.d.ts +8 -0
- package/build/types/products.d.ts.map +1 -0
- package/build/types/products.js +3 -0
- package/build/types/products.js.map +1 -0
- package/build/types/reactions.d.ts +7 -0
- package/build/types/reactions.d.ts.map +1 -0
- package/build/types/reactions.js +3 -0
- package/build/types/reactions.js.map +1 -0
- package/build/types/reports.d.ts +66 -0
- package/build/types/reports.d.ts.map +1 -0
- package/build/types/reports.js +30 -0
- package/build/types/reports.js.map +1 -0
- package/build/types/requests.d.ts +61 -0
- package/build/types/requests.d.ts.map +1 -0
- package/build/types/requests.js +12 -0
- package/build/types/requests.js.map +1 -0
- package/build/types/responses/common.responses.d.ts +23 -0
- package/build/types/responses/common.responses.d.ts.map +1 -0
- package/build/types/responses/common.responses.js +3 -0
- package/build/types/responses/common.responses.js.map +1 -0
- package/build/types/responses/index.d.ts +5 -0
- package/build/types/responses/index.d.ts.map +1 -0
- package/build/types/responses/index.js +21 -0
- package/build/types/responses/index.js.map +1 -0
- package/build/types/responses/playbooks.responses.d.ts +19 -0
- package/build/types/responses/playbooks.responses.d.ts.map +1 -0
- package/build/types/responses/playbooks.responses.js +3 -0
- package/build/types/responses/playbooks.responses.js.map +1 -0
- package/build/types/responses/posts.responses.d.ts +32 -0
- package/build/types/responses/posts.responses.d.ts.map +1 -0
- package/build/types/responses/posts.responses.js +8 -0
- package/build/types/responses/posts.responses.js.map +1 -0
- package/build/types/responses/system.responses.d.ts +87 -0
- package/build/types/responses/system.responses.d.ts.map +1 -0
- package/build/types/responses/system.responses.js +3 -0
- package/build/types/responses/system.responses.js.map +1 -0
- package/build/types/roles.d.ts +41 -0
- package/build/types/roles.d.ts.map +1 -0
- package/build/types/roles.js +33 -0
- package/build/types/roles.js.map +1 -0
- package/build/types/saml.d.ts +11 -0
- package/build/types/saml.d.ts.map +1 -0
- package/build/types/saml.js +3 -0
- package/build/types/saml.js.map +1 -0
- package/build/types/schemes.d.ts +28 -0
- package/build/types/schemes.d.ts.map +1 -0
- package/build/types/schemes.js +9 -0
- package/build/types/schemes.js.map +1 -0
- package/build/types/search.d.ts +13 -0
- package/build/types/search.d.ts.map +1 -0
- package/build/types/search.js +3 -0
- package/build/types/search.js.map +1 -0
- package/build/types/setup.d.ts +5 -0
- package/build/types/setup.d.ts.map +1 -0
- package/build/types/setup.js +3 -0
- package/build/types/setup.js.map +1 -0
- package/build/types/state.d.ts +464 -0
- package/build/types/state.d.ts.map +1 -0
- package/build/types/state.js +3 -0
- package/build/types/state.js.map +1 -0
- package/build/types/store.d.ts +65 -0
- package/build/types/store.d.ts.map +1 -0
- package/build/types/store.js +3 -0
- package/build/types/store.js.map +1 -0
- package/build/types/teams.d.ts +94 -0
- package/build/types/teams.d.ts.map +1 -0
- package/build/types/teams.js +9 -0
- package/build/types/teams.js.map +1 -0
- package/build/types/terms-of-service.d.ts +7 -0
- package/build/types/terms-of-service.d.ts.map +1 -0
- package/build/types/terms-of-service.js +3 -0
- package/build/types/terms-of-service.js.map +1 -0
- package/build/types/threads.d.ts +40 -0
- package/build/types/threads.d.ts.map +1 -0
- package/build/types/threads.js +8 -0
- package/build/types/threads.js.map +1 -0
- package/build/types/typing.d.ts +6 -0
- package/build/types/typing.d.ts.map +1 -0
- package/build/types/typing.js +3 -0
- package/build/types/typing.js.map +1 -0
- package/build/types/users.d.ts +281 -0
- package/build/types/users.d.ts.map +1 -0
- package/build/types/users.js +42 -0
- package/build/types/users.js.map +1 -0
- package/build/types/web-client.d.ts +82 -0
- package/build/types/web-client.d.ts.map +1 -0
- package/build/types/web-client.js +17 -0
- package/build/types/web-client.js.map +1 -0
- package/build/utils.d.ts +24 -0
- package/build/utils.d.ts.map +1 -0
- package/build/utils.js +136 -0
- package/build/utils.js.map +1 -0
- package/build/web-client.d.ts +117 -0
- package/build/web-client.d.ts.map +1 -0
- package/build/web-client.js +421 -0
- package/build/web-client.js.map +1 -0
- package/package.json +74 -0
|
@@ -0,0 +1,1101 @@
|
|
|
1
|
+
import EventEmitter from "eventemitter3";
|
|
2
|
+
import type { Stream } from "form-data";
|
|
3
|
+
import type { ComplianceReport, TokenOverridable, UserCustomStatus, UserID, UserProfile, UserStatus, WebAPICallResult } from "./types";
|
|
4
|
+
import type { AnalyticsRow } from "./types/admin";
|
|
5
|
+
import type { Bot } from "./types/bots";
|
|
6
|
+
import type { Channel, ChannelMembership, ChannelStats, ChannelUnreadResponse, ChannelViewResponse } from "./types/channels";
|
|
7
|
+
import type { CloudCustomer, CloudInvoice, CloudLimits, CloudProduct, CloudSubscription } from "./types/cloud";
|
|
8
|
+
import type { ClientConfig } from "./types/config";
|
|
9
|
+
import type { DataRetentionCustomPolicies } from "./types/data-retention";
|
|
10
|
+
import type { CustomEmoji } from "./types/emojis";
|
|
11
|
+
import type { FileInfo, FileSearchResponse, FileUploadResponse, UploadSession } from "./types/files";
|
|
12
|
+
import type { Group, GroupMembership, GroupStats, GroupSyncable } from "./types/groups";
|
|
13
|
+
import type { Command, IncomingWebhook, OAuthApp, OutgoingWebhook } from "./types/integrations";
|
|
14
|
+
import type { Job } from "./types/jobs";
|
|
15
|
+
import type { BotsAssignArguments, BotsConvertBotToUserArguments, BotsConvertUserArguments, BotsCreateArguments, BotsDeleteIconArguments, BotsDisableArguments, BotsEnableArguments, BotsGetArguments, BotsGetIconArguments, BotsListArguments, BotsPatchArguments, BotsSetIconArguments } from "./types/methods/bots.methods";
|
|
16
|
+
import type { BrandGetImageArguments, BrandUploadImageArguments } from "./types/methods/brand.methods";
|
|
17
|
+
import type { ChannelsAutocompleteArguments, ChannelsCategoriesCreateArguments, ChannelsCategoriesListArguments, ChannelsCategoriesOrderGetArguments, ChannelsCategoriesOrderUpdateArguments, ChannelsCategoriesUpdateAllArguments, ChannelsCategoryDeleteArguments, ChannelsCategoryGetArguments, ChannelsCategoryUpdateArguments, ChannelsCountByGroupArguments, ChannelsCreateArguments, ChannelsCreateDirectArguments, ChannelsCreateGroupArguments, ChannelsDeleteArguments, ChannelsGetAllForUserArguments, ChannelsGetByIdArguments, ChannelsGetByIdsArguments, ChannelsGetByNameArguments, ChannelsGetForUserArguments, ChannelsGetMembersMinusGroupArguments, ChannelsGetPinnedArguments, ChannelsGetStatsArguments, ChannelsGetTimezonesArguments, ChannelsGetUnreadArguments, ChannelsListAllArguments, ChannelsListDeletedArguments, ChannelsListInTeamArguments, ChannelsListPrivateArguments, ChannelsMemberAddArguments, ChannelsMemberArguments, ChannelsMemberRemoveArguments, ChannelsMembersArguments, ChannelsMembersGetByIdsArguments, ChannelsMemberUpdateNotifyPropsArguments, ChannelsMemberUpdateRolesArguments, ChannelsMemberUpdateSchemeRolesArguments, ChannelsModerationGetArguments, ChannelsModerationUpdateArguments, ChannelsMoveArguments, ChannelsPatchArguments, ChannelsRestoreArguments, ChannelsSearchAllArguments, ChannelsSearchArchivedArguments, ChannelsSearchArguments, ChannelsSearchAutocompleteArguments, ChannelsSearchGroupsArguments, ChannelsSetSchemeArguments, ChannelsUpdateArguments, ChannelsUpdatePrivacyArguments, ChannelsViewArguments, SidebarCategory } from "./types/methods/channels.methods";
|
|
18
|
+
import type { CloudConfirmCustomerPaymentArguments, CloudUpdateAddressArguments, CloudUpdateCustomerArguments, CloudValidateBusinessEmailArguments } from "./types/methods/cloud.methods";
|
|
19
|
+
import type { ComplianceCreateReportArguments, ComplianceDownloadReportArguments, ComplianceGetReportsArguments } from "./types/methods/compliance.methods";
|
|
20
|
+
import type { DataRetentionAddPolicyChannelsArguments, DataRetentionAddPolicyTeamsArguments, DataRetentionCreatePolicyArguments, DataRetentionDeletePolicyArguments, DataRetentionGetPoliciesArguments, DataRetentionGetPolicyArguments, DataRetentionGetPolicyChannelsArguments, DataRetentionGetPolicyTeamsArguments, DataRetentionGetUserChannelPoliciesArguments, DataRetentionGetUserTeamPoliciesArguments, DataRetentionPatchPolicyArguments, DataRetentionRemovePolicyChannelsArguments, DataRetentionRemovePolicyTeamsArguments, DataRetentionSearchPolicyChannelsArguments, DataRetentionSearchPolicyTeamsArguments, DataRetentionUpdatePolicyArguments } from "./types/methods/data-retention.methods";
|
|
21
|
+
import type { EmojisAutocompleteArguments, EmojisCreateArguments, EmojisDeleteArguments, EmojisGetArguments, EmojisGetByNameArguments, EmojisGetImageArguments, EmojisGetListArguments, EmojisSearchArguments } from "./types/methods/emojis.methods";
|
|
22
|
+
import type { FilesGetArguments, FilesGetMetadataArguments, FilesGetPreviewArguments, FilesGetPublicArguments, FilesGetPublicLinkArguments, FilesGetThumbnailArguments, FilesSearchArguments, FilesUploadArguments } from "./types/methods/files.methods";
|
|
23
|
+
import type { GroupsAddSyncableArguments, GroupsChannelsGetArguments, GroupsCreateArguments, GroupsDeleteArguments, GroupsDeleteLdapLinkArguments, GroupsGetArguments, GroupsGetStatsArguments, GroupsListArguments, GroupsListForUserArguments, GroupsListSyncablesArguments, GroupsMembersAddArguments, GroupsMembersGetArguments, GroupsMembersRemoveArguments, GroupsPatchArguments, GroupsPatchSyncableArguments, GroupsRemoveSyncableArguments, GroupsRestoreArguments, GroupsTeamsGetArguments, GroupsUpdateArguments } from "./types/methods/groups.methods";
|
|
24
|
+
import type { CommandsCreateArguments, CommandsDeleteArguments, CommandsExecuteArguments, CommandsListArguments, CommandsListAutocompleteArguments, CommandsRegenerateTokenArguments, CommandsUpdateArguments, IncomingWebhooksCreateArguments, IncomingWebhooksDeleteArguments, IncomingWebhooksGetArguments, IncomingWebhooksListArguments, IncomingWebhooksUpdateArguments, OAuthAppsCreateArguments, OAuthAppsDeleteArguments, OAuthAppsGetArguments, OAuthAppsGetInfoArguments, OAuthAppsListArguments, OAuthAppsRegenerateSecretArguments, OAuthAppsUpdateArguments, OutgoingWebhooksCreateArguments, OutgoingWebhooksDeleteArguments, OutgoingWebhooksGetArguments, OutgoingWebhooksListArguments, OutgoingWebhooksRegenerateTokenArguments, OutgoingWebhooksUpdateArguments } from "./types/methods/integrations.methods";
|
|
25
|
+
import type { InteractiveOpenDialogArguments, InteractiveSubmitDialogArguments } from "./types/methods/interactive.methods";
|
|
26
|
+
import type { JobsCancelArguments, JobsCreateArguments, JobsGetArguments, JobsListArguments, JobsListByTypeArguments } from "./types/methods/jobs.methods";
|
|
27
|
+
import type { PlaybookRunsCreateArguments, PlaybookRunsGetArguments, PlaybookRunsListArguments } from "./types/methods/playbook-runs.methods";
|
|
28
|
+
import type { PlaybooksCreateArguments, PlaybooksDeleteArguments, PlaybooksGetArguments, PlaybooksListArguments, PlaybooksUpdateArguments } from "./types/methods/playbooks.methods";
|
|
29
|
+
import type { PluginsDisableArguments, PluginsEnableArguments, PluginsGetMarketplaceArguments, PluginsInstallFromMarketplaceArguments, PluginsInstallFromUrlArguments, PluginsRemoveArguments, PluginsUploadArguments } from "./types/methods/plugins.methods";
|
|
30
|
+
import type { PostsCreateArguments, PostsCreateEphemeralArguments, PostsDeleteArguments, PostsDoActionArguments, PostsGetArguments, PostsGetAroundLastUnreadArguments, PostsGetByIdsArguments, PostsGetFileInfoArguments, PostsGetFlaggedArguments, PostsGetForChannelArguments, PostsGetThreadArguments, PostsMarkAsUnreadArguments, PostsMoveArguments, PostsPatchArguments, PostsPinArguments, PostsSearchArguments, PostsSetReminderArguments, PostsUnpinArguments, PostsUpdateArguments } from "./types/methods/posts.methods";
|
|
31
|
+
import type { PreferencesDeleteArguments, PreferencesGetArguments, PreferencesSaveArguments } from "./types/methods/preferences.methods";
|
|
32
|
+
import type { ReactionsCreateArguments, ReactionsDeleteArguments, ReactionsGetBulkArguments, ReactionsGetForPostArguments } from "./types/methods/reactions.methods";
|
|
33
|
+
import type { RolesGetArguments, RolesGetByNameArguments, RolesGetByNamesArguments, RolesPatchArguments } from "./types/methods/roles.methods";
|
|
34
|
+
import type { SchemesCreateArguments, SchemesDeleteArguments, SchemesGetArguments, SchemesGetChannelsArguments, SchemesGetTeamsArguments, SchemesListArguments, SchemesPatchArguments } from "./types/methods/schemes.methods";
|
|
35
|
+
import type { SystemCheckHealthArguments, SystemGetAnalyticsArguments, SystemGetLogsArguments, SystemTestEmailArguments, SystemTestS3ConnectionArguments, SystemTestSiteURLArguments, SystemUpdateConfigArguments, SystemUploadLogFileArguments } from "./types/methods/system.methods";
|
|
36
|
+
import type { TeamsCheckNameExistsArguments, TeamsCreateArguments, TeamsDeleteArguments, TeamsGetArguments, TeamsGetByIdArguments, TeamsGetByNameArguments, TeamsGetIconArguments, TeamsGetStatsArguments, TeamsImportArguments, TeamsMemberAddArguments, TeamsMemberAddBatchArguments, TeamsMemberGetArguments, TeamsMemberRemoveArguments, TeamsMembersGetByIdsArguments, TeamsMembersListArguments, TeamsMemberUpdateRolesArguments, TeamsMemberUpdateSchemeRolesArguments, TeamsPatchArguments, TeamsRegenerateInviteIdArguments, TeamsRemoveIconArguments, TeamsSearchArguments, TeamsSetIconArguments, TeamsUpdateArguments } from "./types/methods/teams.methods";
|
|
37
|
+
import type { TermsOfServiceCreateArguments, TermsOfServiceGetArguments, TermsOfServiceUpdateArguments } from "./types/methods/terms-of-service.methods";
|
|
38
|
+
import type { UploadsCreateArguments, UploadsGetArguments, UploadsUploadArguments } from "./types/methods/uploads.methods";
|
|
39
|
+
import type { UsersAutocompleteArguments, UsersCustomStatusSetArguments, UsersCustomStatusUnsetArguments, UsersDeleteImageArguments, UsersGetByEmailArguments, UsersGetByUsernameArguments, UsersListArguments, UsersProfileGetArguments, UsersProfileSetArguments, UsersSearchArguments, UsersSetImageArguments, UsersStatusGetAruments, UsersStatusSetAruments, UsersUpdateRolesArguments } from "./types/methods/users.methods";
|
|
40
|
+
import type { PluginManifest, PluginStatus, PluginsGetResponse } from "./types/plugins";
|
|
41
|
+
import type { Post } from "./types/posts";
|
|
42
|
+
import type { Preference } from "./types/preferences";
|
|
43
|
+
import type { Reaction } from "./types/reactions";
|
|
44
|
+
import type { StatusOKResponse } from "./types/responses/common.responses";
|
|
45
|
+
import type { PlaybookRunsCreateResponse, PlaybookRunsGetResponse, PlaybooksCreateResponse, PlaybooksGetResponse, PlaybooksListResponse, PlaybooksRunsListResponse, PlaybooksUpdateResponse } from "./types/responses/playbooks.responses";
|
|
46
|
+
import type { PostListResponse, PostSearchResponse } from "./types/responses/posts.responses";
|
|
47
|
+
import type { SystemCheckDatabaseIntegrityResponse, SystemCheckHealthResponse } from "./types/responses/system.responses";
|
|
48
|
+
import type { Role } from "./types/roles";
|
|
49
|
+
import type { Scheme } from "./types/schemes";
|
|
50
|
+
import type { Team, TeamMembership, TeamMemberWithError, TeamStats } from "./types/teams";
|
|
51
|
+
import type { TermsOfService } from "./types/terms-of-service";
|
|
52
|
+
import { type WebApiCallConfig, type WebClientEvent } from "./types/web-client";
|
|
53
|
+
type MethodWithRequiredArgument<METHOD_ARGS, METHOD_RESULT_DATA = unknown, METHOD_RESULT extends WebAPICallResult<METHOD_RESULT_DATA> = WebAPICallResult<METHOD_RESULT_DATA>> = (options: METHOD_ARGS) => Promise<METHOD_RESULT>;
|
|
54
|
+
type MethodWithOptionalArgument<METHOD_ARGS, METHOD_RESULT_DATA = unknown, METHOD_RESULT extends WebAPICallResult<METHOD_RESULT_DATA> = WebAPICallResult<METHOD_RESULT_DATA>> = (options?: METHOD_ARGS) => Promise<METHOD_RESULT>;
|
|
55
|
+
/**
|
|
56
|
+
* @description A class that defines all Web API methods, their arguments type,
|
|
57
|
+
* their response type, and binds those methods to the `apiCall` class method.
|
|
58
|
+
*
|
|
59
|
+
* Due to irregularities in API some method paths include path params in Express.js notation
|
|
60
|
+
* @example `users/:user_id`
|
|
61
|
+
*
|
|
62
|
+
* Path params are then filled using options object
|
|
63
|
+
* @example { user_id: 'user_id_123456 } with path `users/:user_id/promote` will result in `users/user_id_123456/promote`
|
|
64
|
+
*
|
|
65
|
+
* Loop API reference:
|
|
66
|
+
* @see {@link https://developers.loop.ru/category/loop-api | Loop API}
|
|
67
|
+
*/
|
|
68
|
+
export declare abstract class Methods extends EventEmitter<WebClientEvent> {
|
|
69
|
+
protected constructor();
|
|
70
|
+
abstract apiCall(config: WebApiCallConfig, options?: Record<string, unknown>): Promise<Readonly<WebAPICallResult>>;
|
|
71
|
+
/**
|
|
72
|
+
* ============================================================================
|
|
73
|
+
* @description Bots methods
|
|
74
|
+
* ============================================================================
|
|
75
|
+
*/
|
|
76
|
+
readonly bots: {
|
|
77
|
+
readonly convert: {
|
|
78
|
+
/**
|
|
79
|
+
* @description Convert a user to a bot.
|
|
80
|
+
* Requires `manage_system` permission.
|
|
81
|
+
*/
|
|
82
|
+
readonly fromUser: MethodWithRequiredArgument<BotsConvertUserArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
83
|
+
/**
|
|
84
|
+
* @description Convert a bot to a user.
|
|
85
|
+
* Requires `manage_system` permission.
|
|
86
|
+
*/
|
|
87
|
+
readonly toUser: MethodWithRequiredArgument<BotsConvertBotToUserArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* @description Create a new bot.
|
|
91
|
+
* Requires `create_bot` permission.
|
|
92
|
+
*/
|
|
93
|
+
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
|
+
readonly disable: MethodWithRequiredArgument<BotsDisableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
98
|
+
readonly enable: MethodWithRequiredArgument<BotsEnableArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
99
|
+
readonly assign: MethodWithRequiredArgument<BotsAssignArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
100
|
+
readonly icon: {
|
|
101
|
+
readonly get: MethodWithRequiredArgument<BotsGetIconArguments, Blob, WebAPICallResult<Blob>>;
|
|
102
|
+
readonly set: MethodWithRequiredArgument<BotsSetIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
103
|
+
readonly delete: MethodWithRequiredArgument<BotsDeleteIconArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* ============================================================================
|
|
108
|
+
* @description Brand methods
|
|
109
|
+
* ============================================================================
|
|
110
|
+
*/
|
|
111
|
+
readonly brand: {
|
|
112
|
+
readonly image: {
|
|
113
|
+
readonly get: MethodWithRequiredArgument<BrandGetImageArguments, Stream | Buffer<ArrayBufferLike>, WebAPICallResult<Stream | Buffer<ArrayBufferLike>>>;
|
|
114
|
+
readonly delete: MethodWithOptionalArgument<never, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
115
|
+
readonly upload: MethodWithRequiredArgument<BrandUploadImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
/**
|
|
119
|
+
* ============================================================================
|
|
120
|
+
* Compliance methods
|
|
121
|
+
* ============================================================================
|
|
122
|
+
*/
|
|
123
|
+
readonly compliance: {
|
|
124
|
+
readonly createReport: MethodWithRequiredArgument<ComplianceCreateReportArguments, ComplianceReport, WebAPICallResult<ComplianceReport>>;
|
|
125
|
+
readonly downloadReport: MethodWithRequiredArgument<ComplianceDownloadReportArguments, Stream | Buffer<ArrayBufferLike>, WebAPICallResult<Stream | Buffer<ArrayBufferLike>>>;
|
|
126
|
+
readonly getReports: MethodWithRequiredArgument<ComplianceGetReportsArguments, ComplianceReport[], WebAPICallResult<ComplianceReport[]>>;
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
* ============================================================================
|
|
130
|
+
* @description Channels methods
|
|
131
|
+
* ============================================================================
|
|
132
|
+
*/
|
|
133
|
+
readonly channels: {
|
|
134
|
+
readonly autocomplete: MethodWithRequiredArgument<ChannelsAutocompleteArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
135
|
+
/**
|
|
136
|
+
* @description Create a new channel.
|
|
137
|
+
* If creating a public channel, create_public_channel permission is required.
|
|
138
|
+
* If creating a private channel, create_private_channel permission is required.
|
|
139
|
+
*/
|
|
140
|
+
readonly create: {
|
|
141
|
+
readonly regular: MethodWithRequiredArgument<ChannelsCreateArguments, Channel, WebAPICallResult<Channel>>;
|
|
142
|
+
readonly direct: MethodWithRequiredArgument<ChannelsCreateDirectArguments, Channel, WebAPICallResult<Channel>>;
|
|
143
|
+
readonly group: MethodWithRequiredArgument<ChannelsCreateGroupArguments, Channel, WebAPICallResult<Channel>>;
|
|
144
|
+
};
|
|
145
|
+
readonly list: {
|
|
146
|
+
/**
|
|
147
|
+
* @description List all channels
|
|
148
|
+
*/
|
|
149
|
+
readonly all: MethodWithOptionalArgument<ChannelsListAllArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
150
|
+
/**
|
|
151
|
+
* @description List channels for a team.
|
|
152
|
+
*/
|
|
153
|
+
readonly inTeam: MethodWithRequiredArgument<ChannelsListInTeamArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
154
|
+
readonly byIds: MethodWithRequiredArgument<ChannelsGetByIdsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
155
|
+
/**
|
|
156
|
+
* @description Get all channels for a user across all teams.
|
|
157
|
+
*/
|
|
158
|
+
readonly forUser: MethodWithRequiredArgument<ChannelsGetAllForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
159
|
+
/**
|
|
160
|
+
* @description Get all channels for a user in a specific team.
|
|
161
|
+
*/
|
|
162
|
+
readonly forUserInTeam: MethodWithRequiredArgument<ChannelsGetForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
163
|
+
/**
|
|
164
|
+
* @description Get private channels for a team.
|
|
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.
|
|
178
|
+
*/
|
|
179
|
+
readonly autocomplete: MethodWithRequiredArgument<ChannelsSearchAutocompleteArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
180
|
+
/**
|
|
181
|
+
* @description Search for group message channels.
|
|
182
|
+
*/
|
|
183
|
+
readonly groups: MethodWithRequiredArgument<ChannelsSearchGroupsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
184
|
+
};
|
|
185
|
+
readonly get: {
|
|
186
|
+
/**
|
|
187
|
+
* @description Get a channel by ID.
|
|
188
|
+
*/
|
|
189
|
+
readonly byId: MethodWithRequiredArgument<ChannelsGetByIdArguments, Channel, WebAPICallResult<Channel>>;
|
|
190
|
+
/**
|
|
191
|
+
* @description Get a channel by name.
|
|
192
|
+
*/
|
|
193
|
+
readonly byName: MethodWithRequiredArgument<ChannelsGetByNameArguments, Channel, WebAPICallResult<Channel>>;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* @description Update a channel.
|
|
197
|
+
*/
|
|
198
|
+
readonly update: MethodWithRequiredArgument<ChannelsUpdateArguments, Channel, WebAPICallResult<Channel>>;
|
|
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
|
+
/**
|
|
209
|
+
* @description Get channel members.
|
|
210
|
+
*/
|
|
211
|
+
readonly get: MethodWithRequiredArgument<ChannelsMembersArguments, ChannelMembership[], WebAPICallResult<ChannelMembership[]>>;
|
|
212
|
+
/**
|
|
213
|
+
* @description Get a specific channel member.
|
|
214
|
+
*/
|
|
215
|
+
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
|
+
/**
|
|
226
|
+
* @description Get channel members by user IDs.
|
|
227
|
+
*/
|
|
228
|
+
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
|
+
/**
|
|
242
|
+
* @description Get channel members minus group members.
|
|
243
|
+
* @permission Must have manage_system permission.
|
|
244
|
+
*/
|
|
245
|
+
readonly getMinusGroupMembers: MethodWithRequiredArgument<ChannelsGetMembersMinusGroupArguments, {
|
|
246
|
+
users: unknown[];
|
|
247
|
+
total_count: number;
|
|
248
|
+
next_page_id: string;
|
|
249
|
+
}, WebAPICallResult<{
|
|
250
|
+
users: unknown[];
|
|
251
|
+
total_count: number;
|
|
252
|
+
next_page_id: string;
|
|
253
|
+
}>>;
|
|
254
|
+
/**
|
|
255
|
+
* @description Get member counts by group for a channel.
|
|
256
|
+
*/
|
|
257
|
+
readonly countByGroup: MethodWithRequiredArgument<ChannelsCountByGroupArguments, {
|
|
258
|
+
group_id: string;
|
|
259
|
+
channel_member_count: number;
|
|
260
|
+
}[], WebAPICallResult<{
|
|
261
|
+
group_id: string;
|
|
262
|
+
channel_member_count: number;
|
|
263
|
+
}[]>>;
|
|
264
|
+
};
|
|
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
|
+
readonly moderation: {
|
|
291
|
+
/**
|
|
292
|
+
* @description Get moderation settings for a channel.
|
|
293
|
+
*/
|
|
294
|
+
readonly get: MethodWithRequiredArgument<ChannelsModerationGetArguments, {
|
|
295
|
+
name: string;
|
|
296
|
+
roles: {
|
|
297
|
+
guests: boolean;
|
|
298
|
+
members: boolean;
|
|
299
|
+
};
|
|
300
|
+
}[], WebAPICallResult<{
|
|
301
|
+
name: string;
|
|
302
|
+
roles: {
|
|
303
|
+
guests: boolean;
|
|
304
|
+
members: boolean;
|
|
305
|
+
};
|
|
306
|
+
}[]>>;
|
|
307
|
+
/**
|
|
308
|
+
* @description Update moderation settings for a channel.
|
|
309
|
+
*/
|
|
310
|
+
readonly update: MethodWithRequiredArgument<ChannelsModerationUpdateArguments, {
|
|
311
|
+
name: string;
|
|
312
|
+
roles: {
|
|
313
|
+
guests: boolean;
|
|
314
|
+
members: boolean;
|
|
315
|
+
};
|
|
316
|
+
}[], WebAPICallResult<{
|
|
317
|
+
name: string;
|
|
318
|
+
roles: {
|
|
319
|
+
guests: boolean;
|
|
320
|
+
members: boolean;
|
|
321
|
+
};
|
|
322
|
+
}[]>>;
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
/**
|
|
326
|
+
* ============================================================================
|
|
327
|
+
* @description Cloud methods
|
|
328
|
+
* ============================================================================
|
|
329
|
+
*/
|
|
330
|
+
readonly cloud: {
|
|
331
|
+
readonly customer: {
|
|
332
|
+
readonly get: MethodWithOptionalArgument<never, CloudCustomer, WebAPICallResult<CloudCustomer>>;
|
|
333
|
+
/**
|
|
334
|
+
* Updates the customer information for the LOOP Cloud customer bound to this installation.
|
|
335
|
+
* @description Must have manage_system permission and be licensed for Cloud.
|
|
336
|
+
* Minimum server version: 5.29 Note: This is intended for internal use and is subject to change.
|
|
337
|
+
*/
|
|
338
|
+
readonly update: MethodWithRequiredArgument<CloudUpdateCustomerArguments, CloudCustomer, WebAPICallResult<CloudCustomer>>;
|
|
339
|
+
/**
|
|
340
|
+
* @description Updates the company address for the LOOP Cloud customer bound to this installation.
|
|
341
|
+
* Must have manage_system permission and be licensed for Cloud.
|
|
342
|
+
* Minimum server version: 5.29 Note: This is intended for internal use and is subject to change.
|
|
343
|
+
*/
|
|
344
|
+
readonly updateAddress: MethodWithRequiredArgument<CloudUpdateAddressArguments, CloudCustomer, WebAPICallResult<CloudCustomer>>;
|
|
345
|
+
readonly validateBusinessEmail: MethodWithRequiredArgument<CloudValidateBusinessEmailArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
346
|
+
readonly confirmPayment: MethodWithRequiredArgument<CloudConfirmCustomerPaymentArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
347
|
+
};
|
|
348
|
+
readonly invoices: {
|
|
349
|
+
readonly get: MethodWithOptionalArgument<never, CloudInvoice[], WebAPICallResult<CloudInvoice[]>>;
|
|
350
|
+
};
|
|
351
|
+
readonly subscription: {
|
|
352
|
+
readonly get: MethodWithOptionalArgument<never, CloudSubscription, WebAPICallResult<CloudSubscription>>;
|
|
353
|
+
readonly update: MethodWithOptionalArgument<never, CloudSubscription, WebAPICallResult<CloudSubscription>>;
|
|
354
|
+
};
|
|
355
|
+
readonly products: {
|
|
356
|
+
readonly get: MethodWithOptionalArgument<never, CloudProduct[], WebAPICallResult<CloudProduct[]>>;
|
|
357
|
+
};
|
|
358
|
+
readonly limits: {
|
|
359
|
+
readonly get: MethodWithOptionalArgument<never, CloudLimits, WebAPICallResult<CloudLimits>>;
|
|
360
|
+
};
|
|
361
|
+
};
|
|
362
|
+
/**
|
|
363
|
+
* ============================================================================
|
|
364
|
+
* @description Data retention methods
|
|
365
|
+
* ============================================================================
|
|
366
|
+
*/
|
|
367
|
+
readonly dataRetention: {
|
|
368
|
+
readonly policies: {
|
|
369
|
+
readonly create: MethodWithRequiredArgument<DataRetentionCreatePolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
370
|
+
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
371
|
+
readonly delete: MethodWithRequiredArgument<DataRetentionDeletePolicyArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
372
|
+
readonly update: MethodWithRequiredArgument<DataRetentionUpdatePolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
373
|
+
readonly patch: MethodWithRequiredArgument<DataRetentionPatchPolicyArguments, DataRetentionCustomPolicies, WebAPICallResult<DataRetentionCustomPolicies>>;
|
|
374
|
+
readonly list: MethodWithRequiredArgument<DataRetentionGetPoliciesArguments, DataRetentionCustomPolicies[], WebAPICallResult<DataRetentionCustomPolicies[]>>;
|
|
375
|
+
readonly teams: {
|
|
376
|
+
readonly search: MethodWithRequiredArgument<DataRetentionSearchPolicyTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
377
|
+
readonly add: MethodWithRequiredArgument<DataRetentionAddPolicyTeamsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
378
|
+
readonly remove: MethodWithRequiredArgument<DataRetentionRemovePolicyTeamsArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
379
|
+
readonly get: MethodWithRequiredArgument<DataRetentionGetPolicyTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
380
|
+
};
|
|
381
|
+
readonly channels: {
|
|
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>>;
|
|
394
|
+
};
|
|
395
|
+
readonly policiesCount: {
|
|
396
|
+
readonly get: MethodWithOptionalArgument<never, {
|
|
397
|
+
count: number;
|
|
398
|
+
}, WebAPICallResult<{
|
|
399
|
+
count: number;
|
|
400
|
+
}>>;
|
|
401
|
+
};
|
|
402
|
+
};
|
|
403
|
+
/**
|
|
404
|
+
* ============================================================================
|
|
405
|
+
* @description Emojis methods
|
|
406
|
+
* ============================================================================
|
|
407
|
+
*/
|
|
408
|
+
readonly emojis: {
|
|
409
|
+
readonly autocomplete: MethodWithRequiredArgument<EmojisAutocompleteArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
410
|
+
readonly create: MethodWithRequiredArgument<EmojisCreateArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
411
|
+
readonly list: MethodWithRequiredArgument<EmojisGetListArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
412
|
+
readonly get: {
|
|
413
|
+
readonly byId: MethodWithRequiredArgument<EmojisGetArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
414
|
+
readonly byName: MethodWithRequiredArgument<EmojisGetByNameArguments, CustomEmoji, WebAPICallResult<CustomEmoji>>;
|
|
415
|
+
};
|
|
416
|
+
readonly delete: MethodWithRequiredArgument<EmojisDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
417
|
+
readonly getImage: MethodWithRequiredArgument<EmojisGetImageArguments, Blob, WebAPICallResult<Blob>>;
|
|
418
|
+
readonly search: MethodWithRequiredArgument<EmojisSearchArguments, CustomEmoji[], WebAPICallResult<CustomEmoji[]>>;
|
|
419
|
+
};
|
|
420
|
+
/**
|
|
421
|
+
* ============================================================================
|
|
422
|
+
* @description Files methods
|
|
423
|
+
* ============================================================================
|
|
424
|
+
*/
|
|
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
|
+
/**
|
|
443
|
+
* @description Get file and various file-related data
|
|
444
|
+
*/
|
|
445
|
+
readonly get: {
|
|
446
|
+
/**
|
|
447
|
+
* Get a file
|
|
448
|
+
*
|
|
449
|
+
* @description Gets a file that has been uploaded previously.
|
|
450
|
+
*
|
|
451
|
+
* Must have read_channel permission or be uploader of the file.
|
|
452
|
+
*/
|
|
453
|
+
readonly file: MethodWithRequiredArgument<FilesGetArguments, Blob, WebAPICallResult<Blob>>;
|
|
454
|
+
/**
|
|
455
|
+
* Get metadata for a file
|
|
456
|
+
*
|
|
457
|
+
* @description Gets a file's info.
|
|
458
|
+
*
|
|
459
|
+
* Must have read_channel permission or be uploader of the file.
|
|
460
|
+
*/
|
|
461
|
+
readonly metadata: MethodWithRequiredArgument<FilesGetMetadataArguments, FileInfo, WebAPICallResult<FileInfo>>;
|
|
462
|
+
/**
|
|
463
|
+
* Get a file's preview
|
|
464
|
+
*
|
|
465
|
+
* @description Gets a file's preview.
|
|
466
|
+
*
|
|
467
|
+
* Must have read_channel permission or be uploader of the file.
|
|
468
|
+
*/
|
|
469
|
+
readonly preview: MethodWithRequiredArgument<FilesGetPreviewArguments, Blob, WebAPICallResult<Blob>>;
|
|
470
|
+
/**
|
|
471
|
+
* Get a public file link
|
|
472
|
+
*
|
|
473
|
+
* @description Gets a public link for a file that can be accessed without logging into LOOP.
|
|
474
|
+
*
|
|
475
|
+
* Must have read_channel permission or be uploader of the file.
|
|
476
|
+
*/
|
|
477
|
+
readonly publicLink: MethodWithRequiredArgument<FilesGetPublicLinkArguments, {
|
|
478
|
+
link: string;
|
|
479
|
+
}, WebAPICallResult<{
|
|
480
|
+
link: string;
|
|
481
|
+
}>>;
|
|
482
|
+
/**
|
|
483
|
+
* Get a public file
|
|
484
|
+
*
|
|
485
|
+
* No permissions required.
|
|
486
|
+
*/
|
|
487
|
+
readonly publicFile: MethodWithRequiredArgument<FilesGetPublicArguments, Blob, WebAPICallResult<Blob>>;
|
|
488
|
+
/**
|
|
489
|
+
* Get a file's thumbnail
|
|
490
|
+
*
|
|
491
|
+
* @description Gets a file's thumbnail.
|
|
492
|
+
*
|
|
493
|
+
* Must have read_channel permission or be uploader of the file.
|
|
494
|
+
*/
|
|
495
|
+
readonly thumbnail: MethodWithRequiredArgument<FilesGetThumbnailArguments, Blob, WebAPICallResult<Blob>>;
|
|
496
|
+
};
|
|
497
|
+
/**
|
|
498
|
+
* Search files in team
|
|
499
|
+
*
|
|
500
|
+
* @description Search for files in a team based on file name, extention and file content
|
|
501
|
+
* (if file content extraction is enabled and supported for the files).
|
|
502
|
+
* Must be authenticated and have the view_team permission.
|
|
503
|
+
*
|
|
504
|
+
* @version 5.34+
|
|
505
|
+
*
|
|
506
|
+
* @see https://developers.loop.ru/API/4.0.0/search-files
|
|
507
|
+
*/
|
|
508
|
+
readonly search: MethodWithRequiredArgument<FilesSearchArguments, FileSearchResponse, WebAPICallResult<FileSearchResponse>>;
|
|
509
|
+
};
|
|
510
|
+
/**
|
|
511
|
+
* ============================================================================
|
|
512
|
+
* @description Integrations methods
|
|
513
|
+
* ============================================================================
|
|
514
|
+
*/
|
|
515
|
+
readonly integrations: {
|
|
516
|
+
/**
|
|
517
|
+
* ============================================================================
|
|
518
|
+
* @description Integration interactive dialogs methods
|
|
519
|
+
* ============================================================================
|
|
520
|
+
*/
|
|
521
|
+
readonly dialogs: {
|
|
522
|
+
/**
|
|
523
|
+
* @description Open an interactive dialog using a trigger ID provided
|
|
524
|
+
* by a slash command, or some other action payload.
|
|
525
|
+
* @see {@link https://docs.loop.ru/developer/interactive-dialogs.html | Interactive Dialogs}
|
|
526
|
+
* for more information on interactive dialogs.
|
|
527
|
+
* Minimum server @version 5.6
|
|
528
|
+
*/
|
|
529
|
+
readonly open: MethodWithRequiredArgument<InteractiveOpenDialogArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
530
|
+
/**
|
|
531
|
+
* @description Endpoint used by the LOOP clients to submit a dialog.
|
|
532
|
+
* @see {@link https://docs.loop.ru/developer/interactive-dialogs.html | Interactive Dialogs}
|
|
533
|
+
* for more information on interactive dialogs.
|
|
534
|
+
* Minimum server @version 5.6
|
|
535
|
+
*/
|
|
536
|
+
readonly submit: MethodWithRequiredArgument<InteractiveSubmitDialogArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* ============================================================================
|
|
540
|
+
* @description Integration commands methods
|
|
541
|
+
* ============================================================================
|
|
542
|
+
*/
|
|
543
|
+
readonly commands: {
|
|
544
|
+
/**
|
|
545
|
+
* @description Create a command for a team.
|
|
546
|
+
* `manage_slash_commands` for the team the command is in.
|
|
547
|
+
*/
|
|
548
|
+
readonly create: MethodWithRequiredArgument<CommandsCreateArguments, Command, WebAPICallResult<Command>>;
|
|
549
|
+
/**
|
|
550
|
+
* @description List commands for a team.
|
|
551
|
+
* @permission `manage_slash_commands` if need to list custom commands.
|
|
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[]>>;
|
|
567
|
+
};
|
|
568
|
+
/**
|
|
569
|
+
* ============================================================================
|
|
570
|
+
* @description Integration webhooks methods
|
|
571
|
+
* ============================================================================
|
|
572
|
+
*/
|
|
573
|
+
readonly webhooks: {
|
|
574
|
+
readonly incoming: {
|
|
575
|
+
readonly create: MethodWithRequiredArgument<IncomingWebhooksCreateArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
576
|
+
readonly update: MethodWithRequiredArgument<IncomingWebhooksUpdateArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
577
|
+
readonly delete: MethodWithRequiredArgument<IncomingWebhooksDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
578
|
+
readonly list: MethodWithRequiredArgument<IncomingWebhooksListArguments, IncomingWebhook[], WebAPICallResult<IncomingWebhook[]>>;
|
|
579
|
+
readonly get: MethodWithRequiredArgument<IncomingWebhooksGetArguments, IncomingWebhook, WebAPICallResult<IncomingWebhook>>;
|
|
580
|
+
};
|
|
581
|
+
readonly outgoing: {
|
|
582
|
+
readonly create: MethodWithRequiredArgument<OutgoingWebhooksCreateArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
583
|
+
readonly update: MethodWithRequiredArgument<OutgoingWebhooksUpdateArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
584
|
+
readonly delete: MethodWithRequiredArgument<OutgoingWebhooksDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
585
|
+
readonly list: MethodWithRequiredArgument<OutgoingWebhooksListArguments, OutgoingWebhook[], WebAPICallResult<OutgoingWebhook[]>>;
|
|
586
|
+
readonly get: MethodWithRequiredArgument<OutgoingWebhooksGetArguments, OutgoingWebhook, WebAPICallResult<OutgoingWebhook>>;
|
|
587
|
+
readonly regenerateToken: MethodWithRequiredArgument<OutgoingWebhooksRegenerateTokenArguments, {
|
|
588
|
+
token: string;
|
|
589
|
+
}, WebAPICallResult<{
|
|
590
|
+
token: string;
|
|
591
|
+
}>>;
|
|
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>>;
|
|
608
|
+
};
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
/**
|
|
612
|
+
* ============================================================================
|
|
613
|
+
* @description Groups methods
|
|
614
|
+
* ============================================================================
|
|
615
|
+
*/
|
|
616
|
+
readonly groups: {
|
|
617
|
+
/**
|
|
618
|
+
* @description Create a new group.
|
|
619
|
+
* Requires `manage_system` permission.
|
|
620
|
+
*/
|
|
621
|
+
readonly create: MethodWithRequiredArgument<GroupsCreateArguments, Group, WebAPICallResult<Group>>;
|
|
622
|
+
/**
|
|
623
|
+
* @description Retrieve a group by its ID.
|
|
624
|
+
* Requires `manage_system` permission.
|
|
625
|
+
*/
|
|
626
|
+
readonly get: MethodWithRequiredArgument<GroupsGetArguments, Group, WebAPICallResult<Group>>;
|
|
627
|
+
/**
|
|
628
|
+
* @description List all groups.
|
|
629
|
+
* Requires `manage_system` permission.
|
|
630
|
+
*/
|
|
631
|
+
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
|
+
/**
|
|
644
|
+
* ============================================================================
|
|
645
|
+
* @description Group members methods
|
|
646
|
+
* ============================================================================
|
|
647
|
+
*/
|
|
648
|
+
readonly members: {
|
|
649
|
+
/**
|
|
650
|
+
* @description Get groups for a user.
|
|
651
|
+
*/
|
|
652
|
+
readonly listForUser: MethodWithRequiredArgument<GroupsListForUserArguments, Group[], WebAPICallResult<Group[]>>;
|
|
653
|
+
/**
|
|
654
|
+
* @description Get members of a group.
|
|
655
|
+
*/
|
|
656
|
+
readonly get: MethodWithRequiredArgument<GroupsMembersGetArguments, {
|
|
657
|
+
members: GroupMembership[];
|
|
658
|
+
total_member_count: number;
|
|
659
|
+
}, WebAPICallResult<{
|
|
660
|
+
members: GroupMembership[];
|
|
661
|
+
total_member_count: number;
|
|
662
|
+
}>>;
|
|
663
|
+
/**
|
|
664
|
+
* @description Add members to a custom group.
|
|
665
|
+
*/
|
|
666
|
+
readonly add: MethodWithRequiredArgument<GroupsMembersAddArguments, {
|
|
667
|
+
members: GroupMembership[];
|
|
668
|
+
}, WebAPICallResult<{
|
|
669
|
+
members: GroupMembership[];
|
|
670
|
+
}>>;
|
|
671
|
+
/**
|
|
672
|
+
* @description Remove members from a custom group.
|
|
673
|
+
*/
|
|
674
|
+
readonly remove: MethodWithRequiredArgument<GroupsMembersRemoveArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
675
|
+
};
|
|
676
|
+
readonly teams: {
|
|
677
|
+
/**
|
|
678
|
+
* @description Get a group's teams.
|
|
679
|
+
*/
|
|
680
|
+
readonly get: MethodWithRequiredArgument<GroupsTeamsGetArguments, GroupSyncable[], WebAPICallResult<GroupSyncable[]>>;
|
|
681
|
+
};
|
|
682
|
+
readonly channels: {
|
|
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>>;
|
|
689
|
+
};
|
|
690
|
+
/**
|
|
691
|
+
* ============================================================================
|
|
692
|
+
* @description Jobs methods
|
|
693
|
+
* ============================================================================
|
|
694
|
+
*/
|
|
695
|
+
readonly jobs: {
|
|
696
|
+
/**
|
|
697
|
+
* @description Create a new job.
|
|
698
|
+
* Requires `manage_jobs` permission.
|
|
699
|
+
*/
|
|
700
|
+
readonly create: MethodWithRequiredArgument<JobsCreateArguments, Job, WebAPICallResult<Job>>;
|
|
701
|
+
/**
|
|
702
|
+
* @description Retrieve a job by its ID.
|
|
703
|
+
*/
|
|
704
|
+
readonly get: MethodWithRequiredArgument<JobsGetArguments, Job, WebAPICallResult<Job>>;
|
|
705
|
+
/**
|
|
706
|
+
* @description List all jobs.
|
|
707
|
+
*/
|
|
708
|
+
readonly list: {
|
|
709
|
+
readonly all: MethodWithRequiredArgument<JobsListArguments, Job[], WebAPICallResult<Job[]>>; /**
|
|
710
|
+
* @description List jobs by type.
|
|
711
|
+
*/
|
|
712
|
+
readonly byType: MethodWithRequiredArgument<JobsListByTypeArguments, Job[], WebAPICallResult<Job[]>>;
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* @description Cancel a job.
|
|
716
|
+
*/
|
|
717
|
+
readonly cancel: MethodWithRequiredArgument<JobsCancelArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
718
|
+
};
|
|
719
|
+
/**
|
|
720
|
+
* ============================================================================
|
|
721
|
+
* @description Plugins methods
|
|
722
|
+
* ============================================================================
|
|
723
|
+
*/
|
|
724
|
+
readonly plugins: {
|
|
725
|
+
/**
|
|
726
|
+
* @description Upload a plugin.
|
|
727
|
+
* Requires `manage_system` permission.
|
|
728
|
+
*/
|
|
729
|
+
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
|
+
};
|
|
742
|
+
/**
|
|
743
|
+
* ============================================================================
|
|
744
|
+
* @description Roles methods
|
|
745
|
+
* ============================================================================
|
|
746
|
+
*/
|
|
747
|
+
readonly roles: {
|
|
748
|
+
readonly get: {
|
|
749
|
+
/**
|
|
750
|
+
* @description Retrieve a role by its ID.
|
|
751
|
+
*/
|
|
752
|
+
readonly byId: MethodWithRequiredArgument<RolesGetArguments, Role, WebAPICallResult<Role>>;
|
|
753
|
+
readonly byName: MethodWithRequiredArgument<RolesGetByNameArguments, Role, WebAPICallResult<Role>>;
|
|
754
|
+
readonly byNames: MethodWithRequiredArgument<RolesGetByNamesArguments, Role[], WebAPICallResult<Role[]>>;
|
|
755
|
+
};
|
|
756
|
+
readonly patch: MethodWithRequiredArgument<RolesPatchArguments, Role, WebAPICallResult<Role>>;
|
|
757
|
+
};
|
|
758
|
+
/**
|
|
759
|
+
* ============================================================================
|
|
760
|
+
* @description Schemes methods
|
|
761
|
+
* ============================================================================
|
|
762
|
+
*/
|
|
763
|
+
readonly schemes: {
|
|
764
|
+
readonly create: MethodWithRequiredArgument<SchemesCreateArguments, Scheme, WebAPICallResult<Scheme>>;
|
|
765
|
+
readonly delete: MethodWithRequiredArgument<SchemesDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
766
|
+
readonly get: MethodWithRequiredArgument<SchemesGetArguments, Scheme, WebAPICallResult<Scheme>>;
|
|
767
|
+
readonly getChannels: MethodWithRequiredArgument<SchemesGetChannelsArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
768
|
+
readonly getTeams: MethodWithRequiredArgument<SchemesGetTeamsArguments, Team[], WebAPICallResult<Team[]>>;
|
|
769
|
+
readonly list: MethodWithRequiredArgument<SchemesListArguments, Scheme[], WebAPICallResult<Scheme[]>>;
|
|
770
|
+
readonly patch: MethodWithRequiredArgument<SchemesPatchArguments, Scheme, WebAPICallResult<Scheme>>;
|
|
771
|
+
};
|
|
772
|
+
/**
|
|
773
|
+
* ============================================================================
|
|
774
|
+
* @description Teams methods
|
|
775
|
+
* ============================================================================
|
|
776
|
+
*/
|
|
777
|
+
readonly teams: {
|
|
778
|
+
readonly create: MethodWithRequiredArgument<TeamsCreateArguments, Team, WebAPICallResult<Team>>;
|
|
779
|
+
readonly list: MethodWithOptionalArgument<TeamsGetArguments, Team[], WebAPICallResult<Team[]>>;
|
|
780
|
+
readonly get: {
|
|
781
|
+
readonly byId: MethodWithRequiredArgument<TeamsGetByIdArguments, Team, WebAPICallResult<Team>>;
|
|
782
|
+
readonly byName: MethodWithRequiredArgument<TeamsGetByNameArguments, Team, WebAPICallResult<Team>>;
|
|
783
|
+
};
|
|
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
|
+
readonly getStats: MethodWithRequiredArgument<TeamsGetStatsArguments, TeamStats, WebAPICallResult<TeamStats>>;
|
|
789
|
+
readonly search: MethodWithRequiredArgument<TeamsSearchArguments, Team[], WebAPICallResult<Team[]>>;
|
|
790
|
+
readonly checkNameExists: MethodWithRequiredArgument<TeamsCheckNameExistsArguments, {
|
|
791
|
+
exists: boolean;
|
|
792
|
+
}, WebAPICallResult<{
|
|
793
|
+
exists: boolean;
|
|
794
|
+
}>>;
|
|
795
|
+
readonly import: MethodWithRequiredArgument<TeamsImportArguments, {
|
|
796
|
+
results: string;
|
|
797
|
+
}, WebAPICallResult<{
|
|
798
|
+
results: string;
|
|
799
|
+
}>>;
|
|
800
|
+
readonly icon: {
|
|
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
|
+
};
|
|
805
|
+
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
|
+
/**
|
|
812
|
+
* @description Add a user to a team.
|
|
813
|
+
* Requires `add_user_to_team` permission.
|
|
814
|
+
*/
|
|
815
|
+
readonly add: MethodWithRequiredArgument<TeamsMemberAddArguments, TeamMembership, WebAPICallResult<TeamMembership>>;
|
|
816
|
+
/**
|
|
817
|
+
* @description Add a number of users to a team.
|
|
818
|
+
* Requires `add_user_to_team` permission.
|
|
819
|
+
*/
|
|
820
|
+
readonly addBatch: MethodWithRequiredArgument<TeamsMemberAddBatchArguments, TeamMemberWithError[], WebAPICallResult<TeamMemberWithError[]>>;
|
|
821
|
+
/**
|
|
822
|
+
* @description Get a team member.
|
|
823
|
+
*/
|
|
824
|
+
readonly get: MethodWithRequiredArgument<TeamsMemberGetArguments, TeamMembership, WebAPICallResult<TeamMembership>>;
|
|
825
|
+
/**
|
|
826
|
+
* @description Remove a user from a team.
|
|
827
|
+
* Requires `remove_user_from_team` permission.
|
|
828
|
+
*/
|
|
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
|
+
/**
|
|
835
|
+
* @description Update the roles of a team member.
|
|
836
|
+
*/
|
|
837
|
+
readonly updateRoles: MethodWithRequiredArgument<TeamsMemberUpdateRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
838
|
+
/**
|
|
839
|
+
* @description Update the scheme-derived roles of a team member.
|
|
840
|
+
*/
|
|
841
|
+
readonly updateSchemeRoles: MethodWithRequiredArgument<TeamsMemberUpdateSchemeRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
842
|
+
};
|
|
843
|
+
};
|
|
844
|
+
readonly playbooks: {
|
|
845
|
+
readonly list: MethodWithRequiredArgument<PlaybooksListArguments, PlaybooksListResponse, WebAPICallResult<PlaybooksListResponse>>;
|
|
846
|
+
readonly get: MethodWithRequiredArgument<PlaybooksGetArguments, PlaybooksGetResponse, WebAPICallResult<PlaybooksGetResponse>>;
|
|
847
|
+
readonly create: MethodWithRequiredArgument<PlaybooksCreateArguments, PlaybooksCreateResponse, WebAPICallResult<PlaybooksCreateResponse>>;
|
|
848
|
+
readonly update: MethodWithRequiredArgument<PlaybooksUpdateArguments, PlaybooksUpdateResponse, WebAPICallResult<PlaybooksUpdateResponse>>;
|
|
849
|
+
readonly delete: MethodWithRequiredArgument<PlaybooksDeleteArguments, never, WebAPICallResult<never>>;
|
|
850
|
+
readonly runs: {
|
|
851
|
+
readonly get: MethodWithRequiredArgument<PlaybookRunsGetArguments, PlaybookRunsGetResponse, WebAPICallResult<PlaybookRunsGetResponse>>;
|
|
852
|
+
readonly create: MethodWithRequiredArgument<PlaybookRunsCreateArguments, PlaybookRunsCreateResponse, WebAPICallResult<PlaybookRunsCreateResponse>>;
|
|
853
|
+
readonly list: MethodWithRequiredArgument<PlaybookRunsListArguments, PlaybooksRunsListResponse, WebAPICallResult<PlaybooksRunsListResponse>>;
|
|
854
|
+
};
|
|
855
|
+
};
|
|
856
|
+
/**
|
|
857
|
+
* ============================================================================
|
|
858
|
+
* @description Posts methods
|
|
859
|
+
* ============================================================================
|
|
860
|
+
*/
|
|
861
|
+
readonly posts: {
|
|
862
|
+
readonly create: MethodWithRequiredArgument<PostsCreateArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
863
|
+
/**
|
|
864
|
+
* @description Create an ephemeral post.
|
|
865
|
+
* Creates a new ephemeral post that is visible only to the specified user.
|
|
866
|
+
*/
|
|
867
|
+
readonly createEphemeral: MethodWithRequiredArgument<PostsCreateEphemeralArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
868
|
+
readonly update: MethodWithRequiredArgument<PostsUpdateArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
869
|
+
readonly get: MethodWithRequiredArgument<PostsGetArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
870
|
+
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
|
+
/**
|
|
877
|
+
* @description Mark a channel as being unread from a given post.
|
|
878
|
+
* Sets the last viewed at timestamp for the user's channel to the post's create_at timestamp.
|
|
879
|
+
*/
|
|
880
|
+
readonly setUnread: MethodWithRequiredArgument<PostsMarkAsUnreadArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
881
|
+
/**
|
|
882
|
+
* @description Partially update a post.
|
|
883
|
+
* Updates a post by providing only the fields that need to change.
|
|
884
|
+
*/
|
|
885
|
+
readonly patch: MethodWithRequiredArgument<PostsPatchArguments, Post<Record<string, unknown>>, WebAPICallResult<Post<Record<string, unknown>>>>;
|
|
886
|
+
/**
|
|
887
|
+
* @description Get a list of flagged posts for a user.
|
|
888
|
+
* Retrieves posts that the specified user has flagged/saved.
|
|
889
|
+
*/
|
|
890
|
+
readonly getFlagged: MethodWithRequiredArgument<PostsGetFlaggedArguments, PostListResponse, WebAPICallResult<PostListResponse>>;
|
|
891
|
+
/**
|
|
892
|
+
* @description Get file info for a post.
|
|
893
|
+
* Gets a list of file information objects for the files attached to a post.
|
|
894
|
+
*/
|
|
895
|
+
readonly getFilesInfo: MethodWithRequiredArgument<PostsGetFileInfoArguments, FileInfo[], WebAPICallResult<FileInfo[]>>;
|
|
896
|
+
/**
|
|
897
|
+
* @description Get posts around the last unread.
|
|
898
|
+
* Get the posts around the oldest unread post in a channel for a given user.
|
|
899
|
+
*/
|
|
900
|
+
readonly getAroundUnread: MethodWithRequiredArgument<PostsGetAroundLastUnreadArguments, PostListResponse, WebAPICallResult<PostListResponse>>;
|
|
901
|
+
/**
|
|
902
|
+
* @description Search posts in a team.
|
|
903
|
+
* Search posts in the specified team using the provided terms.
|
|
904
|
+
*/
|
|
905
|
+
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<Record<string, unknown>>[], WebAPICallResult<Post<Record<string, unknown>>[]>>;
|
|
916
|
+
/**
|
|
917
|
+
* @description Set a reminder for a post.
|
|
918
|
+
* Set a reminder for the specified user on the specified post.
|
|
919
|
+
*/
|
|
920
|
+
readonly setReminder: MethodWithRequiredArgument<PostsSetReminderArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* ============================================================================
|
|
924
|
+
* @description Reactions methods
|
|
925
|
+
* ============================================================================
|
|
926
|
+
*/
|
|
927
|
+
readonly reactions: {
|
|
928
|
+
readonly create: MethodWithRequiredArgument<ReactionsCreateArguments, Reaction, WebAPICallResult<Reaction>>;
|
|
929
|
+
readonly getForPost: MethodWithRequiredArgument<ReactionsGetForPostArguments, Reaction[], WebAPICallResult<Reaction[]>>;
|
|
930
|
+
readonly delete: MethodWithRequiredArgument<ReactionsDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
931
|
+
readonly getBulk: MethodWithRequiredArgument<ReactionsGetBulkArguments, Record<string, Reaction[]>, WebAPICallResult<Record<string, Reaction[]>>>;
|
|
932
|
+
};
|
|
933
|
+
/**
|
|
934
|
+
* ============================================================================
|
|
935
|
+
* @description System methods
|
|
936
|
+
* ============================================================================
|
|
937
|
+
*/
|
|
938
|
+
readonly system: {
|
|
939
|
+
readonly checkHealth: MethodWithOptionalArgument<SystemCheckHealthArguments, SystemCheckHealthResponse, WebAPICallResult<SystemCheckHealthResponse>>;
|
|
940
|
+
readonly checkDatabaseIntegrity: MethodWithOptionalArgument<never, SystemCheckDatabaseIntegrityResponse, WebAPICallResult<SystemCheckDatabaseIntegrityResponse>>;
|
|
941
|
+
readonly getAnalytics: MethodWithRequiredArgument<SystemGetAnalyticsArguments, AnalyticsRow[], WebAPICallResult<AnalyticsRow[]>>;
|
|
942
|
+
readonly getLogs: MethodWithRequiredArgument<SystemGetLogsArguments, string[], WebAPICallResult<string[]>>;
|
|
943
|
+
readonly testEmail: MethodWithRequiredArgument<SystemTestEmailArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
944
|
+
readonly testS3Connection: MethodWithRequiredArgument<SystemTestS3ConnectionArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
945
|
+
readonly testSiteURL: MethodWithRequiredArgument<SystemTestSiteURLArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
946
|
+
readonly updateConfig: MethodWithRequiredArgument<SystemUpdateConfigArguments, ClientConfig, WebAPICallResult<ClientConfig>>;
|
|
947
|
+
readonly uploadLogFile: MethodWithRequiredArgument<SystemUploadLogFileArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
948
|
+
};
|
|
949
|
+
readonly termsOfService: {
|
|
950
|
+
readonly create: MethodWithRequiredArgument<TermsOfServiceCreateArguments, TermsOfService, WebAPICallResult<TermsOfService>>;
|
|
951
|
+
readonly get: MethodWithRequiredArgument<TermsOfServiceGetArguments, TermsOfService, WebAPICallResult<TermsOfService>>;
|
|
952
|
+
readonly update: MethodWithRequiredArgument<TermsOfServiceUpdateArguments, TermsOfService, WebAPICallResult<TermsOfService>>;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* ============================================================================
|
|
956
|
+
* @description Uploads profile methods
|
|
957
|
+
* ============================================================================
|
|
958
|
+
*/
|
|
959
|
+
readonly uploads: {
|
|
960
|
+
readonly create: MethodWithRequiredArgument<UploadsCreateArguments, UploadSession, WebAPICallResult<UploadSession>>;
|
|
961
|
+
readonly get: MethodWithRequiredArgument<UploadsGetArguments, UploadSession, WebAPICallResult<UploadSession>>;
|
|
962
|
+
readonly upload: MethodWithRequiredArgument<UploadsUploadArguments, FileInfo, WebAPICallResult<FileInfo>>;
|
|
963
|
+
};
|
|
964
|
+
/**
|
|
965
|
+
* ============================================================================
|
|
966
|
+
* @description User methods
|
|
967
|
+
* ============================================================================
|
|
968
|
+
*/
|
|
969
|
+
readonly users: {
|
|
970
|
+
readonly list: MethodWithOptionalArgument<UsersListArguments, UserProfile[], WebAPICallResult<UserProfile[]>>;
|
|
971
|
+
readonly autocomplete: MethodWithRequiredArgument<UsersAutocompleteArguments, {
|
|
972
|
+
users: UserProfile[];
|
|
973
|
+
out_of_channel?: UserProfile[];
|
|
974
|
+
}, WebAPICallResult<{
|
|
975
|
+
users: UserProfile[];
|
|
976
|
+
out_of_channel?: UserProfile[];
|
|
977
|
+
}>>;
|
|
978
|
+
readonly channels: {
|
|
979
|
+
readonly list: {
|
|
980
|
+
readonly inTeam: MethodWithRequiredArgument<ChannelsGetForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
981
|
+
readonly all: MethodWithRequiredArgument<ChannelsGetAllForUserArguments, Channel[], WebAPICallResult<Channel[]>>;
|
|
982
|
+
};
|
|
983
|
+
readonly sidebar: {
|
|
984
|
+
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
|
+
/**
|
|
996
|
+
* @description Create a new sidebar category.
|
|
997
|
+
*/
|
|
998
|
+
readonly create: MethodWithRequiredArgument<ChannelsCategoriesCreateArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
999
|
+
/**
|
|
1000
|
+
* @description Update all sidebar categories for a user.
|
|
1001
|
+
*/
|
|
1002
|
+
readonly updateAll: MethodWithRequiredArgument<ChannelsCategoriesUpdateAllArguments, SidebarCategory[], WebAPICallResult<SidebarCategory[]>>;
|
|
1003
|
+
/**
|
|
1004
|
+
* @description Get a specific sidebar category.
|
|
1005
|
+
*/
|
|
1006
|
+
readonly get: MethodWithRequiredArgument<ChannelsCategoryGetArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
1007
|
+
/**
|
|
1008
|
+
* @description Update a specific sidebar category.
|
|
1009
|
+
*/
|
|
1010
|
+
readonly update: MethodWithRequiredArgument<ChannelsCategoryUpdateArguments, SidebarCategory, WebAPICallResult<SidebarCategory>>;
|
|
1011
|
+
/**
|
|
1012
|
+
* @description Delete a sidebar category.
|
|
1013
|
+
*/
|
|
1014
|
+
readonly delete: MethodWithRequiredArgument<ChannelsCategoryDeleteArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1015
|
+
/**
|
|
1016
|
+
* @description Get sidebar category order.
|
|
1017
|
+
*/
|
|
1018
|
+
readonly getOrder: MethodWithRequiredArgument<ChannelsCategoriesOrderGetArguments, string[], WebAPICallResult<string[]>>;
|
|
1019
|
+
/**
|
|
1020
|
+
* @description Update sidebar category order.
|
|
1021
|
+
*/
|
|
1022
|
+
readonly updateOrder: MethodWithRequiredArgument<ChannelsCategoriesOrderUpdateArguments, string[], WebAPICallResult<string[]>>;
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
};
|
|
1026
|
+
readonly getGroups: MethodWithRequiredArgument<GroupsListForUserArguments, Group[], WebAPICallResult<Group[]>>;
|
|
1027
|
+
/**
|
|
1028
|
+
* ============================================================================
|
|
1029
|
+
* @description Guest methods
|
|
1030
|
+
* ============================================================================
|
|
1031
|
+
*/
|
|
1032
|
+
readonly guest: {
|
|
1033
|
+
readonly toUser: MethodWithRequiredArgument<UserID, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1034
|
+
readonly fromUser: MethodWithRequiredArgument<UserID, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1035
|
+
};
|
|
1036
|
+
/**
|
|
1037
|
+
* ============================================================================
|
|
1038
|
+
* @description User profile methods
|
|
1039
|
+
* ============================================================================
|
|
1040
|
+
*/
|
|
1041
|
+
readonly profile: {
|
|
1042
|
+
readonly get: {
|
|
1043
|
+
/**
|
|
1044
|
+
* @description Retrieve a user's profile information, including their custom status.
|
|
1045
|
+
*/
|
|
1046
|
+
readonly me: MethodWithOptionalArgument<TokenOverridable, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1047
|
+
/**
|
|
1048
|
+
* @description Retrieve a user's profile information, including their custom status.
|
|
1049
|
+
*/
|
|
1050
|
+
readonly byId: MethodWithOptionalArgument<UsersProfileGetArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1051
|
+
/**
|
|
1052
|
+
* @description Find a user with an email address.
|
|
1053
|
+
*/
|
|
1054
|
+
readonly byEmail: MethodWithRequiredArgument<UsersGetByEmailArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1055
|
+
/**
|
|
1056
|
+
* @description Find a user with an email address.
|
|
1057
|
+
*/
|
|
1058
|
+
readonly byUsername: MethodWithRequiredArgument<UsersGetByUsernameArguments, UserProfile, WebAPICallResult<UserProfile>>;
|
|
1059
|
+
};
|
|
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
|
+
/**
|
|
1066
|
+
* @description Profile image methods
|
|
1067
|
+
*/
|
|
1068
|
+
readonly image: {
|
|
1069
|
+
/**
|
|
1070
|
+
* @description Set the user profile image.
|
|
1071
|
+
*/
|
|
1072
|
+
readonly set: MethodWithRequiredArgument<UsersSetImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>; /**
|
|
1073
|
+
* @description Delete the user profile image.
|
|
1074
|
+
*/
|
|
1075
|
+
readonly delete: MethodWithOptionalArgument<UsersDeleteImageArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
readonly search: MethodWithRequiredArgument<UsersSearchArguments, UserProfile[], WebAPICallResult<UserProfile[]>>;
|
|
1079
|
+
readonly status: {
|
|
1080
|
+
/**
|
|
1081
|
+
* @description Gets status for user
|
|
1082
|
+
*/
|
|
1083
|
+
readonly get: MethodWithRequiredArgument<UsersStatusGetAruments, UserStatus, WebAPICallResult<UserStatus>>;
|
|
1084
|
+
/**
|
|
1085
|
+
* @description Update users status by id
|
|
1086
|
+
* Must have edit_other_users permission for the team.
|
|
1087
|
+
*/
|
|
1088
|
+
readonly set: MethodWithRequiredArgument<UsersStatusSetAruments, UserStatus, WebAPICallResult<UserStatus>>;
|
|
1089
|
+
readonly setCustom: MethodWithRequiredArgument<UsersCustomStatusSetArguments, UserCustomStatus, WebAPICallResult<UserCustomStatus>>;
|
|
1090
|
+
readonly unsetCustom: MethodWithRequiredArgument<UsersCustomStatusUnsetArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1091
|
+
};
|
|
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
|
+
readonly updateRoles: MethodWithRequiredArgument<UsersUpdateRolesArguments, StatusOKResponse, WebAPICallResult<StatusOKResponse>>;
|
|
1098
|
+
};
|
|
1099
|
+
}
|
|
1100
|
+
export {};
|
|
1101
|
+
//# sourceMappingURL=methods.d.ts.map
|