@wildix/xbees-users-client 1.0.54 → 1.2.2
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/dist-cjs/Users.js +20 -0
- package/dist-cjs/commands/AddIdentityCommand.js +21 -0
- package/dist-cjs/commands/GetAccountCommand.js +21 -0
- package/dist-cjs/commands/InviteCommand.js +21 -0
- package/dist-cjs/commands/ListAccountIdentitiesCommand.js +21 -0
- package/dist-cjs/commands/ListWorkspacesCommand.js +21 -0
- package/dist-cjs/commands/RemoveIdentityCommand.js +21 -0
- package/dist-cjs/commands/UnbindWorkspaceCommand.js +21 -0
- package/dist-cjs/commands/UpdateAccountCommand.js +21 -0
- package/dist-cjs/commands/UpdateWorkspaceCommand.js +21 -0
- package/dist-cjs/commands/VerifyAddIdentityCommand.js +21 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/models/models_0.js +84 -1
- package/dist-cjs/protocols/Aws_restJson1.js +398 -2
- package/dist-es/Users.js +20 -0
- package/dist-es/commands/AddIdentityCommand.js +17 -0
- package/dist-es/commands/GetAccountCommand.js +17 -0
- package/dist-es/commands/InviteCommand.js +17 -0
- package/dist-es/commands/ListAccountIdentitiesCommand.js +17 -0
- package/dist-es/commands/ListWorkspacesCommand.js +17 -0
- package/dist-es/commands/RemoveIdentityCommand.js +17 -0
- package/dist-es/commands/UnbindWorkspaceCommand.js +17 -0
- package/dist-es/commands/UpdateAccountCommand.js +17 -0
- package/dist-es/commands/UpdateWorkspaceCommand.js +17 -0
- package/dist-es/commands/VerifyAddIdentityCommand.js +17 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +77 -0
- package/dist-es/protocols/Aws_restJson1.js +377 -1
- package/dist-types/Users.d.ts +70 -0
- package/dist-types/UsersClient.d.ts +12 -2
- package/dist-types/commands/AddIdentityCommand.d.ts +93 -0
- package/dist-types/commands/BatchGetUsersCommand.d.ts +12 -0
- package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +12 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +12 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +12 -0
- package/dist-types/commands/ChangeUserEmailCommand.d.ts +12 -0
- package/dist-types/commands/CreateBotApiKeyCommand.d.ts +12 -0
- package/dist-types/commands/CreateBotCommand.d.ts +12 -0
- package/dist-types/commands/CreateSystemBotCommand.d.ts +12 -0
- package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +12 -0
- package/dist-types/commands/DeleteBotCommand.d.ts +12 -0
- package/dist-types/commands/GetAccountCommand.d.ts +182 -0
- package/dist-types/commands/GetAppVersionCommand.d.ts +12 -0
- package/dist-types/commands/GetBotCallbackCommand.d.ts +12 -0
- package/dist-types/commands/GetBotCommand.d.ts +12 -0
- package/dist-types/commands/GetUserCommand.d.ts +12 -0
- package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +12 -0
- package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +12 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +12 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +12 -0
- package/dist-types/commands/IntelligenceSearchCommand.d.ts +12 -0
- package/dist-types/commands/InviteCommand.d.ts +116 -0
- package/dist-types/commands/ListAccountIdentitiesCommand.d.ts +94 -0
- package/dist-types/commands/ListBotApiKeysCommand.d.ts +12 -0
- package/dist-types/commands/ListBotsCommand.d.ts +12 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +170 -0
- package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +12 -0
- package/dist-types/commands/QueryColleaguesCommand.d.ts +12 -0
- package/dist-types/commands/QueryUserCommand.d.ts +12 -0
- package/dist-types/commands/QueryUsersCommand.d.ts +12 -0
- package/dist-types/commands/RemoveIdentityCommand.d.ts +87 -0
- package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +12 -0
- package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +12 -0
- package/dist-types/commands/UnbindWorkspaceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateAccountCommand.d.ts +94 -0
- package/dist-types/commands/UpdateBotCallbackCommand.d.ts +12 -0
- package/dist-types/commands/UpdateBotCommand.d.ts +12 -0
- package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +12 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +171 -0
- package/dist-types/commands/UploadPictureCommand.d.ts +12 -0
- package/dist-types/commands/UploadPictureV1Command.d.ts +12 -0
- package/dist-types/commands/VerifyAddIdentityCommand.d.ts +95 -0
- package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +12 -0
- package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +12 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +420 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
- package/package.json +2 -2
|
@@ -58,6 +58,18 @@ declare const GetUserPbxLinkSuggestionCommand_base: {
|
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ValidationException} (client fault)
|
|
60
60
|
*
|
|
61
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
72
|
+
*
|
|
61
73
|
* @throws {@link UsersServiceException}
|
|
62
74
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
63
75
|
*
|
|
@@ -58,6 +58,18 @@ declare const GetUserPbxLinkSuggestionV1Command_base: {
|
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ValidationException} (client fault)
|
|
60
60
|
*
|
|
61
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
72
|
+
*
|
|
61
73
|
* @throws {@link UsersServiceException}
|
|
62
74
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
63
75
|
*
|
|
@@ -64,6 +64,18 @@ declare const IntelligenceSearchCommand_base: {
|
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ValidationException} (client fault)
|
|
66
66
|
*
|
|
67
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
78
|
+
*
|
|
67
79
|
* @throws {@link UsersServiceException}
|
|
68
80
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
69
81
|
*
|
|
@@ -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
|
+
}
|
|
@@ -62,6 +62,18 @@ declare const ListBotApiKeysCommand_base: {
|
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ValidationException} (client fault)
|
|
64
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
|
+
*
|
|
65
77
|
* @throws {@link UsersServiceException}
|
|
66
78
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
67
79
|
*
|
|
@@ -68,6 +68,18 @@ declare const ListBotsCommand_base: {
|
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
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
|
+
*
|
|
71
83
|
* @throws {@link UsersServiceException}
|
|
72
84
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
73
85
|
*
|
|
@@ -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
|
+
}
|
|
@@ -60,6 +60,18 @@ declare const PartialUpdateUserEmailNotificationsSettingsCommand_base: {
|
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link ValidationException} (client fault)
|
|
62
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
|
+
*
|
|
63
75
|
* @throws {@link UsersServiceException}
|
|
64
76
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
65
77
|
*
|
|
@@ -131,6 +131,18 @@ declare const QueryColleaguesCommand_base: {
|
|
|
131
131
|
*
|
|
132
132
|
* @throws {@link ValidationException} (client fault)
|
|
133
133
|
*
|
|
134
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
145
|
+
*
|
|
134
146
|
* @throws {@link UsersServiceException}
|
|
135
147
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
136
148
|
*
|
|
@@ -84,6 +84,18 @@ declare const QueryUserCommand_base: {
|
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link ValidationException} (client fault)
|
|
86
86
|
*
|
|
87
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
98
|
+
*
|
|
87
99
|
* @throws {@link UsersServiceException}
|
|
88
100
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
89
101
|
*
|
|
@@ -84,6 +84,18 @@ declare const QueryUsersCommand_base: {
|
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link ValidationException} (client fault)
|
|
86
86
|
*
|
|
87
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
98
|
+
*
|
|
87
99
|
* @throws {@link UsersServiceException}
|
|
88
100
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
89
101
|
*
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { RemoveIdentityInput, RemoveIdentityOutput } 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 RemoveIdentityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RemoveIdentityCommandInput extends RemoveIdentityInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RemoveIdentityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RemoveIdentityCommandOutput extends RemoveIdentityOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RemoveIdentityCommand_base: {
|
|
25
|
+
new (input: RemoveIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveIdentityCommandInput, RemoveIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: RemoveIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveIdentityCommandInput, RemoveIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes a non-primary identity from the account. Requires step-up verification for the primary identity.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, RemoveIdentityCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, RemoveIdentityCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // RemoveIdentityInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* identity: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new RemoveIdentityCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param RemoveIdentityCommandInput - {@link RemoveIdentityCommandInput}
|
|
48
|
+
* @returns {@link RemoveIdentityCommandOutput}
|
|
49
|
+
* @see {@link RemoveIdentityCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link RemoveIdentityCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link UsersServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class RemoveIdentityCommand extends RemoveIdentityCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: RemoveIdentityInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: RemoveIdentityCommandInput;
|
|
84
|
+
output: RemoveIdentityCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -54,6 +54,18 @@ declare const ToggleTranscriptionEmailNotificationsSubscriptionCommand_base: {
|
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link ValidationException} (client fault)
|
|
56
56
|
*
|
|
57
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
68
|
+
*
|
|
57
69
|
* @throws {@link UsersServiceException}
|
|
58
70
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
59
71
|
*
|