btrz-api-client 8.29.0 → 8.31.0

package/types/constants.d.ts

@@ -1 +1,8 @@
-export let INTERNAL_AUTH_TOKEN_SYMBOL: string;
+export = constants;
+/**
+ * Shared constants for the API client.
+ * @type {{ INTERNAL_AUTH_TOKEN_SYMBOL: string }}
+ */
+declare const constants: {
+    INTERNAL_AUTH_TOKEN_SYMBOL: string;
+};

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

@@ -1,20 +1,19 @@
 export = accountsFactory;
+/**
+ * Factory for accounts API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, defaultUsers: { create: function } }}
+ */
 declare function accountsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ jwtToken, accountId, headers }: {
-        jwtToken: any;
-        accountId: any;
-        headers: any;
-    }) => any;
+    get: Function;
     defaultUsers: {
-        create({ token, jwtToken, accountId, data, headers }: {
-            token: any;
-            jwtToken: any;
-            accountId: any;
-            data: any;
-            headers: any;
-        }): any;
+        create: Function;
     };
 };

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

@@ -1,38 +1,20 @@
 export = applicationSettingsFactory;
+/**
+ * Factory for application-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, remove: function, regenerateKeys: function, create: function }}
+ */
 declare function applicationSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, providerId, jwtToken, query, headers }: {
-        token: any;
-        providerId: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, id, application, headers }: {
-        jwtToken: any;
-        token: any;
-        id: any;
-        application: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, token, id, headers }: {
-        jwtToken: any;
-        token: any;
-        id: any;
-        headers: any;
-    }) => any;
-    regenerateKeys: ({ jwtToken, token, id, headers }: {
-        jwtToken: any;
-        token: any;
-        id: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, application, headers }: {
-        jwtToken: any;
-        token: any;
-        application: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
+    remove: Function;
+    regenerateKeys: Function;
+    create: Function;
 };

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

@@ -1,11 +1,16 @@
 export = applicationsFactory;
+/**
+ * Factory for current application (single) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 declare function applicationsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    get: Function;
 };

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

@@ -1,18 +1,17 @@
 export = applicationsFactory;
+/**
+ * Factory for applications (by id/name) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, getByName: function }}
+ */
 declare function applicationsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, id, jwtToken, headers }: {
-        token: any;
-        id: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    getByName: ({ token, appName, jwtToken, headers }: {
-        token: any;
-        appName: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    getByName: Function;
 };

package/types/endpoints/accounts/current-shifts.d.ts

@@ -1,12 +1,16 @@
 export = currentShiftsFactory;
+/**
+ * Factory for current-shift (per user) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 declare function currentShiftsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, userId, query, headers }: {
-        token: any;
-        userId: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    get: Function;
 };

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

@@ -1,52 +1,22 @@
 export = customersFactory;
+/**
+ * Factory for customers API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ put: function, all: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
+ */
 declare function customersFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    put: ({ customerId, customer, token, jwtToken, headers }: {
-        customerId: any;
-        customer: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    all: ({ token, jwtToken, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    create: ({ customer, token, jwtToken, query, headers }: {
-        customer: any;
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    signIn: ({ email, password, apiKey }: {
-        email: any;
-        password: any;
-        apiKey: any;
-    }) => any;
-    signInCas: ({ service, ticket, token, headers }: {
-        service: any;
-        ticket: any;
-        token: any;
-        headers: any;
-    }) => any;
-    update: ({ customerId, token, jwtToken, data, query, headers }: {
-        customerId: any;
-        token: any;
-        jwtToken: any;
-        data: any;
-        query: any;
-        headers: any;
-    }) => any;
-    merge: ({ destinationCustomerId, sourceCustomerIds, jwtToken, token }: {
-        destinationCustomerId: any;
-        sourceCustomerIds: any;
-        jwtToken: any;
-        token: any;
-    }) => any;
+    put: Function;
+    all: Function;
+    create: Function;
+    signIn: Function;
+    signInCas: Function;
+    update: Function;
+    merge: Function;
 };

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

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

@@ -1,23 +1,18 @@
 export = domainsFactory;
+/**
+ * Factory for domains API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, remove: function }}
+ */
 declare function domainsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ data, token, jwtToken, headers }: {
-        data: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    remove: ({ domain, token, jwtToken, headers }: {
-        domain: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    create: Function;
+    remove: Function;
 };

package/types/endpoints/accounts/dynamic-forms.d.ts

@@ -1,68 +1,27 @@
 export = dynamicFormsFactory;
+/**
+ * Factory for dynamic-forms API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, all: function, create: function, update: function, remove: function, fields: { get: function, all: function, create: function, update: function, remove: function } }}
+ */
 declare function dynamicFormsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, dynamicFormId, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        dynamicFormId: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, dynamicFormId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        dynamicFormId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    remove: ({ dynamicFormId, token, jwtToken, headers }: {
-        dynamicFormId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    all: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
     fields: {
-        get({ token, jwtToken, dynamicFormFieldId, headers }?: {}): any;
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
-        create({ jwtToken, token, data, headers }: {
-            jwtToken: any;
-            token: any;
-            data: any;
-            headers: any;
-        }): any;
-        update({ jwtToken, token, dynamicFormFieldId, data, headers }: {
-            jwtToken: any;
-            token: any;
-            dynamicFormFieldId: any;
-            data: any;
-            headers: any;
-        }): any;
-        remove({ dynamicFormFieldId, token, jwtToken, headers }: {
-            dynamicFormFieldId: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-        }): any;
+        get: Function;
+        all: Function;
+        create: Function;
+        update: Function;
+        remove: Function;
     };
 };

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

@@ -1,38 +1,20 @@
 export = emailSettingsFactory;
+/**
+ * Factory for email-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getByEmail: function, create: function, update: function, remove: function }}
+ */
 declare function emailSettingsFactory({ 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;
-    getByEmail: ({ token, jwtToken, email, query, headers }: {
-        token: any;
-        jwtToken: any;
-        email: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ data, token, jwtToken, headers }: {
-        data: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, email, data, headers }: {
-        token: any;
-        jwtToken: any;
-        email: any;
-        data: any;
-        headers: any;
-    }) => any;
-    remove: ({ email, token, jwtToken, headers }: {
-        email: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    getByEmail: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
 };

package/types/endpoints/accounts/email-templates.d.ts

@@ -1,60 +1,133 @@
 export = emailTemplatesFactory;
+/**
+ * @typedef {Object} EmailTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by template type
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales | any | mobileapp
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | custom
+ * @property {string} [status] - draft | published
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {string} [lang] - ISO language code (e.g. en-us)
+ * @property {number} [page] - 1-based page for pagination
+ */
+/**
+ * @typedef {Object} EmailTemplatePostData
+ * @property {string} name - Template name
+ * @property {string} type - Template type
+ * @property {string} subject - Subject line (plain text + Liquid)
+ * @property {string} lang - ISO language code (e.g. en-us)
+ * @property {string} htmlTemplate - HTML body (no scripts)
+ * @property {string} txtTemplate - Plain text body (no HTML)
+ * @property {string} [channel] - any (default) or other channel
+ * @property {string} [status] - draft | published
+ * @property {string} [templateCollectionId] - default | custom (required for accountId "")
+ * @property {string} [accountId] - "" for global template (super user)
+ */
+/**
+ * Factory for email-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getTypes: function, all: function, get: function, create: function, update: function, remove: function, createSub: function, versions: { update: function } }}
+ */
 declare function emailTemplatesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    getTypes: ({ token, jwtToken, headers }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, emailTemplateId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        emailTemplateId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, emailTemplateId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        emailTemplateId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    remove: ({ token, jwtToken, emailTemplateId, headers }: {
-        token: any;
-        jwtToken: any;
-        emailTemplateId: any;
-        headers: any;
-    }) => any;
-    createSub: ({ token, jwtToken, mainTemplateId, agencyId, headers }: {
-        token: any;
-        jwtToken: any;
-        mainTemplateId: any;
-        agencyId: any;
-        headers: any;
-    }) => any;
+    getTypes: Function;
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    remove: Function;
+    createSub: Function;
     versions: {
-        update({ token, jwtToken, emailTemplateId, versionId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            emailTemplateId: any;
-            versionId: any;
-            query?: {};
-            headers: any;
-        }): any;
+        update: Function;
     };
 };
+declare namespace emailTemplatesFactory {
+    export { EmailTemplatesListQuery, EmailTemplatePostData };
+}
+type EmailTemplatesListQuery = {
+    /**
+     * - Filter by provider account (ObjectId)
+     */
+    providerId?: string;
+    /**
+     * - Filter by template type
+     */
+    type?: string;
+    /**
+     * - backoffice | agency-backoffice | websales | agency-websales | any | mobileapp
+     */
+    channel?: string;
+    /**
+     * - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+     */
+    sort?: string;
+    /**
+     * - default | custom
+     */
+    templateCollectionId?: string;
+    /**
+     * - draft | published
+     */
+    status?: string;
+    /**
+     * - Filter by source provider (ObjectId)
+     */
+    mainTemplateAccountId?: string;
+    /**
+     * - ISO language code (e.g. en-us)
+     */
+    lang?: string;
+    /**
+     * - 1-based page for pagination
+     */
+    page?: number;
+};
+type EmailTemplatePostData = {
+    /**
+     * - Template name
+     */
+    name: string;
+    /**
+     * - Template type
+     */
+    type: string;
+    /**
+     * - Subject line (plain text + Liquid)
+     */
+    subject: string;
+    /**
+     * - ISO language code (e.g. en-us)
+     */
+    lang: string;
+    /**
+     * - HTML body (no scripts)
+     */
+    htmlTemplate: string;
+    /**
+     * - Plain text body (no HTML)
+     */
+    txtTemplate: string;
+    /**
+     * - any (default) or other channel
+     */
+    channel?: string;
+    /**
+     * - draft | published
+     */
+    status?: string;
+    /**
+     * - default | custom (required for accountId "")
+     */
+    templateCollectionId?: string;
+    /**
+     * - "" for global template (super user)
+     */
+    accountId?: string;
+};

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

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