firebase-admin/lib/phone-number-verification/error.d.ts

Firebase admin SDK for Node.js

/*! firebase-admin v14.0.0 */
/*!
 * Copyright 2026 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { FirebaseError, ErrorInfo } from '../utils/error';
/**
 * The constant mapping for valid Phone Number Verification client error codes.
 */
export declare const PhoneNumberVerificationErrorCode: {
    readonly INVALID_ARGUMENT: "invalid-argument";
    readonly INVALID_TOKEN: "invalid-token";
    readonly EXPIRED_TOKEN: "expired-token";
};
/**
 * The type definition for valid Phone Number Verification client error codes.
 */
export type PhoneNumberVerificationErrorCode = typeof PhoneNumberVerificationErrorCode[keyof typeof PhoneNumberVerificationErrorCode];
export declare const FPNV_ERROR_CODE_MAPPING: {
    readonly INVALID_ARGUMENT: "invalid-argument";
    readonly INVALID_TOKEN: "invalid-token";
    readonly EXPIRED_TOKEN: "expired-token";
};
/**
 * Firebase Phone Number Verification error code structure. This extends `FirebaseError`.
 *
 * @param info - The error code info.
 * @param message - The error message. If provided, this will override the default message.
 */
export declare class FirebasePhoneNumberVerificationError extends FirebaseError {
    constructor(info: ErrorInfo, message?: string);
}