1 | /// <reference types="node" />
|
2 | /// <reference types="node" />
|
3 | import { Stream } from 'node:stream';
|
4 | import { TokenOverridable, CursorPaginationEnabled, OptionalTeamAssignable, LocaleAware } from './common';
|
5 | export interface UsersConversationsArguments extends TokenOverridable, CursorPaginationEnabled, OptionalTeamAssignable {
|
6 | /** @description Set to `true` to exclude archived channels from the list. Default is `false`. */
|
7 | exclude_archived?: boolean;
|
8 | /**
|
9 | * @description Mix and match channel types by providing a comma-separated list of any combination of
|
10 | * `public_channel`, `private_channel`, `mpim` and `im`. Defaults to `public_channel`.
|
11 | */
|
12 | types?: string;
|
13 | /**
|
14 | * @description Browse conversations by a specific user ID's membership.
|
15 | * Non-public channels are restricted to those where the calling user shares membership.
|
16 | */
|
17 | user?: string;
|
18 | }
|
19 | export interface UsersDeletePhotoArguments extends TokenOverridable {
|
20 | }
|
21 | export interface UsersGetPresenceArguments extends TokenOverridable {
|
22 | /** @description User to get presence info on. Defaults to the authed user. */
|
23 | user?: string;
|
24 | }
|
25 | export interface UsersIdentityArguments extends TokenOverridable {
|
26 | }
|
27 | export interface UsersInfoArguments extends TokenOverridable, LocaleAware {
|
28 | /** @description User to get info on. */
|
29 | user: string;
|
30 | }
|
31 | export interface UsersListArguments extends TokenOverridable, CursorPaginationEnabled, LocaleAware, OptionalTeamAssignable {
|
32 | }
|
33 | export interface UsersLookupByEmailArguments extends TokenOverridable {
|
34 | /** @description An email address belonging to a user in the workspace */
|
35 | email: string;
|
36 | }
|
37 | export interface UsersSetPhotoArguments extends TokenOverridable {
|
38 | /** @description Image file contents. */
|
39 | image: Buffer | Stream;
|
40 | /** @description Width/height of crop box (always square). */
|
41 | crop_w?: number;
|
42 | /** @description X coordinate of top-left corner of crop box. */
|
43 | crop_x?: number;
|
44 | /** @description Y coordinate of top-left corner of crop box. */
|
45 | crop_y?: number;
|
46 | }
|
47 | export interface UsersSetPresenceArguments extends TokenOverridable {
|
48 | /** @description Either `auto` or `away`. */
|
49 | presence: 'auto' | 'away';
|
50 | }
|
51 | export interface UsersProfileGetArguments extends TokenOverridable {
|
52 | /**
|
53 | * @description Include labels for each ID in custom profile fields.
|
54 | * Using this parameter will heavily rate-limit your requests and is not recommended. Defaults to `false`.
|
55 | */
|
56 | include_labels?: boolean;
|
57 | /** @description User to retrieve profile info for. */
|
58 | user?: string;
|
59 | }
|
60 | export interface UsersProfileSetArguments extends TokenOverridable {
|
61 | /**
|
62 | * @description Sets profile fields using a single argument.
|
63 | * Collection of key:value pairs presented.
|
64 | * At most 50 fields may be set. Each field name is limited to 255 characters.
|
65 | * @see {@link https://api.slack.com/methods/users.profile.set#profile-fields `users.profile.set` Profile fields usage info}.
|
66 | */
|
67 | profile?: Record<string, unknown>;
|
68 | /** @description ID of user to change. This argument may only be specified by admins on paid teams. */
|
69 | user?: string;
|
70 | /**
|
71 | * @description Name of a single profile field to set. If both `name` and `profile` are set, `name` takes precedence.
|
72 | * @see {@link https://api.slack.com/methods/users.profile.set#profile-fields `users.profile.set` Profile fields usage info}.
|
73 | */
|
74 | name?: string;
|
75 | /**
|
76 | * @description Value to set for the profile field specified by `name`. Usable only if profile is not passed.
|
77 | * @see {@link https://api.slack.com/methods/users.profile.set#profile-fields `users.profile.set` Profile fields usage info}.
|
78 | */
|
79 | value?: string;
|
80 | }
|
81 | //# sourceMappingURL=users.d.ts.map |
\ | No newline at end of file |