@idelio/contracts 0.1.0-beta.0 → 0.1.0-beta.1

package/dist/error-catalog.d.ts

@@ -0,0 +1,628 @@
+import type { errorTypes } from "./errors.js";
+export type ErrorType = (typeof errorTypes)[number];
+export interface ErrorCatalogEntry {
+    type: ErrorType;
+    status: readonly number[];
+    title: string;
+    description: string;
+    resolution: string;
+}
+export declare const errorCatalog: {
+    readonly required_assets_missing: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "Required asset kinds are missing";
+        readonly description: "Every new brand includes five asset kinds - logo, logo_alternative, logo_wordmark, color_palette and font_pairing - and the assets list in this request leaves out at least one of them. The message names the missing kinds.";
+        readonly resolution: "Add the missing kinds to assets, or leave assets out entirely to get exactly the five. Other kinds can be added on top.";
+    };
+    readonly unsupported_size: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [415];
+        readonly title: "The asset was not rendered at that size";
+        readonly description: "Favicons and app icons come pre-rendered at a fixed set of sizes, and nothing is resized on request. The size you asked for is not one of them; the message lists the sizes this asset has.";
+        readonly resolution: "Request one of the sizes the message lists, or omit size to get the asset's default file.";
+    };
+    readonly session_required: {
+        readonly type: "permission_error";
+        readonly status: readonly [403];
+        readonly title: "This action needs a signed-in user";
+        readonly description: "The operation acts on behalf of a person - billing, members, API keys, workspace settings - and an API key acts for the workspace, not a person, so it can never call it.";
+        readonly resolution: "Do this in the Idelio app while signed in. The SDK exposes no method for these operations.";
+    };
+    readonly already_a_member: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "That person is already a member";
+        readonly description: "The invite or add-member request named a person who already belongs to this workspace.";
+        readonly resolution: "No action is needed - the person already has access. Check the workspace's member list.";
+    };
+    readonly already_generating: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "That suggestion is already generating";
+        readonly description: "The asset a suggestion card points at is already being produced by a job that has not finished yet, so generating it again was refused.";
+        readonly resolution: "Wait for the running job to finish, then check the brand's assets or suggestions again.";
+    };
+    readonly already_on_this_plan: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "The workspace is already on that plan";
+        readonly description: "The checkout or subscription-change request named the price the workspace is subscribed to already.";
+        readonly resolution: "Pick a different plan's price id, or skip the change if the current plan is the intended one.";
+    };
+    readonly already_refunded: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This reservation was already refunded";
+        readonly description: "A credit reservation can be settled or refunded exactly once. This one was already refunded, so it cannot be acted on again.";
+        readonly resolution: "This indicates the request replayed an operation that already completed. If the underlying job or asset still looks stuck, report it with the request_id.";
+    };
+    readonly already_settled: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This reservation was already settled";
+        readonly description: "A credit reservation can be settled or refunded exactly once. This one was already settled, so it cannot be acted on again.";
+        readonly resolution: "This indicates the request replayed an operation that already completed. If the underlying job or asset still looks stuck, report it with the request_id.";
+    };
+    readonly api_key_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No active API key with that id";
+        readonly description: "The API key id in the request does not match an active key on this workspace - it may be revoked or never existed.";
+        readonly resolution: "Check the key id, or list the workspace's keys to find the right one.";
+    };
+    readonly asset_already_exists: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "The brand already has this asset kind";
+        readonly description: "An expand request asked for one or more asset kinds the brand already owns. The message names which ones.";
+        readonly resolution: "Use refine or regenerate on the existing asset instead of expanding for a kind the brand already has.";
+    };
+    readonly asset_kind_does_not_support_instructions: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This asset kind takes no refine/variation instructions";
+        readonly description: "Free-text refine or variation instructions are not supported for this asset's kind yet.";
+        readonly resolution: "Omit the instructions field for this kind, or regenerate the asset without it.";
+    };
+    readonly asset_kind_not_expandable: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This asset kind cannot be expanded";
+        readonly description: "The expand endpoint only produces certain asset kinds - notably not logo, which has its own dedicated generation and approval flow. The message names the kinds it refused.";
+        readonly resolution: "Remove the named kinds from the request, or use the kind's own dedicated endpoint if it has one.";
+    };
+    readonly asset_kind_not_priceable: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This build cannot price that asset kind";
+        readonly description: "The asset kind named in the request has no credit price in the currently deployed catalogue.";
+        readonly resolution: "This indicates a kind that predates or postdates this deployment's catalogue. Report it with the request_id.";
+    };
+    readonly asset_kind_not_regenerable: {
+        readonly type: "api_error";
+        readonly status: readonly [501];
+        readonly title: "Regeneration is not yet available for this asset kind";
+        readonly description: "Regenerate is only implemented for a subset of asset kinds so far; this one is not one of them.";
+        readonly resolution: "There is no workaround yet for this kind - check back as the catalogue of regenerable kinds grows.";
+    };
+    readonly asset_kinds_require_studio_or_elite: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "These asset kinds need a higher AI team tier";
+        readonly description: "One or more requested asset kinds are not available on the flash tier. The message names which ones.";
+        readonly resolution: "Request those kinds on a brand generated (or expanded) with a higher team tier, or drop them from the request.";
+    };
+    readonly asset_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No asset with that id";
+        readonly description: "The asset id in the request does not match an asset in this workspace.";
+        readonly resolution: "Check the asset id, or list the brand's assets to find the right one.";
+    };
+    readonly asset_not_ready: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "This asset has no downloadable files yet";
+        readonly description: "The asset exists but its generation has not produced any files yet - it may still be in progress.";
+        readonly resolution: "Wait for the asset's job to finish, then request the download again.";
+    };
+    readonly asset_not_yet_approved: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "Approve a logo concept first";
+        readonly description: "A variation was requested of a logo concept before any concept on this brand was approved.";
+        readonly resolution: "Approve a logo concept for this brand, then request the variation.";
+    };
+    readonly asset_recipe_incomplete: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This asset predates regeneration support";
+        readonly description: "The asset was generated before its kind recorded the recipe regeneration needs, so it cannot be regenerated in place.";
+        readonly resolution: "Regenerate the full brand (or, for a logo-derived kind, the logo) to get an asset that can be regenerated on its own.";
+    };
+    readonly asset_version_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No matching asset version for that job";
+        readonly description: "The asset_version_id in the request does not match a logo concept (or other version) recorded against this job.";
+        readonly resolution: "Re-read the job's logo concepts and use one of the asset_version_id values it lists.";
+    };
+    readonly bad_request: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [400];
+        readonly title: "The request could not be processed";
+        readonly description: "A generic 400 raised without a more specific code - the request was malformed in a way none of the catalogue's other 4xx codes describe.";
+        readonly resolution: "Check the request body and query parameters against the OpenAPI document for this operation.";
+    };
+    readonly brand_asset_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "The brand has no such asset yet";
+        readonly description: "The brand export or download you requested needs an asset the brand does not have yet - for example a logo, a rendered PNG, a guidelines PDF or a wordmark.";
+        readonly resolution: "Generate or expand the brand to produce the missing asset first, then request the export again.";
+    };
+    readonly brand_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No brand with that id";
+        readonly description: "The brand id in the request does not match a brand in this workspace.";
+        readonly resolution: "Check the brand id, or list the workspace's brands to find the right one.";
+    };
+    readonly brand_not_ready: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "The brand has not finished generating";
+        readonly description: "The brand's DNA (or its current version) has not been frozen yet - its generation job must complete first.";
+        readonly resolution: "Wait for the brand's generation job to finish, then request this operation again.";
+    };
+    readonly checkout_session_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No checkout session with that id";
+        readonly description: "The checkout session id in the request does not match a session created for this workspace.";
+        readonly resolution: "Check the session id, or start a new checkout session.";
+    };
+    readonly clerk_error: {
+        readonly type: "api_error";
+        readonly status: readonly [502];
+        readonly title: "The identity provider could not complete this request";
+        readonly description: "A call to the identity provider behind sign-in and organizations failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly colors_locked: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This brand's color palette is locked";
+        readonly description: "A generation lock is pinning the brand's color palette, so it cannot be regenerated while the lock is on.";
+        readonly resolution: "Unlock the color palette in the brand's DNA, then regenerate it.";
+    };
+    readonly conflict: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "The request conflicts with the resource's current state";
+        readonly description: "A generic 409 raised without a more specific code - the operation cannot be completed given the resource's current state.";
+        readonly resolution: "Re-read the resource's current state and retry the operation if it still applies.";
+    };
+    readonly creative_directions_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't rank the creative directions";
+        readonly description: "The model call that ranks candidate creative directions for a brand failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly custom_image_must_be_alone: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "custom_image cannot be combined with other kinds";
+        readonly description: "A request's assets list included custom_image alongside one or more other asset kinds, which is not allowed.";
+        readonly resolution: "Send a request with assets set to exactly [\"custom_image\"], and request the other kinds separately.";
+    };
+    readonly custom_image_name_not_allowed: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "custom_image_name is only valid for a custom_image request";
+        readonly description: "The custom_image_name field was set on a request whose assets is not exactly [\"custom_image\"].";
+        readonly resolution: "Only send custom_image_name when assets is exactly [\"custom_image\"]; otherwise omit it.";
+    };
+    readonly custom_image_prompt_required: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "A prompt is required for a custom image";
+        readonly description: "The request asked for a custom_image asset without supplying custom_image_prompt.";
+        readonly resolution: "Include custom_image_prompt describing the image to generate.";
+    };
+    readonly dna_token_kinds_must_be_alone: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "color_palette/font_pairing cannot be combined with other kinds";
+        readonly description: "Expanding color_palette or font_pairing regenerates a DNA token in a new brand version, and cannot be requested alongside any other asset kind in the same request.";
+        readonly resolution: "Send color_palette or font_pairing alone, and request other kinds in a separate call.";
+    };
+    readonly icon_locked: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This brand's icon is locked";
+        readonly description: "A generation lock is pinning the brand's logo icon, so it cannot be regenerated while the lock is on.";
+        readonly resolution: "Unlock the icon in the brand's DNA, then regenerate the logo.";
+    };
+    readonly idempotency_key_required: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [400];
+        readonly title: "An Idempotency-Key header is required";
+        readonly description: "Paid generation routes require an Idempotency-Key header so a retried request cannot be charged twice.";
+        readonly resolution: "Send an Idempotency-Key header - any unique string you generate per attempt is fine; a retried attempt should reuse the same key.";
+    };
+    readonly insufficient_credits: {
+        readonly type: "payment_error";
+        readonly status: readonly [402];
+        readonly title: "Not enough credits for this operation";
+        readonly description: "The workspace does not have enough credits to reserve for the requested generation.";
+        readonly resolution: "Buy more credits or wait for the plan's next refill, then retry the request.";
+    };
+    readonly insufficient_role: {
+        readonly type: "permission_error";
+        readonly status: readonly [403];
+        readonly title: "Your role does not allow this action";
+        readonly description: "The signed-in user's role in this workspace is below the role this action requires. The message names the required role.";
+        readonly resolution: "Ask a workspace owner or admin to perform this action, or to raise your role.";
+    };
+    readonly insufficient_scope: {
+        readonly type: "permission_error";
+        readonly status: readonly [403];
+        readonly title: "This API key is missing a required scope";
+        readonly description: "The API key used for this request does not carry the scope this action requires. The message names the required scope.";
+        readonly resolution: "Create or use an API key that includes the required scope.";
+    };
+    readonly internal_error: {
+        readonly type: "api_error";
+        readonly status: readonly [500];
+        readonly title: "Something went wrong on our side";
+        readonly description: "An unexpected error occurred while handling the request, and it was not one this catalogue names more specifically.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly invalid_amount: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [400];
+        readonly title: "The amount is not valid";
+        readonly description: "A credits amount in the request must be a non-negative integer (or, for a top-up, a positive integer), and it was not.";
+        readonly resolution: "Send a whole, non-negative number for the amount field (positive for a top-up).";
+    };
+    readonly invalid_api_key: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "The API key is not valid";
+        readonly description: "The API key on the request is unknown, has been revoked, or its workspace no longer exists.";
+        readonly resolution: "Use a current, active API key for an existing workspace. Create a new one in the Idelio app if needed.";
+    };
+    readonly invalid_cursor: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [400];
+        readonly title: "The pagination cursor is malformed";
+        readonly description: "The cursor query parameter on a list request could not be decoded.";
+        readonly resolution: "Only pass a cursor value exactly as returned by a previous page of the same list - never construct one by hand.";
+    };
+    readonly invalid_settlement: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This settlement does not match its reservation";
+        readonly description: "The amount being settled against a credit reservation is more than the reservation actually holds.";
+        readonly resolution: "This indicates an internal inconsistency between a job's reservation and its settlement. Report it with the request_id.";
+    };
+    readonly invalid_signature: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "The webhook signature could not be verified";
+        readonly description: "An inbound webhook (from the billing provider or the identity provider) arrived with a signature that does not match its payload.";
+        readonly resolution: "This is not something an integrator can resolve on our webhooks. If you operate your own webhook endpoint and see this from us, verify the signing secret you configured matches ours.";
+    };
+    readonly invalid_target: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "That export target is not supported";
+        readonly description: "The target query parameter on a brand export request did not name one of the supported export targets.";
+        readonly resolution: "Use one of the supported target values documented for this endpoint.";
+    };
+    readonly invalid_token: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "The session token could not be verified";
+        readonly description: "The bearer token on the request is not a valid, current identity provider session token.";
+        readonly resolution: "Sign in again to get a fresh session token.";
+    };
+    readonly job_already_finalized: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This job has already finalized";
+        readonly description: "The job has already reached a terminal state and can no longer accept an asset retry.";
+        readonly resolution: "Start a new job (generate or expand again) instead of retrying an asset on this one.";
+    };
+    readonly job_asset_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No asset of that kind on this job";
+        readonly description: "The kind named in the request does not match any asset this job produced or is producing.";
+        readonly resolution: "Check the job's steps to find the asset kinds it actually covers.";
+    };
+    readonly job_asset_not_retryable: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This asset is not in a retryable state";
+        readonly description: "A retry was requested for a job asset that is not currently in a failed, retryable state. The message names its current state.";
+        readonly resolution: "Only retry an asset while the job reports it as failed and retryable.";
+    };
+    readonly job_not_awaiting_logo_selection: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This job is not awaiting a logo selection";
+        readonly description: "A logo concept selection was submitted for a job that is not currently paused waiting for one.";
+        readonly resolution: "Only select a logo concept while the job's status shows it is awaiting a logo selection.";
+    };
+    readonly job_not_cancelable: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This job has already finished";
+        readonly description: "A cancel was requested for a job that already reached a terminal status. The message names that status.";
+        readonly resolution: "There is nothing to cancel - the job is no longer running.";
+    };
+    readonly job_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No job with that id";
+        readonly description: "The job id in the request does not match a job in this workspace.";
+        readonly resolution: "Check the job id, or read the brand's current job to find the right one.";
+    };
+    readonly last_owner: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "The workspace must keep at least one owner";
+        readonly description: "The requested change (removing a member or changing a role) would leave the workspace with no owner.";
+        readonly resolution: "Promote another member to owner first, then repeat this change.";
+    };
+    readonly lockup_not_available: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This brand has no lockup yet";
+        readonly description: "The brand's logo predates the pipeline producing a lockup file, so variant=lockup has nothing to return.";
+        readonly resolution: "Regenerate the logo to get a lockup, or request variant=mark instead.";
+    };
+    readonly logo_concept_preview_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't render that logo concept preview";
+        readonly description: "The render that produces a logo concept's preview image failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly logo_not_approved: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This brand has no approved logo yet";
+        readonly description: "The requested asset kind renders from the brand's approved logo mark, and this brand has not approved a logo concept yet.";
+        readonly resolution: "Approve a logo concept for this brand, then request the asset kind again.";
+    };
+    readonly logo_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "This brand has no approved logo yet";
+        readonly description: "The endpoint reads the brand's approved logo treatment, and this brand has not approved a logo concept yet.";
+        readonly resolution: "Approve a logo concept for this brand, then call this endpoint again.";
+    };
+    readonly logo_not_raster: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This brand's logo predates raster generation";
+        readonly description: "The brand's approved logo is a vector-only mark from before the raster-only logo pipeline, and cannot render the requested kind.";
+        readonly resolution: "Regenerate the logo to get a raster mark, then request the asset kind again.";
+    };
+    readonly member_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No member with that user id";
+        readonly description: "The user id in the request does not match a member of this workspace.";
+        readonly resolution: "Check the user id, or list the workspace's members to find the right one.";
+    };
+    readonly missing_authorization: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "No Authorization header was sent";
+        readonly description: "The request carried no Authorization header at all.";
+        readonly resolution: "Send an Authorization: Bearer header with either a session token or an API key.";
+    };
+    readonly name_ideas_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't come up with names";
+        readonly description: "The model call that generates brand name ideas failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly no_active_subscription: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This workspace has no active subscription";
+        readonly description: "The requested billing operation needs an active subscription, and this workspace does not have one yet.";
+        readonly resolution: "Start a subscription with POST /v1/billing/checkout, then retry this operation.";
+    };
+    readonly no_billing_customer: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This workspace has never made a purchase";
+        readonly description: "The requested billing operation needs an existing billing customer record, and this workspace has none yet.";
+        readonly resolution: "Make a purchase or start a subscription first, then retry this operation.";
+    };
+    readonly not_a_membership: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "This action belongs to a signed-in user";
+        readonly description: "Onboarding-style operations act on a person's own membership and cannot be performed by an API key.";
+        readonly resolution: "Perform this action in the Idelio app while signed in. The SDK exposes no method for it.";
+    };
+    readonly organization_required: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "An active organization is required";
+        readonly description: "The signed-in session has no active organization selected, and this action needs one.";
+        readonly resolution: "Select or create an organization in the Idelio app, then retry.";
+    };
+    readonly package_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't package the files for download";
+        readonly description: "Building the requested download archive failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly preview_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't render that preview";
+        readonly description: "The render behind this preview request failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly rate_limited: {
+        readonly type: "rate_limit_error";
+        readonly status: readonly [429];
+        readonly title: "Too many requests in a short time";
+        readonly description: "The caller exceeded a rate limit - on the general API, on the free AI-assist routes, or on a public form like consent or the waitlist.";
+        readonly resolution: "Honor the Retry-After header (when present) and slow down before retrying.";
+    };
+    readonly reservation_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No credit reservation for that job";
+        readonly description: "The job id (and idempotency key, where relevant) does not match a credit reservation on record.";
+        readonly resolution: "This indicates the job never reserved credits, or the reservation was already resolved. Report it with the request_id if the job still appears to be paid work in progress.";
+    };
+    readonly resource_missing: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "The requested resource does not exist";
+        readonly description: "A generic 404 raised without a more specific code - nothing matches the id or path in the request.";
+        readonly resolution: "Check the id or path against the resource's list endpoint.";
+    };
+    readonly slug_taken: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "That slug is already in use";
+        readonly description: "The slug named in a brand update request already belongs to another brand in this workspace.";
+        readonly resolution: "Choose a different slug.";
+    };
+    readonly stripe_error: {
+        readonly type: "api_error";
+        readonly status: readonly [502];
+        readonly title: "The billing provider could not complete this request";
+        readonly description: "A call to the billing provider failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly suggestion_needs_review: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This custom asset idea needs review first";
+        readonly description: "A custom asset idea's prompt is generated from the brand page after review, and cannot be generated directly by kind.";
+        readonly resolution: "Open the brand page's suggestions and generate the custom asset idea from there.";
+    };
+    readonly suggestion_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No current suggestion for that kind";
+        readonly description: "The brand has no live suggestion card for the requested asset kind right now.";
+        readonly resolution: "Re-read the brand's current suggestions and act on one that is actually listed.";
+    };
+    readonly surprise_brief_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't come up with an idea";
+        readonly description: "The model call that generates a surprise-me brand brief failed or timed out.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly template_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No template with that id";
+        readonly description: "The template id in the request does not match a template in the catalog.";
+        readonly resolution: "Check the template id, or list the catalog's templates to find the right one.";
+    };
+    readonly too_many_running_jobs: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "Too many generations running at once";
+        readonly description: "The workspace already has as many generation jobs running as its plan allows.";
+        readonly resolution: "Wait for a running job to finish, or cancel one, then start the new one.";
+    };
+    readonly typography_locked: {
+        readonly type: "conflict_error";
+        readonly status: readonly [409];
+        readonly title: "This brand's typography is locked";
+        readonly description: "A generation lock is pinning the brand's typography, so it cannot be regenerated - or the logo's font changed - while the lock is on.";
+        readonly resolution: "Unlock typography in the brand's DNA, then retry.";
+    };
+    readonly unauthenticated: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "Sign in is required";
+        readonly description: "The requested action (recording consent, for example) requires a signed-in user and none is present.";
+        readonly resolution: "Sign in, then retry the request.";
+    };
+    readonly unknown_price_id: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "That price id is not recognized";
+        readonly description: "The price_id in the checkout or plan-change request does not match a price this deployment knows about.";
+        readonly resolution: "Use one of the price ids the plans/pricing endpoint returns.";
+    };
+    readonly unsupported_format: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [415, 422];
+        readonly title: "That file format is not available for this asset";
+        readonly description: "The requested file format (for a download, an export, or a logo/wordmark variant) does not exist for this asset - for example, no svg file was ever produced for it.";
+        readonly resolution: "Request one of the formats the asset actually has, or regenerate the asset in a way that produces the format you need.";
+    };
+    readonly validation_failed: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [400, 422];
+        readonly title: "The request body failed validation";
+        readonly description: "The request body does not match the schema this operation expects - a field is missing, of the wrong type, or otherwise invalid.";
+        readonly resolution: "Check the errors array on the envelope, if present, and fix each named field against the OpenAPI document for this operation.";
+    };
+    readonly version_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No such version";
+        readonly description: "The version named in a restore request does not exist for this brand or asset.";
+        readonly resolution: "List the resource's version history to find a version id that actually exists.";
+    };
+    readonly version_pinning_not_supported: {
+        readonly type: "invalid_request_error";
+        readonly status: readonly [422];
+        readonly title: "Pinning a version is not supported here yet";
+        readonly description: "This export always reflects the brand's current head version, and a version query parameter was supplied to pin an older one.";
+        readonly resolution: "Omit the version parameter - the export always uses the brand's current version.";
+    };
+    readonly webhook_endpoint_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No webhook endpoint with that id";
+        readonly description: "The webhook endpoint id in the request does not match one registered on this workspace.";
+        readonly resolution: "Check the endpoint id, or list the workspace's webhook endpoints to find the right one.";
+    };
+    readonly workflow_start_failed: {
+        readonly type: "api_error";
+        readonly status: readonly [503];
+        readonly title: "Couldn't start the job";
+        readonly description: "Starting the durable workflow behind this generation failed - any reserved credits were refunded.";
+        readonly resolution: "Try again. If it keeps happening, report it with the request_id.";
+    };
+    readonly workspace_deleted: {
+        readonly type: "authentication_error";
+        readonly status: readonly [401];
+        readonly title: "This workspace has been deleted";
+        readonly description: "The session's workspace has been deleted and can no longer be used.";
+        readonly resolution: "Sign in to (or create) a different workspace.";
+    };
+    readonly workspace_not_found: {
+        readonly type: "not_found_error";
+        readonly status: readonly [404];
+        readonly title: "No workspace with that id";
+        readonly description: "The workspace id in the request does not match a workspace this credential can access.";
+        readonly resolution: "Check the workspace id, or use GET /v1/me to find the workspace your credential is scoped to.";
+    };
+};
+export type ErrorCode = keyof typeof errorCatalog;