btrz-api-client 8.29.0 → 8.31.0

package/types/endpoints/operations/manifest.d.ts

@@ -1,244 +1,27 @@
 export = manifestFactory;
+/**
+ * @typedef {Object} ManifestQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for manifests API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} manifest API methods
+ */
 declare function manifestFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    getAll: ({ token, jwtToken, providerId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        providerId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    getById: ({ token, jwtToken, manifestId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    outlook: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    patch: ({ token, jwtToken, query, operations, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        operations: any;
-        headers: any;
-    }) => any;
-    save: ({ token, jwtToken, providerId, data, headers, query }: {
-        token: any;
-        jwtToken: any;
-        providerId: any;
-        data: any;
-        headers: any;
-        query?: {};
-    }) => any;
-    addUser: ({ token, jwtToken, manifestId, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    removeUser: ({ token, jwtToken, manifestId, userId, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        userId: any;
-        headers: any;
-    }) => any;
-    updateComment: ({ token, jwtToken, manifestId, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    updateStatus: ({ token, jwtToken, manifestId, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    addCapacityException: ({ token, jwtToken, manifestId, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    removeCapacityException: ({ token, jwtToken, manifestId, exceptionId, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestId: any;
-        exceptionId: any;
-        headers: any;
-    }) => any;
-    dispatch: ({ token, jwtToken, headers, manifestId, data, query }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        manifestId: any;
-        data: any;
-        query: any;
-    }) => any;
-    updateDispatchReporting: ({ token, jwtToken, headers, manifestId, data }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        manifestId: any;
-        data: any;
-    }) => any;
-    createDispatchReporting: ({ token, jwtToken, headers, data }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        data: any;
-    }) => any;
-    statusBulkUpdate: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
-    getSalesAuthorizations: ({ token, jwtToken, manifestKey, query, headers }: {
-        token: any;
-        jwtToken: any;
-        manifestKey: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    manifestsExceptions: {
-        update({ token, jwtToken, manifestKey, manifestException, headers, query }: {
-            token: any;
-            jwtToken: any;
-            manifestKey: any;
-            manifestException: any;
-            headers: any;
-            query?: {};
-        }): any;
-    };
-    checkIn: {
-        create({ token, jwtToken, query, headers, data, manifestId, legFromId }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-            data: any;
-            manifestId: any;
-            legFromId: any;
-        }): any;
-        open({ token, jwtToken, query, headers, manifestId, legFromId }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-            manifestId: any;
-            legFromId: any;
-        }): any;
-        close({ token, jwtToken, query, headers, manifestId, legFromId }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-            manifestId: any;
-            legFromId: any;
-        }): any;
-    };
-    legs: {
-        update({ token, jwtToken, data, query, headers, manifestId, legFromId }: {
-            token: any;
-            jwtToken: any;
-            data: any;
-            query?: {};
-            headers: any;
-            manifestId: any;
-            legFromId: any;
-        }): any;
-        tickets: {
-            update({ token, jwtToken, data, query, headers, manifestId, legFromId, ticketId }: {
-                token: any;
-                jwtToken: any;
-                data: any;
-                query?: {};
-                headers: any;
-                manifestId: any;
-                legFromId: any;
-                ticketId: any;
-            }): any;
-            noshow({ token, jwtToken, query, headers, manifestId, legFromId, ticketId }: {
-                token: any;
-                jwtToken: any;
-                query?: {};
-                headers: any;
-                manifestId: any;
-                legFromId: any;
-                ticketId: any;
-            }): any;
-        };
-    };
-    reports: {
-        get({ token, jwtToken, query, responseType, id, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            responseType?: string;
-            id: any;
-            headers: any;
-        }): any;
-    };
-    labels: {
-        add({ token, jwtToken, manifestId, query, headers, data }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            query?: {};
-            headers: any;
-            data: any;
-        }): any;
-        remove({ token, jwtToken, manifestId, labelId, headers }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            labelId: any;
-            headers: any;
-        }): any;
-    };
-    driverRelays: {
-        update({ token, jwtToken, manifestId, query, headers, data }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            query?: {
-                bypassValidation: boolean;
-            };
-            headers: any;
-            data: any;
-        }): any;
-    };
-    tripClose: {
-        add({ token, jwtToken, manifestId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            query?: {};
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): any;
+declare namespace manifestFactory {
+    export { ManifestQuery };
+}
+type ManifestQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/manifest_leg_for_tickets.d.ts

@@ -1,13 +1,14 @@
 export = manifestLegForTicketsFactory;
+/**
+ * Factory for manifest-leg-for-tickets API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} manifest-leg-for-tickets API methods
+ */
 declare function manifestLegForTicketsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, ticketId, params, headers }: {
-        token: any;
-        jwtToken: any;
-        ticketId: any;
-        params: any;
-        headers: any;
-    }) => any;
-};
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;

package/types/endpoints/operations/movements.d.ts

@@ -1,13 +1,27 @@
 export = movementsFactory;
+/**
+ * @typedef {Object} MovementsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for movements API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} movements API methods
+ */
 declare function movementsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    create: ({ token, jwtToken, movement, query, headers }: {
-        token: any;
-        jwtToken: any;
-        movement: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace movementsFactory {
+    export { MovementsQuery };
+}
+type MovementsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/outlook-trips.d.ts

@@ -1,10 +1,27 @@
 export = outlookTripsFactory;
-declare function outlookTripsFactory({ client }: {
-    client: any;
-}): {
-    get: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
+/**
+ * @typedef {Object} OutlookTripsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for outlook-trips API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} outlook-trips API methods
+ */
+declare function outlookTripsFactory({ client, internalAuthTokenProvider }: {
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace outlookTripsFactory {
+    export { OutlookTripsQuery };
+}
+type OutlookTripsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/parcels.d.ts

@@ -1,41 +1,27 @@
 export = parcelFactory;
+/**
+ * @typedef {Object} ParcelsQuery
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ */
+/**
+ * Factory for parcels API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} parcels API methods
+ */
 declare function parcelFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, id, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-    }) => any;
-    all: ({ token, jwtToken, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    addScan: ({ token, jwtToken, id, operationType, locationData, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        operationType: any;
-        locationData: any;
-        headers: any;
-    }) => any;
-    addComment: ({ token, jwtToken, headers, id, comment }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        id: any;
-        comment: any;
-    }) => any;
-    deleteComment: ({ token, jwtToken, headers, id, commentId }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        id: any;
-        commentId: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace parcelFactory {
+    export { ParcelsQuery };
+}
+type ParcelsQuery = {
+    /**
+     * - Provider account ID (also set via opts.providerId)
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/parcels_manifests.d.ts

@@ -1,52 +1,76 @@
 export = parcelsManifestsFactory;
+/**
+ * Query params for GET /parcels-manifests (btrz-api-operations getSpec).
+ * @typedef {Object} ParcelsManifestsListQuery
+ * @property {string} [date] - Date of manifests (ParcelsManifests.DATE_FORMAT)
+ * @property {string} [dateFrom] - Start date range (same format)
+ * @property {string} [dateTo] - End date range (same format)
+ * @property {string} [originId] - Origin (departure) station ID (24 hex chars)
+ * @property {string} [destinationId] - Destination station ID (24 hex chars)
+ * @property {string} [externalId] - External id associated
+ * @property {number} [page] - Page to return
+ * @property {number} [recordsPerPage] - Records per page (max 100)
+ */
+/**
+ * POST /parcels-manifests, POST .../parcels, POST .../vehicles do not define query params in backend getSpec.
+ * Use for optional query keys forwarded as-is.
+ * @typedef {Object} ParcelsManifestsPostQuery
+ */
+/**
+ * Factory for parcels-manifests API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} parcels-manifests API (all, get, create, parcels, vehicles)
+ */
 declare function parcelsManifestsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, id, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    parcels: {
-        remove({ token, jwtToken, manifestId, parcelId, headers }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            parcelId: any;
-            headers: any;
-        }): any;
-        create({ token, jwtToken, manifestId, query, data, headers }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            query?: {};
-            data: any;
-            headers: any;
-        }): any;
-    };
-    vehicles: {
-        createOrUpdate({ token, jwtToken, manifestId, query, data, headers }: {
-            token: any;
-            jwtToken: any;
-            manifestId: any;
-            query?: {};
-            data: any;
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): any;
+declare namespace parcelsManifestsFactory {
+    export { ParcelsManifestsListQuery, ParcelsManifestsPostQuery };
+}
+/**
+ * Query params for GET /parcels-manifests (btrz-api-operations getSpec).
+ */
+type ParcelsManifestsListQuery = {
+    /**
+     * - Date of manifests (ParcelsManifests.DATE_FORMAT)
+     */
+    date?: string;
+    /**
+     * - Start date range (same format)
+     */
+    dateFrom?: string;
+    /**
+     * - End date range (same format)
+     */
+    dateTo?: string;
+    /**
+     * - Origin (departure) station ID (24 hex chars)
+     */
+    originId?: string;
+    /**
+     * - Destination station ID (24 hex chars)
+     */
+    destinationId?: string;
+    /**
+     * - External id associated
+     */
+    externalId?: string;
+    /**
+     * - Page to return
+     */
+    page?: number;
+    /**
+     * - Records per page (max 100)
+     */
+    recordsPerPage?: number;
 };
+/**
+ * POST /parcels-manifests, POST .../parcels, POST .../vehicles do not define query params in backend getSpec.
+ * Use for optional query keys forwarded as-is.
+ */
+type ParcelsManifestsPostQuery = any;

package/types/endpoints/operations/passenger_check_in_info.d.ts

@@ -1,33 +1,49 @@
 export = passengerCheckInInfoFactory;
+/**
+ * Query params for GET /passenger-check-in-info (btrz-api-operations getSpec).
+ * @typedef {Object} PassengerCheckInInfoListQuery
+ * @property {string} documentType - Document type id (ObjectId; required)
+ * @property {string} documentNumber - Document number of the passenger (required)
+ * @property {string} [providerId] - Provider/account id; defaults to authenticated account when omitted
+ */
+/**
+ * PUT and POST /passenger-check-in-info do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ * @typedef {Object} PassengerCheckInInfoPostQuery
+ */
+/**
+ * Factory for passenger-check-in-info API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} passenger-check-in-info API methods
+ */
 declare function passengerCheckInInfoFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, id, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, id, data, headers, query }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        data: any;
-        headers: any;
-        query: any;
-    }) => any;
-    create: ({ token, jwtToken, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace passengerCheckInInfoFactory {
+    export { PassengerCheckInInfoListQuery, PassengerCheckInInfoPostQuery };
+}
+/**
+ * Query params for GET /passenger-check-in-info (btrz-api-operations getSpec).
+ */
+type PassengerCheckInInfoListQuery = {
+    /**
+     * - Document type id (ObjectId; required)
+     */
+    documentType: string;
+    /**
+     * - Document number of the passenger (required)
+     */
+    documentNumber: string;
+    /**
+     * - Provider/account id; defaults to authenticated account when omitted
+     */
+    providerId?: string;
 };
+/**
+ * PUT and POST /passenger-check-in-info do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ */
+type PassengerCheckInInfoPostQuery = any;

package/types/endpoints/operations/redemption.d.ts

@@ -1,25 +1,14 @@
 export = redemptionFactory;
+/**
+ * Factory for redemptions API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} redemptions API methods
+ */
 declare function redemptionFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    create: ({ token, jwtToken, redemption, headers }: {
-        token: any;
-        jwtToken: any;
-        redemption: any;
-        headers: any;
-    }) => any;
-    getValidate: ({ token, jwtToken, passId, timezone, headers }: {
-        token: any;
-        jwtToken: any;
-        passId: any;
-        timezone: any;
-        headers: any;
-    }) => any;
-    unredeem: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
-};
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;