btrz-api-client 8.29.0 → 8.30.0

package/types/endpoints/inventory/custom-fields.d.ts

@@ -1,37 +1,31 @@
 export = customFieldsFactory;
+/**
+ * Query params for custom-fields endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryCustomFieldsQuery
+ */
+/**
+ * Factory for custom-fields 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, types: object }}
+ */
 declare function customFieldsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ fieldId, token, jwtToken, query, headers }: {
-        fieldId: any;
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, field, headers }: {
-        token: any;
-        jwtToken: any;
-        field: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, fieldId, field, headers }: {
-        token: any;
-        jwtToken: any;
-        fieldId: any;
-        field: any;
-        headers: any;
-    }) => any;
-    types: {
-        all({ token, headers }: {
-            token: any;
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    types: object;
 };
+declare namespace customFieldsFactory {
+    export { InventoryCustomFieldsQuery };
+}
+/**
+ * Query params for custom-fields endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryCustomFieldsQuery = any;

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

@@ -1,6 +1,12 @@
 export = docsFactory;
+/**
+ * Factory for API docs (btrz-api-inventory).
+ * @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/inventory/document-types.d.ts

@@ -1,43 +1,33 @@
 export = documentTypesFactory;
+/**
+ * @typedef {Object} DocumentTypesQuery
+ * @property {string} [providerId] - Provider account ID (also set via opts.providerId)
+ */
+/**
+ * Factory for document-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 declare function documentTypesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    get: ({ token, jwtToken, id, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    update: ({ token, jwtToken, id, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    remove: ({ token, jwtToken, id, query, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    update: Function;
+    remove: Function;
+    create: Function;
+};
+declare namespace documentTypesFactory {
+    export { DocumentTypesQuery };
+}
+type DocumentTypesQuery = {
+    /**
+     * - Provider account ID (also set via opts.providerId)
+     */
+    providerId?: string;
 };

package/types/endpoints/inventory/external-passes.d.ts

@@ -1,18 +1,30 @@
 export = externalPassesFactory;
+/**
+ * @typedef {Object} ExternalPassesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for external-passes 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 externalPassesFactory({ 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: ({ externalPassId, token, jwtToken, headers }: {
-        externalPassId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+};
+declare namespace externalPassesFactory {
+    export { ExternalPassesQuery };
+}
+type ExternalPassesQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/inventory/external-wallets.d.ts

@@ -1,40 +1,16 @@
 export = externalWalletsFactory;
+/**
+ * Factory for external-wallets API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ saldoMax: object }}
+ */
 declare function externalWalletsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    saldoMax: {
-        all: ({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }) => any;
-        create: ({ token, jwtToken, externalWallet, headers }: {
-            token: any;
-            jwtToken: any;
-            externalWallet: any;
-            headers: any;
-        }) => any;
-        get: ({ token, jwtToken, walletId, headers }: {
-            token: any;
-            jwtToken: any;
-            walletId: any;
-            headers: any;
-        }) => any;
-        update: ({ token, jwtToken, externalWallet, headers }: {
-            token: any;
-            jwtToken: any;
-            externalWallet: any;
-            headers: any;
-        }) => any;
-        movements: {
-            create: ({ token, jwtToken, walletId, movement }: {
-                token: any;
-                jwtToken: any;
-                walletId: any;
-                movement: any;
-            }) => any;
-        };
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    saldoMax: object;
 };

package/types/endpoints/inventory/fallback-codes.d.ts

@@ -1,30 +1,19 @@
 export = fallbackCodesFactory;
+/**
+ * Factory for fallback-codes 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 }}
+ */
 declare function fallbackCodesFactory({ 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;
-    create: ({ token, jwtToken, fallbackCode, headers }: {
-        token: any;
-        jwtToken: any;
-        fallbackCode: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, fallbackCodeId, fallbackCode, headers }: {
-        token: any;
-        jwtToken: any;
-        fallbackCodeId: any;
-        fallbackCode: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
 };

package/types/endpoints/inventory/fare-classes.d.ts

@@ -1,25 +1,29 @@
 export = fareClassesFactory;
+/**
+ * Query params for fare-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryFareClassesQuery
+ */
+/**
+ * Factory for fare-classes 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 }}
+ */
 declare function fareClassesFactory({ 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, fareClass, headers }: {
-        token: any;
-        jwtToken: any;
-        fareClass: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, fareClassId, update, headers }: {
-        token: any;
-        jwtToken: any;
-        fareClassId: any;
-        update: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    create: Function;
+    update: Function;
 };
+declare namespace fareClassesFactory {
+    export { InventoryFareClassesQuery };
+}
+/**
+ * Query params for fare-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryFareClassesQuery = any;

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

@@ -1,45 +1,34 @@
 export = faresFactory;
+/**
+ * Query params for fares endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryFaresQuery
+ */
+/**
+ * Factory for fares API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, create: function, adjustments: { create: function, remove: function } }}
+ */
 declare function faresFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, id, headers }: {
-        token: any;
-        id: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, fareId, fare, headers }: {
-        token: any;
-        jwtToken: any;
-        fareId: any;
-        fare: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, fare, headers }: {
-        token: any;
-        jwtToken: any;
-        fare: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    update: Function;
+    create: Function;
     adjustments: {
-        create({ token, jwtToken, fareId, adjustmentsOverride, headers }: {
-            token: any;
-            jwtToken: any;
-            fareId: any;
-            adjustmentsOverride: any;
-            headers: any;
-        }): any;
-        remove({ token, jwtToken, fareId, adjustmentId, headers }: {
-            token: any;
-            jwtToken: any;
-            fareId: any;
-            adjustmentId: any;
-            headers: any;
-        }): any;
+        create: Function;
+        remove: Function;
     };
 };
+declare namespace faresFactory {
+    export { InventoryFaresQuery };
+}
+/**
+ * Query params for fares endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryFaresQuery = any;

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

@@ -1,30 +1,30 @@
 export = feesFactory;
+/**
+ * Query params for fees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryFeesQuery
+ */
+/**
+ * Factory for fees 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 }}
+ */
 declare function feesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, feeId, headers }: {
-        token: any;
-        jwtToken: any;
-        feeId: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, fee, headers }: {
-        token: any;
-        jwtToken: any;
-        fee: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, feeId, fee, headers }: {
-        token: any;
-        jwtToken: any;
-        feeId: any;
-        fee: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
 };
+declare namespace feesFactory {
+    export { InventoryFeesQuery };
+}
+/**
+ * Query params for fees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ */
+type InventoryFeesQuery = any;

package/types/endpoints/inventory/filtered-trips-v2.d.ts

@@ -1,12 +1,16 @@
 export = filteredTripsV2Factory;
+/**
+ * Factory for filtered-trips-v2 API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 declare function filteredTripsV2Factory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, filteredTrip, headers }: {
-        token: any;
-        jwtToken: any;
-        filteredTrip: any;
-        headers: any;
-    }) => any;
+    create: Function;
 };

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

@@ -1,18 +1,17 @@
 export = filteredTripsFactory;
+/**
+ * Factory for filtered-trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function }}
+ */
 declare function filteredTripsFactory({ 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, tripSegmentsId, headers }: {
-        token: any;
-        jwtToken: any;
-        tripSegmentsId: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    create: Function;
 };

package/types/endpoints/inventory/financing-costs.d.ts

@@ -1,39 +1,33 @@
 export = financingCostsFactory;
+/**
+ * @typedef {Object} FinancingCostsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for financing-costs 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 financingCostsFactory({ 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: ({ id, token, headers, jwtToken, query }: {
-        id: any;
-        token: any;
-        headers: any;
-        jwtToken: any;
-        query?: {};
-    }) => any;
-    create: ({ jwtToken, token, financingCost, headers }: {
-        jwtToken: any;
-        token: any;
-        financingCost: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, id, financingCost, headers }: {
-        jwtToken: any;
-        token: any;
-        id: any;
-        financingCost: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, id, token, headers, query }: {
-        jwtToken: any;
-        id: any;
-        token: any;
-        headers: any;
-        query?: {};
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
+};
+declare namespace financingCostsFactory {
+    export { FinancingCostsQuery };
+}
+type FinancingCostsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

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

@@ -1,37 +1,33 @@
 export = garagesFactory;
+/**
+ * @typedef {Object} GaragesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for garages 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 garagesFactory({ 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, garageId, headers }: {
-        token: any;
-        jwtToken: any;
-        garageId: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, garageId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        garageId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    remove: ({ token, jwtToken, garageId, headers }: {
-        token: any;
-        jwtToken: any;
-        garageId: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
+};
+declare namespace garagesFactory {
+    export { GaragesQuery };
+}
+type GaragesQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };