btrz-api-client 8.29.0 → 8.30.0

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

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +44,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -35,6 +67,16 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -50,6 +92,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         travellerCardTypeId = _ref5.travellerCardTypeId,
@@ -63,6 +114,15 @@ function travellerCardTypesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         travellerCardTypeId = _ref6.travellerCardTypeId,

package/lib/endpoints/inventory/trips.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -21,6 +44,14 @@ function tripsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         id = _ref3.id,

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

@@ -3,18 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,

package/lib/endpoints/inventory/vehicles.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +42,15 @@ function vehiclesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var vehicleId = _ref3.vehicleId,
         token = _ref3.token,
@@ -29,6 +61,15 @@ function vehiclesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -45,6 +86,15 @@ function vehiclesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         vehicleId = _ref5.vehicleId,
@@ -58,6 +108,16 @@ function vehiclesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,
@@ -75,7 +135,19 @@ function vehiclesFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, remove: function }} */
   var 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: function create(_ref7) {
       var jwtToken = _ref7.jwtToken,
           token = _ref7.token,
@@ -94,6 +166,18 @@ function vehiclesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function remove(_ref8) {
       var jwtToken = _ref8.jwtToken,
           vehicleId = _ref8.vehicleId,

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

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,14 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var zonePriceOverageId = _ref3.zonePriceOverageId,
         token = _ref3.token,
@@ -30,6 +59,15 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +84,15 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         zonePriceOverageId = _ref5.zonePriceOverageId,
@@ -59,6 +106,16 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

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

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,14 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var zonePriceId = _ref3.zonePriceId,
         token = _ref3.token,
@@ -30,6 +59,15 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +84,15 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         zonePriceId = _ref5.zonePriceId,
@@ -59,6 +106,16 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/invoices/dlink.js

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +50,16 @@ function dlinkFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/invoices/docs.js

@@ -1,8 +1,18 @@
 "use strict";
 
+/**
+ * Factory for invoices API docs (btrz-api-invoices).
+ * @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/invoices/emails.js

@@ -1,12 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,