btrz-api-client 8.28.0 → 8.30.0

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

@@ -1,47 +1,23 @@
 export = printSettingsFactory;
+/**
+ * Factory for print-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, create: function, remove: function, versions: { 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;
-    get: ({ token, query, headers, printTemplateId }: {
-        token: any;
-        query: any;
-        headers: any;
-        printTemplateId: any;
-    }) => any;
-    update: ({ jwtToken, token, printTemplateId, printTemplate, headers, query }: {
-        jwtToken: any;
-        token: any;
-        printTemplateId: any;
-        printTemplate: any;
-        headers: any;
-        query: any;
-    }) => any;
-    create: ({ jwtToken, token, printTemplate, headers }: {
-        jwtToken: any;
-        token: any;
-        printTemplate: any;
-        headers: any;
-    }) => any;
-    remove: ({ printTemplateId, token, jwtToken, headers }: {
-        printTemplateId: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }) => any;
+    all: Function;
+    get: Function;
+    update: Function;
+    create: Function;
+    remove: Function;
     versions: {
-        update({ printTemplateId, token, jwtToken, headers, query, versionId }: {
-            printTemplateId: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-            query: any;
-            versionId: any;
-        }): any;
+        update: Function;
     };
 };

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

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

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

@@ -1,17 +1,17 @@
 export = revenueManagementSettingsFactory;
+/**
+ * Factory for rms-settings (revenue management) 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 revenueManagementSettingsFactory({ 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, revenueManagementSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        revenueManagementSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

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

@@ -1,25 +1,18 @@
 export = s3BucketsFactory;
+/**
+ * Factory for s3Buckets (account) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function, remove: function, create: function }}
+ */
 declare function s3BucketsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    update: ({ jwtToken, token, bucketId, s3BucketData, headers }: {
-        jwtToken: any;
-        token: any;
-        bucketId: any;
-        s3BucketData: any;
-        headers: any;
-    }) => any;
-    remove: ({ jwtToken, token, bucketId, headers }: {
-        jwtToken: any;
-        token: any;
-        bucketId: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, s3BucketData, headers }: {
-        jwtToken: any;
-        token: any;
-        s3BucketData: any;
-        headers: any;
-    }) => any;
+    update: Function;
+    remove: Function;
+    create: Function;
 };

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

@@ -1,18 +1,17 @@
 export = salesforceSettingsFactory;
+/**
+ * Factory for salesforce-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 salesforceSettingsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ jwtToken, token, query, headers }: {
-        jwtToken: any;
-        token: any;
-        query: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, salesforceSettings, headers }: {
-        jwtToken: any;
-        token: any;
-        salesforceSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

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

@@ -1,18 +1,17 @@
 export = shiftSettingsFactory;
+/**
+ * Factory for shift-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 shiftSettingsFactory({ 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, shiftSettings, headers }: {
-        jwtToken: any;
-        token: any;
-        shiftSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

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

@@ -1,231 +1,38 @@
 export = shiftsFactory;
+/**
+ * Factory for shifts 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, update: function, requiresAgencyShiftClosure: object, payments: object, transactions: object, tickets: object, fees: object, refunds: object, items: object, redeemableItems: object, giftCertificates: object, parcels: object, insurances: object, invoices: object, deposits: object, manualTickets: object, locationClosures: object, startingBalances: object, purchaseLimitPayments: object, salesSummary: object, commissions: object }}
+ */
 declare function shiftsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ jwtToken, token, query, headers }: {
-        jwtToken: any;
-        token: any;
-        query: any;
-        headers: any;
-    }) => any;
-    get: ({ token, userId, headers }: {
-        token: any;
-        userId: any;
-        headers: any;
-    }) => any;
-    create: ({ jwtToken, token, shiftData, headers }: {
-        jwtToken: any;
-        token: any;
-        shiftData: any;
-        headers: any;
-    }) => any;
-    update: ({ jwtToken, token, shiftId, operations, headers, query }: {
-        jwtToken: any;
-        token: any;
-        shiftId: any;
-        operations: any;
-        headers: any;
-        query: any;
-    }) => any;
-    requiresAgencyShiftClosure: {
-        put({ token, jwtToken, shiftId, headers, shiftData }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-            shiftData: any;
-        }): any;
-    };
-    payments: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    transactions: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    tickets: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    fees: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    refunds: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    items: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    redeemableItems: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    giftCertificates: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    parcels: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    insurances: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    invoices: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-    };
-    deposits: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-        create({ jwtToken, token, shiftId, deposit, headers }: {
-            jwtToken: any;
-            token: any;
-            shiftId: any;
-            deposit: any;
-            headers: any;
-        }): any;
-    };
-    manualTickets: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
-        create({ jwtToken, token, shiftId, manualTicket, headers }: {
-            jwtToken: any;
-            token: any;
-            shiftId: any;
-            manualTicket: any;
-            headers: any;
-        }): any;
-    };
-    locationClosures: {
-        create({ jwtToken, token, locationClosure, headers }: {
-            jwtToken: any;
-            token: any;
-            locationClosure: any;
-            headers: any;
-        }): any;
-        all({ jwtToken, token, query, headers }: {
-            jwtToken: any;
-            token: any;
-            query: any;
-            headers: any;
-        }): any;
-        get({ token, jwtToken, locationClosureId, headers }: {
-            token: any;
-            jwtToken: any;
-            locationClosureId: any;
-            headers: any;
-        }): any;
-        comments: {
-            create({ jwtToken, token, locationClosureId, locationClosureComment, headers }: {
-                jwtToken: any;
-                token: any;
-                locationClosureId: any;
-                locationClosureComment: any;
-                headers: any;
-            }): any;
-        };
-        status: {
-            update({ jwtToken, token, locationClosureId, locationClosureStatusChange, headers }: {
-                jwtToken: any;
-                token: any;
-                locationClosureId: any;
-                locationClosureStatusChange: any;
-                headers: any;
-            }): any;
-        };
-    };
-    startingBalances: {
-        create({ jwtToken, token, shiftId, startingBalance, headers }: {
-            jwtToken: any;
-            token: any;
-            shiftId: any;
-            startingBalance: any;
-            headers: any;
-        }): any;
-    };
-    purchaseLimitPayments: {
-        get({ token, jwtToken, locationId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            locationId: any;
-            query: any;
-            headers: any;
-        }): any;
-    };
-    salesSummary: {
-        get({ token, jwtToken, shiftId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            query: any;
-            headers: any;
-        }): any;
-    };
-    commissions: {
-        get({ token, jwtToken, shiftId, headers }: {
-            token: any;
-            jwtToken: any;
-            shiftId: any;
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    all: Function;
+    get: Function;
+    create: Function;
+    update: Function;
+    requiresAgencyShiftClosure: object;
+    payments: object;
+    transactions: object;
+    tickets: object;
+    fees: object;
+    refunds: object;
+    items: object;
+    redeemableItems: object;
+    giftCertificates: object;
+    parcels: object;
+    insurances: object;
+    invoices: object;
+    deposits: object;
+    manualTickets: object;
+    locationClosures: object;
+    startingBalances: object;
+    purchaseLimitPayments: object;
+    salesSummary: object;
+    commissions: object;
 };

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

@@ -1,55 +1,25 @@
 export = smsTemplatesFactory;
+/**
+ * Factory for sms-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 smsTemplatesFactory({ 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, smsTemplateId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        smsTemplateId: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, data, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, smsTemplateId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        smsTemplateId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    remove: ({ token, jwtToken, smsTemplateId, headers }: {
-        token: any;
-        jwtToken: any;
-        smsTemplateId: 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, smsTemplateId, versionId, query, headers }: {
-            token: any;
-            jwtToken: any;
-            smsTemplateId: any;
-            versionId: any;
-            query?: {};
-            headers: any;
-        }): any;
+        update: Function;
     };
 };

package/types/endpoints/accounts/sub-print-templates.d.ts

@@ -1,12 +1,16 @@
 export = subPrintTemplatesFactory;
+/**
+ * Factory for sub-print-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 declare function subPrintTemplatesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ jwtToken, token, subPrintTemplate, headers }: {
-        jwtToken: any;
-        token: any;
-        subPrintTemplate: any;
-        headers: any;
-    }) => any;
+    create: Function;
 };

package/types/endpoints/accounts/ticket-movement-settings.d.ts

@@ -1,17 +1,17 @@
 export = ticketMovementSettingsFactory;
+/**
+ * Factory for ticket-movement-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 ticketMovementSettingsFactory({ 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, ticketMovementSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        ticketMovementSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };

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

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

package/types/endpoints/accounts/transport-regulation-settings.d.ts

@@ -1,17 +1,17 @@
 export = transportRegulationSettingsForCNRT;
+/**
+ * Factory for transport-regulation-settings (CNRT) 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 transportRegulationSettingsForCNRT({ 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, transportRegulationSettings, headers }: {
-        token: any;
-        jwtToken: any;
-        transportRegulationSettings: any;
-        headers: any;
-    }) => any;
+    get: Function;
+    update: Function;
 };