@elliemae/pui-scripting-object 1.24.1 → 1.26.0

package/dist/types/objects/application.d.ts

@@ -242,5 +242,11 @@ export interface IApplication extends IScriptingObject {
      * @param logLevel level of the log message
      */
     log(message: string, logLevel: LogLevel): Promise<void>;
+    /**
+     * get company settings for a particular category
+     * @param category category name
+     * @returns company settings as key value pairs. Null if category is not found
+     */
+    getCompanySettings(category: string): Promise<Record<string, any> | null>;
 }
 export {};

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

@@ -31,15 +31,50 @@ export type ServiceSetup = {
     category: ServiceSetupCategory;
 };
 /**
- * options to launch service order integration
+ * options to launch service order integration by category
  */
-export type LaunchOptions = {
+export type LaunchCategoryOptions = {
     /**
      * source application context that is launching the service order integration
      * urn patterned string
      * example: urn:elli:services:getpricing
      */
     source: string;
+    /**
+     * url to redirect to after the service order integration flow is complete
+     */
+    redirectUrl: string;
+    /**
+     * unique id of the existing service order transaction
+     */
+    transactionId?: string;
+    /**
+     * unique id of the existing service order
+     */
+    serviceOrderId?: string;
+    /**
+     * settings to be passed to the service order integration
+     */
+    settings?: any;
+    /**
+     * additional data needed for the service order integration
+     */
+    additionalData?: any;
+};
+/**
+ * options to launch service order integration by specific service setup
+ */
+export type LaunchServiceSetupOptions = {
+    /**
+     * source application context that is launching the service order integration
+     * urn patterned string
+     * example: urn:elli:services:getpricing
+     */
+    source: string;
+    /**
+     * url to redirect to after the service order integration flow is complete
+     */
+    redirectUrl: string;
     /**
      * unique id of the partner
      */
@@ -93,22 +128,27 @@ export interface IService extends IScriptingObject {
      */
     getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
     /**
-     * select a service setup from the list of eligible service setups
-     * @param {ServiceSetupCategory} category - service setup category
-     * @param providerId - unique id of the service setup provider
-     * @returns {ServiceSetup} service setup chosen by the user. Null if no service setup is chosen
+     * launch a service intergration for a specific category 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
+     * @param category - name of the service category
+     * @param {LaunchCategoryOptions} options - options for launching the service order integration
+     * @returns None
      *
      * #### Product Compatibility:
      * | | Encompass | Encompass Web | TPO | Consumer Connect |
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    selectServiceSetup: (category: ServiceSetupCategory, providerId?: string) => Promise<ServiceSetup>;
+    launchByCategory: (category: string, options: LaunchCategoryOptions) => Promise<void>;
     /**
-     * launch the default or specific service intergration to place a new service order or view existing order
+     * 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
      * @param serviceSetupId - unique id of the service setup
-     * @param {LaunchOptions} options - options for launching the service order integration
-     * @throws Error if the service setup is not found or user is not authorized to open the integration
+     * @param {LaunchServiceSetupOptions} options - options for launching the service order integration
      * @returns None
      *
      * #### Product Compatibility:
@@ -116,5 +156,5 @@ export interface IService extends IScriptingObject {
      * :-----:|:-----: |:-----: |:-----: |:-----: |
      * | all |  ✖️ |  ✖️ |  ✖️ |  ✖️ |
      */
-    launch: (serviceSetupId: string, options: LaunchOptions) => Promise<void>;
+    launchByServiceSetup: (serviceSetupId: string, options: LaunchServiceSetupOptions) => Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-scripting-object",
-  "version": "1.24.1",
+  "version": "1.26.0",
   "description": "Typescript defintions for Scripting Objects",
   "sideEffects": false,
   "main": "./dist/cjs/index.js",