Takaro - v0.4.9
    Preparing search index...

    Function PlayerApiAxiosParamCreator

    • PlayerApi - axios parameter creator

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          banControllerCreate: (
              banCreateDTO?: BanCreateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          banControllerDelete: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          banControllerGetOne: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          banControllerSearch: (
              banSearchInputDTO?: BanSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          banControllerUpdate: (
              id: string,
              banUpdateDTO?: BanUpdateDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerAssignRole: (
              id: string,
              roleId: string,
              playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerBulkDelete: (
              playerBulkDeleteInputDTO?: PlayerBulkDeleteInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerDelete: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerGetMe: (
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerGetOne: (
              id: string,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerRemoveRole: (
              id: string,
              roleId: string,
              playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
          playerControllerSearch: (
              playerSearchInputDTO?: PlayerSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ) => Promise<RequestArgs>;
      }

      • banControllerCreate: (
            banCreateDTO?: BanCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Create a new ban, creating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS
        OperationId: BanControllerCreate

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

        Unban player. This will remove the ban from Takaro and the gameserver(s) Required permissions: MANAGE_PLAYERS
        OperationId: BanControllerDelete

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

        Get a single ban Required permissions: READ_PLAYERS
        OperationId: BanControllerGetOne

      • banControllerSearch: (
            banSearchInputDTO?: BanSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Search for bans Required permissions: READ_PLAYERS
        OperationId: BanControllerSearch

      • banControllerUpdate: (
            id: string,
            banUpdateDTO?: BanUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Update an existing ban, updating a ban via the API will always make it takaro managed. Required permissions: MANAGE_PLAYERS
        OperationId: BanControllerUpdate

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

        Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
        OperationId: PlayerControllerAssignRole

      • playerControllerBulkDelete: (
            playerBulkDeleteInputDTO?: PlayerBulkDeleteInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Bulk delete players by their IDs. Deletes Player records which cascades to POG records. Required permissions: MANAGE_PLAYERS
        OperationId: PlayerControllerBulkDelete

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

        Required permissions: MANAGE_PLAYERS
        OperationId: PlayerControllerDelete

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

        Get the player that is currently authenticated. This is a low-privilege route, returning limited data.
        OperationId: PlayerControllerGetMe

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

        Required permissions: READ_PLAYERS
        OperationId: PlayerControllerGetOne

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

        Required permissions: MANAGE_PLAYERS, MANAGE_ROLES
        OperationId: PlayerControllerRemoveRole

      • playerControllerSearch: (
            playerSearchInputDTO?: PlayerSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>

        Required permissions: READ_PLAYERS
        OperationId: PlayerControllerSearch