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

Class AsyncDriversClient

  • public class AsyncDriversClient
extends java.lang.Object

    • Constructor Detail

      • AsyncDriversClient

        public AsyncDriversClient​(ClientOptions clientOptions)

    • Method Detail

      • withRawResponse

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

      • getForCallerV1

        public java.util.concurrent.CompletableFuture<Driver1> getForCallerV1()
        Retrieves driver information for the caller within their organization. | () -> (Driver1)

      • getForCallerV1

        public java.util.concurrent.CompletableFuture<Driver1> getForCallerV1​(RequestOptions requestOptions)
        Retrieves driver information for the caller within their organization. | () -> (Driver1)

      • getByDriverIdV1

        public java.util.concurrent.CompletableFuture<Driver1> getByDriverIdV1​(java.lang.String driverId)
        Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)

      • getByDriverIdV1

        public java.util.concurrent.CompletableFuture<Driver1> getByDriverIdV1​(java.lang.String driverId,
                                                                       RequestOptions requestOptions)
        Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)

      • listOrgMembersAndDriversV1

        public java.util.concurrent.CompletableFuture<java.util.List<OrgMembersAndDrivers>> listOrgMembersAndDriversV1()
        Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (list[OrgMembersAndDrivers])

      • listOrgMembersAndDriversV1

        public java.util.concurrent.CompletableFuture<java.util.List<OrgMembersAndDrivers>> listOrgMembersAndDriversV1​(DriversListOrgMembersAndDriversV1Request request)
        Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (list[OrgMembersAndDrivers])

      • listOrgMembersAndDriversV1

        public java.util.concurrent.CompletableFuture<java.util.List<OrgMembersAndDrivers>> listOrgMembersAndDriversV1​(DriversListOrgMembersAndDriversV1Request request,
                                                                                                               RequestOptions requestOptions)
        Lists all organization members paired with their driver information if they are drivers. Filter by availability. | () -> (list[OrgMembersAndDrivers])

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<Driver1>> listV1()
        Lists all drivers belonging to the caller's organization. Filter by availability. | () -> (list[Driver1])

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<Driver1>> listV1​(DriversListV1Request request)
        Lists all drivers belonging to the caller's organization. Filter by availability. | () -> (list[Driver1])

      • listV1

        public java.util.concurrent.CompletableFuture<java.util.List<Driver1>> listV1​(DriversListV1Request request,
                                                                              RequestOptions requestOptions)
        Lists all drivers belonging to the caller's organization. Filter by availability. | () -> (list[Driver1])

      • createV1

        public java.util.concurrent.CompletableFuture<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. Courier orgs only. | (DriverClientCreate1) -> (PydanticObjectId)

      • createV1

        public java.util.concurrent.CompletableFuture<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. Courier orgs only. | (DriverClientCreate1) -> (PydanticObjectId)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String driverId)
        Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String driverId,
                                                                          DriverClientUpdate1 request)
        Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

      • updateV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> updateV1​(java.lang.String driverId,
                                                                          DriverClientUpdate1 request,
                                                                          RequestOptions requestOptions)
        Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)

      • clearLastSeenV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> clearLastSeenV1()
        Clears the driver's last known location and timestamp. | () -> (bool)

      • clearLastSeenV1

        public java.util.concurrent.CompletableFuture<java.lang.Boolean> clearLastSeenV1​(RequestOptions requestOptions)
        Clears the driver's last known location and timestamp. | () -> (bool)

      • updateAvailabilityAccordingToDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.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. Courier orgs only. | (DriverUpdateAvailabilityReq) -> (bool)

      • updateAvailabilityAccordingToDriverV1

        public java.util.concurrent.CompletableFuture<java.lang.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. Courier orgs only. | (DriverUpdateAvailabilityReq) -> (bool)

      • updateAvailabilityAccordingToOperatorsV1

        public java.util.concurrent.CompletableFuture<java.lang.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. Courier orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)

      • updateAvailabilityAccordingToOperatorsV1

        public java.util.concurrent.CompletableFuture<java.lang.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. Courier orgs only, min role: operator. | (DriverUpdateAvailabilityReq) -> (bool)