Hierarchy (view full)

Constructors

  • Parameters

    • body: {
          error?: {
              code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled";
              message: string;
          };
      }
      • Optional error?: {
            code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled";
            message: string;
        }

        Common403ErrorResponse

        • code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled"

          Description

          Error code:

          • TokenRequired - Auth-API-Key header is missing or empty
          • TokenNotFound - No Fingerprint application found for specified secret key
          • SubscriptionNotActive - Fingerprint application is not active
          • WrongRegion - server and application region differ
          • FeatureNotEnabled - this feature (for example, Delete API) is not enabled for your application

          Example

          TokenRequired
          @enum {string}
        • message: string

          Example

          secret key is required
          
    • response: Response

    Returns DeleteVisit403Error

Properties

cause?: unknown
errorCode: string
message: string
name: string
response: Response
responseBody: {
    error?: {
        code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled";
        message: string;
    };
}

Type declaration

  • Optional error?: {
        code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled";
        message: string;
    }

    Common403ErrorResponse

    • code: "TokenRequired" | "TokenNotFound" | "SubscriptionNotActive" | "WrongRegion" | "FeatureNotEnabled"

      Description

      Error code:

      • TokenRequired - Auth-API-Key header is missing or empty
      • TokenNotFound - No Fingerprint application found for specified secret key
      • SubscriptionNotActive - Fingerprint application is not active
      • WrongRegion - server and application region differ
      • FeatureNotEnabled - this feature (for example, Delete API) is not enabled for your application

      Example

      TokenRequired
      @enum {string}
    • message: string

      Example

      secret key is required
      
stack?: string
statusCode: 403
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void