btrz-api-client 8.29.0 → 8.31.0

package/types/endpoints/inventory/traveller-card-types.d.ts

@@ -1,37 +1,31 @@
 export = travellerCardTypesFactory;
+/**
+ * Query params for GET /traveller-card-types (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTravellerCardTypesListQuery
+ */
+/**
+ * Factory for traveller-card-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function, remove: function }}
+ */
 declare function travellerCardTypesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, travellerCardType, headers }: {
-        token: any;
-        jwtToken: any;
-        travellerCardType: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, travellerCardTypeId, travellerCardType, headers }: {
-        jwtToken: any;
-        token: any;
-        travellerCardTypeId: any;
-        travellerCardType: any;
-        headers: any;
-    }) => any;
-    get: ({ token, travellerCardTypeId, jwtToken, headers }: {
-        token: any;
-        travellerCardTypeId: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    remove: ({ token, travellerCardTypeId, jwtToken, headers }: {
-        token: any;
-        travellerCardTypeId: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    create: Function;
+    update: Function;
+    get: Function;
+    remove: Function;
 };
+declare namespace travellerCardTypesFactory {
+    export { InventoryTravellerCardTypesListQuery };
+}
+/**
+ * Query params for GET /traveller-card-types (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryTravellerCardTypesListQuery = any;

package/types/endpoints/inventory/trips.d.ts

@@ -1,17 +1,28 @@
 export = tripsFactory;
+/**
+ * Query params for GET /trips (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTripsListQuery
+ */
+/**
+ * Factory for trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
 declare function tripsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, id, headers }: {
-        token: any;
-        id: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
 };
+declare namespace tripsFactory {
+    export { InventoryTripsListQuery };
+}
+/**
+ * Query params for GET /trips (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryTripsListQuery = any;

package/types/endpoints/inventory/vehicle-types.d.ts

@@ -1,18 +1,16 @@
 export = vehicleTypesFactory;
+/**
+ * Factory for vehicle-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 declare function vehicleTypesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: string;
-        query?: any;
-        headers?: any;
-    }) => Promise<{
-        data: {
-            vehicleTypes: Array<{
-                _id: string;
-                name: string;
-            }>;
-        };
-    }>;
+    all: Function;
 };

package/types/endpoints/inventory/vehicles.d.ts

@@ -1,53 +1,34 @@
 export = vehiclesFactory;
+/**
+ * @typedef {Object} VehiclesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for vehicles API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, seatmaps: object }}
+ */
 declare function vehiclesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ vehicleId, token, headers }: {
-        vehicleId: any;
-        token: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, vehicle, headers }: {
-        jwtToken: any;
-        token: any;
-        vehicle: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, vehicleId, vehicle, headers }: {
-        jwtToken: any;
-        token: any;
-        vehicleId: any;
-        vehicle: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, vehicleId, token, headers }: {
-        jwtToken: any;
-        vehicleId: any;
-        token: any;
-        headers: any;
-    }) => any;
-    seatmaps: {
-        create({ jwtToken, token, vehicleId, seatmap, headers, newdesign }: {
-            jwtToken: any;
-            token: any;
-            vehicleId: any;
-            seatmap: any;
-            headers: any;
-            newdesign: any;
-        }): any;
-        remove({ jwtToken, vehicleId, seatMapId, token, headers, newdesign }: {
-            jwtToken: any;
-            vehicleId: any;
-            seatMapId: any;
-            token: any;
-            headers: any;
-            newdesign: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
+    seatmaps: object;
+};
+declare namespace vehiclesFactory {
+    export { VehiclesQuery };
+}
+type VehiclesQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/inventory/zone-price-overages.d.ts

@@ -1,35 +1,31 @@
 export = zonePriceOverageFactory;
+/**
+ * Query params for zone-price-overages endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryZonePriceOveragesQuery
+ */
+/**
+ * Factory for zone-price-overages API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 declare function zonePriceOverageFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ zonePriceOverageId, token, headers }: {
-        zonePriceOverageId: any;
-        token: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, zonePriceOverages, headers }: {
-        jwtToken: any;
-        token: any;
-        zonePriceOverages: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, zonePriceOverageId, zonePriceOverages, headers }: {
-        jwtToken: any;
-        token: any;
-        zonePriceOverageId: any;
-        zonePriceOverages: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, zonePriceOverageId, token, headers }: {
-        jwtToken: any;
-        zonePriceOverageId: any;
-        token: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
 };
+declare namespace zonePriceOverageFactory {
+    export { InventoryZonePriceOveragesQuery };
+}
+/**
+ * Query params for zone-price-overages endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryZonePriceOveragesQuery = any;

package/types/endpoints/inventory/zone-prices.d.ts

@@ -1,35 +1,31 @@
 export = zonePriceFactory;
+/**
+ * Query params for zone-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryZonePricesQuery
+ */
+/**
+ * Factory for zone-prices API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
 declare function zonePriceFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ zonePriceId, token, headers }: {
-        zonePriceId: any;
-        token: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, zonePrice, headers }: {
-        jwtToken: any;
-        token: any;
-        zonePrice: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, zonePriceId, zonePrice, headers }: {
-        jwtToken: any;
-        token: any;
-        zonePriceId: any;
-        zonePrice: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, zonePriceId, token, headers }: {
-        jwtToken: any;
-        zonePriceId: any;
-        token: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
 };
+declare namespace zonePriceFactory {
+    export { InventoryZonePricesQuery };
+}
+/**
+ * Query params for zone-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryZonePricesQuery = any;

package/types/endpoints/invoices/dlink.d.ts

@@ -1,20 +1,34 @@
 export = dlinkFactory;
+/**
+ * Query params for POST /dlink (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceDlinkPostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+/**
+ * Factory for DLink invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 declare function dlinkFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    validateCreate: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
+    validateCreate: Function;
+};
+declare namespace dlinkFactory {
+    export { InvoiceDlinkPostQuery };
+}
+/**
+ * Query params for POST /dlink (btrz-api-invoices). onlyValidateRequest optional.
+ */
+type InvoiceDlinkPostQuery = {
+    /**
+     * - If true, only validates the payload and does not process it
+     */
+    onlyValidateRequest?: string;
 };

package/types/endpoints/invoices/docs.d.ts

@@ -1,6 +1,12 @@
 export = docsFactory;
+/**
+ * Factory for invoices API docs (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 declare function docsFactory({ client }: {
-    client: any;
+    client: import("axios").AxiosInstance;
 }): {
-    get: () => any;
+    get: Function;
 };

package/types/endpoints/invoices/emails.d.ts

@@ -1,13 +1,27 @@
 export = emailsFactory;
+/**
+ * Query params for POST /emails (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoiceEmailsPostQuery
+ */
+/**
+ * Factory for invoice emails API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 declare function emailsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
 };
+declare namespace emailsFactory {
+    export { InvoiceEmailsPostQuery };
+}
+/**
+ * Query params for POST /emails (btrz-api-invoices). Forwarded to API as-is.
+ */
+type InvoiceEmailsPostQuery = any;

package/types/endpoints/invoices/gti.d.ts

@@ -1,20 +1,34 @@
 export = gtiFactory;
+/**
+ * Query params for POST /gti (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceGtiPostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+/**
+ * Factory for GTI invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 declare function gtiFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    validateCreate: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
+    validateCreate: Function;
+};
+declare namespace gtiFactory {
+    export { InvoiceGtiPostQuery };
+}
+/**
+ * Query params for POST /gti (btrz-api-invoices). onlyValidateRequest optional.
+ */
+type InvoiceGtiPostQuery = {
+    /**
+     * - If true, only validates the payload and does not process it
+     */
+    onlyValidateRequest?: string;
 };

package/types/endpoints/invoices/infile.d.ts

@@ -1,20 +1,34 @@
 export = infileFactory;
+/**
+ * Query params for POST /infile (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceInfilePostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+/**
+ * Factory for Infile invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 declare function infileFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    validateCreate: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
+    validateCreate: Function;
+};
+declare namespace infileFactory {
+    export { InvoiceInfilePostQuery };
+}
+/**
+ * Query params for POST /infile (btrz-api-invoices). onlyValidateRequest optional.
+ */
+type InvoiceInfilePostQuery = {
+    /**
+     * - If true, only validates the payload and does not process it
+     */
+    onlyValidateRequest?: string;
 };

package/types/endpoints/invoices/infileJson.d.ts

@@ -1,20 +1,34 @@
 export = infileJsonFactory;
+/**
+ * Query params for POST /infile-json (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceInfileJsonPostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+/**
+ * Factory for Infile JSON invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 declare function infileJsonFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    validateCreate: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
+    validateCreate: Function;
+};
+declare namespace infileJsonFactory {
+    export { InvoiceInfileJsonPostQuery };
+}
+/**
+ * Query params for POST /infile-json (btrz-api-invoices). onlyValidateRequest optional.
+ */
+type InvoiceInfileJsonPostQuery = {
+    /**
+     * - If true, only validates the payload and does not process it
+     */
+    onlyValidateRequest?: string;
 };

package/types/endpoints/invoices/invoices.d.ts

@@ -1,39 +1,31 @@
 export = invoicesFactory;
+/**
+ * Query params for invoices endpoints (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoicesQuery
+ */
+/**
+ * Factory for invoices API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, getInvoicesFailures: function, retryInvoicing: function, overrideBuyerRetryInvoicing: function }}
+ */
 declare function invoicesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, id, query, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    getInvoicesFailures: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    retryInvoicing: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    overrideBuyerRetryInvoicing: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    getInvoicesFailures: Function;
+    retryInvoicing: Function;
+    overrideBuyerRetryInvoicing: Function;
 };
+declare namespace invoicesFactory {
+    export { InvoicesQuery };
+}
+/**
+ * Query params for invoices endpoints (btrz-api-invoices). Forwarded to API as-is.
+ */
+type InvoicesQuery = any;