btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/notifications/email.js

@@ -1,12 +1,40 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for email API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function emailFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * 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] - Query params (trxId required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for manifest-notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, all: function }}
+ */
+
+
 function manifestNotificationsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /manifest-notifications - create a manifest notification.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +49,14 @@ function manifestNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /manifest-notifications - list manifest notifications.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         _ref3$query = _ref3.query,

package/lib/endpoints/notifications/notify.js

@@ -1,14 +1,54 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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")
+ */
+
+/**
+ * Factory for notify (child users, tickets, vouchers, manifest) API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function } }}
+ */
+
+
 function notifyTicketFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   return {
     childUsers: {
+      /**
+       * POST /notify-child-user - notify a child user (e.g. email with lang).
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {string} opts.email - Recipient email
+       * @param {string} opts.lang - Language code
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref2) {
         var token = _ref2.token,
             jwtToken = _ref2.jwtToken,
@@ -28,6 +68,18 @@ function notifyTicketFactory(_ref) {
       }
     },
     tickets: {
+      /**
+       * POST /notify-tickets/:ticketId - send ticket notification (to, operation).
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @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
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref3) {
         var token = _ref3.token,
             jwtToken = _ref3.jwtToken,
@@ -50,6 +102,16 @@ function notifyTicketFactory(_ref) {
       }
     },
     vouchers: {
+      /**
+       * POST /notify-vouchers - send voucher notification.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @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>}
+       */
       create: function create(_ref4) {
         var token = _ref4.token,
             jwtToken = _ref4.jwtToken,
@@ -67,6 +129,15 @@ function notifyTicketFactory(_ref) {
       }
     },
     manifest: {
+      /**
+       * POST /notify-manifest - send manifest notification.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} opts.data - Request body
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref5) {
         var token = _ref5.token,
             jwtToken = _ref5.jwtToken,

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

@@ -1,12 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for orders-rules-validations API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function ordersRulesValidations(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * 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 {Object} opts.orderRulesValidation - Validation payload (rule and facts)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -1,12 +1,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.)
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ */
+
+/**
+ * Factory for PDF data (JSON) endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function pdfDataFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET PDF data (JSON) by item id and type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PdfDataGetQuery} [opts.query] - type (required for correct path); family when type is "product"
+   * @param {string} opts.itemId - Item id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data is JSON (structure depends on type)
+   */
   // eslint-disable-next-line max-statements
   function get(_ref2) {
     var token = _ref2.token,
@@ -44,22 +71,47 @@ function pdfDataFactory(_ref) {
           break;
       }
     }
-    if (query.type === "giftCertificate") {
+
+    if (query.type === "parcel_confirmation") {
+      url = "/pdf-parcels/" + itemId;
+    }
+    if (query.type === "redeemable_items_confirmation") {
+      url = "/pdf-redeemable-items/" + itemId;
+    }
+    if (query.type === "sold_item_confirmation") {
+      url = "/pdf-sold-items/" + itemId;
+    }
+    if (query.type === "customer_card_membership" || query.type === "scanning_badge" || query.type === "customer_activation" || query.type === "customer_activation_mobile" || query.type === "customer_password_reset" || query.type === "customer_password_reset_mobile") {
+      url = "/pdf-customer/" + itemId;
+    }
+    if (query.type === "giftCertificate" || query.type === "gift_certificate_notification") {
       url = "/pdf-gift-certificates/" + itemId;
     }
-    if (query.type === "voucher") {
+    if (query.type === "user_password_reset") {
+      url = "/pdf-users/" + itemId;
+    }
+    if (query.type === "voucher" || query.type === "voucher_notification" || query.type === "compensation_voucher") {
       url = "/pdf-vouchers/" + itemId;
     }
-    if (query.type === "transaction") {
+    if (query.type === "new_account" || query.type === "new_seller_account" || query.type === "interline_provider_invite") {
+      url = "/pdf-accounts/" + itemId;
+    }
+    if (query.type === "transaction" || query.type === "operator_purchase" || query.type === "operator_ssr") {
       url = "/pdf-transactions/" + itemId;
     }
+    if (query.type === "operator_manifest_capacity") {
+      url = "/pdf-operator-manifest-capacities/" + itemId;
+    }
     if (query.type === "ssr") {
       url = "/pdf-ssrs/" + itemId;
     }
     if (query.type === "passengersManifest") {
       url = "/pdf-passengers-manifests/" + itemId;
     }
-    if (query.type === "manifest") {
+    if (query.type === "reaccomodation" || query.type === "ticket_movement") {
+      url = "/pdf-reaccomodation/" + itemId;
+    }
+    if (query.type === "manifest" || query.type === "manifest_notification") {
       url = "/pdf-manifests/" + itemId;
     }
     var orderTypes = ["order", "order_confirmation", "cancellation", "change"];

package/lib/endpoints/notifications/pdfs.js

@@ -1,12 +1,40 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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 (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"
+ */
+
+/**
+ * Factory for PDF binary endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function pdfFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET a PDF by item id and type. Returns binary (blob) by default.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PdfGetQuery} [opts.query] - type (required for correct path); family when type is "product"
+   * @param {string} opts.itemId - Item id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} [opts.responseType] - Axios responseType (default "blob")
+   * @returns {Promise<import("axios").AxiosResponse<Blob|ArrayBuffer>>}
+   */
   // eslint-disable-next-line max-statements
   function get(_ref2) {
     var token = _ref2.token,

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

@@ -1,12 +1,43 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function printedTicketsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * 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 ("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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -15,11 +46,12 @@ function printedTicketsFactory(_ref) {
         trxId = _ref2.trxId,
         lang = _ref2.lang,
         date = _ref2.date,
+        channel = _ref2.channel,
         headers = _ref2.headers;
 
     return client({
       url: "/printed-tickets",
-      params: { trxId: trxId, lang: lang, date: date },
+      params: { trxId: trxId, lang: lang, date: date, channel: channel },
       responseType: responseType,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });

package/lib/endpoints/notifications/salesforce.js

@@ -1,14 +1,32 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers.js"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for salesforce API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ sms: { create: function } }}
+ */
+
+
 function salesforceFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   return {
     sms: {
+      /**
+       * POST /salesforce/sms - send SMS via Salesforce.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} [opts.smsMsg] - SMS message payload
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref2) {
         var token = _ref2.token,
             jwtToken = _ref2.jwtToken,
@@ -26,7 +44,6 @@ function salesforceFactory(_ref) {
         });
       }
     }
-
   };
 }
 

package/lib/endpoints/notifications/twilio.js

@@ -1,14 +1,32 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers.js"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for twilio API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ phoneNumbers: { all: function, create: function }, sms: { create: function }, whatsapp: { create: function } }}
+ */
+
+
 function twilioFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   return {
     phoneNumbers: {
+      /**
+       * 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 {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       all: function all(_ref2) {
         var isocode = _ref2.isocode,
             token = _ref2.token,
@@ -22,6 +40,16 @@ function twilioFactory(_ref) {
           headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
         });
       },
+
+      /**
+       * POST /twilio/phone-numbers - create/provision a Twilio phone number.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} [opts.phoneNumberData] - Phone number payload
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref3) {
         var token = _ref3.token,
             jwtToken = _ref3.jwtToken,
@@ -40,6 +68,15 @@ function twilioFactory(_ref) {
       }
     },
     sms: {
+      /**
+       * POST /twilio/sms - send SMS via Twilio.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} [opts.smsMsg] - SMS message payload
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref4) {
         var token = _ref4.token,
             jwtToken = _ref4.jwtToken,
@@ -58,6 +95,15 @@ function twilioFactory(_ref) {
       }
     },
     whatsapp: {
+      /**
+       * POST /twilio/whatsapp - send WhatsApp message via Twilio.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} [opts.whatsappMsg] - WhatsApp message payload
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create: function create(_ref5) {
         var token = _ref5.token,
             jwtToken = _ref5.jwtToken,
@@ -75,7 +121,6 @@ function twilioFactory(_ref) {
         });
       }
     }
-
   };
 }
 

package/lib/endpoints/operations/accounting_items.js

@@ -3,10 +3,37 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
+ */
+
+/**
+ * Factory for accounting-items API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} accounting-items API methods
+ */
+
+
 function accountingItemsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /accounting-items - list accounting items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {AccountingItemsListQuery} [opts.query] - Query params (all optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -23,6 +50,14 @@ function accountingItemsFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var accountingItemId = _ref3.accountingItemId,
         token = _ref3.token,

package/lib/endpoints/operations/applied_insurance.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for applied-insurance API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * 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 (required, sent as query param)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,