@hookdeck/outpost-sdk 0.0.2

package/docs/sdks/destinations/README.md

@@ -0,0 +1,703 @@
+# Destinations
+(*destinations*)
+
+## Overview
+
+Destinations are the endpoints where events are sent. Each destination is associated with a tenant and can be configured to receive specific event topics.
+
+```json
+{
+  "id": "des_12345", // Control plane generated ID or user provided ID
+  "type": "webhooks", // Type of the destination
+  "topics": ["user.created", "user.updated"], // Topics of events this destination is eligible for
+  "config": {
+    // Destination type specific configuration. Schema of depends on type
+    "url": "https://example.com/webhooks/user"
+  },
+  "credentials": {
+    // Destination type specific credentials. AES encrypted. Schema depends on type
+    "secret": "some***********"
+  },
+  "disabled_at": null, // null or ISO date if disabled
+  "created_at": "2024-01-01T00:00:00Z" // Date the destination was created
+}
+```
+
+The `topics` array can contain either a list of topics or a wildcard `*` implying that all topics are supported. If you do not wish to implement topics for your application, you set all destination topics to `*`.
+
+By default all destination `credentials` are obfuscated and the values cannot be read. This does not apply to the `webhook` type destination secret and each destination can expose their own obfuscation logic.
+
+
+### Available Operations
+
+* [list](#list) - List Destinations
+* [create](#create) - Create Destination
+* [get](#get) - Get Destination
+* [update](#update) - Update Destination
+* [delete](#delete) - Delete Destination
+* [enable](#enable) - Enable Destination
+* [disable](#disable) - Disable Destination
+
+## list
+
+Return a list of the destinations for the tenant. The endpoint is not paged.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.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 { destinationsList } from "@hookdeck/outpost-sdk/funcs/destinationsList.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 destinationsList(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.ListTenantDestinationsRequest](../../models/operations/listtenantdestinationsrequest.md)                                                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.ListTenantDestinationsSecurity](../../models/operations/listtenantdestinationssecurity.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.Destination[]](../../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                     | \*/\*                        |
+
+## create
+
+Creates a new destination for the tenant. The request body structure depends on the `type`.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.create({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationCreate: {
+      id: "user-provided-id",
+      type: "aws_sqs",
+      topics: "*",
+      config: {
+        endpoint: "https://sqs.us-east-1.amazonaws.com",
+        queueUrl: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
+      },
+      credentials: {
+        key: "AKIAIOSFODNN7EXAMPLE",
+        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        session: "AQoDYXdzEPT//////////wEXAMPLE...",
+      },
+    },
+  });
+
+  // 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 { destinationsCreate } from "@hookdeck/outpost-sdk/funcs/destinationsCreate.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 destinationsCreate(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationCreate: {
+      id: "user-provided-id",
+      type: "aws_sqs",
+      topics: "*",
+      config: {
+        endpoint: "https://sqs.us-east-1.amazonaws.com",
+        queueUrl: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
+      },
+      credentials: {
+        key: "AKIAIOSFODNN7EXAMPLE",
+        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        session: "AQoDYXdzEPT//////////wEXAMPLE...",
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateTenantDestinationRequest](../../models/operations/createtenantdestinationrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.CreateTenantDestinationSecurity](../../models/operations/createtenantdestinationsecurity.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.Destination](../../models/components/destination.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       | 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 destination.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.get({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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 { destinationsGet } from "@hookdeck/outpost-sdk/funcs/destinationsGet.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 destinationsGet(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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.GetTenantDestinationRequest](../../models/operations/gettenantdestinationrequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.GetTenantDestinationSecurity](../../models/operations/gettenantdestinationsecurity.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.Destination](../../models/components/destination.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                     | \*/\*                        |
+
+## update
+
+Updates the configuration of an existing destination. The request body structure depends on the destination's `type`. Type itself cannot be updated. May return an OAuth redirect URL for certain types.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.update({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<id>",
+    destinationUpdate: {
+      topics: "*",
+      config: {
+        serverUrl: "localhost:5672",
+        exchange: "my-exchange",
+        tls: "false",
+      },
+      credentials: {
+        username: "guest",
+        password: "guest",
+      },
+    },
+  });
+
+  // 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 { destinationsUpdate } from "@hookdeck/outpost-sdk/funcs/destinationsUpdate.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 destinationsUpdate(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<id>",
+    destinationUpdate: {
+      topics: "*",
+      config: {
+        serverUrl: "localhost:5672",
+        exchange: "my-exchange",
+        tls: "false",
+      },
+      credentials: {
+        username: "guest",
+        password: "guest",
+      },
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateTenantDestinationRequest](../../models/operations/updatetenantdestinationrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.UpdateTenantDestinationSecurity](../../models/operations/updatetenantdestinationsecurity.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\<[operations.UpdateTenantDestinationResponse](../../models/operations/updatetenantdestinationresponse.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       | 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                     | \*/\*                        |
+
+## delete
+
+Deletes a specific destination.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.delete({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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 { destinationsDelete } from "@hookdeck/outpost-sdk/funcs/destinationsDelete.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 destinationsDelete(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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.DeleteTenantDestinationRequest](../../models/operations/deletetenantdestinationrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.DeleteTenantDestinationSecurity](../../models/operations/deletetenantdestinationsecurity.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.SuccessResponse](../../models/components/successresponse.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                     | \*/\*                        |
+
+## enable
+
+Enables a previously disabled destination.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.enable({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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 { destinationsEnable } from "@hookdeck/outpost-sdk/funcs/destinationsEnable.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 destinationsEnable(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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.EnableTenantDestinationRequest](../../models/operations/enabletenantdestinationrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.EnableTenantDestinationSecurity](../../models/operations/enabletenantdestinationsecurity.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.Destination](../../models/components/destination.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                     | \*/\*                        |
+
+## disable
+
+Disables a previously enabled destination.
+
+### Example Usage
+
+```typescript
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function run() {
+  const result = await outpost.destinations.disable({
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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 { destinationsDisable } from "@hookdeck/outpost-sdk/funcs/destinationsDisable.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 destinationsDisable(outpost, {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  }, {
+    tenantId: "<id>",
+    destinationId: "<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.DisableTenantDestinationRequest](../../models/operations/disabletenantdestinationrequest.md)                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.DisableTenantDestinationSecurity](../../models/operations/disabletenantdestinationsecurity.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.Destination](../../models/components/destination.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                     | \*/\*                        |