@bitzonegaming/roleplay-engine-sdk/public/api.d.ts

Roleplay Engine SDK

import { ApiOptions, EngineClient } from '../core/engine-client';
import { PublicConfig } from './models/public-config';
import { Locale } from '../locale/models/locale';
import { LocalizationData } from '../localization/models/localization';
import { CharacterGender } from '../character/models/character-gender';
import { CharacterNationality } from '../character/models/character-nationality';
import { ResendEmailVerificationRequest } from './models/resend-email-verification-request';
import { VerifyEmailRequest } from './models/verify-email-request';
import { ForgotPasswordRequest } from './models/forgot-password-request';
import { ResetPasswordRequest } from './models/reset-password-request';
import { ServerTemplate } from '../template/models/server-template';
export declare class PublicApi {
    private readonly client;
    constructor(client: EngineClient);
    /**
     * This endpoint retrieves public configuration for the server.
     * @summary Get public configuration
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getConfiguration(options?: ApiOptions): Promise<PublicConfig[]>;
    /**
     * This endpoint retrieves enabled locales for the server.
     * @summary Get public locales
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getLocales(options?: ApiOptions): Promise<Locale[]>;
    /**
     * This endpoint retrieves localization data for the server based on the provided path and user locale. If no path is specified, it returns the default localization for the user\'s locale.
     * @summary Get public localization
     * @param {string} [path]
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getLocalization(path?: string, options?: ApiOptions): Promise<LocalizationData>;
    /**
     * This endpoint retrieves public character genders for the server.
     * @summary Get public character genders
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterGenders(options?: ApiOptions): Promise<CharacterGender[]>;
    /**
     * This endpoint retrieves public character nationalities for the server.
     * @summary Get public character nationalities
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterNationalities(options?: ApiOptions): Promise<CharacterNationality[]>;
    /**
     * Resend an e-mail verification link to the specified e-mail address. This is useful if the user did not receive the original verification email or if it has expired.
     * @summary Resend e-mail verification
     * @param {ResendEmailVerificationRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    resendEmailVerification(request: ResendEmailVerificationRequest, options?: ApiOptions): Promise<void>;
    /**
     * Verify the e-mail address associated with the account using the provided token. This is typically done after the user clicks on a verification link sent to their e-mail address.
     * @summary Verify e-mail address
     * @param {VerifyEmailRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    verifyEmail(request: VerifyEmailRequest, options?: ApiOptions): Promise<void>;
    /**
     * Request a password reset for the specified e-mail address. This will send a password reset link to the user\'s e-mail, allowing them to set a new password.
     * @summary Forgot password
     * @param {ForgotPasswordRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    forgotPassword(request: ForgotPasswordRequest, options?: ApiOptions): Promise<void>;
    /**
     * Reset the password for the account using the provided token. This is typically done after the user clicks on a password reset link sent to their e-mail address.
     * @summary Reset password
     * @param {ResetPasswordRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    resetPassword(request: ResetPasswordRequest, options?: ApiOptions): Promise<void>;
    /**
     * It returns a list of templates for the server.
     * @summary Get public templates
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getTemplates(options?: ApiOptions): Promise<ReadonlyArray<ServerTemplate>>;
}