@stedi/sdk 0.0.4 → 0.0.10

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

@@ -0,0 +1,141 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetEventDestinationEventInput, GetEventDestinationEventOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetEventDestinationEventCommand}.
+ */
+export interface GetEventDestinationEventCommandInput extends GetEventDestinationEventInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetEventDestinationEventCommand}.
+ */
+export interface GetEventDestinationEventCommandOutput extends GetEventDestinationEventOutput, __MetadataBearer {
+}
+declare const GetEventDestinationEventCommand_base: {
+    new (input: GetEventDestinationEventCommandInput): import("@smithy/core/client").CommandImpl<GetEventDestinationEventCommandInput, GetEventDestinationEventCommandOutput, import("..").StediClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetEventDestinationEventCommandInput): import("@smithy/core/client").CommandImpl<GetEventDestinationEventCommandInput, GetEventDestinationEventCommandOutput, import("..").StediClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the details of an existing event by its identifier.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StediClient, GetEventDestinationEventCommand } from "@stedi/sdk"; // ES Modules import
+ * // const { StediClient, GetEventDestinationEventCommand } = require("@stedi/sdk"); // CommonJS import
+ * // import type { StediClientConfig } from "@stedi/sdk";
+ * const config = {}; // type is StediClientConfig
+ * const client = new StediClient(config);
+ * const input = { // GetEventDestinationEventInput
+ *   eventId: "STRING_VALUE", // required
+ * };
+ * const command = new GetEventDestinationEventCommand(input);
+ * const response = await client.send(command);
+ * // { // GetEventDestinationEventOutput
+ * //   id: "STRING_VALUE", // required
+ * //   status: "PENDING" || "DELIVERED" || "FAILED", // required
+ * //   createdAt: new Date("TIMESTAMP"), // required
+ * //   eventType: "STRING_VALUE", // required
+ * //   eventPayload: { // EventDestinationsEventPayload Union: only one key present
+ * //     v1Event: { // EventDestinationsV1EventPayload
+ * //       object: "v1.event", // required
+ * //       account: "STRING_VALUE", // required
+ * //       environment: "TEST" || "PRODUCTION", // required
+ * //       created: new Date("TIMESTAMP"), // required
+ * //       resource: { // EventDestinationsEventPayloadResourceRef
+ * //         id: "STRING_VALUE", // required
+ * //         type: "STRING_VALUE", // required
+ * //       },
+ * //       id: "STRING_VALUE",
+ * //       type: "STRING_VALUE",
+ * //       relatedResources: [ // EventDestinationsEventPayloadResourceRefList
+ * //         {
+ * //           id: "STRING_VALUE", // required
+ * //           type: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetEventDestinationEventCommandInput - {@link GetEventDestinationEventCommandInput}
+ * @returns {@link GetEventDestinationEventCommandOutput}
+ * @see {@link GetEventDestinationEventCommandInput} for command's `input` shape.
+ * @see {@link GetEventDestinationEventCommandOutput} for command's `response` shape.
+ * @see {@link StediClientResolvedConfig | config} for StediClient's `config` shape.
+ *
+ * @throws {@link AuthenticationFailedException} (client fault)
+ *  The request credentials are missing or not valid.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  The caller is authenticated but lacks permission for this resource or action.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  The service failed unexpectedly. Retry with backoff.
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  The request is not valid. Fix the request before retrying.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  The requested resource does not exist.
+ *
+ * @throws {@link StediServiceException}
+ * <p>Base exception class for all service exceptions from Stedi service.</p>
+ *
+ *
+ * @example Get an event
+ * ```javascript
+ * //
+ * const input = {
+ *   eventId: "evt_550e8400-e29b-41d4-a716-446655440000"
+ * };
+ * const command = new GetEventDestinationEventCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   createdAt: "2026-02-01T12:00:00Z",
+ *   eventPayload: {
+ *     v1Event: {
+ *       account: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+ *       created: "2026-02-01T12:00:00.000Z",
+ *       environment: "PRODUCTION",
+ *       id: "evt_550e8400-e29b-41d4-a716-446655440000",
+ *       object: "v1.event",
+ *       resource: {
+ *         id: "enr_661f9511-f3ac-52e5-b827-557766551111",
+ *         type: "enrollment"
+ *       },
+ *       type: "enrollment.activated"
+ *     }
+ *   },
+ *   eventType: "enrollment.activated",
+ *   id: "evt_550e8400-e29b-41d4-a716-446655440000",
+ *   status: "DELIVERED"
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetEventDestinationEventCommand extends GetEventDestinationEventCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetEventDestinationEventInput;
+            output: GetEventDestinationEventOutput;
+        };
+        sdk: {
+            input: GetEventDestinationEventCommandInput;
+            output: GetEventDestinationEventCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,105 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetEventDestinationSecretInput, GetEventDestinationSecretOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetEventDestinationSecretCommand}.
+ */
+export interface GetEventDestinationSecretCommandInput extends GetEventDestinationSecretInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetEventDestinationSecretCommand}.
+ */
+export interface GetEventDestinationSecretCommandOutput extends GetEventDestinationSecretOutput, __MetadataBearer {
+}
+declare const GetEventDestinationSecretCommand_base: {
+    new (input: GetEventDestinationSecretCommandInput): import("@smithy/core/client").CommandImpl<GetEventDestinationSecretCommandInput, GetEventDestinationSecretCommandOutput, import("..").StediClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetEventDestinationSecretCommandInput): import("@smithy/core/client").CommandImpl<GetEventDestinationSecretCommandInput, GetEventDestinationSecretCommandOutput, import("..").StediClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * Retrieves the current signing secret for a destination. Use this secret to verify the authenticity of event payloads.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { StediClient, GetEventDestinationSecretCommand } from "@stedi/sdk"; // ES Modules import
+ * // const { StediClient, GetEventDestinationSecretCommand } = require("@stedi/sdk"); // CommonJS import
+ * // import type { StediClientConfig } from "@stedi/sdk";
+ * const config = {}; // type is StediClientConfig
+ * const client = new StediClient(config);
+ * const input = { // GetEventDestinationSecretInput
+ *   destinationId: "STRING_VALUE", // required
+ * };
+ * const command = new GetEventDestinationSecretCommand(input);
+ * const response = await client.send(command);
+ * // { // GetEventDestinationSecretOutput
+ * //   signingSecret: "STRING_VALUE", // required
+ * //   previousSecretExpiresAt: new Date("TIMESTAMP"),
+ * // };
+ *
+ * ```
+ *
+ * @param GetEventDestinationSecretCommandInput - {@link GetEventDestinationSecretCommandInput}
+ * @returns {@link GetEventDestinationSecretCommandOutput}
+ * @see {@link GetEventDestinationSecretCommandInput} for command's `input` shape.
+ * @see {@link GetEventDestinationSecretCommandOutput} for command's `response` shape.
+ * @see {@link StediClientResolvedConfig | config} for StediClient's `config` shape.
+ *
+ * @throws {@link AuthenticationFailedException} (client fault)
+ *  The request credentials are missing or not valid.
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  The caller is authenticated but lacks permission for this resource or action.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  The service failed unexpectedly. Retry with backoff.
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  The request is not valid. Fix the request before retrying.
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  The requested resource does not exist.
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  The caller has exceeded a rate limit. Retry with backoff.
+ *
+ * @throws {@link StediServiceException}
+ * <p>Base exception class for all service exceptions from Stedi service.</p>
+ *
+ *
+ * @example Get destination secret
+ * ```javascript
+ * //
+ * const input = {
+ *   destinationId: "dst_550e8400-e29b-41d4-a716-446655440000"
+ * };
+ * const command = new GetEventDestinationSecretCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   signingSecret: "whsec_YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY="
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetEventDestinationSecretCommand extends GetEventDestinationSecretCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetEventDestinationSecretInput;
+            output: GetEventDestinationSecretOutput;
+        };
+        sdk: {
+            input: GetEventDestinationSecretCommandInput;
+            output: GetEventDestinationSecretCommandOutput;
+        };
+    };
+}