btrz-api-client 8.29.0 → 8.30.0

package/types/endpoints/operations/rms.d.ts

@@ -1,21 +1,27 @@
 export = rmsFactory;
+/**
+ * @typedef {Object} RmsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for RMS API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} rms API methods (manifestForecasts)
+ */
 declare function rmsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    manifestForecasts: {
-        all({ token, jwtToken, query, headers }: {
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
-        get({ scheduleId, token, jwtToken, query, headers }: {
-            scheduleId: any;
-            token: any;
-            jwtToken: any;
-            query?: {};
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): any;
+declare namespace rmsFactory {
+    export { RmsQuery };
+}
+type RmsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/scheduled_notifications.d.ts

@@ -1,39 +1,39 @@
 export = scheduledNotificationsFactory;
+/**
+ * Query params for GET /scheduled-notifications (btrz-api-operations getSpec).
+ * @typedef {Object} ScheduledNotificationsListQuery
+ * @property {string} [groupId] - Group id to retrieve
+ */
+/**
+ * PUT and POST /scheduled-notifications do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ * @typedef {Object} ScheduledNotificationsPostQuery
+ */
+/**
+ * Factory for scheduled-notifications API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} scheduled-notifications API methods
+ */
 declare function scheduledNotificationsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, id, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-    }) => any;
-    update: ({ token, jwtToken, id, data, headers, query }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        data: any;
-        headers: any;
-        query: any;
-    }) => any;
-    remove: ({ token, jwtToken, id, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-    }) => any;
-    create: ({ token, jwtToken, query, data, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        data: any;
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace scheduledNotificationsFactory {
+    export { ScheduledNotificationsListQuery, ScheduledNotificationsPostQuery };
+}
+/**
+ * Query params for GET /scheduled-notifications (btrz-api-operations getSpec).
+ */
+type ScheduledNotificationsListQuery = {
+    /**
+     * - Group id to retrieve
+     */
+    groupId?: string;
 };
+/**
+ * PUT and POST /scheduled-notifications do not define query params in backend getSpec. Use for optional query keys forwarded as-is.
+ */
+type ScheduledNotificationsPostQuery = any;

package/types/endpoints/operations/segments.d.ts

@@ -1,14 +1,31 @@
 export = segmentsFactory;
+/**
+ * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ * @typedef {Object} SegmentsListQuery
+ * @property {string} [providerId] - Provider/account id
+ */
+/**
+ * Factory for segments API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} segments API methods
+ */
 declare function segmentsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, productId, ticketId, providerId, headers }: {
-        token: any;
-        jwtToken: any;
-        productId: any;
-        ticketId: any;
-        providerId: any;
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace segmentsFactory {
+    export { SegmentsListQuery };
+}
+/**
+ * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ */
+type SegmentsListQuery = {
+    /**
+     * - Provider/account id
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/sold-items-fulfillment.d.ts

@@ -1,12 +1,27 @@
 export = soldItemsFulfillmentFactory;
+/**
+ * @typedef {Object} SoldItemsFulfillmentQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for sold-items fulfillment API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} sold-items fulfillment API methods
+ */
 declare function soldItemsFulfillmentFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace soldItemsFulfillmentFactory {
+    export { SoldItemsFulfillmentQuery };
+}
+type SoldItemsFulfillmentQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/sold-items.d.ts

@@ -1,19 +1,27 @@
 export = soldItems;
+/**
+ * @typedef {Object} SoldItemsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for sold-items API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} sold-items API methods
+ */
 declare function soldItems({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, headers, query }: {
-        token: any;
-        jwtToken: any;
-        headers: any;
-        query: any;
-    }) => any;
-    get: ({ token, jwtToken, soldItemId, headers, query }: {
-        token: any;
-        jwtToken: any;
-        soldItemId: any;
-        headers: any;
-        query: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace soldItems {
+    export { SoldItemsQuery };
+}
+type SoldItemsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/tickets.d.ts

@@ -1,48 +1,27 @@
 export = ticketsFactory;
+/**
+ * @typedef {Object} TicketsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for tickets API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} tickets API methods
+ */
 declare function ticketsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, id, headers, query }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        headers: any;
-        query: any;
-    }) => any;
-    all: ({ token, jwtToken, query, headers, providerId }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-        providerId: any;
-    }) => any;
-    patch: ({ token, jwtToken, id, operations, warningsEnabled, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        operations: any;
-        warningsEnabled: any;
-        headers: any;
-    }) => any;
-    companionTickets: ({ token, jwtToken, ticketId, headers }: {
-        token: any;
-        jwtToken: any;
-        ticketId: any;
-        headers: any;
-    }) => any;
-    updateDelivery: ({ token, jwtToken, ticketId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        ticketId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    updatePassenger: ({ token, jwtToken, ticketId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        ticketId: any;
-        data: any;
-        headers: any;
-    }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace ticketsFactory {
+    export { TicketsQuery };
+}
+type TicketsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/transaction.d.ts

@@ -1,13 +1,14 @@
 export = transactionFactory;
+/**
+ * Factory for single transaction API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transaction API methods
+ */
 declare function transactionFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, id, providerId, headers }: {
-        token: any;
-        jwtToken: any;
-        id: any;
-        providerId: any;
-        headers: any;
-    }) => any;
-};
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;

package/types/endpoints/operations/transactions.d.ts

@@ -1,89 +1,27 @@
 export = transactionsFactory;
+/**
+ * @typedef {Object} TransactionsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for transactions API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transactions API methods
+ */
 declare function transactionsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all: ({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query: any;
-        headers: any;
-    }) => any;
-    get: ({ token, jwtToken, trxId, query, headers }: {
-        token: any;
-        jwtToken: any;
-        trxId: any;
-        query: any;
-        headers: any;
-    }) => any;
-    getTickets: ({ token, jwtToken, trxId, headers }: {
-        token: any;
-        jwtToken: any;
-        trxId: any;
-        headers: any;
-    }) => any;
-    appliedInsurance: ({ token, jwtToken, trxId, headers }: {
-        token: any;
-        jwtToken: any;
-        trxId: any;
-        headers: any;
-    }) => any;
-    companionTickets: ({ token, jwtToken, transactionId, ticketIds, headers }: {
-        token: any;
-        jwtToken: any;
-        transactionId: any;
-        ticketIds: any;
-        headers: any;
-    }) => any;
-    expireAll: ({ jwtToken, transactionId, avoidEmail, token, headers }: {
-        jwtToken: any;
-        transactionId: any;
-        avoidEmail: any;
-        token: any;
-        headers: any;
-    }) => any;
-    updateDelivery: ({ token, jwtToken, trxId, data, headers }: {
-        token: any;
-        jwtToken: any;
-        trxId: any;
-        data: any;
-        headers: any;
-    }) => any;
-    cancellableItems: ({ token, jwtToken, transactionId, headers, displayAll, channel }: {
-        token: any;
-        jwtToken: any;
-        transactionId: any;
-        headers: any;
-        displayAll: any;
-        channel: any;
-    }) => any;
-    payments: {
-        update({ token, jwtToken, trxId, paymentResult, headers }: {
-            token: any;
-            jwtToken: any;
-            trxId: any;
-            paymentResult: any;
-            headers: any;
-        }): any;
-    };
-    invoices: {
-        create({ token, jwtToken, transactionId, query, invoice, headers }: {
-            token: any;
-            jwtToken: any;
-            transactionId: any;
-            query: any;
-            invoice: any;
-            headers: any;
-        }): any;
-    };
-    creditNotes: {
-        create({ token, jwtToken, transactionId, query, creditNote, headers }: {
-            token: any;
-            jwtToken: any;
-            transactionId: any;
-            query: any;
-            creditNote: any;
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): any;
+declare namespace transactionsFactory {
+    export { TransactionsQuery };
+}
+type TransactionsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/transport_regulations.d.ts

@@ -1,14 +1,14 @@
 export = transportRegulationsFactory;
+/**
+ * Factory for transport-regulations API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transport-regulations API methods (cnrt)
+ */
 declare function transportRegulationsFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    cnrt: {
-        create({ data, token, jwtToken, headers }: {
-            data: any;
-            token: any;
-            jwtToken: any;
-            headers: any;
-        }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
-};
+}): any;

package/types/endpoints/operations/trip_change_info.d.ts

@@ -1,13 +1,14 @@
 export = tripChangeInfoFactory;
+/**
+ * Factory for trip-change-info API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} trip-change-info API methods
+ */
 declare function tripChangeInfoFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    get: ({ token, jwtToken, productId, params, headers }: {
-        token: any;
-        jwtToken: any;
-        productId: any;
-        params: any;
-        headers: any;
-    }) => any;
-};
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;

package/types/endpoints/operations/vehicle_assignments.d.ts

@@ -1,31 +1,27 @@
 export = vehicleAssignmentFactory;
+/**
+ * @typedef {Object} VehicleAssignmentsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for vehicle-assignments API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} vehicle-assignments API methods
+ */
 declare function vehicleAssignmentFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    all({ token, jwtToken, query, headers }: {
-        token: any;
-        jwtToken: any;
-        query?: {};
-        headers: any;
-    }): any;
-    get({ token, jwtToken, vehicleAssignmentId, headers }: {
-        token: any;
-        jwtToken: any;
-        vehicleAssignmentId: any;
-        headers: any;
-    }): any;
-    create({ data, token, jwtToken, headers }: {
-        data: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }): any;
-    update({ vehicleAssignmentId, data, token, jwtToken, headers }: {
-        vehicleAssignmentId: any;
-        data: any;
-        token: any;
-        jwtToken: any;
-        headers: any;
-    }): any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): any;
+declare namespace vehicleAssignmentFactory {
+    export { VehicleAssignmentsQuery };
+}
+type VehicleAssignmentsQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };

package/types/endpoints/operations/vouchers.d.ts

@@ -1,22 +1,27 @@
 export = vouchersFactory;
+/**
+ * @typedef {Object} VouchersQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+/**
+ * Factory for vouchers API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} vouchers API methods
+ */
 declare function vouchersFactory({ client, internalAuthTokenProvider }: {
-    client: any;
-    internalAuthTokenProvider: any;
-}): {
-    create: ({ jwtToken, token, headers, query, voucher }: {
-        jwtToken: any;
-        token: any;
-        headers: any;
-        query?: {};
-        voucher?: {};
-    }) => any;
-    compensations: {
-        create: ({ token, jwtToken, compensation, query, headers }: {
-            token: any;
-            jwtToken: any;
-            compensation: any;
-            query?: {};
-            headers: any;
-        }) => any;
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
     };
+}): any;
+declare namespace vouchersFactory {
+    export { VouchersQuery };
+}
+type VouchersQuery = {
+    /**
+     * - Provider account ID
+     */
+    providerId?: string;
 };