btrz-api-client 8.54.0 → 8.56.0

package/lib/endpoints/accounts/system-model-settings.js

@@ -8,7 +8,7 @@ var _require = require("./../endpoints_helpers.js"),
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, update: function }}
+ * @returns {{ get: function, update: function, validate: function }}
  */
 
 
@@ -66,9 +66,42 @@ function systemModelSettingsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /system-models/:modelName/validations – validate a payload against stored required-field rules.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @param {string} opts.action - Operation context; rules that include this action are enforced against payload.
+   * @param {Object} opts.payload - Payload to validate (e.g. the body you would send to create or update the model).
+   * @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<{ valid: boolean, code?: string, message?: string }>>}
+   */
+  function validate(_ref4) {
+    var jwtToken = _ref4.jwtToken,
+        token = _ref4.token,
+        modelName = _ref4.modelName,
+        action = _ref4.action,
+        payload = _ref4.payload,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/system-models/" + modelName + "/validations",
+      method: "post",
+      headers: authorizationHeaders({
+        token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers
+      }),
+      data: {
+        action: action,
+        payload: payload
+      }
+    });
+  }
+
   return {
     get: get,
-    update: update
+    update: update,
+    validate: validate
   };
 }
 

package/lib/endpoints/inventory/document-types.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
+
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -9,6 +11,12 @@ var _require = require("./../endpoints_helpers.js"),
  * @property {string} [providerIds] - Comma-separated provider IDs to get document types for
  */
 
+/**
+ * Query params for GET /document-types/:documenttypeId (btrz-api-inventory). See get-by-id-handler getSpec().
+ * @typedef {Object} DocumentTypeGetByIdQuery
+ * @property {string} [providerId] - When passed via opts.providerId it is merged here (same pattern as people-lookups / dynamic-forms)
+ */
+
 /**
  * Factory for document-types API (btrz-api-inventory).
  * @param {Object} deps
@@ -53,6 +61,8 @@ function documentTypesFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Document type id (24 hex characters)
+   * @param {DocumentTypeGetByIdQuery} [opts.query] - Optional query params (merged with providerId when opts.providerId is set)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context (same as peopleLookups.getById / dynamicForms.get)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ documenttype: Object }>>}
    * @throws When response is 4xx/5xx (400, 401, 404 DOCUMENTTYPE_NOT_FOUND, 500)
@@ -61,11 +71,16 @@ function documentTypesFactory(_ref) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
         id = _ref3.id,
-        headers = _ref3.headers;
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers,
+        providerId = _ref3.providerId;
 
+    var query_ = providerId ? _extends({}, query, { providerId: providerId }) : query;
     return client({
       url: "/document-types/" + id,
       method: "get",
+      params: query_,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.54.0",
+  "version": "8.56.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/accounts/system-model-settings.js

@@ -7,7 +7,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, update: function }}
+ * @returns {{ get: function, update: function, validate: function }}
  */
 function systemModelSettingsFactory({client, internalAuthTokenProvider}) {
   /**
@@ -49,9 +49,35 @@ function systemModelSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /system-models/:modelName/validations – validate a payload against stored required-field rules.
+   * @param {Object} opts
+   * @param {string} opts.modelName - System model
+   * @param {string} opts.action - Operation context; rules that include this action are enforced against payload.
+   * @param {Object} opts.payload - Payload to validate (e.g. the body you would send to create or update the model).
+   * @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<{ valid: boolean, code?: string, message?: string }>>}
+   */
+  function validate({jwtToken, token, modelName, action, payload, headers}) {
+    return client({
+      url: `/system-models/${modelName}/validations`,
+      method: "post",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      data: {
+        action,
+        payload
+      }
+    });
+  }
+
   return {
     get,
-    update
+    update,
+    validate
   };
 }
 

package/src/endpoints/inventory/document-types.js

@@ -6,6 +6,12 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @property {string} [providerIds] - Comma-separated provider IDs to get document types for
  */
 
+/**
+ * Query params for GET /document-types/:documenttypeId (btrz-api-inventory). See get-by-id-handler getSpec().
+ * @typedef {Object} DocumentTypeGetByIdQuery
+ * @property {string} [providerId] - When passed via opts.providerId it is merged here (same pattern as people-lookups / dynamic-forms)
+ */
+
 /**
  * Factory for document-types API (btrz-api-inventory).
  * @param {Object} deps
@@ -39,14 +45,18 @@ function documentTypesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Document type id (24 hex characters)
+   * @param {DocumentTypeGetByIdQuery} [opts.query] - Optional query params (merged with providerId when opts.providerId is set)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context (same as peopleLookups.getById / dynamicForms.get)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ documenttype: Object }>>}
    * @throws When response is 4xx/5xx (400, 401, 404 DOCUMENTTYPE_NOT_FOUND, 500)
    */
-  function get({token, jwtToken, id, headers}) {
+  function get({token, jwtToken, id, query = {}, headers, providerId}) {
+    const query_ = providerId ? {...query, providerId} : query;
     return client({
       url: `/document-types/${id}`,
       method: "get",
+      params: query_,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });
   }

package/test/endpoints/accounts/system-model-settings.test.js

@@ -34,4 +34,16 @@ describe("accounts/system-model-settings", () => {
       modelName
     });
   });
+
+  it("should post system model validations", () => {
+    const path = `/system-models/${modelName}/validations`;
+    axiosMock.onPost(path).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.systemModelSettings.validate({
+      jwtToken,
+      token,
+      modelName,
+      action: "create",
+      payload: {name: "X"}
+    });
+  });
 });

package/test/endpoints/inventory/document-types.test.js

@@ -37,4 +37,21 @@ describe("inventory/document-types", () => {
     axiosMock.onPut(`/document-types/${documentTypesId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
     return api.inventory.documentTypes.update({jwtToken, token, id: documentTypesId, data});
   });
+
+  it("should get a document-type by id without providerId query", () => {
+    const documentTypesId = "507f1f77bcf86cd799439011";
+    const params = {};
+    axiosMock.onGet(`/document-types/${documentTypesId}`, {params})
+      .reply(expectRequest({statusCode: 200, token, jwtToken, query: params}));
+    return api.inventory.documentTypes.get({token, jwtToken, id: documentTypesId});
+  });
+
+  it("should get a document-type by id with providerId in query params", () => {
+    const documentTypesId = "507f1f77bcf86cd799439011";
+    const providerId = "6750984c6d6aac054165fd9a";
+    const params = {providerId};
+    axiosMock.onGet(`/document-types/${documentTypesId}`, {params})
+      .reply(expectRequest({statusCode: 200, token, jwtToken, query: params}));
+    return api.inventory.documentTypes.get({token, jwtToken, id: documentTypesId, providerId});
+  });
 });