@epilot/customer-portal-client 0.36.0 → 0.38.1
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/LICENSE +21 -0
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +71 -0
- package/dist/openapi.d.ts +633 -5
- package/package.json +14 -15
- package/src/openapi-runtime.json +71 -0
- package/src/openapi.d.ts +16729 -0
- package/src/openapi.json +373 -4
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
|
*/
|
|
@@ -1727,6 +1769,27 @@ declare namespace Components {
|
|
|
1727
1769
|
* 2021-02-09T12:41:43.662Z
|
|
1728
1770
|
*/
|
|
1729
1771
|
_updated_at: string; // date-time
|
|
1772
|
+
/**
|
|
1773
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
1774
|
+
*/
|
|
1775
|
+
templates_output_highlighted?: {
|
|
1776
|
+
[name: string]: string | {
|
|
1777
|
+
[name: string]: string;
|
|
1778
|
+
};
|
|
1779
|
+
};
|
|
1780
|
+
/**
|
|
1781
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
1782
|
+
*/
|
|
1783
|
+
search_snippets?: {
|
|
1784
|
+
/**
|
|
1785
|
+
* Human-readable field label
|
|
1786
|
+
*/
|
|
1787
|
+
field?: string;
|
|
1788
|
+
/**
|
|
1789
|
+
* Highlighted text fragment with <em> tags
|
|
1790
|
+
*/
|
|
1791
|
+
fragment?: string;
|
|
1792
|
+
}[];
|
|
1730
1793
|
_schema: "contact";
|
|
1731
1794
|
}
|
|
1732
1795
|
export interface ContactCountRequest {
|
|
@@ -1857,6 +1920,27 @@ declare namespace Components {
|
|
|
1857
1920
|
* 2021-02-09T12:41:43.662Z
|
|
1858
1921
|
*/
|
|
1859
1922
|
_updated_at: string; // date-time
|
|
1923
|
+
/**
|
|
1924
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
1925
|
+
*/
|
|
1926
|
+
templates_output_highlighted?: {
|
|
1927
|
+
[name: string]: string | {
|
|
1928
|
+
[name: string]: string;
|
|
1929
|
+
};
|
|
1930
|
+
};
|
|
1931
|
+
/**
|
|
1932
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
1933
|
+
*/
|
|
1934
|
+
search_snippets?: {
|
|
1935
|
+
/**
|
|
1936
|
+
* Human-readable field label
|
|
1937
|
+
*/
|
|
1938
|
+
field?: string;
|
|
1939
|
+
/**
|
|
1940
|
+
* Highlighted text fragment with <em> tags
|
|
1941
|
+
*/
|
|
1942
|
+
fragment?: string;
|
|
1943
|
+
}[];
|
|
1860
1944
|
/**
|
|
1861
1945
|
* The name of the contract.
|
|
1862
1946
|
* example:
|
|
@@ -2267,6 +2351,27 @@ declare namespace Components {
|
|
|
2267
2351
|
}
|
|
2268
2352
|
export interface Entity {
|
|
2269
2353
|
[name: string]: any;
|
|
2354
|
+
/**
|
|
2355
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
2356
|
+
*/
|
|
2357
|
+
templates_output_highlighted?: {
|
|
2358
|
+
[name: string]: string | {
|
|
2359
|
+
[name: string]: string;
|
|
2360
|
+
};
|
|
2361
|
+
};
|
|
2362
|
+
/**
|
|
2363
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
2364
|
+
*/
|
|
2365
|
+
search_snippets?: {
|
|
2366
|
+
/**
|
|
2367
|
+
* Human-readable field label
|
|
2368
|
+
*/
|
|
2369
|
+
field?: string;
|
|
2370
|
+
/**
|
|
2371
|
+
* Highlighted text fragment with <em> tags
|
|
2372
|
+
*/
|
|
2373
|
+
fragment?: string;
|
|
2374
|
+
}[];
|
|
2270
2375
|
}
|
|
2271
2376
|
export interface EntityEditRule {
|
|
2272
2377
|
slug?: /**
|
|
@@ -2456,6 +2561,27 @@ declare namespace Components {
|
|
|
2456
2561
|
* 2021-02-09T12:41:43.662Z
|
|
2457
2562
|
*/
|
|
2458
2563
|
_updated_at: string; // date-time
|
|
2564
|
+
/**
|
|
2565
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
2566
|
+
*/
|
|
2567
|
+
templates_output_highlighted?: {
|
|
2568
|
+
[name: string]: string | {
|
|
2569
|
+
[name: string]: string;
|
|
2570
|
+
};
|
|
2571
|
+
};
|
|
2572
|
+
/**
|
|
2573
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
2574
|
+
*/
|
|
2575
|
+
search_snippets?: {
|
|
2576
|
+
/**
|
|
2577
|
+
* Human-readable field label
|
|
2578
|
+
*/
|
|
2579
|
+
field?: string;
|
|
2580
|
+
/**
|
|
2581
|
+
* Highlighted text fragment with <em> tags
|
|
2582
|
+
*/
|
|
2583
|
+
fragment?: string;
|
|
2584
|
+
}[];
|
|
2459
2585
|
/**
|
|
2460
2586
|
* Resolved template strings corresponding to the templates parameter. Supports both string values and nested objects of strings.
|
|
2461
2587
|
* example:
|
|
@@ -2793,6 +2919,12 @@ declare namespace Components {
|
|
|
2793
2919
|
* ]
|
|
2794
2920
|
*/
|
|
2795
2921
|
include?: ("active_workflow")[];
|
|
2922
|
+
/**
|
|
2923
|
+
* 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.
|
|
2924
|
+
*/
|
|
2925
|
+
highlight?: {
|
|
2926
|
+
[key: string]: any;
|
|
2927
|
+
};
|
|
2796
2928
|
}
|
|
2797
2929
|
/**
|
|
2798
2930
|
* URL-friendly identifier for the entity schema
|
|
@@ -3660,6 +3792,27 @@ declare namespace Components {
|
|
|
3660
3792
|
* 2021-02-09T12:41:43.662Z
|
|
3661
3793
|
*/
|
|
3662
3794
|
_updated_at: string; // date-time
|
|
3795
|
+
/**
|
|
3796
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
3797
|
+
*/
|
|
3798
|
+
templates_output_highlighted?: {
|
|
3799
|
+
[name: string]: string | {
|
|
3800
|
+
[name: string]: string;
|
|
3801
|
+
};
|
|
3802
|
+
};
|
|
3803
|
+
/**
|
|
3804
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
3805
|
+
*/
|
|
3806
|
+
search_snippets?: {
|
|
3807
|
+
/**
|
|
3808
|
+
* Human-readable field label
|
|
3809
|
+
*/
|
|
3810
|
+
field?: string;
|
|
3811
|
+
/**
|
|
3812
|
+
* Highlighted text fragment with <em> tags
|
|
3813
|
+
*/
|
|
3814
|
+
fragment?: string;
|
|
3815
|
+
}[];
|
|
3663
3816
|
_schema: "file";
|
|
3664
3817
|
}
|
|
3665
3818
|
/**
|
|
@@ -3706,6 +3859,27 @@ declare namespace Components {
|
|
|
3706
3859
|
* 2021-02-09T12:41:43.662Z
|
|
3707
3860
|
*/
|
|
3708
3861
|
_updated_at: string; // date-time
|
|
3862
|
+
/**
|
|
3863
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
3864
|
+
*/
|
|
3865
|
+
templates_output_highlighted?: {
|
|
3866
|
+
[name: string]: string | {
|
|
3867
|
+
[name: string]: string;
|
|
3868
|
+
};
|
|
3869
|
+
};
|
|
3870
|
+
/**
|
|
3871
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
3872
|
+
*/
|
|
3873
|
+
search_snippets?: {
|
|
3874
|
+
/**
|
|
3875
|
+
* Human-readable field label
|
|
3876
|
+
*/
|
|
3877
|
+
field?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* Highlighted text fragment with <em> tags
|
|
3880
|
+
*/
|
|
3881
|
+
fragment?: string;
|
|
3882
|
+
}[];
|
|
3709
3883
|
_schema: "file";
|
|
3710
3884
|
/**
|
|
3711
3885
|
* example:
|
|
@@ -3836,6 +4010,27 @@ declare namespace Components {
|
|
|
3836
4010
|
* 2021-02-09T12:41:43.662Z
|
|
3837
4011
|
*/
|
|
3838
4012
|
_updated_at: string; // date-time
|
|
4013
|
+
/**
|
|
4014
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4015
|
+
*/
|
|
4016
|
+
templates_output_highlighted?: {
|
|
4017
|
+
[name: string]: string | {
|
|
4018
|
+
[name: string]: string;
|
|
4019
|
+
};
|
|
4020
|
+
};
|
|
4021
|
+
/**
|
|
4022
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4023
|
+
*/
|
|
4024
|
+
search_snippets?: {
|
|
4025
|
+
/**
|
|
4026
|
+
* Human-readable field label
|
|
4027
|
+
*/
|
|
4028
|
+
field?: string;
|
|
4029
|
+
/**
|
|
4030
|
+
* Highlighted text fragment with <em> tags
|
|
4031
|
+
*/
|
|
4032
|
+
fragment?: string;
|
|
4033
|
+
}[];
|
|
3839
4034
|
/**
|
|
3840
4035
|
* Amount to be paid in cents i.e. precision 2
|
|
3841
4036
|
* example:
|
|
@@ -3945,6 +4140,27 @@ declare namespace Components {
|
|
|
3945
4140
|
* 2021-02-09T12:41:43.662Z
|
|
3946
4141
|
*/
|
|
3947
4142
|
_updated_at: string; // date-time
|
|
4143
|
+
/**
|
|
4144
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4145
|
+
*/
|
|
4146
|
+
templates_output_highlighted?: {
|
|
4147
|
+
[name: string]: string | {
|
|
4148
|
+
[name: string]: string;
|
|
4149
|
+
};
|
|
4150
|
+
};
|
|
4151
|
+
/**
|
|
4152
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4153
|
+
*/
|
|
4154
|
+
search_snippets?: {
|
|
4155
|
+
/**
|
|
4156
|
+
* Human-readable field label
|
|
4157
|
+
*/
|
|
4158
|
+
field?: string;
|
|
4159
|
+
/**
|
|
4160
|
+
* Highlighted text fragment with <em> tags
|
|
4161
|
+
*/
|
|
4162
|
+
fragment?: string;
|
|
4163
|
+
}[];
|
|
3948
4164
|
_schema: "meter";
|
|
3949
4165
|
}
|
|
3950
4166
|
export interface MeterChartWidget {
|
|
@@ -4277,6 +4493,27 @@ declare namespace Components {
|
|
|
4277
4493
|
* 2021-02-09T12:41:43.662Z
|
|
4278
4494
|
*/
|
|
4279
4495
|
_updated_at: string; // date-time
|
|
4496
|
+
/**
|
|
4497
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4498
|
+
*/
|
|
4499
|
+
templates_output_highlighted?: {
|
|
4500
|
+
[name: string]: string | {
|
|
4501
|
+
[name: string]: string;
|
|
4502
|
+
};
|
|
4503
|
+
};
|
|
4504
|
+
/**
|
|
4505
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4506
|
+
*/
|
|
4507
|
+
search_snippets?: {
|
|
4508
|
+
/**
|
|
4509
|
+
* Human-readable field label
|
|
4510
|
+
*/
|
|
4511
|
+
field?: string;
|
|
4512
|
+
/**
|
|
4513
|
+
* Highlighted text fragment with <em> tags
|
|
4514
|
+
*/
|
|
4515
|
+
fragment?: string;
|
|
4516
|
+
}[];
|
|
4280
4517
|
_schema: "opportunity";
|
|
4281
4518
|
}
|
|
4282
4519
|
/**
|
|
@@ -4323,6 +4560,27 @@ declare namespace Components {
|
|
|
4323
4560
|
* 2021-02-09T12:41:43.662Z
|
|
4324
4561
|
*/
|
|
4325
4562
|
_updated_at: string; // date-time
|
|
4563
|
+
/**
|
|
4564
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
4565
|
+
*/
|
|
4566
|
+
templates_output_highlighted?: {
|
|
4567
|
+
[name: string]: string | {
|
|
4568
|
+
[name: string]: string;
|
|
4569
|
+
};
|
|
4570
|
+
};
|
|
4571
|
+
/**
|
|
4572
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
4573
|
+
*/
|
|
4574
|
+
search_snippets?: {
|
|
4575
|
+
/**
|
|
4576
|
+
* Human-readable field label
|
|
4577
|
+
*/
|
|
4578
|
+
field?: string;
|
|
4579
|
+
/**
|
|
4580
|
+
* Highlighted text fragment with <em> tags
|
|
4581
|
+
*/
|
|
4582
|
+
fragment?: string;
|
|
4583
|
+
}[];
|
|
4326
4584
|
_schema: "order";
|
|
4327
4585
|
}
|
|
4328
4586
|
export interface OrganizationSettings {
|
|
@@ -5735,6 +5993,27 @@ declare namespace Components {
|
|
|
5735
5993
|
* 2021-02-09T12:41:43.662Z
|
|
5736
5994
|
*/
|
|
5737
5995
|
_updated_at: string; // date-time
|
|
5996
|
+
/**
|
|
5997
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
5998
|
+
*/
|
|
5999
|
+
templates_output_highlighted?: {
|
|
6000
|
+
[name: string]: string | {
|
|
6001
|
+
[name: string]: string;
|
|
6002
|
+
};
|
|
6003
|
+
};
|
|
6004
|
+
/**
|
|
6005
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6006
|
+
*/
|
|
6007
|
+
search_snippets?: {
|
|
6008
|
+
/**
|
|
6009
|
+
* Human-readable field label
|
|
6010
|
+
*/
|
|
6011
|
+
field?: string;
|
|
6012
|
+
/**
|
|
6013
|
+
* Highlighted text fragment with <em> tags
|
|
6014
|
+
*/
|
|
6015
|
+
fragment?: string;
|
|
6016
|
+
}[];
|
|
5738
6017
|
_schema: "portal_user";
|
|
5739
6018
|
}
|
|
5740
6019
|
export type PortalUserRegistrationStatus = "Registration Pending" | "Confirmation Email Sent" | "Registered" | "Email Update In Progress";
|
|
@@ -5783,6 +6062,27 @@ declare namespace Components {
|
|
|
5783
6062
|
* 2021-02-09T12:41:43.662Z
|
|
5784
6063
|
*/
|
|
5785
6064
|
_updated_at: string; // date-time
|
|
6065
|
+
/**
|
|
6066
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
6067
|
+
*/
|
|
6068
|
+
templates_output_highlighted?: {
|
|
6069
|
+
[name: string]: string | {
|
|
6070
|
+
[name: string]: string;
|
|
6071
|
+
};
|
|
6072
|
+
};
|
|
6073
|
+
/**
|
|
6074
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6075
|
+
*/
|
|
6076
|
+
search_snippets?: {
|
|
6077
|
+
/**
|
|
6078
|
+
* Human-readable field label
|
|
6079
|
+
*/
|
|
6080
|
+
field?: string;
|
|
6081
|
+
/**
|
|
6082
|
+
* Highlighted text fragment with <em> tags
|
|
6083
|
+
*/
|
|
6084
|
+
fragment?: string;
|
|
6085
|
+
}[];
|
|
5786
6086
|
_schema: "product";
|
|
5787
6087
|
}
|
|
5788
6088
|
export interface ProductRecommendationsWidget {
|
|
@@ -5997,6 +6297,27 @@ declare namespace Components {
|
|
|
5997
6297
|
* 2021-02-09T12:41:43.662Z
|
|
5998
6298
|
*/
|
|
5999
6299
|
_updated_at: string; // date-time
|
|
6300
|
+
/**
|
|
6301
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
6302
|
+
*/
|
|
6303
|
+
templates_output_highlighted?: {
|
|
6304
|
+
[name: string]: string | {
|
|
6305
|
+
[name: string]: string;
|
|
6306
|
+
};
|
|
6307
|
+
};
|
|
6308
|
+
/**
|
|
6309
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
6310
|
+
*/
|
|
6311
|
+
search_snippets?: {
|
|
6312
|
+
/**
|
|
6313
|
+
* Human-readable field label
|
|
6314
|
+
*/
|
|
6315
|
+
field?: string;
|
|
6316
|
+
/**
|
|
6317
|
+
* Highlighted text fragment with <em> tags
|
|
6318
|
+
*/
|
|
6319
|
+
fragment?: string;
|
|
6320
|
+
}[];
|
|
6000
6321
|
/**
|
|
6001
6322
|
* Amount to be paid in cents i.e. precision 2
|
|
6002
6323
|
* example:
|
|
@@ -7541,6 +7862,28 @@ declare namespace Paths {
|
|
|
7541
7862
|
export type $500 = Components.Responses.InternalServerError;
|
|
7542
7863
|
}
|
|
7543
7864
|
}
|
|
7865
|
+
namespace ClonePortalConfig {
|
|
7866
|
+
export interface RequestBody {
|
|
7867
|
+
source_portal_id: /**
|
|
7868
|
+
* ID of the portal
|
|
7869
|
+
* example:
|
|
7870
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
7871
|
+
*/
|
|
7872
|
+
Components.Schemas.PortalId;
|
|
7873
|
+
/**
|
|
7874
|
+
* Name for the cloned portal. Defaults to "Copy of <source portal name>".
|
|
7875
|
+
*/
|
|
7876
|
+
name?: string;
|
|
7877
|
+
}
|
|
7878
|
+
namespace Responses {
|
|
7879
|
+
export type $201 = Components.Schemas.PortalConfigV3;
|
|
7880
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
7881
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
7882
|
+
export type $403 = Components.Responses.Forbidden;
|
|
7883
|
+
export type $404 = Components.Responses.NotFound;
|
|
7884
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
7885
|
+
}
|
|
7886
|
+
}
|
|
7544
7887
|
namespace ConfigureDistribution {
|
|
7545
7888
|
namespace Parameters {
|
|
7546
7889
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -8050,6 +8393,27 @@ declare namespace Paths {
|
|
|
8050
8393
|
* 2021-02-09T12:41:43.662Z
|
|
8051
8394
|
*/
|
|
8052
8395
|
_updated_at: string; // date-time
|
|
8396
|
+
/**
|
|
8397
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8398
|
+
*/
|
|
8399
|
+
templates_output_highlighted?: {
|
|
8400
|
+
[name: string]: string | {
|
|
8401
|
+
[name: string]: string;
|
|
8402
|
+
};
|
|
8403
|
+
};
|
|
8404
|
+
/**
|
|
8405
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8406
|
+
*/
|
|
8407
|
+
search_snippets?: {
|
|
8408
|
+
/**
|
|
8409
|
+
* Human-readable field label
|
|
8410
|
+
*/
|
|
8411
|
+
field?: string;
|
|
8412
|
+
/**
|
|
8413
|
+
* Highlighted text fragment with <em> tags
|
|
8414
|
+
*/
|
|
8415
|
+
fragment?: string;
|
|
8416
|
+
}[];
|
|
8053
8417
|
/**
|
|
8054
8418
|
* The name of the contract.
|
|
8055
8419
|
* example:
|
|
@@ -8355,6 +8719,27 @@ declare namespace Paths {
|
|
|
8355
8719
|
* 2021-02-09T12:41:43.662Z
|
|
8356
8720
|
*/
|
|
8357
8721
|
_updated_at: string; // date-time
|
|
8722
|
+
/**
|
|
8723
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8724
|
+
*/
|
|
8725
|
+
templates_output_highlighted?: {
|
|
8726
|
+
[name: string]: string | {
|
|
8727
|
+
[name: string]: string;
|
|
8728
|
+
};
|
|
8729
|
+
};
|
|
8730
|
+
/**
|
|
8731
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8732
|
+
*/
|
|
8733
|
+
search_snippets?: {
|
|
8734
|
+
/**
|
|
8735
|
+
* Human-readable field label
|
|
8736
|
+
*/
|
|
8737
|
+
field?: string;
|
|
8738
|
+
/**
|
|
8739
|
+
* Highlighted text fragment with <em> tags
|
|
8740
|
+
*/
|
|
8741
|
+
fragment?: string;
|
|
8742
|
+
}[];
|
|
8358
8743
|
_schema: "opportunity";
|
|
8359
8744
|
journey_actions?: Components.Schemas.JourneyActions;
|
|
8360
8745
|
}[];
|
|
@@ -8437,6 +8822,27 @@ declare namespace Paths {
|
|
|
8437
8822
|
* 2021-02-09T12:41:43.662Z
|
|
8438
8823
|
*/
|
|
8439
8824
|
_updated_at: string; // date-time
|
|
8825
|
+
/**
|
|
8826
|
+
* Template outputs with search highlight <em> tags merged in. Only present when highlight is requested and matches exist.
|
|
8827
|
+
*/
|
|
8828
|
+
templates_output_highlighted?: {
|
|
8829
|
+
[name: string]: string | {
|
|
8830
|
+
[name: string]: string;
|
|
8831
|
+
};
|
|
8832
|
+
};
|
|
8833
|
+
/**
|
|
8834
|
+
* Highlighted fragments for search matches on fields not shown in template content. Max 1 entry.
|
|
8835
|
+
*/
|
|
8836
|
+
search_snippets?: {
|
|
8837
|
+
/**
|
|
8838
|
+
* Human-readable field label
|
|
8839
|
+
*/
|
|
8840
|
+
field?: string;
|
|
8841
|
+
/**
|
|
8842
|
+
* Highlighted text fragment with <em> tags
|
|
8843
|
+
*/
|
|
8844
|
+
fragment?: string;
|
|
8845
|
+
}[];
|
|
8440
8846
|
_schema: "order";
|
|
8441
8847
|
journey_actions?: Components.Schemas.JourneyActions;
|
|
8442
8848
|
}[];
|
|
@@ -8727,9 +9133,17 @@ declare namespace Paths {
|
|
|
8727
9133
|
*/
|
|
8728
9134
|
value: number;
|
|
8729
9135
|
/**
|
|
8730
|
-
* Optional type of the consumption, such as 'nt' (night time)
|
|
9136
|
+
* Optional type of the consumption, such as 'nt' (night time) and 'ht' (high time) or 'feed-in' and 'feed-out'. Can be any string.
|
|
9137
|
+
* example:
|
|
9138
|
+
* nt
|
|
8731
9139
|
*/
|
|
8732
9140
|
type?: string;
|
|
9141
|
+
/**
|
|
9142
|
+
* The method used to aggregate the consumption data. Assumed default is 'sum'.
|
|
9143
|
+
* example:
|
|
9144
|
+
* sum
|
|
9145
|
+
*/
|
|
9146
|
+
aggregation_method?: "sum" | "average" | "max" | "min";
|
|
8733
9147
|
}[];
|
|
8734
9148
|
}
|
|
8735
9149
|
export type $401 = Components.Responses.Unauthorized;
|
|
@@ -9230,6 +9644,48 @@ declare namespace Paths {
|
|
|
9230
9644
|
export type $500 = Components.Responses.InternalServerError;
|
|
9231
9645
|
}
|
|
9232
9646
|
}
|
|
9647
|
+
namespace GetMeterReadings {
|
|
9648
|
+
export interface RequestBody {
|
|
9649
|
+
meter_id: string;
|
|
9650
|
+
counter_id: string;
|
|
9651
|
+
sort?: "asc" | "desc";
|
|
9652
|
+
from?: number;
|
|
9653
|
+
size?: number;
|
|
9654
|
+
/**
|
|
9655
|
+
* Template map (key to Handlebars template string). Each template is resolved per reading.
|
|
9656
|
+
*/
|
|
9657
|
+
templates?: {
|
|
9658
|
+
[name: string]: string;
|
|
9659
|
+
};
|
|
9660
|
+
/**
|
|
9661
|
+
* Template map resolved against the counter entity.
|
|
9662
|
+
*/
|
|
9663
|
+
counter_templates?: {
|
|
9664
|
+
[name: string]: string;
|
|
9665
|
+
};
|
|
9666
|
+
}
|
|
9667
|
+
namespace Responses {
|
|
9668
|
+
export interface $200 {
|
|
9669
|
+
results?: {
|
|
9670
|
+
[name: string]: any;
|
|
9671
|
+
templates_output?: {
|
|
9672
|
+
[name: string]: string;
|
|
9673
|
+
};
|
|
9674
|
+
}[];
|
|
9675
|
+
hits?: number;
|
|
9676
|
+
/**
|
|
9677
|
+
* Resolved counter templates.
|
|
9678
|
+
*/
|
|
9679
|
+
counter_templates_output?: {
|
|
9680
|
+
[name: string]: string;
|
|
9681
|
+
};
|
|
9682
|
+
}
|
|
9683
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
9684
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
9685
|
+
export type $403 = Components.Responses.Forbidden;
|
|
9686
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
9687
|
+
}
|
|
9688
|
+
}
|
|
9233
9689
|
namespace GetOpportunity {
|
|
9234
9690
|
namespace Parameters {
|
|
9235
9691
|
export type Id = /**
|
|
@@ -10981,6 +11437,70 @@ declare namespace Paths {
|
|
|
10981
11437
|
export type $500 = Components.Responses.InternalServerError;
|
|
10982
11438
|
}
|
|
10983
11439
|
}
|
|
11440
|
+
namespace GetPublicPortalWidgetsV3 {
|
|
11441
|
+
namespace Parameters {
|
|
11442
|
+
export type Domain = string;
|
|
11443
|
+
/**
|
|
11444
|
+
* example:
|
|
11445
|
+
* 12324
|
|
11446
|
+
*/
|
|
11447
|
+
export type OrgId = string;
|
|
11448
|
+
export type PortalId = /**
|
|
11449
|
+
* ID of the portal
|
|
11450
|
+
* example:
|
|
11451
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11452
|
+
*/
|
|
11453
|
+
Components.Schemas.PortalId;
|
|
11454
|
+
}
|
|
11455
|
+
export interface QueryParameters {
|
|
11456
|
+
org_id?: /**
|
|
11457
|
+
* example:
|
|
11458
|
+
* 12324
|
|
11459
|
+
*/
|
|
11460
|
+
Parameters.OrgId;
|
|
11461
|
+
portal_id?: Parameters.PortalId;
|
|
11462
|
+
domain?: Parameters.Domain;
|
|
11463
|
+
}
|
|
11464
|
+
namespace Responses {
|
|
11465
|
+
export type $200 = Components.Schemas.UpsertPortalWidget;
|
|
11466
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11467
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11468
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11469
|
+
}
|
|
11470
|
+
}
|
|
11471
|
+
namespace GetPublicSchemasV3 {
|
|
11472
|
+
namespace Parameters {
|
|
11473
|
+
export type Domain = string;
|
|
11474
|
+
/**
|
|
11475
|
+
* example:
|
|
11476
|
+
* 12324
|
|
11477
|
+
*/
|
|
11478
|
+
export type OrgId = string;
|
|
11479
|
+
export type PortalId = /**
|
|
11480
|
+
* ID of the portal
|
|
11481
|
+
* example:
|
|
11482
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
11483
|
+
*/
|
|
11484
|
+
Components.Schemas.PortalId;
|
|
11485
|
+
}
|
|
11486
|
+
export interface QueryParameters {
|
|
11487
|
+
org_id?: /**
|
|
11488
|
+
* example:
|
|
11489
|
+
* 12324
|
|
11490
|
+
*/
|
|
11491
|
+
Parameters.OrgId;
|
|
11492
|
+
portal_id?: Parameters.PortalId;
|
|
11493
|
+
domain?: Parameters.Domain;
|
|
11494
|
+
}
|
|
11495
|
+
namespace Responses {
|
|
11496
|
+
export interface $200 {
|
|
11497
|
+
schemas?: Components.Schemas.Schema[];
|
|
11498
|
+
}
|
|
11499
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
11500
|
+
export type $403 = Components.Responses.Forbidden;
|
|
11501
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
11502
|
+
}
|
|
11503
|
+
}
|
|
10984
11504
|
namespace GetRecipientsToNotifyOnAutomation {
|
|
10985
11505
|
export interface RequestBody {
|
|
10986
11506
|
/**
|
|
@@ -13161,6 +13681,20 @@ export interface OperationMethods {
|
|
|
13161
13681
|
data?: any,
|
|
13162
13682
|
config?: AxiosRequestConfig
|
|
13163
13683
|
): OperationResponse<Paths.GetPublicPortalWidgets.Responses.$200>
|
|
13684
|
+
/**
|
|
13685
|
+
* getPublicPortalWidgetsV3 - getPublicPortalWidgetsV3
|
|
13686
|
+
*
|
|
13687
|
+
* Retrieves the public widgets of a portal.
|
|
13688
|
+
* Supports two identification methods:
|
|
13689
|
+
* 1. Using org_id + portal_id
|
|
13690
|
+
* 2. Using domain
|
|
13691
|
+
*
|
|
13692
|
+
*/
|
|
13693
|
+
'getPublicPortalWidgetsV3'(
|
|
13694
|
+
parameters?: Parameters<Paths.GetPublicPortalWidgetsV3.QueryParameters> | null,
|
|
13695
|
+
data?: any,
|
|
13696
|
+
config?: AxiosRequestConfig
|
|
13697
|
+
): OperationResponse<Paths.GetPublicPortalWidgetsV3.Responses.$200>
|
|
13164
13698
|
/**
|
|
13165
13699
|
* getPortalWidgets - getPortalWidgets
|
|
13166
13700
|
*
|
|
@@ -13251,6 +13785,20 @@ export interface OperationMethods {
|
|
|
13251
13785
|
data?: any,
|
|
13252
13786
|
config?: AxiosRequestConfig
|
|
13253
13787
|
): OperationResponse<Paths.GetSchemasByDomain.Responses.$200>
|
|
13788
|
+
/**
|
|
13789
|
+
* getPublicSchemasV3 - getPublicSchemasV3
|
|
13790
|
+
*
|
|
13791
|
+
* Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.
|
|
13792
|
+
* Supports two identification methods:
|
|
13793
|
+
* 1. Using org_id + portal_id
|
|
13794
|
+
* 2. Using domain
|
|
13795
|
+
*
|
|
13796
|
+
*/
|
|
13797
|
+
'getPublicSchemasV3'(
|
|
13798
|
+
parameters?: Parameters<Paths.GetPublicSchemasV3.QueryParameters> | null,
|
|
13799
|
+
data?: any,
|
|
13800
|
+
config?: AxiosRequestConfig
|
|
13801
|
+
): OperationResponse<Paths.GetPublicSchemasV3.Responses.$200>
|
|
13254
13802
|
/**
|
|
13255
13803
|
* getOrganizationSettingsByDomain - getOrganizationSettingsByDomain
|
|
13256
13804
|
*
|
|
@@ -13915,8 +14463,8 @@ export interface OperationMethods {
|
|
|
13915
14463
|
config?: AxiosRequestConfig
|
|
13916
14464
|
): OperationResponse<Paths.CreateMeterReading.Responses.$200>
|
|
13917
14465
|
/**
|
|
13918
|
-
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
13919
|
-
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
14466
|
+
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
14467
|
+
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
13920
14468
|
* a plausibility check hook to be configured for the portal.
|
|
13921
14469
|
*
|
|
13922
14470
|
*/
|
|
@@ -13925,6 +14473,18 @@ export interface OperationMethods {
|
|
|
13925
14473
|
data?: any,
|
|
13926
14474
|
config?: AxiosRequestConfig
|
|
13927
14475
|
): OperationResponse<Paths.GetAllowedMeterReadingRange.Responses.$200>
|
|
14476
|
+
/**
|
|
14477
|
+
* getMeterReadings - Get meter readings with optional template resolution
|
|
14478
|
+
*
|
|
14479
|
+
* Fetches meter readings for a counter and optionally resolves Handlebars
|
|
14480
|
+
* template strings against each reading object using @epilot/variables.
|
|
14481
|
+
*
|
|
14482
|
+
*/
|
|
14483
|
+
'getMeterReadings'(
|
|
14484
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14485
|
+
data?: Paths.GetMeterReadings.RequestBody,
|
|
14486
|
+
config?: AxiosRequestConfig
|
|
14487
|
+
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
13928
14488
|
/**
|
|
13929
14489
|
* ssoLogin - ssoLogin
|
|
13930
14490
|
*
|
|
@@ -14223,6 +14783,16 @@ export interface OperationMethods {
|
|
|
14223
14783
|
data?: Paths.SwapPortalConfig.RequestBody,
|
|
14224
14784
|
config?: AxiosRequestConfig
|
|
14225
14785
|
): OperationResponse<Paths.SwapPortalConfig.Responses.$200>
|
|
14786
|
+
/**
|
|
14787
|
+
* clonePortalConfig - clonePortalConfig
|
|
14788
|
+
*
|
|
14789
|
+
* Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.
|
|
14790
|
+
*/
|
|
14791
|
+
'clonePortalConfig'(
|
|
14792
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
14793
|
+
data?: Paths.ClonePortalConfig.RequestBody,
|
|
14794
|
+
config?: AxiosRequestConfig
|
|
14795
|
+
): OperationResponse<Paths.ClonePortalConfig.Responses.$201>
|
|
14226
14796
|
/**
|
|
14227
14797
|
* invitePartner - invitePartner
|
|
14228
14798
|
*
|
|
@@ -14648,6 +15218,22 @@ export interface PathsDictionary {
|
|
|
14648
15218
|
config?: AxiosRequestConfig
|
|
14649
15219
|
): OperationResponse<Paths.GetPublicPortalWidgets.Responses.$200>
|
|
14650
15220
|
}
|
|
15221
|
+
['/v3/portal/public/widgets']: {
|
|
15222
|
+
/**
|
|
15223
|
+
* getPublicPortalWidgetsV3 - getPublicPortalWidgetsV3
|
|
15224
|
+
*
|
|
15225
|
+
* Retrieves the public widgets of a portal.
|
|
15226
|
+
* Supports two identification methods:
|
|
15227
|
+
* 1. Using org_id + portal_id
|
|
15228
|
+
* 2. Using domain
|
|
15229
|
+
*
|
|
15230
|
+
*/
|
|
15231
|
+
'get'(
|
|
15232
|
+
parameters?: Parameters<Paths.GetPublicPortalWidgetsV3.QueryParameters> | null,
|
|
15233
|
+
data?: any,
|
|
15234
|
+
config?: AxiosRequestConfig
|
|
15235
|
+
): OperationResponse<Paths.GetPublicPortalWidgetsV3.Responses.$200>
|
|
15236
|
+
}
|
|
14651
15237
|
['/v2/portal/widgets']: {
|
|
14652
15238
|
/**
|
|
14653
15239
|
* upsertPortalWidget - upsertPortalWidget
|
|
@@ -14752,6 +15338,22 @@ export interface PathsDictionary {
|
|
|
14752
15338
|
config?: AxiosRequestConfig
|
|
14753
15339
|
): OperationResponse<Paths.GetSchemasByDomain.Responses.$200>
|
|
14754
15340
|
}
|
|
15341
|
+
['/v3/portal/public/schemas']: {
|
|
15342
|
+
/**
|
|
15343
|
+
* getPublicSchemasV3 - getPublicSchemasV3
|
|
15344
|
+
*
|
|
15345
|
+
* Retrieves schemas by portal. Only schemas and attributes used on public pages are returned.
|
|
15346
|
+
* Supports two identification methods:
|
|
15347
|
+
* 1. Using org_id + portal_id
|
|
15348
|
+
* 2. Using domain
|
|
15349
|
+
*
|
|
15350
|
+
*/
|
|
15351
|
+
'get'(
|
|
15352
|
+
parameters?: Parameters<Paths.GetPublicSchemasV3.QueryParameters> | null,
|
|
15353
|
+
data?: any,
|
|
15354
|
+
config?: AxiosRequestConfig
|
|
15355
|
+
): OperationResponse<Paths.GetPublicSchemasV3.Responses.$200>
|
|
15356
|
+
}
|
|
14755
15357
|
['/v2/portal/public/org/settings']: {
|
|
14756
15358
|
/**
|
|
14757
15359
|
* getOrganizationSettingsByDomain - getOrganizationSettingsByDomain
|
|
@@ -15531,8 +16133,8 @@ export interface PathsDictionary {
|
|
|
15531
16133
|
}
|
|
15532
16134
|
['/v2/portal/metering/reading/allowed-range/{meter_id}']: {
|
|
15533
16135
|
/**
|
|
15534
|
-
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
15535
|
-
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
16136
|
+
* getAllowedMeterReadingRange - Get allowed reading range for all counters of a meter from the configured
|
|
16137
|
+
* third-party plausibility check hook using 'range' mode. This endpoint requires
|
|
15536
16138
|
* a plausibility check hook to be configured for the portal.
|
|
15537
16139
|
*
|
|
15538
16140
|
*/
|
|
@@ -15542,6 +16144,20 @@ export interface PathsDictionary {
|
|
|
15542
16144
|
config?: AxiosRequestConfig
|
|
15543
16145
|
): OperationResponse<Paths.GetAllowedMeterReadingRange.Responses.$200>
|
|
15544
16146
|
}
|
|
16147
|
+
['/v2/portal/metering/readings']: {
|
|
16148
|
+
/**
|
|
16149
|
+
* getMeterReadings - Get meter readings with optional template resolution
|
|
16150
|
+
*
|
|
16151
|
+
* Fetches meter readings for a counter and optionally resolves Handlebars
|
|
16152
|
+
* template strings against each reading object using @epilot/variables.
|
|
16153
|
+
*
|
|
16154
|
+
*/
|
|
16155
|
+
'post'(
|
|
16156
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16157
|
+
data?: Paths.GetMeterReadings.RequestBody,
|
|
16158
|
+
config?: AxiosRequestConfig
|
|
16159
|
+
): OperationResponse<Paths.GetMeterReadings.Responses.$200>
|
|
16160
|
+
}
|
|
15545
16161
|
['/v2/portal/public/sso/login']: {
|
|
15546
16162
|
/**
|
|
15547
16163
|
* ssoLogin - ssoLogin
|
|
@@ -15880,6 +16496,18 @@ export interface PathsDictionary {
|
|
|
15880
16496
|
config?: AxiosRequestConfig
|
|
15881
16497
|
): OperationResponse<Paths.SwapPortalConfig.Responses.$200>
|
|
15882
16498
|
}
|
|
16499
|
+
['/v3/portal/config/clone']: {
|
|
16500
|
+
/**
|
|
16501
|
+
* clonePortalConfig - clonePortalConfig
|
|
16502
|
+
*
|
|
16503
|
+
* Creates a new portal by cloning configuration and pages from an existing portal. The new portal gets its own domain, users, email templates, and authentication settings.
|
|
16504
|
+
*/
|
|
16505
|
+
'post'(
|
|
16506
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
16507
|
+
data?: Paths.ClonePortalConfig.RequestBody,
|
|
16508
|
+
config?: AxiosRequestConfig
|
|
16509
|
+
): OperationResponse<Paths.ClonePortalConfig.Responses.$201>
|
|
16510
|
+
}
|
|
15883
16511
|
['/v3/portal/partner/invite']: {
|
|
15884
16512
|
/**
|
|
15885
16513
|
* invitePartner - invitePartner
|