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

Class AsyncRawDevicesClient

  • public class AsyncRawDevicesClient
extends java.lang.Object

    • Constructor Detail

      • AsyncRawDevicesClient

        public AsyncRawDevicesClient​(ClientOptions clientOptions)

    • Method Detail

      • registerToOrgV1

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

      • updateV1

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

      • updateV1

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

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.lang.Boolean>> deleteV1()
        Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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. | () -> (bool)

      • deleteV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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. | () -> (bool)

      • linkToCargoV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<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<ChrtApiHttpResponse<java.util.List<Device1>>> listV1()
        Returns all tracking devices registered to the caller's organization. | authz: min_org_role=operator | () -> (list[Device1])

      • listV1

        public java.util.concurrent.CompletableFuture<ChrtApiHttpResponse<java.util.List<Device1>>> listV1​(RequestOptions requestOptions)
        Returns all tracking devices registered to the caller's organization. | authz: min_org_role=operator | () -> (list[Device1])