@hookdeck/outpost-sdk 0.5.0 → 0.7.0

package/examples/README.md

@@ -1,31 +0,0 @@
-# @hookdeck/outpost-sdk Examples
-
-This directory contains example scripts demonstrating how to use the @hookdeck/outpost-sdk SDK.
-
-## Prerequisites
-
-- Node.js (v18 or higher)
-- npm
-
-## Setup
-
-1. Copy `.env.template` to `.env`:
-   ```bash
-   cp .env.template .env
-   ```
-
-2. Edit `.env` and add your actual credentials
-
-## Running the Examples
-
-To run an example file from the examples directory:
-
-```bash
-npm run build && npx tsx example.ts
-```
-
-## Creating new examples
-
-Duplicate an existing example file, they won't be overwritten by the generation process.
-
-

package/src/funcs/eventsListByDestination.ts

@@ -1,328 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { OutpostCore } from "../core.js";
-import { dlv } from "../lib/dlv.js";
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { OutpostError } from "../models/errors/outposterror.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-import {
-  createPageIterator,
-  haltIterator,
-  PageIterator,
-  Paginator,
-} from "../types/operations.js";
-
-/**
- * List Events by Destination
- *
- * @remarks
- * Retrieves events associated with a specific destination for the tenant.
- */
-export function eventsListByDestination(
-  client: OutpostCore,
-  request: operations.ListTenantEventsByDestinationRequest,
-  options?: RequestOptions,
-): APIPromise<
-  PageIterator<
-    Result<
-      operations.ListTenantEventsByDestinationResponse,
-      | errors.UnauthorizedError
-      | errors.TimeoutError
-      | errors.RateLimitedError
-      | errors.BadRequestError
-      | errors.NotFoundError
-      | errors.InternalServerError
-      | OutpostError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    { cursor: string }
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: OutpostCore,
-  request: operations.ListTenantEventsByDestinationRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    PageIterator<
-      Result<
-        operations.ListTenantEventsByDestinationResponse,
-        | errors.UnauthorizedError
-        | errors.TimeoutError
-        | errors.RateLimitedError
-        | errors.BadRequestError
-        | errors.NotFoundError
-        | errors.InternalServerError
-        | OutpostError
-        | ResponseValidationError
-        | ConnectionError
-        | RequestAbortedError
-        | RequestTimeoutError
-        | InvalidRequestError
-        | UnexpectedClientError
-        | SDKValidationError
-      >,
-      { cursor: string }
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.ListTenantEventsByDestinationRequest$outboundSchema.parse(
-        value,
-      ),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [haltIterator(parsed), { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const pathParams = {
-    destination_id: encodeSimple("destination_id", payload.destination_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
-  };
-
-  const path = pathToFunc("/{tenant_id}/destinations/{destination_id}/events")(
-    pathParams,
-  );
-
-  const query = encodeFormQuery({
-    "end": payload.end,
-    "limit": payload.limit,
-    "next": payload.next,
-    "prev": payload.prev,
-    "start": payload.start,
-    "status": payload.status,
-  });
-
-  const headers = new Headers(compactMap({
-    Accept: "application/json",
-  }));
-
-  const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listTenantEventsByDestination",
-    oAuth2Scopes: null,
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.security,
-    retryConfig: options?.retries
-      || client._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
-  };
-
-  const requestRes = client._createRequest(context, {
-    security: requestSecurity,
-    method: "GET",
-    baseURL: options?.serverURL,
-    path: path,
-    headers: headers,
-    query: query,
-    body: body,
-    userAgent: client._options.userAgent,
-    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [haltIterator(requestRes), { status: "invalid" }];
-  }
-  const req = requestRes.value;
-
-  const doResult = await client._do(req, {
-    context,
-    errorCodes: [
-      "400",
-      "401",
-      "403",
-      "404",
-      "407",
-      "408",
-      "413",
-      "414",
-      "415",
-      "422",
-      "429",
-      "431",
-      "4XX",
-      "500",
-      "501",
-      "502",
-      "503",
-      "504",
-      "505",
-      "506",
-      "507",
-      "508",
-      "510",
-      "511",
-      "5XX",
-    ],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [haltIterator(doResult), { status: "request-error", request: req }];
-  }
-  const response = doResult.value;
-
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
-  const [result, raw] = await M.match<
-    operations.ListTenantEventsByDestinationResponse,
-    | errors.UnauthorizedError
-    | errors.TimeoutError
-    | errors.RateLimitedError
-    | errors.BadRequestError
-    | errors.NotFoundError
-    | errors.InternalServerError
-    | OutpostError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(
-      200,
-      operations.ListTenantEventsByDestinationResponse$inboundSchema,
-      { key: "Result" },
-    ),
-    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
-    M.jsonErr(408, errors.TimeoutError$inboundSchema),
-    M.jsonErr(429, errors.RateLimitedError$inboundSchema),
-    M.jsonErr(
-      [400, 413, 414, 415, 422, 431],
-      errors.BadRequestError$inboundSchema,
-    ),
-    M.jsonErr(504, errors.TimeoutError$inboundSchema),
-    M.jsonErr([501, 505], errors.NotFoundError$inboundSchema),
-    M.jsonErr(
-      [500, 502, 503, 506, 507, 508],
-      errors.InternalServerError$inboundSchema,
-    ),
-    M.jsonErr(510, errors.BadRequestError$inboundSchema),
-    M.jsonErr(511, errors.UnauthorizedError$inboundSchema),
-    M.fail([404, "4XX"]),
-    M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [haltIterator(result), {
-      status: "complete",
-      request: req,
-      response,
-    }];
-  }
-
-  const nextFunc = (
-    responseData: unknown,
-  ): {
-    next: Paginator<
-      Result<
-        operations.ListTenantEventsByDestinationResponse,
-        | errors.UnauthorizedError
-        | errors.TimeoutError
-        | errors.RateLimitedError
-        | errors.BadRequestError
-        | errors.NotFoundError
-        | errors.InternalServerError
-        | OutpostError
-        | ResponseValidationError
-        | ConnectionError
-        | RequestAbortedError
-        | RequestTimeoutError
-        | InvalidRequestError
-        | UnexpectedClientError
-        | SDKValidationError
-      >
-    >;
-    "~next"?: { cursor: string };
-  } => {
-    const nextCursor = dlv(responseData, "next");
-    if (typeof nextCursor !== "string") {
-      return { next: () => null };
-    }
-    if (nextCursor.trim() === "") {
-      return { next: () => null };
-    }
-    const results = dlv(responseData, "data");
-    if (!Array.isArray(results) || !results.length) {
-      return { next: () => null };
-    }
-    const limit = request?.limit ?? 100;
-    if (results.length < limit) {
-      return { next: () => null };
-    }
-
-    const nextVal = () =>
-      eventsListByDestination(
-        client,
-        {
-          ...request,
-          next: nextCursor,
-        },
-        options,
-      );
-
-    return { next: nextVal, "~next": { cursor: nextCursor } };
-  };
-
-  const page = { ...result, ...nextFunc(raw) };
-  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
-    status: "complete",
-    request: req,
-    response,
-  }];
-}

package/src/funcs/eventsListDeliveries.ts

@@ -1,239 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { OutpostCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import * as components from "../models/components/index.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { OutpostError } from "../models/errors/outposterror.js";
-import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * List Event Delivery Attempts
- *
- * @remarks
- * Retrieves a list of delivery attempts for a specific event, including response details.
- */
-export function eventsListDeliveries(
-  client: OutpostCore,
-  request: operations.ListTenantEventDeliveriesRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    Array<components.DeliveryAttempt>,
-    | errors.UnauthorizedError
-    | errors.TimeoutError
-    | errors.RateLimitedError
-    | errors.BadRequestError
-    | errors.NotFoundError
-    | errors.InternalServerError
-    | OutpostError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: OutpostCore,
-  request: operations.ListTenantEventDeliveriesRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      Array<components.DeliveryAttempt>,
-      | errors.UnauthorizedError
-      | errors.TimeoutError
-      | errors.RateLimitedError
-      | errors.BadRequestError
-      | errors.NotFoundError
-      | errors.InternalServerError
-      | OutpostError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.ListTenantEventDeliveriesRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const pathParams = {
-    event_id: encodeSimple("event_id", payload.event_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
-  };
-
-  const path = pathToFunc("/{tenant_id}/events/{event_id}/deliveries")(
-    pathParams,
-  );
-
-  const headers = new Headers(compactMap({
-    Accept: "application/json",
-  }));
-
-  const securityInput = await extractSecurity(client._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listTenantEventDeliveries",
-    oAuth2Scopes: null,
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.security,
-    retryConfig: options?.retries
-      || client._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
-  };
-
-  const requestRes = client._createRequest(context, {
-    security: requestSecurity,
-    method: "GET",
-    baseURL: options?.serverURL,
-    path: path,
-    headers: headers,
-    body: body,
-    userAgent: client._options.userAgent,
-    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req = requestRes.value;
-
-  const doResult = await client._do(req, {
-    context,
-    errorCodes: [
-      "400",
-      "401",
-      "403",
-      "404",
-      "407",
-      "408",
-      "413",
-      "414",
-      "415",
-      "422",
-      "429",
-      "431",
-      "4XX",
-      "500",
-      "501",
-      "502",
-      "503",
-      "504",
-      "505",
-      "506",
-      "507",
-      "508",
-      "510",
-      "511",
-      "5XX",
-    ],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
-  }
-  const response = doResult.value;
-
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
-  const [result] = await M.match<
-    Array<components.DeliveryAttempt>,
-    | errors.UnauthorizedError
-    | errors.TimeoutError
-    | errors.RateLimitedError
-    | errors.BadRequestError
-    | errors.NotFoundError
-    | errors.InternalServerError
-    | OutpostError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, z.array(components.DeliveryAttempt$inboundSchema)),
-    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
-    M.jsonErr(408, errors.TimeoutError$inboundSchema),
-    M.jsonErr(429, errors.RateLimitedError$inboundSchema),
-    M.jsonErr(
-      [400, 413, 414, 415, 422, 431],
-      errors.BadRequestError$inboundSchema,
-    ),
-    M.jsonErr(504, errors.TimeoutError$inboundSchema),
-    M.jsonErr([501, 505], errors.NotFoundError$inboundSchema),
-    M.jsonErr(
-      [500, 502, 503, 506, 507, 508],
-      errors.InternalServerError$inboundSchema,
-    ),
-    M.jsonErr(510, errors.BadRequestError$inboundSchema),
-    M.jsonErr(511, errors.UnauthorizedError$inboundSchema),
-    M.fail([404, "4XX"]),
-    M.fail("5XX"),
-  )(response, req, { extraFields: responseFields });
-  if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
-  }
-
-  return [result, { status: "complete", request: req, response }];
-}

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

@@ -1,37 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { eventsListByDestination } from "../../funcs/eventsListByDestination.js";
-import * as operations from "../../models/operations/index.js";
-import { formatResult, ToolDefinition } from "../tools.js";
-
-const args = {
-  request: operations.ListTenantEventsByDestinationRequest$inboundSchema,
-};
-
-export const tool$eventsListByDestination: ToolDefinition<typeof args> = {
-  name: "events-list-by-destination",
-  description: `List Events by Destination
-
-Retrieves events associated with a specific destination for the tenant.`,
-  args,
-  tool: async (client, args, ctx) => {
-    const [result, apiCall] = await eventsListByDestination(
-      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.result;
-
-    return formatResult(value, apiCall);
-  },
-};

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

@@ -1,35 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { eventsRetry } from "../../funcs/eventsRetry.js";
-import * as operations from "../../models/operations/index.js";
-import { formatResult, ToolDefinition } from "../tools.js";
-
-const args = {
-  request: operations.RetryTenantEventRequest$inboundSchema,
-};
-
-export const tool$eventsRetry: ToolDefinition<typeof args> = {
-  name: "events-retry",
-  description: `Retry Event Delivery
-
-Triggers a retry for a failed event delivery.`,
-  args,
-  tool: async (client, args, ctx) => {
-    const [result, apiCall] = await eventsRetry(
-      client,
-      args.request,
-      { fetchOptions: { signal: ctx.signal } },
-    ).$inspect();
-
-    if (!result.ok) {
-      return {
-        content: [{ type: "text", text: result.error.message }],
-        isError: true,
-      };
-    }
-
-    return formatResult(void 0, apiCall);
-  },
-};

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

@@ -1,30 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { topicsListJwt } from "../../funcs/topicsListJwt.js";
-import { formatResult, ToolDefinition } from "../tools.js";
-
-export const tool$topicsListJwt: ToolDefinition = {
-  name: "topics-list-jwt",
-  description: `List Available Topics)
-
-Returns a list of available event topics configured in the Outpost instance.`,
-  tool: async (client, ctx) => {
-    const [result, apiCall] = await topicsListJwt(
-      client,
-      { 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);
-  },
-};