@hookdeck/outpost-sdk 0.0.2 → 0.1.1

package/docs/sdks/destinations/README.md

@@ -47,12 +47,14 @@ Return a list of the destinations for the tenant. The endpoint is not paged.
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.list({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
   });
 
@@ -73,12 +75,14 @@ import { destinationsList } from "@hookdeck/outpost-sdk/funcs/destinationsList.j
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsList(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
   });
 
@@ -100,7 +104,6 @@ run();
 | 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.                                                                                                               |
@@ -133,25 +136,27 @@ Creates a new destination for the tenant. The request body structure depends on
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.create({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationCreate: {
       id: "user-provided-id",
-      type: "aws_sqs",
+      type: "rabbitmq",
       topics: "*",
       config: {
-        endpoint: "https://sqs.us-east-1.amazonaws.com",
-        queueUrl: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
+        serverUrl: "localhost:5672",
+        exchange: "my-exchange",
+        tls: "false",
       },
       credentials: {
-        key: "AKIAIOSFODNN7EXAMPLE",
-        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
-        session: "AQoDYXdzEPT//////////wEXAMPLE...",
+        username: "guest",
+        password: "guest",
       },
     },
   });
@@ -173,25 +178,27 @@ import { destinationsCreate } from "@hookdeck/outpost-sdk/funcs/destinationsCrea
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsCreate(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationCreate: {
       id: "user-provided-id",
-      type: "aws_sqs",
+      type: "rabbitmq",
       topics: "*",
       config: {
-        endpoint: "https://sqs.us-east-1.amazonaws.com",
-        queueUrl: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue",
+        serverUrl: "localhost:5672",
+        exchange: "my-exchange",
+        tls: "false",
       },
       credentials: {
-        key: "AKIAIOSFODNN7EXAMPLE",
-        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
-        session: "AQoDYXdzEPT//////////wEXAMPLE...",
+        username: "guest",
+        password: "guest",
       },
     },
   });
@@ -214,7 +221,6 @@ run();
 | 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.                                                                                                               |
@@ -247,12 +253,14 @@ Retrieves details for a specific destination.
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.get({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -274,12 +282,14 @@ 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();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsGet(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -302,7 +312,6 @@ run();
 | 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.                                                                                                               |
@@ -335,24 +344,28 @@ Updates the configuration of an existing destination. The request body structure
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 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",
+        streamName: "my-data-stream",
+        region: "us-east-1",
+        endpoint: "https://kinesis.us-east-1.amazonaws.com",
+        partitionKeyTemplate: "data.\"user_id\"",
       },
       credentials: {
-        username: "guest",
-        password: "guest",
+        key: "AKIAIOSFODNN7EXAMPLE",
+        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        session: "AQoDYXdzEPT//////////wEXAMPLE...",
       },
     },
   });
@@ -374,24 +387,28 @@ import { destinationsUpdate } from "@hookdeck/outpost-sdk/funcs/destinationsUpda
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 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",
+        streamName: "my-data-stream",
+        region: "us-east-1",
+        endpoint: "https://kinesis.us-east-1.amazonaws.com",
+        partitionKeyTemplate: "data.\"user_id\"",
       },
       credentials: {
-        username: "guest",
-        password: "guest",
+        key: "AKIAIOSFODNN7EXAMPLE",
+        secret: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        session: "AQoDYXdzEPT//////////wEXAMPLE...",
       },
     },
   });
@@ -414,7 +431,6 @@ run();
 | 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.                                                                                                               |
@@ -447,12 +463,14 @@ Deletes a specific destination.
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.delete({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -474,12 +492,14 @@ import { destinationsDelete } from "@hookdeck/outpost-sdk/funcs/destinationsDele
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsDelete(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -502,7 +522,6 @@ run();
 | 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.                                                                                                               |
@@ -535,12 +554,14 @@ Enables a previously disabled destination.
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.enable({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -562,12 +583,14 @@ import { destinationsEnable } from "@hookdeck/outpost-sdk/funcs/destinationsEnab
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsEnable(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -590,7 +613,6 @@ run();
 | 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.                                                                                                               |
@@ -623,12 +645,14 @@ Disables a previously enabled destination.
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
-const outpost = new Outpost();
+const outpost = new Outpost({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const result = await outpost.destinations.disable({
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -650,12 +674,14 @@ import { destinationsDisable } from "@hookdeck/outpost-sdk/funcs/destinationsDis
 
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const outpost = new OutpostCore();
+const outpost = new OutpostCore({
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
+});
 
 async function run() {
   const res = await destinationsDisable(outpost, {
-    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
-  }, {
     tenantId: "<id>",
     destinationId: "<id>",
   });
@@ -678,7 +704,6 @@ run();
 | 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.                                                                                                               |