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

Class AsyncDevicesClient

  • public class AsyncDevicesClient
extends java.lang.Object

    • Constructor Detail

      • AsyncDevicesClient

        public AsyncDevicesClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • registerToOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.String> registerToOrgV1​(DevicesRegisterToOrgReq1 request)
        Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)

      • registerToOrgV1

        public java.util.concurrent.CompletableFuture<java.lang.String> registerToOrgV1​(DevicesRegisterToOrgReq1 request,
                                                                                RequestOptions requestOptions)
        Registers a tracking device to the caller's organization. If device is already registered to a different organization, registration is blocked. | (DevicesRegisterToOrgReq1) -> (PydanticObjectId)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1()
        Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(DevicesUpdateRequest1 request)
        Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(DevicesUpdateRequest1 request,
                                                                          RequestOptions requestOptions)
        Updates a device's type, comments, and/or off_chrt_order_id. Can update one or more fields, or delete them by setting delete flags. | (DevicesUpdateRequest1) -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1()
        Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(DevicesDeleteV1Request request)
        Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteV1​(DevicesDeleteV1Request request,
                                                                          RequestOptions requestOptions)
        Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. Deregisters from Shiprec (transfers to deactivate account) before removing from database. | () -> (bool)

      • linkToCargoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> linkToCargoV1​(DevicesLinkToCargoV1Request request)
        Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)

      • linkToCargoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> linkToCargoV1​(DevicesLinkToCargoV1Request request,
                                                                               RequestOptions requestOptions)
        Links a device to cargo with bidirectional references. Device must not already be linked to a session or different cargo. | () -> (bool)

      • unlinkFromCargoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> unlinkFromCargoV1​(DevicesUnlinkFromCargoV1Request request)
        Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)

      • unlinkFromCargoV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> unlinkFromCargoV1​(DevicesUnlinkFromCargoV1Request request,
                                                                                   RequestOptions requestOptions)
        Unlinks a device from its linked cargo, removing the bidirectional reference. Returns false if device is not linked to any cargo. | () -> (bool)

      • getV1

        public java.util.concurrent.CompletableFuture<Device1> getV1()
        Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)

      • getV1

        public java.util.concurrent.CompletableFuture<Device1> getV1​(DevicesGetV1Request request)
        Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)

      • getV1

        public java.util.concurrent.CompletableFuture<Device1> getV1​(DevicesGetV1Request request,
                                                             RequestOptions requestOptions)
        Retrieves a single device by its MAC address or ID. Access restricted to the caller's organization. | authz: min_org_role=operator | () -> (Device1)

      • listV1

        public java.util.concurrent.CompletableFuture<DeviceListRes> listV1()
        Lists devices with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (DeviceListRes)

      • listV1

        public java.util.concurrent.CompletableFuture<DeviceListRes> listV1​(DevicesListV1Request request)
        Lists devices with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (DeviceListRes)

      • listV1

        public java.util.concurrent.CompletableFuture<DeviceListRes> listV1​(DevicesListV1Request request,
                                                                    RequestOptions requestOptions)
        Lists devices with filtering, sorting, and pagination. | authz: min_org_role=operator | () -> (DeviceListRes)

      • typeaheadOffChrtOrderIdV1

        public java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> typeaheadOffChrtOrderIdV1​(DevicesTypeaheadOffChrtOrderIdV1Request request)
        Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching devices. | authz: min_org_role=operator | () -> (list[str])

      • typeaheadOffChrtOrderIdV1

        public java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> typeaheadOffChrtOrderIdV1​(DevicesTypeaheadOffChrtOrderIdV1Request request,
                                                                                                          RequestOptions requestOptions)
        Returns distinct off_chrt_order_id values matching the query via case-insensitive regex, searching devices. | authz: min_org_role=operator | () -> (list[str])

      • searchV1

        public java.util.concurrent.CompletableFuture<DeviceSearchRes> searchV1​(DevicesSearchV1Request request)
        Full-text search across device device_mac_address, comments, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (DeviceSearchRes)

      • searchV1

        public java.util.concurrent.CompletableFuture<DeviceSearchRes> searchV1​(DevicesSearchV1Request request,
                                                                        RequestOptions requestOptions)
        Full-text search across device device_mac_address, comments, and off_chrt_order_id using Atlas Search. | authz: min_org_role=operator | () -> (DeviceSearchRes)