@hookdeck/outpost-sdk 0.6.0 → 0.7.0

package/src/models/operations/listtenantdestinationattempts.ts

@@ -0,0 +1,382 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListTenantDestinationAttemptsGlobals = {
+  tenantId?: string | undefined;
+};
+
+/**
+ * Filter attempts by status.
+ */
+export const ListTenantDestinationAttemptsStatus = {
+  Success: "success",
+  Failed: "failed",
+} as const;
+/**
+ * Filter attempts by status.
+ */
+export type ListTenantDestinationAttemptsStatus = ClosedEnum<
+  typeof ListTenantDestinationAttemptsStatus
+>;
+
+/**
+ * Filter attempts by event topic(s). Can be specified multiple times or comma-separated.
+ */
+export type ListTenantDestinationAttemptsTopic = string | Array<string>;
+
+/**
+ * Fields to include in the response. Can be specified multiple times or comma-separated.
+ *
+ * @remarks
+ * - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
+ * - `event.data`: Include full event with payload data
+ * - `response_data`: Include response body and headers
+ */
+export type ListTenantDestinationAttemptsInclude = string | Array<string>;
+
+/**
+ * Field to sort by.
+ */
+export const ListTenantDestinationAttemptsOrderBy = {
+  Time: "time",
+} as const;
+/**
+ * Field to sort by.
+ */
+export type ListTenantDestinationAttemptsOrderBy = ClosedEnum<
+  typeof ListTenantDestinationAttemptsOrderBy
+>;
+
+/**
+ * Sort direction.
+ */
+export const ListTenantDestinationAttemptsDir = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction.
+ */
+export type ListTenantDestinationAttemptsDir = ClosedEnum<
+  typeof ListTenantDestinationAttemptsDir
+>;
+
+export type ListTenantDestinationAttemptsRequest = {
+  /**
+   * The ID of the tenant. Required when using AdminApiKey authentication.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The ID of the destination.
+   */
+  destinationId: string;
+  /**
+   * Filter attempts by event ID.
+   */
+  eventId?: string | undefined;
+  /**
+   * Filter attempts by status.
+   */
+  status?: ListTenantDestinationAttemptsStatus | undefined;
+  /**
+   * Filter attempts by event topic(s). Can be specified multiple times or comma-separated.
+   */
+  topic?: string | Array<string> | undefined;
+  /**
+   * Filter attempts by event time >= value (RFC3339 or YYYY-MM-DD format).
+   */
+  timeGte?: Date | undefined;
+  /**
+   * Filter attempts by event time <= value (RFC3339 or YYYY-MM-DD format).
+   */
+  timeLte?: Date | undefined;
+  /**
+   * Number of items per page (default 100, max 1000).
+   */
+  limit?: number | undefined;
+  /**
+   * Cursor for next page of results.
+   */
+  next?: string | undefined;
+  /**
+   * Cursor for previous page of results.
+   */
+  prev?: string | undefined;
+  /**
+   * Fields to include in the response. Can be specified multiple times or comma-separated.
+   *
+   * @remarks
+   * - `event`: Include event summary (id, topic, time, eligible_for_retry, metadata)
+   * - `event.data`: Include full event with payload data
+   * - `response_data`: Include response body and headers
+   */
+  include?: string | Array<string> | undefined;
+  /**
+   * Field to sort by.
+   */
+  orderBy?: ListTenantDestinationAttemptsOrderBy | undefined;
+  /**
+   * Sort direction.
+   */
+  dir?: ListTenantDestinationAttemptsDir | undefined;
+};
+
+/** @internal */
+export const ListTenantDestinationAttemptsGlobals$inboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tenant_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+  });
+});
+/** @internal */
+export type ListTenantDestinationAttemptsGlobals$Outbound = {
+  tenant_id?: string | undefined;
+};
+
+/** @internal */
+export const ListTenantDestinationAttemptsGlobals$outboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsGlobals$Outbound,
+  z.ZodTypeDef,
+  ListTenantDestinationAttemptsGlobals
+> = z.object({
+  tenantId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+  });
+});
+
+export function listTenantDestinationAttemptsGlobalsToJSON(
+  listTenantDestinationAttemptsGlobals: ListTenantDestinationAttemptsGlobals,
+): string {
+  return JSON.stringify(
+    ListTenantDestinationAttemptsGlobals$outboundSchema.parse(
+      listTenantDestinationAttemptsGlobals,
+    ),
+  );
+}
+export function listTenantDestinationAttemptsGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantDestinationAttemptsGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantDestinationAttemptsGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantDestinationAttemptsGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantDestinationAttemptsStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ListTenantDestinationAttemptsStatus
+> = z.nativeEnum(ListTenantDestinationAttemptsStatus);
+/** @internal */
+export const ListTenantDestinationAttemptsStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ListTenantDestinationAttemptsStatus> =
+    ListTenantDestinationAttemptsStatus$inboundSchema;
+
+/** @internal */
+export const ListTenantDestinationAttemptsTopic$inboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsTopic,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+/** @internal */
+export type ListTenantDestinationAttemptsTopic$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const ListTenantDestinationAttemptsTopic$outboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsTopic$Outbound,
+  z.ZodTypeDef,
+  ListTenantDestinationAttemptsTopic
+> = z.union([z.string(), z.array(z.string())]);
+
+export function listTenantDestinationAttemptsTopicToJSON(
+  listTenantDestinationAttemptsTopic: ListTenantDestinationAttemptsTopic,
+): string {
+  return JSON.stringify(
+    ListTenantDestinationAttemptsTopic$outboundSchema.parse(
+      listTenantDestinationAttemptsTopic,
+    ),
+  );
+}
+export function listTenantDestinationAttemptsTopicFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantDestinationAttemptsTopic, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantDestinationAttemptsTopic$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantDestinationAttemptsTopic' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantDestinationAttemptsInclude$inboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsInclude,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.array(z.string())]);
+/** @internal */
+export type ListTenantDestinationAttemptsInclude$Outbound =
+  | string
+  | Array<string>;
+
+/** @internal */
+export const ListTenantDestinationAttemptsInclude$outboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsInclude$Outbound,
+  z.ZodTypeDef,
+  ListTenantDestinationAttemptsInclude
+> = z.union([z.string(), z.array(z.string())]);
+
+export function listTenantDestinationAttemptsIncludeToJSON(
+  listTenantDestinationAttemptsInclude: ListTenantDestinationAttemptsInclude,
+): string {
+  return JSON.stringify(
+    ListTenantDestinationAttemptsInclude$outboundSchema.parse(
+      listTenantDestinationAttemptsInclude,
+    ),
+  );
+}
+export function listTenantDestinationAttemptsIncludeFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantDestinationAttemptsInclude, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantDestinationAttemptsInclude$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantDestinationAttemptsInclude' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantDestinationAttemptsOrderBy$inboundSchema:
+  z.ZodNativeEnum<typeof ListTenantDestinationAttemptsOrderBy> = z.nativeEnum(
+    ListTenantDestinationAttemptsOrderBy,
+  );
+/** @internal */
+export const ListTenantDestinationAttemptsOrderBy$outboundSchema:
+  z.ZodNativeEnum<typeof ListTenantDestinationAttemptsOrderBy> =
+    ListTenantDestinationAttemptsOrderBy$inboundSchema;
+
+/** @internal */
+export const ListTenantDestinationAttemptsDir$inboundSchema: z.ZodNativeEnum<
+  typeof ListTenantDestinationAttemptsDir
+> = z.nativeEnum(ListTenantDestinationAttemptsDir);
+/** @internal */
+export const ListTenantDestinationAttemptsDir$outboundSchema: z.ZodNativeEnum<
+  typeof ListTenantDestinationAttemptsDir
+> = ListTenantDestinationAttemptsDir$inboundSchema;
+
+/** @internal */
+export const ListTenantDestinationAttemptsRequest$inboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tenant_id: z.string().optional(),
+  destination_id: z.string(),
+  event_id: z.string().optional(),
+  status: ListTenantDestinationAttemptsStatus$inboundSchema.optional(),
+  topic: z.union([z.string(), z.array(z.string())]).optional(),
+  "time[gte]": z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  "time[lte]": z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  limit: z.number().int().default(100),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  include: z.union([z.string(), z.array(z.string())]).optional(),
+  order_by: ListTenantDestinationAttemptsOrderBy$inboundSchema.default("time"),
+  dir: ListTenantDestinationAttemptsDir$inboundSchema.default("desc"),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+    "destination_id": "destinationId",
+    "event_id": "eventId",
+    "time[gte]": "timeGte",
+    "time[lte]": "timeLte",
+    "order_by": "orderBy",
+  });
+});
+/** @internal */
+export type ListTenantDestinationAttemptsRequest$Outbound = {
+  tenant_id?: string | undefined;
+  destination_id: string;
+  event_id?: string | undefined;
+  status?: string | undefined;
+  topic?: string | Array<string> | undefined;
+  "time[gte]"?: string | undefined;
+  "time[lte]"?: string | undefined;
+  limit: number;
+  next?: string | undefined;
+  prev?: string | undefined;
+  include?: string | Array<string> | undefined;
+  order_by: string;
+  dir: string;
+};
+
+/** @internal */
+export const ListTenantDestinationAttemptsRequest$outboundSchema: z.ZodType<
+  ListTenantDestinationAttemptsRequest$Outbound,
+  z.ZodTypeDef,
+  ListTenantDestinationAttemptsRequest
+> = z.object({
+  tenantId: z.string().optional(),
+  destinationId: z.string(),
+  eventId: z.string().optional(),
+  status: ListTenantDestinationAttemptsStatus$outboundSchema.optional(),
+  topic: z.union([z.string(), z.array(z.string())]).optional(),
+  timeGte: z.date().transform(v => v.toISOString()).optional(),
+  timeLte: z.date().transform(v => v.toISOString()).optional(),
+  limit: z.number().int().default(100),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  include: z.union([z.string(), z.array(z.string())]).optional(),
+  orderBy: ListTenantDestinationAttemptsOrderBy$outboundSchema.default("time"),
+  dir: ListTenantDestinationAttemptsDir$outboundSchema.default("desc"),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    destinationId: "destination_id",
+    eventId: "event_id",
+    timeGte: "time[gte]",
+    timeLte: "time[lte]",
+    orderBy: "order_by",
+  });
+});
+
+export function listTenantDestinationAttemptsRequestToJSON(
+  listTenantDestinationAttemptsRequest: ListTenantDestinationAttemptsRequest,
+): string {
+  return JSON.stringify(
+    ListTenantDestinationAttemptsRequest$outboundSchema.parse(
+      listTenantDestinationAttemptsRequest,
+    ),
+  );
+}
+export function listTenantDestinationAttemptsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantDestinationAttemptsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantDestinationAttemptsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantDestinationAttemptsRequest' from JSON`,
+  );
+}

package/src/models/operations/listtenants.ts

@@ -3,22 +3,34 @@
  */
 
 import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Sort order by `created_at` timestamp.
+ * Field to sort by.
  */
-export const Order = {
+export const ListTenantsOrderBy = {
+  CreatedAt: "created_at",
+} as const;
+/**
+ * Field to sort by.
+ */
+export type ListTenantsOrderBy = ClosedEnum<typeof ListTenantsOrderBy>;
+
+/**
+ * Sort direction.
+ */
+export const ListTenantsDir = {
   Asc: "asc",
   Desc: "desc",
 } as const;
 /**
- * Sort order by `created_at` timestamp.
+ * Sort direction.
  */
-export type Order = ClosedEnum<typeof Order>;
+export type ListTenantsDir = ClosedEnum<typeof ListTenantsDir>;
 
 export type ListTenantsRequest = {
   /**
@@ -26,9 +38,21 @@ export type ListTenantsRequest = {
    */
   limit?: number | undefined;
   /**
-   * Sort order by `created_at` timestamp.
+   * Field to sort by.
+   */
+  orderBy?: ListTenantsOrderBy | undefined;
+  /**
+   * Sort direction.
    */
-  order?: Order | undefined;
+  dir?: ListTenantsDir | undefined;
+  /**
+   * Filter tenants created at or after this time (RFC3339 or YYYY-MM-DD format).
+   */
+  createdAtGte?: Date | undefined;
+  /**
+   * Filter tenants created at or before this time (RFC3339 or YYYY-MM-DD format).
+   */
+  createdAtLte?: Date | undefined;
   /**
    * Cursor for the next page of results. Mutually exclusive with `prev`.
    */
@@ -40,12 +64,22 @@ export type ListTenantsRequest = {
 };
 
 /** @internal */
-export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
-  Order,
-);
+export const ListTenantsOrderBy$inboundSchema: z.ZodNativeEnum<
+  typeof ListTenantsOrderBy
+> = z.nativeEnum(ListTenantsOrderBy);
+/** @internal */
+export const ListTenantsOrderBy$outboundSchema: z.ZodNativeEnum<
+  typeof ListTenantsOrderBy
+> = ListTenantsOrderBy$inboundSchema;
+
+/** @internal */
+export const ListTenantsDir$inboundSchema: z.ZodNativeEnum<
+  typeof ListTenantsDir
+> = z.nativeEnum(ListTenantsDir);
 /** @internal */
-export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> =
-  Order$inboundSchema;
+export const ListTenantsDir$outboundSchema: z.ZodNativeEnum<
+  typeof ListTenantsDir
+> = ListTenantsDir$inboundSchema;
 
 /** @internal */
 export const ListTenantsRequest$inboundSchema: z.ZodType<
@@ -54,14 +88,30 @@ export const ListTenantsRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   limit: z.number().int().default(20),
-  order: Order$inboundSchema.default("desc"),
+  order_by: ListTenantsOrderBy$inboundSchema.default("created_at"),
+  dir: ListTenantsDir$inboundSchema.default("desc"),
+  "created_at[gte]": z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  "created_at[lte]": z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
   next: z.string().optional(),
   prev: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "order_by": "orderBy",
+    "created_at[gte]": "createdAtGte",
+    "created_at[lte]": "createdAtLte",
+  });
 });
 /** @internal */
 export type ListTenantsRequest$Outbound = {
   limit: number;
-  order: string;
+  order_by: string;
+  dir: string;
+  "created_at[gte]"?: string | undefined;
+  "created_at[lte]"?: string | undefined;
   next?: string | undefined;
   prev?: string | undefined;
 };
@@ -73,9 +123,18 @@ export const ListTenantsRequest$outboundSchema: z.ZodType<
   ListTenantsRequest
 > = z.object({
   limit: z.number().int().default(20),
-  order: Order$outboundSchema.default("desc"),
+  orderBy: ListTenantsOrderBy$outboundSchema.default("created_at"),
+  dir: ListTenantsDir$outboundSchema.default("desc"),
+  createdAtGte: z.date().transform(v => v.toISOString()).optional(),
+  createdAtLte: z.date().transform(v => v.toISOString()).optional(),
   next: z.string().optional(),
   prev: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    orderBy: "order_by",
+    createdAtGte: "created_at[gte]",
+    createdAtLte: "created_at[lte]",
+  });
 });
 
 export function listTenantsRequestToJSON(

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,
+    ));
+  }
 }