@hookdeck/outpost-sdk 0.0.2

package/docs/sdks/topics/README.md

@@ -0,0 +1,179 @@
+# Topics
+(*topics*)
+
+## Overview
+
+Operations for retrieving available event topics.
+
+### Available Operations
+
+* [list](#list) - List Available Topics (for Tenant)
+* [listJwt](#listjwt) - List Available Topics (JWT Auth)
+
+## list
+
+Returns a list of available event topics configured in the Outpost instance. Requires Admin API Key or Tenant JWT.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.topics.list({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
+import { topicsList } from "@hookdeck/outpost-sdk/funcs/topicsList.js";
+
+// Use `OutpostCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const outpost = new OutpostCore();
+
+async function run() {
+  const res = await topicsList(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.ListTenantTopicsRequest](../../models/operations/listtenanttopicsrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.ListTenantTopicsSecurity](../../models/operations/listtenanttopicssecurity.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[string[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.UnauthorizedError     | 401, 403, 407                | application/json             |
+| errors.TimeoutError          | 408                          | application/json             |
+| errors.RateLimitedError      | 429                          | application/json             |
+| errors.BadRequestError       | 400, 413, 414, 415, 422, 431 | application/json             |
+| errors.TimeoutError          | 504                          | application/json             |
+| errors.NotFoundError         | 501, 505                     | application/json             |
+| errors.InternalServerError   | 500, 502, 503, 506, 507, 508 | application/json             |
+| errors.BadRequestError       | 510                          | application/json             |
+| errors.UnauthorizedError     | 511                          | application/json             |
+| errors.APIError              | 4XX, 5XX                     | \*/\*                        |
+
+## listJwt
+
+Returns a list of available event topics configured in the Outpost instance (infers tenant from JWT).
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.topics.listJwt({
+    tenantJwt: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
+import { topicsListJwt } from "@hookdeck/outpost-sdk/funcs/topicsListJwt.js";
+
+// Use `OutpostCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const outpost = new OutpostCore();
+
+async function run() {
+  const res = await topicsListJwt(outpost, {
+    tenantJwt: "<YOUR_BEARER_TOKEN_HERE>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `security`                                                                                                                                                                     | [operations.ListTopicsJwtSecurity](../../models/operations/listtopicsjwtsecurity.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[string[]](../../models/.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.NotFoundError         | 404                          | application/json             |
+| errors.UnauthorizedError     | 403, 407                     | application/json             |
+| errors.TimeoutError          | 408                          | application/json             |
+| errors.RateLimitedError      | 429                          | application/json             |
+| errors.BadRequestError       | 400, 413, 414, 415, 422, 431 | application/json             |
+| errors.TimeoutError          | 504                          | application/json             |
+| errors.NotFoundError         | 501, 505                     | application/json             |
+| errors.InternalServerError   | 500, 502, 503, 506, 507, 508 | application/json             |
+| errors.BadRequestError       | 510                          | application/json             |
+| errors.UnauthorizedError     | 511                          | application/json             |
+| errors.APIError              | 4XX, 5XX                     | \*/\*                        |

package/jsr.json

@@ -0,0 +1,27 @@
+
+
+{
+  "name": "@hookdeck/outpost-sdk",
+  "version": "0.0.2",
+  "exports": {
+    ".": "./src/index.ts",    
+    "./models/errors": "./src/models/errors/index.ts",    
+    "./models/components": "./src/models/components/index.ts",    
+    "./models/operations": "./src/models/operations/index.ts",
+    "./lib/config": "./src/lib/config.ts",
+    "./lib/http": "./src/lib/http.ts",
+    "./lib/retries": "./src/lib/retries.ts",
+    "./lib/sdks": "./src/lib/sdks.ts",
+    "./types": "./src/types/index.ts"
+  },
+  "publish": {
+    "include": [
+      "LICENSE",
+      "README.md",
+      "RUNTIMES.md",
+      "USAGE.md",
+      "jsr.json",
+      "src/**/*.ts"
+    ]
+  }
+}

package/package.json

@@ -0,0 +1,144 @@
+{
+  "name": "@hookdeck/outpost-sdk",
+  "version": "0.0.2",
+  "author": "Speakeasy",
+  "type": "module",
+  "bin": {
+    "mcp": "bin/mcp-server.js"
+  },
+  "tshy": {
+    "sourceDialects": [
+      "@hookdeck/outpost-sdk/source"
+    ],
+    "exports": {
+      ".": "./src/index.ts",
+      "./package.json": "./package.json",
+      "./types": "./src/types/index.ts",
+      "./models/errors": "./src/models/errors/index.ts",
+      "./models/components": "./src/models/components/index.ts",
+      "./models/operations": "./src/models/operations/index.ts",
+      "./*.js": "./src/*.ts",
+      "./*": "./src/*.ts"
+    }
+  },
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hookdeck/outpost.git",
+    "directory": "sdks/typescript"
+  },
+  "scripts": {
+    "lint": "eslint --cache --max-warnings=0 src",
+    "build:mcp": "bun src/mcp-server/build.mts",
+    "build": "npm run build:mcp && tshy",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
+    "zod": ">= 3"
+  },
+  "peerDependenciesMeta": {
+    "@modelcontextprotocol/sdk": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.19.0",
+    "@modelcontextprotocol/sdk": ">=1.5.0 <1.10.0",
+    "@stricli/core": "^1.1.1",
+    "@types/express": "^4.17.21",
+    "bun": "^1.2.2",
+    "bun-types": "^1.2.2",
+    "eslint": "^9.19.0",
+    "express": "^4.21.2",
+    "globals": "^15.14.0",
+    "tshy": "^2.0.0",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^8.22.0",
+    "zod": "^3.23.4"
+  },
+  "dependencies": {},
+  "exports": {
+    ".": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/index.ts",
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    },
+    "./package.json": "./package.json",
+    "./types": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/types/index.ts",
+        "types": "./dist/esm/types/index.d.ts",
+        "default": "./dist/esm/types/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/types/index.d.ts",
+        "default": "./dist/commonjs/types/index.js"
+      }
+    },
+    "./models/errors": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/models/errors/index.ts",
+        "types": "./dist/esm/models/errors/index.d.ts",
+        "default": "./dist/esm/models/errors/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/errors/index.d.ts",
+        "default": "./dist/commonjs/models/errors/index.js"
+      }
+    },
+    "./models/components": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/models/components/index.ts",
+        "types": "./dist/esm/models/components/index.d.ts",
+        "default": "./dist/esm/models/components/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/components/index.d.ts",
+        "default": "./dist/commonjs/models/components/index.js"
+      }
+    },
+    "./models/operations": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/models/operations/index.ts",
+        "types": "./dist/esm/models/operations/index.d.ts",
+        "default": "./dist/esm/models/operations/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/operations/index.d.ts",
+        "default": "./dist/commonjs/models/operations/index.js"
+      }
+    },
+    "./*.js": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/*.ts",
+        "types": "./dist/esm/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/*.d.ts",
+        "default": "./dist/commonjs/*.js"
+      }
+    },
+    "./*": {
+      "import": {
+        "@hookdeck/outpost-sdk/source": "./src/*.ts",
+        "types": "./dist/esm/*.d.ts",
+        "default": "./dist/esm/*.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/*.d.ts",
+        "default": "./dist/commonjs/*.js"
+      }
+    }
+  },
+  "main": "./dist/commonjs/index.js",
+  "types": "./dist/commonjs/index.d.ts",
+  "module": "./dist/esm/index.js"
+}

package/src/core.ts

@@ -0,0 +1,13 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "./lib/sdks.js";
+
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export class OutpostCore extends ClientSDK {}

package/src/funcs/destinationsCreate.ts

@@ -0,0 +1,250 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OutpostCore } from "../core.js";
+import { encodeJSON, 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 { resolveSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.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";
+
+/**
+ * Create Destination
+ *
+ * @remarks
+ * Creates a new destination for the tenant. The request body structure depends on the `type`.
+ */
+export function destinationsCreate(
+  client: OutpostCore,
+  security: operations.CreateTenantDestinationSecurity,
+  request: operations.CreateTenantDestinationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.Destination,
+    | errors.UnauthorizedError
+    | errors.TimeoutError
+    | errors.RateLimitedError
+    | errors.BadRequestError
+    | errors.TimeoutError
+    | errors.NotFoundError
+    | errors.InternalServerError
+    | errors.BadRequestError
+    | errors.UnauthorizedError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OutpostCore,
+  security: operations.CreateTenantDestinationSecurity,
+  request: operations.CreateTenantDestinationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.Destination,
+      | errors.UnauthorizedError
+      | errors.TimeoutError
+      | errors.RateLimitedError
+      | errors.BadRequestError
+      | errors.TimeoutError
+      | errors.NotFoundError
+      | errors.InternalServerError
+      | errors.BadRequestError
+      | errors.UnauthorizedError
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.CreateTenantDestinationRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.DestinationCreate, { explode: true });
+
+  const pathParams = {
+    tenant_id: encodeSimple(
+      "tenant_id",
+      payload.tenant_id ?? client._options.tenantId,
+      { explode: false, charEncoding: "percent" },
+    ),
+  };
+
+  const path = pathToFunc("/{tenant_id}/destinations")(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.adminApiKey,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.tenantJwt,
+      },
+    ],
+  );
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "createTenantDestination",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: 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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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<
+    components.Destination,
+    | errors.UnauthorizedError
+    | errors.TimeoutError
+    | errors.RateLimitedError
+    | errors.BadRequestError
+    | errors.TimeoutError
+    | errors.NotFoundError
+    | errors.InternalServerError
+    | errors.BadRequestError
+    | errors.UnauthorizedError
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(201, components.Destination$inboundSchema),
+    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(408, errors.TimeoutError$inboundSchema),
+    M.jsonErr(429, errors.RateLimitedError$inboundSchema),
+    M.jsonErr([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([400, 404, "4XX"]),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}