Merge pull request #451 from hookdeck/speakeasy-sdk-regen-1753976932

chore: 🐝 Update SDK - Generate OUTPOST-TS 0.3.0

Author: leggetter

.speakeasy/workflow.lock

@@ -1,12 +1,12 @@
-speakeasyVersion: 1.548.1
+speakeasyVersion: 1.593.0
 sources:
     Outpost API:
         sourceNamespace: outpost-api
-        sourceRevisionDigest: sha256:4a84fa1ff3b6f870f874a2c74b7063f118be48b326e3abbc3f6d6eabe51544c5
-        sourceBlobDigest: sha256:fde67bc4e44b8d6fa7ba8d93abbb46a32779842540a9635674d2ae2522d82d68
+        sourceRevisionDigest: sha256:837897b6e2774d7ba547d9616639367bfce651d53d84190c3ee0cd32cee7e8b1
+        sourceBlobDigest: sha256:3b1cd63370e0cf368a2049eaa26c9f94cd94a929de42592f8488adb5a6a3f182
         tags:
             - latest
-            - speakeasy-sdk-regen-1747702600
+            - speakeasy-sdk-regen-1753976932
             - 0.0.1
 targets:
     outpost-go:
@@ -26,10 +26,10 @@ targets:
     outpost-ts:
         source: Outpost API
         sourceNamespace: outpost-api
-        sourceRevisionDigest: sha256:6e2b5a5c7fd7a97711c7521cb88ce3d76affdff2a1c36721316ecee8a6521954
-        sourceBlobDigest: sha256:6b2da637ba05af9973197a916e59dedc050a6ea79d39d6be15166bf3ee049bed
+        sourceRevisionDigest: sha256:837897b6e2774d7ba547d9616639367bfce651d53d84190c3ee0cd32cee7e8b1
+        sourceBlobDigest: sha256:3b1cd63370e0cf368a2049eaa26c9f94cd94a929de42592f8488adb5a6a3f182
         codeSamplesNamespace: outpost-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:9442b593b18cdda5586e8bc29d6f4cb6f4e88799814d4ed80361be405ee81bc1
+        codeSamplesRevisionDigest: sha256:73273078c2416ff9b541f2cc8e95cf2a8254fc9ae40d2788122ca4f3e7e74416
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

sdks/outpost-typescript/.gitignore

@@ -1,3 +1,7 @@
+/examples/node_modules
+.env
+.env.local
+.env.*.local
 /models
 /models/errors
 /types

sdks/outpost-typescript/.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: edb58086-83b9-45a3-9095-52bf57a11009
 management:
-  docChecksum: 9d08f718ce55c534f292ba05af3425db
+  docChecksum: 3d3f028a2fdd56804d9ae8a2d95a414b
   docVersion: 0.0.1
-  speakeasyVersion: 1.548.1
-  generationVersion: 2.605.0
-  releaseVersion: 0.2.0
-  configChecksum: 532da1aa2b75a3a3630b0cfd89f7a064
+  speakeasyVersion: 1.593.0
+  generationVersion: 2.669.0
+  releaseVersion: 0.3.0
+  configChecksum: f5c74e03d72ead5a348c5b677ad4b9cc
   repoURL: https://github.com/hookdeck/outpost.git
   repoSubDirectory: sdks/outpost-typescript
   installationURL: https://gitpkg.now.sh/hookdeck/outpost/sdks/outpost-typescript
@@ -15,21 +15,21 @@ features:
   typescript:
     additionalDependencies: 0.1.0
     additionalProperties: 0.1.1
-    core: 3.21.8
+    core: 3.21.17
     defaultEnabledRetries: 0.1.0
     enumUnions: 0.1.0
     envVarSecurityUsage: 0.1.2
     globalSecurity: 2.82.13
     globalSecurityCallbacks: 0.1.0
     globalServerURLs: 2.82.5
     globals: 2.82.2
-    mcpServer: 0.9.2
+    mcpServer: 0.9.3
     nameOverrides: 2.81.2
     nullables: 0.1.1
     responseFormat: 0.2.3
     retries: 2.83.0
-    sdkHooks: 0.2.0
-    unions: 2.85.8
+    sdkHooks: 0.3.0
+    unions: 2.85.11
 generatedFiles:
   - .gitattributes
   - .npmignore
@@ -41,17 +41,23 @@ generatedFiles:
   - docs/models/components/awskinesiscredentials.md
   - docs/models/components/awssqsconfig.md
   - docs/models/components/awssqscredentials.md
+  - docs/models/components/azureservicebusconfig.md
+  - docs/models/components/azureservicebuscredentials.md
   - docs/models/components/deliveryattempt.md
   - docs/models/components/destination.md
   - docs/models/components/destinationawskinesis.md
   - docs/models/components/destinationawskinesistype.md
   - docs/models/components/destinationawssqs.md
   - docs/models/components/destinationawssqstype.md
+  - docs/models/components/destinationazureservicebus.md
+  - docs/models/components/destinationazureservicebustype.md
   - docs/models/components/destinationcreate.md
   - docs/models/components/destinationcreateawskinesis.md
   - docs/models/components/destinationcreateawskinesistype.md
   - docs/models/components/destinationcreateawssqs.md
   - docs/models/components/destinationcreateawssqstype.md
+  - docs/models/components/destinationcreateazureservicebus.md
+  - docs/models/components/destinationcreateazureservicebustype.md
   - docs/models/components/destinationcreatehookdeck.md
   - docs/models/components/destinationcreatehookdecktype.md
   - docs/models/components/destinationcreaterabbitmq.md
@@ -77,6 +83,7 @@ generatedFiles:
   - docs/models/components/hookdeckcredentials.md
   - docs/models/components/portalredirect.md
   - docs/models/components/publishrequest.md
+  - docs/models/components/publishresponse.md
   - docs/models/components/rabbitmqconfig.md
   - docs/models/components/rabbitmqcredentials.md
   - docs/models/components/security.md
@@ -159,6 +166,10 @@ generatedFiles:
   - docs/sdks/tenants/README.md
   - docs/sdks/topics/README.md
   - eslint.config.mjs
+  - examples/.env.template
+  - examples/README.md
+  - examples/healthCheck.example.ts
+  - examples/package.json
   - jsr.json
   - package.json
   - src/core.ts
@@ -250,13 +261,17 @@ generatedFiles:
   - src/models/components/awskinesiscredentials.ts
   - src/models/components/awssqsconfig.ts
   - src/models/components/awssqscredentials.ts
+  - src/models/components/azureservicebusconfig.ts
+  - src/models/components/azureservicebuscredentials.ts
   - src/models/components/deliveryattempt.ts
   - src/models/components/destination.ts
   - src/models/components/destinationawskinesis.ts
   - src/models/components/destinationawssqs.ts
+  - src/models/components/destinationazureservicebus.ts
   - src/models/components/destinationcreate.ts
   - src/models/components/destinationcreateawskinesis.ts
   - src/models/components/destinationcreateawssqs.ts
+  - src/models/components/destinationcreateazureservicebus.ts
   - src/models/components/destinationcreatehookdeck.ts
   - src/models/components/destinationcreaterabbitmq.ts
   - src/models/components/destinationcreatewebhook.ts
@@ -276,6 +291,7 @@ generatedFiles:
   - src/models/components/index.ts
   - src/models/components/portalredirect.ts
   - src/models/components/publishrequest.ts
+  - src/models/components/publishresponse.ts
   - src/models/components/rabbitmqconfig.ts
   - src/models/components/rabbitmqcredentials.ts
   - src/models/components/security.ts
@@ -292,7 +308,9 @@ generatedFiles:
   - src/models/errors/index.ts
   - src/models/errors/internalservererror.ts
   - src/models/errors/notfounderror.ts
+  - src/models/errors/outposterror.ts
   - src/models/errors/ratelimitederror.ts
+  - src/models/errors/responsevalidationerror.ts
   - src/models/errors/sdkvalidationerror.ts
   - src/models/errors/timeouterror.ts
   - src/models/errors/unauthorizederror.ts
@@ -443,7 +461,7 @@ examples:
         application/json: {"topics": "*", "config": {"server_url": "localhost:5672", "exchange": "my-exchange", "tls": "false"}, "credentials": {"username": "guest", "password": "guest"}}
       responses:
         "200":
-          application/json: {"id": "des_kns_xyz", "type": "aws_kinesis", "topics": ["user.created", "user.updated"], "disabled_at": null, "created_at": "2024-03-10T15:30:00Z", "config": {"stream_name": "production-events", "region": "eu-west-1"}, "credentials": {"key": "AKIAIOSFODNN7EXAMPLE", "secret": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"}}
+          application/json: {"id": "des_webhook_123", "type": "webhook", "topics": ["user.created"], "disabled_at": null, "created_at": "2024-02-15T10:00:00Z", "config": {"url": "https://my-service.com/webhook/new-handler"}, "credentials": {"secret": "whsec_abc123def456", "previous_secret": "whsec_prev789xyz012", "previous_secret_invalid_at": "2024-02-16T10:00:00Z"}}
   deleteTenantDestination:
     SuccessExample:
       parameters:
@@ -496,6 +514,8 @@ examples:
           application/json: {}
         "511":
           application/json: {}
+        "202":
+          application/json: {"id": "evt_abc123xyz789"}
   listTenantDestinationTypeSchemas:
     DestinationTypesExample:
       parameters:

sdks/outpost-typescript/.speakeasy/gen.yaml

@@ -4,6 +4,7 @@ generation:
   maintainOpenAPIOrder: true
   usageSnippets:
     optionalPropertyRendering: withExample
+    sdkInitStyle: constructor
   useClassNamesForArrayFields: true
   fixes:
     nameResolutionDec2023: true
@@ -15,22 +16,29 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
+  tests:
+    generateTests: true
+    generateNewTests: false
+    skipResponseBodyAssertions: false
 typescript:
-  version: 0.2.0
+  version: 0.3.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
     peerDependencies: {}
   additionalPackageJSON: {}
   author: Speakeasy
+  baseErrorName: OutpostError
   clientServerStatusCodesAsErrors: true
+  constFieldsAlwaysOptional: true
   defaultErrorName: APIError
   enableCustomCodeRegions: false
   enableMCPServer: true
   enableReactQuery: false
   enumFormat: union
   flattenGlobalSecurity: true
   flatteningOrder: parameters-first
+  generateExamples: true
   imports:
     option: openapi
     paths:

sdks/outpost-typescript/FUNCTIONS.md

@@ -21,36 +21,19 @@ specific category of applications.
 ```typescript
 import { OutpostCore } from "@hookdeck/outpost-sdk/core.js";
 import { healthCheck } from "@hookdeck/outpost-sdk/funcs/healthCheck.js";
-import { SDKValidationError } from "@hookdeck/outpost-sdk/models/errors/sdkvalidationerror.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 healthCheck(outpost);
-
-  switch (true) {
-    case res.ok:
-      // The success case will be handled outside of the switch block
-      break;
-    case res.error instanceof SDKValidationError:
-      // Pretty-print validation errors.
-      return console.log(res.error.pretty());
-    case res.error instanceof Error:
-      return console.log(res.error);
-    default:
-      // TypeScript's type checking will fail on the following line if the above
-      // cases were not exhaustive.
-      res.error satisfies never;
-      throw new Error("Assertion failed: expected error checks to be exhaustive: " + 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();