@elliemae/pui-scripting-object 1.21.0 → 1.23.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 +32 -4
  2. package/package.json +2 -2
package/dist/types/objects/service.d.ts CHANGED
@@ -13,6 +13,10 @@ export type ServiceSetup = {
13
13
  * service setup id
14
14
  */
15
15
  serviceSetupId: string;
16
+ /**
17
+ * unique id of the partner
18
+ */
19
+ partnerId: string;
16
20
  /**
17
21
  * unique provider id
18
22
  */
@@ -31,11 +35,23 @@ export type ServiceSetup = {
31
35
  */
32
36
  export type LaunchOptions = {
33
37
  /**
34
- * application context that is launching the service order integration
38
+ * source application context that is launching the service order integration
35
39
  * urn patterned string
36
40
  * example: urn:elli:services:getpricing
37
41
  */
38
- srcContext: string;
42
+ source: string;
43
+ /**
44
+ * unique id of the partner
45
+ */
46
+ partnerId: string;
47
+ /**
48
+ * unique id of the existing service order transaction
49
+ */
50
+ transactionId?: string;
51
+ /**
52
+ * unique id of the existing service order
53
+ */
54
+ serviceOrderId?: string;
39
55
  };
40
56
  /**
41
57
  * Scripting object to work with service orders, such as launching a service order integration etc.,
@@ -50,7 +66,7 @@ export interface IService extends IScriptingObject {
50
66
  /**
51
67
  * get the service setup for the current user and loan
52
68
  * @param {ServiceSetupCategory} category - service setup category
53
- * @param providerId - The provider id of the service setup
69
+ * @param providerId - unique id of the service setup provider
54
70
  * @returns {Array<ServiceSetup>} list of service setups matching the input criteria. Empty list if no service setups are found
55
71
  *
56
72
  * #### Product Compatibility:
@@ -60,7 +76,19 @@ export interface IService extends IScriptingObject {
60
76
  */
61
77
  getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
62
78
  /**
63
- * launches the default or specific service intergration to place an service order
79
+ * select a service setup from the list of eligible service setups
80
+ * @param {ServiceSetupCategory} category - service setup category
81
+ * @param providerId - unique id of the service setup provider
82
+ * @returns {ServiceSetup} service setup chosen by the user. Null if no service setup is chosen
83
+ *
84
+ * #### Product Compatibility:
85
+ * | | Encompass | Encompass Web | TPO | Consumer Connect |
86
+ * :-----:|:-----: |:-----: |:-----: |:-----: |
87
+ * | all | ✖️ | ✖️ | ✖️ | ✖️ |
88
+ */
89
+ selectServiceSetup: (category: ServiceSetupCategory, providerId?: string) => Promise<ServiceSetup>;
90
+ /**
91
+ * launch the default or specific service intergration to place a new service order or view existing order
64
92
  * @param serviceSetupId - unique id of the service setup
65
93
  * @param {LaunchOptions} options - options for launching the service order integration
66
94
  * @throws Error if the service setup is not found or user is not authorized to open the integration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elliemae/pui-scripting-object",
3
- "version": "1.21.0",
3
+ "version": "1.23.0",
4
4
  "description": "Typescript defintions for Scripting Objects",
5
5
  "sideEffects": false,
6
6
  "main": "./dist/cjs/index.js",
@@ -68,7 +68,7 @@
68
68
  "devDependencies": {
69
69
  "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.7.0",
70
70
  "@elliemae/pui-cli": "~8.13.0",
71
- "@elliemae/pui-doc-gen": "~1.7.0",
71
+ "@elliemae/pui-doc-gen": "~1.7.1",
72
72
  "@elliemae/pui-theme": "~2.7.0",
73
73
  "@types/styled-components": "~5.1.26",
74
74
  "history": "~5.3.0",