@unkey/api 2.0.3 → 2.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -3
- package/bin/mcp-server.js +461 -157
- package/bin/mcp-server.js.map +31 -23
- package/dist/commonjs/funcs/identitiesListIdentities.js +3 -0
- package/dist/commonjs/funcs/identitiesListIdentities.js.map +1 -1
- package/dist/commonjs/funcs/keysRerollKey.d.ts +49 -0
- package/dist/commonjs/funcs/keysRerollKey.d.ts.map +1 -0
- package/dist/commonjs/funcs/keysRerollKey.js +159 -0
- package/dist/commonjs/funcs/keysRerollKey.js.map +1 -0
- package/dist/commonjs/funcs/permissionsListPermissions.d.ts +2 -1
- package/dist/commonjs/funcs/permissionsListPermissions.d.ts.map +1 -1
- package/dist/commonjs/funcs/permissionsListPermissions.js +2 -1
- package/dist/commonjs/funcs/permissionsListPermissions.js.map +1 -1
- package/dist/commonjs/funcs/permissionsListRoles.d.ts +2 -1
- package/dist/commonjs/funcs/permissionsListRoles.d.ts.map +1 -1
- package/dist/commonjs/funcs/permissionsListRoles.js +2 -1
- package/dist/commonjs/funcs/permissionsListRoles.js.map +1 -1
- package/dist/commonjs/funcs/ratelimitLimit.d.ts +2 -2
- package/dist/commonjs/funcs/ratelimitLimit.d.ts.map +1 -1
- package/dist/commonjs/funcs/ratelimitLimit.js +3 -3
- package/dist/commonjs/funcs/ratelimitLimit.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/lib/security.d.ts.map +1 -1
- package/dist/commonjs/lib/security.js.map +1 -1
- package/dist/commonjs/mcp-server/mcp-server.js +1 -1
- package/dist/commonjs/mcp-server/server.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/server.js +3 -1
- package/dist/commonjs/mcp-server/server.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/keysRerollKey.d.ts +8 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.d.ts.map +1 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.js +96 -0
- package/dist/commonjs/mcp-server/tools/keysRerollKey.js.map +1 -0
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.js +2 -1
- package/dist/commonjs/mcp-server/tools/permissionsListPermissions.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.d.ts.map +1 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.js +2 -1
- package/dist/commonjs/mcp-server/tools/permissionsListRoles.js.map +1 -1
- package/dist/commonjs/mcp-server/tools/ratelimitLimit.js +1 -1
- package/dist/commonjs/models/components/index.d.ts +5 -0
- package/dist/commonjs/models/components/index.d.ts.map +1 -1
- package/dist/commonjs/models/components/index.js +5 -0
- package/dist/commonjs/models/components/index.js.map +1 -1
- package/dist/commonjs/models/components/keycreditsrefill.d.ts +8 -8
- package/dist/commonjs/models/components/keycreditsrefill.d.ts.map +1 -1
- package/dist/commonjs/models/components/keycreditsrefill.js +13 -14
- package/dist/commonjs/models/components/keycreditsrefill.js.map +1 -1
- package/dist/commonjs/models/components/updatekeycreditsdata.d.ts +41 -0
- package/dist/commonjs/models/components/updatekeycreditsdata.d.ts.map +1 -0
- package/dist/commonjs/models/components/updatekeycreditsdata.js +72 -0
- package/dist/commonjs/models/components/updatekeycreditsdata.js.map +1 -0
- package/dist/commonjs/models/components/updatekeycreditsrefill.d.ts +81 -0
- package/dist/commonjs/models/components/updatekeycreditsrefill.d.ts.map +1 -0
- package/dist/commonjs/models/components/updatekeycreditsrefill.js +95 -0
- package/dist/commonjs/models/components/updatekeycreditsrefill.js.map +1 -0
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysaddpermissionsresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysaddrolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysremoverolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.d.ts +60 -0
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.d.ts.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.js +71 -0
- package/dist/commonjs/models/components/v2keysrerollkeyrequestbody.js.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.d.ts +36 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.d.ts.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.js +73 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsebody.js.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.d.ts +62 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.d.ts.map +1 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.js +71 -0
- package/dist/commonjs/models/components/v2keysrerollkeyresponsedata.js.map +1 -0
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keyssetpermissionsresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.d.ts +0 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keyssetrolesresponsebody.js.map +1 -1
- package/dist/commonjs/models/components/v2keysupdatekeyrequestbody.d.ts +3 -3
- package/dist/commonjs/models/components/v2keysupdatekeyrequestbody.d.ts.map +1 -1
- package/dist/commonjs/models/components/v2keysupdatekeyrequestbody.js +3 -3
- package/dist/commonjs/models/components/v2keysupdatekeyrequestbody.js.map +1 -1
- package/dist/commonjs/models/errors/goneerrorresponse.d.ts +72 -0
- package/dist/commonjs/models/errors/goneerrorresponse.d.ts.map +1 -0
- package/dist/commonjs/models/errors/goneerrorresponse.js +99 -0
- package/dist/commonjs/models/errors/goneerrorresponse.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +1 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/models/errors/index.js +1 -0
- package/dist/commonjs/models/errors/index.js.map +1 -1
- package/dist/commonjs/sdk/keys.d.ts +38 -0
- package/dist/commonjs/sdk/keys.d.ts.map +1 -1
- package/dist/commonjs/sdk/keys.js +41 -0
- package/dist/commonjs/sdk/keys.js.map +1 -1
- package/dist/commonjs/sdk/permissions.d.ts +4 -2
- package/dist/commonjs/sdk/permissions.d.ts.map +1 -1
- package/dist/commonjs/sdk/permissions.js +4 -2
- package/dist/commonjs/sdk/permissions.js.map +1 -1
- package/dist/commonjs/sdk/ratelimit.d.ts +1 -1
- package/dist/commonjs/sdk/ratelimit.js +1 -1
- package/dist/esm/funcs/identitiesListIdentities.js +3 -0
- package/dist/esm/funcs/identitiesListIdentities.js.map +1 -1
- package/dist/esm/funcs/keysRerollKey.d.ts +49 -0
- package/dist/esm/funcs/keysRerollKey.d.ts.map +1 -0
- package/dist/esm/funcs/keysRerollKey.js +123 -0
- package/dist/esm/funcs/keysRerollKey.js.map +1 -0
- package/dist/esm/funcs/permissionsListPermissions.d.ts +2 -1
- package/dist/esm/funcs/permissionsListPermissions.d.ts.map +1 -1
- package/dist/esm/funcs/permissionsListPermissions.js +2 -1
- package/dist/esm/funcs/permissionsListPermissions.js.map +1 -1
- package/dist/esm/funcs/permissionsListRoles.d.ts +2 -1
- package/dist/esm/funcs/permissionsListRoles.d.ts.map +1 -1
- package/dist/esm/funcs/permissionsListRoles.js +2 -1
- package/dist/esm/funcs/permissionsListRoles.js.map +1 -1
- package/dist/esm/funcs/ratelimitLimit.d.ts +2 -2
- package/dist/esm/funcs/ratelimitLimit.d.ts.map +1 -1
- package/dist/esm/funcs/ratelimitLimit.js +3 -3
- package/dist/esm/funcs/ratelimitLimit.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/lib/security.d.ts.map +1 -1
- package/dist/esm/lib/security.js.map +1 -1
- package/dist/esm/mcp-server/mcp-server.js +1 -1
- package/dist/esm/mcp-server/server.d.ts.map +1 -1
- package/dist/esm/mcp-server/server.js +3 -1
- package/dist/esm/mcp-server/server.js.map +1 -1
- package/dist/esm/mcp-server/tools/keysRerollKey.d.ts +8 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.d.ts.map +1 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.js +60 -0
- package/dist/esm/mcp-server/tools/keysRerollKey.js.map +1 -0
- package/dist/esm/mcp-server/tools/permissionsListPermissions.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListPermissions.js +2 -1
- package/dist/esm/mcp-server/tools/permissionsListPermissions.js.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.d.ts.map +1 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.js +2 -1
- package/dist/esm/mcp-server/tools/permissionsListRoles.js.map +1 -1
- package/dist/esm/mcp-server/tools/ratelimitLimit.js +1 -1
- package/dist/esm/models/components/index.d.ts +5 -0
- package/dist/esm/models/components/index.d.ts.map +1 -1
- package/dist/esm/models/components/index.js +5 -0
- package/dist/esm/models/components/index.js.map +1 -1
- package/dist/esm/models/components/keycreditsrefill.d.ts +8 -8
- package/dist/esm/models/components/keycreditsrefill.d.ts.map +1 -1
- package/dist/esm/models/components/keycreditsrefill.js +12 -13
- package/dist/esm/models/components/keycreditsrefill.js.map +1 -1
- package/dist/esm/models/components/updatekeycreditsdata.d.ts +41 -0
- package/dist/esm/models/components/updatekeycreditsdata.d.ts.map +1 -0
- package/dist/esm/models/components/updatekeycreditsdata.js +34 -0
- package/dist/esm/models/components/updatekeycreditsdata.js.map +1 -0
- package/dist/esm/models/components/updatekeycreditsrefill.d.ts +81 -0
- package/dist/esm/models/components/updatekeycreditsrefill.d.ts.map +1 -0
- package/dist/esm/models/components/updatekeycreditsrefill.js +57 -0
- package/dist/esm/models/components/updatekeycreditsrefill.js.map +1 -0
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysaddpermissionsresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysaddrolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysremoverolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.d.ts +60 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.js +33 -0
- package/dist/esm/models/components/v2keysrerollkeyrequestbody.js.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.d.ts +36 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.js +35 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsebody.js.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.d.ts +62 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.d.ts.map +1 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.js +33 -0
- package/dist/esm/models/components/v2keysrerollkeyresponsedata.js.map +1 -0
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keyssetpermissionsresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.d.ts +0 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keyssetrolesresponsebody.js.map +1 -1
- package/dist/esm/models/components/v2keysupdatekeyrequestbody.d.ts +3 -3
- package/dist/esm/models/components/v2keysupdatekeyrequestbody.d.ts.map +1 -1
- package/dist/esm/models/components/v2keysupdatekeyrequestbody.js +3 -3
- package/dist/esm/models/components/v2keysupdatekeyrequestbody.js.map +1 -1
- package/dist/esm/models/errors/goneerrorresponse.d.ts +72 -0
- package/dist/esm/models/errors/goneerrorresponse.d.ts.map +1 -0
- package/dist/esm/models/errors/goneerrorresponse.js +62 -0
- package/dist/esm/models/errors/goneerrorresponse.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +1 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -1
- package/dist/esm/models/errors/index.js +1 -0
- package/dist/esm/models/errors/index.js.map +1 -1
- package/dist/esm/sdk/keys.d.ts +38 -0
- package/dist/esm/sdk/keys.d.ts.map +1 -1
- package/dist/esm/sdk/keys.js +41 -0
- package/dist/esm/sdk/keys.js.map +1 -1
- package/dist/esm/sdk/permissions.d.ts +4 -2
- package/dist/esm/sdk/permissions.d.ts.map +1 -1
- package/dist/esm/sdk/permissions.js +4 -2
- package/dist/esm/sdk/permissions.js.map +1 -1
- package/dist/esm/sdk/ratelimit.d.ts +1 -1
- package/dist/esm/sdk/ratelimit.js +1 -1
- package/docs/sdks/keys/README.md +113 -0
- package/docs/sdks/permissions/README.md +4 -2
- package/docs/sdks/ratelimit/README.md +2 -1
- package/examples/apisCreateApi.example.ts +2 -2
- package/examples/package-lock.json +3 -3
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/funcs/identitiesListIdentities.ts +3 -0
- package/src/funcs/keysRerollKey.ts +227 -0
- package/src/funcs/permissionsListPermissions.ts +2 -1
- package/src/funcs/permissionsListRoles.ts +2 -1
- package/src/funcs/ratelimitLimit.ts +6 -2
- package/src/lib/config.ts +3 -3
- package/src/lib/security.ts +4 -1
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +3 -1
- package/src/mcp-server/tools/keysRerollKey.ts +69 -0
- package/src/mcp-server/tools/permissionsListPermissions.ts +2 -1
- package/src/mcp-server/tools/permissionsListRoles.ts +2 -1
- package/src/mcp-server/tools/ratelimitLimit.ts +1 -1
- package/src/models/components/index.ts +5 -0
- package/src/models/components/keycreditsrefill.ts +18 -14
- package/src/models/components/updatekeycreditsdata.ts +85 -0
- package/src/models/components/updatekeycreditsrefill.ts +126 -0
- package/src/models/components/v2keysaddpermissionsresponsebody.ts +0 -1
- package/src/models/components/v2keysaddrolesresponsebody.ts +0 -1
- package/src/models/components/v2keysremoverolesresponsebody.ts +0 -1
- package/src/models/components/v2keysrerollkeyrequestbody.ts +99 -0
- package/src/models/components/v2keysrerollkeyresponsebody.ts +87 -0
- package/src/models/components/v2keysrerollkeyresponsedata.ts +103 -0
- package/src/models/components/v2keyssetpermissionsresponsebody.ts +0 -1
- package/src/models/components/v2keyssetrolesresponsebody.ts +0 -1
- package/src/models/components/v2keysupdatekeyrequestbody.ts +10 -10
- package/src/models/errors/goneerrorresponse.ts +118 -0
- package/src/models/errors/index.ts +1 -0
- package/src/sdk/keys.ts +49 -0
- package/src/sdk/permissions.ts +4 -2
- package/src/sdk/ratelimit.ts +1 -1
package/README.md
CHANGED
|
@@ -327,6 +327,7 @@ run();
|
|
|
327
327
|
* [getKey](docs/sdks/keys/README.md#getkey) - Get API key
|
|
328
328
|
* [removePermissions](docs/sdks/keys/README.md#removepermissions) - Remove key permissions
|
|
329
329
|
* [removeRoles](docs/sdks/keys/README.md#removeroles) - Remove key roles
|
|
330
|
+
* [rerollKey](docs/sdks/keys/README.md#rerollkey) - Reroll Key
|
|
330
331
|
* [setPermissions](docs/sdks/keys/README.md#setpermissions) - Set key permissions
|
|
331
332
|
* [setRoles](docs/sdks/keys/README.md#setroles) - Set key roles
|
|
332
333
|
* [updateCredits](docs/sdks/keys/README.md#updatecredits) - Update key credits
|
|
@@ -388,6 +389,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
388
389
|
- [`keysGetKey`](docs/sdks/keys/README.md#getkey) - Get API key
|
|
389
390
|
- [`keysRemovePermissions`](docs/sdks/keys/README.md#removepermissions) - Remove key permissions
|
|
390
391
|
- [`keysRemoveRoles`](docs/sdks/keys/README.md#removeroles) - Remove key roles
|
|
392
|
+
- [`keysRerollKey`](docs/sdks/keys/README.md#rerollkey) - Reroll Key
|
|
391
393
|
- [`keysSetPermissions`](docs/sdks/keys/README.md#setpermissions) - Set key permissions
|
|
392
394
|
- [`keysSetRoles`](docs/sdks/keys/README.md#setroles) - Set key roles
|
|
393
395
|
- [`keysUpdateCredits`](docs/sdks/keys/README.md#updatecredits) - Update key credits
|
|
@@ -572,7 +574,7 @@ run();
|
|
|
572
574
|
* [`InternalServerErrorResponse`](./src/models/errors/internalservererrorresponse.ts): Error response when an unexpected error occurs on the server. This indicates a problem with Unkey's systems rather than your request. When you encounter this error: - The request ID in the response can help Unkey support investigate the issue - The error is likely temporary and retrying may succeed - If the error persists, contact Unkey support with the request ID. Status code `500`.
|
|
573
575
|
* [`NotFoundErrorResponse`](./src/models/errors/notfounderrorresponse.ts): Error response when the requested resource cannot be found. This occurs when: - The specified resource ID doesn't exist in your workspace - The resource has been deleted or moved - The resource exists but is not accessible with current permissions To resolve this error, verify the resource ID is correct and that you have access to it. Status code `404`. *
|
|
574
576
|
|
|
575
|
-
<details><summary>Less common errors (
|
|
577
|
+
<details><summary>Less common errors (9)</summary>
|
|
576
578
|
|
|
577
579
|
<br />
|
|
578
580
|
|
|
@@ -585,8 +587,9 @@ run();
|
|
|
585
587
|
|
|
586
588
|
|
|
587
589
|
**Inherit from [`UnkeyError`](./src/models/errors/unkeyerror.ts)**:
|
|
588
|
-
* [`ConflictErrorResponse`](./src/models/errors/conflicterrorresponse.ts): Error response when the request conflicts with the current state of the resource. This occurs when: - Attempting to create a resource that already exists - Modifying a resource that has been changed by another operation - Violating unique constraints or business rules To resolve this error, check the current state of the resource and adjust your request accordingly. Status code `409`. Applicable to 3 of
|
|
589
|
-
* [`
|
|
590
|
+
* [`ConflictErrorResponse`](./src/models/errors/conflicterrorresponse.ts): Error response when the request conflicts with the current state of the resource. This occurs when: - Attempting to create a resource that already exists - Modifying a resource that has been changed by another operation - Violating unique constraints or business rules To resolve this error, check the current state of the resource and adjust your request accordingly. Status code `409`. Applicable to 3 of 36 methods.*
|
|
591
|
+
* [`GoneErrorResponse`](./src/models/errors/goneerrorresponse.ts): Error response when the requested resource has been soft-deleted and is no longer available. This occurs when: - The resource has been marked as deleted but still exists in the database - The resource is intentionally unavailable but could potentially be restored - The resource cannot be restored through the API or dashboard To resolve this error, contact support if you need the resource restored. Status code `410`. Applicable to 1 of 36 methods.*
|
|
592
|
+
* [`PreconditionFailedErrorResponse`](./src/models/errors/preconditionfailederrorresponse.ts): Error response when one or more conditions specified in the request headers are not met. This typically occurs when: - Using conditional requests with If-Match or If-None-Match headers - The resource version doesn't match the expected value - Optimistic concurrency control detects a conflict To resolve this error, fetch the latest version of the resource and retry with updated conditions. Status code `412`. Applicable to 1 of 36 methods.*
|
|
590
593
|
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
591
594
|
|
|
592
595
|
</details>
|