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

Roleplay Engine SDK

import { ApiOptions, EngineClient } from '../core/engine-client';
import { ChangeMyPasswordRequest } from './models/change-my-password-request';
import { Character } from '../character/models/character';
export declare class PlayerApi {
    private readonly client;
    constructor(client: EngineClient);
    /**
     * This endpoint changes the password of the currently authenticated account.<br/>This endpoint performs account-level operations. The token must be associated with an account.<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Change my password
     * @param {ChangeMyPasswordRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    changeMyPassword(request: ChangeMyPasswordRequest, options?: ApiOptions): Promise<void>;
    /**
     * This endpoint retrieves the currently selected character for the authenticated account.<br/>This endpoint performs character-level operations. The token must be associated with a character.<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Get my current character
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getMyCurrentCharacter(options?: ApiOptions): Promise<Character>;
}