@wildix/xbees-users-client 1.2.3 → 1.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist-types/commands/AddIdentityCommand.d.ts +93 -0
  2. package/dist-types/commands/BatchGetUsersCommand.d.ts +110 -0
  3. package/dist-types/commands/BatchGetUsersEmailNotificationsSettingsCommand.d.ts +95 -0
  4. package/dist-types/commands/BatchGetUsersPbxLinkDataCommand.d.ts +146 -0
  5. package/dist-types/commands/BatchGetUsersPbxLinkDataV1Command.d.ts +146 -0
  6. package/dist-types/commands/ChangeUserEmailCommand.d.ts +100 -0
  7. package/dist-types/commands/CreateBotApiKeyCommand.d.ts +108 -0
  8. package/dist-types/commands/CreateBotCommand.d.ts +210 -0
  9. package/dist-types/commands/CreateSystemBotCommand.d.ts +90 -0
  10. package/dist-types/commands/DeleteBotApiKeyCommand.d.ts +92 -0
  11. package/dist-types/commands/DeleteBotCommand.d.ts +89 -0
  12. package/dist-types/commands/GetAccountCommand.d.ts +182 -0
  13. package/dist-types/commands/GetAppVersionCommand.d.ts +88 -0
  14. package/dist-types/commands/GetBotCallbackCommand.d.ts +196 -0
  15. package/dist-types/commands/GetBotCommand.d.ts +102 -0
  16. package/dist-types/commands/GetUserCommand.d.ts +108 -0
  17. package/dist-types/commands/GetUserEmailNotificationsSettingsCommand.d.ts +93 -0
  18. package/dist-types/commands/GetUserPbxLinkDataCommand.d.ts +144 -0
  19. package/dist-types/commands/GetUserPbxLinkSuggestionCommand.d.ts +91 -0
  20. package/dist-types/commands/GetUserPbxLinkSuggestionV1Command.d.ts +91 -0
  21. package/dist-types/commands/IntelligenceSearchCommand.d.ts +97 -0
  22. package/dist-types/commands/InviteCommand.d.ts +116 -0
  23. package/dist-types/commands/ListAccountIdentitiesCommand.d.ts +94 -0
  24. package/dist-types/commands/ListBotApiKeysCommand.d.ts +95 -0
  25. package/dist-types/commands/ListBotsCommand.d.ts +101 -0
  26. package/dist-types/commands/ListWorkspacesCommand.d.ts +170 -0
  27. package/dist-types/commands/PartialUpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
  28. package/dist-types/commands/QueryColleaguesCommand.d.ts +164 -0
  29. package/dist-types/commands/QueryUserCommand.d.ts +117 -0
  30. package/dist-types/commands/QueryUsersCommand.d.ts +117 -0
  31. package/dist-types/commands/RemoveIdentityCommand.d.ts +87 -0
  32. package/dist-types/commands/ToggleTranscriptionEmailNotificationsSubscriptionCommand.d.ts +87 -0
  33. package/dist-types/commands/ToggleUnreadEmailNotificationsSubscriptionCommand.d.ts +87 -0
  34. package/dist-types/commands/UnbindWorkspaceCommand.d.ts +87 -0
  35. package/dist-types/commands/UpdateAccountCommand.d.ts +94 -0
  36. package/dist-types/commands/UpdateBotCallbackCommand.d.ts +300 -0
  37. package/dist-types/commands/UpdateBotCommand.d.ts +105 -0
  38. package/dist-types/commands/UpdateUserEmailNotificationsSettingsCommand.d.ts +93 -0
  39. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +171 -0
  40. package/dist-types/commands/UploadPictureCommand.d.ts +88 -0
  41. package/dist-types/commands/UploadPictureV1Command.d.ts +90 -0
  42. package/dist-types/commands/VerifyAddIdentityCommand.d.ts +95 -0
  43. package/dist-types/commands/VerifyBotSecretKeyCommand.d.ts +92 -0
  44. package/dist-types/commands/VerifyBotSecretKeyV1Command.d.ts +92 -0
  45. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  46. package/dist-types/runtimeConfig.d.ts +1 -1
  47. package/dist-types/runtimeConfig.native.d.ts +1 -1
  48. package/package.json +2 -2
@@ -0,0 +1,89 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { DeleteBotInput, DeleteBotOutput } 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 DeleteBotCommand}.
14
+ */
15
+ export interface DeleteBotCommandInput extends DeleteBotInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteBotCommand}.
21
+ */
22
+ export interface DeleteBotCommandOutput extends DeleteBotOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteBotCommand_base: {
25
+ new (input: DeleteBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotCommandInput, DeleteBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteBotCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteBotCommandInput, DeleteBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Deletes an existing bot and all its associated data.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, DeleteBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, DeleteBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // DeleteBotInput
38
+ * company: "STRING_VALUE",
39
+ * botId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new DeleteBotCommand(input);
42
+ * const response = await client.send(command);
43
+ * // {};
44
+ *
45
+ * ```
46
+ *
47
+ * @param DeleteBotCommandInput - {@link DeleteBotCommandInput}
48
+ * @returns {@link DeleteBotCommandOutput}
49
+ * @see {@link DeleteBotCommandInput} for command's `input` shape.
50
+ * @see {@link DeleteBotCommandOutput} for command's `response` shape.
51
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
52
+ *
53
+ * @throws {@link BotNotFoundException} (client fault)
54
+ *
55
+ * @throws {@link ForbiddenException} (client fault)
56
+ *
57
+ * @throws {@link ValidationException} (client fault)
58
+ *
59
+ * @throws {@link AccountNotFoundException} (client fault)
60
+ *
61
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
62
+ *
63
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
64
+ *
65
+ * @throws {@link WorkspaceNotFoundException} (client fault)
66
+ *
67
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
68
+ *
69
+ * @throws {@link IdentityNotFoundException} (client fault)
70
+ *
71
+ * @throws {@link UsersServiceException}
72
+ * <p>Base exception class for all service exceptions from Users service.</p>
73
+ *
74
+ *
75
+ * @public
76
+ */
77
+ export declare class DeleteBotCommand extends DeleteBotCommand_base {
78
+ /** @internal type navigation helper, not in runtime. */
79
+ protected static __types: {
80
+ api: {
81
+ input: DeleteBotInput;
82
+ output: {};
83
+ };
84
+ sdk: {
85
+ input: DeleteBotCommandInput;
86
+ output: DeleteBotCommandOutput;
87
+ };
88
+ };
89
+ }
@@ -0,0 +1,182 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { GetAccountInput, GetAccountOutput } 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 GetAccountCommand}.
14
+ */
15
+ export interface GetAccountCommandInput extends GetAccountInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAccountCommand}.
21
+ */
22
+ export interface GetAccountCommandOutput extends GetAccountOutput, __MetadataBearer {
23
+ }
24
+ declare const GetAccountCommand_base: {
25
+ new (input: GetAccountCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccountCommandInput, GetAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAccountCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccountCommandInput, GetAccountCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves the current account with identities and workspaces.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, GetAccountCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, GetAccountCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // GetAccountInput
38
+ * accountId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetAccountCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAccountOutput
43
+ * // account: { // Account
44
+ * // id: "STRING_VALUE", // required
45
+ * // defaultWorkspace: "STRING_VALUE",
46
+ * // primaryIdentity: "STRING_VALUE",
47
+ * // },
48
+ * // workspaces: [ // WorkspaceList // required
49
+ * // { // Workspace
50
+ * // companyId: "STRING_VALUE",
51
+ * // pbxUser: { // UserPbxLinkData
52
+ * // id: "STRING_VALUE", // required
53
+ * // company: "STRING_VALUE", // required
54
+ * // companyName: "STRING_VALUE",
55
+ * // domain: "STRING_VALUE", // required
56
+ * // email: "STRING_VALUE",
57
+ * // info: { // UserPersonalInfo
58
+ * // dn: "STRING_VALUE", // required
59
+ * // id: "STRING_VALUE", // required
60
+ * // name: "STRING_VALUE", // required
61
+ * // extension: "STRING_VALUE", // required
62
+ * // officePhone: "STRING_VALUE",
63
+ * // mobilePhone: "STRING_VALUE",
64
+ * // faxNumber: "STRING_VALUE",
65
+ * // email: "STRING_VALUE",
66
+ * // role: "STRING_VALUE", // required
67
+ * // language: "STRING_VALUE", // required
68
+ * // dialplan: "STRING_VALUE", // required
69
+ * // faxDialplan: "STRING_VALUE", // required
70
+ * // departament: "STRING_VALUE",
71
+ * // picture: "STRING_VALUE", // required
72
+ * // groupDn: "STRING_VALUE", // required
73
+ * // groupName: "STRING_VALUE", // required
74
+ * // jid: "STRING_VALUE", // required
75
+ * // licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
76
+ * // login: "STRING_VALUE",
77
+ * // pbx: "STRING_VALUE",
78
+ * // pbxDn: "STRING_VALUE", // required
79
+ * // sourceId: "STRING_VALUE",
80
+ * // sipPassword: "STRING_VALUE",
81
+ * // },
82
+ * // pbx: { // UserPbxInfo
83
+ * // networkAddresses: [ // UserPbxInfoNetworkAddresses // required
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // ports: [ // UserPbxInfoPorts // required
87
+ * // "STRING_VALUE",
88
+ * // ],
89
+ * // externalLinePrefix: "STRING_VALUE",
90
+ * // version: "STRING_VALUE", // required
91
+ * // serial: "STRING_VALUE", // required
92
+ * // },
93
+ * // picture: "STRING_VALUE", // required
94
+ * // pictureDeleted: true || false,
95
+ * // port: "STRING_VALUE", // required
96
+ * // serial: "STRING_VALUE", // required
97
+ * // services: { // UserPbxServices
98
+ * // xcaracal: true || false,
99
+ * // wizyWebinar: true || false,
100
+ * // },
101
+ * // personalSettings: {},
102
+ * // dialplanSettings: {},
103
+ * // awsRegion: "STRING_VALUE",
104
+ * // updatedAt: "STRING_VALUE",
105
+ * // },
106
+ * // streamUser: { // User
107
+ * // id: "STRING_VALUE", // required
108
+ * // name: "STRING_VALUE",
109
+ * // email: "STRING_VALUE",
110
+ * // phone: "STRING_VALUE",
111
+ * // picture: "STRING_VALUE",
112
+ * // locale: "STRING_VALUE",
113
+ * // timeZone: "STRING_VALUE",
114
+ * // company: "STRING_VALUE",
115
+ * // bot: true || false,
116
+ * // pbxDomain: "STRING_VALUE",
117
+ * // pbxPort: "STRING_VALUE",
118
+ * // pbxExtension: "STRING_VALUE",
119
+ * // pbxSerial: "STRING_VALUE",
120
+ * // pbxUserId: "STRING_VALUE",
121
+ * // pbxGroupId: "STRING_VALUE",
122
+ * // createdAt: "STRING_VALUE",
123
+ * // updatedAt: "STRING_VALUE",
124
+ * // },
125
+ * // type: "personal" || "work" || "support",
126
+ * // id: "STRING_VALUE", // required
127
+ * // accountId: "STRING_VALUE", // required
128
+ * // active: true || false, // required
129
+ * // },
130
+ * // ],
131
+ * // identities: [ // IdentityList // required
132
+ * // { // Identity
133
+ * // identity: "STRING_VALUE", // required
134
+ * // account: "STRING_VALUE", // required
135
+ * // verified: true || false,
136
+ * // },
137
+ * // ],
138
+ * // };
139
+ *
140
+ * ```
141
+ *
142
+ * @param GetAccountCommandInput - {@link GetAccountCommandInput}
143
+ * @returns {@link GetAccountCommandOutput}
144
+ * @see {@link GetAccountCommandInput} for command's `input` shape.
145
+ * @see {@link GetAccountCommandOutput} for command's `response` shape.
146
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
147
+ *
148
+ * @throws {@link AccountNotFoundException} (client fault)
149
+ *
150
+ * @throws {@link ForbiddenException} (client fault)
151
+ *
152
+ * @throws {@link ValidationException} (client fault)
153
+ *
154
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
155
+ *
156
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
157
+ *
158
+ * @throws {@link WorkspaceNotFoundException} (client fault)
159
+ *
160
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
161
+ *
162
+ * @throws {@link IdentityNotFoundException} (client fault)
163
+ *
164
+ * @throws {@link UsersServiceException}
165
+ * <p>Base exception class for all service exceptions from Users service.</p>
166
+ *
167
+ *
168
+ * @public
169
+ */
170
+ export declare class GetAccountCommand extends GetAccountCommand_base {
171
+ /** @internal type navigation helper, not in runtime. */
172
+ protected static __types: {
173
+ api: {
174
+ input: GetAccountInput;
175
+ output: GetAccountOutput;
176
+ };
177
+ sdk: {
178
+ input: GetAccountCommandInput;
179
+ output: GetAccountCommandOutput;
180
+ };
181
+ };
182
+ }
@@ -0,0 +1,88 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { GetAppVersionInput, GetAppVersionOutput } 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 GetAppVersionCommand}.
14
+ */
15
+ export interface GetAppVersionCommandInput extends GetAppVersionInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAppVersionCommand}.
21
+ */
22
+ export interface GetAppVersionCommandOutput extends GetAppVersionOutput, __MetadataBearer {
23
+ }
24
+ declare const GetAppVersionCommand_base: {
25
+ new (input: GetAppVersionCommandInput): import("@smithy/smithy-client").CommandImpl<GetAppVersionCommandInput, GetAppVersionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAppVersionCommandInput): import("@smithy/smithy-client").CommandImpl<GetAppVersionCommandInput, GetAppVersionCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Returns the current Google Play Store version of the Android app for the specified appType (X-Bees, X-Hoppers, Collaboration).
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { UsersClient, GetAppVersionCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, GetAppVersionCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // GetAppVersionInput
38
+ * appType: "x-bees" || "x-hoppers" || "collaboration", // required
39
+ * };
40
+ * const command = new GetAppVersionCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetAppVersionOutput
43
+ * // version: "STRING_VALUE", // required
44
+ * // };
45
+ *
46
+ * ```
47
+ *
48
+ * @param GetAppVersionCommandInput - {@link GetAppVersionCommandInput}
49
+ * @returns {@link GetAppVersionCommandOutput}
50
+ * @see {@link GetAppVersionCommandInput} for command's `input` shape.
51
+ * @see {@link GetAppVersionCommandOutput} for command's `response` shape.
52
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
53
+ *
54
+ * @throws {@link ForbiddenException} (client fault)
55
+ *
56
+ * @throws {@link ValidationException} (client fault)
57
+ *
58
+ * @throws {@link AccountNotFoundException} (client fault)
59
+ *
60
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
61
+ *
62
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
63
+ *
64
+ * @throws {@link WorkspaceNotFoundException} (client fault)
65
+ *
66
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
67
+ *
68
+ * @throws {@link IdentityNotFoundException} (client fault)
69
+ *
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 GetAppVersionCommand extends GetAppVersionCommand_base {
77
+ /** @internal type navigation helper, not in runtime. */
78
+ protected static __types: {
79
+ api: {
80
+ input: GetAppVersionInput;
81
+ output: GetAppVersionOutput;
82
+ };
83
+ sdk: {
84
+ input: GetAppVersionCommandInput;
85
+ output: GetAppVersionCommandOutput;
86
+ };
87
+ };
88
+ }
@@ -0,0 +1,196 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { GetBotCallbackInput, GetBotCallbackOutput } 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 GetBotCallbackCommand}.
14
+ */
15
+ export interface GetBotCallbackCommandInput extends GetBotCallbackInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetBotCallbackCommand}.
21
+ */
22
+ export interface GetBotCallbackCommandOutput extends GetBotCallbackOutput, __MetadataBearer {
23
+ }
24
+ declare const GetBotCallbackCommand_base: {
25
+ new (input: GetBotCallbackCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCallbackCommandInput, GetBotCallbackCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetBotCallbackCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCallbackCommandInput, GetBotCallbackCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves 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, GetBotCallbackCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, GetBotCallbackCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // GetBotCallbackInput
38
+ * company: "STRING_VALUE",
39
+ * botId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetBotCallbackCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetBotCallbackOutput
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
+ *
152
+ * ```
153
+ *
154
+ * @param GetBotCallbackCommandInput - {@link GetBotCallbackCommandInput}
155
+ * @returns {@link GetBotCallbackCommandOutput}
156
+ * @see {@link GetBotCallbackCommandInput} for command's `input` shape.
157
+ * @see {@link GetBotCallbackCommandOutput} for command's `response` shape.
158
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
159
+ *
160
+ * @throws {@link BotNotFoundException} (client fault)
161
+ *
162
+ * @throws {@link ForbiddenException} (client fault)
163
+ *
164
+ * @throws {@link ValidationException} (client fault)
165
+ *
166
+ * @throws {@link AccountNotFoundException} (client fault)
167
+ *
168
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
169
+ *
170
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
171
+ *
172
+ * @throws {@link WorkspaceNotFoundException} (client fault)
173
+ *
174
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
175
+ *
176
+ * @throws {@link IdentityNotFoundException} (client fault)
177
+ *
178
+ * @throws {@link UsersServiceException}
179
+ * <p>Base exception class for all service exceptions from Users service.</p>
180
+ *
181
+ *
182
+ * @public
183
+ */
184
+ export declare class GetBotCallbackCommand extends GetBotCallbackCommand_base {
185
+ /** @internal type navigation helper, not in runtime. */
186
+ protected static __types: {
187
+ api: {
188
+ input: GetBotCallbackInput;
189
+ output: GetBotCallbackOutput;
190
+ };
191
+ sdk: {
192
+ input: GetBotCallbackCommandInput;
193
+ output: GetBotCallbackCommandOutput;
194
+ };
195
+ };
196
+ }
@@ -0,0 +1,102 @@
1
+ import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
2
+ import { GetBotInput, GetBotOutput } 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 GetBotCommand}.
14
+ */
15
+ export interface GetBotCommandInput extends GetBotInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetBotCommand}.
21
+ */
22
+ export interface GetBotCommandOutput extends GetBotOutput, __MetadataBearer {
23
+ }
24
+ declare const GetBotCommand_base: {
25
+ new (input: GetBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCommandInput, GetBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetBotCommandInput): import("@smithy/smithy-client").CommandImpl<GetBotCommandInput, GetBotCommandOutput, UsersClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Retrieves details of a specific bot by its 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, GetBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
35
+ * // const { UsersClient, GetBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
36
+ * const client = new UsersClient(config);
37
+ * const input = { // GetBotInput
38
+ * company: "STRING_VALUE",
39
+ * botId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetBotCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // GetBotOutput
44
+ * // bot: { // Bot
45
+ * // name: "STRING_VALUE", // required
46
+ * // category: "STRING_VALUE",
47
+ * // picture: "STRING_VALUE",
48
+ * // searchable: true || false,
49
+ * // access: "EVERYBODY" || "ORGANIZATION",
50
+ * // id: "STRING_VALUE", // required
51
+ * // integrationType: "LLM" || "DIALOGFLOW_CX" || "OPEN_AI_ASSISTANT" || "WEBHOOK" || "SQS", // required
52
+ * // integrationApiKeysCount: Number("int"), // required
53
+ * // createdAt: "STRING_VALUE", // required
54
+ * // updated: "STRING_VALUE",
55
+ * // },
56
+ * // };
57
+ *
58
+ * ```
59
+ *
60
+ * @param GetBotCommandInput - {@link GetBotCommandInput}
61
+ * @returns {@link GetBotCommandOutput}
62
+ * @see {@link GetBotCommandInput} for command's `input` shape.
63
+ * @see {@link GetBotCommandOutput} for command's `response` shape.
64
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
65
+ *
66
+ * @throws {@link BotNotFoundException} (client fault)
67
+ *
68
+ * @throws {@link ForbiddenException} (client fault)
69
+ *
70
+ * @throws {@link ValidationException} (client fault)
71
+ *
72
+ * @throws {@link AccountNotFoundException} (client fault)
73
+ *
74
+ * @throws {@link IdentityAlreadyLinkedException} (client fault)
75
+ *
76
+ * @throws {@link CannotRemovePrimaryIdentityException} (client fault)
77
+ *
78
+ * @throws {@link WorkspaceNotFoundException} (client fault)
79
+ *
80
+ * @throws {@link CannotUnbindDefaultWorkspaceException} (client fault)
81
+ *
82
+ * @throws {@link IdentityNotFoundException} (client fault)
83
+ *
84
+ * @throws {@link UsersServiceException}
85
+ * <p>Base exception class for all service exceptions from Users service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class GetBotCommand extends GetBotCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: GetBotInput;
95
+ output: GetBotOutput;
96
+ };
97
+ sdk: {
98
+ input: GetBotCommandInput;
99
+ output: GetBotCommandOutput;
100
+ };
101
+ };
102
+ }