@hookdeck/outpost-sdk 0.2.0 → 0.4.0

package/docs/sdks/tenants/README.md

@@ -22,21 +22,20 @@ Idempotently creates or updates a tenant. Required before associating destinatio
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="upsertTenant" method="put" path="/{tenant_id}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.tenants.upsert({
-    tenantId: "<id>",
-  });
+  const result = await outpost.tenants.upsert({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -54,24 +53,20 @@ import { tenantsUpsert } from "@hookdeck/outpost-sdk/funcs/tenantsUpsert.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await tenantsUpsert(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await tenantsUpsert(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tenantsUpsert failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -112,21 +107,20 @@ Retrieves details for a specific tenant.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenant" method="get" path="/{tenant_id}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.tenants.get({
-    tenantId: "<id>",
-  });
+  const result = await outpost.tenants.get({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -144,24 +138,20 @@ import { tenantsGet } from "@hookdeck/outpost-sdk/funcs/tenantsGet.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await tenantsGet(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await tenantsGet(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tenantsGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -201,21 +191,20 @@ Deletes the tenant and all associated destinations.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="deleteTenant" method="delete" path="/{tenant_id}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.tenants.delete({
-    tenantId: "<id>",
-  });
+  const result = await outpost.tenants.delete({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -233,24 +222,20 @@ import { tenantsDelete } from "@hookdeck/outpost-sdk/funcs/tenantsDelete.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await tenantsDelete(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await tenantsDelete(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tenantsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -290,21 +275,20 @@ Returns a redirect URL containing a JWT to authenticate the user with the portal
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenantPortalUrl" method="get" path="/{tenant_id}/portal" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.tenants.getPortalUrl({
-    tenantId: "<id>",
-  });
+  const result = await outpost.tenants.getPortalUrl({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -322,24 +306,20 @@ import { tenantsGetPortalUrl } from "@hookdeck/outpost-sdk/funcs/tenantsGetPorta
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await tenantsGetPortalUrl(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await tenantsGetPortalUrl(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tenantsGetPortalUrl failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -379,21 +359,20 @@ Returns a JWT token scoped to the tenant for safe browser API calls.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenantToken" method="get" path="/{tenant_id}/token" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.tenants.getToken({
-    tenantId: "<id>",
-  });
+  const result = await outpost.tenants.getToken({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -411,24 +390,20 @@ import { tenantsGetToken } from "@hookdeck/outpost-sdk/funcs/tenantsGetToken.js"
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await tenantsGetToken(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await tenantsGetToken(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("tenantsGetToken failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/topics/README.md

@@ -16,21 +16,20 @@ Returns a list of available event topics configured in the Outpost instance. Req
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTenantTopics" method="get" path="/{tenant_id}/topics" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.topics.list({
-    tenantId: "<id>",
-  });
+  const result = await outpost.topics.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -48,24 +47,20 @@ import { topicsList } from "@hookdeck/outpost-sdk/funcs/topicsList.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await topicsList(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await topicsList(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,6 +100,7 @@ Returns a list of available event topics configured in the Outpost instance.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTopics" method="get" path="/topics" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
@@ -117,7 +113,6 @@ const outpost = new Outpost({
 async function run() {
   const result = await outpost.topics.listJwt();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -142,15 +137,12 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await topicsListJwt(outpost);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("topicsListJwt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/examples/README.md

@@ -0,0 +1,31 @@
+# @hookdeck/outpost-sdk Examples
+
+This directory contains example scripts demonstrating how to use the @hookdeck/outpost-sdk SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/healthCheck.example.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @hookdeck/outpost-sdk SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx healthCheck.example.ts
+ */
+
+import { Outpost } from "@hookdeck/outpost-sdk";
+
+const outpost = new Outpost();
+
+async function main() {
+  const result = await outpost.check();
+
+  console.log(result);
+}
+
+main().catch(console.error);