Function UserApiAxiosParamCreator

UserApi - axios parameter creator

Export

  • UserApiAxiosParamCreator(configuration?): {
        userControllerAssignRole: ((id: string, roleId: string, userRoleAssignChangeDTO?: UserRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerCreate: ((userCreateInputDTO?: UserCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerDeleteSelectedDomainCookie: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerInvite: ((inviteCreateDTO?: InviteCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLinkPlayerProfile: ((linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLogin: ((loginDTO?: LoginDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLogout: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerRemoveRole: ((id: string, roleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerSearch: ((userSearchInputDTO?: UserSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerSetSelectedDomain: ((domainId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerUpdate: ((id: string, userUpdateDTO?: UserUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        userControllerAssignRole: ((id: string, roleId: string, userRoleAssignChangeDTO?: UserRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerCreate: ((userCreateInputDTO?: UserCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerDeleteSelectedDomainCookie: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerInvite: ((inviteCreateDTO?: InviteCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLinkPlayerProfile: ((linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLogin: ((loginDTO?: LoginDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerLogout: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerRemoveRole: ((id: string, roleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerSearch: ((userSearchInputDTO?: UserSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerSetSelectedDomain: ((domainId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        userControllerUpdate: ((id: string, userUpdateDTO?: UserUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • userControllerAssignRole: ((id: string, roleId: string, userRoleAssignChangeDTO?: UserRoleAssignChangeDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS, MANAGE_ROLES

      Summary

      Assign role

      Throws

        • (id, roleId, userRoleAssignChangeDTO?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • roleId: string
          • OptionaluserRoleAssignChangeDTO: UserRoleAssignChangeDTO

            UserRoleAssignChangeDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerCreate: ((userCreateInputDTO?: UserCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS

      Summary

      Create

      Throws

        • (userCreateInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaluserCreateInputDTO: UserCreateInputDTO

            UserCreateInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerDeleteSelectedDomainCookie: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Unset the selected domain for the user

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_USERS

      Summary

      Get one

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerInvite: ((inviteCreateDTO?: InviteCreateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS

      Summary

      Invite

      Throws

        • (inviteCreateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalinviteCreateDTO: InviteCreateDTO

            InviteCreateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerLinkPlayerProfile: ((linkPlayerUnauthedInputDTO?: LinkPlayerUnauthedInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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.

      Summary

      Link player profile

      Throws

        • (linkPlayerUnauthedInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionallinkPlayerUnauthedInputDTO: LinkPlayerUnauthedInputDTO

            LinkPlayerUnauthedInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerLogin: ((loginDTO?: LoginDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Login

      Throws

        • (loginDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalloginDTO: LoginDTO

            LoginDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerLogout: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Logout

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerMe: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      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

      Summary

      Get the current logged in user

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS

      Summary

      Remove

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerRemoveRole: ((id: string, roleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS, MANAGE_ROLES

      Summary

      Remove role

      Throws

        • (id, roleId, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • roleId: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerSearch: ((userSearchInputDTO?: UserSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_USERS

      Summary

      Search

      Throws

        • (userSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionaluserSearchInputDTO: UserSearchInputDTO

            UserSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerSetSelectedDomain: ((domainId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

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

      Summary

      Set the selected domain for the user

      Throws

        • (domainId, options?): Promise<RequestArgs>

        • Parameters

          • domainId: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • userControllerUpdate: ((id: string, userUpdateDTO?: UserUpdateDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_USERS

      Summary

      Update

      Throws

        • (id, userUpdateDTO?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • OptionaluserUpdateDTO: UserUpdateDTO

            UserUpdateDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility