btrz-api-client 8.28.0 → 8.30.0

package/src/endpoints/inventory/payment-terminals.js

@@ -1,9 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
-function paymentTerminalFactory({client, internalAuthTokenProvider}) {
+/**
+ * Query params for payment-terminals endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryPaymentTerminalsQuery
+ */
 
+/**
+ * Factory for payment-terminals 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 paymentTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /payment-terminals - list payment terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryPaymentTerminalsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},
@@ -15,13 +34,30 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /payment-terminals/:paymentTerminalId - get payment terminal by id.
+   * @param {Object} opts
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({paymentTerminalId, token, headers}) {
     return client.get(`/payment-terminals/${paymentTerminalId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
-  function create({ jwtToken, token, paymentTerminal, headers }) {
+  /**
+   * POST /payment-terminals - create payment terminal.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({jwtToken, token, paymentTerminal, headers}) {
     return client({
       url: "/payment-terminals",
       method: "post",
@@ -32,7 +68,16 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
-  function remove({ jwtToken, paymentTerminalId, token, headers }) {
+  /**
+   * DELETE /payment-terminals/:paymentTerminalId - remove payment terminal.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({jwtToken, paymentTerminalId, token, headers}) {
     return client({
       url: `/payment-terminals/${paymentTerminalId}`,
       method: "delete",
@@ -40,6 +85,16 @@ function paymentTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /payment-terminals/:paymentTerminalId - update payment terminal.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.paymentTerminalId - Payment terminal id
+   * @param {Object} opts.paymentTerminal - Payment terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, paymentTerminalId, paymentTerminal, headers}) {
     return client({
       url: `/payment-terminals/${paymentTerminalId}`,

package/src/endpoints/inventory/prisma-terminals.js

@@ -2,7 +2,28 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} InventoryPrismaTerminalsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for prisma-terminals 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 prismaTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /prisma-terminals - list prisma terminals.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryPrismaTerminalsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     jwtToken,
@@ -15,12 +36,30 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /prisma-terminals/:prismaTerminalId - get prisma terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({prismaTerminalId, token, jwtToken, headers}) {
     return client.get(`/prisma-terminals/${prismaTerminalId}`, {
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /prisma-terminals - create prisma terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, prismaTerminal, headers}) {
     return client({
       url: "/prisma-terminals",
@@ -32,6 +71,15 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /prisma-terminals/:prismaTerminalId - remove prisma terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, prismaTerminalId, token, headers}) {
     return client({
       url: `/prisma-terminals/${prismaTerminalId}`,
@@ -40,6 +88,16 @@ function prismaTerminalFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /prisma-terminals/:prismaTerminalId - update prisma terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.prismaTerminalId - Prisma terminal id
+   * @param {Object} opts.prismaTerminal - Prisma terminal payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, prismaTerminalId, prismaTerminal, headers}) {
     return client({
       url: `/prisma-terminals/${prismaTerminalId}`,

package/src/endpoints/inventory/products.js

@@ -1,6 +1,22 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for products 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, families: object, domains: object }}
+ */
 function productsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /products - list products.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client({
       url: "/products",
@@ -9,6 +25,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /products/:productId - get product by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({productId, token, jwtToken, query = {}, headers}) {
     return client({
       url: `/products/${productId}`,
@@ -17,6 +43,15 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /products - create product.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({data, token, jwtToken, headers}) {
     return client({
       url: "/products",
@@ -26,6 +61,16 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /products/:productId - update product.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {Object} opts.data - Product payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({productId, data, token, jwtToken, headers}) {
     return client({
       url: `/products/${productId}`,
@@ -35,7 +80,17 @@ function productsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ remove: function }} */
   const domains = {
+    /**
+     * DELETE /products/domains/:domain - remove product domain.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.domain - Domain
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove: ({token, jwtToken, domain, headers}) => {
       return client({
         url: `/products/domains/${domain}`,
@@ -45,7 +100,17 @@ function productsFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ all: function }} */
   const families = {
+    /**
+     * GET /products/families - list product families.
+     * @param {Object} opts
+     * @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>}
+     */
     all: ({token, query = {}, headers}) => {
       return client({
         url: "/products/families",

package/src/endpoints/inventory/promos.js

@@ -1,6 +1,28 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for promos endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryPromosQuery
+ */
+
+/**
+ * Factory for promos 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, patch: function, remove: function, addRule: function, updateRule: function }}
+ */
 function promosFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /promos - list promos.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/promos", {
       params: query,
@@ -8,6 +30,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /promos/:promoId - get promo by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({promoId, token, query = {}, headers}) {
     return client.get(`/promos/${promoId}`, {
       params: query,
@@ -15,6 +47,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /promos - create promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.promo - Promo payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, promo, token, headers}) {
     return client({
       url: "/promos",
@@ -24,6 +65,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /promos/:promoId - remove promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, promoId, token, headers}) {
     return client({
       url: `/promos/${promoId}`,
@@ -32,6 +82,17 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /promos/:promoId - update promo.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow
   function update({jwtToken, token, promoId, update, headers}) {
     return client({
       url: `/promos/${promoId}`,
@@ -41,6 +102,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /promo/:promoId - patch promo with operations.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.operations - Patch operations
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch({jwtToken, token, promoId, operations, headers}) {
     return client({
       url: `/promo/${promoId}`,
@@ -50,6 +121,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /promos/:promoId/rules - add promo rule.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addRule({jwtToken, token, promoId, rule, headers}) {
     return client({
       url: `/promos/${promoId}/rules`,
@@ -59,6 +140,17 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /promos/:promoId/rules/:ruleId - update promo rule.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.promoId - Promo id
+   * @param {string} opts.ruleId - Rule id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateRule({jwtToken, token, promoId, ruleId, rule, headers}) {
     return client({
       url: `/promos/${promoId}/rules/${ruleId}`,