Function PlayerApiAxiosParamCreator

PlayerApi - axios parameter creator

Export

  • PlayerApiAxiosParamCreator(configuration?): {
        playerControllerAssignRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, 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>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        playerControllerAssignRole: ((id: string, roleId: string, playerRoleAssignChangeDTO?: PlayerRoleAssignChangeDTO, 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>);
    }

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

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

      Summary

      Assign role

      Throws

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

        • Parameters

          • id: string
          • roleId: string
          • OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO

            PlayerRoleAssignChangeDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

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

      Summary

      Get current player

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Required permissions: READ_PLAYERS

      Summary

      Get one

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Required permissions: MANAGE_PLAYERS, MANAGE_ROLES

      Summary

      Remove role

      Throws

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

        • Parameters

          • id: string
          • roleId: string
          • OptionalplayerRoleAssignChangeDTO: PlayerRoleAssignChangeDTO

            PlayerRoleAssignChangeDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Required permissions: READ_PLAYERS

      Summary

      Search

      Throws

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

        • Parameters

          • OptionalplayerSearchInputDTO: PlayerSearchInputDTO

            PlayerSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility