btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/vehicles.js

@@ -1,12 +1,50 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /vehicles (btrz-api-inventory). See API get-handler getSpec().
+ * @typedef {Object} VehiclesQuery
+ * @property {string} [disabled] - Filter by disabled status: "true" | "false"
+ * @property {boolean} [newdesign] - With singleSeatmap: consider new design seatmaps
+ * @property {boolean} [nopaging] - If true, return all matching vehicles (no page/limit)
+ * @property {number} [page] - 1-based page (20 per page); ignored when singleSeatmap or nopaging
+ * @property {boolean} [singleSeatmap] - If true, only vehicles with exactly one original seatmap (or zero if allowed)
+ * @property {string} [name] - Case-insensitive partial match on vehicle name (max 50 chars)
+ * @property {string} [internalId] - Exact match on internalId
+ * @property {string} [garageId] - Exact match on garage ID (ObjectId)
+ * @property {string} [brandId] - Exact match on brand ID (ObjectId)
+ * @property {string} [amenityGroupId] - Exact match on amenity group ID (ObjectId)
+ * @property {string} [brand] - Exact match on brand name; use "none" for empty
+ * @property {number} [capacity] - Exact match on capacity (0–10000)
+ * @property {number} [numberFrom] - Vehicles with number >= this value
+ * @property {number} [numberTo] - Vehicles with number <= this value (must be >= numberFrom)
+ * @property {string} [providerIds] - Provider IDs to scope the request (internal use)
+ */
+
+/**
+ * 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 (disabled, page, name, garageId, brandId, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +57,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 +76,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 +101,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 +123,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 +150,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 +181,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,28 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +35,14 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id. API does not accept query params.
+   * @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 +53,15 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * POST /zone-price-overages - create zone price overage(s). API does not accept query params.
+   * @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 +78,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 +100,16 @@ function zonePriceOverageFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage. API does not accept query params.
+   * @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,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /zone-prices (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ZonePricesListQuery
+ * @property {number} [page] - Page number (20 records per page)
+ * @property {number} [weight] - Weight in grams
+ * @property {string} [serviceTypeIds] - Service type id(s), comma-separated
+ * @property {string} [departureZones] - Departure zone(s), comma-separated
+ * @property {string} [arrivalZones] - Arrival zone(s), comma-separated
+ */
+
+/**
+ * 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 {ZonePricesListQuery} [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,
@@ -20,6 +46,14 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * GET /zone-prices/:zonePriceId - get zone price by id. API does not accept query params.
+   * @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 +64,15 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * POST /zone-prices - create zone price. API does not accept query params.
+   * @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 +89,15 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /zone-prices/:zonePriceId - remove zone price. API does not accept query params.
+   * @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 +111,16 @@ function zonePriceFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /zone-prices/:zonePriceId - update zone price. API does not accept query params.
+   * @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,39 @@
 "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). See post-dlink-handler getSpec().
+ * @typedef {Object} InvoiceDlinkPostQuery
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string} [providerId] - Invoice provider id to use
+ */
+
+/**
+ * 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 +51,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,31 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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. 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>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/invoices/gti.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 /gti (btrz-api-invoices). See post-gti-handler getSpec().
+ * @typedef {Object} InvoiceGtiPostQuery
+ * @property {string|boolean} [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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +50,16 @@ function gtiFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/invoices/infile.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 /infile (btrz-api-invoices). See post-infile-handler getSpec().
+ * @typedef {Object} InvoiceInfilePostQuery
+ * @property {string|boolean} [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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +50,16 @@ function infileFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/invoices/infileJson.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 /infile-json (btrz-api-invoices). See post-infile-json-handler getSpec().
+ * @typedef {Object} InvoiceInfileJsonPostQuery
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+
+/**
+ * Factory for Infile JSON 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 infileJsonFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /infile-json - create Infile JSON 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 {InvoiceInfileJsonPostQuery} [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 infileJsonFactory(_ref) {
     });
   }
 
+  /**
+   * POST /infile-json - validate Infile JSON 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 {InvoiceInfileJsonPostQuery} [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,