@wildix/xbees-users-client 1.1.0 → 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
|
@@ -54,6 +54,18 @@ declare const ToggleUnreadEmailNotificationsSubscriptionCommand_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
|
*
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UnbindWorkspaceInput, UnbindWorkspaceOutput } 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 UnbindWorkspaceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UnbindWorkspaceCommandInput extends UnbindWorkspaceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UnbindWorkspaceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UnbindWorkspaceCommandOutput extends UnbindWorkspaceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UnbindWorkspaceCommand_base: {
|
|
25
|
+
new (input: UnbindWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UnbindWorkspaceCommandInput, UnbindWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnbindWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UnbindWorkspaceCommandInput, UnbindWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes the connection between the account and a workspace.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, UnbindWorkspaceCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UnbindWorkspaceCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UnbindWorkspaceInput
|
|
38
|
+
* workspaceId: "STRING_VALUE", // required
|
|
39
|
+
* accountId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UnbindWorkspaceCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param UnbindWorkspaceCommandInput - {@link UnbindWorkspaceCommandInput}
|
|
48
|
+
* @returns {@link UnbindWorkspaceCommandOutput}
|
|
49
|
+
* @see {@link UnbindWorkspaceCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link UnbindWorkspaceCommandOutput} 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 WorkspaceNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ValidationException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link IdentityNotFoundException} (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 UnbindWorkspaceCommand extends UnbindWorkspaceCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: UnbindWorkspaceInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: UnbindWorkspaceCommandInput;
|
|
84
|
+
output: UnbindWorkspaceCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateAccountInput, UpdateAccountOutput } 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 UpdateAccountCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateAccountCommandInput extends UpdateAccountInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateAccountCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateAccountCommandOutput extends UpdateAccountOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateAccountCommand_base: {
|
|
25
|
+
new (input: UpdateAccountCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCommandInput, UpdateAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateAccountCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCommandInput, UpdateAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Updates the account. Allows changing default workspace and 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, UpdateAccountCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateAccountCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateAccountInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* defaultWorkspace: "STRING_VALUE",
|
|
40
|
+
* primaryIdentity: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateAccountCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // UpdateAccountOutput
|
|
45
|
+
* // account: { // Account
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // defaultWorkspace: "STRING_VALUE",
|
|
48
|
+
* // primaryIdentity: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param UpdateAccountCommandInput - {@link UpdateAccountCommandInput}
|
|
55
|
+
* @returns {@link UpdateAccountCommandOutput}
|
|
56
|
+
* @see {@link UpdateAccountCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link UpdateAccountCommandOutput} 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 IdentityNotFoundException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (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 UpdateAccountCommand extends UpdateAccountCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: UpdateAccountInput;
|
|
87
|
+
output: UpdateAccountOutput;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: UpdateAccountCommandInput;
|
|
91
|
+
output: UpdateAccountCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -267,6 +267,18 @@ declare const UpdateBotCallbackCommand_base: {
|
|
|
267
267
|
*
|
|
268
268
|
* @throws {@link ValidationException} (client fault)
|
|
269
269
|
*
|
|
270
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
271
|
+
*
|
|
272
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
273
|
+
*
|
|
274
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
275
|
+
*
|
|
276
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
277
|
+
*
|
|
278
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
279
|
+
*
|
|
280
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
281
|
+
*
|
|
270
282
|
* @throws {@link UsersServiceException}
|
|
271
283
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
272
284
|
*
|
|
@@ -72,6 +72,18 @@ declare const UpdateBotCommand_base: {
|
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link ValidationException} (client fault)
|
|
74
74
|
*
|
|
75
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
86
|
+
*
|
|
75
87
|
* @throws {@link UsersServiceException}
|
|
76
88
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
77
89
|
*
|
|
@@ -60,6 +60,18 @@ declare const UpdateUserEmailNotificationsSettingsCommand_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
|
*
|
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateWorkspaceInput, UpdateWorkspaceOutput } 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 UpdateWorkspaceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateWorkspaceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateWorkspaceCommand_base: {
|
|
25
|
+
new (input: UpdateWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Updates the workspace. Available only via s2s (service-to-service) authentication.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, UpdateWorkspaceCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateWorkspaceCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateWorkspaceInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* workspaceId: "STRING_VALUE", // required
|
|
40
|
+
* active: true || false,
|
|
41
|
+
* type: "personal" || "work" || "support",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new UpdateWorkspaceCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // UpdateWorkspaceOutput
|
|
46
|
+
* // workspace: { // Workspace
|
|
47
|
+
* // companyId: "STRING_VALUE",
|
|
48
|
+
* // pbxUser: { // UserPbxLinkData
|
|
49
|
+
* // id: "STRING_VALUE", // required
|
|
50
|
+
* // company: "STRING_VALUE", // required
|
|
51
|
+
* // companyName: "STRING_VALUE",
|
|
52
|
+
* // domain: "STRING_VALUE", // required
|
|
53
|
+
* // email: "STRING_VALUE",
|
|
54
|
+
* // info: { // UserPersonalInfo
|
|
55
|
+
* // dn: "STRING_VALUE", // required
|
|
56
|
+
* // id: "STRING_VALUE", // required
|
|
57
|
+
* // name: "STRING_VALUE", // required
|
|
58
|
+
* // extension: "STRING_VALUE", // required
|
|
59
|
+
* // officePhone: "STRING_VALUE",
|
|
60
|
+
* // mobilePhone: "STRING_VALUE",
|
|
61
|
+
* // faxNumber: "STRING_VALUE",
|
|
62
|
+
* // email: "STRING_VALUE",
|
|
63
|
+
* // role: "STRING_VALUE", // required
|
|
64
|
+
* // language: "STRING_VALUE", // required
|
|
65
|
+
* // dialplan: "STRING_VALUE", // required
|
|
66
|
+
* // faxDialplan: "STRING_VALUE", // required
|
|
67
|
+
* // departament: "STRING_VALUE",
|
|
68
|
+
* // picture: "STRING_VALUE", // required
|
|
69
|
+
* // groupDn: "STRING_VALUE", // required
|
|
70
|
+
* // groupName: "STRING_VALUE", // required
|
|
71
|
+
* // jid: "STRING_VALUE", // required
|
|
72
|
+
* // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
|
|
73
|
+
* // login: "STRING_VALUE",
|
|
74
|
+
* // pbx: "STRING_VALUE",
|
|
75
|
+
* // pbxDn: "STRING_VALUE", // required
|
|
76
|
+
* // sourceId: "STRING_VALUE",
|
|
77
|
+
* // sipPassword: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // pbx: { // UserPbxInfo
|
|
80
|
+
* // networkAddresses: [ // UserPbxInfoNetworkAddresses // required
|
|
81
|
+
* // "STRING_VALUE",
|
|
82
|
+
* // ],
|
|
83
|
+
* // ports: [ // UserPbxInfoPorts // required
|
|
84
|
+
* // "STRING_VALUE",
|
|
85
|
+
* // ],
|
|
86
|
+
* // externalLinePrefix: "STRING_VALUE",
|
|
87
|
+
* // version: "STRING_VALUE", // required
|
|
88
|
+
* // serial: "STRING_VALUE", // required
|
|
89
|
+
* // },
|
|
90
|
+
* // picture: "STRING_VALUE", // required
|
|
91
|
+
* // pictureDeleted: true || false,
|
|
92
|
+
* // port: "STRING_VALUE", // required
|
|
93
|
+
* // serial: "STRING_VALUE", // required
|
|
94
|
+
* // services: { // UserPbxServices
|
|
95
|
+
* // xcaracal: true || false,
|
|
96
|
+
* // wizyWebinar: true || false,
|
|
97
|
+
* // },
|
|
98
|
+
* // personalSettings: {},
|
|
99
|
+
* // dialplanSettings: {},
|
|
100
|
+
* // awsRegion: "STRING_VALUE",
|
|
101
|
+
* // updatedAt: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // streamUser: { // User
|
|
104
|
+
* // id: "STRING_VALUE", // required
|
|
105
|
+
* // name: "STRING_VALUE",
|
|
106
|
+
* // email: "STRING_VALUE",
|
|
107
|
+
* // phone: "STRING_VALUE",
|
|
108
|
+
* // picture: "STRING_VALUE",
|
|
109
|
+
* // locale: "STRING_VALUE",
|
|
110
|
+
* // timeZone: "STRING_VALUE",
|
|
111
|
+
* // company: "STRING_VALUE",
|
|
112
|
+
* // bot: true || false,
|
|
113
|
+
* // pbxDomain: "STRING_VALUE",
|
|
114
|
+
* // pbxPort: "STRING_VALUE",
|
|
115
|
+
* // pbxExtension: "STRING_VALUE",
|
|
116
|
+
* // pbxSerial: "STRING_VALUE",
|
|
117
|
+
* // pbxUserId: "STRING_VALUE",
|
|
118
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
119
|
+
* // createdAt: "STRING_VALUE",
|
|
120
|
+
* // updatedAt: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // type: "personal" || "work" || "support",
|
|
123
|
+
* // id: "STRING_VALUE", // required
|
|
124
|
+
* // accountId: "STRING_VALUE", // required
|
|
125
|
+
* // active: true || false, // required
|
|
126
|
+
* // },
|
|
127
|
+
* // };
|
|
128
|
+
*
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
131
|
+
* @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput}
|
|
132
|
+
* @returns {@link UpdateWorkspaceCommandOutput}
|
|
133
|
+
* @see {@link UpdateWorkspaceCommandInput} for command's `input` shape.
|
|
134
|
+
* @see {@link UpdateWorkspaceCommandOutput} for command's `response` shape.
|
|
135
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link ValidationException} (client fault)
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link UsersServiceException}
|
|
154
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
155
|
+
*
|
|
156
|
+
*
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
export declare class UpdateWorkspaceCommand extends UpdateWorkspaceCommand_base {
|
|
160
|
+
/** @internal type navigation helper, not in runtime. */
|
|
161
|
+
protected static __types: {
|
|
162
|
+
api: {
|
|
163
|
+
input: UpdateWorkspaceInput;
|
|
164
|
+
output: UpdateWorkspaceOutput;
|
|
165
|
+
};
|
|
166
|
+
sdk: {
|
|
167
|
+
input: UpdateWorkspaceCommandInput;
|
|
168
|
+
output: UpdateWorkspaceCommandOutput;
|
|
169
|
+
};
|
|
170
|
+
};
|
|
171
|
+
}
|
|
@@ -55,6 +55,18 @@ declare const UploadPictureCommand_base: {
|
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link ValidationException} (client fault)
|
|
57
57
|
*
|
|
58
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
69
|
+
*
|
|
58
70
|
* @throws {@link UsersServiceException}
|
|
59
71
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
60
72
|
*
|
|
@@ -57,6 +57,18 @@ declare const UploadPictureV1Command_base: {
|
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ValidationException} (client fault)
|
|
59
59
|
*
|
|
60
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
71
|
+
*
|
|
60
72
|
* @throws {@link UsersServiceException}
|
|
61
73
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
62
74
|
*
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { VerifyAddIdentityInput, VerifyAddIdentityOutput } 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 VerifyAddIdentityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface VerifyAddIdentityCommandInput extends VerifyAddIdentityInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link VerifyAddIdentityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface VerifyAddIdentityCommandOutput extends VerifyAddIdentityOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const VerifyAddIdentityCommand_base: {
|
|
25
|
+
new (input: VerifyAddIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyAddIdentityCommandInput, VerifyAddIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: VerifyAddIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyAddIdentityCommandInput, VerifyAddIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Completes adding an identity by verifying the OTP sent to the new identity. Call after AddIdentity.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, VerifyAddIdentityCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, VerifyAddIdentityCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // VerifyAddIdentityInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* identity: "STRING_VALUE", // required
|
|
40
|
+
* otp: "STRING_VALUE", // required
|
|
41
|
+
* primaryOtp: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new VerifyAddIdentityCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // VerifyAddIdentityOutput
|
|
46
|
+
* // identity: { // Identity
|
|
47
|
+
* // identity: "STRING_VALUE", // required
|
|
48
|
+
* // account: "STRING_VALUE", // required
|
|
49
|
+
* // verified: true || false,
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param VerifyAddIdentityCommandInput - {@link VerifyAddIdentityCommandInput}
|
|
56
|
+
* @returns {@link VerifyAddIdentityCommandOutput}
|
|
57
|
+
* @see {@link VerifyAddIdentityCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link VerifyAddIdentityCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ValidationException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ForbiddenException} (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 UsersServiceException}
|
|
78
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
export declare class VerifyAddIdentityCommand extends VerifyAddIdentityCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: VerifyAddIdentityInput;
|
|
88
|
+
output: VerifyAddIdentityOutput;
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: VerifyAddIdentityCommandInput;
|
|
92
|
+
output: VerifyAddIdentityCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -59,6 +59,18 @@ declare const VerifyBotSecretKeyCommand_base: {
|
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ValidationException} (client fault)
|
|
61
61
|
*
|
|
62
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
73
|
+
*
|
|
62
74
|
* @throws {@link UsersServiceException}
|
|
63
75
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
64
76
|
*
|
|
@@ -59,6 +59,18 @@ declare const VerifyBotSecretKeyV1Command_base: {
|
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ValidationException} (client fault)
|
|
61
61
|
*
|
|
62
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
73
|
+
*
|
|
62
74
|
* @throws {@link UsersServiceException}
|
|
63
75
|
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
64
76
|
*
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from "./AddIdentityCommand";
|
|
1
2
|
export * from "./BatchGetUsersCommand";
|
|
2
3
|
export * from "./BatchGetUsersEmailNotificationsSettingsCommand";
|
|
3
4
|
export * from "./BatchGetUsersPbxLinkDataCommand";
|
|
@@ -8,6 +9,7 @@ export * from "./CreateBotApiKeyCommand";
|
|
|
8
9
|
export * from "./CreateSystemBotCommand";
|
|
9
10
|
export * from "./DeleteBotCommand";
|
|
10
11
|
export * from "./DeleteBotApiKeyCommand";
|
|
12
|
+
export * from "./GetAccountCommand";
|
|
11
13
|
export * from "./GetAppVersionCommand";
|
|
12
14
|
export * from "./GetBotCommand";
|
|
13
15
|
export * from "./GetBotCallbackCommand";
|
|
@@ -17,18 +19,26 @@ export * from "./GetUserPbxLinkDataCommand";
|
|
|
17
19
|
export * from "./GetUserPbxLinkSuggestionCommand";
|
|
18
20
|
export * from "./GetUserPbxLinkSuggestionV1Command";
|
|
19
21
|
export * from "./IntelligenceSearchCommand";
|
|
22
|
+
export * from "./InviteCommand";
|
|
23
|
+
export * from "./ListAccountIdentitiesCommand";
|
|
20
24
|
export * from "./ListBotApiKeysCommand";
|
|
21
25
|
export * from "./ListBotsCommand";
|
|
26
|
+
export * from "./ListWorkspacesCommand";
|
|
22
27
|
export * from "./PartialUpdateUserEmailNotificationsSettingsCommand";
|
|
23
28
|
export * from "./QueryColleaguesCommand";
|
|
24
29
|
export * from "./QueryUserCommand";
|
|
25
30
|
export * from "./QueryUsersCommand";
|
|
31
|
+
export * from "./RemoveIdentityCommand";
|
|
26
32
|
export * from "./ToggleTranscriptionEmailNotificationsSubscriptionCommand";
|
|
27
33
|
export * from "./ToggleUnreadEmailNotificationsSubscriptionCommand";
|
|
34
|
+
export * from "./UnbindWorkspaceCommand";
|
|
35
|
+
export * from "./UpdateAccountCommand";
|
|
28
36
|
export * from "./UpdateBotCommand";
|
|
29
37
|
export * from "./UpdateBotCallbackCommand";
|
|
30
38
|
export * from "./UpdateUserEmailNotificationsSettingsCommand";
|
|
39
|
+
export * from "./UpdateWorkspaceCommand";
|
|
31
40
|
export * from "./UploadPictureCommand";
|
|
32
41
|
export * from "./UploadPictureV1Command";
|
|
42
|
+
export * from "./VerifyAddIdentityCommand";
|
|
33
43
|
export * from "./VerifyBotSecretKeyCommand";
|
|
34
44
|
export * from "./VerifyBotSecretKeyV1Command";
|