@chrt-inc/typescript-sdk 1.320.0 → 1.322.0

package/dist/esm/api/resources/drivers/client/Client.d.mts

@@ -31,97 +31,79 @@ export declare class Drivers {
     protected readonly _options: Drivers.Options;
     constructor(_options?: Drivers.Options);
     /**
-     * Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
-     *
-     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.drivers.listOrgMembersAndDriversV1()
-     */
-    listOrgMembersAndDriversV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.OrgMembersAndDrivers[]>;
-    private __listOrgMembersAndDriversV1;
-    /**
-     * Lists all drivers belonging to the caller's organization. | () -> (list[Driver1])
+     * Retrieves driver information for the caller within their organization. | () -> (Driver1)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.drivers.listV1()
+     *     await client.drivers.getForCallerV1()
      */
-    listV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
-    private __listV1;
+    getForCallerV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
+    private __getForCallerV1;
     /**
-     * Creates a new driver profile for an organization member with optional vehicle type assignments. | (DriverCreateReq) -> (PydanticObjectId)
+     * Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
      *
-     * @param {Chrt.DriverCreateReq} request
+     * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.drivers.createV1({
-     *         org_member: {
-     *             role: "owner",
-     *             user_id: "user_id"
-     *         }
-     *     })
+     *     await client.drivers.getByDriverIdV1("driver_id")
      */
-    createV1(request: Chrt.DriverCreateReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<string>;
-    private __createV1;
+    getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
+    private __getByDriverIdV1;
     /**
-     * Retrieves driver information for the caller within their organization. | () -> (Driver1)
+     * Lists all organization members paired with their driver information if they are drivers. | () -> (list[OrgMembersAndDrivers])
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.drivers.getV1()
+     *     await client.drivers.listOrgMembersAndDriversV1()
      */
-    getV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
-    private __getV1;
+    listOrgMembersAndDriversV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.OrgMembersAndDrivers[]>;
+    private __listOrgMembersAndDriversV1;
     /**
-     * Retrieves detailed driver information by driver ID within the organization. | () -> (Driver1)
+     * Lists all drivers belonging to the caller's organization. | () -> (list[Driver1])
      *
-     * @param {string} driverId
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
      * @example
-     *     await client.drivers.getByDriverIdV1("driver_id")
+     *     await client.drivers.listV1()
      */
-    getByDriverIdV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1>;
-    private __getByDriverIdV1;
+    listV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<Chrt.Driver1[]>;
+    private __listV1;
     /**
-     * Deletes a driver from the organization and removes them from associated rate sheets. | () -> (bool)
+     * Creates a new driver profile for the caller. Returns existing driver ID if one already exists. Courier orgs only, min role: operator. | (DriverClientCreate1) -> (PydanticObjectId)
      *
-     * @param {string} driverId
+     * @param {Chrt.DriverClientCreate1} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.drivers.deleteV1("driver_id")
+     *     await client.drivers.createV1({
+     *         schema_version: 1
+     *     })
      */
-    deleteV1(driverId: string, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteV1;
+    createV1(request: Chrt.DriverClientCreate1, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<string>;
+    private __createV1;
     /**
-     * Sets the activation status of a driver (active/inactive) within the organization. | (SetDriverActivationReq) -> (bool)
+     * Updates driver contact details and vehicle type assignments. Courier orgs only; caller must be the driver (self) or an operator+. | (DriverClientUpdate1) -> (bool)
      *
-     * @param {Chrt.SetDriverActivationReq} request
+     * @param {string} driverId
+     * @param {Chrt.DriverClientUpdate1} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.drivers.setActivationV1({
-     *         driver_object_id: "driver_object_id",
-     *         active: true
-     *     })
+     *     await client.drivers.updateV1("driver_id")
      */
-    setActivationV1(request: Chrt.SetDriverActivationReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __setActivationV1;
+    updateV1(driverId: string, request?: Chrt.DriverClientUpdate1, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateV1;
     /**
-     * Updates the driver's last known location and timestamp for tracking purposes. | (DriverLastSeenReq) -> (bool)
+     * Updates the caller's driver last known location and timestamp for tracking. Only updates if timestamp is newer than existing (DB-side validation). Returns False if driver not found or timestamp is stale. | (DriverLastSeenReq) -> (bool)
      *
      * @param {Chrt.DriverLastSeenReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
@@ -129,7 +111,7 @@ export declare class Drivers {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.drivers.lastSeenV1({
+     *     await client.drivers.updateLastSeenV1({
      *         location: {
      *             type: "Feature",
      *             geometry: {
@@ -142,32 +124,48 @@ export declare class Drivers {
      *         }
      *     })
      */
-    lastSeenV1(request: Chrt.DriverLastSeenReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __lastSeenV1;
+    updateLastSeenV1(request: Chrt.DriverLastSeenReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateLastSeenV1;
     /**
      * Clears the driver's last known location and timestamp. | () -> (bool)
      *
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.drivers.lastSeenClearV1()
+     *     await client.drivers.clearLastSeenV1()
+     */
+    clearLastSeenV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __clearLastSeenV1;
+    /**
+     * 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)
+     *
+     * @param {Chrt.DriverUpdateAvailabilityReq} request
+     * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.drivers.updateAvailabilityAccordingToDriverV1({
+     *         available: true
+     *     })
      */
-    lastSeenClearV1(requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __lastSeenClearV1;
+    updateAvailabilityAccordingToDriverV1(request: Chrt.DriverUpdateAvailabilityReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateAvailabilityAccordingToDriverV1;
     /**
-     * Updates driver contact details and vehicle type assignments within the organization. | (UpdateDriverDetailsReq) -> (bool)
+     * 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)
      *
-     * @param {Chrt.UpdateDriverDetailsReq} request
+     * @param {string} driverId
+     * @param {Chrt.DriverUpdateAvailabilityReq} request
      * @param {Drivers.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.drivers.updateDriverV1({
-     *         driver_object_id: "driver_object_id"
+     *     await client.drivers.updateAvailabilityAccordingToOperatorsV1("driver_id", {
+     *         available: true
      *     })
      */
-    updateDriverV1(request: Chrt.UpdateDriverDetailsReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateDriverV1;
+    updateAvailabilityAccordingToOperatorsV1(driverId: string, request: Chrt.DriverUpdateAvailabilityReq, requestOptions?: Drivers.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __updateAvailabilityAccordingToOperatorsV1;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }