btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/invoices/providersSequences.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for provider sequences endpoints (btrz-api-invoices). Backend getSpec for list has no query; forwarded as-is.
- * @typedef {Object} InvoiceProvidersSequencesQuery
- */
-
 /**
  * Factory for invoice provider sequences API (btrz-api-invoices).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function providersSequencesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /providers/:invoiceProviderId/sequences - list provider sequences.
+   * GET /providers/:invoiceProviderId/sequences - list provider sequences. 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.invoiceProviderId - Invoice provider id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>} 404 PROVIDER_NOT_FOUND
    */
@@ -34,13 +28,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence.
+   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence. 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.invoiceProviderId - Invoice provider id
    * @param {string} opts.invoiceProviderSequenceId - Sequence id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -54,13 +47,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence.
+   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence. 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.invoiceProviderId - Invoice provider id
    * @param {string} opts.id - Sequence id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -74,13 +66,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /providers/:invoiceProviderId/sequences - create provider sequence.
+   * POST /providers/:invoiceProviderId/sequences - create provider sequence. 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.invoiceProviderId - Invoice provider id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,14 +86,13 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence.
+   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence. 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.invoiceProviderId - Invoice provider id
    * @param {string} opts.invoiceProviderSequenceId - Sequence id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/system.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /system (btrz-api-invoices getSpec).
+ * Query params for POST /system (btrz-api-invoices). See post-system-handler getSpec().
  * @typedef {Object} InvoiceSystemPostQuery
- * @property {string} [onlyValidateRequest] - If set to true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/tax-ids.js

@@ -2,7 +2,7 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /tax-ids (btrz-api-invoices getSpec).
+ * Query params for GET /tax-ids (btrz-api-invoices). See tax-ids get-handler getSpec().
  * @typedef {Object} TaxIdsListQuery
  * @property {string} taxNumber - Tax number to look up (required)
  * @property {string} country - ISO code of the country of the tax information (required)

package/src/endpoints/notifications/customers.js

@@ -3,8 +3,28 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} NotificationsCustomersQuery
+ * Query params for POST /customers/reset (btrz-api-notifications). See post-customers-reset-password getSpec().
+ * @typedef {Object} CustomersResetPostQuery
+ * @property {string} providerId - Account id of the customer (required)
+ * @property {string} lang - Language of the email (required)
+ * @property {string} [customerNumber] - Customer number (include at least one of customerNumber or email)
+ * @property {string} [email] - Customer email (include at least one of customerNumber or email)
+ * @property {string} [channel] - Channel the customer is using to restore the pass
+ * @property {string} [platform] - "ios" | "android" | "web"
+ * @property {string} [appName] - Name of the app
+ * @property {string} [appVersion] - Version of the app
+ * @property {string} [cartPath] - (Deprecated) Initial path of the cart websales endpoint
+ */
+
+/**
+ * Query params for POST /customers/activation (btrz-api-notifications). See post-customers-activation getSpec().
+ * @typedef {Object} CustomersActivationPostQuery
+ * @property {string} providerId - Account id of the customer (required)
+ * @property {string} [lang] - Language of the email (default en-us)
+ * @property {string} [channel] - Channel (e.g. "mobileapp")
+ * @property {string} [platform] - "ios" | "android" | "web"
+ * @property {string} [appVersion] - Version of the client app
+ * @property {string} [appName] - Name of the client app
  */
 
 /**
@@ -22,7 +42,7 @@ function customersFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {CustomersResetPostQuery} [opts.query] - Query params (providerId, lang required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,8 +61,8 @@ function customersFactory({
    * POST /customers/activation - send activation email to customer.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
-   * @param {Object} [opts.data] - Request body
+   * @param {CustomersActivationPostQuery} [opts.query] - Query params (providerId required)
+   * @param {Object} [opts.data] - Request body (CustomerForActivation)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/email.js

@@ -3,8 +3,13 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for POST /email (btrz-api-notifications). Define recipient, template, etc. Forwarded to API as-is.
+ * Query params for POST /email (btrz-api-notifications). See post-emails getSpec().
  * @typedef {Object} NotificationsEmailPostQuery
+ * @property {string} trxId - Cart/transaction id to send by email (required)
+ * @property {string} [lang] - Email language (e.g. en-us, es-ar, de-de, fr-fr, nl-nl)
+ * @property {string} [channel] - Channel of the request
+ * @property {string} [appName] - App name of the request
+ * @property {string} [customEmail] - Email address different than customer.email (backoffice only)
  */
 
 /**
@@ -18,11 +23,11 @@ function emailFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * POST /email - send email (query params define recipient/template etc.).
+   * POST /email - send email to customer for the given cart (trxId).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {NotificationsEmailPostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {NotificationsEmailPostQuery} [opts.query] - Query params (trxId required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/manifest-notifications.js

@@ -3,8 +3,9 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for manifest-notifications endpoints (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} ManifestNotificationsQuery
+ * Query params for GET /manifest-notifications (btrz-api-notifications). See get-manifest-notifications-handler getSpec().
+ * @typedef {Object} ManifestNotificationsListQuery
+ * @property {string} [manifestId] - Manifest id (ObjectId format)
  */
 
 /**
@@ -44,7 +45,7 @@ function manifestNotificationsFactory({
    * GET /manifest-notifications - list manifest notifications.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/notify.js

@@ -4,8 +4,23 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for notify-tickets and notify-vouchers (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} NotifyQuery
+ * Query params for POST /notify-tickets/:ticketId (btrz-api-notifications). See post-notify-tickets-by-id-handler getSpec().
+ * @typedef {Object} NotifyTicketsPostQuery
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales (default websales)
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [lang] - Valid language (default en-us)
+ * @property {string} [humanDate] - "mm" | "dd" (default "mm")
+ */
+
+/**
+ * Query params for POST /notify-vouchers (btrz-api-notifications). See post-notify-vouchers-handler getSpec().
+ * @typedef {Object} NotifyVouchersPostQuery
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales (default websales)
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [lang] - Valid language (default en-us)
+ * @property {string} [humanDate] - "mm" | "dd" (default "mm")
  */
 
 /**
@@ -48,7 +63,7 @@ function notifyTicketFactory({
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {NotifyQuery} [opts.query] - Optional query params (forwarded to API)
+       * @param {NotifyTicketsPostQuery} [opts.query] - Query params (all optional)
        * @param {string} opts.operation - Notification operation
        * @param {string} opts.to - Recipient (e.g. email)
        * @param {string} opts.ticketId - Ticket id
@@ -74,8 +89,8 @@ function notifyTicketFactory({
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {NotifyQuery} [opts.query] - Optional query params (forwarded to API)
-       * @param {Object} opts.data - Request body
+       * @param {NotifyVouchersPostQuery} [opts.query] - Query params (all optional)
+       * @param {Object} opts.data - Request body (vouchersIds)
        * @param {Object} [opts.headers] - Optional headers
        * @returns {Promise<import("axios").AxiosResponse>}
        */

package/src/endpoints/notifications/orders-rules-validations.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * Query params for POST /orders-rules-validations (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} OrdersRulesValidationsPostQuery
- */
-
 /**
  * Factory for orders-rules-validations API (btrz-api-notifications).
  * @param {Object} deps
@@ -19,12 +14,11 @@ function ordersRulesValidations({
   internalAuthTokenProvider
 }) {
   /**
-   * POST /orders-rules-validations - create an order rules validation (notification).
+   * POST /orders-rules-validations - validate a rule using the data (body only). 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 {OrdersRulesValidationsPostQuery} [opts.query] - Optional query params (forwarded to API)
-   * @param {Object} opts.orderRulesValidation - Validation payload
+   * @param {Object} opts.orderRulesValidation - Validation payload (rule and facts)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/pdf-data.js

@@ -4,8 +4,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfDataGetQuery
- * @property {string} type - Document type; determines path. E.g. "product", "giftCertificate", "voucher", "transaction", "ssr", "manifest", "passengersManifest", "order", "order_confirmation", "cancellation", "change", "shift", "invoice", "parcelManifest", "parcel_confirmation", "redeemable_items_confirmation", "sold_item_confirmation", "customer_card_membership", "user_password_reset", "new_account", "operator_manifest_capacity", "reaccomodation", "ticket_movement", "manifest_notification", "startingBalance", "partialShiftDeposits", "shiftLocationClosure", "bankDepositSlip", "terminalVoucher", "manualTickets", etc.
+ * @property {string} type - Document type; determines path (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, order_confirmation, cancellation, change, shift, invoice, parcelManifest, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.)
  * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
  */
 

package/src/endpoints/notifications/pdfs.js

@@ -4,8 +4,9 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
+ * Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
  * @typedef {Object} PdfGetQuery
- * @property {string} type - Document type: "product" | "giftCertificate" | "voucher" | "transaction" | "ssr" | "manifest" | "passengersManifest" | "order" | "shift" | "remainderSlip" | "exchange" | "invoice" | "locationClosure" | "parcelManifest" | "startingBalance" | "partialShiftDeposits" | "shiftLocationClosure" | "bankDepositSlip" | "terminalVoucher" | "manualTickets"
+ * @property {string} type - Document type (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, shift, remainderSlip, exchange, invoice, locationClosure, parcelManifest, startingBalance, partialShiftDeposits, shiftLocationClosure, bankDepositSlip, terminalVoucher, manualTickets)
  * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
  */
 

package/src/endpoints/notifications/printed-tickets.js

@@ -2,6 +2,15 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /printed-tickets (btrz-api-notifications). See get-printed-tickets getSpec().
+ * @typedef {Object} PrintedTicketsGetQuery
+ * @property {string} trxId - Transaction id to print its tickets (required)
+ * @property {string} [channel] - Optional channel of the transaction
+ * @property {string} [lang] - Language (handler uses for PDF URL)
+ * @property {string} [date] - Date (handler uses for PDF URL)
+ */
+
 /**
  * Factory for printed-tickets API (btrz-api-notifications).
  * @param {Object} deps
@@ -13,23 +22,24 @@ function printedTicketsFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET /printed-tickets - get printed tickets (by trxId, lang, date); responseType json or blob.
+   * GET /printed-tickets - get printed tickets PDF (trxId required; lang, date optional).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} [opts.responseType] - Response type (e.g. "json" or "blob")
-   * @param {string} opts.trxId - Transaction id
-   * @param {string} opts.lang - Language code
-   * @param {string} opts.date - Date
+   * @param {string} [opts.responseType] - Response type ("json" or "blob")
+   * @param {string} opts.trxId - Transaction id (required)
+   * @param {string} [opts.lang] - Language code
+   * @param {string} [opts.date] - Date
+   * @param {string} [opts.channel] - Optional channel of the transaction
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function get({
-    token, jwtToken, responseType = "json", trxId, lang, date, headers
+    token, jwtToken, responseType = "json", trxId, lang, date, channel, headers
   }) {
     return client({
       url: "/printed-tickets",
-      params: {trxId, lang, date},
+      params: {trxId, lang, date, channel},
       responseType,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });

package/src/endpoints/notifications/twilio.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
-/**
- * Query params for GET /twilio/phone-numbers/:isocode (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} TwilioPhoneNumbersListQuery
- */
-
 /**
  * Factory for twilio API (btrz-api-notifications).
  * @param {Object} deps
@@ -20,12 +15,11 @@ function twilioFactory({
   return {
     phoneNumbers: {
       /**
-       * GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode.
+       * GET /twilio/phone-numbers/:isocode - list Twilio phone numbers for country isocode. API does not accept query params.
        * @param {Object} opts
        * @param {string} opts.isocode - Country ISO code
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {TwilioPhoneNumbersListQuery} [opts.query] - Optional query params (forwarded to API)
        * @param {Object} [opts.headers] - Optional headers
        * @returns {Promise<import("axios").AxiosResponse>}
        */

package/src/endpoints/operations/accounting_items.js

@@ -3,8 +3,13 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * @typedef {Object} AccountingItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /accounting-items (btrz-api-operations). See accounting-items get-handler getSpec().
+ * @typedef {Object} AccountingItemsListQuery
+ * @property {number} [page] - Page number (20 records per page)
+ * @property {string} [shiftId] - Shift id (ObjectId format)
+ * @property {string} [type] - "account_payable" | "account_receivable"
+ * @property {string} [trxId] - Transaction id (ObjectId format)
+ * @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
  */
 
 /**
@@ -21,7 +26,7 @@ function accountingItemsFactory({
    * GET /accounting-items - list accounting items.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {AccountingItemsQuery} [opts.query] - Query params
+   * @param {AccountingItemsListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,7 +46,7 @@ function accountingItemsFactory({
   }
 
   /**
-   * GET /accounting-items/:accountingItemId - get accounting item by id.
+   * 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

package/src/endpoints/operations/applied_insurance.js

@@ -7,13 +7,20 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
  * @returns {Object} applied-insurance API methods
  */
+/**
+ * Query params for GET /appliedInsurances (btrz-api-operations). See get-applied-insurances getSpec().
+ * Deprecated: use GET /transactions/:transactionId/applied-insurance.
+ * @typedef {Object} AppliedInsurancesListQuery
+ * @property {string} trxId - Associated transaction id (required)
+ */
+
 function appliedInsuranceFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /appliedInsurances - list applied insurances (by trxId query).
+   * GET /appliedInsurances - list applied insurances by transaction id (query: trxId).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.trxId - Transaction id (query param)
+   * @param {string} opts.trxId - Transaction id (required, sent as query param)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/calendar_entries.js

@@ -1,8 +1,12 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} CalendarEntriesQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /calendar-entries (btrz-api-operations). See get-calendar-entries getSpec().
+ * @typedef {Object} CalendarEntriesListQuery
+ * @property {string} from - Start travel date (required, format yyyy-mm-dd)
+ * @property {string} to - End travel date (required, format yyyy-mm-dd, max 31 days range)
+ * @property {string} [providerId] - Provider id when consuming from a non-main account
+ * @property {string} [channels] - Filter by channel (e.g. websales); must be one of allowed channels
  */
 
 /**
@@ -17,7 +21,7 @@ function calendarEntriesFactory({client, internalAuthTokenProvider}) {
    * GET /calendar-entries - list calendar entries.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {CalendarEntriesQuery} [opts.query] - Query params
+   * @param {CalendarEntriesListQuery} [opts.query] - Query params (from, to required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/operations/external-bookings.js

@@ -1,10 +1,5 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * @typedef {Object} ExternalBookingsQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for external-bookings API (btrz-api-operations).
  * @param {Object} deps
@@ -14,13 +9,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function externalBookingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /external-bookings - create external booking.
+   * POST /external-bookings - create external booking. 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.externalBooking - External booking payload
    * @param {Object} [opts.headers] - Optional headers
-   * @param {ExternalBookingsQuery} [opts.query] - Query params
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function create({jwtToken, token, externalBooking, headers, query = {}}) {
@@ -34,7 +28,7 @@ function externalBookingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /external-bookings/:ticketId - remove external booking.
+   * DELETE /external-bookings/:ticketId - remove external booking. 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/flexpasses.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function flexpassesFactory({client, internalAuthTokenProvider}) {
   /**
-   * DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip id.
+   * DELETE /flexpasses/:flexpassId/scannings/:tripId - delete scan by trip 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

package/src/endpoints/operations/loans.js

@@ -3,8 +3,14 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} LoansQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /loans (btrz-api-operations). See loans get-handler getSpec().
+ * @typedef {Object} LoansListQuery
+ * @property {number} [page] - Page number (20 records per page)
+ * @property {string} [shiftId] - Shift id (ObjectId format)
+ * @property {string} [type] - "loan" | "re-payment"
+ * @property {string} [trxId] - Transaction id (ObjectId format)
+ * @property {string} [status] - Comma-separated statuses: created, paid, waiting for payment
+ * @property {string} [providerId] - Provider id (for agencies)
  */
 
 /**
@@ -21,7 +27,7 @@ function loansFactory({
    * GET /loans - list loans.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {LoansQuery} [opts.query] - Query params
+   * @param {LoansListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,7 +47,7 @@ function loansFactory({
   }
 
   /**
-   * GET /loans/:loanId - get loan by id.
+   * GET /loans/:loanId - get loan by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.loanId - Loan id