btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/accounts/point-to-point-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Factory for point-to-point-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /point-to-point-settings - get point-to-point settings. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/point-to-point-settings",
@@ -10,6 +25,15 @@ function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /point-to-point-settings - update point-to-point settings. 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.pointToPointSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, pointToPointSettings, headers}) {
     return client({
       url: "/point-to-point-settings",

package/src/endpoints/accounts/print-settings.js

@@ -1,8 +1,22 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for print-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, update: function }}
+ */
 function printSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /print-settings - list/get print settings. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query, headers}) {
     return client({
       url: "/print-settings",
@@ -11,6 +25,15 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /print-settings - update print settings. 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.printSettings - Print settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, printSettings, headers}) {
     return client({
       url: "/print-settings",

package/src/endpoints/accounts/print-templates.js

@@ -1,8 +1,55 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /print-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} PrintTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by type (product, ssr, transaction, invoice, shift, manifest, order, voucher, etc.)
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [format] - default | esc
+ * @property {string} [productFamily] - Only when type is product or invoice
+ * @property {string} [productId] - Only when type is product or invoice (ObjectId)
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [status] - draft | published
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Query params for GET /print-templates/:printTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PrintTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current, or global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Query params for PUT /print-templates/:printTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} PrintTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Factory for print-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, create: function, remove: function, versions: { update: function } }}
+ */
 function printSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /print-templates - list print templates.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {PrintTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, consumer, format, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query, headers}) {
     return client({
       url: "/print-templates",
@@ -11,6 +58,15 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /print-templates/:printTemplateId - get a print template.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.printTemplateId - Print template id (ObjectId)
+   * @param {PrintTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, query, headers, printTemplateId}) {
     return client({
       url: `/print-templates/${printTemplateId}`,
@@ -19,6 +75,16 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /print-templates/:printTemplateId - update a print template. API getSpec() does not define query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.printTemplateId - Print template id (ObjectId)
+   * @param {Object} opts.printTemplate - Print template payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, printTemplateId, printTemplate, headers, query}) {
     return client({
       url: `/print-templates/${printTemplateId}`,
@@ -33,6 +99,15 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /print-templates - create a print template. 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.printTemplate - Print template payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, printTemplate, headers}) {
     return client({
       url: "/print-templates",
@@ -46,6 +121,15 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /print-templates/:printTemplateId - remove a print template. 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.printTemplateId - Print template id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({printTemplateId, token, jwtToken, headers}) {
     return client({
       url: `/print-templates/${printTemplateId}`,
@@ -57,12 +141,23 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   const versions = {
+    /**
+     * PUT /print-templates/:printTemplateId/versions/:versionId - roll back print template to a version.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.printTemplateId - Print template id (ObjectId)
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {PrintTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({printTemplateId, token, jwtToken, headers, query, versionId}) {
       return client({
-        url: "/print-templates/" + printTemplateId + "/versions/" + versionId,
+        url: `/print-templates/${printTemplateId}/versions/${versionId}`,
         method: "put",
         headers: authorizationHeaders({
-          token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+          token, jwtToken, internalAuthTokenProvider, headers
         }),
         params: query
       });

package/src/endpoints/accounts/printers.js

@@ -1,8 +1,22 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for printers API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
 function printersFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /printers - list printers. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query, headers}) {
     return client({
       url: "/printers",

package/src/endpoints/accounts/rms-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for rms-settings (revenue management) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function revenueManagementSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /rms-settings - get revenue management settings. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, headers}) {
     return client({
       url: "/rms-settings",
@@ -10,6 +25,15 @@ function revenueManagementSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /rms-settings - update revenue management settings. 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.revenueManagementSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, revenueManagementSettings, headers}) {
     return client({
       url: "/rms-settings",

package/src/endpoints/accounts/s3buckets.js

@@ -1,6 +1,23 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for s3Buckets (account) API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ update: function, remove: function, create: function }}
+ */
 function s3BucketsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * PUT /account/s3Buckets/:bucketId - update an S3 bucket. 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.bucketId - Bucket id (ObjectId)
+   * @param {Object} opts.s3BucketData - Bucket payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, bucketId, s3BucketData, headers}) {
     return client({
       url: `/account/s3Buckets/${bucketId}`,
@@ -10,6 +27,15 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket. 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.bucketId - Bucket id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, token, bucketId, headers}) {
     return client({
       url: `/account/s3Buckets/${bucketId}`,
@@ -18,6 +44,15 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /account/s3Buckets - create an S3 bucket. 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.s3BucketData - Bucket payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, s3BucketData, headers}) {
     return client({
       url: "/account/s3Buckets",

package/src/endpoints/accounts/salesforce-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for salesforce-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function salesforceSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /salesforce-settings - get Salesforce settings. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({jwtToken, token, query, headers}) {
     return client({
       url: "/salesforce-settings",
@@ -11,6 +26,15 @@ function salesforceSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /salesforce-settings - update Salesforce settings. 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.salesforceSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, salesforceSettings, headers}) {
     return client({
       url: "/salesforce-settings",

package/src/endpoints/accounts/shift-settings.js

@@ -2,7 +2,22 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for shift-settings API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, update: function }}
+ */
 function shiftSettingsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /shift-settings - get shift settings. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, query, headers}) {
     return client({
       url: "/shift-settings",
@@ -11,6 +26,15 @@ function shiftSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /shift-settings - update shift settings. 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.shiftSettings - Settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, shiftSettings, headers}) {
     return client({
       url: "/shift-settings",