Foodtruck Order — TypeScript Reference - v0.1.0
    Preparing search index...

    Variable apiErrorCodesConst

    apiErrorCodes: {
        checkoutInProgress: "CHECKOUT_IN_PROGRESS";
        checkoutNotPaid: "CHECKOUT_NOT_PAID";
        checkoutUnresolved: "CHECKOUT_UNRESOLVED";
        conflict: "CONFLICT";
        internalError: "INTERNAL_ERROR";
        invalidCredentials: "INVALID_CREDENTIALS";
        invalidRequest: "INVALID_REQUEST";
        invalidResetCredential: "INVALID_RESET_CREDENTIAL";
        notFound: "NOT_FOUND";
        rateLimited: "RATE_LIMITED";
        unauthenticated: "UNAUTHENTICATED";
        validationFailed: "VALIDATION_FAILED";
    } = ...

    Stable, client-facing error categories shared by all HTTP endpoints.

    Type Declaration

    • ReadonlycheckoutInProgress: "CHECKOUT_IN_PROGRESS"

      A duplicate initiation was suppressed while the original operation remains pending.

    • ReadonlycheckoutNotPaid: "CHECKOUT_NOT_PAID"

      The provider definitively refused the payment, so no money was captured.

      Distinct from apiErrorCodes.conflict because certainty differs: here the application knows the order is unpaid and the operator may safely continue, while a plain conflict may hide an unresolved attempt.

    • ReadonlycheckoutUnresolved: "CHECKOUT_UNRESOLVED"

      The checkout result was never confirmed, so the attempt is durably recorded as unresolved and the caller must make no claim in either direction.

      Distinct from both apiErrorCodes.checkoutNotPaid and apiErrorCodes.conflict because it is the one checkout failure that forbids a retry: nothing here says money was captured, so charging the same attempt again could take a second payment (MVP-PAY-001-S03).

    • Readonlyconflict: "CONFLICT"

      The request conflicts with newer state.

    • ReadonlyinternalError: "INTERNAL_ERROR"

      An unexpected internal failure; the body carries no details.

    • ReadonlyinvalidCredentials: "INVALID_CREDENTIALS"

      The supplied credentials did not match an enabled user.

    • ReadonlyinvalidRequest: "INVALID_REQUEST"

      Unrecognized client input (for example an unexpected query parameter).

    • ReadonlyinvalidResetCredential: "INVALID_RESET_CREDENTIAL"

      Password-recovery credential is malformed, expired, superseded, or already consumed.

    • ReadonlynotFound: "NOT_FOUND"

      The requested resource does not exist.

    • ReadonlyrateLimited: "RATE_LIMITED"

      A bounded authentication throttle was exceeded; retry after a delay.

    • Readonlyunauthenticated: "UNAUTHENTICATED"

      No authenticated session for an endpoint that requires one.

    • ReadonlyvalidationFailed: "VALIDATION_FAILED"

      Request body failed route-level validation; see issues for details.