@elliemae/pui-scripting-object 1.36.0 → 1.37.0

package/dist/cjs/objects/loan.js

@@ -40,5 +40,6 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";
   LoanLevelActions2["COPY_ITEMIZATION_TO_STATE_DISCLOSURE"] = "copyItemizationToStateDisclosure";
   LoanLevelActions2["CALCULATE_EEM_MORTGAGE"] = "calculateEEMMortgage";
+  LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});

package/dist/esm/objects/loan.js

@@ -15,6 +15,7 @@ var LoanLevelActions = /* @__PURE__ */ ((LoanLevelActions2) => {
   LoanLevelActions2["UPDATE_CORRESPONDENT_FEES"] = "updateCorrespondentFees";
   LoanLevelActions2["COPY_ITEMIZATION_TO_STATE_DISCLOSURE"] = "copyItemizationToStateDisclosure";
   LoanLevelActions2["CALCULATE_EEM_MORTGAGE"] = "calculateEEMMortgage";
+  LoanLevelActions2["COPY_BORROWER_TO_TAX_REQUEST"] = "copyBorrowerToTaxRequest";
   return LoanLevelActions2;
 })(LoanLevelActions || {});
 export {

package/dist/types/lib/objects/loan.d.ts

@@ -97,11 +97,15 @@ export type RecordOptions = {
  * v3 loan object
  */
 export type LoanObject = Record<string, unknown>;
+/**
+ * Loan level actions
+ */
 export declare enum LoanLevelActions {
     UPDATE_CORRESPONDENT_BALANCE = "updateCorrespondentBalance",
     UPDATE_CORRESPONDENT_FEES = "updateCorrespondentFees",
     COPY_ITEMIZATION_TO_STATE_DISCLOSURE = "copyItemizationToStateDisclosure",
-    CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage"
+    CALCULATE_EEM_MORTGAGE = "calculateEEMMortgage",
+    COPY_BORROWER_TO_TAX_REQUEST = "copyBorrowerToTaxRequest"
 }
 type CommitInfo = {
     /**
@@ -352,8 +356,9 @@ export interface ILoan extends IScriptingObject {
     /**
      * Execute loan level action, this is specific to v3 stateful implementation
      * @param type {LoanLevelActions} type of action to be executed
+     * @param params {Record<string, unknown>} additional parameters for the action
      */
-    execAction(type: LoanLevelActions): Promise<LoanObject>;
+    execAction(type: LoanLevelActions, params?: Record<string, unknown>): Promise<LoanObject>;
     /**
      * Returns an object reference of type LoanCollection. Argument "name" is required & used to get specific collection like BorrowerEmployer, Escrow etc.
      * @param name collection template name

package/dist/types/lib/objects/service.d.ts

@@ -56,7 +56,7 @@ export type LaunchCategoryOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
          */
         targetParams?: Record<string, string>;
     };
@@ -102,7 +102,7 @@ export type LaunchServiceSetupOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
          */
         targetParams?: Record<string, string>;
     };
@@ -148,7 +148,7 @@ export type LaunchProviderOptions = {
          */
         targetType: NavigationType;
         /**
-         * additional query parameters to be passed to the redirect location
+         * additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { "key1": "value1", "key2": "value2"}, the url will have querystring as services?query={"transactionId":123, "orderId":456, "key1": "value1", "key2": "value2"}
          */
         targetParams?: Record<string, string>;
     };
@@ -201,7 +201,7 @@ export interface IService extends IScriptingObject {
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?transactionId=123&orderId=456
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
      *
      * Supports EPC & EVP service order integrations
      * @param category - name of the service category
@@ -223,7 +223,7 @@ export interface IService extends IScriptingObject {
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?transactionId=123&orderId=456
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
      *
      * Supports EPC & EVP service order integrations
      * @param serviceSetupId - unique id of the service setup
@@ -245,7 +245,7 @@ export interface IService extends IScriptingObject {
      *
      * After the integration flow is complete, user will be redirected to the location provided in the input parameter.
      *
-     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?transactionId=123&orderId=456
+     * Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url incase of new order. For example, if rediret requested to services area, the url will have querystring as services?query={"transactionId":123, "orderId":456}
      *
      * Supports EPC & EVP service order integrations
      * @param providerId - unique id of the service provider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.36.0",
+  "version": "1.37.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.9.0",
-    "@elliemae/pui-cli": "~8.33.0",
+    "@elliemae/pui-cli": "~8.34.0",
     "@elliemae/pui-doc-gen": "~2.0.1",
     "@elliemae/pui-theme": "~2.9.3",
     "@types/styled-components": "~5.1.34",