@greensecurity/javascript-sdk 0.46.0-beta.8 → 0.46.0-beta.9

package/dist/esm/models/components/tokenresponse.d.ts

@@ -0,0 +1,129 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * What kind of token was issued. Returned for app user, app installation and developer
+ *
+ * @remarks
+ * CLI tokens, including every CLI refresh; absent from the plain API token that
+ * `client_credentials` without `activation_id` and a service account's
+ * `refresh_token` return.
+ */
+export declare const IssuedTokenType: {
+    readonly UrnGreensecurityTokenTypeAppUser: "urn:greensecurity:token-type:app_user";
+    readonly UrnGreensecurityTokenTypeAppInstallation: "urn:greensecurity:token-type:app_installation";
+    readonly UrnGreensecurityTokenTypeDeveloperCli: "urn:greensecurity:token-type:developer_cli";
+};
+/**
+ * What kind of token was issued. Returned for app user, app installation and developer
+ *
+ * @remarks
+ * CLI tokens, including every CLI refresh; absent from the plain API token that
+ * `client_credentials` without `activation_id` and a service account's
+ * `refresh_token` return.
+ */
+export type IssuedTokenType = OpenEnum<typeof IssuedTokenType>;
+/**
+ * A successful `POST /oauth/token` response (RFC 6749 section 5.1, RFC 8693 section 2.2.1).
+ *
+ * @remarks
+ * Send `access_token` as `Authorization: Bearer <access_token>`; app and developer tokens
+ * are refused as a `?token=` query parameter.
+ *
+ * Which fields are present depends on the grant:
+ *
+ * | Grant | Fields |
+ * | --- | --- |
+ * | Token exchange, and `client_credentials` with `activation_id` | `access_token`, `issued_token_type`, `token_type`, `expires_in`, `scope`, `activation_id` |
+ * | Device code, and the apps CLI's `refresh_token` | `access_token`, `issued_token_type`, `token_type`, `expires_in`, `scope`, `refresh_token`, `refresh_token_expires_in` |
+ * | `client_credentials` without `activation_id` | `access_token`, `token_type`, `expires_in`, and `scope` only when the request sent one |
+ * | A service account's `refresh_token` | As `client_credentials` without `activation_id`, plus `refresh_token` |
+ */
+export type TokenResponse = {
+    /**
+     * The token. An app or developer token's prefix names its kind: `gsu_` for an app user
+     *
+     * @remarks
+     * token, `gsi_` for an app installation token, `gsd_` for a developer CLI token. These
+     * are shown only once and cannot be retrieved later. The access
+     * token of a `client_credentials` grant without `activation_id`, or of a service
+     * account's `refresh_token` grant, is an ordinary API token with no prefix.
+     */
+    accessToken: string;
+    /**
+     * What kind of token was issued. Returned for app user, app installation and developer
+     *
+     * @remarks
+     * CLI tokens, including every CLI refresh; absent from the plain API token that
+     * `client_credentials` without `activation_id` and a service account's
+     * `refresh_token` return.
+     */
+    issuedTokenType?: IssuedTokenType | undefined;
+    tokenType: "Bearer";
+    /**
+     * Seconds until the token expires: 900 (15 minutes) for every kind. A developer CLI
+     *
+     * @remarks
+     * token is capped at the end of its login (90 days after the device authorization), so
+     * near that end it can be less. Request a new token before then. Only the device grant
+     * and the `refresh_token` grant return a `refresh_token`.
+     */
+    expiresIn: number;
+    /**
+     * Space-delimited scopes the token carries. For an app user token these are the
+     *
+     * @remarks
+     * manifest permissions (`resource.action`) that the user's own role also grants; for an
+     * installation token, the app's manifest permissions; for a developer CLI token,
+     * `apps:develop`. A `scope` in the request narrows this further.
+     *
+     * A plain API access token (`client_credentials` without `activation_id`, or
+     * `refresh_token`) carries `scope` only when it was narrowed: when the request sent a
+     * `scope`, or when the refresh token it replaces was itself narrowed. Without it the
+     * token has every permission of the service account.
+     *
+     * A narrowed token (any app or developer token, or a plain API access token that
+     * carries `scope`) can only use its scope. An endpoint that names a permission
+     * outside it answers `403` ("App token doesn't have permission" for an app token,
+     * "Token scope doesn't permit this." for a plain one); an endpoint that checks no
+     * named permission answers `403` "This endpoint does not accept scoped tokens."
+     * unless it applies the scope itself. `GET /users/{id}` does, but returns no
+     * `user_token` to a narrowed token and refuses `expand=user.payment_profile` with
+     * `403`. A narrowed token is also refused as the `client_credentials` Bearer, as a
+     * `subject_token`, and as the credential for `POST /oauth/introspect` and
+     * `POST /oauth/revoke`.
+     */
+    scope?: string | undefined;
+    /**
+     * The activation an app user or app installation token is bound to. Not returned for any other token.
+     */
+    activationId?: number | undefined;
+    /**
+     * A single-use refresh token. Keep it as secret as a password; it is never a Bearer
+     *
+     * @remarks
+     * credential.
+     *
+     * - **Apps CLI** (`gsdr_…`): returned by the device grant and by every CLI refresh.
+     *   Each refresh spends it and returns a new one (see `OAuthCliRefreshTokenGrant`).
+     * - **Service account** (no prefix): returned by a service account's `refresh_token`
+     *   grant, replacing the token just spent. It expires after 30 days.
+     */
+    refreshToken?: string | undefined;
+    /**
+     * Apps CLI only: seconds until `refresh_token` expires if it is not used, normally
+     *
+     * @remarks
+     * 2592000 (30 days). A CLI login ends 90 days after the device authorization however
+     * often it is refreshed, so in its last 30 days this is capped at that end (for
+     * example 259200 on day 87).
+     */
+    refreshTokenExpiresIn?: number | undefined;
+};
+/** @internal */
+export declare const IssuedTokenType$inboundSchema: z.ZodType<IssuedTokenType, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const TokenResponse$inboundSchema: z.ZodType<TokenResponse, z.ZodTypeDef, unknown>;
+export declare function tokenResponseFromJSON(jsonString: string): SafeParseResult<TokenResponse, SDKValidationError>;
+//# sourceMappingURL=tokenresponse.d.ts.map

package/dist/esm/models/components/tokenresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/components/tokenresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe;;;;CAMlB,CAAC;AACX;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,OAAO,eAAe,CAAC,CAAC;AAE/D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;;;;OAQG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAC9C,SAAS,EAAE,QAAQ,CAAC;IACpB;;;;;;;OAOG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;;;;;;;;OAUG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;;;;;;OAOG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5C,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,eAAe,EACf,CAAC,CAAC,UAAU,EACZ,OAAO,CACmC,CAAC;AAE7C,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAoBP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD"}

package/dist/esm/models/components/tokenresponse.js

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import * as types from "../../types/primitives.js";
+/**
+ * What kind of token was issued. Returned for app user, app installation and developer
+ *
+ * @remarks
+ * CLI tokens, including every CLI refresh; absent from the plain API token that
+ * `client_credentials` without `activation_id` and a service account's
+ * `refresh_token` return.
+ */
+export const IssuedTokenType = {
+    UrnGreensecurityTokenTypeAppUser: "urn:greensecurity:token-type:app_user",
+    UrnGreensecurityTokenTypeAppInstallation: "urn:greensecurity:token-type:app_installation",
+    UrnGreensecurityTokenTypeDeveloperCli: "urn:greensecurity:token-type:developer_cli",
+};
+/** @internal */
+export const IssuedTokenType$inboundSchema = openEnums.inboundSchema(IssuedTokenType);
+/** @internal */
+export const TokenResponse$inboundSchema = z.object({
+    access_token: types.string(),
+    issued_token_type: types.optional(IssuedTokenType$inboundSchema),
+    token_type: types.literal("Bearer"),
+    expires_in: types.number(),
+    scope: types.optional(types.string()),
+    activation_id: types.optional(types.number()),
+    refresh_token: types.optional(types.string()),
+    refresh_token_expires_in: types.optional(types.number()),
+}).transform((v) => {
+    return remap$(v, {
+        "access_token": "accessToken",
+        "issued_token_type": "issuedTokenType",
+        "token_type": "tokenType",
+        "expires_in": "expiresIn",
+        "activation_id": "activationId",
+        "refresh_token": "refreshToken",
+        "refresh_token_expires_in": "refreshTokenExpiresIn",
+    });
+});
+export function tokenResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => TokenResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'TokenResponse' from JSON`);
+}
+//# sourceMappingURL=tokenresponse.js.map

package/dist/esm/models/components/tokenresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenresponse.js","sourceRoot":"","sources":["../../../../src/models/components/tokenresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAGlD,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AAGnD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,gCAAgC,EAAE,uCAAuC;IACzE,wCAAwC,EACtC,+CAA+C;IACjD,qCAAqC,EACnC,4CAA4C;CACtC,CAAC;AA6GX,gBAAgB;AAChB,MAAM,CAAC,MAAM,6BAA6B,GAItC,SAAS,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;AAE7C,gBAAgB;AAChB,MAAM,CAAC,MAAM,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,KAAK,CAAC,MAAM,EAAE;IAC5B,iBAAiB,EAAE,KAAK,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IAChE,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;IACnC,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE;IAC1B,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACrC,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC7C,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IAC7C,wBAAwB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,cAAc,EAAE,aAAa;QAC7B,mBAAmB,EAAE,iBAAiB;QACtC,YAAY,EAAE,WAAW;QACzB,YAAY,EAAE,WAAW;QACzB,eAAe,EAAE,cAAc;QAC/B,eAAe,EAAE,cAAc;QAC/B,0BAA0B,EAAE,uBAAuB;KACpD,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,qBAAqB,CACnC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC"}

package/dist/esm/models/components/tokenrevocationrequest.d.ts

@@ -0,0 +1,30 @@
+import * as z from "zod/v3";
+import { OAuthTokenTypeHint } from "./oauthtokentypehint.js";
+export type TokenRevocationRequest = {
+    /**
+     * The token to revoke. Revoking any token of an apps CLI login (`gsd_` or `gsdr_`) revokes the whole login.
+     */
+    token: string;
+    /**
+     * Optional hint about the kind of token. Tokens are recognised by prefix, so this is informational.
+     */
+    tokenTypeHint?: OAuthTokenTypeHint | undefined;
+    /**
+     * The apps CLI's public client id (RFC 7009 section 2.1). With a `gsdr_` refresh token
+     *
+     * @remarks
+     * as `token`, no `Authorization` is needed: holding the refresh token entitles the
+     * caller to revoke its login. Ignored with any other token.
+     */
+    clientId?: "greensecurity-apps-cli" | undefined;
+};
+/** @internal */
+export type TokenRevocationRequest$Outbound = {
+    token: string;
+    token_type_hint?: string | undefined;
+    client_id?: "greensecurity-apps-cli" | undefined;
+};
+/** @internal */
+export declare const TokenRevocationRequest$outboundSchema: z.ZodType<TokenRevocationRequest$Outbound, z.ZodTypeDef, TokenRevocationRequest>;
+export declare function tokenRevocationRequestToJSON(tokenRevocationRequest: TokenRevocationRequest): string;
+//# sourceMappingURL=tokenrevocationrequest.d.ts.map

package/dist/esm/models/components/tokenrevocationrequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenrevocationrequest.d.ts","sourceRoot":"","sources":["../../../../src/models/components/tokenrevocationrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EACL,kBAAkB,EAEnB,MAAM,yBAAyB,CAAC;AAEjC,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC/C;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CACjD,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,+BAA+B,GAAG;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,SAAS,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAClD,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,sBAAsB,CAUtB,CAAC;AAEH,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,sBAAsB,GAC7C,MAAM,CAIR"}

package/dist/esm/models/components/tokenrevocationrequest.js

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { OAuthTokenTypeHint$outboundSchema, } from "./oauthtokentypehint.js";
+/** @internal */
+export const TokenRevocationRequest$outboundSchema = z.object({
+    token: z.string(),
+    tokenTypeHint: OAuthTokenTypeHint$outboundSchema.optional(),
+    clientId: z.literal("greensecurity-apps-cli").optional(),
+}).transform((v) => {
+    return remap$(v, {
+        tokenTypeHint: "token_type_hint",
+        clientId: "client_id",
+    });
+});
+export function tokenRevocationRequestToJSON(tokenRevocationRequest) {
+    return JSON.stringify(TokenRevocationRequest$outboundSchema.parse(tokenRevocationRequest));
+}
+//# sourceMappingURL=tokenrevocationrequest.js.map

package/dist/esm/models/components/tokenrevocationrequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenrevocationrequest.js","sourceRoot":"","sources":["../../../../src/models/components/tokenrevocationrequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,KAAK,IAAI,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAEL,iCAAiC,GAClC,MAAM,yBAAyB,CAAC;AA4BjC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,aAAa,EAAE,iCAAiC,CAAC,QAAQ,EAAE;IAC3D,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,QAAQ,EAAE;CACzD,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,MAAM,CAAC,CAAC,EAAE;QACf,aAAa,EAAE,iBAAiB;QAChC,QAAQ,EAAE,WAAW;KACtB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,4BAA4B,CAC1C,sBAA8C;IAE9C,OAAO,IAAI,CAAC,SAAS,CACnB,qCAAqC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CACpE,CAAC;AACJ,CAAC"}

package/dist/esm/models/errors/appsecretsunprocessable.d.ts

@@ -0,0 +1,19 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApiErrorResponse } from "./apierrorresponse.js";
+import { ApiValidationErrorResponse } from "./apivalidationerrorresponse.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+/**
+ * A parameter failed validation, `activation_id` is missing with the service account's
+ *
+ * @remarks
+ * token, a `user` scope has no `user_id` with the service account or an installation
+ * token from `client_credentials`, an `installation` scope names a `user_id`, or the scope
+ * already holds 25 secrets.
+ * Carries either the standard error envelope or the validation envelope.
+ */
+export type AppSecretsUnprocessable = ApiErrorResponse | ApiValidationErrorResponse;
+/** @internal */
+export declare const AppSecretsUnprocessable$inboundSchema: z.ZodType<AppSecretsUnprocessable, z.ZodTypeDef, unknown>;
+export declare function appSecretsUnprocessableFromJSON(jsonString: string): SafeParseResult<AppSecretsUnprocessable, SDKValidationError>;
+//# sourceMappingURL=appsecretsunprocessable.d.ts.map

package/dist/esm/models/errors/appsecretsunprocessable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"appsecretsunprocessable.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/appsecretsunprocessable.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EACL,gBAAgB,EAEjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,0BAA0B,EAE3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;;;;GAQG;AACH,MAAM,MAAM,uBAAuB,GAC/B,gBAAgB,GAChB,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,+BAA+B,CAC7C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,uBAAuB,EAAE,kBAAkB,CAAC,CAM9D"}

package/dist/esm/models/errors/appsecretsunprocessable.js

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { safeParse } from "../../lib/schemas.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import { ApiErrorResponse$inboundSchema, } from "./apierrorresponse.js";
+import { ApiValidationErrorResponse$inboundSchema, } from "./apivalidationerrorresponse.js";
+/** @internal */
+export const AppSecretsUnprocessable$inboundSchema = smartUnion([
+    ApiErrorResponse$inboundSchema,
+    ApiValidationErrorResponse$inboundSchema,
+]);
+export function appSecretsUnprocessableFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => AppSecretsUnprocessable$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AppSecretsUnprocessable' from JSON`);
+}
+//# sourceMappingURL=appsecretsunprocessable.js.map

package/dist/esm/models/errors/appsecretsunprocessable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"appsecretsunprocessable.js","sourceRoot":"","sources":["../../../../src/models/errors/appsecretsunprocessable.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAEL,8BAA8B,GAC/B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEL,wCAAwC,GACzC,MAAM,iCAAiC,CAAC;AAgBzC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,UAAU,CAAC;IACb,8BAA8B;IAC9B,wCAAwC;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,+BAA+B,CAC7C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qCAAqC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjE,qDAAqD,CACtD,CAAC;AACJ,CAAC"}

package/dist/esm/models/errors/createappdevsession.d.ts

@@ -0,0 +1,17 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { ApiValidationErrorResponse } from "./apivalidationerrorresponse.js";
+import { DevSessionErrorResponse } from "./devsessionerrorresponse.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+/**
+ * A field failed validation. A refused `manifest` also lists each problem in `errors`. A
+ *
+ * @remarks
+ * parameter that fails validation before the endpoint runs gets the validation envelope,
+ * whose `error` is an array.
+ */
+export type CreateAppDevSessionResponseBody = DevSessionErrorResponse | ApiValidationErrorResponse;
+/** @internal */
+export declare const CreateAppDevSessionResponseBody$inboundSchema: z.ZodType<CreateAppDevSessionResponseBody, z.ZodTypeDef, unknown>;
+export declare function createAppDevSessionResponseBodyFromJSON(jsonString: string): SafeParseResult<CreateAppDevSessionResponseBody, SDKValidationError>;
+//# sourceMappingURL=createappdevsession.d.ts.map

package/dist/esm/models/errors/createappdevsession.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createappdevsession.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/createappdevsession.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE9D,OAAO,EACL,0BAA0B,EAE3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,uBAAuB,EAExB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GACvC,uBAAuB,GACvB,0BAA0B,CAAC;AAE/B,gBAAgB;AAChB,eAAO,MAAM,6CAA6C,EAAE,CAAC,CAAC,OAAO,CACnE,+BAA+B,EAC/B,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,uCAAuC,CACrD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,+BAA+B,EAAE,kBAAkB,CAAC,CAMtE"}

package/dist/esm/models/errors/createappdevsession.js

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { safeParse } from "../../lib/schemas.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import { ApiValidationErrorResponse$inboundSchema, } from "./apivalidationerrorresponse.js";
+import { DevSessionErrorResponse$inboundSchema, } from "./devsessionerrorresponse.js";
+/** @internal */
+export const CreateAppDevSessionResponseBody$inboundSchema = smartUnion([
+    DevSessionErrorResponse$inboundSchema,
+    ApiValidationErrorResponse$inboundSchema,
+]);
+export function createAppDevSessionResponseBodyFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => CreateAppDevSessionResponseBody$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'CreateAppDevSessionResponseBody' from JSON`);
+}
+//# sourceMappingURL=createappdevsession.js.map

package/dist/esm/models/errors/createappdevsession.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createappdevsession.js","sourceRoot":"","sources":["../../../../src/models/errors/createappdevsession.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAEL,wCAAwC,GACzC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,qCAAqC,GACtC,MAAM,8BAA8B,CAAC;AActC,gBAAgB;AAChB,MAAM,CAAC,MAAM,6CAA6C,GAItD,UAAU,CAAC;IACb,qCAAqC;IACrC,wCAAwC;CACzC,CAAC,CAAC;AAEH,MAAM,UAAU,uCAAuC,CACrD,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,6CAA6C,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzE,6DAA6D,CAC9D,CAAC;AACJ,CAAC"}

package/dist/esm/models/errors/devsessionerrorresponse.d.ts

@@ -0,0 +1,68 @@
+import * as z from "zod/v3";
+import { GreenSecurityError } from "./greensecurityerror.js";
+/**
+ * The standard error envelope. When `manifest` is refused, it also carries `errors`.
+ */
+export type DevSessionErrorResponseData = {
+    /**
+     * A short message that describes the error. For a refused `manifest`, it's
+     *
+     * @remarks
+     * `Invalid manifest: ` followed by the entries of `errors`, joined with `; `.
+     */
+    error: string;
+    /**
+     * Whether the request succeeded. Always false for an error response.
+     */
+    success?: boolean | undefined;
+    /**
+     * The HTTP status code of the error, or `null` if not available.
+     */
+    code?: number | null | undefined;
+    /**
+     * Only when `manifest` is refused: one message per problem, up to 20, in the order
+     *
+     * @remarks
+     * `error` lists them. A message can quote a key or value from your manifest, which may
+     * itself contain `; `, so read this list rather than splitting `error`.
+     */
+    errors?: Array<string> | undefined;
+};
+/**
+ * The standard error envelope. When `manifest` is refused, it also carries `errors`.
+ */
+export declare class DevSessionErrorResponse extends GreenSecurityError {
+    /**
+     * A short message that describes the error. For a refused `manifest`, it's
+     *
+     * @remarks
+     * `Invalid manifest: ` followed by the entries of `errors`, joined with `; `.
+     */
+    error: string;
+    /**
+     * Whether the request succeeded. Always false for an error response.
+     */
+    success?: boolean | undefined;
+    /**
+     * The HTTP status code of the error, or `null` if not available.
+     */
+    code?: number | null | undefined;
+    /**
+     * Only when `manifest` is refused: one message per problem, up to 20, in the order
+     *
+     * @remarks
+     * `error` lists them. A message can quote a key or value from your manifest, which may
+     * itself contain `; `, so read this list rather than splitting `error`.
+     */
+    errors?: Array<string> | undefined;
+    /** The original data that was passed to this error instance. */
+    data$: DevSessionErrorResponseData;
+    constructor(err: DevSessionErrorResponseData, httpMeta: {
+        response: Response;
+        request: Request;
+        body: string;
+    });
+}
+/** @internal */
+export declare const DevSessionErrorResponse$inboundSchema: z.ZodType<DevSessionErrorResponse, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=devsessionerrorresponse.d.ts.map

package/dist/esm/models/errors/devsessionerrorresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devsessionerrorresponse.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/devsessionerrorresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,kBAAkB;IAC7D;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAEnC,gEAAgE;IAChE,KAAK,EAAE,2BAA2B,CAAC;gBAGjC,GAAG,EAAE,2BAA2B,EAChC,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAcnE;AAED,gBAAgB;AAChB,eAAO,MAAM,qCAAqC,EAAE,CAAC,CAAC,OAAO,CAC3D,uBAAuB,EACvB,CAAC,CAAC,UAAU,EACZ,OAAO,CAgBL,CAAC"}

package/dist/esm/models/errors/devsessionerrorresponse.js

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { GreenSecurityError } from "./greensecurityerror.js";
+/**
+ * The standard error envelope. When `manifest` is refused, it also carries `errors`.
+ */
+export class DevSessionErrorResponse extends GreenSecurityError {
+    constructor(err, httpMeta) {
+        const message = "message" in err && typeof err.message === "string"
+            ? err.message
+            : `API error occurred: ${JSON.stringify(err)}`;
+        super(message, httpMeta);
+        this.data$ = err;
+        this.error = err.error;
+        if (err.success != null)
+            this.success = err.success;
+        if (err.code != null)
+            this.code = err.code;
+        if (err.errors != null)
+            this.errors = err.errors;
+        this.name = "DevSessionErrorResponse";
+    }
+}
+/** @internal */
+export const DevSessionErrorResponse$inboundSchema = z.object({
+    error: types.string(),
+    success: types.optional(types.boolean()),
+    code: z.nullable(types.number()).optional(),
+    errors: types.optional(z.array(types.string())),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+})
+    .transform((v) => {
+    return new DevSessionErrorResponse(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+    });
+});
+//# sourceMappingURL=devsessionerrorresponse.js.map

package/dist/esm/models/errors/devsessionerrorresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devsessionerrorresponse.js","sourceRoot":"","sources":["../../../../src/models/errors/devsessionerrorresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,KAAK,KAAK,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AA+B7D;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,kBAAkB;IA4B7D,YACE,GAAgC,EAChC,QAAgE;QAEhE,MAAM,OAAO,GAAG,SAAS,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,QAAQ;YACjE,CAAC,CAAC,GAAG,CAAC,OAAO;YACb,CAAC,CAAC,uBAAuB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;QACjD,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;QACvB,IAAI,GAAG,CAAC,OAAO,IAAI,IAAI;YAAE,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QACpD,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI;YAAE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QAC3C,IAAI,GAAG,CAAC,MAAM,IAAI,IAAI;YAAE,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAEjD,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qCAAqC,GAI9C,CAAC,CAAC,MAAM,CAAC;IACX,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/C,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;IAC/B,SAAS,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC;KACC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACf,OAAO,IAAI,uBAAuB,CAAC,CAAC,EAAE;QACpC,OAAO,EAAE,CAAC,CAAC,QAAQ;QACnB,QAAQ,EAAE,CAAC,CAAC,SAAS;QACrB,IAAI,EAAE,CAAC,CAAC,KAAK;KACd,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/models/errors/index.d.ts

@@ -1,8 +1,12 @@
 export * from "./apierror.js";
 export * from "./apierrorresponse.js";
 export * from "./apivalidationerrorresponse.js";
+export * from "./appsecretsunprocessable.js";
+export * from "./createappdevsession.js";
+export * from "./devsessionerrorresponse.js";
 export * from "./greensecurityerror.js";
 export * from "./httpclienterrors.js";
+export * from "./oautherror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unprocessableentityorvalidationerror.js";

package/dist/esm/models/errors/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC"}

package/dist/esm/models/errors/index.js

@@ -4,8 +4,12 @@
 export * from "./apierror.js";
 export * from "./apierrorresponse.js";
 export * from "./apivalidationerrorresponse.js";
+export * from "./appsecretsunprocessable.js";
+export * from "./createappdevsession.js";
+export * from "./devsessionerrorresponse.js";
 export * from "./greensecurityerror.js";
 export * from "./httpclienterrors.js";
+export * from "./oautherror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";
 export * from "./unprocessableentityorvalidationerror.js";

package/dist/esm/models/errors/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/errors/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/errors/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,2CAA2C,CAAC"}

package/dist/esm/models/errors/oautherror.d.ts

@@ -0,0 +1,85 @@
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { GreenSecurityError } from "./greensecurityerror.js";
+/**
+ * The error body of the `/oauth/*` endpoints (RFC 6749 section 5.2, RFC 8628 section 3.5).
+ *
+ * @remarks
+ * These endpoints use this shape rather than `ApiErrorResponse`, including for a body that
+ * fails validation or cannot be parsed: that is a `400` `invalid_request`, never a `422`.
+ */
+export type OAuthErrorData = {
+    /**
+     * The RFC error code:
+     *
+     * @remarks
+     *
+     * | Code | Meaning |
+     * | --- | --- |
+     * | `invalid_request` | A parameter is missing or malformed (including `client_id` without `client_secret` or the reverse), an OAuth parameter was sent in the query string rather than the body, the body could not be parsed, or more than one activation covers the user and `activation_id` was left out. |
+     * | `invalid_client` | The client could not be authenticated. Returned with `401`. On the apps CLI's `refresh_token` (a `gsdr_` token): a `client_id` other than `greensecurity-apps-cli`. On `client_credentials`: wrong `client_id` or `client_secret`; an `Authorization` token that is missing, invalid, or not the service account's permanent token (a short-lived, narrowed or app token is refused); or a locked service account. On `refresh_token`: `client_id` or `client_secret` does not match the refresh token's service account, or that account is locked. On the device grant and `POST /oauth/device_authorization`: an unknown `client_id`. On `POST /oauth/introspect` and `POST /oauth/revoke`: see each endpoint. |
+     * | `invalid_grant` | `subject_token` is invalid or expired, is an app token or a narrowed (scoped) token, or belongs to a locked user or a service account; `refresh_token` is unknown, expired, already used or not a service account's; an apps CLI refresh token is unknown, expired, revoked or reused, its login is past 90 days, or its developer is locked or deleted (all answered "Re-authenticate with `gs-apps login`."); or `device_code` is unknown or already used, or the user who approved it can no longer sign in. |
+     * | `unauthorized_client` | The caller may not use this grant: `client_credentials` from a user who is not an API service account. |
+     * | `unsupported_grant_type` | `grant_type` is not one of the four supported grants. |
+     * | `invalid_target` | `audience` names no app, or an app the user is not covered by; or `activation_id` is not an activation of the caller's app, or does not match `audience`. |
+     * | `invalid_scope` | None of the requested scopes is available to the client: what it asked for and what it is allowed have nothing in common. On `POST /oauth/device_authorization`, any scope other than `apps:develop`. |
+     * | `authorization_pending` | Device flow: the user has not approved the request yet. Keep polling. |
+     * | `slow_down` | Device flow: polling too fast. Add 5 seconds to the interval and keep polling. `POST /oauth/device_authorization` also returns it, with `429`, when one address starts too many logins, and so does the apps CLI's `refresh_token` past 60 refreshes per address in ten minutes. Wait and retry; it is not a failed login. |
+     * | `access_denied` | Device flow: the user declined the request. Stop polling. |
+     * | `expired_token` | Device flow: `device_code` expired. Start again from `POST /oauth/device_authorization`. |
+     */
+    error: components.OAuthErrorCode;
+    /**
+     * A human-readable explanation, for logs rather than for end users. When a request
+     *
+     * @remarks
+     * parameter fails validation it names the parameter, as `<parameter>: <message>`.
+     */
+    errorDescription?: string | undefined;
+};
+/**
+ * The error body of the `/oauth/*` endpoints (RFC 6749 section 5.2, RFC 8628 section 3.5).
+ *
+ * @remarks
+ * These endpoints use this shape rather than `ApiErrorResponse`, including for a body that
+ * fails validation or cannot be parsed: that is a `400` `invalid_request`, never a `422`.
+ */
+export declare class OAuthError extends GreenSecurityError {
+    /**
+     * The RFC error code:
+     *
+     * @remarks
+     *
+     * | Code | Meaning |
+     * | --- | --- |
+     * | `invalid_request` | A parameter is missing or malformed (including `client_id` without `client_secret` or the reverse), an OAuth parameter was sent in the query string rather than the body, the body could not be parsed, or more than one activation covers the user and `activation_id` was left out. |
+     * | `invalid_client` | The client could not be authenticated. Returned with `401`. On the apps CLI's `refresh_token` (a `gsdr_` token): a `client_id` other than `greensecurity-apps-cli`. On `client_credentials`: wrong `client_id` or `client_secret`; an `Authorization` token that is missing, invalid, or not the service account's permanent token (a short-lived, narrowed or app token is refused); or a locked service account. On `refresh_token`: `client_id` or `client_secret` does not match the refresh token's service account, or that account is locked. On the device grant and `POST /oauth/device_authorization`: an unknown `client_id`. On `POST /oauth/introspect` and `POST /oauth/revoke`: see each endpoint. |
+     * | `invalid_grant` | `subject_token` is invalid or expired, is an app token or a narrowed (scoped) token, or belongs to a locked user or a service account; `refresh_token` is unknown, expired, already used or not a service account's; an apps CLI refresh token is unknown, expired, revoked or reused, its login is past 90 days, or its developer is locked or deleted (all answered "Re-authenticate with `gs-apps login`."); or `device_code` is unknown or already used, or the user who approved it can no longer sign in. |
+     * | `unauthorized_client` | The caller may not use this grant: `client_credentials` from a user who is not an API service account. |
+     * | `unsupported_grant_type` | `grant_type` is not one of the four supported grants. |
+     * | `invalid_target` | `audience` names no app, or an app the user is not covered by; or `activation_id` is not an activation of the caller's app, or does not match `audience`. |
+     * | `invalid_scope` | None of the requested scopes is available to the client: what it asked for and what it is allowed have nothing in common. On `POST /oauth/device_authorization`, any scope other than `apps:develop`. |
+     * | `authorization_pending` | Device flow: the user has not approved the request yet. Keep polling. |
+     * | `slow_down` | Device flow: polling too fast. Add 5 seconds to the interval and keep polling. `POST /oauth/device_authorization` also returns it, with `429`, when one address starts too many logins, and so does the apps CLI's `refresh_token` past 60 refreshes per address in ten minutes. Wait and retry; it is not a failed login. |
+     * | `access_denied` | Device flow: the user declined the request. Stop polling. |
+     * | `expired_token` | Device flow: `device_code` expired. Start again from `POST /oauth/device_authorization`. |
+     */
+    error: components.OAuthErrorCode;
+    /**
+     * A human-readable explanation, for logs rather than for end users. When a request
+     *
+     * @remarks
+     * parameter fails validation it names the parameter, as `<parameter>: <message>`.
+     */
+    errorDescription?: string | undefined;
+    /** The original data that was passed to this error instance. */
+    data$: OAuthErrorData;
+    constructor(err: OAuthErrorData, httpMeta: {
+        response: Response;
+        request: Request;
+        body: string;
+    });
+}
+/** @internal */
+export declare const OAuthError$inboundSchema: z.ZodType<OAuthError, z.ZodTypeDef, unknown>;
+//# sourceMappingURL=oautherror.d.ts.map

package/dist/esm/models/errors/oautherror.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oautherror.d.ts","sourceRoot":"","sources":["../../../../src/models/errors/oautherror.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,KAAK,UAAU,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,EAAE,UAAU,CAAC,cAAc,CAAC;IACjC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,kBAAkB;IAChD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,EAAE,UAAU,CAAC,cAAc,CAAC;IACjC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,gEAAgE;IAChE,KAAK,EAAE,cAAc,CAAC;gBAGpB,GAAG,EAAE,cAAc,EACnB,QAAQ,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;CAcnE;AAED,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAkBL,CAAC"}