btrz-api-client 8.30.0 → 8.32.0

package/lib/endpoints/btrzpay/datalogic.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} DatalogicQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /datalogic/payments (btrz-api-payments). See get-payments-handler getSpec().
+ * @typedef {Object} DatalogicPaymentsListQuery
+ * @property {string} [referenceNumber] - The payment reference number
  */
 
 /**
@@ -26,7 +27,7 @@ function datalogicFactory(_ref) {
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {DatalogicQuery} [opts.query] - Query params
+     * @param {DatalogicPaymentsListQuery} [opts.query] - Query params (referenceNumber)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -45,13 +46,12 @@ function datalogicFactory(_ref) {
     },
 
     /**
-     * POST /datalogic/payments/:referenceNumber - update Datalogic payment.
+     * POST /datalogic/payments/:referenceNumber - update Datalogic payment. 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.referenceNumber - Reference number
      * @param {Object} [opts.data] - Request body
-     * @param {DatalogicQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -74,13 +74,12 @@ function datalogicFactory(_ref) {
     },
 
     /**
-     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment.
+     * POST /datalogic/reverse/:referenceNumber - reverse Datalogic payment. 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.referenceNumber - Reference number
      * @param {Object} [opts.data] - Request body
-     * @param {DatalogicQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -105,7 +104,7 @@ function datalogicFactory(_ref) {
 
   var referenceNumber = {
     /**
-     * GET /datalogic/reference-number - get reference number.
+     * GET /datalogic/reference-number - get reference number. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -127,7 +126,7 @@ function datalogicFactory(_ref) {
 
   var authCode = {
     /**
-     * GET /datalogic/auth-code - get auth code.
+     * GET /datalogic/auth-code - get auth code. 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/lib/endpoints/btrzpay/oxxo.js

@@ -4,17 +4,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /oxxo/:token/payments (btrz-api-payments getSpec).
+ * Query params for GET /oxxo/:token/payments (btrz-api-payments). See get-payments-handler getSpec().
  * @typedef {Object} OxxoPaymentsListQuery
  * @property {string} [referenceNumber] - Payment reference number
  */
 
-/**
- * POST /oxxo/:token/payments/:referenceNumber and POST /oxxo/:token/reverse/:referenceNumber do not define
- * query params in backend getSpec (path + body only). Use for optional query keys forwarded as-is.
- * @typedef {Object} OxxoPostQuery
- */
-
 /**
  * Factory for OXXO API (btrz-api-payments).
  * @param {Object} deps
@@ -30,7 +24,7 @@ function oxxoFactory(_ref) {
 
   var token = {
     /**
-     * GET /oxxo/token - get OXXO token.
+     * GET /oxxo/token - get OXXO token. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
@@ -55,7 +49,7 @@ function oxxoFactory(_ref) {
      * @param {Object} opts
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.oxxoToken - OXXO token
-     * @param {OxxoPaymentsListQuery} [opts.query] - referenceNumber (optional)
+     * @param {OxxoPaymentsListQuery} [opts.query] - Query params (referenceNumber)
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
      * @param {Object} [opts.headers] - Optional request headers
      * @returns {Promise<import("axios").AxiosResponse>} GetOxxoPaymentsResponse; 400 ERROR_GETTING_PAYMENT_METHODS
@@ -75,12 +69,11 @@ function oxxoFactory(_ref) {
     },
 
     /**
-     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment.
+     * POST /oxxo/:oxxoToken/payments/:referenceNumber - update OXXO payment. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.oxxoToken - OXXO token
      * @param {string} opts.referenceNumber - Payment reference number
-     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
      * @param {Object} opts.data - Request body (PostOxxoPaymentsPayload)
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
      * @param {Object} [opts.headers] - Optional request headers
@@ -105,13 +98,12 @@ function oxxoFactory(_ref) {
     },
 
     /**
-     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment.
+     * POST /oxxo/:oxxoToken/reverse/:referenceNumber - reverse OXXO payment. 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.oxxoToken - OXXO token
      * @param {string} opts.referenceNumber - Payment reference number
-     * @param {OxxoPostQuery} [opts.query] - Optional query params (backend getSpec has none; forwarded as-is)
      * @param {Object} [opts.data] - Request body (PostOxxoReversePayload)
      * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider]
      * @param {Object} [opts.headers] - Optional request headers

package/lib/endpoints/btrzpay/payment-methods.js

@@ -5,9 +5,23 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /payment-methods (btrz-api-payments). Passed through as-is when no backend spec found.
+ * Query params for GET /payment-methods (btrz-api-payments). See get-payment-methods getSpec().
  * @typedef {Object} PaymentMethodsListQuery
- * @property {string} [providerName] - Filter by provider name (deprecated; use getByProviderName for single provider)
+ * @property {string} [providerName] - The provider name to filter the payment methods (deprecated; use getByProviderName)
+ * @property {string} [channel] - The channel to get payment methods for
+ * @property {boolean} [enabled] - Filter by enabled [true, false]; if omitted returns both
+ * @property {boolean} [excludePredefined] - Exclude predefined methods; default included
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [externalType] - Reference external type
+ * @property {boolean} [allowToRefundTo] - Filter by ability to accept refunds [true, false]
+ * @property {string} [flows] - Flows in which the method is available (comma-separated); channel required
+ */
+
+/**
+ * Query params for GET /payment-methods/:paymentMethodId (btrz-api-payments). See get-payment-method getSpec().
+ * @typedef {Object} PaymentMethodGetQuery
+ * @property {string} [providerId] - Account provider ID; used by agencies
  */
 
 /**
@@ -29,7 +43,7 @@ function paymentMethodsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName)
+   * @param {PaymentMethodsListQuery} [opts.query] - Query params (providerName, channel, enabled, etc.)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +61,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * GET /payment-methods?providerName= - get by provider name (deprecated).
+   * GET /payment-methods?providerName= - get by provider name (deprecated). API accepts providerName only.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -69,7 +83,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods - create payment method.
+   * POST /payment-methods - create payment method. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -97,7 +111,7 @@ function paymentMethodsFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.paymentMethodId - Payment method id
-   * @param {PaymentMethodsListQuery} [opts.query] - Optional query params (e.g. providerName); forwarded to API
+   * @param {PaymentMethodGetQuery} [opts.query] - Query params (providerId for agencies)
    * @param {Object} [opts.headers] - Optional request headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -116,7 +130,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * PUT /payment-methods/:paymentMethodId - update payment method.
+   * PUT /payment-methods/:paymentMethodId - update payment method. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -141,7 +155,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /payment-methods-to-agencies - set payment methods to agency.
+   * POST /payment-methods-to-agencies - set payment methods to agency. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -168,7 +182,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * POST /default-payment-methods - create default payment methods.
+   * POST /default-payment-methods - create default payment methods. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -189,7 +203,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info.
+   * DELETE /payment-methods/:paymentMethodId/customers - delete customers credit card info. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -209,7 +223,7 @@ function paymentMethodsFactory(_ref) {
   }
 
   /**
-   * DELETE /payment-methods/domains/:domain - delete payment methods domain.
+   * DELETE /payment-methods/domains/:domain - delete payment methods domain. 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/lib/endpoints/btrzpay/payments.js

@@ -17,7 +17,7 @@ function paymentsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /payments - create payments.
+   * POST /payments - create payments. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -40,7 +40,7 @@ function paymentsFactory(_ref) {
   }
 
   /**
-   * GET /transactions/:transactionId - get transaction.
+   * GET /transactions/:transactionId - get transaction. 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/lib/endpoints/btrzpay/prismaTerminals.js

@@ -4,8 +4,9 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET payment/reversal/refund and PUT refund (btrz-api-payments). See get-by-id-* and put-refunds getSpec().
  * @typedef {Object} PrismaTerminalsQuery
- * @property {string} [providerId] - Account provider/operator ID for agencies/sellers
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  * @property {boolean} [validateRefund] - (PUT refunds only) If true, fetch current state from Prisma before applying
  */
 
@@ -29,7 +30,7 @@ function prismaTerminalsFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Reversal id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -48,13 +49,12 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * POST /prisma-terminals/payments/:id/reversals - create reversal.
+     * POST /prisma-terminals/payments/:id/reversals - create reversal. 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 - Payment id
      * @param {Object} opts.prismaReversal - Prisma reversal payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -77,12 +77,11 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * DELETE /prisma-terminals/reversals/:id - delete reversal.
+     * DELETE /prisma-terminals/reversals/:id - delete reversal. 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 - Reversal id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -110,7 +109,7 @@ function prismaTerminalsFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Refund id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -129,13 +128,12 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * POST /prisma-terminals/payments/:id/refunds - create refund.
+     * POST /prisma-terminals/payments/:id/refunds - create 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.id - Payment id
      * @param {Object} opts.prismaRefund - Prisma refund payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -158,12 +156,11 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * DELETE /prisma-terminals/refunds/:id - delete refund.
+     * DELETE /prisma-terminals/refunds/:id - delete 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.id - Refund id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -190,7 +187,7 @@ function prismaTerminalsFactory(_ref) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Refund id
      * @param {Object} opts.prismaRefund - Prisma refund payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId, validateRefund)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -220,7 +217,7 @@ function prismaTerminalsFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Payment id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -239,12 +236,11 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * POST /prisma-terminals/payments - create payment.
+     * POST /prisma-terminals/payments - create payment. 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.prismaPayment - Prisma payment payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -266,12 +262,11 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * DELETE /prisma-terminals/payments/:id - delete payment.
+     * DELETE /prisma-terminals/payments/:id - delete payment. 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 - Payment id
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -292,13 +287,12 @@ function prismaTerminalsFactory(_ref) {
     },
 
     /**
-     * PUT /prisma-terminals/payments/:id - update payment.
+     * PUT /prisma-terminals/payments/:id - update payment. 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 - Payment id
      * @param {Object} opts.prismaPayment - Prisma payment payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -326,12 +320,11 @@ function prismaTerminalsFactory(_ref) {
 
   var settlements = {
     /**
-     * POST /prisma-terminals/settlements - create settlement.
+     * POST /prisma-terminals/settlements - create settlement. 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.settlement - Settlement payload
-     * @param {PrismaTerminalsQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/lib/endpoints/btrzpay/reference-numbers.js

@@ -17,7 +17,7 @@ function referenceNumbersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /reference-numbers - create reference number.
+   * POST /reference-numbers - create reference number. 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/lib/endpoints/btrzpay/referenced-payments.js

@@ -3,6 +3,12 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query for POST .../referenced-payments/:type/:referenceNumber/results (btrz-api-payments). See post-referenced-payments getSpec().
+ * @typedef {Object} ReferencedPaymentsUpdateQuery
+ * @property {string} [includePaidOrExpired] - Update beyond paid/expired for completion [true, false]
+ */
+
 /**
  * Factory for referenced payments API (btrz-api-payments).
  * @param {Object} deps
@@ -17,7 +23,7 @@ function referencedPaymentsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /referenced-payments/:transactionId/:referenceNumber/status - get status.
+   * GET /referenced-payments/:transactionId/:referenceNumber/status - get 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
@@ -47,6 +53,7 @@ function referencedPaymentsFactory(_ref) {
    * @param {string} opts.externalType - External type
    * @param {string} opts.referenceNumber - Reference number
    * @param {Object} opts.paymentResult - Payment result payload
+   * @param {ReferencedPaymentsUpdateQuery} [opts.query] - Query params (includePaidOrExpired)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -56,11 +63,14 @@ function referencedPaymentsFactory(_ref) {
         externalType = _ref3.externalType,
         referenceNumber = _ref3.referenceNumber,
         paymentResult = _ref3.paymentResult,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
         headers = _ref3.headers;
 
     return client({
       url: "/referenced-payments/" + externalType + "/" + referenceNumber + "/results",
       method: "post",
+      params: query,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, headers: headers }),
       data: { paymentResult: paymentResult }
     });

package/lib/endpoints/btrzpay/square.js

@@ -17,7 +17,7 @@ function squareWebhooksFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /square-webhooks/:providerId - create Square webhook.
+   * POST /square-webhooks/:providerId - create Square webhook. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -58,7 +58,7 @@ function squareTerminalsFactory(_ref3) {
       internalAuthTokenProvider = _ref3.internalAuthTokenProvider;
 
   /**
-   * GET /square-terminals - get Square terminals.
+   * GET /square-terminals - get Square terminals. 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/lib/endpoints/btrzpay/stripe-terminals.js

@@ -4,8 +4,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} StripeTerminalsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /stripe-terminals (btrz-api-payments). See get-handler getSpec().
+ * @typedef {Object} StripeTerminalsListQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  */
 
 /**
@@ -26,8 +27,8 @@ function stripeTerminalsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {StripeTerminalsListQuery} [opts.query] - Query params (providerId)
    * @param {Object} [opts.headers] - Optional headers
-   * @param {StripeTerminalsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all(_ref2) {
@@ -46,13 +47,12 @@ function stripeTerminalsFactory(_ref) {
   }
 
   /**
-   * POST /stripe-terminals/:id/simulate - simulate Stripe payment.
+   * POST /stripe-terminals/:id/simulate - simulate Stripe payment. 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 - Terminal id
    * @param {Object} opts.stripePayment - Stripe payment payload
-   * @param {StripeTerminalsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/btrzpay/terminalPayments.js

@@ -4,8 +4,18 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} TerminalPaymentsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /terminal-payments/mit/:id (btrz-api-payments). See get-mit-by-id-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitGetQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
+ * @property {string} [branchId] - Branch id where payment started (required for GET)
+ * @property {string} [companyId] - Company id where payment started (required for GET)
+ * @property {string} [date] - Date when payment started; format dd/mm/yyyy (required for GET)
+ */
+
+/**
+ * Query params for PUT /terminal-payments/mit/:id (btrz-api-payments). See put-mit-handler getSpec().
+ * @typedef {Object} TerminalPaymentsMitPutQuery
+ * @property {string} [providerId] - Account provider (operator) ID; used by agencies/sellers
  */
 
 /**
@@ -29,7 +39,7 @@ function terminalPaymentsFactory(_ref) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Terminal payment id
      * @param {Object} opts.terminalPayment - Terminal payment payload
-     * @param {TerminalPaymentsQuery} [opts.query] - Query params
+     * @param {TerminalPaymentsMitPutQuery} [opts.query] - Query params (providerId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -57,7 +67,7 @@ function terminalPaymentsFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.id - Terminal payment id
-     * @param {TerminalPaymentsQuery} [opts.query] - Query params
+     * @param {TerminalPaymentsMitGetQuery} [opts.query] - Query params (providerId, branchId, companyId, date)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -78,7 +88,7 @@ function terminalPaymentsFactory(_ref) {
 
   var webhooks = {
     /**
-     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook.
+     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook. API does not accept query params.
      * @param {Object} opts
      * @param {Object} opts.data - Request body
      * @param {string} opts.providerId - Provider id

package/lib/endpoints/coltrane/merged-fare-tables.js

@@ -18,7 +18,7 @@ function mergedFareTablesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table.
+   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table. 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/lib/endpoints/coltrane/paths.js

@@ -5,12 +5,15 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /paths (btrz-api-coltrane).
+ * Query params for GET /paths (btrz-api-coltrane). See get-paths getSpec().
  * @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
+ * @property {string} [providerId] - Account ID of the travel provider (required by API)
+ * @property {string} [productId] - Product ID belonging to the provider (required by API)
+ * @property {string} [originId] - Origin station id (required by API)
+ * @property {string} [destinationId] - Destination station id (required by API)
+ * @property {string} [departureFromDate] - Start of search interval; ISO 8601 (e.g. 2021-10-07T17:30:00.000-0400)
+ * @property {string} [departureToDate] - End of search interval; ISO 8601; interval max 25h
+ * @property {string} [metrics] - If true, response includes metrics (debugging)
  */
 
 /**
@@ -30,7 +33,7 @@ function coltraneFactory(_ref) {
    * GET /paths - list Coltrane paths.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {ColtranePathsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ColtranePathsListQuery} [opts.query] - Query params (providerId, productId, originId, destinationId, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/gps/scanner-app-location.js

@@ -4,7 +4,8 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Query params for GET /scanner-app-location (used by websales; GPS API).
+ * Query params for GET /scanner-app-location (GPS API). API is external (not in workspace);
+ * shape from btrz-vue-websales and client usage.
  * @typedef {Object} ScannerAppLocationQuery
  * @property {string} [scheduleId] - Schedule id
  * @property {string} [routeId] - Route id
@@ -29,7 +30,7 @@ function scannerAppLocationFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {ScannerAppLocationQuery} [opts.query] - Query params (scheduleId, routeId, date, includeTravelledPath)
-   * @param {Object} [opts.headers] - Optional request headers
+   * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>} response.data may contain location
    */
   function get(_ref2) {