@hookdeck/outpost-sdk 0.0.2

package/docs/sdks/outpost/README.md

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

package/docs/sdks/publish/README.md

@@ -0,0 +1,114 @@
+# Publish
+(*publish*)
+
+## Overview
+
+Operations for publishing events.
+
+### Available Operations
+
+* [event](#event) - Publish Event
+
+## event
+
+Publishes an event to the specified topic, potentially routed to a specific destination. Requires Admin API Key.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost({
+  adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  await outpost.publish.event({
+    tenantId: "<TENANT_ID>",
+    destinationId: "<DESTINATION_ID>",
+    topic: "topic.name",
+    eligibleForRetry: false,
+    metadata: {
+      "source": "crm",
+    },
+    data: {
+      "user_id": "userid",
+      "status": "active",
+    },
+  });
+
+
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
+import { publishEvent } from "@hookdeck/outpost-sdk/funcs/publishEvent.js";
+
+// Use `OutpostCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const outpost = new OutpostCore({
+  adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await publishEvent(outpost, {
+    tenantId: "<TENANT_ID>",
+    destinationId: "<DESTINATION_ID>",
+    topic: "topic.name",
+    eligibleForRetry: false,
+    metadata: {
+      "source": "crm",
+    },
+    data: {
+      "user_id": "userid",
+      "status": "active",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.PublishRequest](../../models/components/publishrequest.md)                                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object 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\<void\>**
+
+### 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       | 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/docs/sdks/schemas/README.md

@@ -0,0 +1,355 @@
+# Schemas
+(*schemas*)
+
+## Overview
+
+Operations for retrieving destination type schemas.
+
+### Available Operations
+
+* [listTenantDestinationTypes](#listtenantdestinationtypes) - List Destination Type Schemas (for Tenant)
+* [get](#get) - Get Destination Type Schema (for Tenant)
+* [listDestinationTypesJwt](#listdestinationtypesjwt) - List Destination Type Schemas (JWT Auth)
+* [getDestinationTypeJwt](#getdestinationtypejwt) - Get Destination Type Schema (JWT Auth)
+
+## listTenantDestinationTypes
+
+Returns a list of JSON-based input schemas for each available destination type. 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.schemas.listTenantDestinationTypes({
+    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 { schemasListTenantDestinationTypes } from "@hookdeck/outpost-sdk/funcs/schemasListTenantDestinationTypes.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 schemasListTenantDestinationTypes(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.ListTenantDestinationTypeSchemasRequest](../../models/operations/listtenantdestinationtypeschemasrequest.md)                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.ListTenantDestinationTypeSchemasSecurity](../../models/operations/listtenantdestinationtypeschemassecurity.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\<[components.DestinationTypeSchema[]](../../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                     | \*/\*                        |
+
+## get
+
+Returns the input schema for a specific destination type. 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.schemas.get({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    type: "rabbitmq",
+  });
+
+  // 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 { schemasGet } from "@hookdeck/outpost-sdk/funcs/schemasGet.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 schemasGet(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    type: "rabbitmq",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetTenantDestinationTypeSchemaRequest](../../models/operations/gettenantdestinationtypeschemarequest.md)                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.GetTenantDestinationTypeSchemaSecurity](../../models/operations/gettenantdestinationtypeschemasecurity.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\<[components.DestinationTypeSchema](../../models/components/destinationtypeschema.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                     | \*/\*                        |
+
+## listDestinationTypesJwt
+
+Returns a list of JSON-based input schemas for each available destination type (infers tenant from JWT).
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.schemas.listDestinationTypesJwt({
+    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 { schemasListDestinationTypesJwt } from "@hookdeck/outpost-sdk/funcs/schemasListDestinationTypesJwt.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 schemasListDestinationTypesJwt(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.ListDestinationTypeSchemasJwtSecurity](../../models/operations/listdestinationtypeschemasjwtsecurity.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\<[components.DestinationTypeSchema[]](../../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                     | \*/\*                        |
+
+## getDestinationTypeJwt
+
+Returns the input schema for a specific destination type (infers tenant from JWT).
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.schemas.getDestinationTypeJwt({
+    tenantJwt: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    type: "rabbitmq",
+  });
+
+  // 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 { schemasGetDestinationTypeJwt } from "@hookdeck/outpost-sdk/funcs/schemasGetDestinationTypeJwt.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 schemasGetDestinationTypeJwt(outpost, {
+    tenantJwt: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    type: "rabbitmq",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetDestinationTypeSchemaJwtRequest](../../models/operations/getdestinationtypeschemajwtrequest.md)                                                                 | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.GetDestinationTypeSchemaJwtSecurity](../../models/operations/getdestinationtypeschemajwtsecurity.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\<[components.DestinationTypeSchema](../../models/components/destinationtypeschema.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| 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                     | \*/\*                        |