btrz-api-client 8.28.0 → 8.30.0

package/types/endpoints/accounts/exchange-receipts.d.ts

@@ -1,17 +1,17 @@
 export = exchangeReceiptsFactory;
+/**
+ * Factory for exchange-receipt-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function, get: function }}
+ */
 declare function exchangeReceiptsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    update: ({ data, token, jwtToken, headers }: {
-        data: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    update: Function;
+    get: Function;
 };

package/types/endpoints/accounts/goal-settings.d.ts

@@ -1,18 +1,17 @@
 export = goalSettingsFactory;
+/**
+ * Factory for goal-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function goalSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, goalSettings, headers }: {
-        jwtToken: any;
-        token: any;
-        goalSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/images.d.ts

@@ -1,31 +1,19 @@
 export = ImagesFactory;
+/**
+ * Factory for images API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, remove: function }}
+ */
 declare function ImagesFactory({ 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, query, headers, imageId }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-        imageId: any;
-    }) => any;
-    create: ({ jwtToken, token, image, headers }: {
-        jwtToken: any;
-        token: any;
-        image: any;
-        headers: any;
-    }) => any;
-    remove: ({ imageId, token, jwtToken, headers }: {
-        imageId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    create: Function;
+    remove: Function;
 };

package/types/endpoints/accounts/interline.d.ts

@@ -1,68 +1,20 @@
 export = interlineFactory;
+/**
+ * Factory for interline API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ invitations: object, consumers: object, providers: object, network: object, remove: function }}
+ */
 declare function interlineFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    invitations: {
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
-        get({ token, invitationId, headers }: {
-            token: any;
-            invitationId: any;
-            headers: any;
-        }): any;
-        create({ data, token, jwtToken, headers }: {
-            data: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-        }): any;
-        update({ invitationId, data, token, jwtToken, headers }: {
-            invitationId: any;
-            data: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-        }): any;
-    };
-    consumers: {
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
-    };
-    providers: {
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
-    network: {
-        get({ token, interlineId, headers }: {
-            token: any;
-            interlineId: any;
-            headers: any;
-        }): any;
-        update({ interlineId, data, token, jwtToken, headers }: {
-            interlineId: any;
-            data: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-        }): any;
-    };
-    remove({ interlineId, token, jwtToken, headers }: {
-        interlineId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }): any;
+}): {
+    invitations: object;
+    consumers: object;
+    providers: object;
+    network: object;
+    remove: Function;
 };

package/types/endpoints/accounts/journey-prices-settings.d.ts

@@ -1,17 +1,17 @@
 export = journeyPricesSettingsFactory;
+/**
+ * Factory for journey-prices-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function journeyPricesSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, journeyPricesSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        journeyPricesSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/lexicons.d.ts

@@ -1,142 +1,27 @@
 export = lexiconsFactory;
+/**
+ * Factory for lexicons API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, createOrUpdateMany: function, updateMany: function, getByText: function, suggestions: { list: function, getById: function, update: function, delete: function, create: function } }}
+ */
 declare function lexiconsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, context, query, headers }: {
-        token: any;
-        context: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, lexiconEntries, headers }: {
-        token: any;
-        jwtToken: any;
-        lexiconEntries: any;
-        headers: any;
-    }) => any;
-    createOrUpdateMany: ({ token, jwtToken, entries, headers }: {
-        token: any;
-        jwtToken: any;
-        entries: any;
-        headers: any;
-    }) => any;
-    updateMany: ({ token, jwtToken, updates, headers }: {
-        token: any;
-        jwtToken: any;
-        updates: any;
-        headers: any;
-    }) => any;
-    getByText: ({ token, jwtToken, headers, lang, txt }: {
-        lang: string;
-        txt: string;
-        token?: string;
-        jwtToken?: string;
-        headers?: any;
-    }) => Promise<{
-        data: {
-            lexiconTextContentItems: any[];
-        };
-    }>;
+    all: Function;
+    create: Function;
+    createOrUpdateMany: Function;
+    updateMany: Function;
+    getByText: Function;
     suggestions: {
-        /**
-         * List lexicon suggestions for the account (or all accounts when super user params are provided).
-         * @param {Object} opts
-         * @param {string} [opts.token] - API key (x-api-key)
-         * @param {string} [opts.jwtToken] - JWT or constants.INTERNAL_AUTH_TOKEN_SYMBOL for internal auth
-         * @param {Object} [opts.headers] - Optional request headers
-         * @param {Object} [opts.params] - Query params: status, lang, key, superUserId, superUserHash
-         * @returns {Promise<{data: { suggestions: Array }}>}
-         */
-        list({ token, jwtToken, headers, params }: {
-            token?: string;
-            jwtToken?: string;
-            headers?: any;
-            params?: any;
-        }): Promise<{
-            data: {
-                suggestions: any[];
-            };
-        }>;
-        /**
-         * Get a single lexicon suggestion by id.
-         * @param {Object} opts
-         * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion
-         * @param {string} [opts.token] - API key
-         * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-         * @param {Object} [opts.headers] - Optional request headers
-         * @param {Object} [opts.params] - Query params: superUserId, superUserHash (to access any account's suggestion)
-         * @returns {Promise<{data: Object}>}
-         */
-        getById({ token, jwtToken, headers, suggestionId, params }: {
-            suggestionId: string;
-            token?: string;
-            jwtToken?: string;
-            headers?: any;
-            params?: any;
-        }): Promise<{
-            data: any;
-        }>;
-        /**
-         * Update a lexicon suggestion (status and optional rejected_reason). Requires super user auth.
-         * @param {Object} opts
-         * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion
-         * @param {Object} opts.data - { status, [rejected_reason] }
-         * @param {string} opts.superUserId - Super user id (required)
-         * @param {string} opts.superUserHash - Super user hash (required)
-         * @param {string} [opts.token] - API key
-         * @param {string} [opts.jwtToken] - JWT
-         * @param {Object} [opts.headers] - Optional request headers
-         * @returns {Promise<{data: Object}>}
-         */
-        update({ token, jwtToken, headers, suggestionId, data, superUserId, superUserHash }: {
-            suggestionId: string;
-            data: any;
-            superUserId: string;
-            superUserHash: string;
-            token?: string;
-            jwtToken?: string;
-            headers?: any;
-        }): Promise<{
-            data: any;
-        }>;
-        /**
-         * Delete a lexicon suggestion by id. Only suggestions with status "under review" can be deleted.
-         * @param {Object} opts
-         * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion to delete
-         * @param {string} [opts.token] - API key
-         * @param {string} [opts.jwtToken] - JWT
-         * @param {Object} [opts.headers] - Optional request headers
-         * @returns {Promise<{status: number}>} Resolves with 204 on success
-         */
-        delete({ token, jwtToken, headers, suggestionId }: {
-            suggestionId: string;
-            token?: string;
-            jwtToken?: string;
-            headers?: any;
-        }): Promise<{
-            status: number;
-        }>;
-        /**
-         * Submit a translation suggestion for an existing lexicon key and language.
-         * @param {Object} opts
-         * @param {string} opts.key - The existing lexicon key to suggest a translation for
-         * @param {string} opts.lang - Supported language code (e.g. en-us, pt-br)
-         * @param {Object} opts.data - { txt } - The suggested translation text
-         * @param {string} [opts.token] - API key
-         * @param {string} [opts.jwtToken] - JWT
-         * @param {Object} [opts.headers] - Optional request headers
-         * @returns {Promise<{data: Object}>}
-         */
-        create({ token, jwtToken, headers, key, lang, data }: {
-            key: string;
-            lang: string;
-            data: any;
-            token?: string;
-            jwtToken?: string;
-            headers?: any;
-        }): Promise<{
-            data: any;
-        }>;
+        list: Function;
+        getById: Function;
+        update: Function;
+        delete: Function;
+        create: Function;
     };
 };

package/types/endpoints/accounts/market-pricing-settings.d.ts

@@ -1,17 +1,17 @@
 export = marketPricingSettingsFactory;
+/**
+ * Factory for market-pricing-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function marketPricingSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, marketPricingSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        marketPricingSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/multiproduct-sales-settings.d.ts

@@ -1,17 +1,17 @@
 export = multiproductSalesSettingsFactory;
+/**
+ * Factory for multiproduct-sales-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function multiproductSalesSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/network.d.ts

@@ -1,46 +1,23 @@
 export = networkFactory;
+/**
+ * Factory for network API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ agencies: { all: function, get: function, update: function, create: function, removeProduct: function, removeFare: function } }}
+ */
 declare function networkFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
     agencies: {
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
-        get({ token, query, headers, sellerId }: {
-            token: any;
-            query: any;
-            headers: any;
-            sellerId: any;
-        }): any;
-        update({ jwtToken, token, sellerId, agency, headers, query }: {
-            jwtToken: any;
-            token: any;
-            sellerId: any;
-            agency: any;
-            headers: any;
-            query: any;
-        }): any;
-        create({ jwtToken, token, agency, headers }: {
-            jwtToken: any;
-            token: any;
-            agency: any;
-            headers: any;
-        }): any;
-        removeProduct({ token, jwtToken, productId, headers }: {
-            token: any;
-            jwtToken: any;
-            productId: any;
-            headers: any;
-        }): any;
-        removeFare({ token, jwtToken, fareId, headers }: {
-            token: any;
-            jwtToken: any;
-            fareId: any;
-            headers: any;
-        }): any;
+        all: Function;
+        get: Function;
+        update: Function;
+        create: Function;
+        removeProduct: Function;
+        removeFare: Function;
     };
 };

package/types/endpoints/accounts/operation-settings.d.ts

@@ -1,18 +1,17 @@
 export = operationSettingsFactory;
+/**
+ * Factory for operation-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function operationSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, operationSettings, headers }: {
-        jwtToken: any;
-        token: any;
-        operationSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/people-lookups.d.ts

@@ -1,42 +1,20 @@
 export = peopleLookupsFactory;
+/**
+ * Factory for people-lookups API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, update: function, create: function, remove: function }}
+ */
 declare function peopleLookupsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-        providerId: any;
-    }) => any;
-    getById: ({ token, jwtToken, query, headers, personId, providerId }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-        personId: any;
-        providerId: any;
-    }) => any;
-    update: ({ jwtToken, token, personId, person, headers, providerId }: {
-        jwtToken: any;
-        token: any;
-        personId: any;
-        person: any;
-        headers: any;
-        providerId: any;
-    }) => any;
-    create: ({ jwtToken, token, person, headers, providerId }: {
-        jwtToken: any;
-        token: any;
-        person: any;
-        headers: any;
-        providerId: any;
-    }) => any;
-    remove: ({ personId, token, jwtToken, headers }: {
-        personId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    getById: Function;
+    update: Function;
+    create: Function;
+    remove: Function;
 };

package/types/endpoints/accounts/point-to-point-settings.d.ts

@@ -1,17 +1,17 @@
 export = pointToPointSettingsFactory;
+/**
+ * Factory for point-to-point-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 declare function pointToPointSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, pointToPointSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        pointToPointSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

package/types/endpoints/accounts/print-settings.d.ts

@@ -1,17 +1,17 @@
 export = printSettingsFactory;
+/**
+ * Factory for print-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, update: function }}
+ */
 declare function printSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, printSettings, headers }: {
-        jwtToken: any;
-        token: any;
-        printSettings: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    update: Function;
 };