btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/inventory/operation-reasons.js

@@ -3,10 +3,28 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for operation-reasons API (btrz-api-inventory).
+ * @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 operationReasonFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /operation-reasons - list operation reasons.
+   * @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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +40,16 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * GET /operation-reasons/:id - get operation reason by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +66,17 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /operation-reasons/:id - update operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason id
+   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -56,6 +95,16 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /operation-reasons/:id - remove operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operation reason id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -72,6 +121,16 @@ function operationReasonFactory(_ref) {
     });
   }
 
+  /**
+   * POST /operation-reasons - create operation reason.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.operationReason - Operation reason payload
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/parcel-zones.js

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for parcel-zones endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventoryParcelZonesQuery
+ */
+
+/**
+ * Factory for parcel-zones API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function }}
+ */
+
+
 function parcelZonesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /parcel-zones - list parcel zones.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventoryParcelZonesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,15 @@ function parcelZonesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /parcel-zones - create parcel zone.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.parcelZone - Parcel zone payload
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         parcelZone = _ref3.parcelZone,
@@ -34,6 +64,16 @@ function parcelZonesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /parcel-zone/:parcelZoneId - update parcel zone.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.parcelZoneId - Parcel zone id
+   * @param {Object} opts.parcelZone - Parcel zone payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,

package/lib/endpoints/inventory/pay-on-accounts.js

@@ -3,10 +3,34 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} PayOnAccountsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for pay-on-accounts API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function payOnAccountsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /pay-on-accounts - list pay-on accounts.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PayOnAccountsQuery} [opts.query] - Query params
+   * @param {string} [opts.responseType] - Response type (e.g. json)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

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

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

@@ -3,10 +3,33 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +43,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var prismaTerminalId = _ref3.prismaTerminalId,
         token = _ref3.token,
@@ -31,6 +63,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +88,15 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         prismaTerminalId = _ref5.prismaTerminalId,
@@ -60,6 +110,16 @@ function prismaTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/products.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +38,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var productId = _ref3.productId,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +86,16 @@ function productsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var productId = _ref5.productId,
         data = _ref5.data,
@@ -64,7 +111,17 @@ function productsFactory(_ref) {
     });
   }
 
+  /** @type {{ remove: function }} */
   var 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: function remove(_ref6) {
       var token = _ref6.token,
           jwtToken = _ref6.jwtToken,
@@ -79,7 +136,17 @@ function productsFactory(_ref) {
     }
   };
 
+  /** @type {{ all: function }} */
   var 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: function all(_ref7) {
       var token = _ref7.token,
           _ref7$query = _ref7.query,

package/lib/endpoints/inventory/promos.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +43,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var promoId = _ref3.promoId,
         token = _ref3.token,
@@ -32,6 +66,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         promo = _ref4.promo,
@@ -46,6 +89,15 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         promoId = _ref5.promoId,
@@ -59,6 +111,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,
@@ -74,6 +137,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref7) {
     var jwtToken = _ref7.jwtToken,
         token = _ref7.token,
@@ -89,6 +162,16 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var jwtToken = _ref8.jwtToken,
         token = _ref8.token,
@@ -104,6 +187,17 @@ function promosFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref9) {
     var jwtToken = _ref9.jwtToken,
         token = _ref9.token,