Class UserApi

UserApi - object-oriented interface

Export

UserApi

Hierarchy

  • BaseAPI
    • UserApi

Constructors

constructor

Properties

axios basePath configuration

Methods

userControllerAssignRole userControllerCreate userControllerDeleteSelectedDomainCookie userControllerGetOne userControllerInvite userControllerLinkPlayerProfile userControllerLogin userControllerLogout userControllerMe userControllerRemove userControllerRemoveRole userControllerSearch userControllerSetSelectedDomain userControllerUpdate

Constructors

constructor

  • new UserApi(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): UserApi

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns UserApi

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

userControllerAssignRole

userControllerCreate

userControllerDeleteSelectedDomainCookie

  • userControllerDeleteSelectedDomainCookie(
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<void>>

  • Unset the selected domain for the user, this will clear the domain cookie. On the next request, the backend will set this again.
    OperationId: UserControllerDeleteSelectedDomainCookie

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void>>

    Throws

    Memberof

    UserApi

userControllerGetOne

userControllerInvite

userControllerLinkPlayerProfile

  • userControllerLinkPlayerProfile(
        linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<void>>

  • Link your player profile to Takaro, allowing web access for things like shop and stats. To get the code, use the /link command in the game.
    OperationId: UserControllerLinkPlayerProfile

    Parameters

    • OptionallinkPlayerUnauthedInputDTO: LinkPlayerUnauthedInputDTO

      LinkPlayerUnauthedInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void>>

    Throws

    Memberof

    UserApi

userControllerLogin

userControllerLogout

userControllerMe

  • userControllerMe(
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<MeOutoutDTOAPI>>

  • Get the current user and the domains that the user has access to. Note that you can only make requests in the scope of a single domain. In order to switch the domain, you need to use the domain selection endpoints
    OperationId: UserControllerMe

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<MeOutoutDTOAPI>>

    Throws

    Memberof

    UserApi

userControllerRemove

userControllerRemoveRole

userControllerSearch

userControllerSetSelectedDomain

  • userControllerSetSelectedDomain(
        domainId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<void>>

  • One user can have multiple domains, this endpoint is a helper to set the selected domain for the user
    OperationId: UserControllerSetSelectedDomain

    Parameters

    • domainId: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void>>

    Throws

    Memberof

    UserApi

userControllerUpdate

Settings

Member Visibility

On This Page

Constructors
Properties
Methods