@elliemae/pui-scripting-object 1.20.2 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/types/objects/service.d.ts +14 -8
  2. package/package.json +4 -4
package/dist/types/objects/service.d.ts CHANGED
@@ -27,18 +27,24 @@ export type ServiceSetup = {
27
27
  category: ServiceSetupCategory;
28
28
  };
29
29
  /**
30
- * options to create service order
30
+ * options to launch service order integration
31
31
  */
32
- export type CreateOrderOptions = {
32
+ export type LaunchOptions = {
33
33
  /**
34
- * context of the application that is opening the service order integration
34
+ * application context that is launching the service order integration
35
35
  * urn patterned string
36
36
  * example: urn:elli:services:getpricing
37
37
  */
38
- target: string;
38
+ srcContext: string;
39
39
  };
40
40
  /**
41
- * Methods for interacting with the Service orders
41
+ * Scripting object to work with service orders, such as launching a service order integration etc.,
42
+ * Enables applications to place service orders, independent of SLP (Service Landing Page) application
43
+ *
44
+ * #### Product Compatibility:
45
+ * | | Encompass | Encompass Web | TPO | Consumer Connect |
46
+ * :-----:|:-----: |:-----: |:-----: |:-----: |
47
+ * | all | ✖️ | ✖️ | ✖️ | ✖️ |
42
48
  */
43
49
  export interface IService extends IScriptingObject {
44
50
  /**
@@ -54,9 +60,9 @@ export interface IService extends IScriptingObject {
54
60
  */
55
61
  getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
56
62
  /**
57
- * open default or specific service intergration to create an order
63
+ * launches the default or specific service intergration to place an service order
58
64
  * @param serviceSetupId - unique id of the service setup
59
- * @param {CreateOrderOptions} options - options for creating the order
65
+ * @param {LaunchOptions} options - options for launching the service order integration
60
66
  * @throws Error if the service setup is not found or user is not authorized to open the integration
61
67
  * @returns None
62
68
  *
@@ -65,5 +71,5 @@ export interface IService extends IScriptingObject {
65
71
  * :-----:|:-----: |:-----: |:-----: |:-----: |
66
72
  * | all | ✖️ | ✖️ | ✖️ | ✖️ |
67
73
  */
68
- createOrder: (serviceSetupId: string, options: CreateOrderOptions) => Promise<void>;
74
+ launch: (serviceSetupId: string, options: LaunchOptions) => Promise<void>;
69
75
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elliemae/pui-scripting-object",
3
- "version": "1.20.2",
3
+ "version": "1.21.0",
4
4
  "description": "Typescript defintions for Scripting Objects",
5
5
  "sideEffects": false,
6
6
  "main": "./dist/cjs/index.js",
@@ -67,14 +67,14 @@
67
67
  },
68
68
  "devDependencies": {
69
69
  "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
70
- "@elliemae/pui-cli": "~8.12.0",
71
- "@elliemae/pui-doc-gen": "~1.6.4",
70
+ "@elliemae/pui-cli": "~8.13.0",
71
+ "@elliemae/pui-doc-gen": "~1.7.0",
72
72
  "@elliemae/pui-theme": "~2.7.0",
73
73
  "@types/styled-components": "~5.1.26",
74
74
  "history": "~5.3.0",
75
75
  "redux": "~4.2.1",
76
76
  "redux-saga": "~1.2.3",
77
- "styled-components": "~5.3.10"
77
+ "styled-components": "~5.3.11"
78
78
  },
79
79
  "peerDependencies": {},
80
80
  "type": "module"