@hookdeck/outpost-sdk 0.6.0 → 0.7.0

package/src/models/components/event.ts

@@ -5,18 +5,15 @@
 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 const EventStatus = {
-  Success: "success",
-  Failed: "failed",
-} as const;
-export type EventStatus = ClosedEnum<typeof EventStatus>;
-
 export type Event = {
   id?: string | undefined;
+  /**
+   * The tenant this event belongs to.
+   */
+  tenantId?: string | undefined;
   destinationId?: string | undefined;
   topic?: string | undefined;
   /**
@@ -31,24 +28,17 @@ export type Event = {
    * Key-value string pairs of metadata associated with the event.
    */
   metadata?: { [k: string]: string } | null | undefined;
-  status?: EventStatus | undefined;
   /**
    * Freeform JSON data of the event.
    */
   data?: { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const EventStatus$inboundSchema: z.ZodNativeEnum<typeof EventStatus> = z
-  .nativeEnum(EventStatus);
-/** @internal */
-export const EventStatus$outboundSchema: z.ZodNativeEnum<typeof EventStatus> =
-  EventStatus$inboundSchema;
-
 /** @internal */
 export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
   .object({
     id: z.string().optional(),
+    tenant_id: z.string().optional(),
     destination_id: z.string().optional(),
     topic: z.string().optional(),
     time: z.string().datetime({ offset: true }).transform(v => new Date(v))
@@ -57,10 +47,10 @@ export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ).optional(),
     metadata: z.nullable(z.record(z.string())).optional(),
-    status: EventStatus$inboundSchema.optional(),
     data: z.record(z.any()).optional(),
   }).transform((v) => {
     return remap$(v, {
+      "tenant_id": "tenantId",
       "destination_id": "destinationId",
       "successful_at": "successfulAt",
     });
@@ -68,12 +58,12 @@ export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
 /** @internal */
 export type Event$Outbound = {
   id?: string | undefined;
+  tenant_id?: string | undefined;
   destination_id?: string | undefined;
   topic?: string | undefined;
   time?: string | undefined;
   successful_at?: string | null | undefined;
   metadata?: { [k: string]: string } | null | undefined;
-  status?: string | undefined;
   data?: { [k: string]: any } | undefined;
 };
 
@@ -84,15 +74,16 @@ export const Event$outboundSchema: z.ZodType<
   Event
 > = z.object({
   id: z.string().optional(),
+  tenantId: z.string().optional(),
   destinationId: z.string().optional(),
   topic: z.string().optional(),
   time: z.date().transform(v => v.toISOString()).optional(),
   successfulAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
   metadata: z.nullable(z.record(z.string())).optional(),
-  status: EventStatus$outboundSchema.optional(),
   data: z.record(z.any()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    tenantId: "tenant_id",
     destinationId: "destination_id",
     successfulAt: "successful_at",
   });

package/src/models/components/eventfull.ts

@@ -0,0 +1,107 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Full event object with data (returned when include=event.data).
+ */
+export type EventFull = {
+  id?: string | undefined;
+  /**
+   * The tenant this event belongs to.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The destination this event was delivered to.
+   */
+  destinationId?: string | undefined;
+  topic?: string | undefined;
+  /**
+   * Time the event was received.
+   */
+  time?: Date | undefined;
+  /**
+   * Whether this event can be retried.
+   */
+  eligibleForRetry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * The event payload data.
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const EventFull$inboundSchema: z.ZodType<
+  EventFull,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  tenant_id: z.string().optional(),
+  destination_id: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  eligible_for_retry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  data: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+    "destination_id": "destinationId",
+    "eligible_for_retry": "eligibleForRetry",
+  });
+});
+/** @internal */
+export type EventFull$Outbound = {
+  id?: string | undefined;
+  tenant_id?: string | undefined;
+  destination_id?: string | undefined;
+  topic?: string | undefined;
+  time?: string | undefined;
+  eligible_for_retry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const EventFull$outboundSchema: z.ZodType<
+  EventFull$Outbound,
+  z.ZodTypeDef,
+  EventFull
+> = z.object({
+  id: z.string().optional(),
+  tenantId: z.string().optional(),
+  destinationId: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
+  eligibleForRetry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  data: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    destinationId: "destination_id",
+    eligibleForRetry: "eligible_for_retry",
+  });
+});
+
+export function eventFullToJSON(eventFull: EventFull): string {
+  return JSON.stringify(EventFull$outboundSchema.parse(eventFull));
+}
+export function eventFullFromJSON(
+  jsonString: string,
+): SafeParseResult<EventFull, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFull$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFull' from JSON`,
+  );
+}

package/src/models/components/eventpaginatedresult.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Event,
+  Event$inboundSchema,
+  Event$Outbound,
+  Event$outboundSchema,
+} from "./event.js";
+import {
+  SeekPagination,
+  SeekPagination$inboundSchema,
+  SeekPagination$Outbound,
+  SeekPagination$outboundSchema,
+} from "./seekpagination.js";
+
+/**
+ * Paginated list of events.
+ */
+export type EventPaginatedResult = {
+  /**
+   * Array of event objects.
+   */
+  models?: Array<Event> | undefined;
+  /**
+   * Cursor-based pagination metadata for list responses.
+   */
+  pagination?: SeekPagination | undefined;
+};
+
+/** @internal */
+export const EventPaginatedResult$inboundSchema: z.ZodType<
+  EventPaginatedResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  models: z.array(Event$inboundSchema).optional(),
+  pagination: SeekPagination$inboundSchema.optional(),
+});
+/** @internal */
+export type EventPaginatedResult$Outbound = {
+  models?: Array<Event$Outbound> | undefined;
+  pagination?: SeekPagination$Outbound | undefined;
+};
+
+/** @internal */
+export const EventPaginatedResult$outboundSchema: z.ZodType<
+  EventPaginatedResult$Outbound,
+  z.ZodTypeDef,
+  EventPaginatedResult
+> = z.object({
+  models: z.array(Event$outboundSchema).optional(),
+  pagination: SeekPagination$outboundSchema.optional(),
+});
+
+export function eventPaginatedResultToJSON(
+  eventPaginatedResult: EventPaginatedResult,
+): string {
+  return JSON.stringify(
+    EventPaginatedResult$outboundSchema.parse(eventPaginatedResult),
+  );
+}
+export function eventPaginatedResultFromJSON(
+  jsonString: string,
+): SafeParseResult<EventPaginatedResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventPaginatedResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventPaginatedResult' from JSON`,
+  );
+}

package/src/models/components/eventsummary.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Event object without data (returned when include=event).
+ */
+export type EventSummary = {
+  id?: string | undefined;
+  /**
+   * The tenant this event belongs to.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The destination this event was delivered to.
+   */
+  destinationId?: string | undefined;
+  topic?: string | undefined;
+  /**
+   * Time the event was received.
+   */
+  time?: Date | undefined;
+  /**
+   * Whether this event can be retried.
+   */
+  eligibleForRetry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+};
+
+/** @internal */
+export const EventSummary$inboundSchema: z.ZodType<
+  EventSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  tenant_id: z.string().optional(),
+  destination_id: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  eligible_for_retry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "tenant_id": "tenantId",
+    "destination_id": "destinationId",
+    "eligible_for_retry": "eligibleForRetry",
+  });
+});
+/** @internal */
+export type EventSummary$Outbound = {
+  id?: string | undefined;
+  tenant_id?: string | undefined;
+  destination_id?: string | undefined;
+  topic?: string | undefined;
+  time?: string | undefined;
+  eligible_for_retry?: boolean | undefined;
+  metadata?: { [k: string]: string } | null | undefined;
+};
+
+/** @internal */
+export const EventSummary$outboundSchema: z.ZodType<
+  EventSummary$Outbound,
+  z.ZodTypeDef,
+  EventSummary
+> = z.object({
+  id: z.string().optional(),
+  tenantId: z.string().optional(),
+  destinationId: z.string().optional(),
+  topic: z.string().optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
+  eligibleForRetry: z.boolean().optional(),
+  metadata: z.nullable(z.record(z.string())).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    destinationId: "destination_id",
+    eligibleForRetry: "eligible_for_retry",
+  });
+});
+
+export function eventSummaryToJSON(eventSummary: EventSummary): string {
+  return JSON.stringify(EventSummary$outboundSchema.parse(eventSummary));
+}
+export function eventSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<EventSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventSummary' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,6 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./attempt.js";
+export * from "./attemptpaginatedresult.js";
 export * from "./awskinesisconfig.js";
 export * from "./awskinesiscredentials.js";
 export * from "./awss3config.js";
@@ -10,7 +12,6 @@ export * from "./awssqsconfig.js";
 export * from "./awssqscredentials.js";
 export * from "./azureservicebusconfig.js";
 export * from "./azureservicebuscredentials.js";
-export * from "./deliveryattempt.js";
 export * from "./destination.js";
 export * from "./destinationawskinesis.js";
 export * from "./destinationawss3.js";
@@ -42,6 +43,9 @@ export * from "./destinationupdaterabbitmq.js";
 export * from "./destinationupdatewebhook.js";
 export * from "./destinationwebhook.js";
 export * from "./event.js";
+export * from "./eventfull.js";
+export * from "./eventpaginatedresult.js";
+export * from "./eventsummary.js";
 export * from "./gcppubsubconfig.js";
 export * from "./gcppubsubcredentials.js";
 export * from "./hookdeckcredentials.js";
@@ -50,11 +54,12 @@ export * from "./publishrequest.js";
 export * from "./publishresponse.js";
 export * from "./rabbitmqconfig.js";
 export * from "./rabbitmqcredentials.js";
+export * from "./retryrequest.js";
 export * from "./security.js";
+export * from "./seekpagination.js";
 export * from "./successresponse.js";
 export * from "./tenant.js";
-export * from "./tenantlistitem.js";
-export * from "./tenantlistresponse.js";
+export * from "./tenantpaginatedresult.js";
 export * from "./tenanttoken.js";
 export * from "./tenantupsert.js";
 export * from "./topics.js";

package/src/models/components/publishrequest.ts

@@ -29,6 +29,10 @@ export type PublishRequest = {
    * Should event delivery be retried on failure.
    */
   eligibleForRetry?: boolean | undefined;
+  /**
+   * Optional. Custom timestamp for the event. If not provided, defaults to the current time.
+   */
+  time?: Date | undefined;
   /**
    * Any key-value string pairs for metadata.
    */
@@ -50,6 +54,8 @@ export const PublishRequest$inboundSchema: z.ZodType<
   destination_id: z.string().optional(),
   topic: z.string().optional(),
   eligible_for_retry: z.boolean().optional(),
+  time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
   metadata: z.record(z.string()).optional(),
   data: z.record(z.any()),
 }).transform((v) => {
@@ -66,6 +72,7 @@ export type PublishRequest$Outbound = {
   destination_id?: string | undefined;
   topic?: string | undefined;
   eligible_for_retry?: boolean | undefined;
+  time?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
   data: { [k: string]: any };
 };
@@ -81,6 +88,7 @@ export const PublishRequest$outboundSchema: z.ZodType<
   destinationId: z.string().optional(),
   topic: z.string().optional(),
   eligibleForRetry: z.boolean().optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
   metadata: z.record(z.string()).optional(),
   data: z.record(z.any()),
 }).transform((v) => {

package/src/models/components/publishresponse.ts

@@ -3,6 +3,7 @@
  */
 
 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -16,6 +17,10 @@ export type PublishResponse = {
    * Whether this event was already processed (idempotency hit). If true, the event was not queued again.
    */
   duplicate: boolean;
+  /**
+   * The IDs of destinations that matched this event. Empty array if no destinations matched.
+   */
+  destinationIds: Array<string>;
 };
 
 /** @internal */
@@ -26,11 +31,17 @@ export const PublishResponse$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   duplicate: z.boolean(),
+  destination_ids: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "destination_ids": "destinationIds",
+  });
 });
 /** @internal */
 export type PublishResponse$Outbound = {
   id: string;
   duplicate: boolean;
+  destination_ids: Array<string>;
 };
 
 /** @internal */
@@ -41,6 +52,11 @@ export const PublishResponse$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   duplicate: z.boolean(),
+  destinationIds: z.array(z.string()),
+}).transform((v) => {
+  return remap$(v, {
+    destinationIds: "destination_ids",
+  });
 });
 
 export function publishResponseToJSON(

package/src/models/components/retryrequest.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Request body for retrying event delivery to a destination.
+ */
+export type RetryRequest = {
+  /**
+   * The ID of the event to retry.
+   */
+  eventId: string;
+  /**
+   * The ID of the destination to deliver to.
+   */
+  destinationId: string;
+};
+
+/** @internal */
+export const RetryRequest$inboundSchema: z.ZodType<
+  RetryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  event_id: z.string(),
+  destination_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "event_id": "eventId",
+    "destination_id": "destinationId",
+  });
+});
+/** @internal */
+export type RetryRequest$Outbound = {
+  event_id: string;
+  destination_id: string;
+};
+
+/** @internal */
+export const RetryRequest$outboundSchema: z.ZodType<
+  RetryRequest$Outbound,
+  z.ZodTypeDef,
+  RetryRequest
+> = z.object({
+  eventId: z.string(),
+  destinationId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    eventId: "event_id",
+    destinationId: "destination_id",
+  });
+});
+
+export function retryRequestToJSON(retryRequest: RetryRequest): string {
+  return JSON.stringify(RetryRequest$outboundSchema.parse(retryRequest));
+}
+export function retryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<RetryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RetryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RetryRequest' from JSON`,
+  );
+}

package/src/models/components/seekpagination.ts

@@ -0,0 +1,109 @@
+/*
+ * 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";
+
+/**
+ * Sort direction.
+ */
+export const Dir = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort direction.
+ */
+export type Dir = ClosedEnum<typeof Dir>;
+
+/**
+ * Cursor-based pagination metadata for list responses.
+ */
+export type SeekPagination = {
+  /**
+   * The field being sorted on.
+   */
+  orderBy?: string | undefined;
+  /**
+   * Sort direction.
+   */
+  dir?: Dir | undefined;
+  /**
+   * Page size limit.
+   */
+  limit?: number | undefined;
+  /**
+   * Cursor for the next page of results. Null if no more results.
+   */
+  next?: string | null | undefined;
+  /**
+   * Cursor for the previous page of results. Null if on first page.
+   */
+  prev?: string | null | undefined;
+};
+
+/** @internal */
+export const Dir$inboundSchema: z.ZodNativeEnum<typeof Dir> = z.nativeEnum(Dir);
+/** @internal */
+export const Dir$outboundSchema: z.ZodNativeEnum<typeof Dir> =
+  Dir$inboundSchema;
+
+/** @internal */
+export const SeekPagination$inboundSchema: z.ZodType<
+  SeekPagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  order_by: z.string().optional(),
+  dir: Dir$inboundSchema.optional(),
+  limit: z.number().int().optional(),
+  next: z.nullable(z.string()).optional(),
+  prev: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "order_by": "orderBy",
+  });
+});
+/** @internal */
+export type SeekPagination$Outbound = {
+  order_by?: string | undefined;
+  dir?: string | undefined;
+  limit?: number | undefined;
+  next?: string | null | undefined;
+  prev?: string | null | undefined;
+};
+
+/** @internal */
+export const SeekPagination$outboundSchema: z.ZodType<
+  SeekPagination$Outbound,
+  z.ZodTypeDef,
+  SeekPagination
+> = z.object({
+  orderBy: z.string().optional(),
+  dir: Dir$outboundSchema.optional(),
+  limit: z.number().int().optional(),
+  next: z.nullable(z.string()).optional(),
+  prev: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    orderBy: "order_by",
+  });
+});
+
+export function seekPaginationToJSON(seekPagination: SeekPagination): string {
+  return JSON.stringify(SeekPagination$outboundSchema.parse(seekPagination));
+}
+export function seekPaginationFromJSON(
+  jsonString: string,
+): SafeParseResult<SeekPagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SeekPagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SeekPagination' from JSON`,
+  );
+}