@pddo/firefox-api/dist/index.d.ts

Firefox 接码平台 SDK

import { FirefoxApiConfig, LoginParams, LoginResponse, AccountInfoResponse, GetPhoneParams, GetPhoneResponse, GetMessageParams, GetMessageResponse, SendSmsParams, SendSmsResponse, GetSmsStatusParams, GetSmsStatusResponse, ReleasePhoneParams, BlacklistPhoneParams, ApiReturnParams, SetAgainParams, GetItemParams, GetItemResponse, BaseResponse, ERROR_CODES } from './types';
/**
 * Firefox 接码平台 SDK
 * 提供完整的 API 接口封装
 */
export declare class FirefoxApi {
    private client;
    private baseUrl;
    private token?;
    constructor(config?: FirefoxApiConfig);
    /**
     * 设置请求重试拦截器
     */
    private setupRetryInterceptor;
    /**
     * 解析 API 响应
     */
    private parseApiResponse;
    /**
     * 发送 API 请求
     */
    private request;
    /**
     * 登录获取 Token
     * @param params 登录参数
     * @returns 登录响应
     */
    login(params: LoginParams): Promise<LoginResponse>;
    /**
     * 获取账户信息
     * @returns 账户信息响应
     */
    getAccountInfo(): Promise<AccountInfoResponse>;
    /**
     * 获取手机号
     * @param params 获取手机号参数
     * @returns 获取手机号响应
     */
    getPhone(params: GetPhoneParams): Promise<GetPhoneResponse>;
    /**
     * 获取验证码
     * @param params 获取验证码参数
     * @returns 获取验证码响应
     */
    getMessage(params: GetMessageParams): Promise<GetMessageResponse>;
    /**
     * 从短信内容中提取验证码
     */
    private extractVerificationCode;
    /**
     * 发送短信
     * @param params 发送短信参数
     * @returns 发送短信响应
     */
    sendSms(params: SendSmsParams): Promise<SendSmsResponse>;
    /**
     * 获取发短信回执
     * @param params 获取发短信回执参数
     * @returns 获取发短信回执响应
     */
    getSmsStatus(params: GetSmsStatusParams): Promise<GetSmsStatusResponse>;
    /**
     * 释放手机号
     * @param params 释放手机号参数
     * @returns 基础响应
     */
    releasePhone(params: ReleasePhoneParams): Promise<BaseResponse>;
    /**
     * 加黑手机号
     * @param params 加黑手机号参数
     * @returns 基础响应
     */
    blacklistPhone(params: BlacklistPhoneParams): Promise<BaseResponse>;
    /**
     * 状态反馈
     * @param params 状态反馈参数
     * @returns 基础响应
     */
    apiReturn(params: ApiReturnParams): Promise<BaseResponse>;
    /**
     * 再次使用手机号
     * @param params 再次使用参数
     * @returns 基础响应
     */
    setAgain(params: SetAgainParams): Promise<BaseResponse>;
    /**
     * 获取价目表
     * @param params 获取价目表参数
     * @returns 获取价目表响应
     */
    getItemList(params?: GetItemParams): Promise<GetItemResponse>;
    /**
     * 设置 Token
     * @param token Token 值
     */
    setToken(token: string): void;
    /**
     * 获取当前 Token
     * @returns 当前 Token
     */
    getToken(): string | undefined;
    /**
     * 清除 Token
     */
    clearToken(): void;
}
export * from './types';
export { ERROR_CODES };
export default FirefoxApi;
//# sourceMappingURL=index.d.ts.map