Package com.chrt.api.resources.tracking.sessions

Class SessionsClient

  • public class SessionsClient
extends java.lang.Object

    • Constructor Detail

      • SessionsClient

        public SessionsClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

        public RawSessionsClient withRawResponse()
        Get responses with HTTP metadata like headers

      • listV1

        public SessionListRes listV1()
        Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)

      • listV1

        public SessionListRes listV1​(SessionsListV1Request request)
        Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)

      • listV1

        public SessionListRes listV1​(SessionsListV1Request request,
                             RequestOptions requestOptions)
        Lists sessions with filtering, sorting, and pagination. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionListRes)

      • getV1

        public Session1 getV1​(SessionsGetV1Request request)
        Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (Session1)

      • getV1

        public Session1 getV1​(SessionsGetV1Request request,
                      RequestOptions requestOptions)
        Retrieves a single session by its ID. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (Session1)

      • typeaheadV1

        public java.util.List<TrackingTypeaheadResult> typeaheadV1​(SessionsTypeaheadV1Request request)
        Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])

      • typeaheadV1

        public java.util.List<TrackingTypeaheadResult> typeaheadV1​(SessionsTypeaheadV1Request request,
                                                           RequestOptions requestOptions)
        Returns distinct device_mac_address and off_chrt_reference_id values matching the query via case-insensitive regex, searching sessions. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (list[TrackingTypeaheadResult])

      • searchV1

        public SessionSearchRes searchV1​(SessionsSearchV1Request request)
        Search across session comments, device_mac_address, flight_numbers, and off_chrt_reference_id. Handles both partial and full matches. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionSearchRes)

      • searchV1

        public SessionSearchRes searchV1​(SessionsSearchV1Request request,
                                 RequestOptions requestOptions)
        Search across session comments, device_mac_address, flight_numbers, and off_chrt_reference_id. Handles both partial and full matches. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (SessionSearchRes)

      • createSessionV1

        public java.lang.String createSessionV1​(SessionClientCreate1 request)
        Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~3 days out at 8 PM PT. Prevent auto termination with no_auto_termination=True | (SessionClientCreate1) -> (PydanticObjectId)

      • createSessionV1

        public java.lang.String createSessionV1​(SessionClientCreate1 request,
                                        RequestOptions requestOptions)
        Creates a new tracking session for a device and automatically starts recording data points. The caller must be the device owner or belong to an org the device is shared with. The device owner remains the session owner (org_id). The device's shared_with_org_ids are copied to the session. The device must not have an active session. Auto-termination is scheduled for ~3 days out at 8 PM PT. Prevent auto termination with no_auto_termination=True | (SessionClientCreate1) -> (PydanticObjectId)

      • updateV1

        public boolean updateV1​(SessionClientUpdate1 request)
        Updates a session's metadata. | (SessionClientUpdate1) -> (bool)

      • updateSharedOrgsV1

        public boolean updateSharedOrgsV1​(SessionsUpdateSharedOrgsReq1 request)
        Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)

      • updateSharedOrgsV1

        public boolean updateSharedOrgsV1​(SessionsUpdateSharedOrgsReq1 request,
                                  RequestOptions requestOptions)
        Adds and/or removes org_ids from a session's shared_with_org_ids list. Only the owning org may modify sharing. Removal overrides addition. | (SessionsUpdateSharedOrgsReq1) -> (bool)

      • terminateV1

        public boolean terminateV1​(SessionsTerminateV1Request request)
        Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)

      • terminateV1

        public boolean terminateV1​(SessionsTerminateV1Request request,
                           RequestOptions requestOptions)
        Terminates a session. Moves device.active_session_id to device.past_session_ids. | () -> (bool)

      • addFlightV1

        public boolean addFlightV1​(SessionAddFlightReq1 request)
        Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)

      • addFlightV1

        public boolean addFlightV1​(SessionAddFlightReq1 request,
                           RequestOptions requestOptions)
        Adds a flight number and FA flight IDs to an existing session. Creates or reuses a FlightAware alert. | authz: min_org_role=operator | (SessionAddFlightReq1) -> (bool)

      • removeFlightV1

        public boolean removeFlightV1​(SessionRemoveFlightReq1 request)
        Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)

      • removeFlightV1

        public boolean removeFlightV1​(SessionRemoveFlightReq1 request,
                              RequestOptions requestOptions)
        Removes a flight number and FA flight IDs from a session. Runs the shared-aware FlightAware unsubscribe cycle before removing. | authz: min_org_role=operator | (SessionRemoveFlightReq1) -> (bool)

      • syncFlightStatusV1

        public boolean syncFlightStatusV1​(SessionsSyncFlightStatusV1Request request)
        Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)

      • syncFlightStatusV1

        public boolean syncFlightStatusV1​(SessionsSyncFlightStatusV1Request request,
                                  RequestOptions requestOptions)
        Fetches current OOOI timestamps from FlightAware for each fa_flight_id on the session and updates flight_status_by_fa_flight_id. Use when the webhook may have left state out of sync. | authz: min_org_role=operator | () -> (bool)