@wildix/xbees-users-client 1.2.3 → 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,108 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { GetUserInput, GetUserOutput } 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 GetUserCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserCommandInput extends GetUserInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserCommandOutput extends GetUserOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserCommand_base: {
|
|
25
|
+
new (input: GetUserCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetUserCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserCommandInput, GetUserCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves details of a specific user by their unique identifier.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, GetUserCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, GetUserCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // GetUserInput
|
|
38
|
+
* userId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetUserCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetUserOutput
|
|
43
|
+
* // user: { // User
|
|
44
|
+
* // id: "STRING_VALUE", // required
|
|
45
|
+
* // name: "STRING_VALUE",
|
|
46
|
+
* // email: "STRING_VALUE",
|
|
47
|
+
* // phone: "STRING_VALUE",
|
|
48
|
+
* // picture: "STRING_VALUE",
|
|
49
|
+
* // locale: "STRING_VALUE",
|
|
50
|
+
* // timeZone: "STRING_VALUE",
|
|
51
|
+
* // company: "STRING_VALUE",
|
|
52
|
+
* // bot: true || false,
|
|
53
|
+
* // pbxDomain: "STRING_VALUE",
|
|
54
|
+
* // pbxPort: "STRING_VALUE",
|
|
55
|
+
* // pbxExtension: "STRING_VALUE",
|
|
56
|
+
* // pbxSerial: "STRING_VALUE",
|
|
57
|
+
* // pbxUserId: "STRING_VALUE",
|
|
58
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
59
|
+
* // createdAt: "STRING_VALUE",
|
|
60
|
+
* // updatedAt: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param GetUserCommandInput - {@link GetUserCommandInput}
|
|
67
|
+
* @returns {@link GetUserCommandOutput}
|
|
68
|
+
* @see {@link GetUserCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link GetUserCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ValidationException} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link UsersServiceException}
|
|
91
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
92
|
+
*
|
|
93
|
+
*
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export declare class GetUserCommand extends GetUserCommand_base {
|
|
97
|
+
/** @internal type navigation helper, not in runtime. */
|
|
98
|
+
protected static __types: {
|
|
99
|
+
api: {
|
|
100
|
+
input: GetUserInput;
|
|
101
|
+
output: GetUserOutput;
|
|
102
|
+
};
|
|
103
|
+
sdk: {
|
|
104
|
+
input: GetUserCommandInput;
|
|
105
|
+
output: GetUserCommandOutput;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { GetUserEmailNotificationsSettingsInput, GetUserEmailNotificationsSettingsOutput } 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 GetUserEmailNotificationsSettingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserEmailNotificationsSettingsCommandInput extends GetUserEmailNotificationsSettingsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserEmailNotificationsSettingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserEmailNotificationsSettingsCommandOutput extends GetUserEmailNotificationsSettingsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserEmailNotificationsSettingsCommand_base: {
|
|
25
|
+
new (input: GetUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserEmailNotificationsSettingsCommandInput, GetUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserEmailNotificationsSettingsCommandInput, GetUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Getting user email notifications settings
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, GetUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, GetUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // GetUserEmailNotificationsSettingsInput
|
|
38
|
+
* userId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetUserEmailNotificationsSettingsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetUserEmailNotificationsSettingsOutput
|
|
43
|
+
* // notifications: { // UserEmailNotificationsSettings
|
|
44
|
+
* // unread: true || false, // required
|
|
45
|
+
* // transcription: true || false, // required
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetUserEmailNotificationsSettingsCommandInput - {@link GetUserEmailNotificationsSettingsCommandInput}
|
|
52
|
+
* @returns {@link GetUserEmailNotificationsSettingsCommandOutput}
|
|
53
|
+
* @see {@link GetUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ValidationException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link UsersServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
77
|
+
*
|
|
78
|
+
*
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export declare class GetUserEmailNotificationsSettingsCommand extends GetUserEmailNotificationsSettingsCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: GetUserEmailNotificationsSettingsInput;
|
|
86
|
+
output: GetUserEmailNotificationsSettingsOutput;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: GetUserEmailNotificationsSettingsCommandInput;
|
|
90
|
+
output: GetUserEmailNotificationsSettingsCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { GetUserPbxLinkDataInput, GetUserPbxLinkDataOutput } 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 GetUserPbxLinkDataCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserPbxLinkDataCommandInput extends GetUserPbxLinkDataInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserPbxLinkDataCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserPbxLinkDataCommandOutput extends GetUserPbxLinkDataOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserPbxLinkDataCommand_base: {
|
|
25
|
+
new (input: GetUserPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetUserPbxLinkDataCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkDataCommandInput, GetUserPbxLinkDataCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves PBX link data for a specific user.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, GetUserPbxLinkDataCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, GetUserPbxLinkDataCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // GetUserPbxLinkDataInput
|
|
38
|
+
* userId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetUserPbxLinkDataCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetUserPbxLinkDataOutput
|
|
43
|
+
* // user: { // UserPbxLinkData
|
|
44
|
+
* // id: "STRING_VALUE", // required
|
|
45
|
+
* // company: "STRING_VALUE", // required
|
|
46
|
+
* // companyName: "STRING_VALUE",
|
|
47
|
+
* // domain: "STRING_VALUE", // required
|
|
48
|
+
* // email: "STRING_VALUE",
|
|
49
|
+
* // info: { // UserPersonalInfo
|
|
50
|
+
* // dn: "STRING_VALUE", // required
|
|
51
|
+
* // id: "STRING_VALUE", // required
|
|
52
|
+
* // name: "STRING_VALUE", // required
|
|
53
|
+
* // extension: "STRING_VALUE", // required
|
|
54
|
+
* // officePhone: "STRING_VALUE",
|
|
55
|
+
* // mobilePhone: "STRING_VALUE",
|
|
56
|
+
* // faxNumber: "STRING_VALUE",
|
|
57
|
+
* // email: "STRING_VALUE",
|
|
58
|
+
* // role: "STRING_VALUE", // required
|
|
59
|
+
* // language: "STRING_VALUE", // required
|
|
60
|
+
* // dialplan: "STRING_VALUE", // required
|
|
61
|
+
* // faxDialplan: "STRING_VALUE", // required
|
|
62
|
+
* // departament: "STRING_VALUE",
|
|
63
|
+
* // picture: "STRING_VALUE", // required
|
|
64
|
+
* // groupDn: "STRING_VALUE", // required
|
|
65
|
+
* // groupName: "STRING_VALUE", // required
|
|
66
|
+
* // jid: "STRING_VALUE", // required
|
|
67
|
+
* // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
|
|
68
|
+
* // login: "STRING_VALUE",
|
|
69
|
+
* // pbx: "STRING_VALUE",
|
|
70
|
+
* // pbxDn: "STRING_VALUE", // required
|
|
71
|
+
* // sourceId: "STRING_VALUE",
|
|
72
|
+
* // sipPassword: "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // pbx: { // UserPbxInfo
|
|
75
|
+
* // networkAddresses: [ // UserPbxInfoNetworkAddresses // required
|
|
76
|
+
* // "STRING_VALUE",
|
|
77
|
+
* // ],
|
|
78
|
+
* // ports: [ // UserPbxInfoPorts // required
|
|
79
|
+
* // "STRING_VALUE",
|
|
80
|
+
* // ],
|
|
81
|
+
* // externalLinePrefix: "STRING_VALUE",
|
|
82
|
+
* // version: "STRING_VALUE", // required
|
|
83
|
+
* // serial: "STRING_VALUE", // required
|
|
84
|
+
* // },
|
|
85
|
+
* // picture: "STRING_VALUE", // required
|
|
86
|
+
* // pictureDeleted: true || false,
|
|
87
|
+
* // port: "STRING_VALUE", // required
|
|
88
|
+
* // serial: "STRING_VALUE", // required
|
|
89
|
+
* // services: { // UserPbxServices
|
|
90
|
+
* // xcaracal: true || false,
|
|
91
|
+
* // wizyWebinar: true || false,
|
|
92
|
+
* // },
|
|
93
|
+
* // personalSettings: {},
|
|
94
|
+
* // dialplanSettings: {},
|
|
95
|
+
* // awsRegion: "STRING_VALUE",
|
|
96
|
+
* // updatedAt: "STRING_VALUE",
|
|
97
|
+
* // },
|
|
98
|
+
* // };
|
|
99
|
+
*
|
|
100
|
+
* ```
|
|
101
|
+
*
|
|
102
|
+
* @param GetUserPbxLinkDataCommandInput - {@link GetUserPbxLinkDataCommandInput}
|
|
103
|
+
* @returns {@link GetUserPbxLinkDataCommandOutput}
|
|
104
|
+
* @see {@link GetUserPbxLinkDataCommandInput} for command's `input` shape.
|
|
105
|
+
* @see {@link GetUserPbxLinkDataCommandOutput} for command's `response` shape.
|
|
106
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
107
|
+
*
|
|
108
|
+
* @throws {@link UserNotFoundException} (client fault)
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
111
|
+
*
|
|
112
|
+
* @throws {@link ValidationException} (client fault)
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
121
|
+
*
|
|
122
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
123
|
+
*
|
|
124
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link UsersServiceException}
|
|
127
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
128
|
+
*
|
|
129
|
+
*
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export declare class GetUserPbxLinkDataCommand extends GetUserPbxLinkDataCommand_base {
|
|
133
|
+
/** @internal type navigation helper, not in runtime. */
|
|
134
|
+
protected static __types: {
|
|
135
|
+
api: {
|
|
136
|
+
input: GetUserPbxLinkDataInput;
|
|
137
|
+
output: GetUserPbxLinkDataOutput;
|
|
138
|
+
};
|
|
139
|
+
sdk: {
|
|
140
|
+
input: GetUserPbxLinkDataCommandInput;
|
|
141
|
+
output: GetUserPbxLinkDataCommandOutput;
|
|
142
|
+
};
|
|
143
|
+
};
|
|
144
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { GetUserPbxLinkSuggestionInput, GetUserPbxLinkSuggestionOutput } 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 GetUserPbxLinkSuggestionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserPbxLinkSuggestionCommandInput extends GetUserPbxLinkSuggestionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserPbxLinkSuggestionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserPbxLinkSuggestionCommandOutput extends GetUserPbxLinkSuggestionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserPbxLinkSuggestionCommand_base: {
|
|
25
|
+
new (input: GetUserPbxLinkSuggestionCommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetUserPbxLinkSuggestionCommandInput]): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionCommandInput, GetUserPbxLinkSuggestionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves PBX link suggestion information for a user based on their email address.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, GetUserPbxLinkSuggestionCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, GetUserPbxLinkSuggestionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // GetUserPbxLinkSuggestionInput
|
|
38
|
+
* email: "STRING_VALUE",
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetUserPbxLinkSuggestionCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetUserPbxLinkSuggestionOutput
|
|
43
|
+
* // suggestion: { // UserPbxLinkSuggestion
|
|
44
|
+
* // domain: "STRING_VALUE", // required
|
|
45
|
+
* // port: "STRING_VALUE", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetUserPbxLinkSuggestionCommandInput - {@link GetUserPbxLinkSuggestionCommandInput}
|
|
52
|
+
* @returns {@link GetUserPbxLinkSuggestionCommandOutput}
|
|
53
|
+
* @see {@link GetUserPbxLinkSuggestionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetUserPbxLinkSuggestionCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
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
|
+
*
|
|
73
|
+
* @throws {@link UsersServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class GetUserPbxLinkSuggestionCommand extends GetUserPbxLinkSuggestionCommand_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: GetUserPbxLinkSuggestionInput;
|
|
84
|
+
output: GetUserPbxLinkSuggestionOutput;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: GetUserPbxLinkSuggestionCommandInput;
|
|
88
|
+
output: GetUserPbxLinkSuggestionCommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { GetUserPbxLinkSuggestionV1Input, GetUserPbxLinkSuggestionV1Output } 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 GetUserPbxLinkSuggestionV1Command}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetUserPbxLinkSuggestionV1CommandInput extends GetUserPbxLinkSuggestionV1Input {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetUserPbxLinkSuggestionV1Command}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetUserPbxLinkSuggestionV1CommandOutput extends GetUserPbxLinkSuggestionV1Output, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetUserPbxLinkSuggestionV1Command_base: {
|
|
25
|
+
new (input: GetUserPbxLinkSuggestionV1CommandInput): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetUserPbxLinkSuggestionV1CommandInput]): import("@smithy/smithy-client").CommandImpl<GetUserPbxLinkSuggestionV1CommandInput, GetUserPbxLinkSuggestionV1CommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves PBX link suggestion information for a user based on their email address. This is a deprecated operation - use GetUserPbxLinkSuggestion instead.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, GetUserPbxLinkSuggestionV1Command } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, GetUserPbxLinkSuggestionV1Command } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // GetUserPbxLinkSuggestionV1Input
|
|
38
|
+
* email: "STRING_VALUE",
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetUserPbxLinkSuggestionV1Command(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GetUserPbxLinkSuggestionV1Output
|
|
43
|
+
* // suggestion: { // UserPbxLinkSuggestion
|
|
44
|
+
* // domain: "STRING_VALUE", // required
|
|
45
|
+
* // port: "STRING_VALUE", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param GetUserPbxLinkSuggestionV1CommandInput - {@link GetUserPbxLinkSuggestionV1CommandInput}
|
|
52
|
+
* @returns {@link GetUserPbxLinkSuggestionV1CommandOutput}
|
|
53
|
+
* @see {@link GetUserPbxLinkSuggestionV1CommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link GetUserPbxLinkSuggestionV1CommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ValidationException} (client fault)
|
|
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
|
+
*
|
|
73
|
+
* @throws {@link UsersServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
75
|
+
*
|
|
76
|
+
*
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
export declare class GetUserPbxLinkSuggestionV1Command extends GetUserPbxLinkSuggestionV1Command_base {
|
|
80
|
+
/** @internal type navigation helper, not in runtime. */
|
|
81
|
+
protected static __types: {
|
|
82
|
+
api: {
|
|
83
|
+
input: GetUserPbxLinkSuggestionV1Input;
|
|
84
|
+
output: GetUserPbxLinkSuggestionV1Output;
|
|
85
|
+
};
|
|
86
|
+
sdk: {
|
|
87
|
+
input: GetUserPbxLinkSuggestionV1CommandInput;
|
|
88
|
+
output: GetUserPbxLinkSuggestionV1CommandOutput;
|
|
89
|
+
};
|
|
90
|
+
};
|
|
91
|
+
}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { IntelligenceSearchInput, IntelligenceSearchOutput } 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 IntelligenceSearchCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface IntelligenceSearchCommandInput extends IntelligenceSearchInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link IntelligenceSearchCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface IntelligenceSearchCommandOutput extends IntelligenceSearchOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const IntelligenceSearchCommand_base: {
|
|
25
|
+
new (input: IntelligenceSearchCommandInput): import("@smithy/smithy-client").CommandImpl<IntelligenceSearchCommandInput, IntelligenceSearchCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: IntelligenceSearchCommandInput): import("@smithy/smithy-client").CommandImpl<IntelligenceSearchCommandInput, IntelligenceSearchCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Search user in the directory using AI. Result is sorted by relevance.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, IntelligenceSearchCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, IntelligenceSearchCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // IntelligenceSearchInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* search: "STRING_VALUE", // required
|
|
40
|
+
* excludeExtension: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new IntelligenceSearchCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // IntelligenceSearchOutput
|
|
45
|
+
* // items: [ // DirectoryItems // required
|
|
46
|
+
* // { // DirectoryItem
|
|
47
|
+
* // extension: "STRING_VALUE", // required
|
|
48
|
+
* // name: "STRING_VALUE", // required
|
|
49
|
+
* // department: "STRING_VALUE",
|
|
50
|
+
* // group: "STRING_VALUE",
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param IntelligenceSearchCommandInput - {@link IntelligenceSearchCommandInput}
|
|
58
|
+
* @returns {@link IntelligenceSearchCommandOutput}
|
|
59
|
+
* @see {@link IntelligenceSearchCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link IntelligenceSearchCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ValidationException} (client fault)
|
|
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
|
+
*
|
|
79
|
+
* @throws {@link UsersServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
81
|
+
*
|
|
82
|
+
*
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
export declare class IntelligenceSearchCommand extends IntelligenceSearchCommand_base {
|
|
86
|
+
/** @internal type navigation helper, not in runtime. */
|
|
87
|
+
protected static __types: {
|
|
88
|
+
api: {
|
|
89
|
+
input: IntelligenceSearchInput;
|
|
90
|
+
output: IntelligenceSearchOutput;
|
|
91
|
+
};
|
|
92
|
+
sdk: {
|
|
93
|
+
input: IntelligenceSearchCommandInput;
|
|
94
|
+
output: IntelligenceSearchCommandOutput;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
}
|