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,191 @@
|
|
|
1
|
+
import type { Command, OAuthApp } from "../integrations";
|
|
2
|
+
import type { ContentType } from "../web-client";
|
|
3
|
+
import type { ChannelID, OptionalUserID, TeamID, TokenOverridable } from "./common.methods";
|
|
4
|
+
/**
|
|
5
|
+
* Arguments for creating a command.
|
|
6
|
+
*/
|
|
7
|
+
export interface CommandsCreateArguments {
|
|
8
|
+
/**
|
|
9
|
+
* @description Team ID to where the command should be created
|
|
10
|
+
*/
|
|
11
|
+
team_id: string;
|
|
12
|
+
/**
|
|
13
|
+
* @description `P` for post request, `G` for get request
|
|
14
|
+
*/
|
|
15
|
+
method: "P" | "G";
|
|
16
|
+
/**
|
|
17
|
+
* @description Activation word to trigger the command
|
|
18
|
+
*/
|
|
19
|
+
trigger: string;
|
|
20
|
+
/**
|
|
21
|
+
* @description The URL that the command will make the request
|
|
22
|
+
*/
|
|
23
|
+
url: string;
|
|
24
|
+
/**
|
|
25
|
+
* @description The name of the command
|
|
26
|
+
*/
|
|
27
|
+
display_name?: string;
|
|
28
|
+
/**
|
|
29
|
+
* @description The description of the command
|
|
30
|
+
*/
|
|
31
|
+
description?: string;
|
|
32
|
+
/**
|
|
33
|
+
* @description The username that the command will show
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* @description The icon URL that the command will show
|
|
38
|
+
*/
|
|
39
|
+
icon_url?: string;
|
|
40
|
+
/**
|
|
41
|
+
* @description Whether to show autocomplete options
|
|
42
|
+
*/
|
|
43
|
+
auto_complete?: boolean;
|
|
44
|
+
/**
|
|
45
|
+
* @description The description of the autocomplete usage
|
|
46
|
+
*/
|
|
47
|
+
auto_complete_desc?: string;
|
|
48
|
+
/**
|
|
49
|
+
* @description The hint of the autocomplete usage
|
|
50
|
+
*/
|
|
51
|
+
auto_complete_hint?: string;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Arguments for updating a command.
|
|
55
|
+
*/
|
|
56
|
+
export interface CommandsUpdateArguments extends Partial<Command> {
|
|
57
|
+
id: string;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Arguments for deleting a command.
|
|
61
|
+
*/
|
|
62
|
+
export interface CommandsDeleteArguments {
|
|
63
|
+
command_id: string;
|
|
64
|
+
}
|
|
65
|
+
export interface CommandsListArguments {
|
|
66
|
+
team_id?: string;
|
|
67
|
+
custom_only?: boolean;
|
|
68
|
+
}
|
|
69
|
+
export interface CommandsRegenerateTokenArguments {
|
|
70
|
+
command_id: string;
|
|
71
|
+
}
|
|
72
|
+
export interface CommandsExecuteArguments {
|
|
73
|
+
command: string;
|
|
74
|
+
team_id: string;
|
|
75
|
+
channel_id: string;
|
|
76
|
+
root_id?: string;
|
|
77
|
+
}
|
|
78
|
+
export interface CommandsListAutocompleteArguments {
|
|
79
|
+
team_id: string;
|
|
80
|
+
user_input: string;
|
|
81
|
+
}
|
|
82
|
+
export interface IncomingWebhooksCreateArguments extends TokenOverridable, ChannelID, OptionalUserID {
|
|
83
|
+
/**
|
|
84
|
+
* @description The display name for this incoming webhook
|
|
85
|
+
*/
|
|
86
|
+
display_name?: string;
|
|
87
|
+
/**
|
|
88
|
+
* @description The description for this incoming webhook
|
|
89
|
+
*/
|
|
90
|
+
description?: string;
|
|
91
|
+
/**
|
|
92
|
+
* @description The username this incoming webhook will post as.
|
|
93
|
+
*/
|
|
94
|
+
username?: string;
|
|
95
|
+
/**
|
|
96
|
+
* @description The profile picture this incoming webhook will use when posting.
|
|
97
|
+
*/
|
|
98
|
+
icon_url?: string;
|
|
99
|
+
}
|
|
100
|
+
export interface IncomingWebhooksUpdateArguments extends IncomingWebhooksCreateArguments {
|
|
101
|
+
id: string;
|
|
102
|
+
}
|
|
103
|
+
export interface IncomingWebhooksDeleteArguments {
|
|
104
|
+
hook_id: string;
|
|
105
|
+
}
|
|
106
|
+
export interface IncomingWebhooksListArguments {
|
|
107
|
+
team_id?: string;
|
|
108
|
+
page?: number;
|
|
109
|
+
per_page?: number;
|
|
110
|
+
}
|
|
111
|
+
export interface IncomingWebhooksGetArguments {
|
|
112
|
+
hook_id: string;
|
|
113
|
+
}
|
|
114
|
+
export interface OutgoingWebhooksCreateArguments extends TokenOverridable, ChannelID, TeamID {
|
|
115
|
+
/**
|
|
116
|
+
* @description The ID of the owner of the webhook if different than the requester. Required in local mode.
|
|
117
|
+
*/
|
|
118
|
+
creator_id?: string;
|
|
119
|
+
/**
|
|
120
|
+
* @description The description for this outgoing webhook
|
|
121
|
+
*/
|
|
122
|
+
description?: string;
|
|
123
|
+
/**
|
|
124
|
+
* @description The display name for this outgoing webhook
|
|
125
|
+
*/
|
|
126
|
+
display_name: string;
|
|
127
|
+
/**
|
|
128
|
+
* @description When to trigger the webhook, 0 when a trigger word is present at all and 1 if the message starts with a trigger word
|
|
129
|
+
*/
|
|
130
|
+
trigger_when: 0 | 1;
|
|
131
|
+
/**
|
|
132
|
+
* @description List of words for the webhook to trigger on
|
|
133
|
+
*/
|
|
134
|
+
trigger_words: string[];
|
|
135
|
+
/**
|
|
136
|
+
* @description The URLs to POST the payloads to when the webhook is triggered
|
|
137
|
+
*/
|
|
138
|
+
callback_urls: string[];
|
|
139
|
+
/**
|
|
140
|
+
* @default application/x-www-form-urlencoded
|
|
141
|
+
* The format to POST the data in, either application/json or application/x-www-form-urlencoded
|
|
142
|
+
*/
|
|
143
|
+
content_type?: ContentType.JSON | ContentType.URLEncoded;
|
|
144
|
+
}
|
|
145
|
+
export interface OutgoingWebhooksUpdateArguments extends TokenOverridable, ChannelID {
|
|
146
|
+
/**
|
|
147
|
+
* @description The description for this outgoing webhook
|
|
148
|
+
*/
|
|
149
|
+
description?: string;
|
|
150
|
+
/**
|
|
151
|
+
* @description The display name for this outgoing webhook
|
|
152
|
+
*/
|
|
153
|
+
display_name: string;
|
|
154
|
+
}
|
|
155
|
+
export interface OutgoingWebhooksDeleteArguments {
|
|
156
|
+
hook_id: string;
|
|
157
|
+
}
|
|
158
|
+
export interface OutgoingWebhooksListArguments {
|
|
159
|
+
channel_id?: string;
|
|
160
|
+
team_id?: string;
|
|
161
|
+
page?: number;
|
|
162
|
+
per_page?: number;
|
|
163
|
+
}
|
|
164
|
+
export interface OutgoingWebhooksGetArguments {
|
|
165
|
+
hook_id: string;
|
|
166
|
+
}
|
|
167
|
+
export interface OutgoingWebhooksRegenerateTokenArguments {
|
|
168
|
+
hook_id: string;
|
|
169
|
+
}
|
|
170
|
+
export interface OAuthAppsCreateArguments extends Omit<OAuthApp, "id"> {
|
|
171
|
+
}
|
|
172
|
+
export interface OAuthAppsUpdateArguments extends Partial<OAuthApp> {
|
|
173
|
+
id: string;
|
|
174
|
+
}
|
|
175
|
+
export interface OAuthAppsDeleteArguments {
|
|
176
|
+
app_id: string;
|
|
177
|
+
}
|
|
178
|
+
export interface OAuthAppsGetArguments {
|
|
179
|
+
app_id: string;
|
|
180
|
+
}
|
|
181
|
+
export interface OAuthAppsGetInfoArguments {
|
|
182
|
+
app_id: string;
|
|
183
|
+
}
|
|
184
|
+
export interface OAuthAppsListArguments {
|
|
185
|
+
page?: number;
|
|
186
|
+
per_page?: number;
|
|
187
|
+
}
|
|
188
|
+
export interface OAuthAppsRegenerateSecretArguments {
|
|
189
|
+
app_id: string;
|
|
190
|
+
}
|
|
191
|
+
//# sourceMappingURL=integrations.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/integrations.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EACX,SAAS,EACT,cAAc,EACd,MAAM,EACN,gBAAgB,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,OAAO,CAAC,OAAO,CAAC;IAChE,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAChD,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACxC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iCAAiC;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,+BAChB,SAAQ,gBAAgB,EACvB,SAAS,EACT,cAAc;IACf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,+BAChB,SAAQ,+BAA+B;IACvC,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,+BAA+B;IAC/C,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC7C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,MAAM,WAAW,+BAChB,SAAQ,gBAAgB,EACvB,SAAS,EACT,MAAM;IACP;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB;;;OAGG;IACH,YAAY,CAAC,EAAE,WAAW,CAAC,IAAI,GAAG,WAAW,CAAC,UAAU,CAAC;CACzD;AAED,MAAM,WAAW,+BAChB,SAAQ,gBAAgB,EACvB,SAAS;IACV;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,+BAA+B;IAC/C,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,6BAA6B;IAC7C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wCAAwC;IACxD,OAAO,EAAE,MAAM,CAAC;CAChB;AAGD,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC;CAAG;AAEzE,MAAM,WAAW,wBAAyB,SAAQ,OAAO,CAAC,QAAQ,CAAC;IAClE,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,wBAAwB;IACxC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACrC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACzC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kCAAkC;IAClD,MAAM,EAAE,MAAM,CAAC;CACf"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"integrations.methods.js","sourceRoot":"","sources":["../../../src/types/methods/integrations.methods.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { Dialog } from "../dialog";
|
|
2
|
+
/**
|
|
3
|
+
* Arguments for opening a dialog.
|
|
4
|
+
*/
|
|
5
|
+
export interface InteractiveOpenDialogArguments {
|
|
6
|
+
/**
|
|
7
|
+
* @description Trigger ID provided by other action
|
|
8
|
+
*/
|
|
9
|
+
trigger_id: string;
|
|
10
|
+
/**
|
|
11
|
+
* @description Dialog to open
|
|
12
|
+
*/
|
|
13
|
+
dialog: Dialog;
|
|
14
|
+
/**
|
|
15
|
+
* @description The URL to send the submitted dialog payload to
|
|
16
|
+
*/
|
|
17
|
+
url?: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Arguments for submitting a dialog.
|
|
21
|
+
*/
|
|
22
|
+
export interface InteractiveSubmitDialogArguments {
|
|
23
|
+
/** The URL to submit the dialog to */
|
|
24
|
+
url: string;
|
|
25
|
+
/** The channel ID where the dialog was triggered */
|
|
26
|
+
channel_id: string;
|
|
27
|
+
/** The team ID where the dialog was triggered */
|
|
28
|
+
team_id: string;
|
|
29
|
+
/** The dialog submission data */
|
|
30
|
+
submission: Record<string, unknown>;
|
|
31
|
+
/** The callback ID of the dialog */
|
|
32
|
+
callback_id?: string;
|
|
33
|
+
/** The state of the dialog */
|
|
34
|
+
state?: string;
|
|
35
|
+
/** Whether the dialog is cancelled */
|
|
36
|
+
cancelled?: boolean;
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=interactive.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interactive.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/interactive.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAChD,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAC;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"interactive.methods.js","sourceRoot":"","sources":["../../../src/types/methods/interactive.methods.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { JobType } from "../jobs";
|
|
2
|
+
export interface JobsCreateArguments {
|
|
3
|
+
type: JobType;
|
|
4
|
+
}
|
|
5
|
+
export interface JobsGetArguments {
|
|
6
|
+
job_id: string;
|
|
7
|
+
}
|
|
8
|
+
export interface JobsListArguments {
|
|
9
|
+
page?: number;
|
|
10
|
+
per_page?: number;
|
|
11
|
+
}
|
|
12
|
+
export interface JobsListByTypeArguments {
|
|
13
|
+
type: JobType;
|
|
14
|
+
page?: number;
|
|
15
|
+
per_page?: number;
|
|
16
|
+
}
|
|
17
|
+
export interface JobsCancelArguments {
|
|
18
|
+
job_id: string;
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=jobs.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobs.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/jobs.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAEvC,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,OAAO,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACvC,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IACnC,MAAM,EAAE,MAAM,CAAC;CACf"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobs.methods.js","sourceRoot":"","sources":["../../../src/types/methods/jobs.methods.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import type { Directionable, Paginated, TeamID, TokenOverridable } from "./common.methods";
|
|
2
|
+
/**
|
|
3
|
+
* Get a playbook run
|
|
4
|
+
*
|
|
5
|
+
* @description Get a playbook run
|
|
6
|
+
*/
|
|
7
|
+
export interface PlaybookRunsGetArguments extends TokenOverridable {
|
|
8
|
+
/**
|
|
9
|
+
* @description ID of the playbook run to retrieve.
|
|
10
|
+
*/
|
|
11
|
+
id: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Create a new playbook run
|
|
15
|
+
*
|
|
16
|
+
* @description Create a new playbook run in a team, using a playbook as template,
|
|
17
|
+
* with a specific name and a specific owner.
|
|
18
|
+
*/
|
|
19
|
+
export interface PlaybookRunsCreateArguments extends TokenOverridable, TeamID {
|
|
20
|
+
/**
|
|
21
|
+
* @description The name of the playbook run.
|
|
22
|
+
*/
|
|
23
|
+
name: string;
|
|
24
|
+
/**
|
|
25
|
+
* @description The description of the playbook run.
|
|
26
|
+
*/
|
|
27
|
+
description?: string;
|
|
28
|
+
/**
|
|
29
|
+
* @description The identifier of the user who is commanding the playbook run.
|
|
30
|
+
*/
|
|
31
|
+
owner_user_id: string;
|
|
32
|
+
/**
|
|
33
|
+
* @description The identifier of the team where the playbook run's channel is in.
|
|
34
|
+
*/
|
|
35
|
+
team_id: string;
|
|
36
|
+
/**
|
|
37
|
+
* @description If the playbook run was created from a post,
|
|
38
|
+
* this field contains the identifier of such post.
|
|
39
|
+
* If not, this field is empty.
|
|
40
|
+
*
|
|
41
|
+
* @default ""
|
|
42
|
+
*/
|
|
43
|
+
post_id?: string | "";
|
|
44
|
+
/**
|
|
45
|
+
* @description The identifier of the playbook with from which this playbook run was created.
|
|
46
|
+
*/
|
|
47
|
+
playbook_id: string;
|
|
48
|
+
}
|
|
49
|
+
export interface PlaybookRunsListArguments extends TokenOverridable, TeamID, Paginated, Directionable {
|
|
50
|
+
/**
|
|
51
|
+
* @description Number of playbook runs to return per page.
|
|
52
|
+
*
|
|
53
|
+
* @default 1000
|
|
54
|
+
*/
|
|
55
|
+
per_page?: number;
|
|
56
|
+
/**
|
|
57
|
+
* @description Field to sort the returned playbook runs by.
|
|
58
|
+
*
|
|
59
|
+
* @default "create_at"
|
|
60
|
+
*/
|
|
61
|
+
sort?: "id" | "name" | "is_active" | "create_at" | "end_at" | "team_id" | "owner_user_id";
|
|
62
|
+
/**
|
|
63
|
+
* @description Direction (ascending or descending) followed by the sorting of the playbook runs.
|
|
64
|
+
*
|
|
65
|
+
* @default "desc"
|
|
66
|
+
*/
|
|
67
|
+
direction?: "desc" | "asc";
|
|
68
|
+
/**
|
|
69
|
+
* @description The returned list will contain only the playbook runs with the specified statuses.
|
|
70
|
+
*/
|
|
71
|
+
statuses?: ("InProgress" | "Finished")[];
|
|
72
|
+
/**
|
|
73
|
+
* @description The returned list will contain only the playbook runs commanded by this user.
|
|
74
|
+
* Specify "me" for current user.
|
|
75
|
+
*/
|
|
76
|
+
owner_user_id?: string;
|
|
77
|
+
/**
|
|
78
|
+
* @description The returned list will contain only the playbook runs for
|
|
79
|
+
* which the given user is a participant.
|
|
80
|
+
*
|
|
81
|
+
* Specify "me" for current user.
|
|
82
|
+
*/
|
|
83
|
+
participant_id?: string | "me";
|
|
84
|
+
/**
|
|
85
|
+
* @description The returned list will contain only the playbook runs whose name contains the search term.
|
|
86
|
+
*/
|
|
87
|
+
search_term?: string;
|
|
88
|
+
}
|
|
89
|
+
//# sourceMappingURL=playbook-runs.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playbook-runs.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/playbook-runs.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,aAAa,EACb,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;;;GAIG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IACjE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA4B,SAAQ,gBAAgB,EAAE,MAAM;IAC5E;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,yBAChB,SAAQ,gBAAgB,EACvB,MAAM,EACN,SAAS,EACT,aAAa;IACd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EACF,IAAI,GACJ,MAAM,GACN,WAAW,GACX,WAAW,GACX,QAAQ,GACR,SAAS,GACT,eAAe,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,YAAY,GAAG,UAAU,CAAC,EAAE,CAAC;IAEzC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playbook-runs.methods.js","sourceRoot":"","sources":["../../../src/types/methods/playbook-runs.methods.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
import type { Playbook, PlaybookChecklist, PlaybookTask } from "../playbooks";
|
|
2
|
+
import type { Directionable, Paginated, TeamID, TokenOverridable } from "./common.methods";
|
|
3
|
+
/**
|
|
4
|
+
* List all playbooks
|
|
5
|
+
*
|
|
6
|
+
* @description Retrieve a paged list of playbooks, filtered by team,
|
|
7
|
+
* and sorted by title, number of stages or number of steps.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link https://developers.loop.ru/API/4.0.0/get-playbooks | List playbooks}
|
|
10
|
+
*/
|
|
11
|
+
export interface PlaybooksListArguments extends TokenOverridable, TeamID, Paginated, Directionable {
|
|
12
|
+
/**
|
|
13
|
+
* @description ID of the team to filter by.
|
|
14
|
+
*
|
|
15
|
+
* @example 08fmfasq5wit3qyfmq4mjk0rto
|
|
16
|
+
*/
|
|
17
|
+
team_id: string;
|
|
18
|
+
/**
|
|
19
|
+
* @description Number of playbooks to return per page.
|
|
20
|
+
* @default 1000
|
|
21
|
+
*/
|
|
22
|
+
per_page?: number;
|
|
23
|
+
/**
|
|
24
|
+
* @description Field to sort the returned playbooks by title,
|
|
25
|
+
* number of stages or total number of steps.
|
|
26
|
+
* @default "title"
|
|
27
|
+
*/
|
|
28
|
+
sort?: "title" | "stages" | "steps";
|
|
29
|
+
/**
|
|
30
|
+
* @description Direction (ascending or descending) followed by the sorting of the playbooks.
|
|
31
|
+
*
|
|
32
|
+
* @default "asc"
|
|
33
|
+
*/
|
|
34
|
+
direction?: "desc" | "asc";
|
|
35
|
+
/**
|
|
36
|
+
* @description Includes archived playbooks in the result.
|
|
37
|
+
*/
|
|
38
|
+
with_archived?: boolean;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* @description Get a playbook type
|
|
42
|
+
*
|
|
43
|
+
* @see {@link https://developers.loop.ru/API/4.0.0/get-playbook | Get a playbook}
|
|
44
|
+
*/
|
|
45
|
+
export interface PlaybooksGetArguments extends TokenOverridable {
|
|
46
|
+
id: string;
|
|
47
|
+
}
|
|
48
|
+
export interface CreatePlaybookTask extends Partial<Pick<PlaybookTask, "title" | "command" | "description">> {
|
|
49
|
+
title: Required<string>;
|
|
50
|
+
}
|
|
51
|
+
export interface CreatePlaybookChecklist extends Pick<PlaybookChecklist, "title"> {
|
|
52
|
+
items: CreatePlaybookTask;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Create a playbook types
|
|
56
|
+
*
|
|
57
|
+
* @description Create a playbook
|
|
58
|
+
*
|
|
59
|
+
* @see {@link https://developers.loop.ru/API/4.0.0/create-playbook | Create a playbook}
|
|
60
|
+
*/
|
|
61
|
+
export interface PlaybooksCreateArguments extends TokenOverridable, TeamID {
|
|
62
|
+
/**
|
|
63
|
+
* @description The title of the playbook.
|
|
64
|
+
*/
|
|
65
|
+
title: string;
|
|
66
|
+
/**
|
|
67
|
+
* @description The description of the playbook.
|
|
68
|
+
*/
|
|
69
|
+
description?: string;
|
|
70
|
+
/**
|
|
71
|
+
* @description A boolean indicating whether the playbook runs created from this playbook should be public or private.
|
|
72
|
+
*/
|
|
73
|
+
create_public_playbook_run: boolean;
|
|
74
|
+
/**
|
|
75
|
+
* @description The stages defined by this playbook.
|
|
76
|
+
*/
|
|
77
|
+
checklists: CreatePlaybookChecklist[];
|
|
78
|
+
/**
|
|
79
|
+
* @description The identifiers of all the users that are members of this playbook.
|
|
80
|
+
*/
|
|
81
|
+
member_ids: string[];
|
|
82
|
+
/**
|
|
83
|
+
* @description The IDs of the channels where all the status updates will be broadcasted.
|
|
84
|
+
* The team of the broadcast channel must be the same as the playbook's team.
|
|
85
|
+
*/
|
|
86
|
+
broadcast_channel_ids?: string[];
|
|
87
|
+
/**
|
|
88
|
+
* @description A list with the IDs of the members to be automatically invited to
|
|
89
|
+
* the playbook run's channel as soon as the playbook run is created.
|
|
90
|
+
*/
|
|
91
|
+
invited_user_ids?: string[];
|
|
92
|
+
/**
|
|
93
|
+
* @description Boolean that indicates whether the members declared in
|
|
94
|
+
* invited_user_ids will be automatically invited.
|
|
95
|
+
*/
|
|
96
|
+
invite_users_enabled?: boolean;
|
|
97
|
+
/**
|
|
98
|
+
* @description User ID of the member that will be automatically assigned as owner as soon as the playbook run is created.
|
|
99
|
+
* If the member is not part of the playbook run's channel or is not included in the invited_user_ids list, they will be automatically invited to the channel.
|
|
100
|
+
*/
|
|
101
|
+
default_owner_id?: string;
|
|
102
|
+
/**
|
|
103
|
+
* @description Boolean that indicates whether the member declared in default_owner_id will be automatically assigned as owner.
|
|
104
|
+
*/
|
|
105
|
+
default_owner_enabled?: boolean;
|
|
106
|
+
/**
|
|
107
|
+
* @description ID of the channel where the playbook run will be automatically announced as soon as the playbook run is created.
|
|
108
|
+
*/
|
|
109
|
+
announcement_channel_id?: string;
|
|
110
|
+
/**
|
|
111
|
+
* @description Boolean that indicates whether the playbook run creation will be announced in the channel declared in announcement_channel_id.
|
|
112
|
+
*/
|
|
113
|
+
announcement_channel_enabled?: boolean;
|
|
114
|
+
/**
|
|
115
|
+
* @description An absolute URL where a POST request will be sent as soon as the playbook run is created.
|
|
116
|
+
* The allowed protocols are HTTP and HTTPS.
|
|
117
|
+
*/
|
|
118
|
+
webhook_on_creation_url?: string;
|
|
119
|
+
/**
|
|
120
|
+
* @description Boolean that indicates whether the webhook declared in webhook_on_creation_url will be automatically sent.
|
|
121
|
+
*/
|
|
122
|
+
webhook_on_creation_enabled?: boolean;
|
|
123
|
+
/**
|
|
124
|
+
* @description An absolute URL where a POST request will be sent as soon as the playbook run's status is updated.
|
|
125
|
+
* The allowed protocols are HTTP and HTTPS.
|
|
126
|
+
*/
|
|
127
|
+
webhook_on_status_update_url?: string;
|
|
128
|
+
/**
|
|
129
|
+
* @description Boolean that indicates whether the webhook declared in webhook_on_status_update_url will be automatically sent.
|
|
130
|
+
*/
|
|
131
|
+
webhook_on_status_update_enabled?: boolean;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Update a playbook
|
|
135
|
+
*
|
|
136
|
+
* @description Update a playbook
|
|
137
|
+
*
|
|
138
|
+
* @see {@link https://developers.loop.ru/API/4.0.0/update-playbook | Update a playbook}
|
|
139
|
+
*/
|
|
140
|
+
export interface PlaybooksUpdateArguments extends TokenOverridable, Pick<Playbook, "id" | "title" | "description" | "team_id" | "create_public_playbook_run" | "create_at" | "delete_at" | "num_stages" | "num_steps" | "checklists" | "member_ids"> {
|
|
141
|
+
id: string;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Delete a playbook
|
|
145
|
+
*
|
|
146
|
+
* @description Delete a playbook
|
|
147
|
+
*
|
|
148
|
+
* @see {@link https://developers.loop.ru/API/4.0.0/delete-playbook | Delete a playbook}
|
|
149
|
+
*/
|
|
150
|
+
export interface PlaybooksDeleteArguments extends TokenOverridable {
|
|
151
|
+
/**
|
|
152
|
+
* @description ID of the playbook to delete.
|
|
153
|
+
*/
|
|
154
|
+
id: string;
|
|
155
|
+
}
|
|
156
|
+
//# sourceMappingURL=playbooks.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playbooks.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/playbooks.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,KAAK,EACX,aAAa,EACb,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;GAOG;AACH,MAAM,WAAW,sBAChB,SAAQ,gBAAgB,EACvB,MAAM,EACN,SAAS,EACT,aAAa;IACd;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC9D,EAAE,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,kBAChB,SAAQ,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,SAAS,GAAG,aAAa,CAAC,CAAC;IACxE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CACxB;AACD,MAAM,WAAW,uBAChB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACxC,KAAK,EAAE,kBAAkB,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB,EAAE,MAAM;IACzE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,uBAAuB,EAAE,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC3C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAChB,SAAQ,gBAAgB,EACvB,IAAI,CACH,QAAQ,EACN,IAAI,GACJ,OAAO,GACP,aAAa,GACb,SAAS,GACT,4BAA4B,GAC5B,WAAW,GACX,WAAW,GACX,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,YAAY,CACd;IACF,EAAE,EAAE,MAAM,CAAC;CACX;AAED;;;;;;GAMG;AACH,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IACjE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACX"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"playbooks.methods.js","sourceRoot":"","sources":["../../../src/types/methods/playbooks.methods.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { Stream } from "form-data";
|
|
2
|
+
export interface PluginsUploadArguments {
|
|
3
|
+
plugin: Stream | Buffer;
|
|
4
|
+
force?: boolean;
|
|
5
|
+
}
|
|
6
|
+
export interface PluginsInstallFromUrlArguments {
|
|
7
|
+
plugin_download_url: string;
|
|
8
|
+
force?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface PluginsRemoveArguments {
|
|
11
|
+
plugin_id: string;
|
|
12
|
+
}
|
|
13
|
+
export interface PluginsEnableArguments {
|
|
14
|
+
plugin_id: string;
|
|
15
|
+
}
|
|
16
|
+
export interface PluginsDisableArguments {
|
|
17
|
+
plugin_id: string;
|
|
18
|
+
}
|
|
19
|
+
export type PluginsGetWebAppArguments = never;
|
|
20
|
+
export interface PluginsGetMarketplaceArguments {
|
|
21
|
+
page?: number;
|
|
22
|
+
per_page?: number;
|
|
23
|
+
filter?: string;
|
|
24
|
+
server_version?: string;
|
|
25
|
+
local_only?: boolean;
|
|
26
|
+
}
|
|
27
|
+
export interface PluginsInstallFromMarketplaceArguments {
|
|
28
|
+
id: string;
|
|
29
|
+
version: string;
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=plugins.methods.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugins.methods.d.ts","sourceRoot":"","sources":["../../../src/types/methods/plugins.methods.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExC,MAAM,WAAW,sBAAsB;IACtC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC9C,mBAAmB,EAAE,MAAM,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACtC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACtC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,uBAAuB;IACvC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC;AAE9C,MAAM,WAAW,8BAA8B;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,sCAAsC;IACtD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CAChB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugins.methods.js","sourceRoot":"","sources":["../../../src/types/methods/plugins.methods.ts"],"names":[],"mappings":""}
|