btrz-api-client 8.29.0 → 8.31.0

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

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

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

@@ -1,41 +1,31 @@
 export = providersFactory;
+/**
+ * Query params for invoice providers endpoints (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoiceProvidersQuery
+ */
+/**
+ * Factory for invoice providers API (btrz-api-invoices).
+ * @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 providersFactory({ 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;
-    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 providersFactory {
+    export { InvoiceProvidersQuery };
+}
+/**
+ * Query params for invoice providers endpoints (btrz-api-invoices). Forwarded to API as-is.
+ */
+type InvoiceProvidersQuery = any;

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

@@ -1,46 +1,31 @@
 export = providersSequencesFactory;
+/**
+ * Query params for provider sequences endpoints (btrz-api-invoices). Backend getSpec for list has no query; forwarded as-is.
+ * @typedef {Object} InvoiceProvidersSequencesQuery
+ */
+/**
+ * Factory for invoice provider sequences API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, remove: function, create: function, update: function }}
+ */
 declare function providersSequencesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, invoiceProviderId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        invoiceProviderId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, invoiceProviderId, invoiceProviderSequenceId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        invoiceProviderId: any;
-        invoiceProviderSequenceId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    remove: ({ token, jwtToken, invoiceProviderId, id, query, headers }: {
-        token: any;
-        jwtToken: any;
-        invoiceProviderId: any;
-        id: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, invoiceProviderId, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        invoiceProviderId: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, invoiceProviderId, invoiceProviderSequenceId, data, query, headers }: {
-        token: any;
-        jwtToken: any;
-        invoiceProviderId: any;
-        invoiceProviderSequenceId: any;
-        data: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    remove: Function;
+    create: Function;
+    update: Function;
 };
+declare namespace providersSequencesFactory {
+    export { InvoiceProvidersSequencesQuery };
+}
+/**
+ * Query params for provider sequences endpoints (btrz-api-invoices). Backend getSpec for list has no query; forwarded as-is.
+ */
+type InvoiceProvidersSequencesQuery = any;

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

@@ -1,20 +1,34 @@
 export = systemFactory;
+/**
+ * Query params for POST /system (btrz-api-invoices getSpec).
+ * @typedef {Object} InvoiceSystemPostQuery
+ * @property {string} [onlyValidateRequest] - If set to true, only validates the payload and does not process it
+ */
+/**
+ * Factory for invoice system 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 systemFactory({ 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 systemFactory {
+    export { InvoiceSystemPostQuery };
+}
+/**
+ * Query params for POST /system (btrz-api-invoices getSpec).
+ */
+type InvoiceSystemPostQuery = {
+    /**
+     * - If set to true, only validates the payload and does not process it
+     */
+    onlyValidateRequest?: string;
 };

package/types/endpoints/invoices/tax-ids.d.ts

@@ -1,12 +1,48 @@
 export = taxIdsFactory;
+/**
+ * Query params for GET /tax-ids (btrz-api-invoices getSpec).
+ * @typedef {Object} TaxIdsListQuery
+ * @property {string} taxNumber - Tax number to look up (required)
+ * @property {string} country - ISO code of the country of the tax information (required)
+ * @property {string} [invoiceProviderId] - Invoice provider id (24 hex chars)
+ * @property {string} [documentType] - Tax identification type to check against validation service
+ */
+/**
+ * Factory for invoice tax IDs API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 declare function taxIdsFactory({ 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;
+    all: Function;
+};
+declare namespace taxIdsFactory {
+    export { TaxIdsListQuery };
+}
+/**
+ * Query params for GET /tax-ids (btrz-api-invoices getSpec).
+ */
+type TaxIdsListQuery = {
+    /**
+     * - Tax number to look up (required)
+     */
+    taxNumber: string;
+    /**
+     * - ISO code of the country of the tax information (required)
+     */
+    country: string;
+    /**
+     * - Invoice provider id (24 hex chars)
+     */
+    invoiceProviderId?: string;
+    /**
+     * - Tax identification type to check against validation service
+     */
+    documentType?: string;
 };

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

@@ -1,31 +1,40 @@
 export = movementsFactory;
+/**
+ * Query params for GET /programs/:programId/movements and related (loyalty). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} LoyaltyMovementsQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+/**
+ * Factory for loyalty movements API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, balance: Object }}
+ */
 declare function movementsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, programId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        programId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, programId, movement, query, headers }: {
-        token: any;
-        jwtToken: any;
-        programId: any;
-        movement: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    balance: {
-        get({ token, jwtToken, programId, customerId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            programId: any;
-            customerId: any;
-            query?: {};
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    all: Function;
+    create: Function;
+    balance: any;
+};
+declare namespace movementsFactory {
+    export { LoyaltyMovementsQuery };
+}
+/**
+ * Query params for GET /programs/:programId/movements and related (loyalty). Documented from client; backend may support pagination/filters.
+ */
+type LoyaltyMovementsQuery = {
+    /**
+     * - Page (if supported)
+     */
+    page?: number;
+    /**
+     * - Records per page (if supported)
+     */
+    recordsPerPage?: number;
 };

package/types/endpoints/loyalty/programs.d.ts

@@ -1,25 +1,40 @@
 export = programsFactory;
+/**
+ * Query params for GET /programs (loyalty). Client merges context into query.
+ * @typedef {Object} LoyaltyProgramsListQuery
+ * @property {string} [context] - Context (merged from opts.context by client)
+ * @property {string} [providerId] - Provider id (if supported by backend)
+ */
+/**
+ * Factory for loyalty programs API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, put: function }}
+ */
 declare function programsFactory({ 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, program, headers }: {
-        token: any;
-        jwtToken: any;
-        program: any;
-        headers: any;
-    }) => any;
-    put: ({ token, jwtToken, programId, program, headers }: {
-        token: any;
-        jwtToken: any;
-        programId: any;
-        program: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    create: Function;
+    put: Function;
+};
+declare namespace programsFactory {
+    export { LoyaltyProgramsListQuery };
+}
+/**
+ * Query params for GET /programs (loyalty). Client merges context into query.
+ */
+type LoyaltyProgramsListQuery = {
+    /**
+     * - Context (merged from opts.context by client)
+     */
+    context?: string;
+    /**
+     * - Provider id (if supported by backend)
+     */
+    providerId?: string;
 };

package/types/endpoints/notifications/customers.d.ts

@@ -1,18 +1,28 @@
 export = customersFactory;
+/**
+ * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} NotificationsCustomersQuery
+ */
+/**
+ * Factory for customers notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ sendResetPasswordEmail: function, sendActivationEmail: function }}
+ */
 declare function customersFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    sendResetPasswordEmail: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    sendActivationEmail: ({ token, query, data, headers }: {
-        token: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
+    sendResetPasswordEmail: Function;
+    sendActivationEmail: Function;
 };
+declare namespace customersFactory {
+    export { NotificationsCustomersQuery };
+}
+/**
+ * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
+ */
+type NotificationsCustomersQuery = any;

package/types/endpoints/notifications/email.d.ts

@@ -1,12 +1,27 @@
 export = emailFactory;
+/**
+ * Query params for POST /email (btrz-api-notifications). Define recipient, template, etc. Forwarded to API as-is.
+ * @typedef {Object} NotificationsEmailPostQuery
+ */
+/**
+ * Factory for email API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 declare function emailFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
 };
+declare namespace emailFactory {
+    export { NotificationsEmailPostQuery };
+}
+/**
+ * Query params for POST /email (btrz-api-notifications). Define recipient, template, etc. Forwarded to API as-is.
+ */
+type NotificationsEmailPostQuery = any;

package/types/endpoints/notifications/manifest-notifications.d.ts

@@ -1,18 +1,28 @@
 export = manifestNotificationsFactory;
+/**
+ * Query params for manifest-notifications endpoints (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} ManifestNotificationsQuery
+ */
+/**
+ * Factory for manifest-notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, all: function }}
+ */
 declare function manifestNotificationsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    create: Function;
+    all: Function;
 };
+declare namespace manifestNotificationsFactory {
+    export { ManifestNotificationsQuery };
+}
+/**
+ * Query params for manifest-notifications endpoints (btrz-api-notifications). Forwarded to API as-is.
+ */
+type ManifestNotificationsQuery = any;

package/types/endpoints/notifications/notify.d.ts

@@ -1,43 +1,38 @@
 export = notifyTicketFactory;
+/**
+ * Query params for notify-tickets and notify-vouchers (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} NotifyQuery
+ */
+/**
+ * Factory for notify (child users, tickets, vouchers, manifest) API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function } }}
+ */
 declare function notifyTicketFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
     childUsers: {
-        create({ token, jwtToken, email, lang, headers }: {
-            token: any;
-            jwtToken: any;
-            email: any;
-            lang: any;
-            headers: any;
-        }): any;
+        create: Function;
     };
     tickets: {
-        create({ token, jwtToken, query, operation, to, ticketId, headers }: {
-            token: any;
-            jwtToken: any;
-            query: any;
-            operation: any;
-            to: any;
-            ticketId: any;
-            headers: any;
-        }): any;
+        create: Function;
     };
     vouchers: {
-        create({ token, jwtToken, query, data, headers }: {
-            token: any;
-            jwtToken: any;
-            query: any;
-            data: any;
-            headers: any;
-        }): any;
+        create: Function;
     };
     manifest: {
-        create({ token, jwtToken, data, headers }: {
-            token: any;
-            jwtToken: any;
-            data: any;
-            headers: any;
-        }): any;
+        create: Function;
     };
 };
+declare namespace notifyTicketFactory {
+    export { NotifyQuery };
+}
+/**
+ * Query params for notify-tickets and notify-vouchers (btrz-api-notifications). Forwarded to API as-is.
+ */
+type NotifyQuery = any;

package/types/endpoints/notifications/orders-rules-validations.d.ts

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