Package com.chrt.api.resources.shipping.drivers

Class DriversClient

java.lang.Object

com.chrt.api.resources.shipping.drivers.DriversClient

public class DriversClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions
protected java.util.function.Supplier<ComplianceDocumentsClient>	complianceDocumentsClient

Constructor Summary

Constructors

Constructor	Description
DriversClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
boolean	clearLastSeenV1()	Clears the driver's last known location and timestamp.
boolean	clearLastSeenV1(RequestOptions requestOptions)	Clears the driver's last known location and timestamp.
ComplianceDocumentsClient	complianceDocuments()
java.lang.String	createV1(DriverClientCreate1 request)	Creates a new driver profile for the target user (defaults to caller).
java.lang.String	createV1(DriverClientCreate1 request, RequestOptions requestOptions)	Creates a new driver profile for the target user (defaults to caller).
Driver1	getByDriverIdV1(java.lang.String driverId)	Retrieves detailed driver information by driver ID within the organization.
Driver1	getByDriverIdV1(java.lang.String driverId, RequestOptions requestOptions)	Retrieves detailed driver information by driver ID within the organization.
Driver1	getForCallerV1()	Retrieves driver information for the caller within their organization.
Driver1	getForCallerV1(RequestOptions requestOptions)	Retrieves driver information for the caller within their organization.
DriverStatsRes	getStatsV1(java.lang.String driverId, DriverStatsReq request)	Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration.
DriverStatsRes	getStatsV1(java.lang.String driverId, DriverStatsReq request, RequestOptions requestOptions)	Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration.
OrgMembersAndDriversListRes	listOrgMembersAndDriversV1()	Lists all organization members paired with their driver information if they are drivers.
OrgMembersAndDriversListRes	listOrgMembersAndDriversV1(DriversListOrgMembersAndDriversV1Request request)	Lists all organization members paired with their driver information if they are drivers.
OrgMembersAndDriversListRes	listOrgMembersAndDriversV1(DriversListOrgMembersAndDriversV1Request request, RequestOptions requestOptions)	Lists all organization members paired with their driver information if they are drivers.
DriverListRes	listV1()	Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search.
DriverListRes	listV1(DriversListV1Request request)	Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search.
DriverListRes	listV1(DriversListV1Request request, RequestOptions requestOptions)	Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search.
boolean	updateAutoAssignV1(java.lang.String driverId, DriverUpdateAutoAssignReq request)	Toggles a driver's auto_assign_enabled flag — opt-in for direct (non-bidding) task-group assignment.
boolean	updateAutoAssignV1(java.lang.String driverId, DriverUpdateAutoAssignReq request, RequestOptions requestOptions)	Toggles a driver's auto_assign_enabled flag — opt-in for direct (non-bidding) task-group assignment.
boolean	updateAvailabilityAccordingToDriverV1(DriverUpdateAvailabilityReq request)	Updates the caller's driver availability status.
boolean	updateAvailabilityAccordingToDriverV1(DriverUpdateAvailabilityReq request, RequestOptions requestOptions)	Updates the caller's driver availability status.
boolean	updateAvailabilityAccordingToOperatorsV1(java.lang.String driverId, DriverUpdateAvailabilityReq request)	Updates a driver's availability status.
boolean	updateAvailabilityAccordingToOperatorsV1(java.lang.String driverId, DriverUpdateAvailabilityReq request, RequestOptions requestOptions)	Updates a driver's availability status.
boolean	updateV1(java.lang.String driverId)	Updates driver contact details and vehicle type assignments.
boolean	updateV1(java.lang.String driverId, DriverClientUpdate1 request)	Updates driver contact details and vehicle type assignments.
boolean	updateV1(java.lang.String driverId, DriverClientUpdate1 request, RequestOptions requestOptions)	Updates driver contact details and vehicle type assignments.
RawDriversClient	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

complianceDocumentsClient

protected final java.util.function.Supplier<ComplianceDocumentsClient> complianceDocumentsClient

Constructor Detail

DriversClient

public DriversClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawDriversClient withRawResponse()

Get responses with HTTP metadata like headers

getStatsV1

public DriverStatsRes getStatsV1(java.lang.String driverId,
                                 DriverStatsReq request)

Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)

getStatsV1

public DriverStatsRes getStatsV1(java.lang.String driverId,
                                 DriverStatsReq request,
                                 RequestOptions requestOptions)

Retrieves driver stats (hours worked + observed mileage) with overlap-corrected duration. | authz: allowed_org_types=[provider], min_org_role=operator | (DriverStatsReq) -> (DriverStatsRes)

getForCallerV1

public Driver1 getForCallerV1()

Retrieves driver information for the caller within their organization. | () -> (Driver1)

getForCallerV1

public Driver1 getForCallerV1(RequestOptions requestOptions)

Retrieves driver information for the caller within their organization. | () -> (Driver1)

getByDriverIdV1

public Driver1 getByDriverIdV1(java.lang.String driverId)

Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)

getByDriverIdV1

public Driver1 getByDriverIdV1(java.lang.String driverId,
                               RequestOptions requestOptions)

Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)

listOrgMembersAndDriversV1

public OrgMembersAndDriversListRes listOrgMembersAndDriversV1()

Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)

listOrgMembersAndDriversV1

public OrgMembersAndDriversListRes listOrgMembersAndDriversV1(DriversListOrgMembersAndDriversV1Request request)

Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)

listOrgMembersAndDriversV1

public OrgMembersAndDriversListRes listOrgMembersAndDriversV1(DriversListOrgMembersAndDriversV1Request request,
                                                              RequestOptions requestOptions)

Lists all organization members paired with their driver information if they are drivers. Supports search by name, filtering, sorting, and pagination. | () -> (OrgMembersAndDriversListRes)

listV1

public DriverListRes listV1()

Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

listV1

public DriverListRes listV1(DriversListV1Request request)

Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

listV1

public DriverListRes listV1(DriversListV1Request request,
                            RequestOptions requestOptions)

Lists all drivers belonging to the caller's organization with filtering, sorting, pagination, and optional full-text search. | () -> (DriverListRes)

createV1

public java.lang.String createV1(DriverClientCreate1 request)

Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)

createV1

public java.lang.String createV1(DriverClientCreate1 request,
                                 RequestOptions requestOptions)

Creates a new driver profile for the target user (defaults to caller). Drivers can create themselves; operators+ can create any org member. Provider orgs only. | (DriverClientCreate1) -> (PydanticObjectId)

updateV1

public boolean updateV1(java.lang.String driverId)

Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String driverId,
                        DriverClientUpdate1 request)

Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

updateV1

public boolean updateV1(java.lang.String driverId,
                        DriverClientUpdate1 request,
                        RequestOptions requestOptions)

Updates driver contact details and vehicle type assignments. Provider orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

clearLastSeenV1

public boolean clearLastSeenV1()

Clears the driver's last known location and timestamp. | () -> (bool)

clearLastSeenV1

public boolean clearLastSeenV1(RequestOptions requestOptions)

Clears the driver's last known location and timestamp. | () -> (bool)

updateAvailabilityAccordingToDriverV1

public boolean updateAvailabilityAccordingToDriverV1(DriverUpdateAvailabilityReq request)

Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)

updateAvailabilityAccordingToDriverV1

public boolean updateAvailabilityAccordingToDriverV1(DriverUpdateAvailabilityReq request,
                                                     RequestOptions requestOptions)

Updates the caller's driver availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only. | (DriverUpdateAvailabilityReq) -> (bool)

updateAvailabilityAccordingToOperatorsV1

public boolean updateAvailabilityAccordingToOperatorsV1(java.lang.String driverId,
                                                        DriverUpdateAvailabilityReq request)

Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)

updateAvailabilityAccordingToOperatorsV1

public boolean updateAvailabilityAccordingToOperatorsV1(java.lang.String driverId,
                                                        DriverUpdateAvailabilityReq request,
                                                        RequestOptions requestOptions)

Updates a driver's availability status. Must have status UNASSIGNED to set availability to False; always allows setting to True. Provider orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)

updateAutoAssignV1

public boolean updateAutoAssignV1(java.lang.String driverId,
                                  DriverUpdateAutoAssignReq request)

Toggles a driver's auto_assign_enabled flag — opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)

updateAutoAssignV1

public boolean updateAutoAssignV1(java.lang.String driverId,
                                  DriverUpdateAutoAssignReq request,
                                  RequestOptions requestOptions)

Toggles a driver's auto_assign_enabled flag — opt-in for direct (non-bidding) task-group assignment. Authorized: the driver themselves OR an operator+ in the driver's org (operators may override the driver's setting). Provider orgs only. | (DriverUpdateAutoAssignReq) -> (bool)

complianceDocuments

public ComplianceDocumentsClient complianceDocuments()