@hookdeck/outpost-sdk 0.3.0 → 0.5.0

package/src/models/operations/listtenantevents.ts

@@ -7,6 +7,7 @@ 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 * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListTenantEventsGlobals = {
@@ -43,6 +44,49 @@ export type ListTenantEventsRequest = {
    * Filter events by delivery status.
    */
   status?: ListTenantEventsStatus | undefined;
+  /**
+   * Cursor for next page of results
+   */
+  next?: string | undefined;
+  /**
+   * Cursor for previous page of results
+   */
+  prev?: string | undefined;
+  /**
+   * Number of items per page (default 100, max 1000)
+   */
+  limit?: number | undefined;
+  /**
+   * Start time filter (RFC3339 format)
+   */
+  start?: Date | undefined;
+  /**
+   * End time filter (RFC3339 format)
+   */
+  end?: Date | undefined;
+};
+
+/**
+ * A paginated list of events.
+ */
+export type ListTenantEventsResponseBody = {
+  /**
+   * Total number of items across all pages
+   */
+  count: number;
+  data: Array<components.Event>;
+  /**
+   * Cursor for next page (empty string if no next page)
+   */
+  nextCursor: string;
+  /**
+   * Cursor for previous page (empty string if no previous page)
+   */
+  prevCursor: string;
+};
+
+export type ListTenantEventsResponse = {
+  result: ListTenantEventsResponseBody;
 };
 
 /** @internal */
@@ -181,6 +225,13 @@ export const ListTenantEventsRequest$inboundSchema: z.ZodType<
   tenant_id: z.string().optional(),
   destination_id: z.union([z.string(), z.array(z.string())]).optional(),
   status: ListTenantEventsStatus$inboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  end: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "tenant_id": "tenantId",
@@ -193,6 +244,11 @@ export type ListTenantEventsRequest$Outbound = {
   tenant_id?: string | undefined;
   destination_id?: string | Array<string> | undefined;
   status?: string | undefined;
+  next?: string | undefined;
+  prev?: string | undefined;
+  limit: number;
+  start?: string | undefined;
+  end?: string | undefined;
 };
 
 /** @internal */
@@ -204,6 +260,11 @@ export const ListTenantEventsRequest$outboundSchema: z.ZodType<
   tenantId: z.string().optional(),
   destinationId: z.union([z.string(), z.array(z.string())]).optional(),
   status: ListTenantEventsStatus$outboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.date().transform(v => v.toISOString()).optional(),
+  end: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",
@@ -241,3 +302,140 @@ export function listTenantEventsRequestFromJSON(
     `Failed to parse 'ListTenantEventsRequest' from JSON`,
   );
 }
+
+/** @internal */
+export const ListTenantEventsResponseBody$inboundSchema: z.ZodType<
+  ListTenantEventsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  data: z.array(components.Event$inboundSchema),
+  next: z.string(),
+  prev: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "next": "nextCursor",
+    "prev": "prevCursor",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsResponseBody$Outbound = {
+  count: number;
+  data: Array<components.Event$Outbound>;
+  next: string;
+  prev: string;
+};
+
+/** @internal */
+export const ListTenantEventsResponseBody$outboundSchema: z.ZodType<
+  ListTenantEventsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListTenantEventsResponseBody
+> = z.object({
+  count: z.number().int(),
+  data: z.array(components.Event$outboundSchema),
+  nextCursor: z.string(),
+  prevCursor: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    nextCursor: "next",
+    prevCursor: "prev",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsResponseBody$ {
+  /** @deprecated use `ListTenantEventsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListTenantEventsResponseBody$inboundSchema;
+  /** @deprecated use `ListTenantEventsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListTenantEventsResponseBody$outboundSchema;
+  /** @deprecated use `ListTenantEventsResponseBody$Outbound` instead. */
+  export type Outbound = ListTenantEventsResponseBody$Outbound;
+}
+
+export function listTenantEventsResponseBodyToJSON(
+  listTenantEventsResponseBody: ListTenantEventsResponseBody,
+): string {
+  return JSON.stringify(
+    ListTenantEventsResponseBody$outboundSchema.parse(
+      listTenantEventsResponseBody,
+    ),
+  );
+}
+
+export function listTenantEventsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantEventsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTenantEventsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantEventsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantEventsResponse$inboundSchema: z.ZodType<
+  ListTenantEventsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListTenantEventsResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsResponse$Outbound = {
+  Result: ListTenantEventsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListTenantEventsResponse$outboundSchema: z.ZodType<
+  ListTenantEventsResponse$Outbound,
+  z.ZodTypeDef,
+  ListTenantEventsResponse
+> = z.object({
+  result: z.lazy(() => ListTenantEventsResponseBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsResponse$ {
+  /** @deprecated use `ListTenantEventsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListTenantEventsResponse$inboundSchema;
+  /** @deprecated use `ListTenantEventsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListTenantEventsResponse$outboundSchema;
+  /** @deprecated use `ListTenantEventsResponse$Outbound` instead. */
+  export type Outbound = ListTenantEventsResponse$Outbound;
+}
+
+export function listTenantEventsResponseToJSON(
+  listTenantEventsResponse: ListTenantEventsResponse,
+): string {
+  return JSON.stringify(
+    ListTenantEventsResponse$outboundSchema.parse(listTenantEventsResponse),
+  );
+}
+
+export function listTenantEventsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantEventsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListTenantEventsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantEventsResponse' from JSON`,
+  );
+}

package/src/models/operations/listtenanteventsbydestination.ts

@@ -7,6 +7,7 @@ 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 * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListTenantEventsByDestinationGlobals = {
@@ -40,6 +41,49 @@ export type ListTenantEventsByDestinationRequest = {
    * Filter events by delivery status.
    */
   status?: ListTenantEventsByDestinationStatus | undefined;
+  /**
+   * Cursor for next page of results
+   */
+  next?: string | undefined;
+  /**
+   * Cursor for previous page of results
+   */
+  prev?: string | undefined;
+  /**
+   * Number of items per page (default 100, max 1000)
+   */
+  limit?: number | undefined;
+  /**
+   * Start time filter (RFC3339 format)
+   */
+  start?: Date | undefined;
+  /**
+   * End time filter (RFC3339 format)
+   */
+  end?: Date | undefined;
+};
+
+/**
+ * A paginated list of events for the destination.
+ */
+export type ListTenantEventsByDestinationResponseBody = {
+  /**
+   * Total number of items across all pages
+   */
+  count: number;
+  data: Array<components.Event>;
+  /**
+   * Cursor for next page (empty string if no next page)
+   */
+  nextCursor: string;
+  /**
+   * Cursor for previous page (empty string if no previous page)
+   */
+  prevCursor: string;
+};
+
+export type ListTenantEventsByDestinationResponse = {
+  result: ListTenantEventsByDestinationResponseBody;
 };
 
 /** @internal */
@@ -141,6 +185,13 @@ export const ListTenantEventsByDestinationRequest$inboundSchema: z.ZodType<
   tenant_id: z.string().optional(),
   destination_id: z.string(),
   status: ListTenantEventsByDestinationStatus$inboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  end: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "tenant_id": "tenantId",
@@ -153,6 +204,11 @@ export type ListTenantEventsByDestinationRequest$Outbound = {
   tenant_id?: string | undefined;
   destination_id: string;
   status?: string | undefined;
+  next?: string | undefined;
+  prev?: string | undefined;
+  limit: number;
+  start?: string | undefined;
+  end?: string | undefined;
 };
 
 /** @internal */
@@ -164,6 +220,11 @@ export const ListTenantEventsByDestinationRequest$outboundSchema: z.ZodType<
   tenantId: z.string().optional(),
   destinationId: z.string(),
   status: ListTenantEventsByDestinationStatus$outboundSchema.optional(),
+  next: z.string().optional(),
+  prev: z.string().optional(),
+  limit: z.number().int().default(100),
+  start: z.date().transform(v => v.toISOString()).optional(),
+  end: z.date().transform(v => v.toISOString()).optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",
@@ -206,3 +267,157 @@ export function listTenantEventsByDestinationRequestFromJSON(
     `Failed to parse 'ListTenantEventsByDestinationRequest' from JSON`,
   );
 }
+
+/** @internal */
+export const ListTenantEventsByDestinationResponseBody$inboundSchema: z.ZodType<
+  ListTenantEventsByDestinationResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  data: z.array(components.Event$inboundSchema),
+  next: z.string(),
+  prev: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "next": "nextCursor",
+    "prev": "prevCursor",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsByDestinationResponseBody$Outbound = {
+  count: number;
+  data: Array<components.Event$Outbound>;
+  next: string;
+  prev: string;
+};
+
+/** @internal */
+export const ListTenantEventsByDestinationResponseBody$outboundSchema:
+  z.ZodType<
+    ListTenantEventsByDestinationResponseBody$Outbound,
+    z.ZodTypeDef,
+    ListTenantEventsByDestinationResponseBody
+  > = z.object({
+    count: z.number().int(),
+    data: z.array(components.Event$outboundSchema),
+    nextCursor: z.string(),
+    prevCursor: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      nextCursor: "next",
+      prevCursor: "prev",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsByDestinationResponseBody$ {
+  /** @deprecated use `ListTenantEventsByDestinationResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    ListTenantEventsByDestinationResponseBody$inboundSchema;
+  /** @deprecated use `ListTenantEventsByDestinationResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    ListTenantEventsByDestinationResponseBody$outboundSchema;
+  /** @deprecated use `ListTenantEventsByDestinationResponseBody$Outbound` instead. */
+  export type Outbound = ListTenantEventsByDestinationResponseBody$Outbound;
+}
+
+export function listTenantEventsByDestinationResponseBodyToJSON(
+  listTenantEventsByDestinationResponseBody:
+    ListTenantEventsByDestinationResponseBody,
+): string {
+  return JSON.stringify(
+    ListTenantEventsByDestinationResponseBody$outboundSchema.parse(
+      listTenantEventsByDestinationResponseBody,
+    ),
+  );
+}
+
+export function listTenantEventsByDestinationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListTenantEventsByDestinationResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantEventsByDestinationResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListTenantEventsByDestinationResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListTenantEventsByDestinationResponse$inboundSchema: z.ZodType<
+  ListTenantEventsByDestinationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListTenantEventsByDestinationResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListTenantEventsByDestinationResponse$Outbound = {
+  Result: ListTenantEventsByDestinationResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListTenantEventsByDestinationResponse$outboundSchema: z.ZodType<
+  ListTenantEventsByDestinationResponse$Outbound,
+  z.ZodTypeDef,
+  ListTenantEventsByDestinationResponse
+> = z.object({
+  result: z.lazy(() =>
+    ListTenantEventsByDestinationResponseBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListTenantEventsByDestinationResponse$ {
+  /** @deprecated use `ListTenantEventsByDestinationResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    ListTenantEventsByDestinationResponse$inboundSchema;
+  /** @deprecated use `ListTenantEventsByDestinationResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    ListTenantEventsByDestinationResponse$outboundSchema;
+  /** @deprecated use `ListTenantEventsByDestinationResponse$Outbound` instead. */
+  export type Outbound = ListTenantEventsByDestinationResponse$Outbound;
+}
+
+export function listTenantEventsByDestinationResponseToJSON(
+  listTenantEventsByDestinationResponse: ListTenantEventsByDestinationResponse,
+): string {
+  return JSON.stringify(
+    ListTenantEventsByDestinationResponse$outboundSchema.parse(
+      listTenantEventsByDestinationResponse,
+    ),
+  );
+}
+
+export function listTenantEventsByDestinationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListTenantEventsByDestinationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListTenantEventsByDestinationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListTenantEventsByDestinationResponse' from JSON`,
+  );
+}

package/src/sdk/events.ts

@@ -12,6 +12,7 @@ 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 {
   /**
@@ -23,8 +24,10 @@ export class Events extends ClientSDK {
   async list(
     request: operations.ListTenantEventsRequest,
     options?: RequestOptions,
-  ): Promise<Array<components.Event>> {
-    return unwrapAsync(eventsList(
+  ): Promise<
+    PageIterator<operations.ListTenantEventsResponse, { cursor: string }>
+  > {
+    return unwrapResultIterator(eventsList(
       this,
       request,
       options,
@@ -74,8 +77,13 @@ export class Events extends ClientSDK {
   async listByDestination(
     request: operations.ListTenantEventsByDestinationRequest,
     options?: RequestOptions,
-  ): Promise<Array<components.Event>> {
-    return unwrapAsync(eventsListByDestination(
+  ): Promise<
+    PageIterator<
+      operations.ListTenantEventsByDestinationResponse,
+      { cursor: string }
+    >
+  > {
+    return unwrapResultIterator(eventsListByDestination(
       this,
       request,
       options,

package/docs/sdks/outpost/README.md

@@ -1,7 +0,0 @@
-# Outpost SDK
-
-## Overview
-
-Outpost API: The Outpost API is a REST-based JSON API for managing tenants, destinations, and publishing events.
-
-### Available Operations