btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/operations/segments.js

@@ -1,13 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /products/:productId/segments/:ticketId (btrz-api-operations). Client passes providerId as query.
+ * @typedef {Object} SegmentsListQuery
+ * @property {string} [providerId] - Provider/account id
+ */
+
+/**
+ * Factory for segments API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} segments API methods
+ */
+
+
 function segmentsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /products/:productId/segments/:ticketId - list segments for product/ticket.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {string} opts.ticketId - Ticket id
+   * @param {string} [opts.providerId] - Provider id (sent as query param)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/operations/sold-items-fulfillment.js

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} SoldItemsFulfillmentQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for sold-items fulfillment API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} sold-items fulfillment API methods
+ */
+
+
 function soldItemsFulfillmentFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /sold-items/fulfillment - list sold items fulfillment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SoldItemsFulfillmentQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/operations/sold-items.js

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} SoldItemsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for sold-items API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} sold-items API methods
+ */
+
+
 function soldItems(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /sold-items/:soldItemId - get sold item by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.soldItemId - Sold item id
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {SoldItemsQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +44,15 @@ function soldItems(_ref) {
     });
   }
 
+  /**
+   * GET /sold-items - list sold items.
+   * @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 {SoldItemsQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/operations/tickets.js

@@ -5,10 +5,34 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < argument
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} TicketsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for tickets API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} tickets API methods
+ */
+
+
 function ticketsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /tickets/:id - get ticket by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Ticket id
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {TicketsQuery} [opts.query] - Query params
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +48,17 @@ function ticketsFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /tickets/:id - patch ticket.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Ticket id
+   * @param {Object} opts.operations - JSON Patch operations
+   * @param {boolean} [opts.warningsEnabled] - Whether to enable warnings
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -40,6 +75,15 @@ function ticketsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /tickets/:ticketId/companion-tickets - get companion tickets.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.ticketId - Ticket id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function companionTickets(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -52,6 +96,16 @@ function ticketsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /tickets - list tickets.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TicketsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} [opts.providerId] - Provider id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -68,6 +122,16 @@ function ticketsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /tickets/:ticketId/delivery - update ticket delivery.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.ticketId - Ticket id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateDelivery(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -83,6 +147,16 @@ function ticketsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /tickets/:ticketId/passenger - update ticket passenger.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.ticketId - Ticket id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updatePassenger(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,

package/lib/endpoints/operations/transaction.js

@@ -1,13 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for single transaction API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transaction API methods
+ */
+
+
 function transactionFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /transaction/:id - get transaction by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Transaction id
+   * @param {string} opts.providerId - Provider 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/operations/transactions.js

@@ -1,12 +1,37 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} TransactionsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for transactions API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transactions API methods
+ */
+
+
 function transactionsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /transactions/:trxId - get transaction by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.trxId - Transaction id
+   * @param {TransactionsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +46,15 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions - list transactions.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TransactionsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -34,6 +68,15 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:trxId/tickets - get transaction tickets.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.trxId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getTickets(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -46,6 +89,15 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:trxId/applied-insurance - get applied insurance.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.trxId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function appliedInsurance(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -58,6 +110,16 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:transactionId/companion-tickets - get companion tickets.
+   * @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.ticketIds - Ticket ids
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function companionTickets(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -74,6 +136,16 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /transactions/status (expire_payment) - expire transaction payment.
+   * @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 {boolean} [opts.avoidEmail] - Whether to avoid sending email
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function expireAll(_ref7) {
     var jwtToken = _ref7.jwtToken,
         transactionId = _ref7.transactionId,
@@ -96,6 +168,17 @@ function transactionsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /transactions/:transactionId/cancellable-items - get cancellable items.
+   * @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
+   * @param {boolean} [opts.displayAll] - Whether to display all items
+   * @param {string} [opts.channel] - Channel
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function cancellableItems(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -115,6 +198,16 @@ function transactionsFactory(_ref) {
   }
 
   var payments = {
+    /**
+     * PUT /transactions/:trxId/payments - update payment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.trxId - Transaction id
+     * @param {Object} opts.paymentResult - Payment result payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -136,6 +229,17 @@ function transactionsFactory(_ref) {
   };
 
   var invoices = {
+    /**
+     * POST /transactions/:transactionId/invoices - create invoice.
+     * @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 {TransactionsQuery} [opts.query] - Query params
+     * @param {Object} opts.invoice - Invoice payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -155,6 +259,17 @@ function transactionsFactory(_ref) {
   };
 
   var creditNotes = {
+    /**
+     * POST /transactions/:transactionId/credit-notes - create credit note.
+     * @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 {TransactionsQuery} [opts.query] - Query params
+     * @param {Object} opts.creditNote - Credit note payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -173,6 +288,16 @@ function transactionsFactory(_ref) {
     }
   };
 
+  /**
+   * PUT /transactions/:trxId/delivery - update delivery.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.trxId - Transaction id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateDelivery(_ref12) {
     var token = _ref12.token,
         jwtToken = _ref12.jwtToken,

package/lib/endpoints/operations/transport_regulations.js

@@ -1,14 +1,32 @@
 "use strict";
 
-// /transport-regulations/cnrt/manifests
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for transport-regulations API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} transport-regulations API methods (cnrt)
+ */
+
+
 function transportRegulationsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   var cnrt = {
+    /**
+     * POST /transport-regulations/cnrt/manifests - create CNRT manifest.
+     * @param {Object} opts
+     * @param {Object} opts.data - Request body
+     * @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>}
+     */
     create: function create(_ref2) {
       var data = _ref2.data,
           token = _ref2.token,

package/lib/endpoints/operations/trip_change_info.js

@@ -1,13 +1,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for trip-change-info API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} trip-change-info API methods
+ */
+
+
 function tripChangeInfoFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /trip-change-info/:productId - get trip change info.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {Object} [opts.params] - Query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/operations/vehicle_assignments.js

@@ -3,11 +3,34 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} VehicleAssignmentsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for vehicle-assignments API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} vehicle-assignments API methods
+ */
+
+
 function vehicleAssignmentFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   return {
+    /**
+     * GET /vehicle-assignments - list vehicle assignments.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {VehicleAssignmentsQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all: function all(_ref2) {
       var token = _ref2.token,
           jwtToken = _ref2.jwtToken,
@@ -21,6 +44,16 @@ function vehicleAssignmentFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment by id.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleAssignmentId - Vehicle assignment id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref3) {
       var token = _ref3.token,
           jwtToken = _ref3.jwtToken,
@@ -31,6 +64,16 @@ function vehicleAssignmentFactory(_ref) {
         headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
       });
     },
+
+    /**
+     * POST /vehicle-assignments - create vehicle assignment.
+     * @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(_ref4) {
       var data = _ref4.data,
           token = _ref4.token,
@@ -44,6 +87,17 @@ function vehicleAssignmentFactory(_ref) {
         data: data
       });
     },
+
+    /**
+     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleAssignmentId - Vehicle assignment id
+     * @param {Object} opts.data - Request body
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref5) {
       var vehicleAssignmentId = _ref5.vehicleAssignmentId,
           data = _ref5.data,

package/lib/endpoints/operations/vouchers.js

@@ -1,12 +1,37 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} VouchersQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for vouchers API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} vouchers API methods
+ */
+
+
 function vouchersFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /vouchers - create voucher.
+   * @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 {VouchersQuery} [opts.query] - Query params
+   * @param {Object} [opts.voucher] - Voucher payload
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -30,6 +55,16 @@ function vouchersFactory(_ref) {
     });
   }
 
+  /**
+   * POST /vouchers/compensations - create compensation.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.compensation - Compensation payload
+   * @param {VouchersQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function compensationsCreate(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,