btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/btrzpay/payments.js

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, get: function }}
+ */
+
+
 function paymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /payments - create payments.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.payments - Payments payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +39,15 @@ function paymentsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:transactionId - get transaction.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.transactionId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/btrzpay/prismaTerminals.js

@@ -3,11 +3,36 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} PrismaTerminalsQuery
+ * @property {string} [providerId] - Account provider/operator ID for agencies/sellers
+ * @property {boolean} [validateRefund] - (PUT refunds only) If true, fetch current state from Prisma before applying
+ */
+
+/**
+ * Factory for Prisma terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ payments: Object, settlements: Object }}
+ */
+
+
 function prismaTerminalsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var reversals = {
+    /**
+     * GET /prisma-terminals/reversals/:id - get reversal by id.
+     * @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>}
+     */
     get: function get(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +46,18 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/reversals - create reversal.
+     * @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>}
+     */
     create: function create(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -38,6 +75,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaReversal: prismaReversal }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/reversals/:id - delete reversal.
+     * @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>}
+     */
     delete: function _delete(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,
@@ -56,6 +104,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var refunds = {
+    /**
+     * GET /prisma-terminals/refunds/:id - get refund by id.
+     * @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>}
+     */
     get: function get(_ref5) {
       var token = _ref5.token,
           jwtToken = _ref5.jwtToken,
@@ -69,6 +127,18 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments/:id/refunds - create refund.
+     * @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>}
+     */
     create: function create(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -86,6 +156,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaRefund: prismaRefund }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/refunds/:id - delete refund.
+     * @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>}
+     */
     delete: function _delete(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -101,6 +182,18 @@ function prismaTerminalsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * PUT /prisma-terminals/refunds/:id - update refund.
+     * @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 {Object} opts.prismaRefund - Prisma refund payload
+     * @param {PrismaTerminalsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -121,6 +214,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var payments = {
+    /**
+     * GET /prisma-terminals/payments/:id - get payment by id.
+     * @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>}
+     */
     get: function get(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -134,6 +237,17 @@ function prismaTerminalsFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /prisma-terminals/payments - create payment.
+     * @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>}
+     */
     create: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -150,6 +264,17 @@ function prismaTerminalsFactory(_ref) {
         data: { prismaPayment: prismaPayment }
       });
     },
+
+    /**
+     * DELETE /prisma-terminals/payments/:id - delete payment.
+     * @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>}
+     */
     delete: function _delete(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -165,6 +290,18 @@ function prismaTerminalsFactory(_ref) {
         params: query
       });
     },
+
+    /**
+     * PUT /prisma-terminals/payments/:id - update payment.
+     * @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>}
+     */
     update: function update(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -188,6 +325,16 @@ function prismaTerminalsFactory(_ref) {
   };
 
   var settlements = {
+    /**
+     * POST /prisma-terminals/settlements - create settlement.
+     * @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>}
+     */
     create: function create(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,

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

@@ -1,13 +1,30 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for reference numbers API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function referenceNumbersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * POST /reference-numbers - create reference number.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.referenceNumberRequest - Reference number request payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/btrzpay/referenced-payments.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for referenced payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getStatus: function, update: function }}
+ */
+
+
 function referencedPaymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /referenced-payments/:transactionId/:referenceNumber/status - get status.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.transactionId - Transaction id
+   * @param {string} opts.referenceNumber - Reference number
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getStatus(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +39,17 @@ function referencedPaymentsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /referenced-payments/:externalType/:referenceNumber/results - update payment result.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.externalType - External type
+   * @param {string} opts.referenceNumber - Reference number
+   * @param {Object} opts.paymentResult - Payment result payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/btrzpay/square.js

@@ -1,12 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for Square webhooks API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
+
+
 function squareWebhooksFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /square-webhooks/:providerId - create Square webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.providerId - Provider id
+   * @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,
@@ -27,10 +46,25 @@ function squareWebhooksFactory(_ref) {
   };
 }
 
+/**
+ * Factory for Square terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function squareTerminalsFactory(_ref3) {
   var client = _ref3.client,
       internalAuthTokenProvider = _ref3.internalAuthTokenProvider;
 
+  /**
+   * GET /square-terminals - get Square terminals.
+   * @param {Object} opts
+   * @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>}
+   */
   function get(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/btrzpay/stripe-terminals.js

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} StripeTerminalsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for Stripe terminals API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, simulate: function }}
+ */
+
+
 function stripeTerminalsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /stripe-terminals - list Stripe terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {StripeTerminalsQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +45,17 @@ function stripeTerminalsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /stripe-terminals/:id/simulate - simulate Stripe payment.
+   * @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>}
+   */
   function simulate(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/btrzpay/terminalPayments.js

@@ -3,11 +3,36 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} TerminalPaymentsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for terminal payments API (btrz-api-payments).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ mit: Object, webhooks: Object }}
+ */
+
+
 function terminalPaymentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var mit = {
+    /**
+     * PUT /terminal-payments/mit/:id - update MIT terminal payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -25,6 +50,17 @@ function terminalPaymentsFactory(_ref) {
         data: { terminalPayment: terminalPayment }
       });
     },
+
+    /**
+     * GET /terminal-payments/mit/:id - get MIT terminal payment.
+     * @param {Object} opts
+     * @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 {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -41,6 +77,16 @@ function terminalPaymentsFactory(_ref) {
   };
 
   var webhooks = {
+    /**
+     * POST /terminal-payments/webhooks/getnet/:providerId - Getnet webhook.
+     * @param {Object} opts
+     * @param {Object} opts.data - Request body
+     * @param {string} opts.providerId - Provider id
+     * @param {Object} [opts.headers] - Optional headers
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     getnet: function getnet(_ref4) {
       var data = _ref4.data,
           providerId = _ref4.providerId,

package/lib/endpoints/coltrane/docs.js

@@ -1,8 +1,18 @@
 "use strict";
 
+/**
+ * Factory for Coltrane API docs (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory(_ref) {
   var client = _ref.client;
 
+  /**
+   * GET /api-docs-v2 - get API documentation.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

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

@@ -1,12 +1,32 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for Coltrane merged fare tables API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function mergedFareTablesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /coltrane/routes/:routeId/merged-fare-tables/:productId - get merged fare table.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.productId - Product id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/coltrane/paths.js

@@ -1,12 +1,39 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /paths (btrz-api-coltrane).
+ * @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
+ */
+
+/**
+ * Factory for Coltrane paths API (btrz-api-coltrane).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function coltraneFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/endpoints_helpers.js

@@ -4,8 +4,18 @@ var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = [
 
 var _typeof = typeof Symbol === "function" && typeof Symbol.iterator === "symbol" ? function (obj) { return typeof obj; } : function (obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; };
 
-var constants = require("../constants");
+/* eslint-disable max-len */
+var constants = require("../constants.js");
 
+/**
+ * Builds authorization and forwarding headers for API requests.
+ * @param {Object} opts - Options for authorization
+ * @param {string} [opts.token] - API key; sets x-api-key header when provided
+ * @param {string} [opts.jwtToken] - JWT or internal auth symbol; sets Authorization Bearer when provided
+ * @param {{ getToken: function(): string }} [opts.internalAuthTokenProvider] - When jwtToken is INTERNAL_AUTH_TOKEN_SYMBOL, getToken() is used for the Bearer token
+ * @param {Object} [opts.headers] - Optional request headers; x-amzn-trace-id and x-elevation-token are forwarded when present; cookie with "btrz-trusted" is forwarded for trusted machine
+ * @returns {Object} Headers object suitable for axios (x-api-key, Authorization, cookie, x-amzn-trace-id, x-elevation-token as applicable)
+ */
 function authorizationHeaders(_ref) {
   var token = _ref.token,
       jwtToken = _ref.jwtToken,