Package com.chrt.api.resources.tracking.sessionbydevice

Class AsyncSessionByDeviceClient

  • public class AsyncSessionByDeviceClient
extends java.lang.Object

    • Constructor Detail

      • AsyncSessionByDeviceClient

        public AsyncSessionByDeviceClient​(ClientOptions clientOptions)

    • Method Detail

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<Session1>> listV1()
        Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<Session1>> listV1​(RequestOptions requestOptions)
        Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

      • getV1

        public java.util.concurrent.CompletableFuture<Session1> getV1​(SessionByDeviceGetV1Request request)
        Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)

      • getV1

        public java.util.concurrent.CompletableFuture<Session1> getV1​(SessionByDeviceGetV1Request request,
                                                              RequestOptions requestOptions)
        Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)

      • lastSeenV1

        public java.util.concurrent.CompletableFuture<java.util.Optional<TrackingSessionByDeviceDataPoint1>> lastSeenV1​(SessionByDeviceLastSeenV1Request request)
        Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | () -> (TrackingSessionByDeviceDataPoint1 | None)

      • dataPointsV1

        public java.util.concurrent.CompletableFuture<java.util.List<TrackingSessionByDeviceDataPoint1>> dataPointsV1​(SessionByDeviceDataPointsV1Request request)
        Returns up to the specified number of data points for a session, intelligently sampled across the time range. Excludes outliers. | () -> (list[TrackingSessionByDeviceDataPoint1])

      • createSessionV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createSessionV1​(SessionByDeviceCreateSessionRequest1 request)
        Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionByDeviceCreateSessionRequest1) -> (PydanticObjectId)

      • createSessionV1

        public java.util.concurrent.CompletableFuture<java.lang.String> createSessionV1​(SessionByDeviceCreateSessionRequest1 request,
                                                                                RequestOptions requestOptions)
        Creates a new tracking session for a device and links the device to it. The device must be registered to the caller's organization. | (SessionByDeviceCreateSessionRequest1) -> (PydanticObjectId)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(SessionByDeviceUpdateRequest1 request)
        Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionByDeviceUpdateRequest1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(SessionByDeviceUpdateRequest1 request,
                                                                          RequestOptions requestOptions)
        Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionByDeviceUpdateRequest1) -> (bool)

      • startV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> startV1​(SessionByDeviceStartV1Request request)
        Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)

      • startV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> startV1​(SessionByDeviceStartV1Request request,
                                                                         RequestOptions requestOptions)
        Starts location recording for a session by setting recording status to true. Sets the recording initiated timestamp on first start. | () -> (bool)

      • pauseRecordingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> pauseRecordingV1​(SessionByDevicePauseRecordingV1Request request)
        Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)

      • pauseRecordingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> pauseRecordingV1​(SessionByDevicePauseRecordingV1Request request,
                                                                                  RequestOptions requestOptions)
        Pauses location recording for a session by setting recording status to false. Device remains linked to the session. | () -> (bool)

      • resumeRecordingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> resumeRecordingV1​(SessionByDeviceResumeRecordingV1Request request)
        Resumes location recording for a session by setting recording status to true. | () -> (bool)

      • resumeRecordingV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> resumeRecordingV1​(SessionByDeviceResumeRecordingV1Request request,
                                                                                   RequestOptions requestOptions)
        Resumes location recording for a session by setting recording status to true. | () -> (bool)

      • terminateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> terminateV1​(SessionByDeviceTerminateV1Request request)
        Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)

      • terminateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> terminateV1​(SessionByDeviceTerminateV1Request request,
                                                                             RequestOptions requestOptions)
        Terminates a session by setting recording to false and marking it as terminated. Unlinks the device from the session. | () -> (bool)

      • outlierV1

        public java.util.concurrent.CompletableFuture<SessionByDeviceMarkOutliersResponse1> outlierV1​(SessionByDeviceMarkOutliersRequest1 request)
        Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)

      • deleteV1

        public java.util.concurrent.CompletableFuture<SessionByDeviceDeleteResponse1> deleteV1​(SessionByDeviceDeleteV1Request request)
        Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionByDeviceDeleteResponse1)

      • lastSeenPublicV1

        public java.util.concurrent.CompletableFuture<java.util.Optional<TrackingSessionByDeviceDataPoint1>> lastSeenPublicV1​(SessionByDeviceLastSeenPublicV1Request request)
        Returns the most recent data point for a public session, excluding outliers. No authentication required if session has public visibility enabled. | () -> (TrackingSessionByDeviceDataPoint1 | None)

      • dataPointsPublicV1

        public java.util.concurrent.CompletableFuture<java.util.List<TrackingSessionByDeviceDataPoint1>> dataPointsPublicV1​(SessionByDeviceDataPointsPublicV1Request request)
        Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled. | () -> (list[TrackingSessionByDeviceDataPoint1])

      • dataPointsPublicV1

        public java.util.concurrent.CompletableFuture<java.util.List<TrackingSessionByDeviceDataPoint1>> dataPointsPublicV1​(SessionByDeviceDataPointsPublicV1Request request,
                                                                                                                    RequestOptions requestOptions)
        Returns up to the specified number of data points for a public session, intelligently sampled across the time range. Excludes outliers. No authentication required if session has public visibility enabled. | () -> (list[TrackingSessionByDeviceDataPoint1])