@wildix/xbees-users-client 1.0.1 → 1.0.3

package/dist-types/commands/BatchGetUsersStreamLinkDataCommand.d.ts

@@ -65,6 +65,8 @@ export interface BatchGetUsersStreamLinkDataCommandOutput extends BatchGetUsersS
  * @see {@link BatchGetUsersStreamLinkDataCommandOutput} for command's `response` shape.
  * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
  *
+ * @throws {@link ForbiddenException} (client fault)
+ *
  * @throws {@link ValidationException} (client fault)
  *
  * @throws {@link UsersServiceException}

package/dist-types/commands/CreateBotApiKeyCommand.d.ts

@@ -0,0 +1,113 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { CreateBotApiKeyInput, CreateBotApiKeyOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateBotApiKeyCommand}.
+ */
+export interface CreateBotApiKeyCommandInput extends CreateBotApiKeyInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateBotApiKeyCommand}.
+ */
+export interface CreateBotApiKeyCommandOutput extends CreateBotApiKeyOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, CreateBotApiKeyCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, CreateBotApiKeyCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // CreateBotApiKeyInput
+ *   company: "STRING_VALUE",
+ *   botId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ * };
+ * const command = new CreateBotApiKeyCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateBotApiKeyOutput
+ * //   bot: { // Bot
+ * //     id: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     secret: "STRING_VALUE", // required
+ * //     visibility: { // BotVisibilitySettings
+ * //       search: true || false,
+ * //       mention: true || false,
+ * //     },
+ * //     callback: { // BotCallbackSettings Union: only one key present
+ * //       webhook: { // BotCallbackWebhook
+ * //         url: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //         triggers: { // BotCallbackTriggers
+ * //           channel: true || false,
+ * //           company: true || false,
+ * //           mention: true || false,
+ * //         },
+ * //       },
+ * //       sqs: { // BotCallbackSqs
+ * //         url: "STRING_VALUE", // required
+ * //         key: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //         triggers: {
+ * //           channel: true || false,
+ * //           company: true || false,
+ * //           mention: true || false,
+ * //         },
+ * //       },
+ * //     },
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updated: "STRING_VALUE",
+ * //   },
+ * //   key: { // BotApiKey
+ * //     secret: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE",
+ * //     createdAt: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateBotApiKeyCommandInput - {@link CreateBotApiKeyCommandInput}
+ * @returns {@link CreateBotApiKeyCommandOutput}
+ * @see {@link CreateBotApiKeyCommandInput} for command's `input` shape.
+ * @see {@link CreateBotApiKeyCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class CreateBotApiKeyCommand extends $Command<CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput, UsersClientResolvedConfig> {
+    readonly input: CreateBotApiKeyCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: CreateBotApiKeyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBotApiKeyCommandInput, CreateBotApiKeyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/CreateBotCommand.d.ts

@@ -0,0 +1,132 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { CreateBotInput, CreateBotOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateBotCommand}.
+ */
+export interface CreateBotCommandInput extends CreateBotInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateBotCommand}.
+ */
+export interface CreateBotCommandOutput extends CreateBotOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, CreateBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, CreateBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // CreateBotInput
+ *   company: "STRING_VALUE",
+ *   name: "STRING_VALUE", // required
+ *   visibility: { // BotVisibilitySettings
+ *     search: true || false,
+ *     mention: true || false,
+ *   },
+ *   callback: { // BotCallbackSettings Union: only one key present
+ *     webhook: { // BotCallbackWebhook
+ *       url: "STRING_VALUE", // required
+ *       secret: "STRING_VALUE", // required
+ *       triggers: { // BotCallbackTriggers
+ *         channel: true || false,
+ *         company: true || false,
+ *         mention: true || false,
+ *       },
+ *     },
+ *     sqs: { // BotCallbackSqs
+ *       url: "STRING_VALUE", // required
+ *       key: "STRING_VALUE", // required
+ *       secret: "STRING_VALUE", // required
+ *       triggers: {
+ *         channel: true || false,
+ *         company: true || false,
+ *         mention: true || false,
+ *       },
+ *     },
+ *   },
+ * };
+ * const command = new CreateBotCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateBotOutput
+ * //   bot: { // Bot
+ * //     id: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE", // required
+ * //     secret: "STRING_VALUE", // required
+ * //     visibility: { // BotVisibilitySettings
+ * //       search: true || false,
+ * //       mention: true || false,
+ * //     },
+ * //     callback: { // BotCallbackSettings Union: only one key present
+ * //       webhook: { // BotCallbackWebhook
+ * //         url: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //         triggers: { // BotCallbackTriggers
+ * //           channel: true || false,
+ * //           company: true || false,
+ * //           mention: true || false,
+ * //         },
+ * //       },
+ * //       sqs: { // BotCallbackSqs
+ * //         url: "STRING_VALUE", // required
+ * //         key: "STRING_VALUE", // required
+ * //         secret: "STRING_VALUE", // required
+ * //         triggers: {
+ * //           channel: true || false,
+ * //           company: true || false,
+ * //           mention: true || false,
+ * //         },
+ * //       },
+ * //     },
+ * //     createdAt: "STRING_VALUE", // required
+ * //     updated: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateBotCommandInput - {@link CreateBotCommandInput}
+ * @returns {@link CreateBotCommandOutput}
+ * @see {@link CreateBotCommandInput} for command's `input` shape.
+ * @see {@link CreateBotCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class CreateBotCommand extends $Command<CreateBotCommandInput, CreateBotCommandOutput, UsersClientResolvedConfig> {
+    readonly input: CreateBotCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: CreateBotCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBotCommandInput, CreateBotCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/DeleteBotApiKeyCommand.d.ts

@@ -0,0 +1,79 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { DeleteBotApiKeyInput, DeleteBotApiKeyOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteBotApiKeyCommand}.
+ */
+export interface DeleteBotApiKeyCommandInput extends DeleteBotApiKeyInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteBotApiKeyCommand}.
+ */
+export interface DeleteBotApiKeyCommandOutput extends DeleteBotApiKeyOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, DeleteBotApiKeyCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, DeleteBotApiKeyCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // DeleteBotApiKeyInput
+ *   company: "STRING_VALUE",
+ *   botId: "STRING_VALUE", // required
+ *   apiKeySecret: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteBotApiKeyCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteBotApiKeyCommandInput - {@link DeleteBotApiKeyCommandInput}
+ * @returns {@link DeleteBotApiKeyCommandOutput}
+ * @see {@link DeleteBotApiKeyCommandInput} for command's `input` shape.
+ * @see {@link DeleteBotApiKeyCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link BotNotFoundException} (client fault)
+ *
+ * @throws {@link BotApiKeyNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class DeleteBotApiKeyCommand extends $Command<DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput, UsersClientResolvedConfig> {
+    readonly input: DeleteBotApiKeyCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: DeleteBotApiKeyCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteBotApiKeyCommandInput, DeleteBotApiKeyCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/DeleteBotCommand.d.ts

@@ -0,0 +1,76 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { DeleteBotInput, DeleteBotOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DeleteBotCommand}.
+ */
+export interface DeleteBotCommandInput extends DeleteBotInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DeleteBotCommand}.
+ */
+export interface DeleteBotCommandOutput extends DeleteBotOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, DeleteBotCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, DeleteBotCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // DeleteBotInput
+ *   company: "STRING_VALUE",
+ *   botId: "STRING_VALUE", // required
+ * };
+ * const command = new DeleteBotCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param DeleteBotCommandInput - {@link DeleteBotCommandInput}
+ * @returns {@link DeleteBotCommandOutput}
+ * @see {@link DeleteBotCommandInput} for command's `input` shape.
+ * @see {@link DeleteBotCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link BotNotFoundException} (client fault)
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class DeleteBotCommand extends $Command<DeleteBotCommandInput, DeleteBotCommandOutput, UsersClientResolvedConfig> {
+    readonly input: DeleteBotCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: DeleteBotCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteBotCommandInput, DeleteBotCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListBotApiKeysCommand.d.ts

@@ -0,0 +1,82 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { ListBotApiKeysInput, ListBotApiKeysOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListBotApiKeysCommand}.
+ */
+export interface ListBotApiKeysCommandInput extends ListBotApiKeysInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListBotApiKeysCommand}.
+ */
+export interface ListBotApiKeysCommandOutput extends ListBotApiKeysOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, ListBotApiKeysCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, ListBotApiKeysCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // ListBotApiKeysInput
+ *   company: "STRING_VALUE",
+ *   botId: "STRING_VALUE", // required
+ * };
+ * const command = new ListBotApiKeysCommand(input);
+ * const response = await client.send(command);
+ * // { // ListBotApiKeysOutput
+ * //   keys: [ // BotApiKeysList // required
+ * //     { // BotApiKey
+ * //       secret: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //       createdAt: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListBotApiKeysCommandInput - {@link ListBotApiKeysCommandInput}
+ * @returns {@link ListBotApiKeysCommandOutput}
+ * @see {@link ListBotApiKeysCommandInput} for command's `input` shape.
+ * @see {@link ListBotApiKeysCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class ListBotApiKeysCommand extends $Command<ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput, UsersClientResolvedConfig> {
+    readonly input: ListBotApiKeysCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: ListBotApiKeysCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBotApiKeysCommandInput, ListBotApiKeysCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/ListBotsCommand.d.ts

@@ -0,0 +1,108 @@
+import { ServiceInputTypes, ServiceOutputTypes, UsersClientResolvedConfig } from "../UsersClient";
+import { ListBotsInput, ListBotsOutput } from "../models/models_0";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@smithy/types";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListBotsCommand}.
+ */
+export interface ListBotsCommandInput extends ListBotsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListBotsCommand}.
+ */
+export interface ListBotsCommandOutput extends ListBotsOutput, __MetadataBearer {
+}
+/**
+ * @public
+ *
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { UsersClient, ListBotsCommand } from "@wildix/xbees-users-client"; // ES Modules import
+ * // const { UsersClient, ListBotsCommand } = require("@wildix/xbees-users-client"); // CommonJS import
+ * const client = new UsersClient(config);
+ * const input = { // ListBotsInput
+ *   company: "STRING_VALUE",
+ * };
+ * const command = new ListBotsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListBotsOutput
+ * //   bots: [ // BotList // required
+ * //     { // Bot
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE", // required
+ * //       secret: "STRING_VALUE", // required
+ * //       visibility: { // BotVisibilitySettings
+ * //         search: true || false,
+ * //         mention: true || false,
+ * //       },
+ * //       callback: { // BotCallbackSettings Union: only one key present
+ * //         webhook: { // BotCallbackWebhook
+ * //           url: "STRING_VALUE", // required
+ * //           secret: "STRING_VALUE", // required
+ * //           triggers: { // BotCallbackTriggers
+ * //             channel: true || false,
+ * //             company: true || false,
+ * //             mention: true || false,
+ * //           },
+ * //         },
+ * //         sqs: { // BotCallbackSqs
+ * //           url: "STRING_VALUE", // required
+ * //           key: "STRING_VALUE", // required
+ * //           secret: "STRING_VALUE", // required
+ * //           triggers: {
+ * //             channel: true || false,
+ * //             company: true || false,
+ * //             mention: true || false,
+ * //           },
+ * //         },
+ * //       },
+ * //       createdAt: "STRING_VALUE", // required
+ * //       updated: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListBotsCommandInput - {@link ListBotsCommandInput}
+ * @returns {@link ListBotsCommandOutput}
+ * @see {@link ListBotsCommandInput} for command's `input` shape.
+ * @see {@link ListBotsCommandOutput} for command's `response` shape.
+ * @see {@link UsersClientResolvedConfig | config} for UsersClient's `config` shape.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link UsersServiceException}
+ * <p>Base exception class for all service exceptions from Users service.</p>
+ *
+ */
+export declare class ListBotsCommand extends $Command<ListBotsCommandInput, ListBotsCommandOutput, UsersClientResolvedConfig> {
+    readonly input: ListBotsCommandInput;
+    /**
+     * @public
+     */
+    constructor(input: ListBotsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: UsersClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListBotsCommandInput, ListBotsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}