Package com.chrt.api.resources.tracking.sharing

Class SharingClient

java.lang.Object

com.chrt.api.resources.tracking.sharing.SharingClient

public class SharingClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
SharingClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
CargoByDeviceSharingSettings1	cargoByDeviceSettingsV1(CargoByDeviceSharingSettingsUpdateReq request)	Updates the sharing settings for a cargo by device tracking dataset.
CargoByDeviceSharingSettings1	cargoByDeviceSettingsV1(CargoByDeviceSharingSettingsUpdateReq request, RequestOptions requestOptions)	Updates the sharing settings for a cargo by device tracking dataset.
CargoByDriverSharingSettings1	cargoByDriverSettingsV1(CargoByDriverSharingSettingsUpdateReq request)	Updates the sharing settings for a cargo by driver tracking dataset.
CargoByDriverSharingSettings1	cargoByDriverSettingsV1(CargoByDriverSharingSettingsUpdateReq request, RequestOptions requestOptions)	Updates the sharing settings for a cargo by driver tracking dataset.
java.util.List<TrackingSharingSettingsRes>	getSettingsV1(java.lang.String orderIdOrShortId)	Get all tracking datasets and their sharing settings for a given order.
java.util.List<TrackingSharingSettingsRes>	getSettingsV1(java.lang.String orderIdOrShortId, RequestOptions requestOptions)	Get all tracking datasets and their sharing settings for a given order.
TaskGroupByDriverSharingSettings1	taskGroupByDriverSharingSettingsV1(TaskGroupByDriverSharingSettingsUpdateReq request)	Updates the sharing settings for a task group by driver tracking dataset.
TaskGroupByDriverSharingSettings1	taskGroupByDriverSharingSettingsV1(TaskGroupByDriverSharingSettingsUpdateReq request, RequestOptions requestOptions)	Updates the sharing settings for a task group by driver tracking dataset.
RawSharingClient	withRawResponse()	Get responses with HTTP metadata like headers

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

SharingClient

public SharingClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawSharingClient withRawResponse()

Get responses with HTTP metadata like headers

getSettingsV1

public java.util.List<TrackingSharingSettingsRes> getSettingsV1(java.lang.String orderIdOrShortId)

Get all tracking datasets and their sharing settings for a given order. | authz_personas=[shipper_org_operators, forwarder_org_operators, courier_org_operators] | () -> (list[TrackingSharingSettingsRes])

getSettingsV1

public java.util.List<TrackingSharingSettingsRes> getSettingsV1(java.lang.String orderIdOrShortId,
                                                                RequestOptions requestOptions)

Get all tracking datasets and their sharing settings for a given order. | authz_personas=[shipper_org_operators, forwarder_org_operators, courier_org_operators] | () -> (list[TrackingSharingSettingsRes])

taskGroupByDriverSharingSettingsV1

public TaskGroupByDriverSharingSettings1 taskGroupByDriverSharingSettingsV1(TaskGroupByDriverSharingSettingsUpdateReq request)

Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)

taskGroupByDriverSharingSettingsV1

public TaskGroupByDriverSharingSettings1 taskGroupByDriverSharingSettingsV1(TaskGroupByDriverSharingSettingsUpdateReq request,
                                                                            RequestOptions requestOptions)

Updates the sharing settings for a task group by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (TaskGroupByDriverSharingSettingsUpdateReq) -> (TaskGroupByDriverSharingSettings1)

cargoByDriverSettingsV1

public CargoByDriverSharingSettings1 cargoByDriverSettingsV1(CargoByDriverSharingSettingsUpdateReq request)

Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)

cargoByDriverSettingsV1

public CargoByDriverSharingSettings1 cargoByDriverSettingsV1(CargoByDriverSharingSettingsUpdateReq request,
                                                             RequestOptions requestOptions)

Updates the sharing settings for a cargo by driver tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, courier_org_operators, courier_driver] | (CargoByDriverSharingSettingsUpdateReq) -> (CargoByDriverSharingSettings1)

cargoByDeviceSettingsV1

public CargoByDeviceSharingSettings1 cargoByDeviceSettingsV1(CargoByDeviceSharingSettingsUpdateReq request)

Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)

cargoByDeviceSettingsV1

public CargoByDeviceSharingSettings1 cargoByDeviceSettingsV1(CargoByDeviceSharingSettingsUpdateReq request,
                                                             RequestOptions requestOptions)

Updates the sharing settings for a cargo by device tracking dataset. | authz_personas=[forwarder_org_operators, shipper_org_operators, order_creator_org_operators] | (CargoByDeviceSharingSettingsUpdateReq) -> (CargoByDeviceSharingSettings1)