btrz-api-client 8.69.0 → 8.70.0

package/lib/endpoints/accounts/dynamic-forms.js

@@ -20,6 +20,14 @@ var _require = require("../endpoints_helpers.js"),
  * @property {string} [providerId] - Fetch the dynamic form for the given providerId (ObjectId)
  */
 
+/**
+ * Query params for GET /renderable-dynamic-forms/:dynamicFormId (btrz-api-accounts).
+ * @typedef {Object} RenderableDynamicFormByIdQuery
+ * @property {string} [providerId] - Fetch under provider context (ObjectId)
+ * @property {string} [currentLanguage] - Language code used for translated values
+ * @property {string} [documentTypeIds] - Comma-separated document type ids for filtering
+ */
+
 /**
  * Factory for dynamic-forms API (btrz-api-accounts).
  * @param {Object} deps
@@ -62,45 +70,73 @@ function dynamicFormsFactory(_ref) {
   }
 
   /**
-   * GET /dynamic-forms - list dynamic forms.
+   * GET /renderable-dynamic-forms/:dynamicFormId - get renderable dynamic form context.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {DynamicFormsQuery} [opts.query] - Query params (dynamicFormFieldId, providerId, type)
+   * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
+   * @param {RenderableDynamicFormByIdQuery} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function all(_ref3) {
+  function getRenderable(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
+        dynamicFormId = _ref3.dynamicFormId,
         _ref3$query = _ref3.query,
         query = _ref3$query === undefined ? {} : _ref3$query,
-        headers = _ref3.headers;
+        headers = _ref3.headers,
+        providerId = _ref3.providerId;
 
+    var query_ = providerId ? _extends({}, query, { providerId: providerId }) : query;
     return client({
-      url: "/dynamic-forms",
-      params: query,
+      url: "/renderable-dynamic-forms/" + dynamicFormId,
+      params: query_,
       headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * POST /dynamic-forms - create a dynamic form.
+   * GET /dynamic-forms - list dynamic forms.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.data - Form payload
+   * @param {DynamicFormsQuery} [opts.query] - Query params (dynamicFormFieldId, providerId, type)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function create(_ref4) {
+  function all(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
         _ref4$query = _ref4.query,
         query = _ref4$query === undefined ? {} : _ref4$query,
-        data = _ref4.data,
         headers = _ref4.headers;
 
+    return client({
+      url: "/dynamic-forms",
+      params: query,
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /dynamic-forms - create a dynamic form.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Form payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        _ref5$query = _ref5.query,
+        query = _ref5$query === undefined ? {} : _ref5$query,
+        data = _ref5.data,
+        headers = _ref5.headers;
+
     return client({
       url: "/dynamic-forms",
       method: "post",
@@ -120,12 +156,12 @@ function dynamicFormsFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function update(_ref5) {
-    var token = _ref5.token,
-        jwtToken = _ref5.jwtToken,
-        dynamicFormId = _ref5.dynamicFormId,
-        data = _ref5.data,
-        headers = _ref5.headers;
+  function update(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        dynamicFormId = _ref6.dynamicFormId,
+        data = _ref6.data,
+        headers = _ref6.headers;
 
     return client({
       url: "/dynamic-forms/" + dynamicFormId,
@@ -144,11 +180,11 @@ function dynamicFormsFactory(_ref) {
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-  function remove(_ref6) {
-    var dynamicFormId = _ref6.dynamicFormId,
-        token = _ref6.token,
-        jwtToken = _ref6.jwtToken,
-        headers = _ref6.headers;
+  function remove(_ref7) {
+    var dynamicFormId = _ref7.dynamicFormId,
+        token = _ref7.token,
+        jwtToken = _ref7.jwtToken,
+        headers = _ref7.headers;
 
     return client({
       url: "/dynamic-forms/" + dynamicFormId,
@@ -168,11 +204,11 @@ function dynamicFormsFactory(_ref) {
      * @returns {Promise<import("axios").AxiosResponse>}
      */
     get: function get() {
-      var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-          token = _ref7.token,
-          jwtToken = _ref7.jwtToken,
-          dynamicFormFieldId = _ref7.dynamicFormFieldId,
-          headers = _ref7.headers;
+      var _ref8 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+          token = _ref8.token,
+          jwtToken = _ref8.jwtToken,
+          dynamicFormFieldId = _ref8.dynamicFormFieldId,
+          headers = _ref8.headers;
 
       return client({
         url: "/dynamic-forms/fields/" + dynamicFormFieldId,
@@ -188,12 +224,12 @@ function dynamicFormsFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    all: function all(_ref8) {
-      var token = _ref8.token,
-          jwtToken = _ref8.jwtToken,
-          _ref8$query = _ref8.query,
-          query = _ref8$query === undefined ? {} : _ref8$query,
-          headers = _ref8.headers;
+    all: function all(_ref9) {
+      var token = _ref9.token,
+          jwtToken = _ref9.jwtToken,
+          _ref9$query = _ref9.query,
+          query = _ref9$query === undefined ? {} : _ref9$query,
+          headers = _ref9.headers;
 
       return client({
         url: "/dynamic-forms/fields",
@@ -211,11 +247,11 @@ function dynamicFormsFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    create: function create(_ref9) {
-      var jwtToken = _ref9.jwtToken,
-          token = _ref9.token,
-          data = _ref9.data,
-          headers = _ref9.headers;
+    create: function create(_ref10) {
+      var jwtToken = _ref10.jwtToken,
+          token = _ref10.token,
+          data = _ref10.data,
+          headers = _ref10.headers;
 
       return client({
         url: "/dynamic-forms/fields",
@@ -235,12 +271,12 @@ function dynamicFormsFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    update: function update(_ref10) {
-      var jwtToken = _ref10.jwtToken,
-          token = _ref10.token,
-          dynamicFormFieldId = _ref10.dynamicFormFieldId,
-          data = _ref10.data,
-          headers = _ref10.headers;
+    update: function update(_ref11) {
+      var jwtToken = _ref11.jwtToken,
+          token = _ref11.token,
+          dynamicFormFieldId = _ref11.dynamicFormFieldId,
+          data = _ref11.data,
+          headers = _ref11.headers;
 
       return client({
         url: "/dynamic-forms/fields/" + dynamicFormFieldId,
@@ -259,11 +295,11 @@ function dynamicFormsFactory(_ref) {
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
-    remove: function remove(_ref11) {
-      var dynamicFormFieldId = _ref11.dynamicFormFieldId,
-          token = _ref11.token,
-          jwtToken = _ref11.jwtToken,
-          headers = _ref11.headers;
+    remove: function remove(_ref12) {
+      var dynamicFormFieldId = _ref12.dynamicFormFieldId,
+          token = _ref12.token,
+          jwtToken = _ref12.jwtToken,
+          headers = _ref12.headers;
 
       return client({
         url: "/dynamic-forms/fields/" + dynamicFormFieldId,
@@ -275,6 +311,7 @@ function dynamicFormsFactory(_ref) {
 
   return {
     get: get,
+    getRenderable: getRenderable,
     all: all,
     create: create,
     update: update,

package/package.json

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

package/src/endpoints/accounts/dynamic-forms.js

@@ -15,6 +15,14 @@ const {authorizationHeaders} = require("../endpoints_helpers.js");
  * @property {string} [providerId] - Fetch the dynamic form for the given providerId (ObjectId)
  */
 
+/**
+ * Query params for GET /renderable-dynamic-forms/:dynamicFormId (btrz-api-accounts).
+ * @typedef {Object} RenderableDynamicFormByIdQuery
+ * @property {string} [providerId] - Fetch under provider context (ObjectId)
+ * @property {string} [currentLanguage] - Language code used for translated values
+ * @property {string} [documentTypeIds] - Comma-separated document type ids for filtering
+ */
+
 /**
  * Factory for dynamic-forms API (btrz-api-accounts).
  * @param {Object} deps
@@ -43,6 +51,26 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /renderable-dynamic-forms/:dynamicFormId - get renderable dynamic form context.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
+   * @param {RenderableDynamicFormByIdQuery} [opts.query] - Query params
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getRenderable({token, jwtToken, dynamicFormId, query = {}, headers, providerId}) {
+    const query_ = providerId ? {...query, providerId} : query;
+    return client({
+      url: `/renderable-dynamic-forms/${dynamicFormId}`,
+      params: query_,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   /**
    * GET /dynamic-forms - list dynamic forms.
    * @param {Object} opts
@@ -201,6 +229,7 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
 
   return {
     get,
+    getRenderable,
     all,
     create,
     update,

package/test/endpoints/accounts/dynamic-forms.test.js

@@ -27,6 +27,20 @@ describe("accounts/dynamic-forms/", () => {
     return api.accounts.dynamicForms.get({token, jwtToken, dynamicFormId});
   });
 
+  it("should GET the renderable dynamic form context", () => {
+    const dynamicFormId = "123";
+    const query = {currentLanguage: "es", documentTypeIds: "id-1,id-2", providerId: "provider-1"};
+    axiosMock.onGet(`/renderable-dynamic-forms/${dynamicFormId}`)
+      .reply(expectRequest({statusCode: 200, token, query}));
+    return api.accounts.dynamicForms.getRenderable({
+      token,
+      jwtToken,
+      dynamicFormId,
+      query: {currentLanguage: "es", documentTypeIds: "id-1,id-2"},
+      providerId: "provider-1"
+    });
+  });
+
   it("should create dynamic form", () => {
     const data = {};
     axiosMock.onPost("/dynamic-forms").reply(expectRequest({statusCode: 200, token, jwtToken, body: data}));

package/types/endpoints/accounts/dynamic-forms.d.ts

@@ -4,7 +4,7 @@ export = dynamicFormsFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ get: function, all: function, create: function, update: function, remove: function, fields: { get: function, all: function, create: function, update: function, remove: function } }}
+ * @returns {{ get: function, getRenderable: function, all: function, create: function, update: function, remove: function, fields: { get: function, all: function, create: function, update: function, remove: function } }}
  */
 declare function dynamicFormsFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -13,6 +13,7 @@ declare function dynamicFormsFactory({ client, internalAuthTokenProvider }: {
     };
 }): {
     get: Function;
+    getRenderable: Function;
     all: Function;
     create: Function;
     update: Function;