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

Roleplay Engine SDK

import { ApiOptions, EngineClient } from '../core/engine-client';
import { CharacterGender } from './models/character-gender';
import { CharacterNationality } from './models/character-nationality';
import { CreateCharacterNationalityRequest } from './models/create-character-nationality-request';
import { CreateCharacterGenderRequest } from './models/create-character-gender-request';
import { UpdateCharacterNationalityOrderRequest } from './models/update-character-nationality-order-request';
import { UpdateCharacterGenderOrderRequest } from './models/update-character-gender-order-request';
import { UpdateCharacterBasicInfoRequest } from './models/update-character-basic-info-request';
import { Character } from './models/character';
export declare class CharacterApi {
    private readonly client;
    constructor(client: EngineClient);
    /**
     * Creates a new character nationality<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Create character nationality
     * @param {CreateCharacterNationalityRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    createCharacterNationality(request: CreateCharacterNationalityRequest, options?: ApiOptions): Promise<CharacterNationality>;
    /**
     * Retrieves all character nationalities<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:read:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: read:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Get character nationalities
     * @param {Object} [query] Query parameters
     * @param {boolean} [query.noCache] If `true`, bypass server cache and fetch fresh data.
     * @param {boolean} [query.enabled] Filter by enabled status.
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterNationalities(query?: {
        noCache?: boolean;
        enabled?: boolean;
    }, options?: ApiOptions): Promise<CharacterNationality[]>;
    /**
     * Retrieves a character nationality by its unique identifier<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:read:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: read:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Get character nationality by ID
     * @param {string} characterNationalityId
     * @param {Object} [query] Query parameters
     * @param {boolean} [query.noCache] If `true`, bypass server cache and fetch fresh data.
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterNationalityById(characterNationalityId: string, query?: {
        noCache?: boolean;
    }, options?: ApiOptions): Promise<CharacterNationality>;
    /**
     * Enables a character nationality, making it available for use<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Enable character nationality
     * @param {string} characterNationalityId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    enableCharacterNationality(characterNationalityId: string, options?: ApiOptions): Promise<void>;
    /**
     * Disables a character nationality, making it unavailable for use<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Disable character nationality
     * @param {string} characterNationalityId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    disableCharacterNationality(characterNationalityId: string, options?: ApiOptions): Promise<void>;
    /**
     * Updates the order of a character nationality<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Update character nationality order
     * @param {string} characterNationalityId
     * @param {UpdateCharacterNationalityOrderRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    updateCharacterNationalityOrder(characterNationalityId: string, request: UpdateCharacterNationalityOrderRequest, options?: ApiOptions): Promise<void>;
    /**
     * Creates a new character gender<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Create character gender
     * @param {CreateCharacterNationalityRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    createCharacterGender(request: CreateCharacterGenderRequest, options?: ApiOptions): Promise<CharacterNationality>;
    /**
     * Retrieves all character genders<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:read:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: read:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Get character genders
     * @param {Object} [query] Query parameters
     * @param {boolean} [query.noCache] If `true`, bypass server cache and fetch fresh data.
     * @param {boolean} [query.enabled] Filter by enabled status.
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterGenders(query?: {
        noCache?: boolean;
        enabled?: boolean;
    }, options?: ApiOptions): Promise<CharacterGender[]>;
    /**
     * Retrieves a character gender by its unique identifier<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:read:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: read:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Get character gender by ID
     * @param {string} characterGenderId
     * @param {Object} [query] Query parameters
     * @param {boolean} [query.noCache] If `true`, bypass server cache and fetch fresh data.
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    getCharacterGenderById(characterGenderId: string, query?: {
        noCache?: boolean;
    }, options?: ApiOptions): Promise<CharacterGender>;
    /**
     * Enables a character gender, making it available for use<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Enable character gender
     * @param {string} characterGenderId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    enableCharacterGender(characterGenderId: string, options?: ApiOptions): Promise<void>;
    /**
     * Disables a character gender, making it unavailable for use<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Disable character gender
     * @param {string} characterGenderId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    disableCharacterGender(characterGenderId: string, options?: ApiOptions): Promise<void>;
    /**
     * Updates the order of a character gender<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:configuration<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:configuration<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Update character gender order
     * @param {string} characterGenderId
     * @param {UpdateCharacterGenderOrderRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    updateCharacterGenderOrder(characterGenderId: string, request: UpdateCharacterGenderOrderRequest, options?: ApiOptions): Promise<void>;
    /**
     * Updates the basic information of a character<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:character<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:character<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Update character basic info
     * @param {string} characterId
     * @param {UpdateCharacterBasicInfoRequest} request
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    updateCharacterBasicInfo(characterId: string, request: UpdateCharacterBasicInfoRequest, options?: ApiOptions): Promise<Character>;
    /**
     * Activates a character, making it available for gameplay<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:character<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:character<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Activate character
     * @param {string} characterId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    activateCharacter(characterId: string, options?: ApiOptions): Promise<void>;
    /**
     * Deactivates a character, making it unavailable for gameplay<br/>This endpoint performs server-level operations. The token does not need to be associated with any account or character.<br/><b>Account Policies</b>: account_policy:write:character<br/><br/> This endpoint requires authorization, and supports following token types:<br/>🔓 [API Key] <b>Required Scopes</b>: write:character<br/>🔓 [SSO Token]<br/>🔓 [Access Token]<br/>🔓 [Session Token]
     * @summary Deactivate character
     * @param {string} characterId
     * @param {*} [options] Override http request option.
     * @throws {EngineError}
     */
    deactivateCharacter(characterId: string, options?: ApiOptions): Promise<void>;
}