@elliemae/pui-scripting-object 1.34.2 → 1.34.4

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

@@ -41,8 +41,10 @@ export type LaunchCategoryOptions = {
      */
     source: string;
     /**
-     * url to redirect to after the service order integration flow is complete
+     * url to redirect to after the service order integration flow is complete.
+     *
      * url should be relative to the current loan context.
+     *
      * For example to redirect to service landing page that has absolute url as https://encompass.ice.com/pipeline/loan/d4ef4c0a-5456-4e72-bf94-269eb2ccde18/services, the redirect url should be services
      */
     redirectUrl: string;
@@ -74,8 +76,10 @@ export type LaunchServiceSetupOptions = {
      */
     source: string;
     /**
-     * url to redirect to after the service order integration flow is complete
+     * url to redirect to after the service order integration flow is complete.
+     *
      * url should be relative to the current loan context.
+     *
      * For example to redirect to service landing page that has absolute url as https://encompass.ice.com/pipeline/loan/d4ef4c0a-5456-4e72-bf94-269eb2ccde18/services, the redirect url should be services
      */
     redirectUrl: string;
@@ -119,8 +123,10 @@ export type LaunchProviderOptions = {
      */
     source: string;
     /**
-     * url to redirect to after the service order integration flow is complete
+     * url to redirect to after the service order integration flow is complete.
+     *
      * url should be relative to the current loan context.
+     *
      * For example to redirect to service landing page that has absolute url as https://encompass.ice.com/pipeline/loan/d4ef4c0a-5456-4e72-bf94-269eb2ccde18/services, the redirect url should be services
      */
     redirectUrl: string;
@@ -157,7 +163,7 @@ export type LaunchProviderOptions = {
  * #### Product Compatibility:
  * | | Encompass | Encompass Web | TPO | Consumer Connect |
  * :-----:|:-----: |:-----: |:-----: |:-----: |
- * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+ * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
  */
 export interface IService extends IScriptingObject {
     /**
@@ -169,14 +175,20 @@ export interface IService extends IScriptingObject {
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
     getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
     /**
-     * launch a service intergration for a specific category to place a new service order or view existing order
+     * Launch a service intergration for a specific category to place a new service order or view existing order.
+     *
+     * Commit all unsaved loan changes using loan.commit, before calling this method.
+     *
      * This method will unload the current microapp and navigate to the service order integration
-     * after the integration flow is complete, user will be redirected back to the url provided in the options.
-     * redirect url will be appended with query parameters containing the service order transaction id and service order id incase of new order
+     *
+     * After the integration flow is complete, user will be redirected back to the url provided in the options.
+     *
+     * Service order transaction id and service order id will be appended as query parameters to the redirect url incase of new order
+     *
      * Supports EPC & EVP service order integrations
      * @param category - name of the service category
      * @param {LaunchCategoryOptions} options - options for launching the service order integration
@@ -185,14 +197,20 @@ export interface IService extends IScriptingObject {
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
     launchByCategory: (category: string, options: LaunchCategoryOptions) => Promise<void>;
     /**
-     * launch a service intergration for a specific service setup to place a new service order or view existing order
-     * This method will unload the current microapp and navigate to the service order integration
-     * after the integration flow is complete, user will be redirected back to the url provided in the options.
-     * redirect url will be appended with query parameters containing the service order transaction id and service order id incase of new order
+     * Launch a service intergration for a specific service setup to place a new service order or view existing order.
+     *
+     * Commit all unsaved loan changes using loan.commit, before calling this method.
+     *
+     * This method will unload the current microapp and navigate to the service order integration.
+     *
+     * After the integration flow is complete, user will be redirected back to the url provided in the options.
+     *
+     * Service order transaction id and service order id will be appended as query parameters to the redirect url incase of new order
+     *
      * Supports EPC & EVP service order integrations
      * @param serviceSetupId - unique id of the service setup
      * @param {LaunchServiceSetupOptions} options - options for launching the service order integration
@@ -201,14 +219,20 @@ export interface IService extends IScriptingObject {
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
-     * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
+     * | all |  ✖️ |  ✔ |  ✖️ |  ✖️ |
      */
     launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
     /**
-     * launch a service intergration for a specific provider to place a new service order or view existing order
+     * Launch a service intergration for a specific provider to place a new service order or view existing order
+     *
+     * Commit all unsaved loan changes using loan.commit, before calling this method.
+     *
      * This method will unload the current microapp and navigate to the service order integration
-     * after the integration flow is complete, user will be redirected back to the url provided in the options.
-     * redirect url will be appended with query parameters containing the service order transaction id and service order id incase of new order
+     *
+     * After the integration flow is complete, user will be redirected back to the url provided in the options.
+     *
+     * Service order transaction id and service order id will be appended as query parameters to the redirect url incase of new order
+     *
      * Supports EPC & EVP service order integrations
      * @param providerId - unique id of the service provider
      * @param {LaunchProviderOptions} options - options for launching the service order integration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.34.2",
+  "version": "1.34.4",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "type": "module",