btrz-api-client 8.29.0 → 8.31.0

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

@@ -1,6 +1,37 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /sold-items list (btrz-api-operations). See get-handler getSpec().
+ * @typedef {Object} SoldItemsListQuery
+ * @property {number} [page] - Page number to retrieve
+ * @property {string} [from] - Ticket manifest date from (yyyy-mm-dd; range max 31 days)
+ * @property {string} [to] - Ticket manifest date to (yyyy-mm-dd; range max 31 days)
+ */
+
+/**
+ * Query params for GET /sold-items/:soldItemId (btrz-api-operations). See get-by-id-handler getSpec().
+ * @typedef {Object} SoldItemsGetQuery
+ * @property {string} [providerId] - Provider account id (ObjectId)
+ */
+
+/**
+ * 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({client, 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 {SoldItemsGetQuery} [opts.query] - Optional query (providerId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, soldItemId, headers, query}) {
     return client.get(`/sold-items/${soldItemId}`, {
       params: query,
@@ -8,6 +39,15 @@ function soldItems({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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 {SoldItemsListQuery} [opts.query] - Query params (page, from, to)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, headers, query}) {
     return client.get("/sold-items", {
       params: query,

package/src/endpoints/operations/tickets.js

@@ -1,6 +1,28 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /tickets list (btrz-api-operations). providerId merged when opts.providerId set.
+ * @typedef {Object} TicketsListQuery
+ * @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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /tickets/:id - get ticket by id. API does not accept query params (btrz-api-operations).
+   * @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
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, headers, query}) {
     return client({
       url: `/tickets/${id}`,
@@ -10,6 +32,17 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, id, operations, warningsEnabled, headers}) {
     return client({
       url: `/tickets/${id}`,
@@ -19,6 +52,15 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, ticketId, headers}) {
     return client({
       url: `/tickets/${ticketId}/companion-tickets`,
@@ -26,6 +68,16 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /tickets - list tickets.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TicketsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} [opts.providerId] - Provider id
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers, providerId}) {
     const query_ = providerId ? {...query, providerId} : query;
     return client({
@@ -35,6 +87,16 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, ticketId, data, headers}) {
     return client({
       url: `/tickets/${ticketId}/delivery`,
@@ -44,6 +106,16 @@ function ticketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, ticketId, data, headers}) {
     return client({
       url: `/tickets/${ticketId}/passenger`,

package/src/endpoints/operations/transaction.js

@@ -1,15 +1,31 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function transactionFactory({ client, internalAuthTokenProvider }) {
-
-  function get({ token, jwtToken, id, providerId, headers }) {
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /transaction/:id - get transaction by id. providerId passed as query param in URL.
+   * @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({token, jwtToken, id, providerId, headers}) {
     return client({
       url: `/transaction/${id}?providerId=${providerId}`,
-      headers: authorizationHeaders({ token , jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  return { 
+  return {
     get
   };
 }

package/src/endpoints/operations/transactions.js

@@ -1,6 +1,23 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
+  /**
+   * GET /transactions/:trxId - get transaction by 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
+   * @param {string} opts.trxId - Transaction id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, trxId, query, headers}) {
     return client({
       url: `/transactions/${trxId}`,
@@ -9,6 +26,14 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /transactions - list transactions. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query, headers}) {
     return client({
       url: "/transactions",
@@ -17,6 +42,15 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, trxId, headers}) {
     return client({
       url: `/transactions/${trxId}/tickets`,
@@ -24,6 +58,15 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, trxId, headers}) {
     return client({
       url: `/transactions/${trxId}/applied-insurance`,
@@ -31,6 +74,16 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, transactionId, ticketIds, headers}) {
     return client({
       url: `/transactions/${transactionId}/companion-tickets`,
@@ -41,6 +94,16 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({jwtToken, transactionId, avoidEmail, token, headers}) {
     return client({
       url: "/transactions/status",
@@ -57,6 +120,17 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /transactions/:transactionId/cancellable-items - get cancellable items. Query: displayAll, channel (channel required per getSpec).
+   * @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] - Display all transaction items whether cancellable or not
+   * @param {string} [opts.channel] - Channel (required per btrz-api-operations getSpec)
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function cancellableItems({token, jwtToken, transactionId, headers, displayAll, channel}) {
     return client({
       url: `/transactions/${transactionId}/cancellable-items`,
@@ -69,6 +143,16 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   }
 
   const 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({token, jwtToken, trxId, paymentResult, headers}) {
       return client({
         url: `/transactions/${trxId}/payments`,
@@ -84,6 +168,17 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   };
 
   const 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({token, jwtToken, transactionId, query, invoice, headers}) {
       return client({
         url: `/transactions/${transactionId}/invoices`,
@@ -96,6 +191,16 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
   };
 
   const creditNotes = {
+    /**
+     * POST /transactions/:transactionId/credit-notes - create credit note. 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.transactionId - Transaction id
+     * @param {Object} opts.creditNote - Credit note payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, transactionId, query, creditNote, headers}) {
       return client({
         url: `/transactions/${transactionId}/credit-notes`,
@@ -107,6 +212,16 @@ function transactionsFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /**
+   * 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({token, jwtToken, trxId, data, headers}) {
     return client({
       url: `/transactions/${trxId}/delivery`,

package/src/endpoints/operations/transport_regulations.js

@@ -1,10 +1,26 @@
-// /transport-regulations/cnrt/manifests
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * 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({client, internalAuthTokenProvider}) {
   const cnrt = {
+    /**
+     * POST /transport-regulations/cnrt/manifests - create CNRT manifest. API does not accept query params.
+     * @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({data, token, jwtToken, headers}) {
       return client({
         url: "/transport-regulations/cnrt/manifests",

package/src/endpoints/operations/trip_change_info.js

@@ -1,11 +1,39 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function tripChangeInfoFactory({ client, internalAuthTokenProvider }) {
+/**
+ * Query params for GET /trip-change-info/:productId (btrz-api-operations get-trip-change-info getSpec).
+ * @typedef {Object} TripChangeInfoGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [ticketNumber] - Ticket number (required for Reservation products)
+ * @property {string} [lastName] - Passenger last name (required for Reservation products)
+ * @property {string} [departureDate] - Departure date yyyy-mm-dd (required for Reservation products)
+ * @property {string} [returnDate] - Return date yyyy-mm-dd (optional for Reservation products)
+ * @property {string} [ticketId] - Ticket id
+ * @property {string} [channel] - Sales change channel (default websales)
+ */
 
-  function get({ token, jwtToken, productId, params, headers}) {
+/**
+ * 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({client, 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 {TripChangeInfoGetQuery} [opts.params] - Query params (providerId, ticketNumber, lastName, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, productId, params, headers}) {
     return client({
       url: `/trip-change-info/${productId}`,
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       params
     });
   }

package/src/endpoints/operations/vehicle_assignments.js

@@ -2,8 +2,34 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /vehicle-assignments list (btrz-api-operations get-handler getSpec).
+ * @typedef {Object} VehicleAssignmentsListQuery
+ * @property {string} [name] - Partial or full name of the vehicle assignment
+ * @property {string} [effectiveFrom] - Valid-from date (format per API)
+ * @property {string} [effectiveTo] - Valid-to date (format per API)
+ * @property {string} [status] - Status, comma-separated; valid: draft, published
+ * @property {number} [page] - Page number (20 records per page)
+ */
+
+/**
+ * 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({client, 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({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/vehicle-assignments",
@@ -11,11 +37,29 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * GET /vehicle-assignments/:vehicleAssignmentId - get vehicle assignment by 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
+     * @param {string} opts.vehicleAssignmentId - Vehicle assignment id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, vehicleAssignmentId, headers}) {
       return client.get(`/vehicle-assignments/${vehicleAssignmentId}`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /vehicle-assignments - create vehicle assignment. 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.data - Request body
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({data, token, jwtToken, headers}) {
       return client({
         url: "/vehicle-assignments",
@@ -24,6 +68,16 @@ function vehicleAssignmentFactory({client, internalAuthTokenProvider}) {
         data
       });
     },
+    /**
+     * PUT /vehicle-assignments/:vehicleAssignmentId - update vehicle assignment. 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.vehicleAssignmentId - Vehicle assignment id
+     * @param {Object} opts.data - Request body
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({vehicleAssignmentId, data, token, jwtToken, headers}) {
       return client({
         url: `/vehicle-assignments/${vehicleAssignmentId}`,

package/src/endpoints/operations/vouchers.js

@@ -1,10 +1,27 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * 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({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * POST /vouchers - create voucher. 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.headers] - Optional headers
+   * @param {Object} [opts.voucher] - Voucher payload
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     jwtToken, token, headers, query = {}, voucher = {}
   }) {
@@ -22,6 +39,15 @@ function vouchersFactory({
     });
   }
 
+  /**
+   * POST /vouchers/compensations - create compensation. 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.compensation - Compensation payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function compensationsCreate({token, jwtToken, compensation, query = {}, headers}) {
     return client({
       url: "/vouchers/compensations",

package/src/endpoints/operations/waitlists.js

@@ -1,6 +1,32 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /waitlists (btrz-api-operations getSpec).
+ * @typedef {Object} WaitlistsListQuery
+ * @property {number} [page] - Page number to return (20 records per page)
+ * @property {string} [originId] - Filter by origin id (24 hex chars)
+ * @property {string} [destinationId] - Filter by destination id (24 hex chars)
+ * @property {string} [dateOfTravelStr] - Filter by date of travel (YYYY-MM-DD)
+ */
+
+/**
+ * Factory for waitlists API (btrz-api-operations).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} waitlists API methods
+ */
 function waitlistsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /waitlists - list waitlists.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {WaitlistsListQuery} [opts.query] - page, originId, destinationId, dateOfTravelStr
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetWaitlistsResponse; 400 INVALID_ORIGIN_ID, INVALID_DESTINATION_ID, INVALID_DATE_OF_TRAVEL_STR
+   */
   function all({token, jwtToken, query, headers}) {
     return client({
       url: "/waitlists",
@@ -9,6 +35,15 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /waitlists/:waitlistId - get waitlist by 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
+   * @param {string} opts.waitlistId - Waitlist id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, waitlistId, headers}) {
     return client({
       url: `/waitlists/${waitlistId}`,
@@ -17,19 +52,37 @@ function waitlistsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ token, jwtToken, waitlistId, headers }) {
+  /**
+   * DELETE /waitlists/:waitlistId - remove waitlist.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.waitlistId - Waitlist id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({token, jwtToken, waitlistId, headers}) {
     return client({
       url: `/waitlists/${waitlistId}`,
       method: "delete",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers })
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ token, jwtToken, data, headers }) {  
+  /**
+   * POST /waitlists - create waitlist. 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.data - Waitlist payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, data, headers}) {
     return client({
       url: "/waitlists",
       method: "post",
-      headers: authorizationHeaders({ token, jwtToken, internalAuthTokenProvider, headers }),
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
       data
     });
   }