@hookdeck/outpost-sdk 0.2.0 → 0.3.0

package/docs/sdks/events/README.md

@@ -20,21 +20,20 @@ Retrieves a list of events for the tenant, supporting cursor navigation (details
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTenantEvents" method="get" path="/{tenant_id}/events" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const result = await outpost.events.list({
-    tenantId: "<id>",
-  });
+  const result = await outpost.events.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -52,24 +51,20 @@ import { eventsList } from "@hookdeck/outpost-sdk/funcs/eventsList.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
 });
 
 async function run() {
-  const res = await eventsList(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await eventsList(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -109,10 +104,12 @@ Retrieves details for a specific event.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenantEvent" method="get" path="/{tenant_id}/events/{event_id}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -120,11 +117,9 @@ const outpost = new Outpost({
 
 async function run() {
   const result = await outpost.events.get({
-    tenantId: "<id>",
     eventId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -142,6 +137,7 @@ import { eventsGet } from "@hookdeck/outpost-sdk/funcs/eventsGet.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -149,18 +145,14 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await eventsGet(outpost, {
-    tenantId: "<id>",
     eventId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -200,10 +192,12 @@ Retrieves a list of delivery attempts for a specific event, including response d
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTenantEventDeliveries" method="get" path="/{tenant_id}/events/{event_id}/deliveries" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -211,11 +205,9 @@ const outpost = new Outpost({
 
 async function run() {
   const result = await outpost.events.listDeliveries({
-    tenantId: "<id>",
     eventId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -233,6 +225,7 @@ import { eventsListDeliveries } from "@hookdeck/outpost-sdk/funcs/eventsListDeli
 // 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>",
   },
@@ -240,18 +233,14 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await eventsListDeliveries(outpost, {
-    tenantId: "<id>",
     eventId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsListDeliveries failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -291,10 +280,12 @@ Retrieves events associated with a specific destination for the tenant.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTenantEventsByDestination" method="get" path="/{tenant_id}/destinations/{destination_id}/events" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -302,11 +293,9 @@ const outpost = new Outpost({
 
 async function run() {
   const result = await outpost.events.listByDestination({
-    tenantId: "<id>",
     destinationId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -324,6 +313,7 @@ import { eventsListByDestination } from "@hookdeck/outpost-sdk/funcs/eventsListB
 // 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>",
   },
@@ -331,18 +321,14 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await eventsListByDestination(outpost, {
-    tenantId: "<id>",
     destinationId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsListByDestination failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -382,10 +368,12 @@ Retrieves a specific event associated with a specific destination for the tenant
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenantEventByDestination" method="get" path="/{tenant_id}/destinations/{destination_id}/events/{event_id}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -393,12 +381,10 @@ const outpost = new Outpost({
 
 async function run() {
   const result = await outpost.events.getByDestination({
-    tenantId: "<id>",
     destinationId: "<id>",
     eventId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -416,6 +402,7 @@ import { eventsGetByDestination } from "@hookdeck/outpost-sdk/funcs/eventsGetByD
 // 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>",
   },
@@ -423,19 +410,15 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await eventsGetByDestination(outpost, {
-    tenantId: "<id>",
     destinationId: "<id>",
     eventId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsGetByDestination failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -475,10 +458,12 @@ Triggers a retry for a failed event delivery.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="retryTenantEvent" method="post" path="/{tenant_id}/destinations/{destination_id}/events/{event_id}/retry" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -486,7 +471,6 @@ const outpost = new Outpost({
 
 async function run() {
   await outpost.events.retry({
-    tenantId: "<id>",
     destinationId: "<id>",
     eventId: "<id>",
   });
@@ -508,6 +492,7 @@ import { eventsRetry } from "@hookdeck/outpost-sdk/funcs/eventsRetry.js";
 // Use `OutpostCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const outpost = new OutpostCore({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -515,18 +500,15 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await eventsRetry(outpost, {
-    tenantId: "<id>",
     destinationId: "<id>",
     eventId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    
+  } else {
+    console.log("eventsRetry failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();

package/docs/sdks/health/README.md

@@ -15,6 +15,7 @@ Simple health check endpoint.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="healthCheck" method="get" path="/healthz" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
@@ -23,7 +24,6 @@ const outpost = new Outpost();
 async function run() {
   const result = await outpost.health.check();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -44,15 +44,12 @@ const outpost = new OutpostCore();
 
 async function run() {
   const res = await healthCheck(outpost);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("healthCheck failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/publish/README.md

@@ -15,6 +15,7 @@ Publishes an event to the specified topic, potentially routed to a specific dest
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="publishEvent" method="post" path="/publish" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
@@ -25,7 +26,7 @@ const outpost = new Outpost({
 });
 
 async function run() {
-  await outpost.publish.event({
+  const result = await outpost.publish.event({
     id: "evt_custom_123",
     tenantId: "<TENANT_ID>",
     destinationId: "<DESTINATION_ID>",
@@ -39,7 +40,7 @@ async function run() {
     },
   });
 
-
+  console.log(result);
 }
 
 run();
@@ -75,14 +76,12 @@ async function run() {
       "status": "active",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("publishEvent failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  
 }
 
 run();
@@ -99,7 +98,7 @@ run();
 
 ### Response
 
-**Promise\<void\>**
+**Promise\<[components.PublishResponse](../../models/components/publishresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/schemas/README.md

@@ -18,21 +18,20 @@ Returns a list of JSON-based input schemas for each available destination type.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listTenantDestinationTypeSchemas" method="get" path="/{tenant_id}/destination-types" -->
 ```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.schemas.listTenantDestinationTypes({
-    tenantId: "<id>",
-  });
+  const result = await outpost.schemas.listTenantDestinationTypes({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,24 +49,20 @@ import { schemasListTenantDestinationTypes } from "@hookdeck/outpost-sdk/funcs/s
 // 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 schemasListTenantDestinationTypes(outpost, {
-    tenantId: "<id>",
-  });
-
-  if (!res.ok) {
-    throw res.error;
+  const res = await schemasListTenantDestinationTypes(outpost, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("schemasListTenantDestinationTypes failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -107,10 +102,12 @@ Returns the input schema for a specific destination type. Requires Admin API Key
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getTenantDestinationTypeSchema" method="get" path="/{tenant_id}/destination-types/{type}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
 const outpost = new Outpost({
+  tenantId: "<id>",
   security: {
     adminApiKey: "<YOUR_BEARER_TOKEN_HERE>",
   },
@@ -118,11 +115,9 @@ const outpost = new Outpost({
 
 async function run() {
   const result = await outpost.schemas.get({
-    tenantId: "<id>",
     type: "hookdeck",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -140,6 +135,7 @@ import { schemasGet } from "@hookdeck/outpost-sdk/funcs/schemasGet.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>",
   },
@@ -147,18 +143,14 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await schemasGet(outpost, {
-    tenantId: "<id>",
     type: "hookdeck",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("schemasGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -198,6 +190,7 @@ Returns a list of JSON-based input schemas for each available destination type (
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="listDestinationTypeSchemasJwt" method="get" path="/destination-types" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
@@ -210,7 +203,6 @@ const outpost = new Outpost({
 async function run() {
   const result = await outpost.schemas.listDestinationTypesJwt();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -235,15 +227,12 @@ const outpost = new OutpostCore({
 
 async function run() {
   const res = await schemasListDestinationTypesJwt(outpost);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("schemasListDestinationTypesJwt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -283,6 +272,7 @@ Returns the input schema for a specific destination type.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="getDestinationTypeSchema" method="get" path="/destination-types/{type}" -->
 ```typescript
 import { Outpost } from "@hookdeck/outpost-sdk";
 
@@ -297,7 +287,6 @@ async function run() {
     type: "rabbitmq",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -324,15 +313,12 @@ async function run() {
   const res = await schemasGetDestinationTypeJwt(outpost, {
     type: "rabbitmq",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("schemasGetDestinationTypeJwt failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();