@elliemae/pui-scripting-object 1.20.2 → 1.22.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.
|
@@ -27,24 +27,38 @@ export type ServiceSetup = {
|
|
|
27
27
|
category: ServiceSetupCategory;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* options to
|
|
30
|
+
* options to launch service order integration
|
|
31
31
|
*/
|
|
32
|
-
export type
|
|
32
|
+
export type LaunchOptions = {
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* source application context that is launching the service order integration
|
|
35
35
|
* urn patterned string
|
|
36
36
|
* example: urn:elli:services:getpricing
|
|
37
37
|
*/
|
|
38
|
-
|
|
38
|
+
source: string;
|
|
39
|
+
/**
|
|
40
|
+
* unique id of the existing service order transaction
|
|
41
|
+
*/
|
|
42
|
+
transactionId?: string;
|
|
43
|
+
/**
|
|
44
|
+
* unique id of the existing service order
|
|
45
|
+
*/
|
|
46
|
+
serviceOrderId?: string;
|
|
39
47
|
};
|
|
40
48
|
/**
|
|
41
|
-
*
|
|
49
|
+
* Scripting object to work with service orders, such as launching a service order integration etc.,
|
|
50
|
+
* Enables applications to place service orders, independent of SLP (Service Landing Page) application
|
|
51
|
+
*
|
|
52
|
+
* #### Product Compatibility:
|
|
53
|
+
* | | Encompass | Encompass Web | TPO | Consumer Connect |
|
|
54
|
+
* :-----:|:-----: |:-----: |:-----: |:-----: |
|
|
55
|
+
* | all | ✖️ | ✖️ | ✖️ | ✖️ |
|
|
42
56
|
*/
|
|
43
57
|
export interface IService extends IScriptingObject {
|
|
44
58
|
/**
|
|
45
59
|
* get the service setup for the current user and loan
|
|
46
60
|
* @param {ServiceSetupCategory} category - service setup category
|
|
47
|
-
* @param providerId -
|
|
61
|
+
* @param providerId - unique id of the service setup provider
|
|
48
62
|
* @returns {Array<ServiceSetup>} list of service setups matching the input criteria. Empty list if no service setups are found
|
|
49
63
|
*
|
|
50
64
|
* #### Product Compatibility:
|
|
@@ -54,9 +68,21 @@ export interface IService extends IScriptingObject {
|
|
|
54
68
|
*/
|
|
55
69
|
getEligibleServices: (category: ServiceSetupCategory, providerId?: string) => Promise<Array<ServiceSetup>>;
|
|
56
70
|
/**
|
|
57
|
-
*
|
|
71
|
+
* select a service setup from the list of eligible service setups
|
|
72
|
+
* @param {ServiceSetupCategory} category - service setup category
|
|
73
|
+
* @param providerId - unique id of the service setup provider
|
|
74
|
+
* @returns {ServiceSetup} service setup chosen by the user. Null if no service setup is chosen
|
|
75
|
+
*
|
|
76
|
+
* #### Product Compatibility:
|
|
77
|
+
* | | Encompass | Encompass Web | TPO | Consumer Connect |
|
|
78
|
+
* :-----:|:-----: |:-----: |:-----: |:-----: |
|
|
79
|
+
* | all | ✖️ | ✖️ | ✖️ | ✖️ |
|
|
80
|
+
*/
|
|
81
|
+
selectServiceSetup: (category: ServiceSetupCategory, providerId?: string) => Promise<ServiceSetup>;
|
|
82
|
+
/**
|
|
83
|
+
* launches the default or specific service intergration to place a service order
|
|
58
84
|
* @param serviceSetupId - unique id of the service setup
|
|
59
|
-
* @param {
|
|
85
|
+
* @param {LaunchOptions} options - options for launching the service order integration
|
|
60
86
|
* @throws Error if the service setup is not found or user is not authorized to open the integration
|
|
61
87
|
* @returns None
|
|
62
88
|
*
|
|
@@ -65,5 +91,5 @@ export interface IService extends IScriptingObject {
|
|
|
65
91
|
* :-----:|:-----: |:-----: |:-----: |:-----: |
|
|
66
92
|
* | all | ✖️ | ✖️ | ✖️ | ✖️ |
|
|
67
93
|
*/
|
|
68
|
-
|
|
94
|
+
launch: (serviceSetupId: string, options: LaunchOptions) => Promise<void>;
|
|
69
95
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elliemae/pui-scripting-object",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.22.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.
|
|
71
|
-
"@elliemae/pui-doc-gen": "~1.
|
|
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.
|
|
77
|
+
"styled-components": "~5.3.11"
|
|
78
78
|
},
|
|
79
79
|
"peerDependencies": {},
|
|
80
80
|
"type": "module"
|