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

package/dist/error-catalog.js

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

package/dist/events.d.ts

@@ -1,16 +1,13 @@
 import { z } from "zod";
-export declare const webhookEventTypes: readonly ["brand.completed", "brand.updated", "asset.ready", "asset.regenerated", "job.failed", "credits.low", "credits.settled", "subscription.changed"];
+export declare const webhookEventTypes: readonly ["brand.completed", "asset.ready", "asset.regenerated", "job.failed", "credits.low"];
 export declare const webhookEnvelopeSchema: z.ZodObject<{
     id: z.ZodString;
     type: z.ZodEnum<{
         "brand.completed": "brand.completed";
-        "brand.updated": "brand.updated";
         "asset.ready": "asset.ready";
         "asset.regenerated": "asset.regenerated";
         "job.failed": "job.failed";
         "credits.low": "credits.low";
-        "credits.settled": "credits.settled";
-        "subscription.changed": "subscription.changed";
     }>;
     created_at: z.ZodString;
     data: z.ZodRecord<z.ZodString, z.ZodUnknown>;

package/dist/events.js

@@ -1,13 +1,10 @@
 import { z } from "zod";
 export const webhookEventTypes = [
     "brand.completed",
-    "brand.updated",
     "asset.ready",
     "asset.regenerated",
     "job.failed",
     "credits.low",
-    "credits.settled",
-    "subscription.changed",
 ];
 export const webhookEnvelopeSchema = z.object({
     id: z.string(),

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from "./catalog.js";
 export * from "./consent.js";
 export * from "./creative-direction.js";
 export * from "./credits.js";
+export * from "./error-catalog.js";
 export * from "./errors.js";
 export * from "./events.js";
 export * from "./ids.js";

package/dist/index.js

@@ -6,6 +6,7 @@ export * from "./catalog.js";
 export * from "./consent.js";
 export * from "./creative-direction.js";
 export * from "./credits.js";
+export * from "./error-catalog.js";
 export * from "./errors.js";
 export * from "./events.js";
 export * from "./ids.js";