@hookdeck/outpost-sdk 0.9.0 → 0.9.2

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

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { metricsGetEventMetrics } from "../../funcs/metricsGetEventMetrics.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.GetEventMetricsRequest$inboundSchema,
+};
+
+export const tool$metricsGetEventMetrics: ToolDefinition<typeof args> = {
+  name: "metrics-get-event-metrics",
+  description: `Get Event Metrics
+
+Returns aggregated event publish metrics. Supports time bucketing via granularity,
+dimensional grouping, and filtering.
+
+**Measures:** \`count\`, \`rate\`
+
+**Dimensions:** \`tenant_id\` (admin-only), \`topic\`, \`destination_id\`
+
+**Filters:** \`tenant_id\` (admin-only), \`topic\`, \`destination_id\`
+`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await metricsGetEventMetrics(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/attempt.ts

@@ -9,17 +9,11 @@ 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";
+  Destination,
+  Destination$inboundSchema,
+  Destination$Outbound,
+  Destination$outboundSchema,
+} from "./destination.js";
 
 /**
  * The attempt status.
@@ -33,6 +27,60 @@ export const Status = {
  */
 export type Status = ClosedEnum<typeof Status>;
 
+/**
+ * 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;
+};
+
+/**
+ * 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;
+};
+
 /**
  * The associated event object. Only present when include=event or include=event.data.
  */
@@ -65,7 +113,7 @@ export type Attempt = {
   /**
    * Response data from the attempt. Only included when include=response_data.
    */
-  responseData?: { [k: string]: any } | undefined;
+  responseData?: { [k: string]: any } | null | undefined;
   /**
    * The attempt number (1 for first attempt, 2+ for retries).
    */
@@ -85,7 +133,8 @@ export type Attempt = {
   /**
    * The associated event object. Only present when include=event or include=event.data.
    */
-  event?: EventSummary | EventFull | undefined;
+  event?: EventSummary | EventFull | null | undefined;
+  destination?: Destination | undefined;
 };
 
 /** @internal */
@@ -95,12 +144,150 @@ export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
 export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
   Status$inboundSchema;
 
+/** @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`,
+  );
+}
+
+/** @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`,
+  );
+}
+
 /** @internal */
 export const EventUnion$inboundSchema: z.ZodType<
   EventUnion,
   z.ZodTypeDef,
   unknown
-> = z.union([EventSummary$inboundSchema, EventFull$inboundSchema]);
+> = z.union([
+  z.lazy(() => EventSummary$inboundSchema),
+  z.lazy(() => EventFull$inboundSchema),
+]);
 /** @internal */
 export type EventUnion$Outbound = EventSummary$Outbound | EventFull$Outbound;
 
@@ -109,7 +296,10 @@ export const EventUnion$outboundSchema: z.ZodType<
   EventUnion$Outbound,
   z.ZodTypeDef,
   EventUnion
-> = z.union([EventSummary$outboundSchema, EventFull$outboundSchema]);
+> = z.union([
+  z.lazy(() => EventSummary$outboundSchema),
+  z.lazy(() => EventFull$outboundSchema),
+]);
 
 export function eventUnionToJSON(eventUnion: EventUnion): string {
   return JSON.stringify(EventUnion$outboundSchema.parse(eventUnion));
@@ -133,13 +323,18 @@ export const Attempt$inboundSchema: z.ZodType<Attempt, z.ZodTypeDef, unknown> =
     time: z.string().datetime({ offset: true }).transform(v => new Date(v))
       .optional(),
     code: z.string().optional(),
-    response_data: z.record(z.any()).optional(),
+    response_data: z.nullable(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(),
+    event: z.nullable(
+      z.union([
+        z.lazy(() => EventSummary$inboundSchema),
+        z.lazy(() => EventFull$inboundSchema),
+      ]),
+    ).optional(),
+    destination: Destination$inboundSchema.optional(),
   }).transform((v) => {
     return remap$(v, {
       "tenant_id": "tenantId",
@@ -156,12 +351,13 @@ export type Attempt$Outbound = {
   status?: string | undefined;
   time?: string | undefined;
   code?: string | undefined;
-  response_data?: { [k: string]: any } | undefined;
+  response_data?: { [k: string]: any } | null | undefined;
   attempt_number?: number | undefined;
   manual?: boolean | undefined;
   event_id?: string | undefined;
   destination_id?: string | undefined;
-  event?: EventSummary$Outbound | EventFull$Outbound | undefined;
+  event?: EventSummary$Outbound | EventFull$Outbound | null | undefined;
+  destination?: Destination$Outbound | undefined;
 };
 
 /** @internal */
@@ -175,13 +371,18 @@ export const Attempt$outboundSchema: z.ZodType<
   status: Status$outboundSchema.optional(),
   time: z.date().transform(v => v.toISOString()).optional(),
   code: z.string().optional(),
-  responseData: z.record(z.any()).optional(),
+  responseData: z.nullable(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(),
+  event: z.nullable(
+    z.union([
+      z.lazy(() => EventSummary$outboundSchema),
+      z.lazy(() => EventFull$outboundSchema),
+    ]),
+  ).optional(),
+  destination: Destination$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     tenantId: "tenant_id",

package/src/models/components/destinationschemafield.ts

@@ -11,6 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export const TypeEnum = {
   Text: "text",
   Checkbox: "checkbox",
+  KeyValueMap: "key_value_map",
 } as const;
 export type TypeEnum = ClosedEnum<typeof TypeEnum>;
 

package/src/models/components/index.ts

@@ -43,12 +43,13 @@ 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";
+export * from "./metricsdatapoint.js";
+export * from "./metricsmetadata.js";
+export * from "./metricsresponse.js";
 export * from "./portalredirect.js";
 export * from "./publishrequest.js";
 export * from "./publishresponse.js";

package/src/models/components/metricsdatapoint.ts

@@ -0,0 +1,79 @@
+/*
+ * 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";
+
+export type MetricsDataPoint = {
+  /**
+   * Start of the time bucket. Null when no granularity is specified.
+   */
+  timeBucket?: Date | null | undefined;
+  /**
+   * Dimension values for this data point. Empty object when no dimensions are requested.
+   */
+  dimensions?: { [k: string]: string } | undefined;
+  /**
+   * Requested measure values for this data point.
+   */
+  metrics?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const MetricsDataPoint$inboundSchema: z.ZodType<
+  MetricsDataPoint,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  time_bucket: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  dimensions: z.record(z.string()).optional(),
+  metrics: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "time_bucket": "timeBucket",
+  });
+});
+/** @internal */
+export type MetricsDataPoint$Outbound = {
+  time_bucket?: string | null | undefined;
+  dimensions?: { [k: string]: string } | undefined;
+  metrics?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const MetricsDataPoint$outboundSchema: z.ZodType<
+  MetricsDataPoint$Outbound,
+  z.ZodTypeDef,
+  MetricsDataPoint
+> = z.object({
+  timeBucket: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  dimensions: z.record(z.string()).optional(),
+  metrics: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    timeBucket: "time_bucket",
+  });
+});
+
+export function metricsDataPointToJSON(
+  metricsDataPoint: MetricsDataPoint,
+): string {
+  return JSON.stringify(
+    MetricsDataPoint$outboundSchema.parse(metricsDataPoint),
+  );
+}
+export function metricsDataPointFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricsDataPoint, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricsDataPoint$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricsDataPoint' from JSON`,
+  );
+}

package/src/models/components/metricsmetadata.ts

@@ -0,0 +1,93 @@
+/*
+ * 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";
+
+export type MetricsMetadata = {
+  /**
+   * The granularity used for time bucketing, or null if none was specified.
+   */
+  granularity?: string | null | undefined;
+  /**
+   * Query execution time in milliseconds.
+   */
+  queryTimeMs?: number | undefined;
+  /**
+   * Number of data points returned.
+   */
+  rowCount?: number | undefined;
+  /**
+   * Maximum number of rows the query will return.
+   */
+  rowLimit?: number | undefined;
+  /**
+   * Whether the results were truncated due to hitting the row limit.
+   */
+  truncated?: boolean | undefined;
+};
+
+/** @internal */
+export const MetricsMetadata$inboundSchema: z.ZodType<
+  MetricsMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  granularity: z.nullable(z.string()).optional(),
+  query_time_ms: z.number().int().optional(),
+  row_count: z.number().int().optional(),
+  row_limit: z.number().int().optional(),
+  truncated: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "query_time_ms": "queryTimeMs",
+    "row_count": "rowCount",
+    "row_limit": "rowLimit",
+  });
+});
+/** @internal */
+export type MetricsMetadata$Outbound = {
+  granularity?: string | null | undefined;
+  query_time_ms?: number | undefined;
+  row_count?: number | undefined;
+  row_limit?: number | undefined;
+  truncated?: boolean | undefined;
+};
+
+/** @internal */
+export const MetricsMetadata$outboundSchema: z.ZodType<
+  MetricsMetadata$Outbound,
+  z.ZodTypeDef,
+  MetricsMetadata
+> = z.object({
+  granularity: z.nullable(z.string()).optional(),
+  queryTimeMs: z.number().int().optional(),
+  rowCount: z.number().int().optional(),
+  rowLimit: z.number().int().optional(),
+  truncated: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    queryTimeMs: "query_time_ms",
+    rowCount: "row_count",
+    rowLimit: "row_limit",
+  });
+});
+
+export function metricsMetadataToJSON(
+  metricsMetadata: MetricsMetadata,
+): string {
+  return JSON.stringify(MetricsMetadata$outboundSchema.parse(metricsMetadata));
+}
+export function metricsMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricsMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricsMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricsMetadata' from JSON`,
+  );
+}

package/src/models/components/metricsresponse.ts

@@ -0,0 +1,68 @@
+/*
+ * 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 {
+  MetricsDataPoint,
+  MetricsDataPoint$inboundSchema,
+  MetricsDataPoint$Outbound,
+  MetricsDataPoint$outboundSchema,
+} from "./metricsdatapoint.js";
+import {
+  MetricsMetadata,
+  MetricsMetadata$inboundSchema,
+  MetricsMetadata$Outbound,
+  MetricsMetadata$outboundSchema,
+} from "./metricsmetadata.js";
+
+export type MetricsResponse = {
+  /**
+   * Array of aggregated data points.
+   */
+  data?: Array<MetricsDataPoint> | undefined;
+  metadata?: MetricsMetadata | undefined;
+};
+
+/** @internal */
+export const MetricsResponse$inboundSchema: z.ZodType<
+  MetricsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(MetricsDataPoint$inboundSchema).optional(),
+  metadata: MetricsMetadata$inboundSchema.optional(),
+});
+/** @internal */
+export type MetricsResponse$Outbound = {
+  data?: Array<MetricsDataPoint$Outbound> | undefined;
+  metadata?: MetricsMetadata$Outbound | undefined;
+};
+
+/** @internal */
+export const MetricsResponse$outboundSchema: z.ZodType<
+  MetricsResponse$Outbound,
+  z.ZodTypeDef,
+  MetricsResponse
+> = z.object({
+  data: z.array(MetricsDataPoint$outboundSchema).optional(),
+  metadata: MetricsMetadata$outboundSchema.optional(),
+});
+
+export function metricsResponseToJSON(
+  metricsResponse: MetricsResponse,
+): string {
+  return JSON.stringify(MetricsResponse$outboundSchema.parse(metricsResponse));
+}
+export function metricsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MetricsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MetricsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MetricsResponse' from JSON`,
+  );
+}

package/src/models/operations/getattempt.ts

@@ -15,6 +15,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * - `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
+ * - `destination`: Include the full destination object
  */
 export type GetAttemptInclude = string | Array<string>;
 
@@ -30,6 +31,7 @@ export type GetAttemptRequest = {
    * - `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
+   * - `destination`: Include the full destination object
    */
   include?: string | Array<string> | undefined;
 };