@epilot/customer-portal-client 0.35.0 → 0.37.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.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +132 -6
- package/dist/openapi.d.ts +816 -25
- package/package.json +1 -1
- package/src/openapi-runtime.json +132 -6
- package/src/openapi.json +478 -23
package/dist/openapi.d.ts
CHANGED
|
@@ -467,6 +467,27 @@ declare namespace Components {
|
|
|
467
467
|
* 2021-02-09T12:41:43.662Z
|
|
468
468
|
*/
|
|
469
469
|
_updated_at: string; // date-time
|
|
470
|
+
/**
|
|
471
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
472
|
+
*/
|
|
473
|
+
templates_output_highlighted?: {
|
|
474
|
+
[name: string]: string | {
|
|
475
|
+
[name: string]: string;
|
|
476
|
+
};
|
|
477
|
+
};
|
|
478
|
+
/**
|
|
479
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
480
|
+
*/
|
|
481
|
+
search_snippets?: {
|
|
482
|
+
/**
|
|
483
|
+
* Human-readable field label
|
|
484
|
+
*/
|
|
485
|
+
field?: string;
|
|
486
|
+
/**
|
|
487
|
+
* Highlighted text fragment with <em> tags
|
|
488
|
+
*/
|
|
489
|
+
fragment?: string;
|
|
490
|
+
}[];
|
|
470
491
|
/**
|
|
471
492
|
* Amount to be paid in cents i.e. precision 2
|
|
472
493
|
* example:
|
|
@@ -592,6 +613,27 @@ declare namespace Components {
|
|
|
592
613
|
* 2021-02-09T12:41:43.662Z
|
|
593
614
|
*/
|
|
594
615
|
_updated_at: string; // date-time
|
|
616
|
+
/**
|
|
617
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
618
|
+
*/
|
|
619
|
+
templates_output_highlighted?: {
|
|
620
|
+
[name: string]: string | {
|
|
621
|
+
[name: string]: string;
|
|
622
|
+
};
|
|
623
|
+
};
|
|
624
|
+
/**
|
|
625
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
626
|
+
*/
|
|
627
|
+
search_snippets?: {
|
|
628
|
+
/**
|
|
629
|
+
* Human-readable field label
|
|
630
|
+
*/
|
|
631
|
+
field?: string;
|
|
632
|
+
/**
|
|
633
|
+
* Highlighted text fragment with <em> tags
|
|
634
|
+
*/
|
|
635
|
+
fragment?: string;
|
|
636
|
+
}[];
|
|
595
637
|
/**
|
|
596
638
|
* Billing account number
|
|
597
639
|
*/
|
|
@@ -865,6 +907,13 @@ declare namespace Components {
|
|
|
865
907
|
* Mark true if the domain is an Epilot domain
|
|
866
908
|
*/
|
|
867
909
|
is_epilot_domain?: boolean;
|
|
910
|
+
/**
|
|
911
|
+
* The URL on which the portal is accessible
|
|
912
|
+
* example:
|
|
913
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
914
|
+
*/
|
|
915
|
+
epilot_domain?: string;
|
|
916
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
868
917
|
/**
|
|
869
918
|
* ID of the design used to build the portal
|
|
870
919
|
*/
|
|
@@ -1286,6 +1335,13 @@ declare namespace Components {
|
|
|
1286
1335
|
* Mark true if the domain is an Epilot domain
|
|
1287
1336
|
*/
|
|
1288
1337
|
is_epilot_domain?: boolean;
|
|
1338
|
+
/**
|
|
1339
|
+
* The Epilot domain on which the portal is accessible
|
|
1340
|
+
* example:
|
|
1341
|
+
* example-portal-1.ecp.epilot.io
|
|
1342
|
+
*/
|
|
1343
|
+
epilot_domain?: string;
|
|
1344
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
1289
1345
|
/**
|
|
1290
1346
|
* ID of the design used to build the portal
|
|
1291
1347
|
*/
|
|
@@ -1727,6 +1783,27 @@ declare namespace Components {
|
|
|
1727
1783
|
* 2021-02-09T12:41:43.662Z
|
|
1728
1784
|
*/
|
|
1729
1785
|
_updated_at: string; // date-time
|
|
1786
|
+
/**
|
|
1787
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
1788
|
+
*/
|
|
1789
|
+
templates_output_highlighted?: {
|
|
1790
|
+
[name: string]: string | {
|
|
1791
|
+
[name: string]: string;
|
|
1792
|
+
};
|
|
1793
|
+
};
|
|
1794
|
+
/**
|
|
1795
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
1796
|
+
*/
|
|
1797
|
+
search_snippets?: {
|
|
1798
|
+
/**
|
|
1799
|
+
* Human-readable field label
|
|
1800
|
+
*/
|
|
1801
|
+
field?: string;
|
|
1802
|
+
/**
|
|
1803
|
+
* Highlighted text fragment with <em> tags
|
|
1804
|
+
*/
|
|
1805
|
+
fragment?: string;
|
|
1806
|
+
}[];
|
|
1730
1807
|
_schema: "contact";
|
|
1731
1808
|
}
|
|
1732
1809
|
export interface ContactCountRequest {
|
|
@@ -1857,6 +1934,27 @@ declare namespace Components {
|
|
|
1857
1934
|
* 2021-02-09T12:41:43.662Z
|
|
1858
1935
|
*/
|
|
1859
1936
|
_updated_at: string; // date-time
|
|
1937
|
+
/**
|
|
1938
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
1939
|
+
*/
|
|
1940
|
+
templates_output_highlighted?: {
|
|
1941
|
+
[name: string]: string | {
|
|
1942
|
+
[name: string]: string;
|
|
1943
|
+
};
|
|
1944
|
+
};
|
|
1945
|
+
/**
|
|
1946
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
1947
|
+
*/
|
|
1948
|
+
search_snippets?: {
|
|
1949
|
+
/**
|
|
1950
|
+
* Human-readable field label
|
|
1951
|
+
*/
|
|
1952
|
+
field?: string;
|
|
1953
|
+
/**
|
|
1954
|
+
* Highlighted text fragment with <em> tags
|
|
1955
|
+
*/
|
|
1956
|
+
fragment?: string;
|
|
1957
|
+
}[];
|
|
1860
1958
|
/**
|
|
1861
1959
|
* The name of the contract.
|
|
1862
1960
|
* example:
|
|
@@ -2125,6 +2223,23 @@ declare namespace Components {
|
|
|
2125
2223
|
de?: string;
|
|
2126
2224
|
};
|
|
2127
2225
|
}
|
|
2226
|
+
/**
|
|
2227
|
+
* Domain settings for the portal
|
|
2228
|
+
*/
|
|
2229
|
+
export interface DomainSettings {
|
|
2230
|
+
/**
|
|
2231
|
+
* Whether the custom domain is enabled
|
|
2232
|
+
*/
|
|
2233
|
+
is_custom_domain_enabled?: boolean;
|
|
2234
|
+
/**
|
|
2235
|
+
* Whether the Epilot domain is enabled
|
|
2236
|
+
*/
|
|
2237
|
+
is_epilot_domain_enabled?: boolean;
|
|
2238
|
+
/**
|
|
2239
|
+
* Whether the redirection is enabled
|
|
2240
|
+
*/
|
|
2241
|
+
is_redirection_enabled?: boolean;
|
|
2242
|
+
}
|
|
2128
2243
|
/**
|
|
2129
2244
|
* Email templates used for authentication and internal processes
|
|
2130
2245
|
*/
|
|
@@ -2267,6 +2382,27 @@ declare namespace Components {
|
|
|
2267
2382
|
}
|
|
2268
2383
|
export interface Entity {
|
|
2269
2384
|
[name: string]: any;
|
|
2385
|
+
/**
|
|
2386
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
2387
|
+
*/
|
|
2388
|
+
templates_output_highlighted?: {
|
|
2389
|
+
[name: string]: string | {
|
|
2390
|
+
[name: string]: string;
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
/**
|
|
2394
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
2395
|
+
*/
|
|
2396
|
+
search_snippets?: {
|
|
2397
|
+
/**
|
|
2398
|
+
* Human-readable field label
|
|
2399
|
+
*/
|
|
2400
|
+
field?: string;
|
|
2401
|
+
/**
|
|
2402
|
+
* Highlighted text fragment with <em> tags
|
|
2403
|
+
*/
|
|
2404
|
+
fragment?: string;
|
|
2405
|
+
}[];
|
|
2270
2406
|
}
|
|
2271
2407
|
export interface EntityEditRule {
|
|
2272
2408
|
slug?: /**
|
|
@@ -2456,6 +2592,27 @@ declare namespace Components {
|
|
|
2456
2592
|
* 2021-02-09T12:41:43.662Z
|
|
2457
2593
|
*/
|
|
2458
2594
|
_updated_at: string; // date-time
|
|
2595
|
+
/**
|
|
2596
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
2597
|
+
*/
|
|
2598
|
+
templates_output_highlighted?: {
|
|
2599
|
+
[name: string]: string | {
|
|
2600
|
+
[name: string]: string;
|
|
2601
|
+
};
|
|
2602
|
+
};
|
|
2603
|
+
/**
|
|
2604
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
2605
|
+
*/
|
|
2606
|
+
search_snippets?: {
|
|
2607
|
+
/**
|
|
2608
|
+
* Human-readable field label
|
|
2609
|
+
*/
|
|
2610
|
+
field?: string;
|
|
2611
|
+
/**
|
|
2612
|
+
* Highlighted text fragment with <em> tags
|
|
2613
|
+
*/
|
|
2614
|
+
fragment?: string;
|
|
2615
|
+
}[];
|
|
2459
2616
|
/**
|
|
2460
2617
|
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
2461
2618
|
* example:
|
|
@@ -2793,6 +2950,12 @@ declare namespace Components {
|
|
|
2793
2950
|
* ]
|
|
2794
2951
|
*/
|
|
2795
2952
|
include?: ("active_workflow")[];
|
|
2953
|
+
/**
|
|
2954
|
+
* Elasticsearch highlight configuration passed through to the Entity API. When provided, matching results include a `highlight` object with field names as keys and arrays of highlighted fragments as values.
|
|
2955
|
+
*/
|
|
2956
|
+
highlight?: {
|
|
2957
|
+
[key: string]: any;
|
|
2958
|
+
};
|
|
2796
2959
|
}
|
|
2797
2960
|
/**
|
|
2798
2961
|
* URL-friendly identifier for the entity schema
|
|
@@ -3660,6 +3823,27 @@ declare namespace Components {
|
|
|
3660
3823
|
* 2021-02-09T12:41:43.662Z
|
|
3661
3824
|
*/
|
|
3662
3825
|
_updated_at: string; // date-time
|
|
3826
|
+
/**
|
|
3827
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
3828
|
+
*/
|
|
3829
|
+
templates_output_highlighted?: {
|
|
3830
|
+
[name: string]: string | {
|
|
3831
|
+
[name: string]: string;
|
|
3832
|
+
};
|
|
3833
|
+
};
|
|
3834
|
+
/**
|
|
3835
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
3836
|
+
*/
|
|
3837
|
+
search_snippets?: {
|
|
3838
|
+
/**
|
|
3839
|
+
* Human-readable field label
|
|
3840
|
+
*/
|
|
3841
|
+
field?: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* Highlighted text fragment with <em> tags
|
|
3844
|
+
*/
|
|
3845
|
+
fragment?: string;
|
|
3846
|
+
}[];
|
|
3663
3847
|
_schema: "file";
|
|
3664
3848
|
}
|
|
3665
3849
|
/**
|
|
@@ -3706,6 +3890,27 @@ declare namespace Components {
|
|
|
3706
3890
|
* 2021-02-09T12:41:43.662Z
|
|
3707
3891
|
*/
|
|
3708
3892
|
_updated_at: string; // date-time
|
|
3893
|
+
/**
|
|
3894
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
3895
|
+
*/
|
|
3896
|
+
templates_output_highlighted?: {
|
|
3897
|
+
[name: string]: string | {
|
|
3898
|
+
[name: string]: string;
|
|
3899
|
+
};
|
|
3900
|
+
};
|
|
3901
|
+
/**
|
|
3902
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
3903
|
+
*/
|
|
3904
|
+
search_snippets?: {
|
|
3905
|
+
/**
|
|
3906
|
+
* Human-readable field label
|
|
3907
|
+
*/
|
|
3908
|
+
field?: string;
|
|
3909
|
+
/**
|
|
3910
|
+
* Highlighted text fragment with <em> tags
|
|
3911
|
+
*/
|
|
3912
|
+
fragment?: string;
|
|
3913
|
+
}[];
|
|
3709
3914
|
_schema: "file";
|
|
3710
3915
|
/**
|
|
3711
3916
|
* example:
|
|
@@ -3836,6 +4041,27 @@ declare namespace Components {
|
|
|
3836
4041
|
* 2021-02-09T12:41:43.662Z
|
|
3837
4042
|
*/
|
|
3838
4043
|
_updated_at: string; // date-time
|
|
4044
|
+
/**
|
|
4045
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4046
|
+
*/
|
|
4047
|
+
templates_output_highlighted?: {
|
|
4048
|
+
[name: string]: string | {
|
|
4049
|
+
[name: string]: string;
|
|
4050
|
+
};
|
|
4051
|
+
};
|
|
4052
|
+
/**
|
|
4053
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4054
|
+
*/
|
|
4055
|
+
search_snippets?: {
|
|
4056
|
+
/**
|
|
4057
|
+
* Human-readable field label
|
|
4058
|
+
*/
|
|
4059
|
+
field?: string;
|
|
4060
|
+
/**
|
|
4061
|
+
* Highlighted text fragment with <em> tags
|
|
4062
|
+
*/
|
|
4063
|
+
fragment?: string;
|
|
4064
|
+
}[];
|
|
3839
4065
|
/**
|
|
3840
4066
|
* Amount to be paid in cents i.e. precision 2
|
|
3841
4067
|
* example:
|
|
@@ -3900,6 +4126,12 @@ declare namespace Components {
|
|
|
3900
4126
|
* Whether the org is in canary mode
|
|
3901
4127
|
*/
|
|
3902
4128
|
is_canary?: boolean;
|
|
4129
|
+
/**
|
|
4130
|
+
* The URL to redirect to
|
|
4131
|
+
* example:
|
|
4132
|
+
* https://example.com
|
|
4133
|
+
*/
|
|
4134
|
+
redirect_to?: string;
|
|
3903
4135
|
}
|
|
3904
4136
|
/**
|
|
3905
4137
|
* The meter entity
|
|
@@ -3945,6 +4177,27 @@ declare namespace Components {
|
|
|
3945
4177
|
* 2021-02-09T12:41:43.662Z
|
|
3946
4178
|
*/
|
|
3947
4179
|
_updated_at: string; // date-time
|
|
4180
|
+
/**
|
|
4181
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4182
|
+
*/
|
|
4183
|
+
templates_output_highlighted?: {
|
|
4184
|
+
[name: string]: string | {
|
|
4185
|
+
[name: string]: string;
|
|
4186
|
+
};
|
|
4187
|
+
};
|
|
4188
|
+
/**
|
|
4189
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4190
|
+
*/
|
|
4191
|
+
search_snippets?: {
|
|
4192
|
+
/**
|
|
4193
|
+
* Human-readable field label
|
|
4194
|
+
*/
|
|
4195
|
+
field?: string;
|
|
4196
|
+
/**
|
|
4197
|
+
* Highlighted text fragment with <em> tags
|
|
4198
|
+
*/
|
|
4199
|
+
fragment?: string;
|
|
4200
|
+
}[];
|
|
3948
4201
|
_schema: "meter";
|
|
3949
4202
|
}
|
|
3950
4203
|
export interface MeterChartWidget {
|
|
@@ -4010,7 +4263,7 @@ declare namespace Components {
|
|
|
4010
4263
|
/**
|
|
4011
4264
|
* If the value is not provided, the system will be set with the time the request is processed.
|
|
4012
4265
|
* example:
|
|
4013
|
-
* 2022-10-
|
|
4266
|
+
* 2022-10-10T00:00:00.000Z
|
|
4014
4267
|
*/
|
|
4015
4268
|
timestamp?: string;
|
|
4016
4269
|
/**
|
|
@@ -4277,6 +4530,27 @@ declare namespace Components {
|
|
|
4277
4530
|
* 2021-02-09T12:41:43.662Z
|
|
4278
4531
|
*/
|
|
4279
4532
|
_updated_at: string; // date-time
|
|
4533
|
+
/**
|
|
4534
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4535
|
+
*/
|
|
4536
|
+
templates_output_highlighted?: {
|
|
4537
|
+
[name: string]: string | {
|
|
4538
|
+
[name: string]: string;
|
|
4539
|
+
};
|
|
4540
|
+
};
|
|
4541
|
+
/**
|
|
4542
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4543
|
+
*/
|
|
4544
|
+
search_snippets?: {
|
|
4545
|
+
/**
|
|
4546
|
+
* Human-readable field label
|
|
4547
|
+
*/
|
|
4548
|
+
field?: string;
|
|
4549
|
+
/**
|
|
4550
|
+
* Highlighted text fragment with <em> tags
|
|
4551
|
+
*/
|
|
4552
|
+
fragment?: string;
|
|
4553
|
+
}[];
|
|
4280
4554
|
_schema: "opportunity";
|
|
4281
4555
|
}
|
|
4282
4556
|
/**
|
|
@@ -4323,6 +4597,27 @@ declare namespace Components {
|
|
|
4323
4597
|
* 2021-02-09T12:41:43.662Z
|
|
4324
4598
|
*/
|
|
4325
4599
|
_updated_at: string; // date-time
|
|
4600
|
+
/**
|
|
4601
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4602
|
+
*/
|
|
4603
|
+
templates_output_highlighted?: {
|
|
4604
|
+
[name: string]: string | {
|
|
4605
|
+
[name: string]: string;
|
|
4606
|
+
};
|
|
4607
|
+
};
|
|
4608
|
+
/**
|
|
4609
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4610
|
+
*/
|
|
4611
|
+
search_snippets?: {
|
|
4612
|
+
/**
|
|
4613
|
+
* Human-readable field label
|
|
4614
|
+
*/
|
|
4615
|
+
field?: string;
|
|
4616
|
+
/**
|
|
4617
|
+
* Highlighted text fragment with <em> tags
|
|
4618
|
+
*/
|
|
4619
|
+
fragment?: string;
|
|
4620
|
+
}[];
|
|
4326
4621
|
_schema: "order";
|
|
4327
4622
|
}
|
|
4328
4623
|
export interface OrganizationSettings {
|
|
@@ -4579,6 +4874,12 @@ declare namespace Components {
|
|
|
4579
4874
|
* 2021-02-09T12:41:43.662Z
|
|
4580
4875
|
*/
|
|
4581
4876
|
last_modified_at?: string; // date-time
|
|
4877
|
+
/**
|
|
4878
|
+
* The id of the portal
|
|
4879
|
+
* example:
|
|
4880
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
4881
|
+
*/
|
|
4882
|
+
portal_id?: string;
|
|
4582
4883
|
}
|
|
4583
4884
|
export interface PageRequest {
|
|
4584
4885
|
[name: string]: any;
|
|
@@ -4740,6 +5041,13 @@ declare namespace Components {
|
|
|
4740
5041
|
* Mark true if the domain is an Epilot domain
|
|
4741
5042
|
*/
|
|
4742
5043
|
is_epilot_domain?: boolean;
|
|
5044
|
+
/**
|
|
5045
|
+
* The URL on which the portal is accessible
|
|
5046
|
+
* example:
|
|
5047
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
5048
|
+
*/
|
|
5049
|
+
epilot_domain?: string;
|
|
5050
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
4743
5051
|
design_id?: /**
|
|
4744
5052
|
* Entity ID
|
|
4745
5053
|
* example:
|
|
@@ -5244,6 +5552,13 @@ declare namespace Components {
|
|
|
5244
5552
|
* Mark true if the domain is an Epilot domain
|
|
5245
5553
|
*/
|
|
5246
5554
|
is_epilot_domain?: boolean;
|
|
5555
|
+
/**
|
|
5556
|
+
* The Epilot domain on which the portal is accessible
|
|
5557
|
+
* example:
|
|
5558
|
+
* example-portal-1.ecp.epilot.io
|
|
5559
|
+
*/
|
|
5560
|
+
epilot_domain?: string;
|
|
5561
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5247
5562
|
design_id?: /**
|
|
5248
5563
|
* Entity ID
|
|
5249
5564
|
* example:
|
|
@@ -5729,6 +6044,27 @@ declare namespace Components {
|
|
|
5729
6044
|
* 2021-02-09T12:41:43.662Z
|
|
5730
6045
|
*/
|
|
5731
6046
|
_updated_at: string; // date-time
|
|
6047
|
+
/**
|
|
6048
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
6049
|
+
*/
|
|
6050
|
+
templates_output_highlighted?: {
|
|
6051
|
+
[name: string]: string | {
|
|
6052
|
+
[name: string]: string;
|
|
6053
|
+
};
|
|
6054
|
+
};
|
|
6055
|
+
/**
|
|
6056
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6057
|
+
*/
|
|
6058
|
+
search_snippets?: {
|
|
6059
|
+
/**
|
|
6060
|
+
* Human-readable field label
|
|
6061
|
+
*/
|
|
6062
|
+
field?: string;
|
|
6063
|
+
/**
|
|
6064
|
+
* Highlighted text fragment with <em> tags
|
|
6065
|
+
*/
|
|
6066
|
+
fragment?: string;
|
|
6067
|
+
}[];
|
|
5732
6068
|
_schema: "portal_user";
|
|
5733
6069
|
}
|
|
5734
6070
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
@@ -5777,6 +6113,27 @@ declare namespace Components {
|
|
|
5777
6113
|
* 2021-02-09T12:41:43.662Z
|
|
5778
6114
|
*/
|
|
5779
6115
|
_updated_at: string; // date-time
|
|
6116
|
+
/**
|
|
6117
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
6118
|
+
*/
|
|
6119
|
+
templates_output_highlighted?: {
|
|
6120
|
+
[name: string]: string | {
|
|
6121
|
+
[name: string]: string;
|
|
6122
|
+
};
|
|
6123
|
+
};
|
|
6124
|
+
/**
|
|
6125
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6126
|
+
*/
|
|
6127
|
+
search_snippets?: {
|
|
6128
|
+
/**
|
|
6129
|
+
* Human-readable field label
|
|
6130
|
+
*/
|
|
6131
|
+
field?: string;
|
|
6132
|
+
/**
|
|
6133
|
+
* Highlighted text fragment with <em> tags
|
|
6134
|
+
*/
|
|
6135
|
+
fragment?: string;
|
|
6136
|
+
}[];
|
|
5780
6137
|
_schema: "product";
|
|
5781
6138
|
}
|
|
5782
6139
|
export interface ProductRecommendationsWidget {
|
|
@@ -5991,6 +6348,27 @@ declare namespace Components {
|
|
|
5991
6348
|
* 2021-02-09T12:41:43.662Z
|
|
5992
6349
|
*/
|
|
5993
6350
|
_updated_at: string; // date-time
|
|
6351
|
+
/**
|
|
6352
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
6353
|
+
*/
|
|
6354
|
+
templates_output_highlighted?: {
|
|
6355
|
+
[name: string]: string | {
|
|
6356
|
+
[name: string]: string;
|
|
6357
|
+
};
|
|
6358
|
+
};
|
|
6359
|
+
/**
|
|
6360
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6361
|
+
*/
|
|
6362
|
+
search_snippets?: {
|
|
6363
|
+
/**
|
|
6364
|
+
* Human-readable field label
|
|
6365
|
+
*/
|
|
6366
|
+
field?: string;
|
|
6367
|
+
/**
|
|
6368
|
+
* Highlighted text fragment with <em> tags
|
|
6369
|
+
*/
|
|
6370
|
+
fragment?: string;
|
|
6371
|
+
}[];
|
|
5994
6372
|
/**
|
|
5995
6373
|
* Amount to be paid in cents i.e. precision 2
|
|
5996
6374
|
* example:
|
|
@@ -6400,6 +6778,13 @@ declare namespace Components {
|
|
|
6400
6778
|
* Mark true if the domain is an Epilot domain
|
|
6401
6779
|
*/
|
|
6402
6780
|
is_epilot_domain?: boolean;
|
|
6781
|
+
/**
|
|
6782
|
+
* The URL on which the portal is accessible
|
|
6783
|
+
* example:
|
|
6784
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
6785
|
+
*/
|
|
6786
|
+
epilot_domain?: string;
|
|
6787
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6403
6788
|
design_id?: /**
|
|
6404
6789
|
* Entity ID
|
|
6405
6790
|
* example:
|
|
@@ -6858,6 +7243,13 @@ declare namespace Components {
|
|
|
6858
7243
|
* Mark true if the domain is an Epilot domain
|
|
6859
7244
|
*/
|
|
6860
7245
|
is_epilot_domain?: boolean;
|
|
7246
|
+
/**
|
|
7247
|
+
* The Epilot domain on which the portal is accessible
|
|
7248
|
+
* example:
|
|
7249
|
+
* example-portal-1.ecp.epilot.io
|
|
7250
|
+
*/
|
|
7251
|
+
epilot_domain?: string;
|
|
7252
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6861
7253
|
design_id?: /**
|
|
6862
7254
|
* Entity ID
|
|
6863
7255
|
* example:
|
|
@@ -7499,6 +7891,7 @@ declare namespace Paths {
|
|
|
7499
7891
|
}
|
|
7500
7892
|
namespace CheckContactExistsV3 {
|
|
7501
7893
|
namespace Parameters {
|
|
7894
|
+
export type Domain = string;
|
|
7502
7895
|
export type PortalId = /**
|
|
7503
7896
|
* ID of the portal
|
|
7504
7897
|
* example:
|
|
@@ -7507,7 +7900,8 @@ declare namespace Paths {
|
|
|
7507
7900
|
Components.Schemas.PortalId;
|
|
7508
7901
|
}
|
|
7509
7902
|
export interface QueryParameters {
|
|
7510
|
-
portal_id
|
|
7903
|
+
portal_id?: Parameters.PortalId;
|
|
7904
|
+
domain?: Parameters.Domain;
|
|
7511
7905
|
}
|
|
7512
7906
|
export type RequestBody = Components.Schemas.ContactExistsRequest;
|
|
7513
7907
|
namespace Responses {
|
|
@@ -7748,6 +8142,7 @@ declare namespace Paths {
|
|
|
7748
8142
|
}
|
|
7749
8143
|
namespace CreateUserV3 {
|
|
7750
8144
|
namespace Parameters {
|
|
8145
|
+
export type Domain = string;
|
|
7751
8146
|
export type PortalId = /**
|
|
7752
8147
|
* ID of the portal
|
|
7753
8148
|
* example:
|
|
@@ -7756,7 +8151,8 @@ declare namespace Paths {
|
|
|
7756
8151
|
Components.Schemas.PortalId;
|
|
7757
8152
|
}
|
|
7758
8153
|
export interface QueryParameters {
|
|
7759
|
-
portal_id
|
|
8154
|
+
portal_id?: Parameters.PortalId;
|
|
8155
|
+
domain?: Parameters.Domain;
|
|
7760
8156
|
}
|
|
7761
8157
|
export type RequestBody = Components.Schemas.CreateUserRequest;
|
|
7762
8158
|
namespace Responses {
|
|
@@ -8040,6 +8436,27 @@ declare namespace Paths {
|
|
|
8040
8436
|
* 2021-02-09T12:41:43.662Z
|
|
8041
8437
|
*/
|
|
8042
8438
|
_updated_at: string; // date-time
|
|
8439
|
+
/**
|
|
8440
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8441
|
+
*/
|
|
8442
|
+
templates_output_highlighted?: {
|
|
8443
|
+
[name: string]: string | {
|
|
8444
|
+
[name: string]: string;
|
|
8445
|
+
};
|
|
8446
|
+
};
|
|
8447
|
+
/**
|
|
8448
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8449
|
+
*/
|
|
8450
|
+
search_snippets?: {
|
|
8451
|
+
/**
|
|
8452
|
+
* Human-readable field label
|
|
8453
|
+
*/
|
|
8454
|
+
field?: string;
|
|
8455
|
+
/**
|
|
8456
|
+
* Highlighted text fragment with <em> tags
|
|
8457
|
+
*/
|
|
8458
|
+
fragment?: string;
|
|
8459
|
+
}[];
|
|
8043
8460
|
/**
|
|
8044
8461
|
* The name of the contract.
|
|
8045
8462
|
* example:
|
|
@@ -8345,8 +8762,29 @@ declare namespace Paths {
|
|
|
8345
8762
|
* 2021-02-09T12:41:43.662Z
|
|
8346
8763
|
*/
|
|
8347
8764
|
_updated_at: string; // date-time
|
|
8348
|
-
|
|
8349
|
-
|
|
8765
|
+
/**
|
|
8766
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8767
|
+
*/
|
|
8768
|
+
templates_output_highlighted?: {
|
|
8769
|
+
[name: string]: string | {
|
|
8770
|
+
[name: string]: string;
|
|
8771
|
+
};
|
|
8772
|
+
};
|
|
8773
|
+
/**
|
|
8774
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8775
|
+
*/
|
|
8776
|
+
search_snippets?: {
|
|
8777
|
+
/**
|
|
8778
|
+
* Human-readable field label
|
|
8779
|
+
*/
|
|
8780
|
+
field?: string;
|
|
8781
|
+
/**
|
|
8782
|
+
* Highlighted text fragment with <em> tags
|
|
8783
|
+
*/
|
|
8784
|
+
fragment?: string;
|
|
8785
|
+
}[];
|
|
8786
|
+
_schema: "opportunity";
|
|
8787
|
+
journey_actions?: Components.Schemas.JourneyActions;
|
|
8350
8788
|
}[];
|
|
8351
8789
|
}
|
|
8352
8790
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -8427,6 +8865,27 @@ declare namespace Paths {
|
|
|
8427
8865
|
* 2021-02-09T12:41:43.662Z
|
|
8428
8866
|
*/
|
|
8429
8867
|
_updated_at: string; // date-time
|
|
8868
|
+
/**
|
|
8869
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8870
|
+
*/
|
|
8871
|
+
templates_output_highlighted?: {
|
|
8872
|
+
[name: string]: string | {
|
|
8873
|
+
[name: string]: string;
|
|
8874
|
+
};
|
|
8875
|
+
};
|
|
8876
|
+
/**
|
|
8877
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8878
|
+
*/
|
|
8879
|
+
search_snippets?: {
|
|
8880
|
+
/**
|
|
8881
|
+
* Human-readable field label
|
|
8882
|
+
*/
|
|
8883
|
+
field?: string;
|
|
8884
|
+
/**
|
|
8885
|
+
* Highlighted text fragment with <em> tags
|
|
8886
|
+
*/
|
|
8887
|
+
fragment?: string;
|
|
8888
|
+
}[];
|
|
8430
8889
|
_schema: "order";
|
|
8431
8890
|
journey_actions?: Components.Schemas.JourneyActions;
|
|
8432
8891
|
}[];
|
|
@@ -9427,6 +9886,13 @@ declare namespace Paths {
|
|
|
9427
9886
|
* Mark true if the domain is an Epilot domain
|
|
9428
9887
|
*/
|
|
9429
9888
|
is_epilot_domain?: boolean;
|
|
9889
|
+
/**
|
|
9890
|
+
* The URL on which the portal is accessible
|
|
9891
|
+
* example:
|
|
9892
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
9893
|
+
*/
|
|
9894
|
+
epilot_domain?: string;
|
|
9895
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
9430
9896
|
design_id?: /**
|
|
9431
9897
|
* Entity ID
|
|
9432
9898
|
* example:
|
|
@@ -9921,6 +10387,13 @@ declare namespace Paths {
|
|
|
9921
10387
|
* Mark true if the domain is an Epilot domain
|
|
9922
10388
|
*/
|
|
9923
10389
|
is_epilot_domain?: boolean;
|
|
10390
|
+
/**
|
|
10391
|
+
* The URL on which the portal is accessible
|
|
10392
|
+
* example:
|
|
10393
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
10394
|
+
*/
|
|
10395
|
+
epilot_domain?: string;
|
|
10396
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
9924
10397
|
design_id?: /**
|
|
9925
10398
|
* Entity ID
|
|
9926
10399
|
* example:
|
|
@@ -10624,6 +11097,32 @@ declare namespace Paths {
|
|
|
10624
11097
|
export type $500 = Components.Responses.InternalServerError;
|
|
10625
11098
|
}
|
|
10626
11099
|
}
|
|
11100
|
+
namespace GetPortalWidgetsV3 {
|
|
11101
|
+
namespace Parameters {
|
|
11102
|
+
export type ContractId = /**
|
|
11103
|
+
* Entity ID
|
|
11104
|
+
* example:
|
|
11105
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
11106
|
+
*/
|
|
11107
|
+
Components.Schemas.EntityId /* uuid */;
|
|
11108
|
+
export type PortalId = /**
|
|
11109
|
+
* ID of the portal
|
|
11110
|
+
* example:
|
|
11111
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11112
|
+
*/
|
|
11113
|
+
Components.Schemas.PortalId;
|
|
11114
|
+
}
|
|
11115
|
+
export interface QueryParameters {
|
|
11116
|
+
portal_id: Parameters.PortalId;
|
|
11117
|
+
contract_id?: Parameters.ContractId;
|
|
11118
|
+
}
|
|
11119
|
+
namespace Responses {
|
|
11120
|
+
export type $200 = Components.Schemas.UpsertPortalWidget;
|
|
11121
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11122
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11123
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11124
|
+
}
|
|
11125
|
+
}
|
|
10627
11126
|
namespace GetPrices {
|
|
10628
11127
|
namespace Parameters {
|
|
10629
11128
|
export type AppId = string;
|
|
@@ -10945,6 +11444,70 @@ declare namespace Paths {
|
|
|
10945
11444
|
export type $500 = Components.Responses.InternalServerError;
|
|
10946
11445
|
}
|
|
10947
11446
|
}
|
|
11447
|
+
namespace GetPublicPortalWidgetsV3 {
|
|
11448
|
+
namespace Parameters {
|
|
11449
|
+
export type Domain = string;
|
|
11450
|
+
/**
|
|
11451
|
+
* example:
|
|
11452
|
+
* 12324
|
|
11453
|
+
*/
|
|
11454
|
+
export type OrgId = string;
|
|
11455
|
+
export type PortalId = /**
|
|
11456
|
+
* ID of the portal
|
|
11457
|
+
* example:
|
|
11458
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11459
|
+
*/
|
|
11460
|
+
Components.Schemas.PortalId;
|
|
11461
|
+
}
|
|
11462
|
+
export interface QueryParameters {
|
|
11463
|
+
org_id?: /**
|
|
11464
|
+
* example:
|
|
11465
|
+
* 12324
|
|
11466
|
+
*/
|
|
11467
|
+
Parameters.OrgId;
|
|
11468
|
+
portal_id?: Parameters.PortalId;
|
|
11469
|
+
domain?: Parameters.Domain;
|
|
11470
|
+
}
|
|
11471
|
+
namespace Responses {
|
|
11472
|
+
export type $200 = Components.Schemas.UpsertPortalWidget;
|
|
11473
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11474
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11475
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11476
|
+
}
|
|
11477
|
+
}
|
|
11478
|
+
namespace GetPublicSchemasV3 {
|
|
11479
|
+
namespace Parameters {
|
|
11480
|
+
export type Domain = string;
|
|
11481
|
+
/**
|
|
11482
|
+
* example:
|
|
11483
|
+
* 12324
|
|
11484
|
+
*/
|
|
11485
|
+
export type OrgId = string;
|
|
11486
|
+
export type PortalId = /**
|
|
11487
|
+
* ID of the portal
|
|
11488
|
+
* example:
|
|
11489
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11490
|
+
*/
|
|
11491
|
+
Components.Schemas.PortalId;
|
|
11492
|
+
}
|
|
11493
|
+
export interface QueryParameters {
|
|
11494
|
+
org_id?: /**
|
|
11495
|
+
* example:
|
|
11496
|
+
* 12324
|
|
11497
|
+
*/
|
|
11498
|
+
Parameters.OrgId;
|
|
11499
|
+
portal_id?: Parameters.PortalId;
|
|
11500
|
+
domain?: Parameters.Domain;
|
|
11501
|
+
}
|
|
11502
|
+
namespace Responses {
|
|
11503
|
+
export interface $200 {
|
|
11504
|
+
schemas?: Components.Schemas.Schema[];
|
|
11505
|
+
}
|
|
11506
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11507
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11508
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11509
|
+
}
|
|
11510
|
+
}
|
|
10948
11511
|
namespace GetRecipientsToNotifyOnAutomation {
|
|
10949
11512
|
export interface RequestBody {
|
|
10950
11513
|
/**
|
|
@@ -11448,6 +12011,10 @@ declare namespace Paths {
|
|
|
11448
12011
|
* The portal ID to look up the portal config. When provided, takes precedence over origin.
|
|
11449
12012
|
*/
|
|
11450
12013
|
portal_id?: string;
|
|
12014
|
+
/**
|
|
12015
|
+
* Portal domain for identification. Alternative to portal_id or origin.
|
|
12016
|
+
*/
|
|
12017
|
+
domain?: string;
|
|
11451
12018
|
}
|
|
11452
12019
|
namespace Responses {
|
|
11453
12020
|
export interface $200 {
|
|
@@ -11784,6 +12351,30 @@ declare namespace Paths {
|
|
|
11784
12351
|
export type $500 = Components.Responses.InternalServerError;
|
|
11785
12352
|
}
|
|
11786
12353
|
}
|
|
12354
|
+
namespace SavePortalFilesV3 {
|
|
12355
|
+
namespace Parameters {
|
|
12356
|
+
export type PortalId = /**
|
|
12357
|
+
* ID of the portal
|
|
12358
|
+
* example:
|
|
12359
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
12360
|
+
*/
|
|
12361
|
+
Components.Schemas.PortalId;
|
|
12362
|
+
}
|
|
12363
|
+
export interface QueryParameters {
|
|
12364
|
+
portal_id: Parameters.PortalId;
|
|
12365
|
+
}
|
|
12366
|
+
export type RequestBody = Components.Schemas.SavePortalFile;
|
|
12367
|
+
namespace Responses {
|
|
12368
|
+
export interface $201 {
|
|
12369
|
+
createdFiles?: /* The file entity */ Components.Schemas.File[];
|
|
12370
|
+
}
|
|
12371
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
12372
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
12373
|
+
export type $403 = Components.Responses.Forbidden;
|
|
12374
|
+
export type $404 = Components.Responses.NotFound;
|
|
12375
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12376
|
+
}
|
|
12377
|
+
}
|
|
11787
12378
|
namespace SearchPaymentRelationsInEntities {
|
|
11788
12379
|
namespace Parameters {
|
|
11789
12380
|
export type Id = /**
|
|
@@ -11895,6 +12486,7 @@ declare namespace Paths {
|
|
|
11895
12486
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
11896
12487
|
*/
|
|
11897
12488
|
export type ContactId = string; // uuid
|
|
12489
|
+
export type Domain = string;
|
|
11898
12490
|
/**
|
|
11899
12491
|
* example:
|
|
11900
12492
|
* 123
|
|
@@ -11908,12 +12500,13 @@ declare namespace Paths {
|
|
|
11908
12500
|
Components.Schemas.PortalId;
|
|
11909
12501
|
}
|
|
11910
12502
|
export interface QueryParameters {
|
|
11911
|
-
portal_id
|
|
11912
|
-
org_id
|
|
12503
|
+
portal_id?: Parameters.PortalId;
|
|
12504
|
+
org_id?: /**
|
|
11913
12505
|
* example:
|
|
11914
12506
|
* 123
|
|
11915
12507
|
*/
|
|
11916
12508
|
Parameters.OrgId;
|
|
12509
|
+
domain?: Parameters.Domain;
|
|
11917
12510
|
contact_id?: /**
|
|
11918
12511
|
* example:
|
|
11919
12512
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
@@ -12072,6 +12665,7 @@ declare namespace Paths {
|
|
|
12072
12665
|
}
|
|
12073
12666
|
namespace TriggerEntityAccessEventV3 {
|
|
12074
12667
|
namespace Parameters {
|
|
12668
|
+
export type Domain = string;
|
|
12075
12669
|
export type EntityId = /**
|
|
12076
12670
|
* Entity ID
|
|
12077
12671
|
* example:
|
|
@@ -12099,7 +12693,8 @@ declare namespace Paths {
|
|
|
12099
12693
|
}
|
|
12100
12694
|
export interface QueryParameters {
|
|
12101
12695
|
entity_id?: Parameters.EntityId;
|
|
12102
|
-
portal_id
|
|
12696
|
+
portal_id?: Parameters.PortalId;
|
|
12697
|
+
domain?: Parameters.Domain;
|
|
12103
12698
|
}
|
|
12104
12699
|
namespace Responses {
|
|
12105
12700
|
export interface $200 {
|
|
@@ -12476,6 +13071,27 @@ declare namespace Paths {
|
|
|
12476
13071
|
export type $500 = Components.Responses.InternalServerError;
|
|
12477
13072
|
}
|
|
12478
13073
|
}
|
|
13074
|
+
namespace UpsertPortalWidgetV3 {
|
|
13075
|
+
namespace Parameters {
|
|
13076
|
+
export type PortalId = /**
|
|
13077
|
+
* ID of the portal
|
|
13078
|
+
* example:
|
|
13079
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
13080
|
+
*/
|
|
13081
|
+
Components.Schemas.PortalId;
|
|
13082
|
+
}
|
|
13083
|
+
export interface QueryParameters {
|
|
13084
|
+
portal_id: Parameters.PortalId;
|
|
13085
|
+
}
|
|
13086
|
+
export type RequestBody = Components.Schemas.UpsertPortalWidget;
|
|
13087
|
+
namespace Responses {
|
|
13088
|
+
export type $201 = Components.Schemas.UpsertPortalWidget;
|
|
13089
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
13090
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
13091
|
+
export type $403 = Components.Responses.Forbidden;
|
|
13092
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
13093
|
+
}
|
|
13094
|
+
}
|
|
12479
13095
|
namespace UserExists {
|
|
12480
13096
|
namespace Parameters {
|
|
12481
13097
|
/**
|
|
@@ -12521,6 +13137,7 @@ declare namespace Paths {
|
|
|
12521
13137
|
}
|
|
12522
13138
|
namespace UserExistsV3 {
|
|
12523
13139
|
namespace Parameters {
|
|
13140
|
+
export type Domain = string;
|
|
12524
13141
|
/**
|
|
12525
13142
|
* Email Address of the portal user
|
|
12526
13143
|
* example:
|
|
@@ -12528,7 +13145,7 @@ declare namespace Paths {
|
|
|
12528
13145
|
*/
|
|
12529
13146
|
export type Email = string;
|
|
12530
13147
|
/**
|
|
12531
|
-
* Organization ID
|
|
13148
|
+
* Organization ID (required if domain is not provided)
|
|
12532
13149
|
* example:
|
|
12533
13150
|
* 123
|
|
12534
13151
|
*/
|
|
@@ -12547,13 +13164,14 @@ declare namespace Paths {
|
|
|
12547
13164
|
* user@example.com
|
|
12548
13165
|
*/
|
|
12549
13166
|
Parameters.Email;
|
|
12550
|
-
org_id
|
|
12551
|
-
* Organization ID
|
|
13167
|
+
org_id?: /**
|
|
13168
|
+
* Organization ID (required if domain is not provided)
|
|
12552
13169
|
* example:
|
|
12553
13170
|
* 123
|
|
12554
13171
|
*/
|
|
12555
13172
|
Parameters.OrgId;
|
|
12556
13173
|
portal_id?: Parameters.PortalId;
|
|
13174
|
+
domain?: Parameters.Domain;
|
|
12557
13175
|
}
|
|
12558
13176
|
namespace Responses {
|
|
12559
13177
|
export interface $200 {
|
|
@@ -12760,7 +13378,6 @@ declare namespace Paths {
|
|
|
12760
13378
|
}
|
|
12761
13379
|
}
|
|
12762
13380
|
|
|
12763
|
-
|
|
12764
13381
|
export interface OperationMethods {
|
|
12765
13382
|
/**
|
|
12766
13383
|
* upsertPortal - upsertPortal
|
|
@@ -12785,7 +13402,11 @@ export interface OperationMethods {
|
|
|
12785
13402
|
/**
|
|
12786
13403
|
* createUserV3 - createUserV3
|
|
12787
13404
|
*
|
|
12788
|
-
* Registers a portal user
|
|
13405
|
+
* Registers a portal user.
|
|
13406
|
+
* Supports two identification methods:
|
|
13407
|
+
* 1. Using portal_id
|
|
13408
|
+
* 2. Using domain
|
|
13409
|
+
*
|
|
12789
13410
|
*/
|
|
12790
13411
|
'createUserV3'(
|
|
12791
13412
|
parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
|
|
@@ -13066,6 +13687,20 @@ export interface OperationMethods {
|
|
|
13066
13687
|
data?: any,
|
|
13067
13688
|
config?: AxiosRequestConfig
|
|
13068
13689
|
): OperationResponse<Paths.GetPublicPortalWidgets.Responses.$200>
|
|
13690
|
+
/**
|
|
13691
|
+
* getPublicPortalWidgetsV3 - getPublicPortalWidgetsV3
|
|
13692
|
+
*
|
|
13693
|
+
* Retrieves the public widgets of a portal.
|
|
13694
|
+
* Supports two identification methods:
|
|
13695
|
+
* 1. Using org_id + portal_id
|
|
13696
|
+
* 2. Using domain
|
|
13697
|
+
*
|
|
13698
|
+
*/
|
|
13699
|
+
'getPublicPortalWidgetsV3'(
|
|
13700
|
+
parameters?: Parameters<Paths.GetPublicPortalWidgetsV3.QueryParameters> | null,
|
|
13701
|
+
data?: any,
|
|
13702
|
+
config?: AxiosRequestConfig
|
|
13703
|
+
): OperationResponse<Paths.GetPublicPortalWidgetsV3.Responses.$200>
|
|
13069
13704
|
/**
|
|
13070
13705
|
* getPortalWidgets - getPortalWidgets
|
|
13071
13706
|
*
|
|
@@ -13086,6 +13721,36 @@ export interface OperationMethods {
|
|
|
13086
13721
|
data?: Paths.UpsertPortalWidget.RequestBody,
|
|
13087
13722
|
config?: AxiosRequestConfig
|
|
13088
13723
|
): OperationResponse<Paths.UpsertPortalWidget.Responses.$201>
|
|
13724
|
+
/**
|
|
13725
|
+
* getPortalWidgetsV3 - getPortalWidgetsV3
|
|
13726
|
+
*
|
|
13727
|
+
* Retrieves the widgets of a portal by portal_id.
|
|
13728
|
+
*/
|
|
13729
|
+
'getPortalWidgetsV3'(
|
|
13730
|
+
parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
|
|
13731
|
+
data?: any,
|
|
13732
|
+
config?: AxiosRequestConfig
|
|
13733
|
+
): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
|
|
13734
|
+
/**
|
|
13735
|
+
* upsertPortalWidgetV3 - upsertPortalWidgetV3
|
|
13736
|
+
*
|
|
13737
|
+
* Upsert widget for a portal by portal_id.
|
|
13738
|
+
*/
|
|
13739
|
+
'upsertPortalWidgetV3'(
|
|
13740
|
+
parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
|
|
13741
|
+
data?: Paths.UpsertPortalWidgetV3.RequestBody,
|
|
13742
|
+
config?: AxiosRequestConfig
|
|
13743
|
+
): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
|
|
13744
|
+
/**
|
|
13745
|
+
* savePortalFilesV3 - savePortalFilesV3
|
|
13746
|
+
*
|
|
13747
|
+
* Add files to portal by portal_id
|
|
13748
|
+
*/
|
|
13749
|
+
'savePortalFilesV3'(
|
|
13750
|
+
parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
|
|
13751
|
+
data?: Paths.SavePortalFilesV3.RequestBody,
|
|
13752
|
+
config?: AxiosRequestConfig
|
|
13753
|
+
): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
|
|
13089
13754
|
/**
|
|
13090
13755
|
* replaceECPTemplateVariables - replaceECPTemplateVariables
|
|
13091
13756
|
*
|
|
@@ -13126,6 +13791,20 @@ export interface OperationMethods {
|
|
|
13126
13791
|
data?: any,
|
|
13127
13792
|
config?: AxiosRequestConfig
|
|
13128
13793
|
): OperationResponse<Paths.GetSchemasByDomain.Responses.$200>
|
|
13794
|
+
/**
|
|
13795
|
+
* getPublicSchemasV3 - getPublicSchemasV3
|
|
13796
|
+
*
|
|
13797
|
+
* Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.
|
|
13798
|
+
* Supports two identification methods:
|
|
13799
|
+
* 1. Using org_id + portal_id
|
|
13800
|
+
* 2. Using domain
|
|
13801
|
+
*
|
|
13802
|
+
*/
|
|
13803
|
+
'getPublicSchemasV3'(
|
|
13804
|
+
parameters?: Parameters<Paths.GetPublicSchemasV3.QueryParameters> | null,
|
|
13805
|
+
data?: any,
|
|
13806
|
+
config?: AxiosRequestConfig
|
|
13807
|
+
): OperationResponse<Paths.GetPublicSchemasV3.Responses.$200>
|
|
13129
13808
|
/**
|
|
13130
13809
|
* getOrganizationSettingsByDomain - getOrganizationSettingsByDomain
|
|
13131
13810
|
*
|
|
@@ -13210,6 +13889,10 @@ export interface OperationMethods {
|
|
|
13210
13889
|
* checkContactExistsV3 - checkContactExistsV3
|
|
13211
13890
|
*
|
|
13212
13891
|
* True if contact with given identifiers exists.
|
|
13892
|
+
* Supports two identification methods:
|
|
13893
|
+
* 1. Using portal_id
|
|
13894
|
+
* 2. Using domain
|
|
13895
|
+
*
|
|
13213
13896
|
*/
|
|
13214
13897
|
'checkContactExistsV3'(
|
|
13215
13898
|
parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
|
|
@@ -13319,7 +14002,11 @@ export interface OperationMethods {
|
|
|
13319
14002
|
/**
|
|
13320
14003
|
* userExistsV3 - userExistsV3
|
|
13321
14004
|
*
|
|
13322
|
-
* Checks whether a user exists in the portal
|
|
14005
|
+
* Checks whether a user exists in the portal.
|
|
14006
|
+
* Supports two identification methods:
|
|
14007
|
+
* 1. Using org_id + portal_id
|
|
14008
|
+
* 2. Using domain
|
|
14009
|
+
*
|
|
13323
14010
|
*/
|
|
13324
14011
|
'userExistsV3'(
|
|
13325
14012
|
parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
|
|
@@ -13666,6 +14353,11 @@ export interface OperationMethods {
|
|
|
13666
14353
|
*
|
|
13667
14354
|
* Token is valid for 5 minutes.
|
|
13668
14355
|
*
|
|
14356
|
+
* Supports three identification methods (at least one required):
|
|
14357
|
+
* 1. Using portal_id (takes precedence)
|
|
14358
|
+
* 2. Using domain
|
|
14359
|
+
* 3. Using origin (legacy)
|
|
14360
|
+
*
|
|
13669
14361
|
*/
|
|
13670
14362
|
'loginToPortalAsUser'(
|
|
13671
14363
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -13685,7 +14377,11 @@ export interface OperationMethods {
|
|
|
13685
14377
|
/**
|
|
13686
14378
|
* triggerEntityAccessEventV3 - triggerEntityAccessEventV3
|
|
13687
14379
|
*
|
|
13688
|
-
* Trigger entity access event for a portal user
|
|
14380
|
+
* Trigger entity access event for a portal user.
|
|
14381
|
+
* Supports two identification methods:
|
|
14382
|
+
* 1. Using portal_id
|
|
14383
|
+
* 2. Using domain
|
|
14384
|
+
*
|
|
13689
14385
|
*/
|
|
13690
14386
|
'triggerEntityAccessEventV3'(
|
|
13691
14387
|
parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
|
|
@@ -13773,8 +14469,8 @@ export interface OperationMethods {
|
|
|
13773
14469
|
config?: AxiosRequestConfig
|
|
13774
14470
|
): OperationResponse<Paths.CreateMeterReading.Responses.$200>
|
|
13775
14471
|
/**
|
|
13776
|
-
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
13777
|
-
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
14472
|
+
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
14473
|
+
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
13778
14474
|
* a plausibility check hook to be configured for the portal.
|
|
13779
14475
|
*
|
|
13780
14476
|
*/
|
|
@@ -13805,7 +14501,11 @@ export interface OperationMethods {
|
|
|
13805
14501
|
*
|
|
13806
14502
|
* Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
|
|
13807
14503
|
*
|
|
13808
|
-
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito
|
|
14504
|
+
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
|
|
14505
|
+
*
|
|
14506
|
+
* Supports two identification methods:
|
|
14507
|
+
* 1. Using org_id + portal_id
|
|
14508
|
+
* 2. Using domain
|
|
13809
14509
|
*
|
|
13810
14510
|
*/
|
|
13811
14511
|
'ssoLoginV3'(
|
|
@@ -14168,7 +14868,11 @@ export interface PathsDictionary {
|
|
|
14168
14868
|
/**
|
|
14169
14869
|
* createUserV3 - createUserV3
|
|
14170
14870
|
*
|
|
14171
|
-
* Registers a portal user
|
|
14871
|
+
* Registers a portal user.
|
|
14872
|
+
* Supports two identification methods:
|
|
14873
|
+
* 1. Using portal_id
|
|
14874
|
+
* 2. Using domain
|
|
14875
|
+
*
|
|
14172
14876
|
*/
|
|
14173
14877
|
'post'(
|
|
14174
14878
|
parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
|
|
@@ -14498,6 +15202,22 @@ export interface PathsDictionary {
|
|
|
14498
15202
|
config?: AxiosRequestConfig
|
|
14499
15203
|
): OperationResponse<Paths.GetPublicPortalWidgets.Responses.$200>
|
|
14500
15204
|
}
|
|
15205
|
+
['/v3/portal/public/widgets']: {
|
|
15206
|
+
/**
|
|
15207
|
+
* getPublicPortalWidgetsV3 - getPublicPortalWidgetsV3
|
|
15208
|
+
*
|
|
15209
|
+
* Retrieves the public widgets of a portal.
|
|
15210
|
+
* Supports two identification methods:
|
|
15211
|
+
* 1. Using org_id + portal_id
|
|
15212
|
+
* 2. Using domain
|
|
15213
|
+
*
|
|
15214
|
+
*/
|
|
15215
|
+
'get'(
|
|
15216
|
+
parameters?: Parameters<Paths.GetPublicPortalWidgetsV3.QueryParameters> | null,
|
|
15217
|
+
data?: any,
|
|
15218
|
+
config?: AxiosRequestConfig
|
|
15219
|
+
): OperationResponse<Paths.GetPublicPortalWidgetsV3.Responses.$200>
|
|
15220
|
+
}
|
|
14501
15221
|
['/v2/portal/widgets']: {
|
|
14502
15222
|
/**
|
|
14503
15223
|
* upsertPortalWidget - upsertPortalWidget
|
|
@@ -14520,6 +15240,40 @@ export interface PathsDictionary {
|
|
|
14520
15240
|
config?: AxiosRequestConfig
|
|
14521
15241
|
): OperationResponse<Paths.GetPortalWidgets.Responses.$200>
|
|
14522
15242
|
}
|
|
15243
|
+
['/v3/portal/widgets']: {
|
|
15244
|
+
/**
|
|
15245
|
+
* getPortalWidgetsV3 - getPortalWidgetsV3
|
|
15246
|
+
*
|
|
15247
|
+
* Retrieves the widgets of a portal by portal_id.
|
|
15248
|
+
*/
|
|
15249
|
+
'get'(
|
|
15250
|
+
parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
|
|
15251
|
+
data?: any,
|
|
15252
|
+
config?: AxiosRequestConfig
|
|
15253
|
+
): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
|
|
15254
|
+
/**
|
|
15255
|
+
* upsertPortalWidgetV3 - upsertPortalWidgetV3
|
|
15256
|
+
*
|
|
15257
|
+
* Upsert widget for a portal by portal_id.
|
|
15258
|
+
*/
|
|
15259
|
+
'post'(
|
|
15260
|
+
parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
|
|
15261
|
+
data?: Paths.UpsertPortalWidgetV3.RequestBody,
|
|
15262
|
+
config?: AxiosRequestConfig
|
|
15263
|
+
): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
|
|
15264
|
+
}
|
|
15265
|
+
['/v3/portal/portal/files']: {
|
|
15266
|
+
/**
|
|
15267
|
+
* savePortalFilesV3 - savePortalFilesV3
|
|
15268
|
+
*
|
|
15269
|
+
* Add files to portal by portal_id
|
|
15270
|
+
*/
|
|
15271
|
+
'post'(
|
|
15272
|
+
parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
|
|
15273
|
+
data?: Paths.SavePortalFilesV3.RequestBody,
|
|
15274
|
+
config?: AxiosRequestConfig
|
|
15275
|
+
): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
|
|
15276
|
+
}
|
|
14523
15277
|
['/v2/portal/replace-ecp-template-variables']: {
|
|
14524
15278
|
/**
|
|
14525
15279
|
* replaceECPTemplateVariables - replaceECPTemplateVariables
|
|
@@ -14568,6 +15322,22 @@ export interface PathsDictionary {
|
|
|
14568
15322
|
config?: AxiosRequestConfig
|
|
14569
15323
|
): OperationResponse<Paths.GetSchemasByDomain.Responses.$200>
|
|
14570
15324
|
}
|
|
15325
|
+
['/v3/portal/public/schemas']: {
|
|
15326
|
+
/**
|
|
15327
|
+
* getPublicSchemasV3 - getPublicSchemasV3
|
|
15328
|
+
*
|
|
15329
|
+
* Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.
|
|
15330
|
+
* Supports two identification methods:
|
|
15331
|
+
* 1. Using org_id + portal_id
|
|
15332
|
+
* 2. Using domain
|
|
15333
|
+
*
|
|
15334
|
+
*/
|
|
15335
|
+
'get'(
|
|
15336
|
+
parameters?: Parameters<Paths.GetPublicSchemasV3.QueryParameters> | null,
|
|
15337
|
+
data?: any,
|
|
15338
|
+
config?: AxiosRequestConfig
|
|
15339
|
+
): OperationResponse<Paths.GetPublicSchemasV3.Responses.$200>
|
|
15340
|
+
}
|
|
14571
15341
|
['/v2/portal/public/org/settings']: {
|
|
14572
15342
|
/**
|
|
14573
15343
|
* getOrganizationSettingsByDomain - getOrganizationSettingsByDomain
|
|
@@ -14667,6 +15437,10 @@ export interface PathsDictionary {
|
|
|
14667
15437
|
* checkContactExistsV3 - checkContactExistsV3
|
|
14668
15438
|
*
|
|
14669
15439
|
* True if contact with given identifiers exists.
|
|
15440
|
+
* Supports two identification methods:
|
|
15441
|
+
* 1. Using portal_id
|
|
15442
|
+
* 2. Using domain
|
|
15443
|
+
*
|
|
14670
15444
|
*/
|
|
14671
15445
|
'post'(
|
|
14672
15446
|
parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
|
|
@@ -14794,7 +15568,11 @@ export interface PathsDictionary {
|
|
|
14794
15568
|
/**
|
|
14795
15569
|
* userExistsV3 - userExistsV3
|
|
14796
15570
|
*
|
|
14797
|
-
* Checks whether a user exists in the portal
|
|
15571
|
+
* Checks whether a user exists in the portal.
|
|
15572
|
+
* Supports two identification methods:
|
|
15573
|
+
* 1. Using org_id + portal_id
|
|
15574
|
+
* 2. Using domain
|
|
15575
|
+
*
|
|
14798
15576
|
*/
|
|
14799
15577
|
'get'(
|
|
14800
15578
|
parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
|
|
@@ -15201,6 +15979,11 @@ export interface PathsDictionary {
|
|
|
15201
15979
|
*
|
|
15202
15980
|
* Token is valid for 5 minutes.
|
|
15203
15981
|
*
|
|
15982
|
+
* Supports three identification methods (at least one required):
|
|
15983
|
+
* 1. Using portal_id (takes precedence)
|
|
15984
|
+
* 2. Using domain
|
|
15985
|
+
* 3. Using origin (legacy)
|
|
15986
|
+
*
|
|
15204
15987
|
*/
|
|
15205
15988
|
'post'(
|
|
15206
15989
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -15224,7 +16007,11 @@ export interface PathsDictionary {
|
|
|
15224
16007
|
/**
|
|
15225
16008
|
* triggerEntityAccessEventV3 - triggerEntityAccessEventV3
|
|
15226
16009
|
*
|
|
15227
|
-
* Trigger entity access event for a portal user
|
|
16010
|
+
* Trigger entity access event for a portal user.
|
|
16011
|
+
* Supports two identification methods:
|
|
16012
|
+
* 1. Using portal_id
|
|
16013
|
+
* 2. Using domain
|
|
16014
|
+
*
|
|
15228
16015
|
*/
|
|
15229
16016
|
'post'(
|
|
15230
16017
|
parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
|
|
@@ -15330,8 +16117,8 @@ export interface PathsDictionary {
|
|
|
15330
16117
|
}
|
|
15331
16118
|
['/v2/portal/metering/reading/allowed-range/{meter_id}']: {
|
|
15332
16119
|
/**
|
|
15333
|
-
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
15334
|
-
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
16120
|
+
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
16121
|
+
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
15335
16122
|
* a plausibility check hook to be configured for the portal.
|
|
15336
16123
|
*
|
|
15337
16124
|
*/
|
|
@@ -15366,7 +16153,11 @@ export interface PathsDictionary {
|
|
|
15366
16153
|
*
|
|
15367
16154
|
* Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
|
|
15368
16155
|
*
|
|
15369
|
-
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito
|
|
16156
|
+
* Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
|
|
16157
|
+
*
|
|
16158
|
+
* Supports two identification methods:
|
|
16159
|
+
* 1. Using org_id + portal_id
|
|
16160
|
+
* 2. Using domain
|
|
15370
16161
|
*
|
|
15371
16162
|
*/
|
|
15372
16163
|
'post'(
|
|
@@ -15751,7 +16542,6 @@ export interface PathsDictionary {
|
|
|
15751
16542
|
|
|
15752
16543
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
15753
16544
|
|
|
15754
|
-
|
|
15755
16545
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
15756
16546
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
15757
16547
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
@@ -15791,6 +16581,7 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
15791
16581
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
15792
16582
|
export type Direction = Components.Schemas.Direction;
|
|
15793
16583
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
16584
|
+
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
15794
16585
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
15795
16586
|
export type Entity = Components.Schemas.Entity;
|
|
15796
16587
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|