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

Class RawDevicesClient

java.lang.Object

com.chrt.api.resources.tracking.devices.RawDevicesClient

public class RawDevicesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawDevicesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1()	Deletes a device by ID or MAC address.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(DevicesDeleteV1Request request)	Deletes a device by ID or MAC address.
ChrtApiHttpResponse<java.lang.Boolean>	deleteV1(DevicesDeleteV1Request request, RequestOptions requestOptions)	Deletes a device by ID or MAC address.
ChrtApiHttpResponse<Device1>	getV1()	Retrieves a single device by its MAC address or ID.
ChrtApiHttpResponse<Device1>	getV1(DevicesGetV1Request request)	Retrieves a single device by its MAC address or ID.
ChrtApiHttpResponse<Device1>	getV1(DevicesGetV1Request request, RequestOptions requestOptions)	Retrieves a single device by its MAC address or ID.
ChrtApiHttpResponse<java.lang.Boolean>	linkToCargoV1(DevicesLinkToCargoV1Request request)	Links a device to cargo with bidirectional references.
ChrtApiHttpResponse<java.lang.Boolean>	linkToCargoV1(DevicesLinkToCargoV1Request request, RequestOptions requestOptions)	Links a device to cargo with bidirectional references.
ChrtApiHttpResponse<java.util.List<Device1>>	listV1()	Returns all tracking devices registered to the authenticated user's organization.
ChrtApiHttpResponse<java.util.List<Device1>>	listV1(RequestOptions requestOptions)	Returns all tracking devices registered to the authenticated user's organization.
ChrtApiHttpResponse<java.lang.String>	registerToOrgV1(DevicesRegisterToOrgReq1 request)	Registers a tracking device to the authenticated user's organization.
ChrtApiHttpResponse<java.lang.String>	registerToOrgV1(DevicesRegisterToOrgReq1 request, RequestOptions requestOptions)	Registers a tracking device to the authenticated user's organization.
ChrtApiHttpResponse<java.lang.Boolean>	unlinkFromCargoV1(DevicesUnlinkFromCargoV1Request request)	Unlinks a device from its linked cargo, removing the bidirectional reference.
ChrtApiHttpResponse<java.lang.Boolean>	unlinkFromCargoV1(DevicesUnlinkFromCargoV1Request request, RequestOptions requestOptions)	Unlinks a device from its linked cargo, removing the bidirectional reference.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1()	Updates a device's type and/or comments.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(DevicesUpdateRequest1 request)	Updates a device's type and/or comments.
ChrtApiHttpResponse<java.lang.Boolean>	updateV1(DevicesUpdateRequest1 request, RequestOptions requestOptions)	Updates a device's type and/or comments.

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

RawDevicesClient

public RawDevicesClient(ClientOptions clientOptions)

Method Detail

registerToOrgV1

public ChrtApiHttpResponse<java.lang.String> registerToOrgV1(DevicesRegisterToOrgReq1 request)

Registers a tracking device to the authenticated user's organization. If device is already registered to a different organization, registration is blocked.

registerToOrgV1

public ChrtApiHttpResponse<java.lang.String> registerToOrgV1(DevicesRegisterToOrgReq1 request,
                                                             RequestOptions requestOptions)

Registers a tracking device to the authenticated user's organization. If device is already registered to a different organization, registration is blocked.

updateV1

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

updateV1

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

updateV1

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

deleteV1

public ChrtApiHttpResponse<java.lang.Boolean> deleteV1()

Deletes a device by ID or MAC address. Device must be unlinked from any session or cargo before deletion.

deleteV1

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

deleteV1

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

getV1

public ChrtApiHttpResponse<Device1> getV1()

Retrieves a single device by its MAC address or ID. Access restricted to the device's organization.

getV1

public ChrtApiHttpResponse<Device1> getV1(DevicesGetV1Request request)

Retrieves a single device by its MAC address or ID. Access restricted to the device's organization.

getV1

public ChrtApiHttpResponse<Device1> getV1(DevicesGetV1Request request,
                                          RequestOptions requestOptions)

Retrieves a single device by its MAC address or ID. Access restricted to the device's organization.

listV1

public ChrtApiHttpResponse<java.util.List<Device1>> listV1()

Returns all tracking devices registered to the authenticated user's organization.

listV1

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

Returns all tracking devices registered to the authenticated user's organization.

linkToCargoV1

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

linkToCargoV1

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

unlinkFromCargoV1

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

unlinkFromCargoV1

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