@wildix/xbees-users-client 1.2.3 → 1.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist-types/commands/AddIdentityCommand.d.ts +93 -0
  2. package/dist-types/commands/BatchGetUsersCommand.d.ts +110 -0
  3. package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +95 -0
  4. package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +146 -0
  5. package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +146 -0
  6. package/dist-types/commands/ChangeUserEmailCommand.d.ts +100 -0
  7. package/dist-types/commands/CreateBotApiKeyCommand.d.ts +108 -0
  8. package/dist-types/commands/CreateBotCommand.d.ts +210 -0
  9. package/dist-types/commands/CreateSystemBotCommand.d.ts +90 -0
  10. package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +92 -0
  11. package/dist-types/commands/DeleteBotCommand.d.ts +89 -0
  12. package/dist-types/commands/GetAccountCommand.d.ts +182 -0
  13. package/dist-types/commands/GetAppVersionCommand.d.ts +88 -0
  14. package/dist-types/commands/GetBotCallbackCommand.d.ts +196 -0
  15. package/dist-types/commands/GetBotCommand.d.ts +102 -0
  16. package/dist-types/commands/GetUserCommand.d.ts +108 -0
  17. package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +93 -0
  18. package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +144 -0
  19. package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +91 -0
  20. package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +91 -0
  21. package/dist-types/commands/IntelligenceSearchCommand.d.ts +97 -0
  22. package/dist-types/commands/InviteCommand.d.ts +116 -0
  23. package/dist-types/commands/ListAccountIdentitiesCommand.d.ts +94 -0
  24. package/dist-types/commands/ListBotApiKeysCommand.d.ts +95 -0
  25. package/dist-types/commands/ListBotsCommand.d.ts +101 -0
  26. package/dist-types/commands/ListWorkspacesCommand.d.ts +170 -0
  27. package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
  28. package/dist-types/commands/QueryColleaguesCommand.d.ts +164 -0
  29. package/dist-types/commands/QueryUserCommand.d.ts +117 -0
  30. package/dist-types/commands/QueryUsersCommand.d.ts +117 -0
  31. package/dist-types/commands/RemoveIdentityCommand.d.ts +87 -0
  32. package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +87 -0
  33. package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +87 -0
  34. package/dist-types/commands/UnbindWorkspaceCommand.d.ts +87 -0
  35. package/dist-types/commands/UpdateAccountCommand.d.ts +94 -0
  36. package/dist-types/commands/UpdateBotCallbackCommand.d.ts +300 -0
  37. package/dist-types/commands/UpdateBotCommand.d.ts +105 -0
  38. package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
  39. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +171 -0
  40. package/dist-types/commands/UploadPictureCommand.d.ts +88 -0
  41. package/dist-types/commands/UploadPictureV1Command.d.ts +90 -0
  42. package/dist-types/commands/VerifyAddIdentityCommand.d.ts +95 -0
  43. package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +92 -0
  44. package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +92 -0
  45. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  46. package/dist-types/runtimeConfig.d.ts +1 -1
  47. package/dist-types/runtimeConfig.native.d.ts +1 -1
  48. package/package.json +2 -2
@@ -0,0 +1,116 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { InviteInput, InviteOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link InviteCommand}.
14
+ */
15
+ export interface InviteCommandInput extends InviteInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link InviteCommand}.
21
+ */
22
+ export interface InviteCommandOutput extends InviteOutput, __MetadataBearer {
23
+ }
24
+ declare const InviteCommand_base: {
25
+ new (input: InviteCommandInput): import("@smithy/smithy-client").CommandImpl<InviteCommandInput, InviteCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: InviteCommandInput): import("@smithy/smithy-client").CommandImpl<InviteCommandInput, InviteCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Invite a list of users to x-bees. This operation creates an account for specified emails or phone numbers. Use this method to create users who can be added to conversations later.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, InviteCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, InviteCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // InviteInput
38
+ * companyId: "STRING_VALUE",
39
+ * invitees: [ // UsersToInviteList // required
40
+ * { // UserToInvite
41
+ * email: "STRING_VALUE",
42
+ * phone: "STRING_VALUE",
43
+ * name: "STRING_VALUE",
44
+ * colleague: true || false,
45
+ * },
46
+ * ],
47
+ * };
48
+ * const command = new InviteCommand(input);
49
+ * const response = await client.send(command);
50
+ * // { // InviteOutput
51
+ * // users: [ // UsersList // required
52
+ * // { // User
53
+ * // id: "STRING_VALUE", // required
54
+ * // name: "STRING_VALUE",
55
+ * // email: "STRING_VALUE",
56
+ * // phone: "STRING_VALUE",
57
+ * // picture: "STRING_VALUE",
58
+ * // locale: "STRING_VALUE",
59
+ * // timeZone: "STRING_VALUE",
60
+ * // company: "STRING_VALUE",
61
+ * // bot: true || false,
62
+ * // pbxDomain: "STRING_VALUE",
63
+ * // pbxPort: "STRING_VALUE",
64
+ * // pbxExtension: "STRING_VALUE",
65
+ * // pbxSerial: "STRING_VALUE",
66
+ * // pbxUserId: "STRING_VALUE",
67
+ * // pbxGroupId: "STRING_VALUE",
68
+ * // createdAt: "STRING_VALUE",
69
+ * // updatedAt: "STRING_VALUE",
70
+ * // },
71
+ * // ],
72
+ * // };
73
+ *
74
+ * ```
75
+ *
76
+ * @param InviteCommandInput - {@link InviteCommandInput}
77
+ * @returns {@link InviteCommandOutput}
78
+ * @see {@link InviteCommandInput} for command's `input` shape.
79
+ * @see {@link InviteCommandOutput} for command's `response` shape.
80
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
81
+ *
82
+ * @throws {@link ForbiddenException} (client fault)
83
+ *
84
+ * @throws {@link ValidationException} (client fault)
85
+ *
86
+ * @throws {@link AccountNotFoundException} (client fault)
87
+ *
88
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
89
+ *
90
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
91
+ *
92
+ * @throws {@link WorkspaceNotFoundException} (client fault)
93
+ *
94
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
95
+ *
96
+ * @throws {@link IdentityNotFoundException} (client fault)
97
+ *
98
+ * @throws {@link UsersServiceException}
99
+ * <p>Base exception class for all service exceptions from Users service.</p>
100
+ *
101
+ *
102
+ * @public
103
+ */
104
+ export declare class InviteCommand extends InviteCommand_base {
105
+ /** @internal type navigation helper, not in runtime. */
106
+ protected static __types: {
107
+ api: {
108
+ input: InviteInput;
109
+ output: InviteOutput;
110
+ };
111
+ sdk: {
112
+ input: InviteCommandInput;
113
+ output: InviteCommandOutput;
114
+ };
115
+ };
116
+ }
@@ -0,0 +1,94 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ListAccountIdentitiesInput, ListAccountIdentitiesOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListAccountIdentitiesCommand}.
14
+ */
15
+ export interface ListAccountIdentitiesCommandInput extends ListAccountIdentitiesInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAccountIdentitiesCommand}.
21
+ */
22
+ export interface ListAccountIdentitiesCommandOutput extends ListAccountIdentitiesOutput, __MetadataBearer {
23
+ }
24
+ declare const ListAccountIdentitiesCommand_base: {
25
+ new (input: ListAccountIdentitiesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAccountIdentitiesCommandInput, ListAccountIdentitiesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListAccountIdentitiesCommandInput): import("@smithy/smithy-client").CommandImpl<ListAccountIdentitiesCommandInput, ListAccountIdentitiesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Lists all identities (login methods) for the current account.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, ListAccountIdentitiesCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ListAccountIdentitiesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ListAccountIdentitiesInput
38
+ * accountId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new ListAccountIdentitiesCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListAccountIdentitiesOutput
43
+ * // identities: [ // IdentityList // required
44
+ * // { // Identity
45
+ * // identity: "STRING_VALUE", // required
46
+ * // account: "STRING_VALUE", // required
47
+ * // verified: true || false,
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param ListAccountIdentitiesCommandInput - {@link ListAccountIdentitiesCommandInput}
55
+ * @returns {@link ListAccountIdentitiesCommandOutput}
56
+ * @see {@link ListAccountIdentitiesCommandInput} for command's `input` shape.
57
+ * @see {@link ListAccountIdentitiesCommandOutput} for command's `response` shape.
58
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
59
+ *
60
+ * @throws {@link AccountNotFoundException} (client fault)
61
+ *
62
+ * @throws {@link ForbiddenException} (client fault)
63
+ *
64
+ * @throws {@link ValidationException} (client fault)
65
+ *
66
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
67
+ *
68
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
69
+ *
70
+ * @throws {@link WorkspaceNotFoundException} (client fault)
71
+ *
72
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
73
+ *
74
+ * @throws {@link IdentityNotFoundException} (client fault)
75
+ *
76
+ * @throws {@link UsersServiceException}
77
+ * <p>Base exception class for all service exceptions from Users service.</p>
78
+ *
79
+ *
80
+ * @public
81
+ */
82
+ export declare class ListAccountIdentitiesCommand extends ListAccountIdentitiesCommand_base {
83
+ /** @internal type navigation helper, not in runtime. */
84
+ protected static __types: {
85
+ api: {
86
+ input: ListAccountIdentitiesInput;
87
+ output: ListAccountIdentitiesOutput;
88
+ };
89
+ sdk: {
90
+ input: ListAccountIdentitiesCommandInput;
91
+ output: ListAccountIdentitiesCommandOutput;
92
+ };
93
+ };
94
+ }
@@ -0,0 +1,95 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ListBotApiKeysInput, ListBotApiKeysOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListBotApiKeysCommand}.
14
+ */
15
+ export interface ListBotApiKeysCommandInput extends ListBotApiKeysInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListBotApiKeysCommand}.
21
+ */
22
+ export interface ListBotApiKeysCommandOutput extends ListBotApiKeysOutput, __MetadataBearer {
23
+ }
24
+ declare const ListBotApiKeysCommand_base: {
25
+ new (input: ListBotApiKeysCommandInput): import("@smithy/smithy-client").CommandImpl<ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListBotApiKeysCommandInput): import("@smithy/smithy-client").CommandImpl<ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves a list of API keys associated with a specific bot.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, ListBotApiKeysCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ListBotApiKeysCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ListBotApiKeysInput
38
+ * company: "STRING_VALUE",
39
+ * botId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new ListBotApiKeysCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // ListBotApiKeysOutput
44
+ * // keys: [ // BotApiKeysList // required
45
+ * // { // BotApiKey
46
+ * // secret: "STRING_VALUE", // required
47
+ * // name: "STRING_VALUE",
48
+ * // createdAt: "STRING_VALUE", // required
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param ListBotApiKeysCommandInput - {@link ListBotApiKeysCommandInput}
56
+ * @returns {@link ListBotApiKeysCommandOutput}
57
+ * @see {@link ListBotApiKeysCommandInput} for command's `input` shape.
58
+ * @see {@link ListBotApiKeysCommandOutput} for command's `response` shape.
59
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
60
+ *
61
+ * @throws {@link ForbiddenException} (client fault)
62
+ *
63
+ * @throws {@link ValidationException} (client fault)
64
+ *
65
+ * @throws {@link AccountNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
68
+ *
69
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
70
+ *
71
+ * @throws {@link WorkspaceNotFoundException} (client fault)
72
+ *
73
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
74
+ *
75
+ * @throws {@link IdentityNotFoundException} (client fault)
76
+ *
77
+ * @throws {@link UsersServiceException}
78
+ * <p>Base exception class for all service exceptions from Users service.</p>
79
+ *
80
+ *
81
+ * @public
82
+ */
83
+ export declare class ListBotApiKeysCommand extends ListBotApiKeysCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: ListBotApiKeysInput;
88
+ output: ListBotApiKeysOutput;
89
+ };
90
+ sdk: {
91
+ input: ListBotApiKeysCommandInput;
92
+ output: ListBotApiKeysCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -0,0 +1,101 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ListBotsInput, ListBotsOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListBotsCommand}.
14
+ */
15
+ export interface ListBotsCommandInput extends ListBotsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListBotsCommand}.
21
+ */
22
+ export interface ListBotsCommandOutput extends ListBotsOutput, __MetadataBearer {
23
+ }
24
+ declare const ListBotsCommand_base: {
25
+ new (input: ListBotsCommandInput): import("@smithy/smithy-client").CommandImpl<ListBotsCommandInput, ListBotsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListBotsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListBotsCommandInput, ListBotsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves a list of all bots for the specified company.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, ListBotsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ListBotsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ListBotsInput
38
+ * company: "STRING_VALUE",
39
+ * };
40
+ * const command = new ListBotsCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListBotsOutput
43
+ * // bots: [ // BotList // required
44
+ * // { // Bot
45
+ * // name: "STRING_VALUE", // required
46
+ * // category: "STRING_VALUE",
47
+ * // picture: "STRING_VALUE",
48
+ * // searchable: true || false,
49
+ * // access: "EVERYBODY" || "ORGANIZATION",
50
+ * // id: "STRING_VALUE", // required
51
+ * // integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
52
+ * // integrationApiKeysCount: Number("int"), // required
53
+ * // createdAt: "STRING_VALUE", // required
54
+ * // updated: "STRING_VALUE",
55
+ * // },
56
+ * // ],
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ListBotsCommandInput - {@link ListBotsCommandInput}
62
+ * @returns {@link ListBotsCommandOutput}
63
+ * @see {@link ListBotsCommandInput} for command's `input` shape.
64
+ * @see {@link ListBotsCommandOutput} for command's `response` shape.
65
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
66
+ *
67
+ * @throws {@link ForbiddenException} (client fault)
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ *
71
+ * @throws {@link AccountNotFoundException} (client fault)
72
+ *
73
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
74
+ *
75
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
76
+ *
77
+ * @throws {@link WorkspaceNotFoundException} (client fault)
78
+ *
79
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
80
+ *
81
+ * @throws {@link IdentityNotFoundException} (client fault)
82
+ *
83
+ * @throws {@link UsersServiceException}
84
+ * <p>Base exception class for all service exceptions from Users service.</p>
85
+ *
86
+ *
87
+ * @public
88
+ */
89
+ export declare class ListBotsCommand extends ListBotsCommand_base {
90
+ /** @internal type navigation helper, not in runtime. */
91
+ protected static __types: {
92
+ api: {
93
+ input: ListBotsInput;
94
+ output: ListBotsOutput;
95
+ };
96
+ sdk: {
97
+ input: ListBotsCommandInput;
98
+ output: ListBotsCommandOutput;
99
+ };
100
+ };
101
+ }
@@ -0,0 +1,170 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { ListWorkspacesInput, ListWorkspacesOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListWorkspacesCommand}.
14
+ */
15
+ export interface ListWorkspacesCommandInput extends ListWorkspacesInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListWorkspacesCommand}.
21
+ */
22
+ export interface ListWorkspacesCommandOutput extends ListWorkspacesOutput, __MetadataBearer {
23
+ }
24
+ declare const ListWorkspacesCommand_base: {
25
+ new (input: ListWorkspacesCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspacesCommandInput, ListWorkspacesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ListWorkspacesCommandInput): import("@smithy/smithy-client").CommandImpl<ListWorkspacesCommandInput, ListWorkspacesCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Lists all workspaces available to the account.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, ListWorkspacesCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, ListWorkspacesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // ListWorkspacesInput
38
+ * accountId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new ListWorkspacesCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // ListWorkspacesOutput
43
+ * // workspaces: [ // WorkspaceList // required
44
+ * // { // Workspace
45
+ * // companyId: "STRING_VALUE",
46
+ * // pbxUser: { // UserPbxLinkData
47
+ * // id: "STRING_VALUE", // required
48
+ * // company: "STRING_VALUE", // required
49
+ * // companyName: "STRING_VALUE",
50
+ * // domain: "STRING_VALUE", // required
51
+ * // email: "STRING_VALUE",
52
+ * // info: { // UserPersonalInfo
53
+ * // dn: "STRING_VALUE", // required
54
+ * // id: "STRING_VALUE", // required
55
+ * // name: "STRING_VALUE", // required
56
+ * // extension: "STRING_VALUE", // required
57
+ * // officePhone: "STRING_VALUE",
58
+ * // mobilePhone: "STRING_VALUE",
59
+ * // faxNumber: "STRING_VALUE",
60
+ * // email: "STRING_VALUE",
61
+ * // role: "STRING_VALUE", // required
62
+ * // language: "STRING_VALUE", // required
63
+ * // dialplan: "STRING_VALUE", // required
64
+ * // faxDialplan: "STRING_VALUE", // required
65
+ * // departament: "STRING_VALUE",
66
+ * // picture: "STRING_VALUE", // required
67
+ * // groupDn: "STRING_VALUE", // required
68
+ * // groupName: "STRING_VALUE", // required
69
+ * // jid: "STRING_VALUE", // required
70
+ * // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
71
+ * // login: "STRING_VALUE",
72
+ * // pbx: "STRING_VALUE",
73
+ * // pbxDn: "STRING_VALUE", // required
74
+ * // sourceId: "STRING_VALUE",
75
+ * // sipPassword: "STRING_VALUE",
76
+ * // },
77
+ * // pbx: { // UserPbxInfo
78
+ * // networkAddresses: [ // UserPbxInfoNetworkAddresses // required
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // ports: [ // UserPbxInfoPorts // required
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // externalLinePrefix: "STRING_VALUE",
85
+ * // version: "STRING_VALUE", // required
86
+ * // serial: "STRING_VALUE", // required
87
+ * // },
88
+ * // picture: "STRING_VALUE", // required
89
+ * // pictureDeleted: true || false,
90
+ * // port: "STRING_VALUE", // required
91
+ * // serial: "STRING_VALUE", // required
92
+ * // services: { // UserPbxServices
93
+ * // xcaracal: true || false,
94
+ * // wizyWebinar: true || false,
95
+ * // },
96
+ * // personalSettings: {},
97
+ * // dialplanSettings: {},
98
+ * // awsRegion: "STRING_VALUE",
99
+ * // updatedAt: "STRING_VALUE",
100
+ * // },
101
+ * // streamUser: { // User
102
+ * // id: "STRING_VALUE", // required
103
+ * // name: "STRING_VALUE",
104
+ * // email: "STRING_VALUE",
105
+ * // phone: "STRING_VALUE",
106
+ * // picture: "STRING_VALUE",
107
+ * // locale: "STRING_VALUE",
108
+ * // timeZone: "STRING_VALUE",
109
+ * // company: "STRING_VALUE",
110
+ * // bot: true || false,
111
+ * // pbxDomain: "STRING_VALUE",
112
+ * // pbxPort: "STRING_VALUE",
113
+ * // pbxExtension: "STRING_VALUE",
114
+ * // pbxSerial: "STRING_VALUE",
115
+ * // pbxUserId: "STRING_VALUE",
116
+ * // pbxGroupId: "STRING_VALUE",
117
+ * // createdAt: "STRING_VALUE",
118
+ * // updatedAt: "STRING_VALUE",
119
+ * // },
120
+ * // type: "personal" || "work" || "support",
121
+ * // id: "STRING_VALUE", // required
122
+ * // accountId: "STRING_VALUE", // required
123
+ * // active: true || false, // required
124
+ * // },
125
+ * // ],
126
+ * // };
127
+ *
128
+ * ```
129
+ *
130
+ * @param ListWorkspacesCommandInput - {@link ListWorkspacesCommandInput}
131
+ * @returns {@link ListWorkspacesCommandOutput}
132
+ * @see {@link ListWorkspacesCommandInput} for command's `input` shape.
133
+ * @see {@link ListWorkspacesCommandOutput} for command's `response` shape.
134
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
135
+ *
136
+ * @throws {@link AccountNotFoundException} (client fault)
137
+ *
138
+ * @throws {@link ForbiddenException} (client fault)
139
+ *
140
+ * @throws {@link ValidationException} (client fault)
141
+ *
142
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
143
+ *
144
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
145
+ *
146
+ * @throws {@link WorkspaceNotFoundException} (client fault)
147
+ *
148
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
149
+ *
150
+ * @throws {@link IdentityNotFoundException} (client fault)
151
+ *
152
+ * @throws {@link UsersServiceException}
153
+ * <p>Base exception class for all service exceptions from Users service.</p>
154
+ *
155
+ *
156
+ * @public
157
+ */
158
+ export declare class ListWorkspacesCommand extends ListWorkspacesCommand_base {
159
+ /** @internal type navigation helper, not in runtime. */
160
+ protected static __types: {
161
+ api: {
162
+ input: ListWorkspacesInput;
163
+ output: ListWorkspacesOutput;
164
+ };
165
+ sdk: {
166
+ input: ListWorkspacesCommandInput;
167
+ output: ListWorkspacesCommandOutput;
168
+ };
169
+ };
170
+ }
@@ -0,0 +1,93 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { PartialUpdateUserEmailNotificationsSettingsInput, PartialUpdateUserEmailNotificationsSettingsOutput } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link PartialUpdateUserEmailNotificationsSettingsCommand}.
14
+ */
15
+ export interface PartialUpdateUserEmailNotificationsSettingsCommandInput extends PartialUpdateUserEmailNotificationsSettingsInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link PartialUpdateUserEmailNotificationsSettingsCommand}.
21
+ */
22
+ export interface PartialUpdateUserEmailNotificationsSettingsCommandOutput extends PartialUpdateUserEmailNotificationsSettingsOutput, __MetadataBearer {
23
+ }
24
+ declare const PartialUpdateUserEmailNotificationsSettingsCommand_base: {
25
+ new (input: PartialUpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: PartialUpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<PartialUpdateUserEmailNotificationsSettingsCommandInput, PartialUpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Partially update user email notifications settings
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, PartialUpdateUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, PartialUpdateUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // PartialUpdateUserEmailNotificationsSettingsInput
38
+ * unread: true || false,
39
+ * transcription: true || false,
40
+ * userId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new PartialUpdateUserEmailNotificationsSettingsCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // PartialUpdateUserEmailNotificationsSettingsOutput
45
+ * // notifications: { // UserEmailNotificationsSettings
46
+ * // unread: true || false, // required
47
+ * // transcription: true || false, // required
48
+ * // },
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param PartialUpdateUserEmailNotificationsSettingsCommandInput - {@link PartialUpdateUserEmailNotificationsSettingsCommandInput}
54
+ * @returns {@link PartialUpdateUserEmailNotificationsSettingsCommandOutput}
55
+ * @see {@link PartialUpdateUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
56
+ * @see {@link PartialUpdateUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
57
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
58
+ *
59
+ * @throws {@link ForbiddenException} (client fault)
60
+ *
61
+ * @throws {@link ValidationException} (client fault)
62
+ *
63
+ * @throws {@link AccountNotFoundException} (client fault)
64
+ *
65
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
66
+ *
67
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
68
+ *
69
+ * @throws {@link WorkspaceNotFoundException} (client fault)
70
+ *
71
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
72
+ *
73
+ * @throws {@link IdentityNotFoundException} (client fault)
74
+ *
75
+ * @throws {@link UsersServiceException}
76
+ * <p>Base exception class for all service exceptions from Users service.</p>
77
+ *
78
+ *
79
+ * @public
80
+ */
81
+ export declare class PartialUpdateUserEmailNotificationsSettingsCommand extends PartialUpdateUserEmailNotificationsSettingsCommand_base {
82
+ /** @internal type navigation helper, not in runtime. */
83
+ protected static __types: {
84
+ api: {
85
+ input: PartialUpdateUserEmailNotificationsSettingsInput;
86
+ output: PartialUpdateUserEmailNotificationsSettingsOutput;
87
+ };
88
+ sdk: {
89
+ input: PartialUpdateUserEmailNotificationsSettingsCommandInput;
90
+ output: PartialUpdateUserEmailNotificationsSettingsCommandOutput;
91
+ };
92
+ };
93
+ }