@hookdeck/outpost-sdk 0.5.0 → 0.7.0

package/src/models/operations/upserttenant.ts

@@ -2,10 +2,11 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type UpsertTenantGlobals = {
@@ -17,6 +18,10 @@ export type UpsertTenantRequest = {
    * The ID of the tenant. Required when using AdminApiKey authentication.
    */
   tenantId?: string | undefined;
+  /**
+   * Optional tenant metadata
+   */
+  params?: components.TenantUpsert | undefined;
 };
 
 /** @internal */
@@ -31,7 +36,6 @@ export const UpsertTenantGlobals$inboundSchema: z.ZodType<
     "tenant_id": "tenantId",
   });
 });
-
 /** @internal */
 export type UpsertTenantGlobals$Outbound = {
   tenant_id?: string | undefined;
@@ -50,19 +54,6 @@ export const UpsertTenantGlobals$outboundSchema: z.ZodType<
   });
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UpsertTenantGlobals$ {
-  /** @deprecated use `UpsertTenantGlobals$inboundSchema` instead. */
-  export const inboundSchema = UpsertTenantGlobals$inboundSchema;
-  /** @deprecated use `UpsertTenantGlobals$outboundSchema` instead. */
-  export const outboundSchema = UpsertTenantGlobals$outboundSchema;
-  /** @deprecated use `UpsertTenantGlobals$Outbound` instead. */
-  export type Outbound = UpsertTenantGlobals$Outbound;
-}
-
 export function upsertTenantGlobalsToJSON(
   upsertTenantGlobals: UpsertTenantGlobals,
 ): string {
@@ -70,7 +61,6 @@ export function upsertTenantGlobalsToJSON(
     UpsertTenantGlobals$outboundSchema.parse(upsertTenantGlobals),
   );
 }
-
 export function upsertTenantGlobalsFromJSON(
   jsonString: string,
 ): SafeParseResult<UpsertTenantGlobals, SDKValidationError> {
@@ -88,15 +78,16 @@ export const UpsertTenantRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   tenant_id: z.string().optional(),
+  params: components.TenantUpsert$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "tenant_id": "tenantId",
   });
 });
-
 /** @internal */
 export type UpsertTenantRequest$Outbound = {
   tenant_id?: string | undefined;
+  params?: components.TenantUpsert$Outbound | undefined;
 };
 
 /** @internal */
@@ -106,25 +97,13 @@ export const UpsertTenantRequest$outboundSchema: z.ZodType<
   UpsertTenantRequest
 > = z.object({
   tenantId: z.string().optional(),
+  params: components.TenantUpsert$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",
   });
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UpsertTenantRequest$ {
-  /** @deprecated use `UpsertTenantRequest$inboundSchema` instead. */
-  export const inboundSchema = UpsertTenantRequest$inboundSchema;
-  /** @deprecated use `UpsertTenantRequest$outboundSchema` instead. */
-  export const outboundSchema = UpsertTenantRequest$outboundSchema;
-  /** @deprecated use `UpsertTenantRequest$Outbound` instead. */
-  export type Outbound = UpsertTenantRequest$Outbound;
-}
-
 export function upsertTenantRequestToJSON(
   upsertTenantRequest: UpsertTenantRequest,
 ): string {
@@ -132,7 +111,6 @@ export function upsertTenantRequestToJSON(
     UpsertTenantRequest$outboundSchema.parse(upsertTenantRequest),
   );
 }
-
 export function upsertTenantRequestFromJSON(
   jsonString: string,
 ): SafeParseResult<UpsertTenantRequest, SDKValidationError> {

package/src/sdk/attempts.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { attemptsGet } from "../funcs/attemptsGet.js";
+import { attemptsList } from "../funcs/attemptsList.js";
+import { attemptsRetry } from "../funcs/attemptsRetry.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Attempts extends ClientSDK {
+  /**
+   * List Attempts (Admin)
+   *
+   * @remarks
+   * Retrieves a paginated list of attempts across all tenants. This is an admin-only endpoint that requires the Admin API Key.
+   *
+   * When `tenant_id` is not provided, returns attempts from all tenants. When `tenant_id` is provided, returns only attempts for that tenant.
+   */
+  async list(
+    request: operations.AdminListAttemptsRequest,
+    options?: RequestOptions,
+  ): Promise<components.AttemptPaginatedResult> {
+    return unwrapAsync(attemptsList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Attempt
+   *
+   * @remarks
+   * Retrieves details for a specific attempt.
+   *
+   * When authenticated with a Tenant JWT, only attempts belonging to that tenant can be accessed.
+   * When authenticated with Admin API Key, attempts from any tenant can be accessed.
+   */
+  async get(
+    request: operations.GetAttemptRequest,
+    options?: RequestOptions,
+  ): Promise<components.Attempt> {
+    return unwrapAsync(attemptsGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retry Event Delivery
+   *
+   * @remarks
+   * Triggers a retry for delivering an event to a destination. The event must exist and the destination must be enabled and match the event's topic.
+   *
+   * When authenticated with a Tenant JWT, only events belonging to that tenant can be retried.
+   * When authenticated with Admin API Key, events from any tenant can be retried.
+   */
+  async retry(
+    request: components.RetryRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(attemptsRetry(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/destinations.ts

@@ -7,7 +7,9 @@ import { destinationsDelete } from "../funcs/destinationsDelete.js";
 import { destinationsDisable } from "../funcs/destinationsDisable.js";
 import { destinationsEnable } from "../funcs/destinationsEnable.js";
 import { destinationsGet } from "../funcs/destinationsGet.js";
+import { destinationsGetAttempt } from "../funcs/destinationsGetAttempt.js";
 import { destinationsList } from "../funcs/destinationsList.js";
+import { destinationsListAttempts } from "../funcs/destinationsListAttempts.js";
 import { destinationsUpdate } from "../funcs/destinationsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -133,4 +135,38 @@ export class Destinations extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List Destination Attempts
+   *
+   * @remarks
+   * Retrieves a paginated list of attempts scoped to a specific destination.
+   */
+  async listAttempts(
+    request: operations.ListTenantDestinationAttemptsRequest,
+    options?: RequestOptions,
+  ): Promise<components.AttemptPaginatedResult> {
+    return unwrapAsync(destinationsListAttempts(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Destination Attempt
+   *
+   * @remarks
+   * Retrieves details for a specific attempt scoped to a destination.
+   */
+  async getAttempt(
+    request: operations.GetTenantDestinationAttemptRequest,
+    options?: RequestOptions,
+  ): Promise<components.Attempt> {
+    return unwrapAsync(destinationsGetAttempt(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/events.ts

@@ -3,31 +3,26 @@
  */
 
 import { eventsGet } from "../funcs/eventsGet.js";
-import { eventsGetByDestination } from "../funcs/eventsGetByDestination.js";
 import { eventsList } from "../funcs/eventsList.js";
-import { eventsListByDestination } from "../funcs/eventsListByDestination.js";
-import { eventsListDeliveries } from "../funcs/eventsListDeliveries.js";
-import { eventsRetry } from "../funcs/eventsRetry.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
-import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Events extends ClientSDK {
   /**
-   * List Events
+   * List Events (Admin)
    *
    * @remarks
-   * Retrieves a list of events for the tenant, supporting cursor navigation (details TBD) and filtering.
+   * Retrieves a list of events across all tenants. This is an admin-only endpoint that requires the Admin API Key.
+   *
+   * When `tenant_id` is not provided, returns events from all tenants. When `tenant_id` is provided, returns only events for that tenant.
    */
   async list(
-    request: operations.ListTenantEventsRequest,
+    request: operations.AdminListEventsRequest,
     options?: RequestOptions,
-  ): Promise<
-    PageIterator<operations.ListTenantEventsResponse, { cursor: string }>
-  > {
-    return unwrapResultIterator(eventsList(
+  ): Promise<components.EventPaginatedResult> {
+    return unwrapAsync(eventsList(
       this,
       request,
       options,
@@ -39,9 +34,12 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Retrieves details for a specific event.
+   *
+   * When authenticated with a Tenant JWT, only events belonging to that tenant can be accessed.
+   * When authenticated with Admin API Key, events from any tenant can be accessed.
    */
   async get(
-    request: operations.GetTenantEventRequest,
+    request: operations.GetEventRequest,
     options?: RequestOptions,
   ): Promise<components.Event> {
     return unwrapAsync(eventsGet(
@@ -50,77 +48,4 @@ export class Events extends ClientSDK {
       options,
     ));
   }
-
-  /**
-   * List Event Delivery Attempts
-   *
-   * @remarks
-   * Retrieves a list of delivery attempts for a specific event, including response details.
-   */
-  async listDeliveries(
-    request: operations.ListTenantEventDeliveriesRequest,
-    options?: RequestOptions,
-  ): Promise<Array<components.DeliveryAttempt>> {
-    return unwrapAsync(eventsListDeliveries(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * List Events by Destination
-   *
-   * @remarks
-   * Retrieves events associated with a specific destination for the tenant.
-   */
-  async listByDestination(
-    request: operations.ListTenantEventsByDestinationRequest,
-    options?: RequestOptions,
-  ): Promise<
-    PageIterator<
-      operations.ListTenantEventsByDestinationResponse,
-      { cursor: string }
-    >
-  > {
-    return unwrapResultIterator(eventsListByDestination(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Get Event by Destination
-   *
-   * @remarks
-   * Retrieves a specific event associated with a specific destination for the tenant.
-   */
-  async getByDestination(
-    request: operations.GetTenantEventByDestinationRequest,
-    options?: RequestOptions,
-  ): Promise<components.Event> {
-    return unwrapAsync(eventsGetByDestination(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Retry Event Delivery
-   *
-   * @remarks
-   * Triggers a retry for a failed event delivery.
-   */
-  async retry(
-    request: operations.RetryTenantEventRequest,
-    options?: RequestOptions,
-  ): Promise<void> {
-    return unwrapAsync(eventsRetry(
-      this,
-      request,
-      options,
-    ));
-  }
 }

package/src/sdk/health.ts

@@ -4,6 +4,7 @@
 
 import { healthCheck } from "../funcs/healthCheck.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Health extends ClientSDK {
@@ -11,11 +12,23 @@ export class Health extends ClientSDK {
    * Health Check
    *
    * @remarks
-   * Simple health check endpoint.
+   * Health check endpoint that reports the status of all workers.
+   *
+   * Returns HTTP 200 when all workers are healthy, or HTTP 503 if any worker has failed.
+   *
+   * The response includes:
+   * - `status`: Overall health status ("healthy" or "failed")
+   * - `timestamp`: When this health check was performed (ISO 8601 format)
+   * - `workers`: Map of worker names to their individual health status
+   *
+   * Each worker reports:
+   * - `status`: Worker health ("healthy" or "failed")
+   *
+   * Note: Error details are not exposed for security reasons. Check application logs for detailed error information.
    */
   async check(
     options?: RequestOptions,
-  ): Promise<string> {
+  ): Promise<operations.HealthCheckResponse> {
     return unwrapAsync(healthCheck(
       this,
       options,

package/src/sdk/schemas.ts

@@ -2,10 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { schemasGet } from "../funcs/schemasGet.js";
 import { schemasGetDestinationTypeJwt } from "../funcs/schemasGetDestinationTypeJwt.js";
 import { schemasListDestinationTypesJwt } from "../funcs/schemasListDestinationTypesJwt.js";
-import { schemasListTenantDestinationTypes } from "../funcs/schemasListTenantDestinationTypes.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -13,44 +11,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Schemas extends ClientSDK {
   /**
-   * List Destination Type Schemas (for Tenant)
+   * List Destination Type Schemas
    *
    * @remarks
-   * Returns a list of JSON-based input schemas for each available destination type. Requires Admin API Key or Tenant JWT.
-   */
-  async listTenantDestinationTypes(
-    request: operations.ListTenantDestinationTypeSchemasRequest,
-    options?: RequestOptions,
-  ): Promise<Array<components.DestinationTypeSchema>> {
-    return unwrapAsync(schemasListTenantDestinationTypes(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * Get Destination Type Schema (for Tenant)
-   *
-   * @remarks
-   * Returns the input schema for a specific destination type. Requires Admin API Key or Tenant JWT.
-   */
-  async get(
-    request: operations.GetTenantDestinationTypeSchemaRequest,
-    options?: RequestOptions,
-  ): Promise<components.DestinationTypeSchema> {
-    return unwrapAsync(schemasGet(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * List Destination Type Schemas (JWT Auth)
-   *
-   * @remarks
-   * Returns a list of JSON-based input schemas for each available destination type (infers tenant from JWT).
+   * Returns a list of JSON-based input schemas for each available destination type.
    */
   async listDestinationTypesJwt(
     options?: RequestOptions,

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Attempts } from "./attempts.js";
 import { Destinations } from "./destinations.js";
 import { Events } from "./events.js";
 import { Health } from "./health.js";
@@ -22,6 +23,16 @@ export class Outpost extends ClientSDK {
     return (this._tenants ??= new Tenants(this._options));
   }
 
+  private _events?: Events;
+  get events(): Events {
+    return (this._events ??= new Events(this._options));
+  }
+
+  private _attempts?: Attempts;
+  get attempts(): Attempts {
+    return (this._attempts ??= new Attempts(this._options));
+  }
+
   private _destinations?: Destinations;
   get destinations(): Destinations {
     return (this._destinations ??= new Destinations(this._options));
@@ -41,9 +52,4 @@ export class Outpost extends ClientSDK {
   get topics(): Topics {
     return (this._topics ??= new Topics(this._options));
   }
-
-  private _events?: Events;
-  get events(): Events {
-    return (this._events ??= new Events(this._options));
-  }
 }

package/src/sdk/tenants.ts

@@ -6,6 +6,7 @@ import { tenantsDelete } from "../funcs/tenantsDelete.js";
 import { tenantsGet } from "../funcs/tenantsGet.js";
 import { tenantsGetPortalUrl } from "../funcs/tenantsGetPortalUrl.js";
 import { tenantsGetToken } from "../funcs/tenantsGetToken.js";
+import { tenantsListTenants } from "../funcs/tenantsListTenants.js";
 import { tenantsUpsert } from "../funcs/tenantsUpsert.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -13,6 +14,29 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Tenants extends ClientSDK {
+  /**
+   * List Tenants
+   *
+   * @remarks
+   * List all tenants with cursor-based pagination.
+   *
+   * **Requirements:** This endpoint requires Redis with RediSearch module (e.g., `redis/redis-stack-server`).
+   * If RediSearch is not available, this endpoint returns `501 Not Implemented`.
+   *
+   * The response includes lightweight tenant objects without computed fields like `destinations_count` and `topics`.
+   * Use `GET /tenants/{tenant_id}` to retrieve full tenant details including these fields.
+   */
+  async listTenants(
+    request: operations.ListTenantsRequest,
+    options?: RequestOptions,
+  ): Promise<components.TenantPaginatedResult> {
+    return unwrapAsync(tenantsListTenants(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create or Update Tenant
    *

package/src/sdk/topics.ts

@@ -3,39 +3,20 @@
  */
 
 import { topicsList } from "../funcs/topicsList.js";
-import { topicsListJwt } from "../funcs/topicsListJwt.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Topics extends ClientSDK {
   /**
-   * List Available Topics (for Tenant)
+   * List Available Topics
    *
    * @remarks
-   * Returns a list of available event topics configured in the Outpost instance. Requires Admin API Key or Tenant JWT.
+   * Returns a list of available event topics configured in the Outpost instance.
    */
   async list(
-    request: operations.ListTenantTopicsRequest,
     options?: RequestOptions,
   ): Promise<Array<string>> {
     return unwrapAsync(topicsList(
-      this,
-      request,
-      options,
-    ));
-  }
-
-  /**
-   * List Available Topics)
-   *
-   * @remarks
-   * Returns a list of available event topics configured in the Outpost instance.
-   */
-  async listJwt(
-    options?: RequestOptions,
-  ): Promise<Array<string>> {
-    return unwrapAsync(topicsListJwt(
       this,
       options,
     ));

package/src/types/blobs.ts

@@ -2,13 +2,14 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
-export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> =
-  z.custom<Blob>(isBlobLike, {
-    message: "expected a Blob, File or Blob-like object",
-    fatal: true,
-  });
+export const blobLikeSchema: z.ZodType<Blob, z.ZodTypeDef, Blob> = z.custom<
+  Blob
+>(isBlobLike, {
+  message: "expected a Blob, File or Blob-like object",
+  fatal: true,
+});
 
 export function isBlobLike(val: unknown): val is Blob {
   if (val instanceof Blob) {

package/src/types/constdatetime.ts

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+import * as z from "zod/v3";
 
 export function constDateTime(
   val: string,

package/src/types/enums.ts

@@ -2,15 +2,44 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-declare const __brand: unique symbol;
-export type Unrecognized<T> = T & { [__brand]: "unrecognized" };
+import * as z from "zod/v3";
+import { Unrecognized, unrecognized } from "./unrecognized.js";
 
-export function catchUnrecognizedEnum<T>(value: T): Unrecognized<T> {
-  return value as Unrecognized<T>;
+export type ClosedEnum<T extends Readonly<Record<string, string | number>>> =
+  T[keyof T];
+export type OpenEnum<T extends Readonly<Record<string, string | number>>> =
+  | T[keyof T]
+  | Unrecognized<T[keyof T] extends number ? number : string>;
+
+export function inboundSchema<T extends Record<string, string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  const options = Object.values(enumObj);
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.string().transform(x => unrecognized(x)),
+  ] as any);
 }
 
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
-export type ClosedEnum<T> = T[keyof T];
-export type OpenEnum<T> =
-  | Prettify<T[keyof T]>
-  | Unrecognized<T[keyof T] extends number ? number : string>;
+export function inboundSchemaInt<T extends Record<string, number | string>>(
+  enumObj: T,
+): z.ZodType<OpenEnum<T>, z.ZodTypeDef, unknown> {
+  // For numeric enums, Object.values returns both numbers and string keys
+  const options = Object.values(enumObj).filter(v => typeof v === "number");
+  return z.union([
+    ...options.map(x => z.literal(x)),
+    z.number().int().transform(x => unrecognized(x)),
+  ] as any);
+}
+
+export function outboundSchema<T extends Record<string, string>>(
+  _: T,
+): z.ZodType<string, z.ZodTypeDef, OpenEnum<T>> {
+  return z.string() as any;
+}
+
+export function outboundSchemaInt<T extends Record<string, number | string>>(
+  _: T,
+): z.ZodType<number, z.ZodTypeDef, OpenEnum<T>> {
+  return z.number().int() as any;
+}

package/src/types/index.ts

@@ -3,9 +3,9 @@
  */
 
 export { blobLikeSchema, isBlobLike } from "./blobs.js";
-export { catchUnrecognizedEnum } from "./enums.js";
-export type { ClosedEnum, OpenEnum, Unrecognized } from "./enums.js";
+export type { ClosedEnum, OpenEnum } from "./enums.js";
 export type { Result } from "./fp.js";
 export type { PageIterator, Paginator } from "./operations.js";
 export { createPageIterator } from "./operations.js";
 export { RFCDate } from "./rfcdate.js";
+export * from "./unrecognized.js";