Merge pull request #4 from unkeyed/speakeasy-sdk-regen-1743577103

chore: 🐝 Update SDK - Generate 2.0.0-alpha.2

Author: chronark

.speakeasy/gen.lock

@@ -3,12 +3,13 @@ id: 4ae464f3-5455-4bce-932c-85c7fc085db8
 management:
   docChecksum: d32c409ca16bfb64eed3c26906f2835b
   docVersion: 2.0.0
-  speakeasyVersion: 1.524.0
-  generationVersion: 2.562.2
-  releaseVersion: 2.0.0-alpha.1
-  configChecksum: ced7af67912943185c51d929991fe39c
+  speakeasyVersion: 1.527.1
+  generationVersion: 2.564.5
+  releaseVersion: 2.0.0-alpha.2
+  configChecksum: b1983b3119d551c7e7e77d9627b050ce
   repoURL: https://github.com/unkeyed/unkey-ts.git
   installationURL: https://github.com/unkeyed/unkey-ts
+  published: true
 features:
   typescript:
     additionalDependencies: 0.1.0
@@ -36,6 +37,7 @@ generatedFiles:
   - RUNTIMES.md
   - USAGE.md
   - docs/lib/utils/retryconfig.md
+  - docs/models/components/httpmetadata.md
   - docs/models/components/security.md
   - docs/models/components/v2livenessresponsebody.md
   - docs/models/components/v2ratelimitdeleteoverriderequestbody.md
@@ -48,11 +50,7 @@ generatedFiles:
   - docs/models/components/v2ratelimitsetoverrideresponsebody.md
   - docs/models/components/validationerror.md
   - docs/models/errors/badrequesterror.md
-  - docs/models/errors/forbiddenerror.md
-  - docs/models/errors/internalservererror.md
-  - docs/models/errors/notfounderror.md
-  - docs/models/errors/preconditionfailederror.md
-  - docs/models/errors/unauthorizederror.md
+  - docs/models/errors/baseerror.md
   - docs/models/operations/livenessresponse.md
   - docs/models/operations/ratelimitdeleteoverrideresponse.md
   - docs/models/operations/ratelimitgetoverrideresponse.md
@@ -90,6 +88,7 @@ generatedFiles:
   - src/lib/sdks.ts
   - src/lib/security.ts
   - src/lib/url.ts
+  - src/models/components/httpmetadata.ts
   - src/models/components/index.ts
   - src/models/components/security.ts
   - src/models/components/v2livenessresponsebody.ts
@@ -104,14 +103,10 @@ generatedFiles:
   - src/models/components/validationerror.ts
   - src/models/errors/apierror.ts
   - src/models/errors/badrequesterror.ts
-  - src/models/errors/forbiddenerror.ts
+  - src/models/errors/baseerror.ts
   - src/models/errors/httpclienterrors.ts
   - src/models/errors/index.ts
-  - src/models/errors/internalservererror.ts
-  - src/models/errors/notfounderror.ts
-  - src/models/errors/preconditionfailederror.ts
   - src/models/errors/sdkvalidationerror.ts
-  - src/models/errors/unauthorizederror.ts
   - src/models/operations/index.ts
   - src/models/operations/liveness.ts
   - src/models/operations/ratelimitdeleteoverride.ts

.speakeasy/gen.yaml

@@ -18,7 +18,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: true
 typescript:
-  version: 2.0.0-alpha.1
+  version: 2.0.0-alpha.2
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
@@ -49,7 +49,7 @@ typescript:
   methodArguments: require-security-and-request
   moduleFormat: dual
   outputModelSuffix: output
-  packageName: "@unkey/api"
+  packageName: '@unkey/api'
   responseFormat: envelope-http
   templateVersion: v2
   useIndexModules: true

.speakeasy/workflow.lock

@@ -1,21 +1,21 @@
-speakeasyVersion: 1.524.0
+speakeasyVersion: 1.527.1
 sources:
     Unkey API:
         sourceNamespace: unkey-api
-        sourceRevisionDigest: sha256:d1b6923d89a67cd40d106a5a673534fac7099ea32e1917d20ef4bffec86fd417
+        sourceRevisionDigest: sha256:18e88a99a35b022f4fa8aff9625054a11f3925fd921d1a440d84a25024fecc8e
         sourceBlobDigest: sha256:411d7a08cddea23554e812add92b683e49ce24e0ab269bd188bc98ffaf5763d9
         tags:
             - latest
-            - speakeasy-sdk-regen-1742602508
+            - speakeasy-sdk-regen-1743577103
             - 2.0.0
 targets:
     unkey:
         source: Unkey API
         sourceNamespace: unkey-api
-        sourceRevisionDigest: sha256:d1b6923d89a67cd40d106a5a673534fac7099ea32e1917d20ef4bffec86fd417
+        sourceRevisionDigest: sha256:18e88a99a35b022f4fa8aff9625054a11f3925fd921d1a440d84a25024fecc8e
         sourceBlobDigest: sha256:411d7a08cddea23554e812add92b683e49ce24e0ab269bd188bc98ffaf5763d9
         codeSamplesNamespace: unkey-api-typescript-code-samples
-        codeSamplesRevisionDigest: sha256:d79377e915643475184c0b9f720c57abcacd3801386ae55e1ed4634bda7ffde1
+        codeSamplesRevisionDigest: sha256:bd448cfc67388ab278f8ca23c08ee6b25f751ca633162a0d48c6a06851e30b57
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest
@@ -31,6 +31,9 @@ workflow:
         unkey:
             target: typescript
             source: Unkey API
+            publish:
+                npm:
+                    token: $npm_token
             codeSamples:
                 registry:
                     location: registry.speakeasyapi.dev/unkey/unkey/unkey-api-typescript-code-samples

README.md

@@ -44,34 +44,30 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage *
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
-> [!TIP]
-> To finish publishing your SDK to npm and others you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
-
-
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
 
 ### NPM
 
 ```bash
-npm add https://github.com/unkeyed/unkey-ts
+npm add @unkey/api
 ```
 
 ### PNPM
 
 ```bash
-pnpm add https://github.com/unkeyed/unkey-ts
+pnpm add @unkey/api
 ```
 
 ### Bun
 
 ```bash
-bun add https://github.com/unkeyed/unkey-ts
+bun add @unkey/api
 ```
 
 ### Yarn
 
 ```bash
-yarn add https://github.com/unkeyed/unkey-ts zod
+yarn add @unkey/api zod
 
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
@@ -277,26 +273,21 @@ run();
 
 Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `limit` method may throw the following errors:
 
-| Error Type                 | Status Code | Content Type             |
-| -------------------------- | ----------- | ------------------------ |
-| errors.BadRequestError     | 400         | application/problem+json |
-| errors.UnauthorizedError   | 401         | application/problem+json |
-| errors.ForbiddenError      | 403         | application/problem+json |
-| errors.NotFoundError       | 404         | application/problem+json |
-| errors.InternalServerError | 500         | application/problem+json |
-| errors.APIError            | 4XX, 5XX    | \*/\*                    |
+| Error Type             | Status Code   | Content Type             |
+| ---------------------- | ------------- | ------------------------ |
+| errors.BadRequestError | 400           | application/problem+json |
+| errors.BaseError       | 401, 403, 404 | application/problem+json |
+| errors.BaseError       | 500           | application/problem+json |
+| errors.APIError        | 4XX, 5XX      | \*/\*                    |
 
 If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
 
 ```typescript
 import { Unkey } from "@unkey/api";
 import {
   BadRequestError,
-  ForbiddenError,
-  InternalServerError,
-  NotFoundError,
+  BaseError,
   SDKValidationError,
-  UnauthorizedError,
 } from "@unkey/api/models/errors";
 
 const unkey = new Unkey({
@@ -330,23 +321,13 @@ async function run() {
         console.error(err);
         return;
       }
-      case (err instanceof UnauthorizedError): {
-        // Handle err.data$: UnauthorizedErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof ForbiddenError): {
-        // Handle err.data$: ForbiddenErrorData
-        console.error(err);
-        return;
-      }
-      case (err instanceof NotFoundError): {
-        // Handle err.data$: NotFoundErrorData
+      case (err instanceof BaseError): {
+        // Handle err.data$: BaseErrorData
         console.error(err);
         return;
       }
-      case (err instanceof InternalServerError): {
-        // Handle err.data$: InternalServerErrorData
+      case (err instanceof BaseError): {
+        // Handle err.data$: BaseErrorData
         console.error(err);
         return;
       }

RELEASES.md

@@ -14,4 +14,14 @@ Based on:
 - OpenAPI Doc  
 - Speakeasy CLI 1.524.0 (2.562.2) https://github.com/speakeasy-api/speakeasy
 ### Generated
-- [typescript v2.0.0-alpha.1] .
+- [typescript v2.0.0-alpha.1] .
+
+## 2025-04-02 06:58:07
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.527.1 (2.564.5) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v2.0.0-alpha.2] .
+### Releases
+- [NPM v2.0.0-alpha.2] https://www.npmjs.com/package/@unkey/api/v/2.0.0-alpha.2 - .

docs/models/components/httpmetadata.md

@@ -0,0 +1,21 @@
+# HTTPMetadata
+
+## Example Usage
+
+```typescript
+import { HTTPMetadata } from "@unkey/api/models/components";
+
+let value: HTTPMetadata = {
+  response: new Response("{\"message\": \"hello world\"}", {
+    headers: { "Content-Type": "application/json" },
+  }),
+  request: new Request("https://example.com"),
+};
+```
+
+## Fields
+
+| Field                                                                 | Type                                                                  | Required                                                              | Description                                                           |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| `response`                                                            | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark:                                                    | Raw HTTP response; suitable for custom response parsing               |
+| `request`                                                             | *Request*                                                             | :heavy_check_mark:                                                    | Raw HTTP request; suitable for debugging                              |

docs/models/components/v2ratelimitgetoverrideresponsebody.md

@@ -8,9 +8,9 @@ import { V2RatelimitGetOverrideResponseBody } from "@unkey/api/models/components
 let value: V2RatelimitGetOverrideResponseBody = {
   namespaceId: "<id>",
   overrideId: "<id>",
-  duration: 832620,
+  duration: 891773,
   identifier: "<value>",
-  limit: 778157,
+  limit: 963663,
 };
 ```
 

docs/models/components/v2ratelimitlimitrequestbody.md

@@ -7,9 +7,9 @@ import { V2RatelimitLimitRequestBody } from "@unkey/api/models/components";
 
 let value: V2RatelimitLimitRequestBody = {
   namespace: "sms.sign_up",
-  duration: 925597,
+  duration: 544883,
   identifier: "<value>",
-  limit: 71036,
+  limit: 423655,
 };
 ```
 

docs/models/components/v2ratelimitlimitresponsebody.md

@@ -6,9 +6,9 @@
 import { V2RatelimitLimitResponseBody } from "@unkey/api/models/components";
 
 let value: V2RatelimitLimitResponseBody = {
-  limit: 791725,
-  remaining: 528895,
-  reset: 568045,
+  limit: 548814,
+  remaining: 715190,
+  reset: 602763,
   success: false,
 };
 ```

docs/models/components/v2ratelimitsetoverriderequestbody.md

@@ -8,9 +8,9 @@ Sets a new or overwrites an existing override.
 import { V2RatelimitSetOverrideRequestBody } from "@unkey/api/models/components";
 
 let value: V2RatelimitSetOverrideRequestBody = {
-  duration: 87129,
+  duration: 645894,
   identifier: "<value>",
-  limit: 20218,
+  limit: 437587,
 };
 ```