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

Class SessionByDeviceClient

java.lang.Object

com.chrt.api.resources.tracking.sessionbydevice.SessionByDeviceClient

public class SessionByDeviceClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
SessionByDeviceClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	createSessionV1(SessionByDeviceCreateSessionRequest1 request)	Creates a new tracking session for a device and links the device to it.
java.lang.String	createSessionV1(SessionByDeviceCreateSessionRequest1 request, RequestOptions requestOptions)	Creates a new tracking session for a device and links the device to it.
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.
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.
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.
java.util.List<TrackingSessionByDeviceDataPoint1>	dataPointsV1(SessionByDeviceDataPointsV1Request request, RequestOptions requestOptions)	Returns up to the specified number of data points for a session, intelligently sampled across the time range.
SessionByDeviceDeleteResponse1	deleteV1(SessionByDeviceDeleteV1Request request)	Deletes a terminated session and all its associated timeseries data points.
SessionByDeviceDeleteResponse1	deleteV1(SessionByDeviceDeleteV1Request request, RequestOptions requestOptions)	Deletes a terminated session and all its associated timeseries data points.
Session1	getV1(SessionByDeviceGetV1Request request)	Retrieves a single session by its ID.
Session1	getV1(SessionByDeviceGetV1Request request, RequestOptions requestOptions)	Retrieves a single session by its ID.
java.util.Optional<TrackingSessionByDeviceDataPoint1>	lastSeenPublicV1(SessionByDeviceLastSeenPublicV1Request request)	Returns the most recent data point for a public session, excluding outliers.
java.util.Optional<TrackingSessionByDeviceDataPoint1>	lastSeenPublicV1(SessionByDeviceLastSeenPublicV1Request request, RequestOptions requestOptions)	Returns the most recent data point for a public session, excluding outliers.
java.util.Optional<TrackingSessionByDeviceDataPoint1>	lastSeenV1(SessionByDeviceLastSeenV1Request request)	Returns the most recent data point for a session, excluding outliers.
java.util.Optional<TrackingSessionByDeviceDataPoint1>	lastSeenV1(SessionByDeviceLastSeenV1Request request, RequestOptions requestOptions)	Returns the most recent data point for a session, excluding outliers.
java.util.List<Session1>	listV1()	Returns all tracking sessions for the caller's organization.
java.util.List<Session1>	listV1(RequestOptions requestOptions)	Returns all tracking sessions for the caller's organization.
SessionByDeviceMarkOutliersResponse1	outlierV1(SessionByDeviceMarkOutliersRequest1 request)	Marks data points as outliers or non-outliers.
SessionByDeviceMarkOutliersResponse1	outlierV1(SessionByDeviceMarkOutliersRequest1 request, RequestOptions requestOptions)	Marks data points as outliers or non-outliers.
boolean	pauseRecordingV1(SessionByDevicePauseRecordingV1Request request)	Pauses location recording for a session by setting recording status to false.
boolean	pauseRecordingV1(SessionByDevicePauseRecordingV1Request request, RequestOptions requestOptions)	Pauses location recording for a session by setting recording status to false.
boolean	resumeRecordingV1(SessionByDeviceResumeRecordingV1Request request)	Resumes location recording for a session by setting recording status to true.
boolean	resumeRecordingV1(SessionByDeviceResumeRecordingV1Request request, RequestOptions requestOptions)	Resumes location recording for a session by setting recording status to true.
boolean	startV1(SessionByDeviceStartV1Request request)	Starts location recording for a session by setting recording status to true.
boolean	startV1(SessionByDeviceStartV1Request request, RequestOptions requestOptions)	Starts location recording for a session by setting recording status to true.
boolean	terminateV1(SessionByDeviceTerminateV1Request request)	Terminates a session by setting recording to false and marking it as terminated.
boolean	terminateV1(SessionByDeviceTerminateV1Request request, RequestOptions requestOptions)	Terminates a session by setting recording to false and marking it as terminated.
boolean	updateV1(SessionByDeviceUpdateRequest1 request)	Updates a session's comments and/or public visibility status.
boolean	updateV1(SessionByDeviceUpdateRequest1 request, RequestOptions requestOptions)	Updates a session's comments and/or public visibility status.
RawSessionByDeviceClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

SessionByDeviceClient

public SessionByDeviceClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawSessionByDeviceClient withRawResponse()

Get responses with HTTP metadata like headers

listV1

public java.util.List<Session1> listV1()

Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

listV1

public java.util.List<Session1> listV1(RequestOptions requestOptions)

Returns all tracking sessions for the caller's organization. | () -> (list[Session1])

getV1

public Session1 getV1(SessionByDeviceGetV1Request request)

Retrieves a single session by its ID. Access restricted to the caller's organization. | () -> (Session1)

getV1

public 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.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)

lastSeenV1

public java.util.Optional<TrackingSessionByDeviceDataPoint1> lastSeenV1(SessionByDeviceLastSeenV1Request request,
                                                                        RequestOptions requestOptions)

Returns the most recent data point for a session, excluding outliers. Access restricted to the caller's organization. | () -> (TrackingSessionByDeviceDataPoint1 | None)

dataPointsV1

public 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])

dataPointsV1

public java.util.List<TrackingSessionByDeviceDataPoint1> dataPointsV1(SessionByDeviceDataPointsV1Request request,
                                                                      RequestOptions requestOptions)

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.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.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 boolean updateV1(SessionByDeviceUpdateRequest1 request)

Updates a session's comments and/or public visibility status. Can update one or both fields. | (SessionByDeviceUpdateRequest1) -> (bool)

updateV1

public 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 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 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 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 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 boolean resumeRecordingV1(SessionByDeviceResumeRecordingV1Request request)

Resumes location recording for a session by setting recording status to true. | () -> (bool)

resumeRecordingV1

public boolean resumeRecordingV1(SessionByDeviceResumeRecordingV1Request request,
                                 RequestOptions requestOptions)

Resumes location recording for a session by setting recording status to true. | () -> (bool)

terminateV1

public 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 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 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)

outlierV1

public SessionByDeviceMarkOutliersResponse1 outlierV1(SessionByDeviceMarkOutliersRequest1 request,
                                                      RequestOptions requestOptions)

Marks data points as outliers or non-outliers. Uses atomic delete and reinsert strategy for time-series collection updates. | (SessionByDeviceMarkOutliersRequest1) -> (SessionByDeviceMarkOutliersResponse1)

deleteV1

public SessionByDeviceDeleteResponse1 deleteV1(SessionByDeviceDeleteV1Request request)

Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionByDeviceDeleteResponse1)

deleteV1

public SessionByDeviceDeleteResponse1 deleteV1(SessionByDeviceDeleteV1Request request,
                                               RequestOptions requestOptions)

Deletes a terminated session and all its associated timeseries data points. Only sessions marked as terminated can be deleted. | () -> (SessionByDeviceDeleteResponse1)

lastSeenPublicV1

public 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)

lastSeenPublicV1

public java.util.Optional<TrackingSessionByDeviceDataPoint1> lastSeenPublicV1(SessionByDeviceLastSeenPublicV1Request request,
                                                                              RequestOptions requestOptions)

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.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.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])