@unkey/api 0.33.1 → 0.34.0

package/dist/index.d.mts

@@ -260,6 +260,28 @@ interface components {
         requestId: string;
       };
     };
+    ErrPreconditionFailed: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example PRECONDITION_FAILED
+         * @enum {string}
+         */
+        code: "PRECONDITION_FAILED";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://unkey.dev/docs/api-reference/errors/code/PRECONDITION_FAILED
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req_1234
+         */
+        requestId: string;
+      };
+    };
     ErrTooManyRequests: {
       error: {
         /**
@@ -570,6 +592,8 @@ interface components {
           [key: string]: unknown;
         };
       };
+      /** @description A unique id for this request, please provide it to Unkey support to help us debug your issue. */
+      requestId: string;
     };
     /** @description A query for which permissions you require */
     PermissionQuery: OneOf<[string, {
@@ -748,6 +772,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -806,6 +836,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -923,6 +959,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -947,7 +989,7 @@ interface operations {
            */
           keyId: string;
           /**
-           * @description By default Unkey soft deletes keys, so they may be recovered later. If you want to permanently delete it, set permanent=true. This might be necessary if you run into NOT_UNIQUE errors during key migration.
+           * @description By default Unkey soft deletes keys, so they may be recovered later. If you want to permanently delete it, set permanent=true. This might be necessary if you run into CONFLICT errors during key migration.
            * @default false
            */
           permanent?: boolean;
@@ -991,6 +1033,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1218,6 +1266,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1275,6 +1329,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1499,6 +1559,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1578,6 +1644,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1662,6 +1734,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1745,6 +1823,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1822,6 +1906,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -1920,6 +2010,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2018,6 +2114,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2095,6 +2197,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2193,6 +2301,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2266,6 +2380,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2335,6 +2455,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2407,6 +2533,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2470,6 +2602,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The api is protected from deletions */
       429: {
         content: {
@@ -2541,6 +2679,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2689,6 +2833,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2783,6 +2933,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2858,6 +3014,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2931,6 +3093,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -2996,6 +3164,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3216,6 +3390,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3426,6 +3606,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3453,7 +3639,7 @@ interface operations {
            * @description Explain what this permission does. This is just for your team, your users will not see this.
            * @example record.write can create new dns records for our domains.
            */
-          description?: string;
+          description?: string | "";
         };
       };
     };
@@ -3500,6 +3686,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3563,6 +3755,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3636,6 +3834,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3704,6 +3908,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3731,7 +3941,7 @@ interface operations {
            * @description Explain what this role does. This is just for your team, your users will not see this.
            * @example dns.records.manager can read and write dns records for our domains.
            */
-          description?: string;
+          description?: string | "";
         };
       };
     };
@@ -3778,6 +3988,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3841,6 +4057,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3914,6 +4136,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -3982,6 +4210,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4006,7 +4240,7 @@ interface operations {
            * This usually comes from your authentication provider and could be a userId, organisationId or even an email.
            * It does not matter what you use, as long as it uniquely identifies something in your application.
            *
-           * `externalId`s are unique across your workspace and therefore a `PRECONDITION_FAILED` error is returned when you try to create duplicates.
+           * `externalId`s are unique across your workspace and therefore a `CONFLICT` error is returned when you try to create duplicates.
            *
            * @example user_123
            */
@@ -4087,6 +4321,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4172,6 +4412,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4264,6 +4510,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4409,6 +4661,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4472,6 +4730,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4569,6 +4833,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4710,6 +4980,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4868,6 +5144,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -4934,6 +5216,12 @@ interface operations {
           "application/json": components["schemas"]["ErrConflict"];
         };
       };
+      /** @description The requested operation cannot be completed because certain conditions were not met. This typically occurs when a required resource state or version check fails. */
+      412: {
+        content: {
+          "application/json": components["schemas"]["ErrPreconditionFailed"];
+        };
+      };
       /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
       429: {
         content: {
@@ -5140,6 +5428,7 @@ declare function verifyKey<TPermission extends string = string>(req: string | (O
                 [key: string]: unknown;
             };
         };
+        requestId: string;
     };
     error?: never;
 }>;