@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,87 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UnbindWorkspaceInput, UnbindWorkspaceOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UnbindWorkspaceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UnbindWorkspaceCommandInput extends UnbindWorkspaceInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UnbindWorkspaceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UnbindWorkspaceCommandOutput extends UnbindWorkspaceOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UnbindWorkspaceCommand_base: {
|
|
25
|
+
new (input: UnbindWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UnbindWorkspaceCommandInput, UnbindWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UnbindWorkspaceCommandInput): import("@smithy/smithy-client").CommandImpl<UnbindWorkspaceCommandInput, UnbindWorkspaceCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes the connection between the account and a workspace.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, UnbindWorkspaceCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UnbindWorkspaceCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UnbindWorkspaceInput
|
|
38
|
+
* workspaceId: "STRING_VALUE", // required
|
|
39
|
+
* accountId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new UnbindWorkspaceCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // {};
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param UnbindWorkspaceCommandInput - {@link UnbindWorkspaceCommandInput}
|
|
48
|
+
* @returns {@link UnbindWorkspaceCommandOutput}
|
|
49
|
+
* @see {@link UnbindWorkspaceCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link UnbindWorkspaceCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ValidationException} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link UsersServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class UnbindWorkspaceCommand extends UnbindWorkspaceCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: UnbindWorkspaceInput;
|
|
80
|
+
output: {};
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: UnbindWorkspaceCommandInput;
|
|
84
|
+
output: UnbindWorkspaceCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateAccountInput, UpdateAccountOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateAccountCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateAccountCommandInput extends UpdateAccountInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateAccountCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateAccountCommandOutput extends UpdateAccountOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateAccountCommand_base: {
|
|
25
|
+
new (input: UpdateAccountCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCommandInput, UpdateAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateAccountCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateAccountCommandInput, UpdateAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Updates the account. Allows changing default workspace and primary identity.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, UpdateAccountCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateAccountCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateAccountInput
|
|
38
|
+
* accountId: "STRING_VALUE", // required
|
|
39
|
+
* defaultWorkspace: "STRING_VALUE",
|
|
40
|
+
* primaryIdentity: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateAccountCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // UpdateAccountOutput
|
|
45
|
+
* // account: { // Account
|
|
46
|
+
* // id: "STRING_VALUE", // required
|
|
47
|
+
* // defaultWorkspace: "STRING_VALUE",
|
|
48
|
+
* // primaryIdentity: "STRING_VALUE",
|
|
49
|
+
* // },
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param UpdateAccountCommandInput - {@link UpdateAccountCommandInput}
|
|
55
|
+
* @returns {@link UpdateAccountCommandOutput}
|
|
56
|
+
* @see {@link UpdateAccountCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link UpdateAccountCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link UsersServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class UpdateAccountCommand extends UpdateAccountCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: UpdateAccountInput;
|
|
87
|
+
output: UpdateAccountOutput;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: UpdateAccountCommandInput;
|
|
91
|
+
output: UpdateAccountCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateBotCallbackInput, UpdateBotCallbackOutput } 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 UpdateBotCallbackCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateBotCallbackCommandInput extends UpdateBotCallbackInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateBotCallbackCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateBotCallbackCommandOutput extends UpdateBotCallbackOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateBotCallbackCommand_base: {
|
|
25
|
+
new (input: UpdateBotCallbackCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateBotCallbackCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCallbackCommandInput, UpdateBotCallbackCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Updates the callback configuration 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, UpdateBotCallbackCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateBotCallbackCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateBotCallbackInput
|
|
38
|
+
* company: "STRING_VALUE",
|
|
39
|
+
* botId: "STRING_VALUE", // required
|
|
40
|
+
* callback: { // BotCallback
|
|
41
|
+
* endpoint: { // BotEndpoint Union: only one key present
|
|
42
|
+
* llm: { // BotLlmEndpoint
|
|
43
|
+
* prompt: "STRING_VALUE", // required
|
|
44
|
+
* guidelines: [ // AgentGuidelinesList
|
|
45
|
+
* "STRING_VALUE",
|
|
46
|
+
* ],
|
|
47
|
+
* model: "STRING_VALUE",
|
|
48
|
+
* embeddedTools: [ // BotLlmEmbeddedToolsList
|
|
49
|
+
* { // BotLlmEmbeddedTool
|
|
50
|
+
* type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
|
|
51
|
+
* name: "STRING_VALUE", // required
|
|
52
|
+
* parameters: "DOCUMENT_VALUE",
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* tools: [ // BotLlmToolsList
|
|
56
|
+
* { // BotLlmTool
|
|
57
|
+
* type: "function", // required
|
|
58
|
+
* function: { // BotLlmFunctionDefinition
|
|
59
|
+
* name: "STRING_VALUE", // required
|
|
60
|
+
* description: "STRING_VALUE",
|
|
61
|
+
* parameters: "DOCUMENT_VALUE",
|
|
62
|
+
* integration: { // BotLlmFunctionIntegration Union: only one key present
|
|
63
|
+
* webhook: { // BotLlmFunctionIntegrationWebhook
|
|
64
|
+
* url: "STRING_VALUE", // required
|
|
65
|
+
* method: "get" || "post" || "put" || "delete" || "patch",
|
|
66
|
+
* async: true || false,
|
|
67
|
+
* authorization: { // BotLlmFunctionIntegrationWebhookAuthorization Union: only one key present
|
|
68
|
+
* bearer: { // BotLlmFunctionIntegrationWebhookAuthorizationBearer
|
|
69
|
+
* token: "STRING_VALUE", // required
|
|
70
|
+
* },
|
|
71
|
+
* basic: { // BotLlmFunctionIntegrationWebhookAuthorizationBasic
|
|
72
|
+
* username: "STRING_VALUE", // required
|
|
73
|
+
* password: "STRING_VALUE", // required
|
|
74
|
+
* },
|
|
75
|
+
* oauth: { // BotLlmFunctionIntegrationWebhookAuthorizationOAuth
|
|
76
|
+
* clientId: "STRING_VALUE", // required
|
|
77
|
+
* clientSecret: "STRING_VALUE", // required
|
|
78
|
+
* endpointUrl: "STRING_VALUE", // required
|
|
79
|
+
* scope: "STRING_VALUE",
|
|
80
|
+
* },
|
|
81
|
+
* },
|
|
82
|
+
* headers: [ // BotLlmFunctionIntegrationWebhookHeadersList
|
|
83
|
+
* { // BotLlmFunctionIntegrationWebhookHeader
|
|
84
|
+
* key: "STRING_VALUE", // required
|
|
85
|
+
* value: "STRING_VALUE", // required
|
|
86
|
+
* },
|
|
87
|
+
* ],
|
|
88
|
+
* timeout: Number("int"),
|
|
89
|
+
* parameters: "DOCUMENT_VALUE",
|
|
90
|
+
* },
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
93
|
+
* },
|
|
94
|
+
* ],
|
|
95
|
+
* capabilities: [ // BotCapabilitiesList
|
|
96
|
+
* { // BotCapability Union: only one key present
|
|
97
|
+
* tool: { // BotCapabilityTool
|
|
98
|
+
* id: "STRING_VALUE", // required
|
|
99
|
+
* variables: [ // BotToolVariablesList
|
|
100
|
+
* { // BotToolVariable
|
|
101
|
+
* name: "STRING_VALUE", // required
|
|
102
|
+
* handler: { // BotToolVariableHandler Union: only one key present
|
|
103
|
+
* auto: {},
|
|
104
|
+
* guided: { // BotToolVariableGuidedHandler
|
|
105
|
+
* description: "STRING_VALUE", // required
|
|
106
|
+
* },
|
|
107
|
+
* predefined: { // BotToolVariablePredefinedHandler
|
|
108
|
+
* description: "STRING_VALUE", // required
|
|
109
|
+
* },
|
|
110
|
+
* },
|
|
111
|
+
* },
|
|
112
|
+
* ],
|
|
113
|
+
* pipeline: { // BotCapabilityToolPipeline
|
|
114
|
+
* type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
115
|
+
* instructions: "STRING_VALUE",
|
|
116
|
+
* },
|
|
117
|
+
* },
|
|
118
|
+
* kb: { // BotKnowledgeBase
|
|
119
|
+
* knowledgeBaseId: "STRING_VALUE",
|
|
120
|
+
* instructions: "STRING_VALUE",
|
|
121
|
+
* },
|
|
122
|
+
* },
|
|
123
|
+
* ],
|
|
124
|
+
* },
|
|
125
|
+
* dialogflowCx: { // BotDialogflowCxEndpoint
|
|
126
|
+
* credentials: "DOCUMENT_VALUE", // required
|
|
127
|
+
* agent: "STRING_VALUE", // required
|
|
128
|
+
* location: "STRING_VALUE", // required
|
|
129
|
+
* language: "STRING_VALUE", // required
|
|
130
|
+
* },
|
|
131
|
+
* openAiAssistant: { // BotOpenAiAssistantEndpoint
|
|
132
|
+
* key: "STRING_VALUE", // required
|
|
133
|
+
* assistantId: "STRING_VALUE", // required
|
|
134
|
+
* },
|
|
135
|
+
* webhook: { // BotWebhookEndpoint
|
|
136
|
+
* url: "STRING_VALUE", // required
|
|
137
|
+
* secret: "STRING_VALUE", // required
|
|
138
|
+
* },
|
|
139
|
+
* sqs: { // BotSqsEndpoint
|
|
140
|
+
* url: "STRING_VALUE", // required
|
|
141
|
+
* key: "STRING_VALUE", // required
|
|
142
|
+
* secret: "STRING_VALUE", // required
|
|
143
|
+
* },
|
|
144
|
+
* },
|
|
145
|
+
* },
|
|
146
|
+
* };
|
|
147
|
+
* const command = new UpdateBotCallbackCommand(input);
|
|
148
|
+
* const response = await client.send(command);
|
|
149
|
+
* // { // UpdateBotCallbackOutput
|
|
150
|
+
* // callback: { // BotCallback
|
|
151
|
+
* // endpoint: { // BotEndpoint Union: only one key present
|
|
152
|
+
* // llm: { // BotLlmEndpoint
|
|
153
|
+
* // prompt: "STRING_VALUE", // required
|
|
154
|
+
* // guidelines: [ // AgentGuidelinesList
|
|
155
|
+
* // "STRING_VALUE",
|
|
156
|
+
* // ],
|
|
157
|
+
* // model: "STRING_VALUE",
|
|
158
|
+
* // embeddedTools: [ // BotLlmEmbeddedToolsList
|
|
159
|
+
* // { // BotLlmEmbeddedTool
|
|
160
|
+
* // type: "HANDOVER" || "DELEGATE" || "SUGGESTIONS", // required
|
|
161
|
+
* // name: "STRING_VALUE", // required
|
|
162
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
163
|
+
* // },
|
|
164
|
+
* // ],
|
|
165
|
+
* // tools: [ // BotLlmToolsList
|
|
166
|
+
* // { // BotLlmTool
|
|
167
|
+
* // type: "function", // required
|
|
168
|
+
* // function: { // BotLlmFunctionDefinition
|
|
169
|
+
* // name: "STRING_VALUE", // required
|
|
170
|
+
* // description: "STRING_VALUE",
|
|
171
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
172
|
+
* // integration: { // BotLlmFunctionIntegration Union: only one key present
|
|
173
|
+
* // webhook: { // BotLlmFunctionIntegrationWebhook
|
|
174
|
+
* // url: "STRING_VALUE", // required
|
|
175
|
+
* // method: "get" || "post" || "put" || "delete" || "patch",
|
|
176
|
+
* // async: true || false,
|
|
177
|
+
* // authorization: { // BotLlmFunctionIntegrationWebhookAuthorization Union: only one key present
|
|
178
|
+
* // bearer: { // BotLlmFunctionIntegrationWebhookAuthorizationBearer
|
|
179
|
+
* // token: "STRING_VALUE", // required
|
|
180
|
+
* // },
|
|
181
|
+
* // basic: { // BotLlmFunctionIntegrationWebhookAuthorizationBasic
|
|
182
|
+
* // username: "STRING_VALUE", // required
|
|
183
|
+
* // password: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // oauth: { // BotLlmFunctionIntegrationWebhookAuthorizationOAuth
|
|
186
|
+
* // clientId: "STRING_VALUE", // required
|
|
187
|
+
* // clientSecret: "STRING_VALUE", // required
|
|
188
|
+
* // endpointUrl: "STRING_VALUE", // required
|
|
189
|
+
* // scope: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // },
|
|
192
|
+
* // headers: [ // BotLlmFunctionIntegrationWebhookHeadersList
|
|
193
|
+
* // { // BotLlmFunctionIntegrationWebhookHeader
|
|
194
|
+
* // key: "STRING_VALUE", // required
|
|
195
|
+
* // value: "STRING_VALUE", // required
|
|
196
|
+
* // },
|
|
197
|
+
* // ],
|
|
198
|
+
* // timeout: Number("int"),
|
|
199
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
200
|
+
* // },
|
|
201
|
+
* // },
|
|
202
|
+
* // },
|
|
203
|
+
* // },
|
|
204
|
+
* // ],
|
|
205
|
+
* // capabilities: [ // BotCapabilitiesList
|
|
206
|
+
* // { // BotCapability Union: only one key present
|
|
207
|
+
* // tool: { // BotCapabilityTool
|
|
208
|
+
* // id: "STRING_VALUE", // required
|
|
209
|
+
* // variables: [ // BotToolVariablesList
|
|
210
|
+
* // { // BotToolVariable
|
|
211
|
+
* // name: "STRING_VALUE", // required
|
|
212
|
+
* // handler: { // BotToolVariableHandler Union: only one key present
|
|
213
|
+
* // auto: {},
|
|
214
|
+
* // guided: { // BotToolVariableGuidedHandler
|
|
215
|
+
* // description: "STRING_VALUE", // required
|
|
216
|
+
* // },
|
|
217
|
+
* // predefined: { // BotToolVariablePredefinedHandler
|
|
218
|
+
* // description: "STRING_VALUE", // required
|
|
219
|
+
* // },
|
|
220
|
+
* // },
|
|
221
|
+
* // },
|
|
222
|
+
* // ],
|
|
223
|
+
* // pipeline: { // BotCapabilityToolPipeline
|
|
224
|
+
* // type: "blocking_request" || "blocking_request_guided" || "async_request" || "async_request_guided",
|
|
225
|
+
* // instructions: "STRING_VALUE",
|
|
226
|
+
* // },
|
|
227
|
+
* // },
|
|
228
|
+
* // kb: { // BotKnowledgeBase
|
|
229
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
230
|
+
* // instructions: "STRING_VALUE",
|
|
231
|
+
* // },
|
|
232
|
+
* // },
|
|
233
|
+
* // ],
|
|
234
|
+
* // },
|
|
235
|
+
* // dialogflowCx: { // BotDialogflowCxEndpoint
|
|
236
|
+
* // credentials: "DOCUMENT_VALUE", // required
|
|
237
|
+
* // agent: "STRING_VALUE", // required
|
|
238
|
+
* // location: "STRING_VALUE", // required
|
|
239
|
+
* // language: "STRING_VALUE", // required
|
|
240
|
+
* // },
|
|
241
|
+
* // openAiAssistant: { // BotOpenAiAssistantEndpoint
|
|
242
|
+
* // key: "STRING_VALUE", // required
|
|
243
|
+
* // assistantId: "STRING_VALUE", // required
|
|
244
|
+
* // },
|
|
245
|
+
* // webhook: { // BotWebhookEndpoint
|
|
246
|
+
* // url: "STRING_VALUE", // required
|
|
247
|
+
* // secret: "STRING_VALUE", // required
|
|
248
|
+
* // },
|
|
249
|
+
* // sqs: { // BotSqsEndpoint
|
|
250
|
+
* // url: "STRING_VALUE", // required
|
|
251
|
+
* // key: "STRING_VALUE", // required
|
|
252
|
+
* // secret: "STRING_VALUE", // required
|
|
253
|
+
* // },
|
|
254
|
+
* // },
|
|
255
|
+
* // },
|
|
256
|
+
* // };
|
|
257
|
+
*
|
|
258
|
+
* ```
|
|
259
|
+
*
|
|
260
|
+
* @param UpdateBotCallbackCommandInput - {@link UpdateBotCallbackCommandInput}
|
|
261
|
+
* @returns {@link UpdateBotCallbackCommandOutput}
|
|
262
|
+
* @see {@link UpdateBotCallbackCommandInput} for command's `input` shape.
|
|
263
|
+
* @see {@link UpdateBotCallbackCommandOutput} for command's `response` shape.
|
|
264
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
265
|
+
*
|
|
266
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
267
|
+
*
|
|
268
|
+
* @throws {@link ValidationException} (client fault)
|
|
269
|
+
*
|
|
270
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
271
|
+
*
|
|
272
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
273
|
+
*
|
|
274
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
275
|
+
*
|
|
276
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
277
|
+
*
|
|
278
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
279
|
+
*
|
|
280
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
281
|
+
*
|
|
282
|
+
* @throws {@link UsersServiceException}
|
|
283
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
284
|
+
*
|
|
285
|
+
*
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export declare class UpdateBotCallbackCommand extends UpdateBotCallbackCommand_base {
|
|
289
|
+
/** @internal type navigation helper, not in runtime. */
|
|
290
|
+
protected static __types: {
|
|
291
|
+
api: {
|
|
292
|
+
input: UpdateBotCallbackInput;
|
|
293
|
+
output: UpdateBotCallbackOutput;
|
|
294
|
+
};
|
|
295
|
+
sdk: {
|
|
296
|
+
input: UpdateBotCallbackCommandInput;
|
|
297
|
+
output: UpdateBotCallbackCommandOutput;
|
|
298
|
+
};
|
|
299
|
+
};
|
|
300
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateBotInput, UpdateBotOutput } 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 UpdateBotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateBotCommandInput extends UpdateBotInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateBotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateBotCommandOutput extends UpdateBotOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateBotCommand_base: {
|
|
25
|
+
new (input: UpdateBotCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCommandInput, UpdateBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateBotCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateBotCommandInput, UpdateBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Updates the configuration of an existing bot.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { UsersClient, UpdateBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateBotInput
|
|
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
|
+
* botId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new UpdateBotCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // UpdateBotOutput
|
|
49
|
+
* // bot: { // Bot
|
|
50
|
+
* // name: "STRING_VALUE", // required
|
|
51
|
+
* // category: "STRING_VALUE",
|
|
52
|
+
* // picture: "STRING_VALUE",
|
|
53
|
+
* // searchable: true || false,
|
|
54
|
+
* // access: "EVERYBODY" || "ORGANIZATION",
|
|
55
|
+
* // id: "STRING_VALUE", // required
|
|
56
|
+
* // integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
|
|
57
|
+
* // integrationApiKeysCount: Number("int"), // required
|
|
58
|
+
* // createdAt: "STRING_VALUE", // required
|
|
59
|
+
* // updated: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
63
|
+
* ```
|
|
64
|
+
*
|
|
65
|
+
* @param UpdateBotCommandInput - {@link UpdateBotCommandInput}
|
|
66
|
+
* @returns {@link UpdateBotCommandOutput}
|
|
67
|
+
* @see {@link UpdateBotCommandInput} for command's `input` shape.
|
|
68
|
+
* @see {@link UpdateBotCommandOutput} for command's `response` shape.
|
|
69
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ValidationException} (client fault)
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link AccountNotFoundException} (client fault)
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link IdentityAlreadyLinkedException} (client fault)
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link CannotRemovePrimaryIdentityException} (client fault)
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link WorkspaceNotFoundException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link IdentityNotFoundException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link UsersServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from Users service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class UpdateBotCommand extends UpdateBotCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: UpdateBotInput;
|
|
98
|
+
output: UpdateBotOutput;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: UpdateBotCommandInput;
|
|
102
|
+
output: UpdateBotCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
|
|
2
|
+
import { UpdateUserEmailNotificationsSettingsInput, UpdateUserEmailNotificationsSettingsOutput } 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 UpdateUserEmailNotificationsSettingsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateUserEmailNotificationsSettingsCommandInput extends UpdateUserEmailNotificationsSettingsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateUserEmailNotificationsSettingsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateUserEmailNotificationsSettingsCommandOutput extends UpdateUserEmailNotificationsSettingsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateUserEmailNotificationsSettingsCommand_base: {
|
|
25
|
+
new (input: UpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserEmailNotificationsSettingsCommandInput, UpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateUserEmailNotificationsSettingsCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateUserEmailNotificationsSettingsCommandInput, UpdateUserEmailNotificationsSettingsCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Update 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, UpdateUserEmailNotificationsSettingsCommand } from "@wildix/xbees-users-client"; // ES Modules import
|
|
35
|
+
* // const { UsersClient, UpdateUserEmailNotificationsSettingsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
|
|
36
|
+
* const client = new UsersClient(config);
|
|
37
|
+
* const input = { // UpdateUserEmailNotificationsSettingsInput
|
|
38
|
+
* unread: true || false,
|
|
39
|
+
* transcription: true || false,
|
|
40
|
+
* userId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new UpdateUserEmailNotificationsSettingsCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // UpdateUserEmailNotificationsSettingsOutput
|
|
45
|
+
* // notifications: { // UserEmailNotificationsSettings
|
|
46
|
+
* // unread: true || false, // required
|
|
47
|
+
* // transcription: true || false, // required
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param UpdateUserEmailNotificationsSettingsCommandInput - {@link UpdateUserEmailNotificationsSettingsCommandInput}
|
|
54
|
+
* @returns {@link UpdateUserEmailNotificationsSettingsCommandOutput}
|
|
55
|
+
* @see {@link UpdateUserEmailNotificationsSettingsCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link UpdateUserEmailNotificationsSettingsCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
|
|
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 UpdateUserEmailNotificationsSettingsCommand extends UpdateUserEmailNotificationsSettingsCommand_base {
|
|
82
|
+
/** @internal type navigation helper, not in runtime. */
|
|
83
|
+
protected static __types: {
|
|
84
|
+
api: {
|
|
85
|
+
input: UpdateUserEmailNotificationsSettingsInput;
|
|
86
|
+
output: UpdateUserEmailNotificationsSettingsOutput;
|
|
87
|
+
};
|
|
88
|
+
sdk: {
|
|
89
|
+
input: UpdateUserEmailNotificationsSettingsCommandInput;
|
|
90
|
+
output: UpdateUserEmailNotificationsSettingsCommandOutput;
|
|
91
|
+
};
|
|
92
|
+
};
|
|
93
|
+
}
|