npm - @hookdeck/outpost-sdk - Versions diffs - 0.5.0 → 0.7.0 - Mend

@hookdeck/outpost-sdk 0.5.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1608) hide show

package/docs/sdks/events/README.md DELETED Viewed

@@ -1,551 +0,0 @@
-# Events
-(*events*)
-## Overview
-Operations related to event history and deliveries.
-### Available Operations
-* [list](#list) - List Events
-* [get](#get) - Get Event
-* [listDeliveries](#listdeliveries) - List Event Delivery Attempts
-* [listByDestination](#listbydestination) - List Events by Destination
-* [getByDestination](#getbydestination) - Get Event by Destination
-* [retry](#retry) - Retry Event Delivery
-## list
-Retrieves a list of events for the tenant, supporting cursor navigation (details TBD) and filtering.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="listTenantEvents" method="get" path="/{tenant_id}/events" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const result = await outpost.events.list({});
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsList } from "@hookdeck/outpost-sdk/funcs/eventsList.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsList(outpost, {});
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("eventsList failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListTenantEventsRequest](../../models/operations/listtenanteventsrequest.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\<[operations.ListTenantEventsResponse](../../models/operations/listtenanteventsresponse.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
-Retrieves details for a specific event.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="getTenantEvent" method="get" path="/{tenant_id}/events/{event_id}" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const result = await outpost.events.get({
-    eventId: "<id>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsGet } from "@hookdeck/outpost-sdk/funcs/eventsGet.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsGet(outpost, {
-    eventId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("eventsGet failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetTenantEventRequest](../../models/operations/gettenanteventrequest.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\<[components.Event](../../models/components/event.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                     | \*/\*                        |
-## listDeliveries
-Retrieves a list of delivery attempts for a specific event, including response details.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="listTenantEventDeliveries" method="get" path="/{tenant_id}/events/{event_id}/deliveries" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const result = await outpost.events.listDeliveries({
-    eventId: "<id>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsListDeliveries } from "@hookdeck/outpost-sdk/funcs/eventsListDeliveries.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsListDeliveries(outpost, {
-    eventId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("eventsListDeliveries failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListTenantEventDeliveriesRequest](../../models/operations/listtenanteventdeliveriesrequest.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\<[components.DeliveryAttempt[]](../../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                     | \*/\*                        |
-## listByDestination
-Retrieves events associated with a specific destination for the tenant.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="listTenantEventsByDestination" method="get" path="/{tenant_id}/destinations/{destination_id}/events" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const result = await outpost.events.listByDestination({
-    destinationId: "<id>",
-  });
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsListByDestination } from "@hookdeck/outpost-sdk/funcs/eventsListByDestination.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsListByDestination(outpost, {
-    destinationId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("eventsListByDestination failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListTenantEventsByDestinationRequest](../../models/operations/listtenanteventsbydestinationrequest.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\<[operations.ListTenantEventsByDestinationResponse](../../models/operations/listtenanteventsbydestinationresponse.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                     | \*/\*                        |
-## getByDestination
-Retrieves a specific event associated with a specific destination for the tenant.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="getTenantEventByDestination" method="get" path="/{tenant_id}/destinations/{destination_id}/events/{event_id}" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const result = await outpost.events.getByDestination({
-    destinationId: "<id>",
-    eventId: "<id>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsGetByDestination } from "@hookdeck/outpost-sdk/funcs/eventsGetByDestination.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsGetByDestination(outpost, {
-    destinationId: "<id>",
-    eventId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("eventsGetByDestination failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetTenantEventByDestinationRequest](../../models/operations/gettenanteventbydestinationrequest.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\<[components.Event](../../models/components/event.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                     | \*/\*                        |
-## retry
-Triggers a retry for a failed event delivery.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="retryTenantEvent" method="post" path="/{tenant_id}/destinations/{destination_id}/events/{event_id}/retry" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  await outpost.events.retry({
-    destinationId: "<id>",
-    eventId: "<id>",
-  });
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { eventsRetry } from "@hookdeck/outpost-sdk/funcs/eventsRetry.js";
-// Use `OutpostCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const outpost = new OutpostCore({
-  tenantId: "<id>",
-  security: {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  },
-});
-async function run() {
-  const res = await eventsRetry(outpost, {
-    destinationId: "<id>",
-    eventId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-  } else {
-    console.log("eventsRetry failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.RetryTenantEventRequest](../../models/operations/retrytenanteventrequest.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.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                     | \*/\*                        |

package/docs/sdks/health/README.md DELETED Viewed

@@ -1,84 +0,0 @@
-# Health
-(*health*)
-## Overview
-API Health Check
-### Available Operations
-* [check](#check) - Health Check
-## check
-Simple health check endpoint.
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="healthCheck" method="get" path="/healthz" -->
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-const outpost = new Outpost();
-async function run() {
-  const result = await outpost.health.check();
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
-import { healthCheck } from "@hookdeck/outpost-sdk/funcs/healthCheck.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 healthCheck(outpost);
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("healthCheck failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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     | 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                     | \*/\*                        |