Skip to content
This repository was archived by the owner on May 8, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.DS_Store
**/.speakeasy/temp/
**/.speakeasy/logs/
.DS_Store
/models
/models/errors
/types
Expand Down
46 changes: 36 additions & 10 deletions .speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
lockVersion: 2.0.0
id: 7d97a20d-0f3d-43c0-811c-95313a801624
management:
docChecksum: a03ebe085eb661cdbe01107d63729706
docChecksum: 8e78dcb4bad946f25bef0bce834f7d42
docVersion: 2.0.0
speakeasyVersion: 1.533.0
generationVersion: 2.578.0
releaseVersion: 2.0.0-alpha.7
configChecksum: 660d8bfb38a8014fbe93cfcaaf22c94c
speakeasyVersion: 1.542.3
generationVersion: 2.597.9
releaseVersion: 2.0.0-alpha.8
configChecksum: eea09d701468a471a467b1456fe16076
repoURL: https://github.com/unkeyed/unkey-ts.git
installationURL: https://github.com/unkeyed/unkey-ts
published: true
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.11
core: 3.21.6
core: 3.21.7
defaultEnabledRetries: 0.1.0
devContainers: 2.90.0
envVarSecurityUsage: 0.1.2
Expand All @@ -23,11 +23,12 @@ features:
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.4
mcpServer: 0.9.1
mcpServer: 0.9.2
nameOverrides: 2.81.2
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.2.0
unions: 2.85.8
generatedFiles:
- .devcontainer/README.md
- .devcontainer/devcontainer.json
Expand All @@ -44,19 +45,23 @@ generatedFiles:
- docs/models/components/identitiescreateidentityresponsedata.md
- docs/models/components/livenessresponsedata.md
- docs/models/components/meta.md
- docs/models/components/one.md
- docs/models/components/pagination.md
- docs/models/components/ratelimit.md
- docs/models/components/ratelimitdeleteoverrideresponsedata.md
- docs/models/components/ratelimitlimitresponsedata.md
- docs/models/components/ratelimitoverride.md
- docs/models/components/ratelimitsetoverrideresponsedata.md
- docs/models/components/security.md
- docs/models/components/two.md
- docs/models/components/v2apiscreateapirequestbody.md
- docs/models/components/v2apiscreateapiresponsebody.md
- docs/models/components/v2identitiescreateidentityrequestbody.md
- docs/models/components/v2identitiescreateidentityrequestbodymeta.md
- docs/models/components/v2identitiescreateidentityresponsebody.md
- docs/models/components/v2identitiesdeleteidentityrequestbody.md
- docs/models/components/v2identitiesdeleteidentityresponsebody.md
- docs/models/components/v2livenessresponsebody.md
- docs/models/components/v2ratelimit.md
- docs/models/components/v2ratelimitdeleteoverriderequestbody.md
- docs/models/components/v2ratelimitdeleteoverrideresponsebody.md
- docs/models/components/v2ratelimitgetoverriderequestbody.md
Expand Down Expand Up @@ -86,6 +91,7 @@ generatedFiles:
- src/core.ts
- src/funcs/apisCreateApi.ts
- src/funcs/identitiesCreateIdentity.ts
- src/funcs/identitiesDeleteIdentity.ts
- src/funcs/livenessLiveness.ts
- src/funcs/ratelimitDeleteOverride.ts
- src/funcs/ratelimitGetOverride.ts
Expand Down Expand Up @@ -127,6 +133,7 @@ generatedFiles:
- src/mcp-server/tools.ts
- src/mcp-server/tools/apisCreateApi.ts
- src/mcp-server/tools/identitiesCreateIdentity.ts
- src/mcp-server/tools/identitiesDeleteIdentity.ts
- src/mcp-server/tools/livenessLiveness.ts
- src/mcp-server/tools/ratelimitDeleteOverride.ts
- src/mcp-server/tools/ratelimitGetOverride.ts
Expand All @@ -141,6 +148,7 @@ generatedFiles:
- src/models/components/livenessresponsedata.ts
- src/models/components/meta.ts
- src/models/components/pagination.ts
- src/models/components/ratelimit.ts
- src/models/components/ratelimitdeleteoverrideresponsedata.ts
- src/models/components/ratelimitlimitresponsedata.ts
- src/models/components/ratelimitoverride.ts
Expand All @@ -150,8 +158,9 @@ generatedFiles:
- src/models/components/v2apiscreateapiresponsebody.ts
- src/models/components/v2identitiescreateidentityrequestbody.ts
- src/models/components/v2identitiescreateidentityresponsebody.ts
- src/models/components/v2identitiesdeleteidentityrequestbody.ts
- src/models/components/v2identitiesdeleteidentityresponsebody.ts
- src/models/components/v2livenessresponsebody.ts
- src/models/components/v2ratelimit.ts
- src/models/components/v2ratelimitdeleteoverriderequestbody.ts
- src/models/components/v2ratelimitdeleteoverrideresponsebody.ts
- src/models/components/v2ratelimitgetoverriderequestbody.ts
Expand Down Expand Up @@ -337,7 +346,7 @@ examples:
identities.createIdentity:
speakeasy-default-identities-create-identity:
requestBody:
application/json: {"externalId": "user_123"}
application/json: {"externalId": "user_123", "ratelimits": [{"name": "api", "limit": 944235, "duration": 703242}, {"name": "api", "limit": 17275, "duration": 470912}, {"name": "api", "limit": 919479, "duration": 557622}]}
responses:
"200":
application/json: {"meta": {"requestId": "req_123"}, "data": {"identityId": "<id>"}}
Expand All @@ -351,5 +360,22 @@ examples:
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
"500":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
v2.identities.deleteIdentity:
speakeasy-default-v2-identities-delete-identity:
requestBody:
application/json: {"externalId": "user_123", "identityId": "id_123"}
responses:
"200":
application/json: {}
"400":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example", "errors": [{"location": "<value>", "message": "<value>"}, {"location": "<value>", "message": "<value>"}, {"location": "<value>", "message": "<value>"}]}}
"401":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
"403":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
"404":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
"500":
application/problem+json: {"meta": {"requestId": "req_123"}, "error": {"detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 404, "title": "<value>", "type": "https://example.com/errors/example"}}
examplesVersion: 1.0.1
generatedTests: {}
3 changes: 2 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ generation:
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
securityFeb2025: true
sharedErrorComponentsApr2025: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
typescript:
version: 2.0.0-alpha.7
version: 2.0.0-alpha.8
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.533.0
speakeasyVersion: 1.542.3
sources:
Unkey API:
sourceNamespace: unkey-api
sourceRevisionDigest: sha256:98828cc4229a2093978021ba166190f9c2a0591957cbe712cf1137310f32a913
sourceBlobDigest: sha256:ca8d6455b76ea23e06ccd91a210ebddeb8898a549c91a83916f8cfa612701594
sourceRevisionDigest: sha256:2d798e12bb9d98ecad4a686e59ea27861a880f4a014ffdc06a9a9223275d8dfa
sourceBlobDigest: sha256:85b3645ceff5010fc000082dc687048500d03c1978454341fe6b2ab3a63aa75b
tags:
- latest
- speakeasy-sdk-regen-1744793823
- speakeasy-sdk-regen-1745453731
- 2.0.0
targets:
unkey:
source: Unkey API
sourceNamespace: unkey-api
sourceRevisionDigest: sha256:98828cc4229a2093978021ba166190f9c2a0591957cbe712cf1137310f32a913
sourceBlobDigest: sha256:ca8d6455b76ea23e06ccd91a210ebddeb8898a549c91a83916f8cfa612701594
sourceRevisionDigest: sha256:2d798e12bb9d98ecad4a686e59ea27861a880f4a014ffdc06a9a9223275d8dfa
sourceBlobDigest: sha256:85b3645ceff5010fc000082dc687048500d03c1978454341fe6b2ab3a63aa75b
codeSamplesNamespace: unkey-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:00507ef991e4c044e74c353dc79d30dced54e8d534c9f089bdd09f06f7632fa2
codeSamplesRevisionDigest: sha256:5831c2a91d3cfc455f5bd0561b286c6bf4153120a74e693fbd5f5ede1e56af7d
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,7 @@ run();
### [identities](docs/sdks/identities/README.md)

* [createIdentity](docs/sdks/identities/README.md#createidentity)
* [deleteIdentity](docs/sdks/identities/README.md#deleteidentity)

### [liveness](docs/sdks/liveness/README.md)

Expand Down Expand Up @@ -279,6 +280,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).

- [`apisCreateApi`](docs/sdks/apis/README.md#createapi)
- [`identitiesCreateIdentity`](docs/sdks/identities/README.md#createidentity)
- [`identitiesDeleteIdentity`](docs/sdks/identities/README.md#deleteidentity)
- [`livenessLiveness`](docs/sdks/liveness/README.md#liveness) - Liveness check
- [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride)
- [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride)
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,14 @@ Based on:
### Generated
- [typescript v2.0.0-alpha.7] .
### Releases
- [NPM v2.0.0-alpha.7] https://www.npmjs.com/package/@unkey/api/v/2.0.0-alpha.7 - .
- [NPM v2.0.0-alpha.7] https://www.npmjs.com/package/@unkey/api/v/2.0.0-alpha.7 - .

## 2025-05-08 00:16:03
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.542.3 (2.597.9) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v2.0.0-alpha.8] .
### Releases
- [NPM v2.0.0-alpha.8] https://www.npmjs.com/package/@unkey/api/v/2.0.0-alpha.8 - .
19 changes: 19 additions & 0 deletions docs/models/components/one.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# One

## Example Usage

```typescript
import { One } from "@unkey/api/models/components";

let value: One = {
externalId: "user_123",
identityId: "id_123",
};
```

## Fields

| Field | Type | Required | Description | Example |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `externalId` | *string* | :heavy_check_mark: | The id of this identity in your system.<br/><br/>This usually comes from your authentication provider and could be a userId, organisationId or even an email.<br/>It does not matter what you use, as long as it uniquely identifies something in your application.<br/> | user_123 |
| `identityId` | *string* | :heavy_minus_sign: | The Unkey Identity ID. | id_123 |
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# V2Ratelimit
# Ratelimit

## Example Usage

```typescript
import { V2Ratelimit } from "@unkey/api/models/components";
import { Ratelimit } from "@unkey/api/models/components";

let value: V2Ratelimit = {
name: "<value>",
limit: 590340,
duration: 928936,
let value: Ratelimit = {
name: "api",
limit: 55520,
duration: 628977,
};
```

## Fields

| Field | Type | Required | Description |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `name` | *string* | :heavy_check_mark: | The name of this limit. You will need to use this again when verifying a key. |
| `limit` | *number* | :heavy_check_mark: | How many requests may pass within a given window before requests are rejected. |
| `duration` | *number* | :heavy_check_mark: | The duration for each ratelimit window in milliseconds. |
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
| `name` | *string* | :heavy_check_mark: | The name of this limit. You will need to use this again when verifying a key. | api |
| `limit` | *number* | :heavy_check_mark: | How many requests may pass within a given window before requests are rejected. | |
| `duration` | *number* | :heavy_check_mark: | The duration for each ratelimit window in milliseconds. | |
Loading