@wildix/wilma-agents-client 1.0.1

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

@@ -0,0 +1,96 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { CreateAgentApiKeyInput, CreateAgentApiKeyOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateAgentApiKeyCommand}.
+ */
+export interface CreateAgentApiKeyCommandInput extends CreateAgentApiKeyInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateAgentApiKeyCommand}.
+ */
+export interface CreateAgentApiKeyCommandOutput extends CreateAgentApiKeyOutput, __MetadataBearer {
+}
+declare const CreateAgentApiKeyCommand_base: {
+    new (input: CreateAgentApiKeyCommandInput): import("@smithy/core/client").CommandImpl<CreateAgentApiKeyCommandInput, CreateAgentApiKeyCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: CreateAgentApiKeyCommandInput): import("@smithy/core/client").CommandImpl<CreateAgentApiKeyCommandInput, CreateAgentApiKeyCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * Creates a new API key for an agent. The secret is returned only in this response and cannot be retrieved later.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, CreateAgentApiKeyCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, CreateAgentApiKeyCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
+ * // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
+ * const config = {}; // type is WilmaAgentsClientConfig
+ * const client = new WilmaAgentsClient(config);
+ * const input = { // CreateAgentApiKeyInput
+ *   company: "STRING_VALUE",
+ *   agentId: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   expiresAt: "STRING_VALUE",
+ * };
+ * const command = new CreateAgentApiKeyCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateAgentApiKeyOutput
+ * //   key: { // AgentApiKey
+ * //     id: "STRING_VALUE", // required
+ * //     name: "STRING_VALUE",
+ * //     prefix: "STRING_VALUE", // required
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: { // Actor
+ * //       type: "user" || "api_key" || "service", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //     expiresAt: "STRING_VALUE",
+ * //     lastUsedAt: "STRING_VALUE",
+ * //   },
+ * //   secret: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param CreateAgentApiKeyCommandInput - {@link CreateAgentApiKeyCommandInput}
+ * @returns {@link CreateAgentApiKeyCommandOutput}
+ * @see {@link CreateAgentApiKeyCommandInput} for command's `input` shape.
+ * @see {@link CreateAgentApiKeyCommandOutput} for command's `response` shape.
+ * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
+ *
+ * @throws {@link AgentNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WilmaAgentsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
+ *
+ *
+ * @public
+ */
+export declare class CreateAgentApiKeyCommand extends CreateAgentApiKeyCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateAgentApiKeyInput;
+            output: CreateAgentApiKeyOutput;
+        };
+        sdk: {
+            input: CreateAgentApiKeyCommandInput;
+            output: CreateAgentApiKeyCommandOutput;
+        };
+    };
+}