btrz-api-client 8.29.0 → 8.31.0

package/types/endpoints/btrzpay/payment-methods.d.ts

@@ -1,61 +1,32 @@
 export = paymentMethodsFactory;
+/**
+ * Query params for GET /payment-methods (btrz-api-payments). Passed through as-is when no backend spec found.
+ * @typedef {Object} PaymentMethodsListQuery
+ * @property {string} [providerName] - Filter by provider name (deprecated; use getByProviderName for single provider)
+ */
+/**
+ * Factory for payment methods API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} methods all, getByProviderName, create, get, update, setToAgency,
+ *   createDefaultPaymentMethods, deleteCustomersCreditCardInfo, deletePaymentMethodsDomain
+ */
 declare function paymentMethodsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
-    getByProviderName: ({ token, jwtToken, providerName, headers }: {
-        token: any;
-        jwtToken: any;
-        providerName: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, paymentMethod, headers }: {
-        token: any;
-        jwtToken: any;
-        paymentMethod: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, paymentMethodId, headers, query }: {
-        token: any;
-        jwtToken: any;
-        paymentMethodId: any;
-        headers: any;
-        query?: {};
-    }) => any;
-    setToAgency: ({ token, jwtToken, agencyId, providerId, paymentMethodNames, headers }: {
-        token: any;
-        jwtToken: any;
-        agencyId: any;
-        providerId: any;
-        paymentMethodNames: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, paymentMethodId, paymentMethod, headers }: {
-        token: any;
-        jwtToken: any;
-        paymentMethodId: any;
-        paymentMethod: any;
-        headers: any;
-    }) => any;
-    createDefaultPaymentMethods: ({ token, jwtToken, accountId }: {
-        token: any;
-        jwtToken: any;
-        accountId: any;
-    }) => any;
-    deleteCustomersCreditCardInfo: ({ token, jwtToken, paymentMethodId }: {
-        token: any;
-        jwtToken: any;
-        paymentMethodId: any;
-    }) => any;
-    deletePaymentMethodsDomain: ({ token, jwtToken, domain }: {
-        token: any;
-        jwtToken: any;
-        domain: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace paymentMethodsFactory {
+    export { PaymentMethodsListQuery };
+}
+/**
+ * Query params for GET /payment-methods (btrz-api-payments). Passed through as-is when no backend spec found.
+ */
+type PaymentMethodsListQuery = {
+    /**
+     * - Filter by provider name (deprecated; use getByProviderName for single provider)
+     */
+    providerName?: string;
 };

package/types/endpoints/btrzpay/payments.d.ts

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

package/types/endpoints/btrzpay/prismaTerminals.d.ts

@@ -1,102 +1,35 @@
 export = prismaTerminalsFactory;
+/**
+ * @typedef {Object} PrismaTerminalsQuery
+ * @property {string} [providerId] - Account provider/operator ID for agencies/sellers
+ * @property {boolean} [validateRefund] - (PUT refunds only) If true, fetch current state from Prisma before applying
+ */
+/**
+ * Factory for Prisma terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ payments: Object, settlements: Object }}
+ */
 declare function prismaTerminalsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    payments: {
-        get({ token, jwtToken, id, query, headers }: {
-            token: any;
-            jwtToken: any;
-            id: any;
-            query?: {};
-            headers: any;
-        }): any;
-        create({ token, jwtToken, prismaPayment, query, headers }: {
-            token: any;
-            jwtToken: any;
-            prismaPayment: any;
-            query?: {};
-            headers: any;
-        }): any;
-        delete({ token, jwtToken, id, query, headers }: {
-            token: any;
-            jwtToken: any;
-            id: any;
-            query?: {};
-            headers: any;
-        }): any;
-        update({ token, jwtToken, id, prismaPayment, query, headers }: {
-            token: any;
-            jwtToken: any;
-            id: any;
-            prismaPayment: any;
-            query?: {};
-            headers: any;
-        }): any;
-        reversals: {
-            get({ token, jwtToken, id, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                query?: {};
-                headers: any;
-            }): any;
-            create({ token, jwtToken, id, prismaReversal, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                prismaReversal: any;
-                query?: {};
-                headers: any;
-            }): any;
-            delete({ token, jwtToken, id, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                query?: {};
-                headers: any;
-            }): any;
-        };
-        refunds: {
-            get({ token, jwtToken, id, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                query?: {};
-                headers: any;
-            }): any;
-            create({ token, jwtToken, id, prismaRefund, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                prismaRefund: any;
-                query?: {};
-                headers: any;
-            }): any;
-            delete({ token, jwtToken, id, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                query?: {};
-                headers: any;
-            }): any;
-            update({ token, jwtToken, id, prismaRefund, query, headers }: {
-                token: any;
-                jwtToken: any;
-                id: any;
-                prismaRefund: any;
-                query?: {};
-                headers: any;
-            }): any;
-        };
-    };
-    settlements: {
-        create({ token, jwtToken, settlement, query, headers }: {
-            token: any;
-            jwtToken: any;
-            settlement: any;
-            query?: {};
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    payments: any;
+    settlements: any;
+};
+declare namespace prismaTerminalsFactory {
+    export { PrismaTerminalsQuery };
+}
+type PrismaTerminalsQuery = {
+    /**
+     * - Account provider/operator ID for agencies/sellers
+     */
+    providerId?: string;
+    /**
+     * - (PUT refunds only) If true, fetch current state from Prisma before applying
+     */
+    validateRefund?: boolean;
 };

package/types/endpoints/btrzpay/reference-numbers.d.ts

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

package/types/endpoints/btrzpay/referenced-payments.d.ts

@@ -1,21 +1,17 @@
 export = referencedPaymentsFactory;
+/**
+ * Factory for referenced payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getStatus: function, update: function }}
+ */
 declare function referencedPaymentsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    getStatus: ({ token, jwtToken, transactionId, referenceNumber, headers }: {
-        token: any;
-        jwtToken: any;
-        transactionId: any;
-        referenceNumber: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, externalType, referenceNumber, paymentResult, headers }: {
-        token: any;
-        jwtToken: any;
-        externalType: any;
-        referenceNumber: any;
-        paymentResult: any;
-        headers: any;
-    }) => any;
+    getStatus: Function;
+    update: Function;
 };

package/types/endpoints/btrzpay/square.d.ts

@@ -1,22 +1,30 @@
+/**
+ * Factory for Square webhooks API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 export function squareWebhooksFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    create: ({ token, jwtToken, data, providerId, headers }: {
-        token: any;
-        jwtToken: any;
-        data: any;
-        providerId: any;
-        headers: any;
-    }) => any;
+    create: Function;
 };
+/**
+ * Factory for Square terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 export function squareTerminalsFactory({ 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/btrzpay/stripe-terminals.d.ts

@@ -1,20 +1,30 @@
 export = stripeTerminalsFactory;
+/**
+ * @typedef {Object} StripeTerminalsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for Stripe terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, simulate: function }}
+ */
 declare function stripeTerminalsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, jwtToken, headers, query }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        query?: {};
-    }) => any;
-    simulate: ({ token, jwtToken, id, stripePayment, query, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        stripePayment: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    all: Function;
+    simulate: Function;
+};
+declare namespace stripeTerminalsFactory {
+    export { StripeTerminalsQuery };
+}
+type StripeTerminalsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/btrzpay/terminalPayments.d.ts

@@ -1,32 +1,30 @@
 export = terminalPaymentsFactory;
+/**
+ * @typedef {Object} TerminalPaymentsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for terminal payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ mit: Object, webhooks: Object }}
+ */
 declare function terminalPaymentsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    mit: {
-        update({ token, jwtToken, id, terminalPayment, query, headers }: {
-            token: any;
-            jwtToken: any;
-            id: any;
-            terminalPayment: any;
-            query?: {};
-            headers: any;
-        }): any;
-        get({ token, jwtToken, id, query, headers }: {
-            token: any;
-            jwtToken: any;
-            id: any;
-            query?: {};
-            headers: any;
-        }): any;
-    };
-    webhooks: {
-        getnet({ data, providerId, headers, token, jwtToken }: {
-            data: any;
-            providerId: any;
-            headers?: {};
-            token: any;
-            jwtToken: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): {
+    mit: any;
+    webhooks: any;
+};
+declare namespace terminalPaymentsFactory {
+    export { TerminalPaymentsQuery };
+}
+type TerminalPaymentsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

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

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

@@ -1,13 +1,16 @@
 export = mergedFareTablesFactory;
+/**
+ * Factory for Coltrane merged fare tables API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 declare function mergedFareTablesFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, jwtToken, routeId, productId, headers }: {
-        token: any;
-        jwtToken: any;
-        routeId: any;
-        productId: any;
-        headers: any;
-    }) => any;
+    get: Function;
 };

package/types/endpoints/coltrane/paths.d.ts

@@ -1,11 +1,48 @@
 export = coltraneFactory;
+/**
+ * Query params for GET /paths (btrz-api-coltrane).
+ * @typedef {Object} ColtranePathsListQuery
+ * @property {string} [providerId] - Provider id
+ * @property {string} [productId] - Product id
+ * @property {string} [originId] - Origin station id
+ * @property {string} [destinationId] - Destination station id
+ */
+/**
+ * Factory for Coltrane paths API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 declare function coltraneFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    all: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    all: Function;
+};
+declare namespace coltraneFactory {
+    export { ColtranePathsListQuery };
+}
+/**
+ * Query params for GET /paths (btrz-api-coltrane).
+ */
+type ColtranePathsListQuery = {
+    /**
+     * - Provider id
+     */
+    providerId?: string;
+    /**
+     * - Product id
+     */
+    productId?: string;
+    /**
+     * - Origin station id
+     */
+    originId?: string;
+    /**
+     * - Destination station id
+     */
+    destinationId?: string;
 };

package/types/endpoints/endpoints_helpers.d.ts

@@ -1,10 +1,17 @@
+/**
+ * Builds authorization and forwarding headers for API requests.
+ * @param {Object} opts - Options for authorization
+ * @param {string} [opts.token] - API key; sets x-api-key header when provided
+ * @param {string} [opts.jwtToken] - JWT or internal auth symbol; sets Authorization Bearer when provided
+ * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider] - When jwtToken is INTERNAL_AUTH_TOKEN_SYMBOL, getToken() is used for the Bearer token
+ * @param {Object} [opts.headers] - Optional request headers; x-amzn-trace-id and x-elevation-token are forwarded when present; cookie with "btrz-trusted" is forwarded for trusted machine
+ * @returns {Object} Headers object suitable for axios (x-api-key, Authorization, cookie, x-amzn-trace-id, x-elevation-token as applicable)
+ */
 export function authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }: {
-    token: any;
-    jwtToken: any;
-    internalAuthTokenProvider: any;
-    headers: any;
-}): {
-    "x-api-key": string;
-    cookie: any;
-    authorization: string;
-};
+    token?: string;
+    jwtToken?: string;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+    headers?: any;
+}): any;

package/types/endpoints/gps/scanner-app-location.d.ts

@@ -1,10 +1,48 @@
 export = scannerAppLocationFactory;
+/**
+ * Query params for GET /scanner-app-location (used by websales; GPS API).
+ * @typedef {Object} ScannerAppLocationQuery
+ * @property {string} [scheduleId] - Schedule id
+ * @property {string} [routeId] - Route id
+ * @property {string} [date] - Date (e.g. YYYY-MM-DD); defaults to today when omitted in websales
+ * @property {boolean} [includeTravelledPath] - Whether to include travelled path
+ */
+/**
+ * Factory for scanner app location API (GPS).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 declare function scannerAppLocationFactory({ client }: {
-    client: any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
 }): {
-    get: ({ token, query, headers }: {
-        token: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    get: Function;
+};
+declare namespace scannerAppLocationFactory {
+    export { ScannerAppLocationQuery };
+}
+/**
+ * Query params for GET /scanner-app-location (used by websales; GPS API).
+ */
+type ScannerAppLocationQuery = {
+    /**
+     * - Schedule id
+     */
+    scheduleId?: string;
+    /**
+     * - Route id
+     */
+    routeId?: string;
+    /**
+     * - Date (e.g. YYYY-MM-DD); defaults to today when omitted in websales
+     */
+    date?: string;
+    /**
+     * - Whether to include travelled path
+     */
+    includeTravelledPath?: boolean;
 };