@yeci226/hoyoapi/dist/types/module/redeem/redeem.d.ts

HoYoAPI is an unofficial API Wrapper library developed to facilitate communication with the official HoYoLab API.

import { GamesEnum } from '../../client/hoyolab';
import { LanguageEnum } from '../../language';
import { HTTPRequest } from '../../request';
import { IRedeemCode } from './redeem.interface';
/**
 * Class representing the Redeem module for Genshin Impact's Hoyolab API.
 *
 * @public
 * @internal
 * @category Module
 */
export declare class RedeemModule {
    private request;
    private lang;
    private game;
    private region;
    private uid;
    /**
     * Constructs a new RedeemModule object.
     * @param request - The Request object used for making HTTP requests.
     * @param lang - The language to use for the API response.
     * @param game - The game to redeem the code for.
     * @param region - The region of the user's account. If null, the API will use the default region for the game.
     * @param uid - The user ID of the account. If null, the API will use the user ID associated with the provided auth cookies.
     */
    constructor(request: HTTPRequest, lang: LanguageEnum, game: GamesEnum, region: string | null, uid: number | null);
    /**
     * Redeems a code for a specific game and account.
     *
     * @param code - The code to redeem.
     * @returns A promise that resolves to an IRedeemCode object containing information about the redemption status.
     * @throws HoyoAPIError if the API returns an error.
     * @remarks
     * This method sends a request to the Genshin Impact API to get the daily note information for a user.
     * The user's region and UID must be set before calling this method, otherwise an error will be thrown.
     */
    claim(code: string): Promise<IRedeemCode>;
}