btrz-api-client 8.33.0 → 8.35.0

package/src/endpoints/notifications/external-customers.js

@@ -0,0 +1,41 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Request body for POST /external-customers/ado/registration (btrz-api-notifications).
+ * @typedef {Object} SaldoMaxRegistrationRequest
+ * @property {string} email - User email to register in Saldo Max (verification code is sent to this email).
+ */
+
+/**
+ * Factory for external-customers API (btrz-api-notifications). Saldo Max (ADO) verification-code registration.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ requestSaldoMaxVerificationCode: function }}
+ */
+function externalCustomersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /external-customers/ado/registration – Request a Saldo Max (ADO) verification code for the given email.
+   * Requires BETTEREZ_APP JWT. Forwards to Saldo Max; sends verification code to the email.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT (BETTEREZ_APP audience)
+   * @param {SaldoMaxRegistrationRequest} opts.data - Body: { email } (or { body: { email } })
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ code: string, message: string }>>}
+   */
+  function requestSaldoMaxVerificationCode({data, token, jwtToken, headers}) {
+    return client({
+      url: "/external-customers/ado/registration",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  return {
+    requestSaldoMaxVerificationCode
+  };
+}
+
+module.exports = externalCustomersFactory;

package/src/endpoints/notifications/pdfs.js

@@ -78,9 +78,6 @@ function pdfFactory({
     if (query.type === "transaction") {
       url = `/pdf-transactions/${itemId}`;
     }
-    if (query.type === "transaction") {
-      url = `/pdf-transactions/${itemId}`;
-    }
     if (query.type === "ssr") {
       url = `/pdf-ssrs/${itemId}`;
     }

package/src/endpoints/operations/accounting_items.js

@@ -26,12 +26,14 @@ function accountingItemsFactory({
    * GET /accounting-items - list accounting items.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {AccountingItemsListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({
     token,
+    jwtToken,
     query = {},
     headers
   }) {
@@ -39,6 +41,7 @@ function accountingItemsFactory({
       params: query,
       headers: authorizationHeaders({
         token,
+        jwtToken,
         internalAuthTokenProvider,
         headers
       })
@@ -49,16 +52,18 @@ function accountingItemsFactory({
    * GET /accounting-items/:accountingItemId - get accounting item by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.accountingItemId - Accounting item id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.accountingItemId - Accounting item id (ObjectId format)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({
-    accountingItemId, token, headers
+    accountingItemId, token, jwtToken, headers
   }) {
     return client.get(`/accounting-items/${accountingItemId}`, {
       headers: authorizationHeaders({
         token,
+        jwtToken,
         internalAuthTokenProvider,
         headers
       })

package/src/endpoints/operations/flexpasses.js

@@ -9,14 +9,16 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function flexpassesFactory({client, internalAuthTokenProvider}) {
   /**
-   * DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id. API does not accept query params.
+   * DELETE /flexpasses/:flexpassId/scannings/:tripId - deletes one flexpass scanning for the given trip ID.
+   * Removes the scan matching tripId from the flexpass's scans; if multiple scans exist for the same tripId, only one is removed.
+   * Requires operations API base URL (e.g. .../operations). No query parameters.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.flexpassId - Flexpass id
-   * @param {string} opts.tripId - Trip id
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization Bearer)
+   * @param {string} opts.flexpassId - Flexpass document ID (Mongo ObjectId string)
+   * @param {string} opts.tripId - Trip identifier of the scan to remove (e.g. routeId_scheduleName_date)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ flexpassDeleted?: string }>>}
    */
   function deleteScanBytripId({jwtToken, token, flexpassId, tripId, headers}) {
     return client({

package/src/endpoints/operations/gift-certificates.js

@@ -0,0 +1,39 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Factory for gift-certificates API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} gift-certificates API methods
+ */
+function giftCertificatesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /gift-certificates - list paid gift certificates for a customer. Paginated; requires customer JWT when used with JwtAuth.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization Bearer); when using customer JWT, must match customer param
+   * @param {string} opts.customer - Customer number to filter by (required)
+   * @param {number} [opts.page] - 1-based page number; page size is 20
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ giftCertificates: Array<object>, count: number, next?: string, previous?: string }>>}
+   */
+  function list({jwtToken, token, customer, page, headers}) {
+    const params = {customer};
+    if (page != null) {
+      params.page = page;
+    }
+    return client({
+      url: "/gift-certificates",
+      method: "get",
+      params,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    list
+  };
+}
+
+module.exports = giftCertificatesFactory;

package/src/endpoints/operations/loans.js

@@ -24,15 +24,17 @@ function loansFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET /loans - list loans.
+   * GET /loans - list loans for the account or provider. Paginated (20 per page). Requires operations API base URL.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {LoansListQuery} [opts.query] - Query params (all optional)
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization Bearer)
+   * @param {LoansListQuery} [opts.query] - Query params (all optional): page, shiftId, type, trxId, status, providerId
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ loans: Array<object>, count: number, next?: string, previous?: string }>>}
    */
   function all({
     token,
+    jwtToken,
     query = {},
     headers
   }) {
@@ -40,6 +42,7 @@ function loansFactory({
       params: query,
       headers: authorizationHeaders({
         token,
+        jwtToken,
         internalAuthTokenProvider,
         headers
       })
@@ -47,19 +50,21 @@ function loansFactory({
   }
 
   /**
-   * GET /loans/:loanId - get loan by id. API does not accept query params.
+   * GET /loans/:loanId - get a single loan by ID. Requires operations API base URL.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} opts.loanId - Loan id
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization Bearer)
+   * @param {string} opts.loanId - Loan document ID (24 hex characters)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ loan: object }>>}
    */
   function get({
-    loanId, token, headers
+    loanId, token, jwtToken, headers
   }) {
     return client.get(`/loans/${loanId}`, {
       headers: authorizationHeaders({
         token,
+        jwtToken,
         internalAuthTokenProvider,
         headers
       })

package/src/endpoints/operations/movements.js

@@ -1,5 +1,15 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Request body for POST /movements (btrz-api-operations). See MovementPostData in movements models.
+ * @typedef {Object} MovementPostData
+ * @property {Array<{ _id: string, section?: string, sectionName?: string, seat?: string, row?: string, seatId?: string }>} tickets - Tickets to move (same transaction if more than one). Each must have _id; optional seat fields for destination seatmap.
+ * @property {{ routeId: string, scheduleId: string, date: string }} newManifest - Destination manifest: routeId (ObjectId), scheduleId (UUID), date (YYYY-MM-DD).
+ * @property {string} channel - Channel of the movement (e.g. backoffice). Must be a valid backoffice channel.
+ * @property {boolean} [allowsDifferentTrx] - If true, allows moving tickets from different transactions.
+ * @property {boolean} [newdesign] - If true, uses new seatmap design for accommodation.
+ */
+
 /**
  * Factory for movements API (btrz-api-operations).
  * @param {Object} deps
@@ -9,13 +19,14 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function movementsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /movements - create movement. API does not accept query params.
+   * POST /movements - create a movement (move tickets to another manifest). No query params.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.movement - Movement payload
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth (Authorization Bearer)
+   * @param {MovementPostData} opts.movement - Request body: tickets, newManifest, channel; optional allowsDifferentTrx, newdesign
+   * @param {Object} [opts.query] - Optional query params (API accepts none)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{}>>}
    */
   function create({token, jwtToken, movement, query = {}, headers}) {
     return client({

package/src/endpoints/operations/pago-express.js

@@ -0,0 +1,73 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Pago Express (Datalogic) endpoints for the Operations API.
+ * Used to get info, pay, and reverse reference payments.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} pagoExpress API methods
+ */
+function pagoExpressFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /pago-express/info - get transaction information for a Pago Express reference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio (20-digit string), id_terminal (number), local_date (string DD/MM/YYYY HH:mm:ss), trx_no (number)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostInfoResponse (code, message, result with folio, id_terminal, local_date, saldo, trx_no, responsecode, descriptioncode)
+   */
+  function info({token, jwtToken, payment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/info",
+      data: {payment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /pago-express/pay - pay a Pago Express reference payment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostPayResponse (code, message, result with folio, id_terminal, local_date, trx_no, noauto, amount, responsecode, descriptioncode)
+   */
+  function pay({token, jwtToken, payment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/pay",
+      data: {payment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /pago-express/reverse - reverse (cancel) a Pago Express reference payment. Emits transaction.reversed webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.reversePayment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostReverseResponse (code, message, result)
+   */
+  function reverse({token, jwtToken, reversePayment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/reverse",
+      data: {reversePayment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    info,
+    pay,
+    reverse
+  };
+}
+
+module.exports = pagoExpressFactory;

package/src/endpoints/operations/parcels.js

@@ -28,13 +28,13 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function parcelFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /parcels/:id - get parcel by id. API does not accept query params.
+   * GET /parcels/{parcelId} - get parcel by id. Requires JwtAuth. No query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
+   * @param {string} opts.id - Parcel id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 { parcel }; 400 INVALID_PARCEL_ID; 401 Unauthorized; 404 PARCEL_NOT_FOUND; 500
    */
   function get({token, jwtToken, id, headers}) {
     return client({
@@ -83,14 +83,14 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /parcels/:id/user-comments - add comment to parcel. API does not accept query params.
+   * POST /parcels/{parcelId}/user-comments - add user comment to parcel. Requires JwtAuth. Body: { comment } (string).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
-   * @param {Object} opts.comment - Comment payload
+   * @param {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.comment - Comment text (sent as body.comment)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND; 409
    */
   function addComment({token, jwtToken, headers, id, comment}) {
     return client({
@@ -102,14 +102,14 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment. API does not accept query params.
+   * DELETE /parcels/{parcelId}/user-comments/{commentId} - delete user comment from parcel. Requires JwtAuth.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
-   * @param {string} opts.commentId - Comment id
+   * @param {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.commentId - Comment id (path)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 deleted ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND, COMMENT_NOT_FOUND; 409
    */
   function deleteComment({token, jwtToken, headers, id, commentId}) {
     return client({

package/src/endpoints/operations/parcels_manifests.js

@@ -40,19 +40,21 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /parcels-manifests/:id - get parcels manifest by id. API does not accept query params.
+   * GET /parcels-manifests/:id - get parcels manifest by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel manifest id (ObjectId)
+   * @param {string} opts.id - Parcel manifest id (ObjectId, 24 hex chars)
+   * @param {"standard"|"webhook"} [opts.format="standard"] - Response format (standard | webhook)
    * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 404 PARCELMANIFEST_NOT_FOUND
+   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 400 WRONG_DATA; 404 MANIFEST_NOT_FOUND, PARCELMANIFEST_NOT_FOUND
    */
-  function get({token, jwtToken, id, headers}) {
+  function get({token, jwtToken, id, format, headers}) {
     return client({
       url: `/parcels-manifests/${id}`,
       method: "get",
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: format != null ? {format} : undefined
     });
   }
 

package/src/endpoints/sales/cancellations.js

@@ -1,22 +1,34 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
+ * Request body for POST /cancellations (btrz-api-sales). CancelPostData. Item IDs grouped by family; trxId required.
  * @typedef {{
- *   fees: string[],
+ *   trxId: string,
+ *   fees: number[],
  *   flexPasses: string[],
  *   parcels: string[],
  *   redeemableItems: string[],
  *   soldItems: string[],
  *   tickets: string[],
  *   giftCertificates: string[],
+ *   reservations: string[],
  *   insurances: string[],
- *   trxId: string,
- *   penalty?: {
- *      amount: number,
- *      reason: string
- *   }
- * }} CancelSetData
- *
+ *   channel: string,
+ *   penalty?: { amount: number, reason: string },
+ *   overrideCancelFees?: Array<{ _id: string, reason: string }>,
+ *   currency?: string,
+ *   terminalPayload?: { status: string, provider: string, auth?: string },
+ *   paymentDetails?: Array<{ _id: string, authorization: string }>
+ * }} CancelPostData
+ */
+
+/**
+ * Request body for PUT /cancellations (btrz-api-sales). CancelPutData. Unmodified cancel set from POST response (must include _id and signature).
+ * @typedef {{ _id: string, cancellation: Object, signature: string }} CancelPutData
+ */
+
+/**
+ * Request body for PUT /cancellations/:pendingTransactionId (btrz-api-sales). CompletePaymentCancellationData.
  * @typedef {{
  *   provider: string,
  *   type: string,
@@ -28,17 +40,17 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  *   referenceNumber: string,
  *   authCode?: string
  * }} CompletePaymentCancellationData
-*/
+ */
 
 function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * 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
-   * @param {CancelSetData} params.cancelData List of item ids grouped by family
-   * @param {Object} params.headers HTTP Headers
-   * @returns {Promise} A cancel set object
+   * POST /cancellations - creates a cancel set (preview) with calculated refunds and signature. Does not execute refunds. 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 {CancelPostData} opts.cancelData - Refundable item IDs by family, trxId, channel, penalty (optional), etc.
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string, cancellation: Object, signature: string }>>} Cancel set (signed). Rejects with 400 (e.g. MISSING_CANCELLABLE_IDS, INVALID_CANCEL_SET, [itemType]_NOT_REFUNDABLE), 401, 403 (NOT_ALLOWED_FOR_ONLINE, FEE_OVERRIDE_NOT_ALLOWED), 404 ([itemType]_NOT_FOUND), 409 (CURRENCY_EXCHANGE_MISMATCH, AGENCY_CURRENCY_MISMATCH), 500.
    */
   function createCancelSet({token, jwtToken, cancelData, headers}) {
     return client({
@@ -52,13 +64,13 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * Creates and runs payment refunds
-   * @param {Object} params
-   * @param {string} params.token Public key
-   * @param {string} params.jwtToken Auth token
-   * @param {Object} params.cancelSet An unmodified cancel set object generated by the cancellations endpoint
-   * @param {Object} params.headers HTTP Headers
-   * @returns {Promise} Refund result
+   * PUT /cancellations - executes the refund using the signed cancel set from POST. Body is cancelSet (or object with cancelSet key). API does not accept query params. Duplicate submission (same dupKey within 30s) returns 409.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CancelPutData} opts.cancelSet - Unmodified cancel set from createCancelSet response
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ transaction: Object }>>} RefundResponse. Rejects with 400 (e.g. INVALID_SIGNATURE, MISSING_TERMINAL_PAYLOAD, REFUNDED_ITEM), 401, 409 (NOT_FOUND_FOR_REFUND, REFUND_EXECUTION_ERROR, PAYMENT_ROLLBACK_FAILED, CONFLICT duplicate), 500.
    */
   function createRefund({token, jwtToken, cancelSet, headers}) {
     return client({
@@ -70,14 +82,14 @@ function cancellationEndpointsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
-   * @param {string} params.pendingTransactionId Negative transaction id (ObjectId)
-   * @param {CompletePaymentCancellationData} params.paymentResult Payment result for one completed terminal refund
-   * @param {Object} params.headers HTTP Headers
-   * @returns {Promise} Updated negative transaction (with remaining pending payments if any)
+   * PUT /cancellations/:pendingTransactionId - completes a pending payment for a cancellation transaction (e.g. terminal refund). 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.pendingTransactionId - Negative (pending) transaction ID (ObjectId)
+   * @param {CompletePaymentCancellationData} opts.paymentResult - Payment result from terminal/provider
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ transaction?: Object, paymentResult?: Object }>>} GetCompletePaymentCancellationResponse. Rejects with 400 (INVALID_PENDING_TRANSACTION_ID, INVALID_TRANSACTION_STATUS, PAYMENT_NOT_PENDING, etc.), 401, 404 (TRANSACTION_NOT_FOUND, PAYMENT_NOT_FOUND, etc.), 500.
    */
   function updateCompletePayment({token, jwtToken, pendingTransactionId, paymentResult, headers}) {
     return client({

package/src/endpoints/sales/cart.js

@@ -20,6 +20,13 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {string} [internalId] - Internal id or code of the financing cost to match
  */
 
+/**
+ * Query params for DELETE /carts/:cartId/paid-in-items (btrz-api-sales delete-cart-paid-in-items-handler getSpec).
+ * @typedef {Object} CartDeletePaidInItemsQuery
+ * @property {string} [operationId] - Optional operation id to filter which paid-in items to remove
+ * @property {string} [productId] - Optional product id to filter which paid-in items to remove
+ */
+
 /**
  * Factory for cart API (btrz-api-sales).
  * @param {Object} deps
@@ -29,23 +36,18 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function cartFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /cart/:id - get cart by id. Query: providerId, transactionStatus (per get-cart getSpec).
+   * GET /cart/:id - get cart by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.id - Cart id
-   * @param {string} [opts.providerId] - Provider id (sent as query)
+   * @param {CartGetQuery} [opts.query] - Query params (providerId, transactionStatus)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function get({token, id, providerId, headers}) {
-    let url = `/cart/${id}`;
-
-    if (providerId) {
-      url = `${url}?providerId=${providerId}`;
-    }
-
+  function get({token, id, query = {}, headers}) {
     return client({
-      url,
+      url: `/cart/${id}`,
+      params: query,
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
@@ -125,11 +127,11 @@ function cartFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /carts/:cartId/paid-in-items - delete paid-in items. Query forwarded via opts.params if provided.
+   * DELETE /carts/:cartId/paid-in-items - delete paid-in items.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.cartId - Cart id
-   * @param {Object} opts.params - Query params (forwarded to API)
+   * @param {CartDeletePaidInItemsQuery} [opts.params] - Query params (operationId, productId)
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -139,7 +141,7 @@ function cartFactory({client, internalAuthTokenProvider}) {
       url: `/carts/${cartId}/paid-in-items`,
       method: "delete",
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-      params
+      params: params || {}
     });
   }
 
@@ -184,13 +186,13 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const partialDepositStatus = {
     /**
-     * GET /cart/:shiftId/partial-deposit-status - get partial deposit status. API does not accept query params.
+     * GET /cart/:shiftId/partial-deposit-status - get shift partial deposit status. API does not accept query params. Response: partialDeposit.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {string} opts.shiftId - Shift id
+     * @param {string} opts.shiftId - Shift id (24 hex characters)
      * @param {Object} [opts.headers] - Optional headers
-     * @returns {Promise<import("axios").AxiosResponse>}
+     * @returns {Promise<import("axios").AxiosResponse<{ partialDeposit: * }>>}
      */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/cart/${shiftId}/partial-deposit-status`, {
@@ -238,13 +240,13 @@ function cartFactory({client, internalAuthTokenProvider}) {
 
   const taxExemptPaymentMethod = {
     /**
-     * POST /carts/:cartId/tax-exempt-payment-method - set tax exempt payment method. API does not accept query params.
+     * POST /carts/:cartId/tax-exempt-payment-method - recalculate taxes for a tax exempt payment method. Body: amountExempt (number).
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.cartId - Cart id
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional headers
-     * @param {Object} [opts.data] - Request body
+     * @param {Object} opts.data - Request body; must include amountExempt (number, amount exempted of taxes)
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     post({token, cartId, jwtToken, headers, data = {}}) {

package/src/endpoints/sales/flexpasses.js

@@ -10,18 +10,17 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function flexpassesEndpointsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
+   * GET /flexpasses/:flexpassId - get flexpass 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.flexpassId - Flexpass id
+   * @param {string} opts.flexpassId - Flexpass id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function get({token, jwtToken, flexpassId, query = {}, headers}) {
+  function get({token, jwtToken, flexpassId, headers}) {
     return client({
       url: `/flexpasses/${flexpassId}`,
-      params: query,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }