@hookdeck/outpost-sdk 0.0.2 → 0.1.1

package/README.md

@@ -9,11 +9,6 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage t
     </a>
 </div>
 
-
-<br /><br />
-> [!IMPORTANT]
-> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/speakeasy-onboarding/onboarding). Delete this section before > publishing to a package manager.
-
 <!-- Start Summary [summary] -->
 ## Summary
 
@@ -100,6 +95,7 @@ Add the following server definition to your `claude_desktop_config.json` file:
         "--",
         "mcp", "start",
         "--admin-api-key", "...",
+        "--tenant-jwt", "...",
         "--tenant-id", "..."
       ]
     }
@@ -124,6 +120,7 @@ Create a `.cursor/mcp.json` file in your project root with the following content
         "--",
         "mcp", "start",
         "--admin-api-key", "...",
+        "--tenant-jwt", "...",
         "--tenant-id", "..."
       ]
     }
@@ -197,18 +194,21 @@ run();
 
 ### Per-Client Security Schemes
 
-This SDK supports the following security scheme globally:
+This SDK supports the following security schemes globally:
 
 | Name          | Type | Scheme      |
 | ------------- | ---- | ----------- |
 | `adminApiKey` | http | HTTP Bearer |
+| `tenantJwt`   | http | HTTP Bearer |
 
-To authenticate with the API the `adminApiKey` parameter must be set when initializing the SDK client instance. For example:
+You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
-  adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
 });
 
 async function run() {
@@ -220,27 +220,6 @@ async function run() {
 
 run();
 
-```
-
-### Per-Operation Security Schemes
-
-Some operations in this SDK require the security scheme to be specified at the request level. For example:
-```typescript
-import { Outpost } from "@hookdeck/outpost-sdk";
-
-const outpost = new Outpost();
-
-async function run() {
-  const result = await outpost.tenants.get({}, {
-    tenantId: "<id>",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-
 ```
 <!-- End Authentication [security] -->
 
@@ -283,7 +262,7 @@ run();
 * [listTenantDestinationTypes](docs/sdks/schemas/README.md#listtenantdestinationtypes) - List Destination Type Schemas (for Tenant)
 * [get](docs/sdks/schemas/README.md#get) - Get Destination Type Schema (for Tenant)
 * [listDestinationTypesJwt](docs/sdks/schemas/README.md#listdestinationtypesjwt) - List Destination Type Schemas (JWT Auth)
-* [getDestinationTypeJwt](docs/sdks/schemas/README.md#getdestinationtypejwt) - Get Destination Type Schema (JWT Auth)
+* [getDestinationTypeJwt](docs/sdks/schemas/README.md#getdestinationtypejwt) - Get Destination Type Schema
 
 ### [tenants](docs/sdks/tenants/README.md)
 
@@ -292,13 +271,11 @@ run();
 * [delete](docs/sdks/tenants/README.md#delete) - Delete Tenant
 * [getPortalUrl](docs/sdks/tenants/README.md#getportalurl) - Get Portal Redirect URL
 * [getToken](docs/sdks/tenants/README.md#gettoken) - Get Tenant JWT Token
-* [getPortalUrlJwtContext](docs/sdks/tenants/README.md#getportalurljwtcontext) - Get Portal Redirect URL (JWT Auth Context)
-* [getTokenJwtContext](docs/sdks/tenants/README.md#gettokenjwtcontext) - Get Tenant JWT Token (JWT Auth Context)
 
 ### [topics](docs/sdks/topics/README.md)
 
 * [list](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
-* [listJwt](docs/sdks/topics/README.md#listjwt) - List Available Topics (JWT Auth)
+* [listJwt](docs/sdks/topics/README.md#listjwt) - List Available Topics)
 
 </details>
 <!-- End Available Resources and Operations [operations] -->
@@ -334,18 +311,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`healthCheck`](docs/sdks/health/README.md#check) - Health Check
 - [`publishEvent`](docs/sdks/publish/README.md#event) - Publish Event
 - [`schemasGet`](docs/sdks/schemas/README.md#get) - Get Destination Type Schema (for Tenant)
-- [`schemasGetDestinationTypeJwt`](docs/sdks/schemas/README.md#getdestinationtypejwt) - Get Destination Type Schema (JWT Auth)
+- [`schemasGetDestinationTypeJwt`](docs/sdks/schemas/README.md#getdestinationtypejwt) - Get Destination Type Schema
 - [`schemasListDestinationTypesJwt`](docs/sdks/schemas/README.md#listdestinationtypesjwt) - List Destination Type Schemas (JWT Auth)
 - [`schemasListTenantDestinationTypes`](docs/sdks/schemas/README.md#listtenantdestinationtypes) - List Destination Type Schemas (for Tenant)
 - [`tenantsDelete`](docs/sdks/tenants/README.md#delete) - Delete Tenant
 - [`tenantsGet`](docs/sdks/tenants/README.md#get) - Get Tenant
 - [`tenantsGetPortalUrl`](docs/sdks/tenants/README.md#getportalurl) - Get Portal Redirect URL
-- [`tenantsGetPortalUrlJwtContext`](docs/sdks/tenants/README.md#getportalurljwtcontext) - Get Portal Redirect URL (JWT Auth Context)
 - [`tenantsGetToken`](docs/sdks/tenants/README.md#gettoken) - Get Tenant JWT Token
-- [`tenantsGetTokenJwtContext`](docs/sdks/tenants/README.md#gettokenjwtcontext) - Get Tenant JWT Token (JWT Auth Context)
 - [`tenantsUpsert`](docs/sdks/tenants/README.md#upsert) - Create or Update Tenant
 - [`topicsList`](docs/sdks/topics/README.md#list) - List Available Topics (for Tenant)
-- [`topicsListJwt`](docs/sdks/topics/README.md#listjwt) - List Available Topics (JWT Auth)
+- [`topicsListJwt`](docs/sdks/topics/README.md#listjwt) - List Available Topics)
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -372,7 +347,9 @@ The following global parameter is available.
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
-  adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  security: {
+    adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
+  },
 });
 
 async function run() {