btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/operations/scheduled_notifications.js

@@ -6,11 +6,6 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @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
@@ -37,7 +32,7 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /scheduled-notifications/:id - get scheduled notification by id.
+   * GET /scheduled-notifications/:id - get scheduled notification by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -54,13 +49,12 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /scheduled-notifications/:id - update scheduled notification. Backend getSpec has no query params; query is passed through.
+   * PUT /scheduled-notifications/:id - update scheduled notification. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Scheduled notification id (ObjectId)
    * @param {Object} opts.data - ScheduledNotificationPostData
-   * @param {ScheduledNotificationsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>} 404 SCHEDULEDNOTIFICATION_NOT_FOUND, 409 SCHEDULED_NOTIFICATION_EXISTS
    */
@@ -75,7 +69,7 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /scheduled-notifications/:id - remove scheduled notification.
+   * DELETE /scheduled-notifications/:id - remove scheduled notification. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -92,11 +86,10 @@ function scheduledNotificationsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /scheduled-notifications - create scheduled notification. Backend getSpec has no query params; query is passed through.
+   * POST /scheduled-notifications - create scheduled notification. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ScheduledNotificationsPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
    * @param {Object} opts.data - ScheduledNotificationPostData
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>} 409 SCHEDULED_NOTIFICATION_EXISTS

package/src/endpoints/operations/segments.js

@@ -1,9 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ * Query param for GET /products/:productId/segments/:ticketId (btrz-api-operations getSpec). Client passes via opts.providerId.
  * @typedef {Object} SegmentsListQuery
- * @property {string} [providerId] - Provider/account id
+ * @property {string} [providerId] - Provider/account id (Id of the provider account)
  */
 
 /**

package/src/endpoints/operations/sold-items-fulfillment.js

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} SoldItemsFulfillmentQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /sold-items/fulfillment (btrz-api-operations). See 01-get-fulfillment-handler getSpec().
+ * @typedef {Object} SoldItemsFulfillmentListQuery
+ * @property {string} soldItemIds - Comma-separated sold item IDs (required)
  */
 
 /**
@@ -18,7 +19,7 @@ function soldItemsFulfillmentFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {SoldItemsFulfillmentQuery} [opts.query] - Query params
+   * @param {SoldItemsFulfillmentListQuery} [opts.query] - Query params (soldItemIds required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/sold-items.js

@@ -1,8 +1,17 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} SoldItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /sold-items list (btrz-api-operations). See get-handler getSpec().
+ * @typedef {Object} SoldItemsListQuery
+ * @property {number} [page] - Page number to retrieve
+ * @property {string} [from] - Ticket manifest date from (yyyy-mm-dd; range max 31 days)
+ * @property {string} [to] - Ticket manifest date to (yyyy-mm-dd; range max 31 days)
+ */
+
+/**
+ * Query params for GET /sold-items/:soldItemId (btrz-api-operations). See get-by-id-handler getSpec().
+ * @typedef {Object} SoldItemsGetQuery
+ * @property {string} [providerId] - Provider account id (ObjectId)
  */
 
 /**
@@ -19,8 +28,8 @@ function soldItems({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.soldItemId - Sold item id
+   * @param {SoldItemsGetQuery} [opts.query] - Optional query (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {SoldItemsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, soldItemId, headers, query}) {
@@ -35,8 +44,8 @@ function soldItems({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SoldItemsListQuery} [opts.query] - Query params (page, from, to)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {SoldItemsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, jwtToken, headers, query}) {

package/src/endpoints/operations/tickets.js

@@ -1,7 +1,8 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} TicketsQuery
+ * Query params for GET /tickets list (btrz-api-operations). providerId merged when opts.providerId set.
+ * @typedef {Object} TicketsListQuery
  * @property {string} [providerId] - Provider account ID
  */
 
@@ -14,13 +15,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function ticketsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /tickets/:id - get ticket by id.
+   * GET /tickets/:id - get ticket by id. API does not accept query params (btrz-api-operations).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Ticket id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {TicketsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, id, headers, query}) {
@@ -73,7 +73,7 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TicketsQuery} [opts.query] - Query params
+   * @param {TicketsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @param {string} [opts.providerId] - Provider id
    * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/operations/transaction.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function transactionFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /transaction/:id - get transaction by id.
+   * GET /transaction/:id - get transaction by id. providerId passed as query param in URL.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/operations/transactions.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} TransactionsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for transactions API (btrz-api-operations).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function transactionsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /transactions/:trxId - get transaction by id.
+   * GET /transactions/:trxId - get transaction by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.trxId - Transaction id
-   * @param {TransactionsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,11 +27,10 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /transactions - list transactions.
+   * GET /transactions - list transactions. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {TransactionsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -128,14 +121,14 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /transactions/:transactionId/cancellable-items - get cancellable items.
+   * GET /transactions/:transactionId/cancellable-items - get cancellable items. Query: displayAll, channel (channel required per getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.transactionId - Transaction id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {boolean} [opts.displayAll] - Whether to display all items
-   * @param {string} [opts.channel] - Channel
+   * @param {boolean} [opts.displayAll] - Display all transaction items whether cancellable or not
+   * @param {string} [opts.channel] - Channel (required per btrz-api-operations getSpec)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function cancellableItems({token, jwtToken, transactionId, headers, displayAll, channel}) {
@@ -199,12 +192,11 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
 
   const creditNotes = {
     /**
-     * POST /transactions/:transactionId/credit-notes - create credit note.
+     * POST /transactions/:transactionId/credit-notes - create credit note. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.transactionId - Transaction id
-     * @param {TransactionsQuery} [opts.query] - Query params
      * @param {Object} opts.creditNote - Credit note payload
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/operations/transport_regulations.js

@@ -13,7 +13,7 @@ const {
 function transportRegulationsFactory({client, internalAuthTokenProvider}) {
   const cnrt = {
     /**
-     * POST /transport-regulations/cnrt/manifests - create CNRT manifest.
+     * POST /transport-regulations/cnrt/manifests - create CNRT manifest. API does not accept query params.
      * @param {Object} opts
      * @param {Object} opts.data - Request body
      * @param {string} [opts.token] - API key

package/src/endpoints/operations/trip_change_info.js

@@ -1,5 +1,17 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /trip-change-info/:productId (btrz-api-operations get-trip-change-info getSpec).
+ * @typedef {Object} TripChangeInfoGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [ticketNumber] - Ticket number (required for Reservation products)
+ * @property {string} [lastName] - Passenger last name (required for Reservation products)
+ * @property {string} [departureDate] - Departure date yyyy-mm-dd (required for Reservation products)
+ * @property {string} [returnDate] - Return date yyyy-mm-dd (optional for Reservation products)
+ * @property {string} [ticketId] - Ticket id
+ * @property {string} [channel] - Sales change channel (default websales)
+ */
+
 /**
  * Factory for trip-change-info API (btrz-api-operations).
  * @param {Object} deps
@@ -14,7 +26,7 @@ function tripChangeInfoFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.productId - Product id
-   * @param {Object} [opts.params] - Query params (forwarded to API)
+   * @param {TripChangeInfoGetQuery} [opts.params] - Query params (providerId, ticketNumber, lastName, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/vehicle_assignments.js

@@ -3,8 +3,13 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * @typedef {Object} VehicleAssignmentsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /vehicle-assignments list (btrz-api-operations get-handler getSpec).
+ * @typedef {Object} VehicleAssignmentsListQuery
+ * @property {string} [name] - Partial or full name of the vehicle assignment
+ * @property {string} [effectiveFrom] - Valid-from date (format per API)
+ * @property {string} [effectiveTo] - Valid-to date (format per API)
+ * @property {string} [status] - Status, comma-separated; valid: draft, published
+ * @property {number} [page] - Page number (20 records per page)
  */
 
 /**
@@ -33,7 +38,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment by id.
+     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment by id. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -47,7 +52,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /vehicle-assignments - create vehicle assignment.
+     * POST /vehicle-assignments - create vehicle assignment. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -64,7 +69,7 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment.
+     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/operations/vouchers.js

@@ -3,11 +3,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * @typedef {Object} VouchersQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for vouchers API (btrz-api-operations).
  * @param {Object} deps
@@ -19,12 +14,11 @@ function vouchersFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * POST /vouchers - create voucher.
+   * POST /vouchers - create voucher. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @param {VouchersQuery} [opts.query] - Query params
    * @param {Object} [opts.voucher] - Voucher payload
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -46,12 +40,11 @@ function vouchersFactory({
   }
 
   /**
-   * POST /vouchers/compensations - create compensation.
+   * POST /vouchers/compensations - create compensation. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.compensation - Compensation payload
-   * @param {VouchersQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/waitlists.js

@@ -36,7 +36,7 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /waitlists/:waitlistId - get waitlist by id.
+   * GET /waitlists/:waitlistId - get waitlist by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -70,7 +70,7 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /waitlists - create waitlist.
+   * POST /waitlists - create waitlist. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/src/endpoints/sales/bundles.js

@@ -2,8 +2,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET /bundles (btrz-api-sales get-bundles getSpec).
  * @typedef {Object} BundlesListQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id to get bundles for
+ * @property {string} type - Filter bundles by bundle type (required)
  */
 
 /**
@@ -18,7 +20,7 @@ function bundlesFactory({client, internalAuthTokenProvider}) {
    * GET /bundles - list bundles.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {BundlesListQuery} [opts.query] - Query params
+   * @param {BundlesListQuery} [opts.query] - Query params (type required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/cancellations.js

@@ -32,7 +32,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * Creates a set of refundable items and payments to be refunded
+   * Creates a set of refundable items and payments to be refunded. API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token
@@ -70,7 +70,7 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund).
+   * Completes a pending payment for a cancellation transaction (e.g. one terminal refund). API does not accept query params.
    * @param {Object} params
    * @param {string} params.token Public key
    * @param {string} params.jwtToken Auth token

package/src/endpoints/sales/cart-promo.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} CartPromoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for cart promos API (btrz-api-sales).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function cartPromoFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /cart/:cartId/promos - add promo to cart.
+   * POST /cart/:cartId/promos - add promo to cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -34,12 +28,11 @@ function cartPromoFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /cart/:cartId - remove cart promo.
+   * DELETE /cart/:cartId - remove cart promo. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.cartId - Cart id
-   * @param {CartPromoQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/sales/cart.js

@@ -2,8 +2,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} CartQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /cart/:cartId (btrz-api-sales get-cart getSpec).
+ * @typedef {Object} CartGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [transactionStatus] - Filter: 'created' or 'waiting_for_payment'
+ */
+
+/**
+ * Query params for POST /carts/:cartId/financing-costs (btrz-api-sales post-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsCreateQuery
+ * @property {string} [providerId] - Provider id to get financing costs for
+ */
+
+/**
+ * Query params for DELETE /carts/:cartId/financing-costs (btrz-api-sales delete-financingcost-handler getSpec).
+ * @typedef {Object} CartFinancingCostsDeleteQuery
+ * @property {string} [internalId] - Internal id or code of the financing cost to match
  */
 
 /**
@@ -15,11 +29,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function cartFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /cart/:id - get cart by id.
+   * GET /cart/:id - get cart by id. Query: providerId, transactionStatus (per get-cart getSpec).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Cart id
-   * @param {string} [opts.providerId] - Provider id
+   * @param {string} [opts.providerId] - Provider id (sent as query)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -55,7 +69,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /cart/:cartId/items - add items to cart.
+   * POST /cart/:cartId/items - add items to cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -74,7 +88,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /cart/:cartId/items - delete items from cart.
+   * DELETE /cart/:cartId/items - delete items from cart. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -93,7 +107,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item.
+   * DELETE /carts/:cartId/paid-in-items/:itemId - delete paid-in item. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -111,7 +125,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items - delete paid-in items.
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items. Query forwarded via opts.params if provided.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
@@ -131,12 +145,11 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const loyaltyPointsAmount = {
     /**
-     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart.
+     * GET /carts/:cartId/loyalty-points-amount - get loyalty points amount for cart. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -151,7 +164,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
 
   /**
-   * PATCH /cart/:cartId - patch cart.
+   * PATCH /cart/:cartId - patch cart. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -171,7 +184,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const partialDepositStatus = {
     /**
-     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status.
+     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -188,7 +201,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const payments = {
     /**
-     * DELETE /carts/:cartId/payments - delete cart payments.
+     * DELETE /carts/:cartId/payments - delete cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -204,7 +217,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /carts/:cartId/payments - put cart payments.
+     * PUT /carts/:cartId/payments - put cart payments. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -225,7 +238,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const taxExemptPaymentMethod = {
     /**
-     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method.
+     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
@@ -253,7 +266,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
      * @param {Object} opts.financingCost - Financing cost payload
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsCreateQuery} [opts.query] - Query params (providerId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     create({token, jwtToken, headers, cartId, financingCost, query = {}}) {
@@ -274,7 +287,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional headers
      * @param {string} opts.cartId - Cart id
-     * @param {CartQuery} [opts.query] - Query params
+     * @param {CartFinancingCostsDeleteQuery} [opts.query] - Query params (internalId)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     delete({token, jwtToken, headers, cartId, query = {}}) {

package/src/endpoints/sales/check-in-info.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} CheckInInfoQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for check-in API (btrz-api-sales).
  * @param {Object} deps
@@ -15,13 +10,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function checkInInfoFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /check-in/:id - get check-in info.
+   * GET /check-in/:id - get check-in info. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Check-in id
    * @param {Object} [opts.headers] - Optional headers
-   * @param {CheckInInfoQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({token, jwtToken, id, headers, query = {}}) {