btrz-api-client 8.29.0 → 8.30.0

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). onlyValidateRequest optional.
+ * @typedef {Object} InvoiceInfileJsonPostQuery
+ * @property {string} [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,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for invoices endpoints (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoicesQuery
+ */
+
+/**
+ * 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 {InvoicesQuery} [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: "/invoices",
@@ -10,6 +32,16 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /invoices/:id - get invoice by id.
+   * @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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +51,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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getInvoicesFailures({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/failures",
@@ -28,6 +69,16 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /retry - retry invoicing.
+   * @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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function retryInvoicing({token, jwtToken, data, query = {}, headers}) {
     return client({
       url: "/retry",
@@ -38,6 +89,16 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /retry - override buyer and retry invoicing.
+   * @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 {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /pdfs (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoicePdfsListQuery
+ */
+
+/**
+ * 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 {InvoicePdfsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for invoice providers endpoints (btrz-api-invoices). Forwarded to API as-is.
+ * @typedef {Object} InvoiceProvidersQuery
+ */
+
+/**
+ * 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 {InvoiceProvidersQuery} [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: "/providers",
@@ -10,6 +32,16 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /providers/:id - get invoice provider by id.
+   * @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 {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +51,17 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /providers/:id - update invoice provider.
+   * @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 {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +72,16 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /providers/:id - remove invoice provider.
+   * @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 {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +91,16 @@ function providersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /providers - create invoice provider.
+   * @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 {InvoiceProvidersQuery} [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: "/providers",

package/src/endpoints/invoices/providersSequences.js

@@ -1,6 +1,29 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for provider sequences endpoints (btrz-api-invoices). Backend getSpec for list has no query; forwarded as-is.
+ * @typedef {Object} InvoiceProvidersSequencesQuery
+ */
+
+/**
+ * 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.
+   * @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 {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +33,17 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence.
+   * @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 {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +53,17 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence.
+   * @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 {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +73,17 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /providers/:invoiceProviderId/sequences - create provider sequence.
+   * @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 {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 +94,18 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence.
+   * @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 {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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 getSpec).
+ * @typedef {Object} InvoiceSystemPostQuery
+ * @property {string} [onlyValidateRequest] - If set to 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 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",

package/src/endpoints/loyalty/movements.js

@@ -1,7 +1,32 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function movementsFactory({ client, internalAuthTokenProvider }) {
-  function all({ token, jwtToken, programId, query = {}, headers }) {
+/**
+ * Query params for GET /programs/:programId/movements and related (loyalty). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} LoyaltyMovementsQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for loyalty movements API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, balance: Object }}
+ */
+function movementsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /programs/:programId/movements - list movements.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, programId, query = {}, headers}) {
     return client({
       url: `/programs/${programId}/movements`,
       params: query,
@@ -9,7 +34,18 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function create({ token, jwtToken, programId, movement, query = {}, headers }) {
+  /**
+   * POST /programs/:programId/movements - create movement.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {Object} opts.movement - Movement payload
+   * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, programId, movement, query = {}, headers}) {
     return client({
       url: `/programs/${programId}/movements`,
       method: "post",
@@ -20,7 +56,18 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
   }
 
   const balance = {
-    get({ token, jwtToken, programId, customerId, query = {}, headers }) {
+    /**
+     * GET /programs/:programId/movements/balance/:customerId - get balance.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.programId - Program id
+     * @param {string} opts.customerId - Customer id
+     * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    get({token, jwtToken, programId, customerId, query = {}, headers}) {
       return client({
         url: `/programs/${programId}/movements/balance/${customerId}`,
         params: query,
@@ -34,7 +81,6 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
     create,
     balance
   };
-
 }
 
 module.exports = movementsFactory;

package/src/endpoints/loyalty/programs.js

@@ -1,10 +1,32 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function programsFactory({ client, internalAuthTokenProvider }) {
-  
-  function all({ token, context, query = {}, headers }) {
+/**
+ * Query params for GET /programs (loyalty). Client merges context into query.
+ * @typedef {Object} LoyaltyProgramsListQuery
+ * @property {string} [context] - Context (merged from opts.context by client)
+ * @property {string} [providerId] - Provider id (if supported by backend)
+ */
+
+/**
+ * Factory for loyalty programs API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, put: function }}
+ */
+function programsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /programs - list loyalty programs. Query is merged with context (context takes precedence in merge).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.context] - Context; merged into query as query.context
+   * @param {LoyaltyProgramsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, context, query = {}, headers}) {
     const queryObj = Object.assign({}, query, {context});
-    
+
     return client({
       url: "/programs",
       params: queryObj,
@@ -12,7 +34,16 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function create({ token, jwtToken, program, headers }) {
+  /**
+   * POST /programs - create loyalty program.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.program - Program payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, program, headers}) {
     return client({
       url: "/programs",
       method: "post",
@@ -21,7 +52,17 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function put({ token, jwtToken, programId, program, headers }) {
+  /**
+   * PUT /programs/:programId - update loyalty program.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {Object} opts.program - Program payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function put({token, jwtToken, programId, program, headers}) {
     return client({
       url: `/programs/${programId}`,
       method: "put",
@@ -35,7 +76,6 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     create,
     put
   };
-
 }
 
-module.exports = programsFactory;
+module.exports = programsFactory;

package/src/endpoints/notifications/customers.js

@@ -1,10 +1,31 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} NotificationsCustomersQuery
+ */
+
+/**
+ * Factory for customers notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ sendResetPasswordEmail: function, sendActivationEmail: function }}
+ */
 function customersFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * POST /customers/reset - send reset password email to customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function sendResetPasswordEmail({
     token, jwtToken, query = {}, headers
   }) {
@@ -16,6 +37,15 @@ function customersFactory({
     });
   }
 
+  /**
+   * POST /customers/activation - send activation email to customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.data] - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function sendActivationEmail({
     token, query = {}, data, headers
   }) {