@elliemae/pui-scripting-object 1.22.0 → 1.24.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.
@@ -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
  */
@@ -36,6 +40,10 @@ export type LaunchOptions = {
36
40
  * example: urn:elli:services:getpricing
37
41
  */
38
42
  source: string;
43
+ /**
44
+ * unique id of the partner
45
+ */
46
+ partnerId: string;
39
47
  /**
40
48
  * unique id of the existing service order transaction
41
49
  */
@@ -44,10 +52,19 @@ export type LaunchOptions = {
44
52
  * unique id of the existing service order
45
53
  */
46
54
  serviceOrderId?: string;
55
+ /**
56
+ * settings to be passed to the service order integration
57
+ */
58
+ settings?: any;
59
+ /**
60
+ * additional data needed for the service order integration
61
+ */
62
+ additionalData?: any;
47
63
  };
48
64
  /**
49
65
  * Scripting object to work with service orders, such as launching a service order integration etc.,
50
66
  * Enables applications to place service orders, independent of SLP (Service Landing Page) application
67
+ * Errors thrown by the service order integration will be returned to the caller of this Scripting Object method
51
68
  *
52
69
  * #### Product Compatibility:
53
70
  * | | Encompass | Encompass Web | TPO | Consumer Connect |
@@ -80,7 +97,7 @@ export interface IService extends IScriptingObject {
80
97
  */
81
98
  selectServiceSetup: (category: ServiceSetupCategory, providerId?: string) => Promise<ServiceSetup>;
82
99
  /**
83
- * launches the default or specific service intergration to place a service order
100
+ * launch the default or specific service intergration to place a new service order or view existing order
84
101
  * @param serviceSetupId - unique id of the service setup
85
102
  * @param {LaunchOptions} options - options for launching the service order integration
86
103
  * @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.22.0",
3
+ "version": "1.24.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",