@wildix/xbees-users-client 1.2.3 → 1.2.5
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-types/commands/AddIdentityCommand.d.ts +93 -0
- package/dist-types/commands/BatchGetUsersCommand.d.ts +110 -0
- package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +95 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +146 -0
- package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +146 -0
- package/dist-types/commands/ChangeUserEmailCommand.d.ts +100 -0
- package/dist-types/commands/CreateBotApiKeyCommand.d.ts +108 -0
- package/dist-types/commands/CreateBotCommand.d.ts +210 -0
- package/dist-types/commands/CreateSystemBotCommand.d.ts +90 -0
- package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +92 -0
- package/dist-types/commands/DeleteBotCommand.d.ts +89 -0
- package/dist-types/commands/GetAccountCommand.d.ts +182 -0
- package/dist-types/commands/GetAppVersionCommand.d.ts +88 -0
- package/dist-types/commands/GetBotCallbackCommand.d.ts +196 -0
- package/dist-types/commands/GetBotCommand.d.ts +102 -0
- package/dist-types/commands/GetUserCommand.d.ts +108 -0
- package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +144 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +91 -0
- package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +91 -0
- package/dist-types/commands/IntelligenceSearchCommand.d.ts +97 -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 +95 -0
- package/dist-types/commands/ListBotsCommand.d.ts +101 -0
- package/dist-types/commands/ListWorkspacesCommand.d.ts +170 -0
- package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/QueryColleaguesCommand.d.ts +164 -0
- package/dist-types/commands/QueryUserCommand.d.ts +117 -0
- package/dist-types/commands/QueryUsersCommand.d.ts +117 -0
- package/dist-types/commands/RemoveIdentityCommand.d.ts +87 -0
- package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +87 -0
- package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +87 -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 +300 -0
- package/dist-types/commands/UpdateBotCommand.d.ts +105 -0
- package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
- package/dist-types/commands/UpdateWorkspaceCommand.d.ts +171 -0
- package/dist-types/commands/UploadPictureCommand.d.ts +88 -0
- package/dist-types/commands/UploadPictureV1Command.d.ts +90 -0
- package/dist-types/commands/VerifyAddIdentityCommand.d.ts +95 -0
- package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +92 -0
- package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +92 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { AddIdentityInput, AddIdentityOutput } 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 AddIdentityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface AddIdentityCommandInput extends AddIdentityInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link AddIdentityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface AddIdentityCommandOutput extends AddIdentityOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const AddIdentityCommand_base: {
|
|
25
|
+
new (input: AddIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<AddIdentityCommandInput, AddIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: AddIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<AddIdentityCommandInput, AddIdentityCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Adds a new identity (email or phone) to the account. Requires OTP verification for the new identity and re-verification of 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, AddIdentityCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, AddIdentityCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // AddIdentityInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* identity: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new AddIdentityCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // AddIdentityOutput
|
|
44
|
+
* // identity: { // Identity
|
|
45
|
+
* // identity: "STRING_VALUE", // required
|
|
46
|
+
* // account: "STRING_VALUE", // required
|
|
47
|
+
* // verified: true || false,
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param AddIdentityCommandInput - {@link AddIdentityCommandInput}
|
|
54
|
+
* @returns {@link AddIdentityCommandOutput}
|
|
55
|
+
* @see {@link AddIdentityCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link AddIdentityCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ValidationException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ForbiddenException} (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 AddIdentityCommand extends AddIdentityCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: AddIdentityInput;
|
|
86
|
+
output: AddIdentityOutput;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: AddIdentityCommandInput;
|
|
90
|
+
output: AddIdentityCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { BatchGetUsersInput, BatchGetUsersOutput } 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 BatchGetUsersCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchGetUsersCommandInput extends BatchGetUsersInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchGetUsersCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchGetUsersCommandOutput extends BatchGetUsersOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchGetUsersCommand_base: {
|
|
25
|
+
new (input: BatchGetUsersCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersCommandInput, BatchGetUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: BatchGetUsersCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersCommandInput, BatchGetUsersCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves details of multiple users in a single batch operation.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, BatchGetUsersCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, BatchGetUsersCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // BatchGetUsersInput
|
|
38
|
+
* id: [ // UsersIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new BatchGetUsersCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // BatchGetUsersOutput
|
|
45
|
+
* // users: [ // UsersList // required
|
|
46
|
+
* // { // User
|
|
47
|
+
* // id: "STRING_VALUE", // required
|
|
48
|
+
* // name: "STRING_VALUE",
|
|
49
|
+
* // email: "STRING_VALUE",
|
|
50
|
+
* // phone: "STRING_VALUE",
|
|
51
|
+
* // picture: "STRING_VALUE",
|
|
52
|
+
* // locale: "STRING_VALUE",
|
|
53
|
+
* // timeZone: "STRING_VALUE",
|
|
54
|
+
* // company: "STRING_VALUE",
|
|
55
|
+
* // bot: true || false,
|
|
56
|
+
* // pbxDomain: "STRING_VALUE",
|
|
57
|
+
* // pbxPort: "STRING_VALUE",
|
|
58
|
+
* // pbxExtension: "STRING_VALUE",
|
|
59
|
+
* // pbxSerial: "STRING_VALUE",
|
|
60
|
+
* // pbxUserId: "STRING_VALUE",
|
|
61
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
62
|
+
* // createdAt: "STRING_VALUE",
|
|
63
|
+
* // updatedAt: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* @param BatchGetUsersCommandInput - {@link BatchGetUsersCommandInput}
|
|
71
|
+
* @returns {@link BatchGetUsersCommandOutput}
|
|
72
|
+
* @see {@link BatchGetUsersCommandInput} for command's `input` shape.
|
|
73
|
+
* @see {@link BatchGetUsersCommandOutput} for command's `response` shape.
|
|
74
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link ValidationException} (client fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link UsersServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class BatchGetUsersCommand extends BatchGetUsersCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: BatchGetUsersInput;
|
|
103
|
+
output: BatchGetUsersOutput;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: BatchGetUsersCommandInput;
|
|
107
|
+
output: BatchGetUsersCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { BatchGetUsersEmailNotificationsSettingsInput, BatchGetUsersEmailNotificationsSettingsOutput } 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 BatchGetUsersEmailNotificationsSettingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchGetUsersEmailNotificationsSettingsCommandInput extends BatchGetUsersEmailNotificationsSettingsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchGetUsersEmailNotificationsSettingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchGetUsersEmailNotificationsSettingsCommandOutput extends BatchGetUsersEmailNotificationsSettingsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchGetUsersEmailNotificationsSettingsCommand_base: {
|
|
25
|
+
new (input: BatchGetUsersEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: BatchGetUsersEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersEmailNotificationsSettingsCommandInput, BatchGetUsersEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get multiple user settings by their IDs
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, BatchGetUsersEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, BatchGetUsersEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // BatchGetUsersEmailNotificationsSettingsInput
|
|
38
|
+
* usersIds: [ // UsersIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new BatchGetUsersEmailNotificationsSettingsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // BatchGetUsersEmailNotificationsSettingsOutput
|
|
45
|
+
* // notifications: { // UsersEmailNotificationsSettingsMap // required
|
|
46
|
+
* // "<keys>": { // UserEmailNotificationsSettings
|
|
47
|
+
* // unread: true || false, // required
|
|
48
|
+
* // transcription: true || false, // required
|
|
49
|
+
* // },
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param BatchGetUsersEmailNotificationsSettingsCommandInput - {@link BatchGetUsersEmailNotificationsSettingsCommandInput}
|
|
56
|
+
* @returns {@link BatchGetUsersEmailNotificationsSettingsCommandOutput}
|
|
57
|
+
* @see {@link BatchGetUsersEmailNotificationsSettingsCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link BatchGetUsersEmailNotificationsSettingsCommandOutput} 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 BatchGetUsersEmailNotificationsSettingsCommand extends BatchGetUsersEmailNotificationsSettingsCommand_base {
|
|
84
|
+
/** @internal type navigation helper, not in runtime. */
|
|
85
|
+
protected static __types: {
|
|
86
|
+
api: {
|
|
87
|
+
input: BatchGetUsersEmailNotificationsSettingsInput;
|
|
88
|
+
output: BatchGetUsersEmailNotificationsSettingsOutput;
|
|
89
|
+
};
|
|
90
|
+
sdk: {
|
|
91
|
+
input: BatchGetUsersEmailNotificationsSettingsCommandInput;
|
|
92
|
+
output: BatchGetUsersEmailNotificationsSettingsCommandOutput;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
95
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { BatchGetUsersPbxLinkDataInput, BatchGetUsersPbxLinkDataOutput } 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 BatchGetUsersPbxLinkDataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchGetUsersPbxLinkDataCommandInput extends BatchGetUsersPbxLinkDataInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchGetUsersPbxLinkDataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchGetUsersPbxLinkDataCommandOutput extends BatchGetUsersPbxLinkDataOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchGetUsersPbxLinkDataCommand_base: {
|
|
25
|
+
new (input: BatchGetUsersPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersPbxLinkDataCommandInput, BatchGetUsersPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: BatchGetUsersPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersPbxLinkDataCommandInput, BatchGetUsersPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves PBX link data for multiple users in a single batch operation.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, BatchGetUsersPbxLinkDataCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, BatchGetUsersPbxLinkDataCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // BatchGetUsersPbxLinkDataInput
|
|
38
|
+
* id: [ // UsersIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new BatchGetUsersPbxLinkDataCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // BatchGetUsersPbxLinkDataOutput
|
|
45
|
+
* // users: [ // UsersPbxLinkDataList // required
|
|
46
|
+
* // { // 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
|
+
* // ],
|
|
102
|
+
* // };
|
|
103
|
+
*
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @param BatchGetUsersPbxLinkDataCommandInput - {@link BatchGetUsersPbxLinkDataCommandInput}
|
|
107
|
+
* @returns {@link BatchGetUsersPbxLinkDataCommandOutput}
|
|
108
|
+
* @see {@link BatchGetUsersPbxLinkDataCommandInput} for command's `input` shape.
|
|
109
|
+
* @see {@link BatchGetUsersPbxLinkDataCommandOutput} for command's `response` shape.
|
|
110
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ValidationException} (client fault)
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link UsersServiceException}
|
|
129
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
130
|
+
*
|
|
131
|
+
*
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare class BatchGetUsersPbxLinkDataCommand extends BatchGetUsersPbxLinkDataCommand_base {
|
|
135
|
+
/** @internal type navigation helper, not in runtime. */
|
|
136
|
+
protected static __types: {
|
|
137
|
+
api: {
|
|
138
|
+
input: BatchGetUsersPbxLinkDataInput;
|
|
139
|
+
output: BatchGetUsersPbxLinkDataOutput;
|
|
140
|
+
};
|
|
141
|
+
sdk: {
|
|
142
|
+
input: BatchGetUsersPbxLinkDataCommandInput;
|
|
143
|
+
output: BatchGetUsersPbxLinkDataCommandOutput;
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { BatchGetUsersPbxLinkDataV1Input, BatchGetUsersPbxLinkDataV1Output } 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 BatchGetUsersPbxLinkDataV1Command}.
|
|
14
|
+
*/
|
|
15
|
+
export interface BatchGetUsersPbxLinkDataV1CommandInput extends BatchGetUsersPbxLinkDataV1Input {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link BatchGetUsersPbxLinkDataV1Command}.
|
|
21
|
+
*/
|
|
22
|
+
export interface BatchGetUsersPbxLinkDataV1CommandOutput extends BatchGetUsersPbxLinkDataV1Output, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const BatchGetUsersPbxLinkDataV1Command_base: {
|
|
25
|
+
new (input: BatchGetUsersPbxLinkDataV1CommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: BatchGetUsersPbxLinkDataV1CommandInput): import("@smithy/smithy-client").CommandImpl<BatchGetUsersPbxLinkDataV1CommandInput, BatchGetUsersPbxLinkDataV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves PBX link data for multiple users in a single batch operation. This is a deprecated operation - use BatchGetUsersPbxLinkData instead.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, BatchGetUsersPbxLinkDataV1Command } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, BatchGetUsersPbxLinkDataV1Command } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // BatchGetUsersPbxLinkDataV1Input
|
|
38
|
+
* id: [ // UsersIdList // required
|
|
39
|
+
* "STRING_VALUE",
|
|
40
|
+
* ],
|
|
41
|
+
* };
|
|
42
|
+
* const command = new BatchGetUsersPbxLinkDataV1Command(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // BatchGetUsersPbxLinkDataV1Output
|
|
45
|
+
* // users: [ // UsersPbxLinkDataList // required
|
|
46
|
+
* // { // 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
|
+
* // ],
|
|
102
|
+
* // };
|
|
103
|
+
*
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @param BatchGetUsersPbxLinkDataV1CommandInput - {@link BatchGetUsersPbxLinkDataV1CommandInput}
|
|
107
|
+
* @returns {@link BatchGetUsersPbxLinkDataV1CommandOutput}
|
|
108
|
+
* @see {@link BatchGetUsersPbxLinkDataV1CommandInput} for command's `input` shape.
|
|
109
|
+
* @see {@link BatchGetUsersPbxLinkDataV1CommandOutput} for command's `response` shape.
|
|
110
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ValidationException} (client fault)
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
127
|
+
*
|
|
128
|
+
* @throws {@link UsersServiceException}
|
|
129
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
130
|
+
*
|
|
131
|
+
*
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare class BatchGetUsersPbxLinkDataV1Command extends BatchGetUsersPbxLinkDataV1Command_base {
|
|
135
|
+
/** @internal type navigation helper, not in runtime. */
|
|
136
|
+
protected static __types: {
|
|
137
|
+
api: {
|
|
138
|
+
input: BatchGetUsersPbxLinkDataV1Input;
|
|
139
|
+
output: BatchGetUsersPbxLinkDataV1Output;
|
|
140
|
+
};
|
|
141
|
+
sdk: {
|
|
142
|
+
input: BatchGetUsersPbxLinkDataV1CommandInput;
|
|
143
|
+
output: BatchGetUsersPbxLinkDataV1CommandOutput;
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
}
|