btrz-api-client 8.28.0 → 8.30.0

package/lib/endpoints/accounts/people-lookups.js

@@ -5,10 +5,29 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < argument
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for people-lookups API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, getById: function, update: function, create: function, remove: function }}
+ */
+
+
 function peopleLookupsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /people-lookups - list people lookups.
+   * @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 {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +43,17 @@ function peopleLookupsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /people-lookups/:personId - get a person lookup.
+   * @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 {string} opts.personId - Person id (ObjectId)
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -41,6 +71,17 @@ function peopleLookupsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /people-lookups/:personId - update a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {Object} opts.person - Person payload
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -64,6 +105,16 @@ function peopleLookupsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /people-lookups - create a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.person - Person payload
+   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -86,6 +137,15 @@ function peopleLookupsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /people-lookups/:personId - remove a person lookup.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.personId - Person id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var personId = _ref6.personId,
         token = _ref6.token,

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

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /point-to-point-settings - get point-to-point settings.
+   * @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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function pointToPointSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /point-to-point-settings - update point-to-point settings.
+   * @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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

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

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /print-settings - list/get print settings.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         query = _ref2.query,
@@ -19,6 +36,15 @@ function printSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /print-settings - update print settings.
+   * @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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,

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

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /print-templates - list print templates.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         query = _ref2.query,
@@ -19,6 +36,15 @@ function printSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /print-templates/:printTemplateId - get a print template.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.printTemplateId - Print template id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         query = _ref3.query,
@@ -32,6 +58,17 @@ function printSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /print-templates/:printTemplateId - update a print template.
+   * @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.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -53,6 +90,15 @@ function printSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /print-templates - create a print template.
+   * @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(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -71,6 +117,15 @@ function printSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /print-templates/:printTemplateId - remove a print template.
+   * @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(_ref6) {
     var printTemplateId = _ref6.printTemplateId,
         token = _ref6.token,
@@ -87,6 +142,17 @@ function printSettingsFactory(_ref) {
   }
 
   var versions = {
+    /**
+     * PUT /print-templates/:printTemplateId/versions/:versionId - update a print template 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 - Version id (ObjectId)
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref7) {
       var printTemplateId = _ref7.printTemplateId,
           token = _ref7.token,

package/lib/endpoints/accounts/printers.js

@@ -1,12 +1,29 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /printers - list printers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         query = _ref2.query,

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

@@ -3,10 +3,27 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /rms-settings - get revenue management settings.
+   * @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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -18,6 +35,15 @@ function revenueManagementSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /rms-settings - update revenue management settings.
+   * @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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/accounts/s3buckets.js

@@ -3,10 +3,29 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * PUT /account/s3Buckets/:bucketId - update an S3 bucket.
+   * @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(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -22,6 +41,15 @@ function s3BucketsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket.
+   * @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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function s3BucketsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /account/s3Buckets - create an S3 bucket.
+   * @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(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,

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

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /salesforce-settings - get Salesforce settings.
+   * @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 get(_ref2) {
     var jwtToken = _ref2.jwtToken,
         token = _ref2.token,
@@ -20,6 +38,15 @@ function salesforceSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /salesforce-settings - update Salesforce settings.
+   * @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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,

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

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /shift-settings - get shift settings.
+   * @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 get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +38,15 @@ function shiftSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /shift-settings - update shift settings.
+   * @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(_ref3) {
     var jwtToken = _ref3.jwtToken,
         token = _ref3.token,