Package com.chrt.api.resources.tracking.devices

Class DevicesClient

  • public class DevicesClient
extends java.lang.Object

    • Constructor Detail

      • DevicesClient

        public DevicesClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • registerToOrgV1

        public java.lang.String registerToOrgV1​(DeviceClientCreate1 request)
        Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)

      • registerToOrgV1

        public java.lang.String registerToOrgV1​(DeviceClientCreate1 request,
                                        RequestOptions requestOptions)
        Registers a tracking device to the caller's organization. If the device is already registered to a different organization, returns 409 Conflict. | (DeviceClientCreate1) -> (PydanticObjectId)

      • updateV1

        public boolean updateV1​(DeviceClientUpdate1 request)
        Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)

      • updateV1

        public boolean updateV1​(DeviceClientUpdate1 request,
                        RequestOptions requestOptions)
        Updates a device's type, comments, and/or off_chrt_reference_id. Use __set_to_None flags to explicitly clear Optional fields. | (DeviceClientUpdate1) -> (bool)

      • archiveV1

        public boolean archiveV1​(DevicesArchiveV1Request request)
        Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)

      • archiveV1

        public boolean archiveV1​(DevicesArchiveV1Request request,
                         RequestOptions requestOptions)
        Archives a device by setting archived=True. Device must not have an active session — terminate it first. | () -> (bool)

      • updateSharedOrgsV1

        public boolean updateSharedOrgsV1​(DevicesUpdateSharedOrgsReq1 request)
        Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)

      • updateSharedOrgsV1

        public boolean updateSharedOrgsV1​(DevicesUpdateSharedOrgsReq1 request,
                                  RequestOptions requestOptions)
        Adds and/or removes org_ids from a device's shared_with_org_ids list. Removal overrides addition. | (DevicesUpdateSharedOrgsReq1) -> (bool)

      • getV1

        public DeviceExpandedRes getV1​(DevicesGetV1Request request)
        Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)

      • getV1

        public DeviceExpandedRes getV1​(DevicesGetV1Request request,
                               RequestOptions requestOptions)
        Retrieves a single device by its ID with expanded sessions and cargos. Access restricted to the caller's organization or shared organizations. | authz: min_org_role=operator | () -> (DeviceExpandedRes)

      • listV1

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

      • listV1

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

      • listV1

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

      • typeaheadV1

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

      • searchV1

        public DeviceSearchRes searchV1​(DevicesSearchV1Request request)
        Search across device device_mac_address, comments, and off_chrt_reference_id. Handles both partial (typing) and full query submission. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceSearchRes)

      • searchV1

        public DeviceSearchRes searchV1​(DevicesSearchV1Request request,
                                RequestOptions requestOptions)
        Search across device device_mac_address, comments, and off_chrt_reference_id. Handles both partial (typing) and full query submission. Use org_scope to restrict to owned, shared, or both (default). | authz: min_org_role=operator | () -> (DeviceSearchRes)