Takaro - v0.6.0
    Preparing search index...

    Function TrackingApiFp

    • TrackingApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          trackingControllerGetBoundingBoxPlayers(
              boundingBoxSearchInputDTO?: BoundingBoxSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >;
          trackingControllerGetPlayerInventoryHistory(
              playerInventoryHistoryInputDTO?: PlayerInventoryHistoryInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerInventoryArrayOutputDTOAPI>,
          >;
          trackingControllerGetPlayerMovementHistory(
              playerMovementHistoryInputDTO?: PlayerMovementHistoryInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >;
          trackingControllerGetPlayersByItem(
              playersByItemInputDTO?: PlayersByItemInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerItemHistoryArrayOutputDTOAPI>,
          >;
          trackingControllerGetRadiusPlayers(
              radiusSearchInputDTO?: RadiusSearchInputDTO,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >;
      }

      • trackingControllerGetBoundingBoxPlayers: function
        • Find all players within a 3D rectangular volume at a specific time Required permissions: READ_PLAYERS
          OperationId: TrackingControllerGetBoundingBoxPlayers

          Parameters

          • OptionalboundingBoxSearchInputDTO: BoundingBoxSearchInputDTO

            BoundingBoxSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >

      • trackingControllerGetPlayerInventoryHistory: function
      • trackingControllerGetPlayerMovementHistory: function
        • Get movement history for players within date bounds Required permissions: READ_PLAYERS
          OperationId: TrackingControllerGetPlayerMovementHistory

          Parameters

          • OptionalplayerMovementHistoryInputDTO: PlayerMovementHistoryInputDTO

            PlayerMovementHistoryInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >

      • trackingControllerGetPlayersByItem: function
        • Find all players who have had a specific item in their inventory Required permissions: READ_PLAYERS
          OperationId: TrackingControllerGetPlayersByItem

          Parameters

          • OptionalplayersByItemInputDTO: PlayersByItemInputDTO

            PlayersByItemInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerItemHistoryArrayOutputDTOAPI>,
          >

      • trackingControllerGetRadiusPlayers: function
        • Find all players within a spherical area from a center point Required permissions: READ_PLAYERS
          OperationId: TrackingControllerGetRadiusPlayers

          Parameters

          • OptionalradiusSearchInputDTO: RadiusSearchInputDTO

            RadiusSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<PlayerLocationArrayOutputDTOAPI>,
          >