btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/invoices/dlink.js

@@ -1,6 +1,31 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({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 +36,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,23 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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. 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({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). 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({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). 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({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;

package/src/endpoints/invoices/infileJson.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-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({client, 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({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/infile-json",
@@ -11,6 +35,16 @@ function infileJsonFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, query = {}, headers}) {
     // eslint-disable-next-line no-param-reassign
     query.onlyValidateRequest = true;

package/src/endpoints/invoices/invoices.js

@@ -1,6 +1,35 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /invoices (btrz-api-invoices). See get-handler getSpec().
+ * @typedef {Object} InvoicesListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
+ */
+
+/**
+ * Query params for GET /failures (btrz-api-invoices). See get-failures-handler getSpec().
+ * @typedef {Object} InvoicesFailuresQuery
+ * @property {string} [transactionId] - Transaction id of the invoice failure
+ */
+
+/**
+ * Factory for invoices API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, getInvoicesFailures: function, retryInvoicing: function, overrideBuyerRetryInvoicing: function }}
+ */
 function invoicesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /invoices - list invoices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InvoicesListQuery} [opts.query] - Query params (transactionId required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/invoices",
@@ -10,6 +39,15 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /invoices/:id - get invoice 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.id - Invoice id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/invoices/${id}`,
@@ -19,6 +57,15 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /failures - list invoice failures.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InvoicesFailuresQuery} [opts.query] - Query params (transactionId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getInvoicesFailures({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/failures",
@@ -28,6 +75,15 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /retry - retry invoicing. 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 retryInvoicing({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/retry",
@@ -38,6 +94,15 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /retry - override buyer and retry invoicing. 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 overrideBuyerRetryInvoicing({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/retry",

package/src/endpoints/invoices/pdfs.js

@@ -1,6 +1,30 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /pdfs (btrz-api-invoices). See pdfs get-handler getSpec().
+ * @typedef {Object} PdfsListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
+ */
+
+/**
+ * Factory for invoice PDFs API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function pdfsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /pdfs - list invoice PDFs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PdfsListQuery} [opts.query] - Query params (transactionId required)
+   * @param {string} [opts.responseType] - Response type (e.g. "json", "blob")
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, responseType = "json", headers}) {
     return client({
       url: "/pdfs",

package/src/endpoints/invoices/providers.js

@@ -1,6 +1,33 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /providers (btrz-api-invoices). See providers get-handler getSpec().
+ * @typedef {Object} ProvidersListQuery
+ * @property {boolean} [enabled] - If the provider is enabled or not
+ * @property {string} [invoiceProviderType] - The type of the provider
+ * @property {string} [channel] - Filter by channel (must be one of the allowed channels)
+ * @property {string} [country] - ISO code of the provider's country
+ * @property {string} [operatingCompany] - Operating company id associated with the provider
+ */
+
+/**
+ * Factory for invoice providers API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
 function providersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /providers - list invoice providers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ProvidersListQuery} [opts.query] - Query params (all optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/providers",
@@ -10,6 +37,15 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /providers/:id - get invoice provider 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.id - Provider id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/providers/${id}`,
@@ -19,6 +55,16 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /providers/:id - update invoice provider. 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.id - Provider id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, id, data, query = {}, headers}) {
     return client({
       url: `/providers/${id}`,
@@ -29,6 +75,15 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /providers/:id - remove invoice provider. 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.id - Provider id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, id, query = {}, headers}) {
     return client({
       url: `/providers/${id}`,
@@ -38,6 +93,15 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /providers - create invoice provider. 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({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/providers",

package/src/endpoints/invoices/providersSequences.js

@@ -1,6 +1,23 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for invoice provider sequences API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, remove: function, create: function, update: function }}
+ */
 function providersSequencesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /providers/:invoiceProviderId/sequences - list provider sequences. 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.invoiceProviderId - Invoice provider id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 PROVIDER_NOT_FOUND
+   */
   function all({token, jwtToken, invoiceProviderId, query = {}, headers}) {
     return client({
       url: `/providers/${invoiceProviderId}/sequences`,
@@ -10,6 +27,16 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence. 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.invoiceProviderId - Invoice provider id
+   * @param {string} opts.invoiceProviderSequenceId - Sequence id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, invoiceProviderId, invoiceProviderSequenceId, query = {}, headers}) {
     return client({
       url: `/providers/${invoiceProviderId}/sequences/${invoiceProviderSequenceId}`,
@@ -19,6 +46,16 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence. 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.invoiceProviderId - Invoice provider id
+   * @param {string} opts.id - Sequence id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, invoiceProviderId, id, query = {}, headers}) {
     return client({
       url: `/providers/${invoiceProviderId}/sequences/${id}`,
@@ -28,6 +65,16 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /providers/:invoiceProviderId/sequences - create provider sequence. 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.invoiceProviderId - Invoice provider id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, invoiceProviderId, data, query = {}, headers}) {
     return client({
       url: `/providers/${invoiceProviderId}/sequences`,
@@ -38,6 +85,17 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence. 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.invoiceProviderId - Invoice provider id
+   * @param {string} opts.invoiceProviderSequenceId - Sequence id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, invoiceProviderId, invoiceProviderSequenceId, data, query = {}, headers}) {
     return client({
       url: `/providers/${invoiceProviderId}/sequences/${invoiceProviderSequenceId}`,

package/src/endpoints/invoices/system.js

@@ -1,6 +1,30 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for POST /system (btrz-api-invoices). See post-system-handler getSpec().
+ * @typedef {Object} InvoiceSystemPostQuery
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ */
+
+/**
+ * Factory for invoice system 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 systemFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /system - create system invoice request.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Request body (SystemPostData)
+   * @param {InvoiceSystemPostQuery} [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: "/system",
@@ -11,6 +35,16 @@ function systemFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /system - validate system 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 (SystemPostData)
+   * @param {InvoiceSystemPostQuery} [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/tax-ids.js

@@ -1,6 +1,32 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /tax-ids (btrz-api-invoices). See tax-ids get-handler getSpec().
+ * @typedef {Object} TaxIdsListQuery
+ * @property {string} taxNumber - Tax number to look up (required)
+ * @property {string} country - ISO code of the country of the tax information (required)
+ * @property {string} [invoiceProviderId] - Invoice provider id (24 hex chars)
+ * @property {string} [documentType] - Tax identification type to check against validation service
+ */
+
+/**
+ * Factory for invoice tax IDs API (btrz-api-invoices).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function taxIdsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /tax-ids - list tax IDs.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {TaxIdsListQuery} opts.query - taxNumber, country; optional invoiceProviderId, documentType
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 400 WRONG_DATA, INVALID_PROVIDER_ID; 404 TAXID_NOT_FOUND
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/tax-ids",