@wildix/xbees-users-client 1.1.0 → 1.2.3
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/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/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 +3 -3
- package/dist-types/commands/BatchGetUsersCommand.d.ts +0 -98
- package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +0 -83
- package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +0 -134
- package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +0 -134
- package/dist-types/commands/ChangeUserEmailCommand.d.ts +0 -88
- package/dist-types/commands/CreateBotApiKeyCommand.d.ts +0 -96
- package/dist-types/commands/CreateBotCommand.d.ts +0 -198
- package/dist-types/commands/CreateSystemBotCommand.d.ts +0 -78
- package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +0 -80
- package/dist-types/commands/DeleteBotCommand.d.ts +0 -77
- package/dist-types/commands/GetAppVersionCommand.d.ts +0 -76
- package/dist-types/commands/GetBotCallbackCommand.d.ts +0 -184
- package/dist-types/commands/GetBotCommand.d.ts +0 -90
- package/dist-types/commands/GetUserCommand.d.ts +0 -96
- package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +0 -81
- package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +0 -132
- package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +0 -79
- package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +0 -79
- package/dist-types/commands/IntelligenceSearchCommand.d.ts +0 -85
- package/dist-types/commands/ListBotApiKeysCommand.d.ts +0 -83
- package/dist-types/commands/ListBotsCommand.d.ts +0 -89
- package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +0 -81
- package/dist-types/commands/QueryColleaguesCommand.d.ts +0 -152
- package/dist-types/commands/QueryUserCommand.d.ts +0 -105
- package/dist-types/commands/QueryUsersCommand.d.ts +0 -105
- package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +0 -75
- package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +0 -75
- package/dist-types/commands/UpdateBotCallbackCommand.d.ts +0 -288
- package/dist-types/commands/UpdateBotCommand.d.ts +0 -93
- package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +0 -81
- package/dist-types/commands/UploadPictureCommand.d.ts +0 -76
- package/dist-types/commands/UploadPictureV1Command.d.ts +0 -78
- package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +0 -80
- package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +0 -80
|
@@ -1,134 +0,0 @@
|
|
|
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 UsersServiceException}
|
|
117
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
* @public
|
|
121
|
-
*/
|
|
122
|
-
export declare class BatchGetUsersPbxLinkDataV1Command extends BatchGetUsersPbxLinkDataV1Command_base {
|
|
123
|
-
/** @internal type navigation helper, not in runtime. */
|
|
124
|
-
protected static __types: {
|
|
125
|
-
api: {
|
|
126
|
-
input: BatchGetUsersPbxLinkDataV1Input;
|
|
127
|
-
output: BatchGetUsersPbxLinkDataV1Output;
|
|
128
|
-
};
|
|
129
|
-
sdk: {
|
|
130
|
-
input: BatchGetUsersPbxLinkDataV1CommandInput;
|
|
131
|
-
output: BatchGetUsersPbxLinkDataV1CommandOutput;
|
|
132
|
-
};
|
|
133
|
-
};
|
|
134
|
-
}
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
-
import { ChangeUserEmailInput, ChangeUserEmailOutput } 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 ChangeUserEmailCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface ChangeUserEmailCommandInput extends ChangeUserEmailInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link ChangeUserEmailCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface ChangeUserEmailCommandOutput extends ChangeUserEmailOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const ChangeUserEmailCommand_base: {
|
|
25
|
-
new (input: ChangeUserEmailCommandInput): import("@smithy/smithy-client").CommandImpl<ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (__0_0: ChangeUserEmailCommandInput): import("@smithy/smithy-client").CommandImpl<ChangeUserEmailCommandInput, ChangeUserEmailCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Schedules user's email changing.
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { UsersClient, ChangeUserEmailCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
-
* // const { UsersClient, ChangeUserEmailCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
-
* const client = new UsersClient(config);
|
|
37
|
-
* const input = { // ChangeUserEmailInput
|
|
38
|
-
* newData: { // NewEmailData
|
|
39
|
-
* email: "STRING_VALUE", // required
|
|
40
|
-
* companyId: "STRING_VALUE",
|
|
41
|
-
* pbxDomain: "STRING_VALUE",
|
|
42
|
-
* },
|
|
43
|
-
* oldData: { // OldEmailData
|
|
44
|
-
* email: "STRING_VALUE", // required
|
|
45
|
-
* companyId: "STRING_VALUE",
|
|
46
|
-
* },
|
|
47
|
-
* };
|
|
48
|
-
* const command = new ChangeUserEmailCommand(input);
|
|
49
|
-
* const response = await client.send(command);
|
|
50
|
-
* // { // ChangeUserEmailOutput
|
|
51
|
-
* // sfnArn: "STRING_VALUE", // required
|
|
52
|
-
* // };
|
|
53
|
-
*
|
|
54
|
-
* ```
|
|
55
|
-
*
|
|
56
|
-
* @param ChangeUserEmailCommandInput - {@link ChangeUserEmailCommandInput}
|
|
57
|
-
* @returns {@link ChangeUserEmailCommandOutput}
|
|
58
|
-
* @see {@link ChangeUserEmailCommandInput} for command's `input` shape.
|
|
59
|
-
* @see {@link ChangeUserEmailCommandOutput} for command's `response` shape.
|
|
60
|
-
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
61
|
-
*
|
|
62
|
-
* @throws {@link UserNotFoundException} (client fault)
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link UserCompanyNotValidException} (client fault)
|
|
65
|
-
*
|
|
66
|
-
* @throws {@link ForbiddenException} (client fault)
|
|
67
|
-
*
|
|
68
|
-
* @throws {@link ValidationException} (client fault)
|
|
69
|
-
*
|
|
70
|
-
* @throws {@link UsersServiceException}
|
|
71
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
export declare class ChangeUserEmailCommand extends ChangeUserEmailCommand_base {
|
|
77
|
-
/** @internal type navigation helper, not in runtime. */
|
|
78
|
-
protected static __types: {
|
|
79
|
-
api: {
|
|
80
|
-
input: ChangeUserEmailInput;
|
|
81
|
-
output: ChangeUserEmailOutput;
|
|
82
|
-
};
|
|
83
|
-
sdk: {
|
|
84
|
-
input: ChangeUserEmailCommandInput;
|
|
85
|
-
output: ChangeUserEmailCommandOutput;
|
|
86
|
-
};
|
|
87
|
-
};
|
|
88
|
-
}
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
-
import { CreateBotApiKeyInput, CreateBotApiKeyOutput } 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 CreateBotApiKeyCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface CreateBotApiKeyCommandInput extends CreateBotApiKeyInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link CreateBotApiKeyCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface CreateBotApiKeyCommandOutput extends CreateBotApiKeyOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const CreateBotApiKeyCommand_base: {
|
|
25
|
-
new (input: CreateBotApiKeyCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (__0_0: CreateBotApiKeyCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Creates a new API key for a specific bot.
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { UsersClient, CreateBotApiKeyCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
-
* // const { UsersClient, CreateBotApiKeyCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
-
* const client = new UsersClient(config);
|
|
37
|
-
* const input = { // CreateBotApiKeyInput
|
|
38
|
-
* company: "STRING_VALUE",
|
|
39
|
-
* botId: "STRING_VALUE", // required
|
|
40
|
-
* name: "STRING_VALUE",
|
|
41
|
-
* };
|
|
42
|
-
* const command = new CreateBotApiKeyCommand(input);
|
|
43
|
-
* const response = await client.send(command);
|
|
44
|
-
* // { // CreateBotApiKeyOutput
|
|
45
|
-
* // bot: { // Bot
|
|
46
|
-
* // name: "STRING_VALUE", // required
|
|
47
|
-
* // category: "STRING_VALUE",
|
|
48
|
-
* // picture: "STRING_VALUE",
|
|
49
|
-
* // searchable: true || false,
|
|
50
|
-
* // access: "EVERYBODY" || "ORGANIZATION",
|
|
51
|
-
* // id: "STRING_VALUE", // required
|
|
52
|
-
* // integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
|
|
53
|
-
* // integrationApiKeysCount: Number("int"), // required
|
|
54
|
-
* // createdAt: "STRING_VALUE", // required
|
|
55
|
-
* // updated: "STRING_VALUE",
|
|
56
|
-
* // },
|
|
57
|
-
* // key: { // BotApiKey
|
|
58
|
-
* // secret: "STRING_VALUE", // required
|
|
59
|
-
* // name: "STRING_VALUE",
|
|
60
|
-
* // createdAt: "STRING_VALUE", // required
|
|
61
|
-
* // },
|
|
62
|
-
* // };
|
|
63
|
-
*
|
|
64
|
-
* ```
|
|
65
|
-
*
|
|
66
|
-
* @param CreateBotApiKeyCommandInput - {@link CreateBotApiKeyCommandInput}
|
|
67
|
-
* @returns {@link CreateBotApiKeyCommandOutput}
|
|
68
|
-
* @see {@link CreateBotApiKeyCommandInput} for command's `input` shape.
|
|
69
|
-
* @see {@link CreateBotApiKeyCommandOutput} for command's `response` shape.
|
|
70
|
-
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
71
|
-
*
|
|
72
|
-
* @throws {@link BotNotFoundException} (client fault)
|
|
73
|
-
*
|
|
74
|
-
* @throws {@link ForbiddenException} (client fault)
|
|
75
|
-
*
|
|
76
|
-
* @throws {@link ValidationException} (client fault)
|
|
77
|
-
*
|
|
78
|
-
* @throws {@link UsersServiceException}
|
|
79
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
* @public
|
|
83
|
-
*/
|
|
84
|
-
export declare class CreateBotApiKeyCommand extends CreateBotApiKeyCommand_base {
|
|
85
|
-
/** @internal type navigation helper, not in runtime. */
|
|
86
|
-
protected static __types: {
|
|
87
|
-
api: {
|
|
88
|
-
input: CreateBotApiKeyInput;
|
|
89
|
-
output: CreateBotApiKeyOutput;
|
|
90
|
-
};
|
|
91
|
-
sdk: {
|
|
92
|
-
input: CreateBotApiKeyCommandInput;
|
|
93
|
-
output: CreateBotApiKeyCommandOutput;
|
|
94
|
-
};
|
|
95
|
-
};
|
|
96
|
-
}
|
|
@@ -1,198 +0,0 @@
|
|
|
1
|
-
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
-
import { CreateBotInput, CreateBotOutput } 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 CreateBotCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface CreateBotCommandInput extends CreateBotInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link CreateBotCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface CreateBotCommandOutput extends CreateBotOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const CreateBotCommand_base: {
|
|
25
|
-
new (input: CreateBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotCommandInput, CreateBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (__0_0: CreateBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateBotCommandInput, CreateBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Creates a new bot with the specified configuration and callback settings.
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { UsersClient, CreateBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
-
* // const { UsersClient, CreateBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
-
* const client = new UsersClient(config);
|
|
37
|
-
* const input = { // CreateBotInput
|
|
38
|
-
* name: "STRING_VALUE", // required
|
|
39
|
-
* category: "STRING_VALUE",
|
|
40
|
-
* picture: "STRING_VALUE",
|
|
41
|
-
* searchable: true || false,
|
|
42
|
-
* access: "EVERYBODY" || "ORGANIZATION",
|
|
43
|
-
* company: "STRING_VALUE",
|
|
44
|
-
* callback: { // BotCallback
|
|
45
|
-
* endpoint: { // BotEndpoint Union: only one key present
|
|
46
|
-
* llm: { // BotLlmEndpoint
|
|
47
|
-
* prompt: "STRING_VALUE", // required
|
|
48
|
-
* guidelines: [ // AgentGuidelinesList
|
|
49
|
-
* "STRING_VALUE",
|
|
50
|
-
* ],
|
|
51
|
-
* model: "STRING_VALUE",
|
|
52
|
-
* embeddedTools: [ // BotLlmEmbeddedToolsList
|
|
53
|
-
* { // BotLlmEmbeddedTool
|
|
54
|
-
* type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
|
|
55
|
-
* name: "STRING_VALUE", // required
|
|
56
|
-
* parameters: "DOCUMENT_VALUE",
|
|
57
|
-
* },
|
|
58
|
-
* ],
|
|
59
|
-
* tools: [ // BotLlmToolsList
|
|
60
|
-
* { // BotLlmTool
|
|
61
|
-
* type: "function", // required
|
|
62
|
-
* function: { // BotLlmFunctionDefinition
|
|
63
|
-
* name: "STRING_VALUE", // required
|
|
64
|
-
* description: "STRING_VALUE",
|
|
65
|
-
* parameters: "DOCUMENT_VALUE",
|
|
66
|
-
* integration: { // BotLlmFunctionIntegration Union: only one key present
|
|
67
|
-
* webhook: { // BotLlmFunctionIntegrationWebhook
|
|
68
|
-
* url: "STRING_VALUE", // required
|
|
69
|
-
* method: "get" || "post" || "put" || "delete" || "patch",
|
|
70
|
-
* async: true || false,
|
|
71
|
-
* authorization: { // BotLlmFunctionIntegrationWebhookAuthorization Union: only one key present
|
|
72
|
-
* bearer: { // BotLlmFunctionIntegrationWebhookAuthorizationBearer
|
|
73
|
-
* token: "STRING_VALUE", // required
|
|
74
|
-
* },
|
|
75
|
-
* basic: { // BotLlmFunctionIntegrationWebhookAuthorizationBasic
|
|
76
|
-
* username: "STRING_VALUE", // required
|
|
77
|
-
* password: "STRING_VALUE", // required
|
|
78
|
-
* },
|
|
79
|
-
* oauth: { // BotLlmFunctionIntegrationWebhookAuthorizationOAuth
|
|
80
|
-
* clientId: "STRING_VALUE", // required
|
|
81
|
-
* clientSecret: "STRING_VALUE", // required
|
|
82
|
-
* endpointUrl: "STRING_VALUE", // required
|
|
83
|
-
* scope: "STRING_VALUE",
|
|
84
|
-
* },
|
|
85
|
-
* },
|
|
86
|
-
* headers: [ // BotLlmFunctionIntegrationWebhookHeadersList
|
|
87
|
-
* { // BotLlmFunctionIntegrationWebhookHeader
|
|
88
|
-
* key: "STRING_VALUE", // required
|
|
89
|
-
* value: "STRING_VALUE", // required
|
|
90
|
-
* },
|
|
91
|
-
* ],
|
|
92
|
-
* timeout: Number("int"),
|
|
93
|
-
* parameters: "DOCUMENT_VALUE",
|
|
94
|
-
* },
|
|
95
|
-
* },
|
|
96
|
-
* },
|
|
97
|
-
* },
|
|
98
|
-
* ],
|
|
99
|
-
* capabilities: [ // BotCapabilitiesList
|
|
100
|
-
* { // BotCapability Union: only one key present
|
|
101
|
-
* tool: { // BotCapabilityTool
|
|
102
|
-
* id: "STRING_VALUE", // required
|
|
103
|
-
* variables: [ // BotToolVariablesList
|
|
104
|
-
* { // BotToolVariable
|
|
105
|
-
* name: "STRING_VALUE", // required
|
|
106
|
-
* handler: { // BotToolVariableHandler Union: only one key present
|
|
107
|
-
* auto: {},
|
|
108
|
-
* guided: { // BotToolVariableGuidedHandler
|
|
109
|
-
* description: "STRING_VALUE", // required
|
|
110
|
-
* },
|
|
111
|
-
* predefined: { // BotToolVariablePredefinedHandler
|
|
112
|
-
* description: "STRING_VALUE", // required
|
|
113
|
-
* },
|
|
114
|
-
* },
|
|
115
|
-
* },
|
|
116
|
-
* ],
|
|
117
|
-
* pipeline: { // BotCapabilityToolPipeline
|
|
118
|
-
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
119
|
-
* instructions: "STRING_VALUE",
|
|
120
|
-
* },
|
|
121
|
-
* },
|
|
122
|
-
* kb: { // BotKnowledgeBase
|
|
123
|
-
* knowledgeBaseId: "STRING_VALUE",
|
|
124
|
-
* instructions: "STRING_VALUE",
|
|
125
|
-
* },
|
|
126
|
-
* },
|
|
127
|
-
* ],
|
|
128
|
-
* },
|
|
129
|
-
* dialogflowCx: { // BotDialogflowCxEndpoint
|
|
130
|
-
* credentials: "DOCUMENT_VALUE", // required
|
|
131
|
-
* agent: "STRING_VALUE", // required
|
|
132
|
-
* location: "STRING_VALUE", // required
|
|
133
|
-
* language: "STRING_VALUE", // required
|
|
134
|
-
* },
|
|
135
|
-
* openAiAssistant: { // BotOpenAiAssistantEndpoint
|
|
136
|
-
* key: "STRING_VALUE", // required
|
|
137
|
-
* assistantId: "STRING_VALUE", // required
|
|
138
|
-
* },
|
|
139
|
-
* webhook: { // BotWebhookEndpoint
|
|
140
|
-
* url: "STRING_VALUE", // required
|
|
141
|
-
* secret: "STRING_VALUE", // required
|
|
142
|
-
* },
|
|
143
|
-
* sqs: { // BotSqsEndpoint
|
|
144
|
-
* url: "STRING_VALUE", // required
|
|
145
|
-
* key: "STRING_VALUE", // required
|
|
146
|
-
* secret: "STRING_VALUE", // required
|
|
147
|
-
* },
|
|
148
|
-
* },
|
|
149
|
-
* },
|
|
150
|
-
* };
|
|
151
|
-
* const command = new CreateBotCommand(input);
|
|
152
|
-
* const response = await client.send(command);
|
|
153
|
-
* // { // CreateBotOutput
|
|
154
|
-
* // bot: { // Bot
|
|
155
|
-
* // name: "STRING_VALUE", // required
|
|
156
|
-
* // category: "STRING_VALUE",
|
|
157
|
-
* // picture: "STRING_VALUE",
|
|
158
|
-
* // searchable: true || false,
|
|
159
|
-
* // access: "EVERYBODY" || "ORGANIZATION",
|
|
160
|
-
* // id: "STRING_VALUE", // required
|
|
161
|
-
* // integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
|
|
162
|
-
* // integrationApiKeysCount: Number("int"), // required
|
|
163
|
-
* // createdAt: "STRING_VALUE", // required
|
|
164
|
-
* // updated: "STRING_VALUE",
|
|
165
|
-
* // },
|
|
166
|
-
* // };
|
|
167
|
-
*
|
|
168
|
-
* ```
|
|
169
|
-
*
|
|
170
|
-
* @param CreateBotCommandInput - {@link CreateBotCommandInput}
|
|
171
|
-
* @returns {@link CreateBotCommandOutput}
|
|
172
|
-
* @see {@link CreateBotCommandInput} for command's `input` shape.
|
|
173
|
-
* @see {@link CreateBotCommandOutput} for command's `response` shape.
|
|
174
|
-
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
175
|
-
*
|
|
176
|
-
* @throws {@link ForbiddenException} (client fault)
|
|
177
|
-
*
|
|
178
|
-
* @throws {@link ValidationException} (client fault)
|
|
179
|
-
*
|
|
180
|
-
* @throws {@link UsersServiceException}
|
|
181
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
* @public
|
|
185
|
-
*/
|
|
186
|
-
export declare class CreateBotCommand extends CreateBotCommand_base {
|
|
187
|
-
/** @internal type navigation helper, not in runtime. */
|
|
188
|
-
protected static __types: {
|
|
189
|
-
api: {
|
|
190
|
-
input: CreateBotInput;
|
|
191
|
-
output: CreateBotOutput;
|
|
192
|
-
};
|
|
193
|
-
sdk: {
|
|
194
|
-
input: CreateBotCommandInput;
|
|
195
|
-
output: CreateBotCommandOutput;
|
|
196
|
-
};
|
|
197
|
-
};
|
|
198
|
-
}
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
-
import { CreateSystemBotInput, CreateSystemBotOutput } 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 CreateSystemBotCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface CreateSystemBotCommandInput extends CreateSystemBotInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link CreateSystemBotCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface CreateSystemBotCommandOutput extends CreateSystemBotOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const CreateSystemBotCommand_base: {
|
|
25
|
-
new (input: CreateSystemBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSystemBotCommandInput, CreateSystemBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (__0_0: CreateSystemBotCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSystemBotCommandInput, CreateSystemBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Creates a new system bot with basic configuration for internal use.
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { UsersClient, CreateSystemBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
-
* // const { UsersClient, CreateSystemBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
-
* const client = new UsersClient(config);
|
|
37
|
-
* const input = { // CreateSystemBotInput
|
|
38
|
-
* company: "STRING_VALUE",
|
|
39
|
-
* name: "STRING_VALUE", // required
|
|
40
|
-
* picture: "STRING_VALUE",
|
|
41
|
-
* };
|
|
42
|
-
* const command = new CreateSystemBotCommand(input);
|
|
43
|
-
* const response = await client.send(command);
|
|
44
|
-
* // { // CreateSystemBotOutput
|
|
45
|
-
* // id: "STRING_VALUE", // required
|
|
46
|
-
* // };
|
|
47
|
-
*
|
|
48
|
-
* ```
|
|
49
|
-
*
|
|
50
|
-
* @param CreateSystemBotCommandInput - {@link CreateSystemBotCommandInput}
|
|
51
|
-
* @returns {@link CreateSystemBotCommandOutput}
|
|
52
|
-
* @see {@link CreateSystemBotCommandInput} for command's `input` shape.
|
|
53
|
-
* @see {@link CreateSystemBotCommandOutput} for command's `response` shape.
|
|
54
|
-
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
55
|
-
*
|
|
56
|
-
* @throws {@link ForbiddenException} (client fault)
|
|
57
|
-
*
|
|
58
|
-
* @throws {@link ValidationException} (client fault)
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link UsersServiceException}
|
|
61
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* @public
|
|
65
|
-
*/
|
|
66
|
-
export declare class CreateSystemBotCommand extends CreateSystemBotCommand_base {
|
|
67
|
-
/** @internal type navigation helper, not in runtime. */
|
|
68
|
-
protected static __types: {
|
|
69
|
-
api: {
|
|
70
|
-
input: CreateSystemBotInput;
|
|
71
|
-
output: CreateSystemBotOutput;
|
|
72
|
-
};
|
|
73
|
-
sdk: {
|
|
74
|
-
input: CreateSystemBotCommandInput;
|
|
75
|
-
output: CreateSystemBotCommandOutput;
|
|
76
|
-
};
|
|
77
|
-
};
|
|
78
|
-
}
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
-
import { DeleteBotApiKeyInput, DeleteBotApiKeyOutput } 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 DeleteBotApiKeyCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface DeleteBotApiKeyCommandInput extends DeleteBotApiKeyInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link DeleteBotApiKeyCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface DeleteBotApiKeyCommandOutput extends DeleteBotApiKeyOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const DeleteBotApiKeyCommand_base: {
|
|
25
|
-
new (input: DeleteBotApiKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (__0_0: DeleteBotApiKeyCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Deletes an existing API key for a specific bot.
|
|
31
|
-
* @example
|
|
32
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
-
* ```javascript
|
|
34
|
-
* import { UsersClient, DeleteBotApiKeyCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
-
* // const { UsersClient, DeleteBotApiKeyCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
-
* const client = new UsersClient(config);
|
|
37
|
-
* const input = { // DeleteBotApiKeyInput
|
|
38
|
-
* company: "STRING_VALUE",
|
|
39
|
-
* botId: "STRING_VALUE", // required
|
|
40
|
-
* apiKeySecret: "STRING_VALUE", // required
|
|
41
|
-
* };
|
|
42
|
-
* const command = new DeleteBotApiKeyCommand(input);
|
|
43
|
-
* const response = await client.send(command);
|
|
44
|
-
* // {};
|
|
45
|
-
*
|
|
46
|
-
* ```
|
|
47
|
-
*
|
|
48
|
-
* @param DeleteBotApiKeyCommandInput - {@link DeleteBotApiKeyCommandInput}
|
|
49
|
-
* @returns {@link DeleteBotApiKeyCommandOutput}
|
|
50
|
-
* @see {@link DeleteBotApiKeyCommandInput} for command's `input` shape.
|
|
51
|
-
* @see {@link DeleteBotApiKeyCommandOutput} for command's `response` shape.
|
|
52
|
-
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
53
|
-
*
|
|
54
|
-
* @throws {@link BotNotFoundException} (client fault)
|
|
55
|
-
*
|
|
56
|
-
* @throws {@link BotApiKeyNotFoundException} (client fault)
|
|
57
|
-
*
|
|
58
|
-
* @throws {@link ForbiddenException} (client fault)
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link ValidationException} (client fault)
|
|
61
|
-
*
|
|
62
|
-
* @throws {@link UsersServiceException}
|
|
63
|
-
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
export declare class DeleteBotApiKeyCommand extends DeleteBotApiKeyCommand_base {
|
|
69
|
-
/** @internal type navigation helper, not in runtime. */
|
|
70
|
-
protected static __types: {
|
|
71
|
-
api: {
|
|
72
|
-
input: DeleteBotApiKeyInput;
|
|
73
|
-
output: {};
|
|
74
|
-
};
|
|
75
|
-
sdk: {
|
|
76
|
-
input: DeleteBotApiKeyCommandInput;
|
|
77
|
-
output: DeleteBotApiKeyCommandOutput;
|
|
78
|
-
};
|
|
79
|
-
};
|
|
80
|
-
}
|