@hookdeck/outpost-sdk 0.6.0 → 0.7.0

package/src/mcp-server/tools/{eventsListByDestination.ts → destinationsListAttempts.ts}

@@ -2,22 +2,22 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { eventsListByDestination } from "../../funcs/eventsListByDestination.js";
+import { destinationsListAttempts } from "../../funcs/destinationsListAttempts.js";
 import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.ListTenantEventsByDestinationRequest$inboundSchema,
+  request: operations.ListTenantDestinationAttemptsRequest$inboundSchema,
 };
 
-export const tool$eventsListByDestination: ToolDefinition<typeof args> = {
-  name: "events-list-by-destination",
-  description: `List Events by Destination
+export const tool$destinationsListAttempts: ToolDefinition<typeof args> = {
+  name: "destinations-list-attempts",
+  description: `List Destination Attempts
 
-Retrieves events associated with a specific destination for the tenant.`,
+Retrieves a paginated list of attempts scoped to a specific destination.`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await eventsListByDestination(
+    const [result, apiCall] = await destinationsListAttempts(
       client,
       args.request,
       { fetchOptions: { signal: ctx.signal } },

package/src/mcp-server/tools/eventsGet.ts

@@ -7,14 +7,18 @@ import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.GetTenantEventRequest$inboundSchema,
+  request: operations.GetEventRequest$inboundSchema,
 };
 
 export const tool$eventsGet: ToolDefinition<typeof args> = {
   name: "events-get",
   description: `Get Event
 
-Retrieves details for a specific event.`,
+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.
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await eventsGet(

package/src/mcp-server/tools/eventsList.ts

@@ -7,14 +7,17 @@ import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.ListTenantEventsRequest$inboundSchema,
+  request: operations.AdminListEventsRequest$inboundSchema,
 };
 
 export const tool$eventsList: ToolDefinition<typeof args> = {
   name: "events-list",
-  description: `List Events
+  description: `List Events (Admin)
 
-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.
+`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await eventsList(

package/src/mcp-server/tools/schemasListDestinationTypesJwt.ts

@@ -7,9 +7,9 @@ import { formatResult, ToolDefinition } from "../tools.js";
 
 export const tool$schemasListDestinationTypesJwt: ToolDefinition = {
   name: "schemas-list-destination-types-jwt",
-  description: `List Destination Type Schemas (JWT Auth)
+  description: `List Destination Type Schemas
 
-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.`,
   tool: async (client, ctx) => {
     const [result, apiCall] = await schemasListDestinationTypesJwt(
       client,

package/src/mcp-server/tools/topicsList.ts

@@ -3,23 +3,16 @@
  */
 
 import { topicsList } from "../../funcs/topicsList.js";
-import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
-const args = {
-  request: operations.ListTenantTopicsRequest$inboundSchema,
-};
-
-export const tool$topicsList: ToolDefinition<typeof args> = {
+export const tool$topicsList: ToolDefinition = {
   name: "topics-list",
-  description: `List Available Topics (for Tenant)
+  description: `List Available Topics
 
-Returns a list of available event topics configured in the Outpost instance. Requires Admin API Key or Tenant JWT.`,
-  args,
-  tool: async (client, args, ctx) => {
+Returns a list of available event topics configured in the Outpost instance.`,
+  tool: async (client, ctx) => {
     const [result, apiCall] = await topicsList(
       client,
-      args.request,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();
 

package/src/models/components/attempt.ts

@@ -0,0 +1,206 @@
+/*
+ * 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";
+import {
+  EventFull,
+  EventFull$inboundSchema,
+  EventFull$Outbound,
+  EventFull$outboundSchema,
+} from "./eventfull.js";
+import {
+  EventSummary,
+  EventSummary$inboundSchema,
+  EventSummary$Outbound,
+  EventSummary$outboundSchema,
+} from "./eventsummary.js";
+
+/**
+ * The attempt status.
+ */
+export const Status = {
+  Success: "success",
+  Failed: "failed",
+} as const;
+/**
+ * The attempt status.
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/**
+ * The associated event object. Only present when include=event or include=event.data.
+ */
+export type EventUnion = EventSummary | EventFull;
+
+/**
+ * An attempt represents a single delivery attempt of an event to a destination.
+ */
+export type Attempt = {
+  /**
+   * Unique identifier for this attempt.
+   */
+  id?: string | undefined;
+  /**
+   * The tenant this attempt belongs to.
+   */
+  tenantId?: string | undefined;
+  /**
+   * The attempt status.
+   */
+  status?: Status | undefined;
+  /**
+   * Time the attempt was made.
+   */
+  time?: Date | undefined;
+  /**
+   * Response status code or error code.
+   */
+  code?: string | undefined;
+  /**
+   * Response data from the attempt. Only included when include=response_data.
+   */
+  responseData?: { [k: string]: any } | undefined;
+  /**
+   * The attempt number (1 for first attempt, 2+ for retries).
+   */
+  attemptNumber?: number | undefined;
+  /**
+   * Whether this attempt was manually triggered (e.g., a retry initiated by a user).
+   */
+  manual?: boolean | undefined;
+  /**
+   * The ID of the associated event.
+   */
+  eventId?: string | undefined;
+  /**
+   * The destination ID this attempt was sent to.
+   */
+  destinationId?: string | undefined;
+  /**
+   * The associated event object. Only present when include=event or include=event.data.
+   */
+  event?: EventSummary | EventFull | undefined;
+};
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
+
+/** @internal */
+export const EventUnion$inboundSchema: z.ZodType<
+  EventUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([EventSummary$inboundSchema, EventFull$inboundSchema]);
+/** @internal */
+export type EventUnion$Outbound = EventSummary$Outbound | EventFull$Outbound;
+
+/** @internal */
+export const EventUnion$outboundSchema: z.ZodType<
+  EventUnion$Outbound,
+  z.ZodTypeDef,
+  EventUnion
+> = z.union([EventSummary$outboundSchema, EventFull$outboundSchema]);
+
+export function eventUnionToJSON(eventUnion: EventUnion): string {
+  return JSON.stringify(EventUnion$outboundSchema.parse(eventUnion));
+}
+export function eventUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<EventUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventUnion' from JSON`,
+  );
+}
+
+/** @internal */
+export const Attempt$inboundSchema: z.ZodType<Attempt, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string().optional(),
+    tenant_id: z.string().optional(),
+    status: Status$inboundSchema.optional(),
+    time: z.string().datetime({ offset: true }).transform(v => new Date(v))
+      .optional(),
+    code: z.string().optional(),
+    response_data: z.record(z.any()).optional(),
+    attempt_number: z.number().int().optional(),
+    manual: z.boolean().optional(),
+    event_id: z.string().optional(),
+    destination_id: z.string().optional(),
+    event: z.union([EventSummary$inboundSchema, EventFull$inboundSchema])
+      .optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "tenant_id": "tenantId",
+      "response_data": "responseData",
+      "attempt_number": "attemptNumber",
+      "event_id": "eventId",
+      "destination_id": "destinationId",
+    });
+  });
+/** @internal */
+export type Attempt$Outbound = {
+  id?: string | undefined;
+  tenant_id?: string | undefined;
+  status?: string | undefined;
+  time?: string | undefined;
+  code?: string | undefined;
+  response_data?: { [k: string]: any } | undefined;
+  attempt_number?: number | undefined;
+  manual?: boolean | undefined;
+  event_id?: string | undefined;
+  destination_id?: string | undefined;
+  event?: EventSummary$Outbound | EventFull$Outbound | undefined;
+};
+
+/** @internal */
+export const Attempt$outboundSchema: z.ZodType<
+  Attempt$Outbound,
+  z.ZodTypeDef,
+  Attempt
+> = z.object({
+  id: z.string().optional(),
+  tenantId: z.string().optional(),
+  status: Status$outboundSchema.optional(),
+  time: z.date().transform(v => v.toISOString()).optional(),
+  code: z.string().optional(),
+  responseData: z.record(z.any()).optional(),
+  attemptNumber: z.number().int().optional(),
+  manual: z.boolean().optional(),
+  eventId: z.string().optional(),
+  destinationId: z.string().optional(),
+  event: z.union([EventSummary$outboundSchema, EventFull$outboundSchema])
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    tenantId: "tenant_id",
+    responseData: "response_data",
+    attemptNumber: "attempt_number",
+    eventId: "event_id",
+    destinationId: "destination_id",
+  });
+});
+
+export function attemptToJSON(attempt: Attempt): string {
+  return JSON.stringify(Attempt$outboundSchema.parse(attempt));
+}
+export function attemptFromJSON(
+  jsonString: string,
+): SafeParseResult<Attempt, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Attempt$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Attempt' from JSON`,
+  );
+}

package/src/models/components/attemptpaginatedresult.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 {
+  Attempt,
+  Attempt$inboundSchema,
+  Attempt$Outbound,
+  Attempt$outboundSchema,
+} from "./attempt.js";
+import {
+  SeekPagination,
+  SeekPagination$inboundSchema,
+  SeekPagination$Outbound,
+  SeekPagination$outboundSchema,
+} from "./seekpagination.js";
+
+/**
+ * Paginated list of attempts.
+ */
+export type AttemptPaginatedResult = {
+  /**
+   * Array of attempt objects.
+   */
+  models?: Array<Attempt> | undefined;
+  /**
+   * Cursor-based pagination metadata for list responses.
+   */
+  pagination?: SeekPagination | undefined;
+};
+
+/** @internal */
+export const AttemptPaginatedResult$inboundSchema: z.ZodType<
+  AttemptPaginatedResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  models: z.array(Attempt$inboundSchema).optional(),
+  pagination: SeekPagination$inboundSchema.optional(),
+});
+/** @internal */
+export type AttemptPaginatedResult$Outbound = {
+  models?: Array<Attempt$Outbound> | undefined;
+  pagination?: SeekPagination$Outbound | undefined;
+};
+
+/** @internal */
+export const AttemptPaginatedResult$outboundSchema: z.ZodType<
+  AttemptPaginatedResult$Outbound,
+  z.ZodTypeDef,
+  AttemptPaginatedResult
+> = z.object({
+  models: z.array(Attempt$outboundSchema).optional(),
+  pagination: SeekPagination$outboundSchema.optional(),
+});
+
+export function attemptPaginatedResultToJSON(
+  attemptPaginatedResult: AttemptPaginatedResult,
+): string {
+  return JSON.stringify(
+    AttemptPaginatedResult$outboundSchema.parse(attemptPaginatedResult),
+  );
+}
+export function attemptPaginatedResultFromJSON(
+  jsonString: string,
+): SafeParseResult<AttemptPaginatedResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AttemptPaginatedResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AttemptPaginatedResult' from JSON`,
+  );
+}

package/src/models/components/destinationawskinesis.ts

@@ -63,7 +63,7 @@ export type DestinationAWSKinesis = {
   config: AWSKinesisConfig;
   credentials: AWSKinesisCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationawss3.ts

@@ -63,7 +63,7 @@ export type DestinationAwss3 = {
   config: Awss3Config;
   credentials: Awss3Credentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationawssqs.ts

@@ -63,7 +63,7 @@ export type DestinationAWSSQS = {
   config: AWSSQSConfig;
   credentials: AWSSQSCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationazureservicebus.ts

@@ -63,7 +63,7 @@ export type DestinationAzureServiceBus = {
   config: AzureServiceBusConfig;
   credentials: AzureServiceBusCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreateawskinesis.ts

@@ -51,7 +51,7 @@ export type DestinationCreateAWSKinesis = {
   config: AWSKinesisConfig;
   credentials: AWSKinesisCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreateawss3.ts

@@ -51,7 +51,7 @@ export type DestinationCreateAwss3 = {
   config: Awss3Config;
   credentials: Awss3Credentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreateawssqs.ts

@@ -51,7 +51,7 @@ export type DestinationCreateAWSSQS = {
   config: AWSSQSConfig;
   credentials: AWSSQSCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreateazureservicebus.ts

@@ -51,7 +51,7 @@ export type DestinationCreateAzureServiceBus = {
   config: AzureServiceBusConfig;
   credentials: AzureServiceBusCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreategcppubsub.ts

@@ -51,7 +51,7 @@ export type DestinationCreateGCPPubSub = {
   config: GCPPubSubConfig;
   credentials: GCPPubSubCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreatehookdeck.ts

@@ -45,7 +45,7 @@ export type DestinationCreateHookdeck = {
   config?: any | undefined;
   credentials: HookdeckCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreaterabbitmq.ts

@@ -51,7 +51,7 @@ export type DestinationCreateRabbitMQ = {
   config: RabbitMQConfig;
   credentials: RabbitMQCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationcreatewebhook.ts

@@ -51,7 +51,7 @@ export type DestinationCreateWebhook = {
   config: WebhookConfig;
   credentials?: WebhookCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationgcppubsub.ts

@@ -63,7 +63,7 @@ export type DestinationGCPPubSub = {
   config: GCPPubSubConfig;
   credentials: GCPPubSubCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationhookdeck.ts

@@ -57,7 +57,7 @@ export type DestinationHookdeck = {
   config?: any | undefined;
   credentials: HookdeckCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationrabbitmq.ts

@@ -63,7 +63,7 @@ export type DestinationRabbitMQ = {
   config: RabbitMQConfig;
   credentials: RabbitMQCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdateawskinesis.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateAWSKinesis = {
   config?: AWSKinesisConfig | undefined;
   credentials?: AWSKinesisCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdateawss3.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateAwss3 = {
   config?: Awss3Config | undefined;
   credentials?: Awss3Credentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdateawssqs.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateAWSSQS = {
   config?: AWSSQSConfig | undefined;
   credentials?: AWSSQSCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdateazureservicebus.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateAzureServiceBus = {
   config?: AzureServiceBusConfig | undefined;
   credentials?: AzureServiceBusCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdategcppubsub.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateGCPPubSub = {
   config?: GCPPubSubConfig | undefined;
   credentials?: GCPPubSubCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdatehookdeck.ts

@@ -37,7 +37,7 @@ export type DestinationUpdateHookdeck = {
   config?: any | undefined;
   credentials?: HookdeckCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdaterabbitmq.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateRabbitMQ = {
   config?: RabbitMQConfig | undefined;
   credentials?: RabbitMQCredentials | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationupdatewebhook.ts

@@ -43,7 +43,7 @@ export type DestinationUpdateWebhook = {
   config?: WebhookConfig | undefined;
   credentials?: WebhookCredentialsUpdate | undefined;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**

package/src/models/components/destinationwebhook.ts

@@ -63,7 +63,7 @@ export type DestinationWebhook = {
   config: WebhookConfig;
   credentials: WebhookCredentials;
   /**
-   * Static key-value pairs merged into event metadata on every delivery.
+   * Static key-value pairs merged into event metadata on every attempt.
    */
   deliveryMetadata?: { [k: string]: string } | null | undefined;
   /**