btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/inventory/traveller-card-types.js

@@ -1,6 +1,27 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /traveller-card-types (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTravellerCardTypesListQuery
+ */
+
+/**
+ * Factory for traveller-card-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function, remove: function }}
+ */
 function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /traveller-card-types - list traveller card types.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryTravellerCardTypesListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/traveller-card-types",
@@ -9,6 +30,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /traveller-card-types - create traveller card type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, travellerCardType, headers}) {
     return client({
       url: "/traveller-card-types",
@@ -18,6 +48,16 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /traveller-card-types/:travellerCardTypeId - update traveller card type.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {Object} opts.travellerCardType - Traveller card type payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, travellerCardTypeId, travellerCardType, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,
@@ -27,6 +67,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /traveller-card-types/:travellerCardTypeId - get traveller card type by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, travellerCardTypeId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,
@@ -35,6 +84,15 @@ function travellerCardTypesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /traveller-card-types/:travellerCardTypeId - remove traveller card type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.travellerCardTypeId - Traveller card type id
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, travellerCardTypeId, jwtToken, headers}) {
     return client({
       url: `/traveller-card-types/${travellerCardTypeId}`,

package/src/endpoints/inventory/trips.js

@@ -1,7 +1,28 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function tripsFactory({ client, internalAuthTokenProvider }) {
-  function all({ token, jwtToken, query = {}, headers }) {
+/**
+ * Query params for GET /trips (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryTripsListQuery
+ */
+
+/**
+ * Factory for trips API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+function tripsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /trips - list trips.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryTripsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/trips",
       params: query,
@@ -9,6 +30,14 @@ function tripsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
+  /**
+   * GET /trip/:id - get trip by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.id - Trip id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, id, headers}) {
     return client.get(`/trip/${id}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})

package/src/endpoints/inventory/vehicle-types.js

@@ -2,15 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for vehicle-types API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function vehicleTypesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET all vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
-   * Used when configuring schedule vehicle type or displaying vehicle type in trips/manifests.
+   * GET /vehicle-types - list vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
    * @param {Object} opts
-   * @param {string} opts.token - API key token
-   * @param {Object} [opts.query] - Optional query params
-   * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<{data: {vehicleTypes: Array<{_id: string, name: string}>}}>}
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
    */
   function all({token, jwtToken, query = {}, headers}) {
     return client.get("/vehicle-types", {

package/src/endpoints/inventory/vehicles.js

@@ -1,8 +1,29 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} VehiclesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for vehicles API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, seatmaps: object }}
+ */
 function vehiclesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /vehicles - list vehicles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {VehiclesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -14,12 +35,30 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /vehicles/:vehicleId - get vehicle by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({vehicleId, token, headers}) {
     return client.get(`/vehicles/${vehicleId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /vehicles - create vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, vehicle, headers}) {
     return client({
       url: "/vehicles",
@@ -31,6 +70,15 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /vehicles/:vehicleId - remove vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, vehicleId, token, headers}) {
     return client({
       url: `/vehicles/${vehicleId}`,
@@ -39,6 +87,16 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /vehicles/:vehicleId - update vehicle.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.vehicleId - Vehicle id
+   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, vehicleId, vehicle, headers}) {
     return client({
       url: `/vehicles/${vehicleId}`,
@@ -50,7 +108,19 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, remove: function }} */
   const seatmaps = {
+    /**
+     * POST /vehicles/:vehicleId/seatmaps - create vehicle seatmap.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleId - Vehicle id
+     * @param {Object} opts.seatmap - Seatmap payload
+     * @param {boolean} [opts.newdesign] - New design flag
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, vehicleId, seatmap, headers, newdesign}) {
       return client({
         url: `/vehicles/${vehicleId}/seatmaps`,
@@ -62,6 +132,17 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /vehicles/:vehicleId/seatmaps/:seatMapId - remove vehicle seatmap.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.vehicleId - Vehicle id
+     * @param {string} opts.seatMapId - Seat map id
+     * @param {boolean} [opts.newdesign] - New design flag
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove({jwtToken, vehicleId, seatMapId, token, headers, newdesign}) {
       return client({
         url: `/vehicles/${vehicleId}/seatmaps/${seatMapId}`,

package/src/endpoints/inventory/zone-price-overages.js

@@ -1,9 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for zone-price-overages endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryZonePriceOveragesQuery
+ */
 
+/**
+ * Factory for zone-price-overages API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /zone-price-overages - list zone price overages.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryZonePriceOveragesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +34,29 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id.
+   * @param {Object} opts
+   * @param {string} opts.zonePriceOverageId - Zone price overage id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({zonePriceOverageId, token, headers}) {
     return client.get(`/zone-price-overages/${zonePriceOverageId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /zone-price-overages - create zone price overage(s).
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.zonePriceOverages - Zone price overages payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, zonePriceOverages, headers}) {
     return client({
       url: "/zone-price-overages",
@@ -32,6 +68,15 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /zone-price-overages/:zonePriceOverageId - remove zone price overage.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.zonePriceOverageId - Zone price overage id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, zonePriceOverageId, token, headers}) {
     return client({
       url: `/zone-price-overages/${zonePriceOverageId}`,
@@ -40,6 +85,16 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.zonePriceOverageId - Zone price overage id
+   * @param {Object} opts.zonePriceOverages - Zone price overages payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, zonePriceOverageId, zonePriceOverages, headers}) {
     return client({
       url: `/zone-price-overages/${zonePriceOverageId}`,

package/src/endpoints/inventory/zone-prices.js

@@ -1,9 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function zonePriceFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for zone-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryZonePricesQuery
+ */
 
+/**
+ * Factory for zone-prices API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+function zonePriceFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /zone-prices - list zone prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryZonePricesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,12 +34,29 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /zone-prices/:zonePriceId - get zone price by id.
+   * @param {Object} opts
+   * @param {string} opts.zonePriceId - Zone price id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({zonePriceId, token, headers}) {
     return client.get(`/zone-prices/${zonePriceId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /zone-prices - create zone price.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.zonePrice - Zone price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, zonePrice, headers}) {
     return client({
       url: "/zone-prices",
@@ -32,6 +68,15 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /zone-prices/:zonePriceId - remove zone price.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.zonePriceId - Zone price id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, zonePriceId, token, headers}) {
     return client({
       url: `/zone-prices/${zonePriceId}`,
@@ -40,6 +85,16 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /zone-prices/:zonePriceId - update zone price.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.zonePriceId - Zone price id
+   * @param {Object} opts.zonePrice - Zone price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, zonePriceId, zonePrice, headers}) {
     return client({
       url: `/zone-prices/${zonePriceId}`,

package/src/endpoints/invoices/dlink.js

@@ -1,6 +1,30 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for POST /dlink (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceDlinkPostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+
+/**
+ * Factory for DLink invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 function dlinkFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /dlink - create DLink invoice.
+   * @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 {InvoiceDlinkPostQuery} [opts.query] - onlyValidateRequest (optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/dlink",
@@ -11,6 +35,16 @@ function dlinkFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /dlink - validate DLink invoice request (onlyValidateRequest=true).
+   * @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 {InvoiceDlinkPostQuery} [opts.query] - onlyValidateRequest (set to true internally)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function validateCreate({token, jwtToken, data, query = {}, headers}) {
     // eslint-disable-next-line no-param-reassign
     query.onlyValidateRequest = true;

package/src/endpoints/invoices/docs.js

@@ -1,4 +1,14 @@
+/**
+ * Factory for invoices API docs (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @returns {{ get: function }}
+ */
 function docsFactory({client}) {
+  /**
+   * GET /api-docs-v2 - get API documentation.
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get() {
     return client.get("/api-docs-v2", {});
   }

package/src/endpoints/invoices/emails.js

@@ -1,6 +1,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for POST /emails (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoiceEmailsPostQuery
+ */
+
+/**
+ * Factory for invoice emails API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function emailsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /emails - create/send invoice email.
+   * @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 {InvoiceEmailsPostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/emails",

package/src/endpoints/invoices/gti.js

@@ -1,6 +1,30 @@
-const {authorizationHeaders} = require("../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for POST /gti (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceGtiPostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+
+/**
+ * Factory for GTI invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 function gtiFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /gti - create GTI invoice.
+   * @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 {InvoiceGtiPostQuery} [opts.query] - onlyValidateRequest (optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/gti",
@@ -11,6 +35,16 @@ function gtiFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /gti - validate GTI invoice request (onlyValidateRequest=true).
+   * @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 {InvoiceGtiPostQuery} [opts.query] - onlyValidateRequest (set to true internally)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function validateCreate({token, jwtToken, data, query = {}, headers}) {
     // eslint-disable-next-line no-param-reassign
     query.onlyValidateRequest = true;

package/src/endpoints/invoices/infile.js

@@ -1,6 +1,30 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for POST /infile (btrz-api-invoices). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceInfilePostQuery
+ * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+
+/**
+ * Factory for Infile invoice API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, validateCreate: function }}
+ */
 function infileFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /infile - create Infile invoice.
+   * @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 {InvoiceInfilePostQuery} [opts.query] - onlyValidateRequest (optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/infile",
@@ -11,6 +35,16 @@ function infileFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /infile - validate Infile invoice request (onlyValidateRequest=true).
+   * @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 {InvoiceInfilePostQuery} [opts.query] - onlyValidateRequest (set to true internally)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function validateCreate({token, jwtToken, data, query = {}, headers}) {
     // eslint-disable-next-line no-param-reassign
     query.onlyValidateRequest = true;