@epilot/customer-portal-client 0.38.7 → 0.38.9
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 +49 -0
- package/dist/openapi.d.ts +416 -9
- package/package.json +1 -1
- package/src/openapi-runtime.json +49 -0
- package/src/openapi.json +362 -7
package/dist/openapi.d.ts
CHANGED
|
@@ -49,6 +49,31 @@ declare namespace Components {
|
|
|
49
49
|
*/
|
|
50
50
|
decision: "accept" | "decline";
|
|
51
51
|
}
|
|
52
|
+
export interface AccountExistsRequest {
|
|
53
|
+
/**
|
|
54
|
+
* ID of the organization
|
|
55
|
+
* example:
|
|
56
|
+
* 728
|
|
57
|
+
*/
|
|
58
|
+
org_id: string;
|
|
59
|
+
/**
|
|
60
|
+
* Identifier-value pairs per schema to identify an account during portal user registration
|
|
61
|
+
* example:
|
|
62
|
+
* {
|
|
63
|
+
* "account": {
|
|
64
|
+
* "customer_number": "ACC-123456"
|
|
65
|
+
* },
|
|
66
|
+
* "contract": {
|
|
67
|
+
* "contract_number": "123456"
|
|
68
|
+
* }
|
|
69
|
+
* }
|
|
70
|
+
*/
|
|
71
|
+
registration_identifiers: {
|
|
72
|
+
[name: string]: {
|
|
73
|
+
[name: string]: string;
|
|
74
|
+
};
|
|
75
|
+
};
|
|
76
|
+
}
|
|
52
77
|
export interface ActionLabel {
|
|
53
78
|
en?: string | null;
|
|
54
79
|
de?: string | null;
|
|
@@ -907,6 +932,13 @@ declare namespace Components {
|
|
|
907
932
|
* Mark true if the domain is an Epilot domain
|
|
908
933
|
*/
|
|
909
934
|
is_epilot_domain?: boolean;
|
|
935
|
+
/**
|
|
936
|
+
* The URL on which the portal is accessible
|
|
937
|
+
* example:
|
|
938
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
939
|
+
*/
|
|
940
|
+
epilot_domain?: string;
|
|
941
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
910
942
|
/**
|
|
911
943
|
* ID of the design used to build the portal
|
|
912
944
|
*/
|
|
@@ -926,6 +958,14 @@ declare namespace Components {
|
|
|
926
958
|
*/
|
|
927
959
|
allowed_portal_entities?: string[];
|
|
928
960
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
961
|
+
/**
|
|
962
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
963
|
+
*/
|
|
964
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
965
|
+
/**
|
|
966
|
+
* Entity type used as the primary identifier for self-registration
|
|
967
|
+
*/
|
|
968
|
+
self_registration_entity?: "contact" | "account";
|
|
929
969
|
/**
|
|
930
970
|
* Enable or disable user account self management
|
|
931
971
|
* example:
|
|
@@ -1306,6 +1346,12 @@ declare namespace Components {
|
|
|
1306
1346
|
pages?: {
|
|
1307
1347
|
[name: string]: Page;
|
|
1308
1348
|
};
|
|
1349
|
+
/**
|
|
1350
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
1351
|
+
*/
|
|
1352
|
+
global_blocks?: {
|
|
1353
|
+
[name: string]: Block;
|
|
1354
|
+
};
|
|
1309
1355
|
}
|
|
1310
1356
|
export interface CommonConfigAttributesV3 {
|
|
1311
1357
|
/**
|
|
@@ -1328,6 +1374,13 @@ declare namespace Components {
|
|
|
1328
1374
|
* Mark true if the domain is an Epilot domain
|
|
1329
1375
|
*/
|
|
1330
1376
|
is_epilot_domain?: boolean;
|
|
1377
|
+
/**
|
|
1378
|
+
* The Epilot domain on which the portal is accessible
|
|
1379
|
+
* example:
|
|
1380
|
+
* example-portal-1.ecp.epilot.io
|
|
1381
|
+
*/
|
|
1382
|
+
epilot_domain?: string;
|
|
1383
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
1331
1384
|
/**
|
|
1332
1385
|
* ID of the design used to build the portal
|
|
1333
1386
|
*/
|
|
@@ -1347,6 +1400,14 @@ declare namespace Components {
|
|
|
1347
1400
|
*/
|
|
1348
1401
|
allowed_portal_entities?: string[];
|
|
1349
1402
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
1403
|
+
/**
|
|
1404
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
1405
|
+
*/
|
|
1406
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
1407
|
+
/**
|
|
1408
|
+
* Entity type used as the primary identifier for self-registration
|
|
1409
|
+
*/
|
|
1410
|
+
self_registration_entity?: "contact" | "account";
|
|
1350
1411
|
/**
|
|
1351
1412
|
* Enable or disable user account self management
|
|
1352
1413
|
* example:
|
|
@@ -1724,6 +1785,12 @@ declare namespace Components {
|
|
|
1724
1785
|
*/
|
|
1725
1786
|
portal_sk_v3?: string;
|
|
1726
1787
|
origin?: /* Origin of the portal */ Origin;
|
|
1788
|
+
/**
|
|
1789
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
1790
|
+
*/
|
|
1791
|
+
global_blocks?: {
|
|
1792
|
+
[name: string]: Block;
|
|
1793
|
+
};
|
|
1727
1794
|
}
|
|
1728
1795
|
/**
|
|
1729
1796
|
* The mapped contact of the portal user
|
|
@@ -2210,6 +2277,23 @@ declare namespace Components {
|
|
|
2210
2277
|
de?: string;
|
|
2211
2278
|
};
|
|
2212
2279
|
}
|
|
2280
|
+
/**
|
|
2281
|
+
* Domain settings for the portal
|
|
2282
|
+
*/
|
|
2283
|
+
export interface DomainSettings {
|
|
2284
|
+
/**
|
|
2285
|
+
* Whether the custom domain is enabled
|
|
2286
|
+
*/
|
|
2287
|
+
is_custom_domain_enabled?: boolean;
|
|
2288
|
+
/**
|
|
2289
|
+
* Whether the Epilot domain is enabled
|
|
2290
|
+
*/
|
|
2291
|
+
is_epilot_domain_enabled?: boolean;
|
|
2292
|
+
/**
|
|
2293
|
+
* Whether the redirection is enabled
|
|
2294
|
+
*/
|
|
2295
|
+
is_redirection_enabled?: boolean;
|
|
2296
|
+
}
|
|
2213
2297
|
/**
|
|
2214
2298
|
* Email templates used for authentication and internal processes
|
|
2215
2299
|
*/
|
|
@@ -4218,6 +4302,12 @@ declare namespace Components {
|
|
|
4218
4302
|
* Whether the org is in canary mode
|
|
4219
4303
|
*/
|
|
4220
4304
|
is_canary?: boolean;
|
|
4305
|
+
/**
|
|
4306
|
+
* The URL to redirect to
|
|
4307
|
+
* example:
|
|
4308
|
+
* https://example.com
|
|
4309
|
+
*/
|
|
4310
|
+
redirect_to?: string;
|
|
4221
4311
|
}
|
|
4222
4312
|
/**
|
|
4223
4313
|
* The meter entity
|
|
@@ -5143,6 +5233,13 @@ declare namespace Components {
|
|
|
5143
5233
|
* Mark true if the domain is an Epilot domain
|
|
5144
5234
|
*/
|
|
5145
5235
|
is_epilot_domain?: boolean;
|
|
5236
|
+
/**
|
|
5237
|
+
* The URL on which the portal is accessible
|
|
5238
|
+
* example:
|
|
5239
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
5240
|
+
*/
|
|
5241
|
+
epilot_domain?: string;
|
|
5242
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5146
5243
|
design_id?: /**
|
|
5147
5244
|
* Entity ID
|
|
5148
5245
|
* example:
|
|
@@ -5159,6 +5256,14 @@ declare namespace Components {
|
|
|
5159
5256
|
*/
|
|
5160
5257
|
allowed_portal_entities?: string[];
|
|
5161
5258
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
5259
|
+
/**
|
|
5260
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
5261
|
+
*/
|
|
5262
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
5263
|
+
/**
|
|
5264
|
+
* Entity type used as the primary identifier for self-registration
|
|
5265
|
+
*/
|
|
5266
|
+
self_registration_entity?: "contact" | "account";
|
|
5162
5267
|
/**
|
|
5163
5268
|
* Enable or disable user account self management
|
|
5164
5269
|
* example:
|
|
@@ -5539,6 +5644,12 @@ declare namespace Components {
|
|
|
5539
5644
|
pages?: {
|
|
5540
5645
|
[name: string]: Page;
|
|
5541
5646
|
};
|
|
5647
|
+
/**
|
|
5648
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
5649
|
+
*/
|
|
5650
|
+
global_blocks?: {
|
|
5651
|
+
[name: string]: Block;
|
|
5652
|
+
};
|
|
5542
5653
|
/**
|
|
5543
5654
|
* ID of the organization
|
|
5544
5655
|
* example:
|
|
@@ -5647,6 +5758,13 @@ declare namespace Components {
|
|
|
5647
5758
|
* Mark true if the domain is an Epilot domain
|
|
5648
5759
|
*/
|
|
5649
5760
|
is_epilot_domain?: boolean;
|
|
5761
|
+
/**
|
|
5762
|
+
* The Epilot domain on which the portal is accessible
|
|
5763
|
+
* example:
|
|
5764
|
+
* example-portal-1.ecp.epilot.io
|
|
5765
|
+
*/
|
|
5766
|
+
epilot_domain?: string;
|
|
5767
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
5650
5768
|
design_id?: /**
|
|
5651
5769
|
* Entity ID
|
|
5652
5770
|
* example:
|
|
@@ -5663,6 +5781,14 @@ declare namespace Components {
|
|
|
5663
5781
|
*/
|
|
5664
5782
|
allowed_portal_entities?: string[];
|
|
5665
5783
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
5784
|
+
/**
|
|
5785
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
5786
|
+
*/
|
|
5787
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
5788
|
+
/**
|
|
5789
|
+
* Entity type used as the primary identifier for self-registration
|
|
5790
|
+
*/
|
|
5791
|
+
self_registration_entity?: "contact" | "account";
|
|
5666
5792
|
/**
|
|
5667
5793
|
* Enable or disable user account self management
|
|
5668
5794
|
* example:
|
|
@@ -6040,6 +6166,12 @@ declare namespace Components {
|
|
|
6040
6166
|
*/
|
|
6041
6167
|
portal_sk_v3?: string;
|
|
6042
6168
|
origin?: /* Origin of the portal */ Origin;
|
|
6169
|
+
/**
|
|
6170
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
6171
|
+
*/
|
|
6172
|
+
global_blocks?: {
|
|
6173
|
+
[name: string]: Block;
|
|
6174
|
+
};
|
|
6043
6175
|
/**
|
|
6044
6176
|
* ID of the organization
|
|
6045
6177
|
* example:
|
|
@@ -6887,6 +7019,13 @@ declare namespace Components {
|
|
|
6887
7019
|
* Mark true if the domain is an Epilot domain
|
|
6888
7020
|
*/
|
|
6889
7021
|
is_epilot_domain?: boolean;
|
|
7022
|
+
/**
|
|
7023
|
+
* The URL on which the portal is accessible
|
|
7024
|
+
* example:
|
|
7025
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
7026
|
+
*/
|
|
7027
|
+
epilot_domain?: string;
|
|
7028
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
6890
7029
|
design_id?: /**
|
|
6891
7030
|
* Entity ID
|
|
6892
7031
|
* example:
|
|
@@ -6903,6 +7042,14 @@ declare namespace Components {
|
|
|
6903
7042
|
*/
|
|
6904
7043
|
allowed_portal_entities?: string[];
|
|
6905
7044
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7045
|
+
/**
|
|
7046
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
7047
|
+
*/
|
|
7048
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
7049
|
+
/**
|
|
7050
|
+
* Entity type used as the primary identifier for self-registration
|
|
7051
|
+
*/
|
|
7052
|
+
self_registration_entity?: "contact" | "account";
|
|
6906
7053
|
/**
|
|
6907
7054
|
* Enable or disable user account self management
|
|
6908
7055
|
* example:
|
|
@@ -7283,6 +7430,12 @@ declare namespace Components {
|
|
|
7283
7430
|
pages?: {
|
|
7284
7431
|
[name: string]: Page;
|
|
7285
7432
|
};
|
|
7433
|
+
/**
|
|
7434
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
7435
|
+
*/
|
|
7436
|
+
global_blocks?: {
|
|
7437
|
+
[name: string]: Block;
|
|
7438
|
+
};
|
|
7286
7439
|
}
|
|
7287
7440
|
export interface UpsertPortalConfigV3 {
|
|
7288
7441
|
/**
|
|
@@ -7345,6 +7498,13 @@ declare namespace Components {
|
|
|
7345
7498
|
* Mark true if the domain is an Epilot domain
|
|
7346
7499
|
*/
|
|
7347
7500
|
is_epilot_domain?: boolean;
|
|
7501
|
+
/**
|
|
7502
|
+
* The Epilot domain on which the portal is accessible
|
|
7503
|
+
* example:
|
|
7504
|
+
* example-portal-1.ecp.epilot.io
|
|
7505
|
+
*/
|
|
7506
|
+
epilot_domain?: string;
|
|
7507
|
+
domain_settings?: /* Domain settings for the portal */ DomainSettings;
|
|
7348
7508
|
design_id?: /**
|
|
7349
7509
|
* Entity ID
|
|
7350
7510
|
* example:
|
|
@@ -7361,6 +7521,14 @@ declare namespace Components {
|
|
|
7361
7521
|
*/
|
|
7362
7522
|
allowed_portal_entities?: string[];
|
|
7363
7523
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
7524
|
+
/**
|
|
7525
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
7526
|
+
*/
|
|
7527
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
7528
|
+
/**
|
|
7529
|
+
* Entity type used as the primary identifier for self-registration
|
|
7530
|
+
*/
|
|
7531
|
+
self_registration_entity?: "contact" | "account";
|
|
7364
7532
|
/**
|
|
7365
7533
|
* Enable or disable user account self management
|
|
7366
7534
|
* example:
|
|
@@ -7738,6 +7906,12 @@ declare namespace Components {
|
|
|
7738
7906
|
*/
|
|
7739
7907
|
portal_sk_v3?: string;
|
|
7740
7908
|
origin?: /* Origin of the portal */ Origin;
|
|
7909
|
+
/**
|
|
7910
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
7911
|
+
*/
|
|
7912
|
+
global_blocks?: {
|
|
7913
|
+
[name: string]: Block;
|
|
7914
|
+
};
|
|
7741
7915
|
pages?: PageRequest[];
|
|
7742
7916
|
}
|
|
7743
7917
|
export interface UpsertPortalWidget {
|
|
@@ -7835,19 +8009,19 @@ declare namespace Components {
|
|
|
7835
8009
|
*/
|
|
7836
8010
|
statistical_method?: "sum" | "average" | "min" | "max";
|
|
7837
8011
|
/**
|
|
7838
|
-
*
|
|
7839
|
-
|
|
7840
|
-
|
|
7841
|
-
|
|
7842
|
-
*
|
|
7843
|
-
* With both directions present in a prosumer setup, the chart computes a *net* consumption per period — when production exceeds consumption the period total is negative and the chart can flip its label to "Total production" instead. Defaults to `out` when omitted (the legacy assumption that all values are consumption from the grid).
|
|
8012
|
+
* Unit shared by all values of this type (e.g. "kWh").
|
|
8013
|
+
*/
|
|
8014
|
+
unit?: string;
|
|
8015
|
+
/**
|
|
8016
|
+
* Optional Spark color token used to render this type in the visualization. Maps onto the portal's Spark palette (`primary` is the org's primary brand color). When omitted the consumer falls back to its own per-type default.
|
|
7844
8017
|
*
|
|
7845
8018
|
*/
|
|
7846
|
-
|
|
8019
|
+
color?: "primary" | "slate" | "mauve" | "orange" | "red" | "tomato" | "amber" | "green" | "blue";
|
|
7847
8020
|
/**
|
|
7848
|
-
*
|
|
8021
|
+
* Optional number of decimal places to show when rendering values of this type in the visualization (axis labels, tooltips, summaries). When omitted the consumer falls back to its own default precision.
|
|
8022
|
+
*
|
|
7849
8023
|
*/
|
|
7850
|
-
|
|
8024
|
+
precision?: number;
|
|
7851
8025
|
}
|
|
7852
8026
|
export interface WidgetAction {
|
|
7853
8027
|
_id: string;
|
|
@@ -8030,6 +8204,44 @@ declare namespace Paths {
|
|
|
8030
8204
|
}
|
|
8031
8205
|
}
|
|
8032
8206
|
}
|
|
8207
|
+
namespace CheckAccountExists {
|
|
8208
|
+
namespace Parameters {
|
|
8209
|
+
export type Domain = string;
|
|
8210
|
+
export type PortalId = /**
|
|
8211
|
+
* ID of the portal
|
|
8212
|
+
* example:
|
|
8213
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
8214
|
+
*/
|
|
8215
|
+
Components.Schemas.PortalId;
|
|
8216
|
+
}
|
|
8217
|
+
export interface QueryParameters {
|
|
8218
|
+
portal_id?: Parameters.PortalId;
|
|
8219
|
+
domain?: Parameters.Domain;
|
|
8220
|
+
}
|
|
8221
|
+
export type RequestBody = Components.Schemas.AccountExistsRequest;
|
|
8222
|
+
namespace Responses {
|
|
8223
|
+
export interface $200 {
|
|
8224
|
+
/**
|
|
8225
|
+
* Whether the account exists with the given identifier values
|
|
8226
|
+
* example:
|
|
8227
|
+
* true
|
|
8228
|
+
*/
|
|
8229
|
+
exists?: boolean;
|
|
8230
|
+
/**
|
|
8231
|
+
* ID of the account if exists
|
|
8232
|
+
*/
|
|
8233
|
+
accountId?: /**
|
|
8234
|
+
* Entity ID
|
|
8235
|
+
* example:
|
|
8236
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8237
|
+
*/
|
|
8238
|
+
Components.Schemas.EntityId /* uuid */;
|
|
8239
|
+
}
|
|
8240
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
8241
|
+
export type $404 = Components.Responses.NotFound;
|
|
8242
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
8243
|
+
}
|
|
8244
|
+
}
|
|
8033
8245
|
namespace CheckContactExists {
|
|
8034
8246
|
namespace Parameters {
|
|
8035
8247
|
export type Origin = /* Origin of the portal */ Components.Schemas.Origin;
|
|
@@ -8093,6 +8305,15 @@ declare namespace Paths {
|
|
|
8093
8305
|
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8094
8306
|
*/
|
|
8095
8307
|
Components.Schemas.EntityId /* uuid */;
|
|
8308
|
+
/**
|
|
8309
|
+
* ID of the resolved account when the portal is configured for account-based registration
|
|
8310
|
+
*/
|
|
8311
|
+
accountId?: /**
|
|
8312
|
+
* Entity ID
|
|
8313
|
+
* example:
|
|
8314
|
+
* 5da0a718-c822-403d-9f5d-20d4584e0528
|
|
8315
|
+
*/
|
|
8316
|
+
Components.Schemas.EntityId /* uuid */;
|
|
8096
8317
|
}
|
|
8097
8318
|
export type $400 = Components.Responses.InvalidRequest;
|
|
8098
8319
|
export type $404 = Components.Responses.NotFound;
|
|
@@ -10130,6 +10351,13 @@ declare namespace Paths {
|
|
|
10130
10351
|
* Mark true if the domain is an Epilot domain
|
|
10131
10352
|
*/
|
|
10132
10353
|
is_epilot_domain?: boolean;
|
|
10354
|
+
/**
|
|
10355
|
+
* The URL on which the portal is accessible
|
|
10356
|
+
* example:
|
|
10357
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
10358
|
+
*/
|
|
10359
|
+
epilot_domain?: string;
|
|
10360
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
10133
10361
|
design_id?: /**
|
|
10134
10362
|
* Entity ID
|
|
10135
10363
|
* example:
|
|
@@ -10146,6 +10374,14 @@ declare namespace Paths {
|
|
|
10146
10374
|
*/
|
|
10147
10375
|
allowed_portal_entities?: string[];
|
|
10148
10376
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
10377
|
+
/**
|
|
10378
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
10379
|
+
*/
|
|
10380
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
10381
|
+
/**
|
|
10382
|
+
* Entity type used as the primary identifier for self-registration
|
|
10383
|
+
*/
|
|
10384
|
+
self_registration_entity?: "contact" | "account";
|
|
10149
10385
|
/**
|
|
10150
10386
|
* Enable or disable user account self management
|
|
10151
10387
|
* example:
|
|
@@ -10526,6 +10762,12 @@ declare namespace Paths {
|
|
|
10526
10762
|
pages?: {
|
|
10527
10763
|
[name: string]: Components.Schemas.Page;
|
|
10528
10764
|
};
|
|
10765
|
+
/**
|
|
10766
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
10767
|
+
*/
|
|
10768
|
+
global_blocks?: {
|
|
10769
|
+
[name: string]: Components.Schemas.Block;
|
|
10770
|
+
};
|
|
10529
10771
|
/**
|
|
10530
10772
|
* ID of the organization
|
|
10531
10773
|
* example:
|
|
@@ -10624,6 +10866,13 @@ declare namespace Paths {
|
|
|
10624
10866
|
* Mark true if the domain is an Epilot domain
|
|
10625
10867
|
*/
|
|
10626
10868
|
is_epilot_domain?: boolean;
|
|
10869
|
+
/**
|
|
10870
|
+
* The URL on which the portal is accessible
|
|
10871
|
+
* example:
|
|
10872
|
+
* example-portal-12345.ecp.epilot.cloud
|
|
10873
|
+
*/
|
|
10874
|
+
epilot_domain?: string;
|
|
10875
|
+
domain_settings?: /* Domain settings for the portal */ Components.Schemas.DomainSettings;
|
|
10627
10876
|
design_id?: /**
|
|
10628
10877
|
* Entity ID
|
|
10629
10878
|
* example:
|
|
@@ -10640,6 +10889,14 @@ declare namespace Paths {
|
|
|
10640
10889
|
*/
|
|
10641
10890
|
allowed_portal_entities?: string[];
|
|
10642
10891
|
self_registration_setting?: "ALLOW_WITH_CONTACT_CREATION" | "ALLOW_WITHOUT_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY" | "BLOCK_IF_PORTAL_USER_EXISTS";
|
|
10892
|
+
/**
|
|
10893
|
+
* Controls behavior of self-registration when account is used as the registration entity
|
|
10894
|
+
*/
|
|
10895
|
+
self_registration_account_setting?: "ALLOW_WITH_CONTACT_CREATION" | "DENY" | "ALWAYS_CREATE_CONTACT" | "DISALLOW_COMPLETELY";
|
|
10896
|
+
/**
|
|
10897
|
+
* Entity type used as the primary identifier for self-registration
|
|
10898
|
+
*/
|
|
10899
|
+
self_registration_entity?: "contact" | "account";
|
|
10643
10900
|
/**
|
|
10644
10901
|
* Enable or disable user account self management
|
|
10645
10902
|
* example:
|
|
@@ -11020,6 +11277,12 @@ declare namespace Paths {
|
|
|
11020
11277
|
pages?: {
|
|
11021
11278
|
[name: string]: Components.Schemas.Page;
|
|
11022
11279
|
};
|
|
11280
|
+
/**
|
|
11281
|
+
* Portal-level blocks shared across all pages (e.g. footer). Keyed by block id.
|
|
11282
|
+
*/
|
|
11283
|
+
global_blocks?: {
|
|
11284
|
+
[name: string]: Components.Schemas.Block;
|
|
11285
|
+
};
|
|
11023
11286
|
/**
|
|
11024
11287
|
* ID of the organization
|
|
11025
11288
|
* example:
|
|
@@ -12342,6 +12605,42 @@ declare namespace Paths {
|
|
|
12342
12605
|
export type $500 = Components.Responses.InternalServerError;
|
|
12343
12606
|
}
|
|
12344
12607
|
}
|
|
12608
|
+
namespace PortalProxyExecute {
|
|
12609
|
+
export interface RequestBody {
|
|
12610
|
+
/**
|
|
12611
|
+
* Integration ID containing the managed-call use case
|
|
12612
|
+
*/
|
|
12613
|
+
integration_id: string; // uuid
|
|
12614
|
+
/**
|
|
12615
|
+
* Use case slug (acts as the RPC method name)
|
|
12616
|
+
*/
|
|
12617
|
+
use_case_slug: string;
|
|
12618
|
+
/**
|
|
12619
|
+
* Input data for the managed-call operation
|
|
12620
|
+
*/
|
|
12621
|
+
payload?: {
|
|
12622
|
+
[name: string]: any;
|
|
12623
|
+
};
|
|
12624
|
+
}
|
|
12625
|
+
namespace Responses {
|
|
12626
|
+
export interface $200 {
|
|
12627
|
+
success: boolean;
|
|
12628
|
+
/**
|
|
12629
|
+
* Managed-call response payload. Shape is defined by the use
|
|
12630
|
+
* case's JSONata response_mapping; if no mapping is
|
|
12631
|
+
* configured the raw external API response is returned.
|
|
12632
|
+
*
|
|
12633
|
+
*/
|
|
12634
|
+
data?: {
|
|
12635
|
+
[name: string]: any;
|
|
12636
|
+
};
|
|
12637
|
+
}
|
|
12638
|
+
export type $400 = Components.Responses.InvalidRequest;
|
|
12639
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
12640
|
+
export type $403 = Components.Responses.Forbidden;
|
|
12641
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
12642
|
+
}
|
|
12643
|
+
}
|
|
12345
12644
|
namespace PostOrderAcceptance {
|
|
12346
12645
|
namespace Parameters {
|
|
12347
12646
|
export type Id = /**
|
|
@@ -13700,6 +13999,34 @@ declare namespace Paths {
|
|
|
13700
13999
|
export type $500 = Components.Responses.InternalServerError;
|
|
13701
14000
|
}
|
|
13702
14001
|
}
|
|
14002
|
+
namespace VerifyDns {
|
|
14003
|
+
namespace Parameters {
|
|
14004
|
+
export type PortalId = /**
|
|
14005
|
+
* ID of the portal
|
|
14006
|
+
* example:
|
|
14007
|
+
* 453ad7bf-86d5-46c8-8252-bcc868df5e3c
|
|
14008
|
+
*/
|
|
14009
|
+
Components.Schemas.PortalId;
|
|
14010
|
+
}
|
|
14011
|
+
export interface QueryParameters {
|
|
14012
|
+
portal_id: Parameters.PortalId;
|
|
14013
|
+
}
|
|
14014
|
+
namespace Responses {
|
|
14015
|
+
export interface $200 {
|
|
14016
|
+
/**
|
|
14017
|
+
* The status of the custom domain verification
|
|
14018
|
+
*/
|
|
14019
|
+
domain_status?: "PENDING" | "SUCCEED";
|
|
14020
|
+
/**
|
|
14021
|
+
* A message describing the result
|
|
14022
|
+
*/
|
|
14023
|
+
message?: string;
|
|
14024
|
+
}
|
|
14025
|
+
export type $401 = Components.Responses.Unauthorized;
|
|
14026
|
+
export type $403 = Components.Responses.Forbidden;
|
|
14027
|
+
export type $500 = Components.Responses.InternalServerError;
|
|
14028
|
+
}
|
|
14029
|
+
}
|
|
13703
14030
|
}
|
|
13704
14031
|
|
|
13705
14032
|
|
|
@@ -14246,6 +14573,20 @@ export interface OperationMethods {
|
|
|
14246
14573
|
data?: Paths.CheckContactExistsV3.RequestBody,
|
|
14247
14574
|
config?: AxiosRequestConfig
|
|
14248
14575
|
): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
|
|
14576
|
+
/**
|
|
14577
|
+
* checkAccountExists - checkAccountExists
|
|
14578
|
+
*
|
|
14579
|
+
* True if account with given identifiers exists.
|
|
14580
|
+
* Supports two identification methods:
|
|
14581
|
+
* 1. Using portal_id
|
|
14582
|
+
* 2. Using domain
|
|
14583
|
+
*
|
|
14584
|
+
*/
|
|
14585
|
+
'checkAccountExists'(
|
|
14586
|
+
parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
|
|
14587
|
+
data?: Paths.CheckAccountExists.RequestBody,
|
|
14588
|
+
config?: AxiosRequestConfig
|
|
14589
|
+
): OperationResponse<Paths.CheckAccountExists.Responses.$200>
|
|
14249
14590
|
/**
|
|
14250
14591
|
* getValidSecondaryAttributes - getValidSecondaryAttributes
|
|
14251
14592
|
*
|
|
@@ -15206,6 +15547,28 @@ export interface OperationMethods {
|
|
|
15206
15547
|
data?: any,
|
|
15207
15548
|
config?: AxiosRequestConfig
|
|
15208
15549
|
): OperationResponse<Paths.EnablePartner.Responses.$200>
|
|
15550
|
+
/**
|
|
15551
|
+
* verifyDns - verifyDns
|
|
15552
|
+
*
|
|
15553
|
+
* Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
|
|
15554
|
+
*/
|
|
15555
|
+
'verifyDns'(
|
|
15556
|
+
parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
|
|
15557
|
+
data?: any,
|
|
15558
|
+
config?: AxiosRequestConfig
|
|
15559
|
+
): OperationResponse<Paths.VerifyDns.Responses.$200>
|
|
15560
|
+
/**
|
|
15561
|
+
* portalProxyExecute - portalProxyExecute
|
|
15562
|
+
*
|
|
15563
|
+
* Execute an Integration Hub managed-call use case on behalf of a portal user.
|
|
15564
|
+
* Bridges PortalAuth to the Integration API by generating an internal token.
|
|
15565
|
+
*
|
|
15566
|
+
*/
|
|
15567
|
+
'portalProxyExecute'(
|
|
15568
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
15569
|
+
data?: Paths.PortalProxyExecute.RequestBody,
|
|
15570
|
+
config?: AxiosRequestConfig
|
|
15571
|
+
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
15209
15572
|
}
|
|
15210
15573
|
|
|
15211
15574
|
export interface PathsDictionary {
|
|
@@ -15843,6 +16206,22 @@ export interface PathsDictionary {
|
|
|
15843
16206
|
config?: AxiosRequestConfig
|
|
15844
16207
|
): OperationResponse<Paths.CheckContactExistsV3.Responses.$200>
|
|
15845
16208
|
}
|
|
16209
|
+
['/v3/portal/public/account/exists']: {
|
|
16210
|
+
/**
|
|
16211
|
+
* checkAccountExists - checkAccountExists
|
|
16212
|
+
*
|
|
16213
|
+
* True if account with given identifiers exists.
|
|
16214
|
+
* Supports two identification methods:
|
|
16215
|
+
* 1. Using portal_id
|
|
16216
|
+
* 2. Using domain
|
|
16217
|
+
*
|
|
16218
|
+
*/
|
|
16219
|
+
'post'(
|
|
16220
|
+
parameters?: Parameters<Paths.CheckAccountExists.QueryParameters> | null,
|
|
16221
|
+
data?: Paths.CheckAccountExists.RequestBody,
|
|
16222
|
+
config?: AxiosRequestConfig
|
|
16223
|
+
): OperationResponse<Paths.CheckAccountExists.Responses.$200>
|
|
16224
|
+
}
|
|
15846
16225
|
['/v2/portal/contact/valid/secondary/attributes']: {
|
|
15847
16226
|
/**
|
|
15848
16227
|
* getValidSecondaryAttributes - getValidSecondaryAttributes
|
|
@@ -16959,12 +17338,39 @@ export interface PathsDictionary {
|
|
|
16959
17338
|
config?: AxiosRequestConfig
|
|
16960
17339
|
): OperationResponse<Paths.EnablePartner.Responses.$200>
|
|
16961
17340
|
}
|
|
17341
|
+
['/v3/portal/verify-dns']: {
|
|
17342
|
+
/**
|
|
17343
|
+
* verifyDns - verifyDns
|
|
17344
|
+
*
|
|
17345
|
+
* Manually triggers DNS verification for a portal's domain setup. Runs the same verification logic as the scheduled processAllPendingNetworks lambda.
|
|
17346
|
+
*/
|
|
17347
|
+
'post'(
|
|
17348
|
+
parameters?: Parameters<Paths.VerifyDns.QueryParameters> | null,
|
|
17349
|
+
data?: any,
|
|
17350
|
+
config?: AxiosRequestConfig
|
|
17351
|
+
): OperationResponse<Paths.VerifyDns.Responses.$200>
|
|
17352
|
+
}
|
|
17353
|
+
['/v2/portal/proxy/execute']: {
|
|
17354
|
+
/**
|
|
17355
|
+
* portalProxyExecute - portalProxyExecute
|
|
17356
|
+
*
|
|
17357
|
+
* Execute an Integration Hub managed-call use case on behalf of a portal user.
|
|
17358
|
+
* Bridges PortalAuth to the Integration API by generating an internal token.
|
|
17359
|
+
*
|
|
17360
|
+
*/
|
|
17361
|
+
'post'(
|
|
17362
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
17363
|
+
data?: Paths.PortalProxyExecute.RequestBody,
|
|
17364
|
+
config?: AxiosRequestConfig
|
|
17365
|
+
): OperationResponse<Paths.PortalProxyExecute.Responses.$200>
|
|
17366
|
+
}
|
|
16962
17367
|
}
|
|
16963
17368
|
|
|
16964
17369
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
16965
17370
|
|
|
16966
17371
|
|
|
16967
17372
|
export type AcceptanceDecision = Components.Schemas.AcceptanceDecision;
|
|
17373
|
+
export type AccountExistsRequest = Components.Schemas.AccountExistsRequest;
|
|
16968
17374
|
export type ActionLabel = Components.Schemas.ActionLabel;
|
|
16969
17375
|
export type ActionWidget = Components.Schemas.ActionWidget;
|
|
16970
17376
|
export type Activity = Components.Schemas.Activity;
|
|
@@ -17003,6 +17409,7 @@ export type DataRetrievalItem = Components.Schemas.DataRetrievalItem;
|
|
|
17003
17409
|
export type DeleteEntityFile = Components.Schemas.DeleteEntityFile;
|
|
17004
17410
|
export type Direction = Components.Schemas.Direction;
|
|
17005
17411
|
export type DocumentWidget = Components.Schemas.DocumentWidget;
|
|
17412
|
+
export type DomainSettings = Components.Schemas.DomainSettings;
|
|
17006
17413
|
export type EmailTemplates = Components.Schemas.EmailTemplates;
|
|
17007
17414
|
export type Entity = Components.Schemas.Entity;
|
|
17008
17415
|
export type EntityEditRule = Components.Schemas.EntityEditRule;
|