@epilot/customer-portal-client 0.33.3 → 0.35.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/client.d.ts +1 -1
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +29 -0
- package/dist/openapi.d.ts +769 -128
- package/package.json +4 -7
- package/src/openapi-runtime.json +29 -0
- package/src/openapi.json +493 -59
package/src/openapi.json
CHANGED
|
@@ -2110,7 +2110,8 @@
|
|
|
2110
2110
|
"get": {
|
|
2111
2111
|
"operationId": "getPublicPortalWidgets",
|
|
2112
2112
|
"summary": "getPublicPortalWidgets",
|
|
2113
|
-
"description": "Retrieves the public widgets of a portal",
|
|
2113
|
+
"description": "Retrieves the public widgets of a portal.",
|
|
2114
|
+
"deprecated": true,
|
|
2114
2115
|
"tags": [
|
|
2115
2116
|
"Public"
|
|
2116
2117
|
],
|
|
@@ -2164,6 +2165,7 @@
|
|
|
2164
2165
|
"operationId": "upsertPortalWidget",
|
|
2165
2166
|
"summary": "upsertPortalWidget",
|
|
2166
2167
|
"description": "Upsert widget for a portal of an organization.",
|
|
2168
|
+
"deprecated": true,
|
|
2167
2169
|
"security": [
|
|
2168
2170
|
{
|
|
2169
2171
|
"EpilotAuth": []
|
|
@@ -2222,7 +2224,8 @@
|
|
|
2222
2224
|
"get": {
|
|
2223
2225
|
"operationId": "getPortalWidgets",
|
|
2224
2226
|
"summary": "getPortalWidgets",
|
|
2225
|
-
"description": "Retrieves the widgets of a portal",
|
|
2227
|
+
"description": "Retrieves the widgets of a portal.",
|
|
2228
|
+
"deprecated": true,
|
|
2226
2229
|
"tags": [
|
|
2227
2230
|
"ECP Admin",
|
|
2228
2231
|
"ECP"
|
|
@@ -2826,6 +2829,7 @@
|
|
|
2826
2829
|
"operationId": "updateContact",
|
|
2827
2830
|
"summary": "updateContact",
|
|
2828
2831
|
"description": "Updates the contact details.",
|
|
2832
|
+
"deprecated": true,
|
|
2829
2833
|
"tags": [
|
|
2830
2834
|
"ECP"
|
|
2831
2835
|
],
|
|
@@ -3881,7 +3885,8 @@
|
|
|
3881
3885
|
"get": {
|
|
3882
3886
|
"operationId": "getAllOrders",
|
|
3883
3887
|
"summary": "getAllOrders",
|
|
3884
|
-
"description": "Get all orders for the portal user",
|
|
3888
|
+
"description": "Get all orders for the portal user. Use searchPortalUserEntities instead.",
|
|
3889
|
+
"deprecated": true,
|
|
3885
3890
|
"tags": [
|
|
3886
3891
|
"ECP"
|
|
3887
3892
|
],
|
|
@@ -4028,7 +4033,8 @@
|
|
|
4028
4033
|
"get": {
|
|
4029
4034
|
"operationId": "getOrder",
|
|
4030
4035
|
"summary": "getOrder",
|
|
4031
|
-
"description": "Get an order by id",
|
|
4036
|
+
"description": "Get an order by id. Use getPortalUserEntity instead.",
|
|
4037
|
+
"deprecated": true,
|
|
4032
4038
|
"tags": [
|
|
4033
4039
|
"ECP"
|
|
4034
4040
|
],
|
|
@@ -4122,7 +4128,8 @@
|
|
|
4122
4128
|
"patch": {
|
|
4123
4129
|
"operationId": "updateOrder",
|
|
4124
4130
|
"summary": "updateOrder",
|
|
4125
|
-
"description": "Update an order by id",
|
|
4131
|
+
"description": "Update an order by id. Use getPortalUserEntity instead.",
|
|
4132
|
+
"deprecated": true,
|
|
4126
4133
|
"tags": [
|
|
4127
4134
|
"ECP"
|
|
4128
4135
|
],
|
|
@@ -4186,7 +4193,8 @@
|
|
|
4186
4193
|
"get": {
|
|
4187
4194
|
"operationId": "getAllOpportunities",
|
|
4188
4195
|
"summary": "getAllOpportunities",
|
|
4189
|
-
"description": "Get all opportunities of a portal user",
|
|
4196
|
+
"description": "Get all opportunities of a portal user. Use searchPortalUserEntities instead.",
|
|
4197
|
+
"deprecated": true,
|
|
4190
4198
|
"tags": [
|
|
4191
4199
|
"ECP"
|
|
4192
4200
|
],
|
|
@@ -4269,7 +4277,8 @@
|
|
|
4269
4277
|
"get": {
|
|
4270
4278
|
"operationId": "getSearchableAttributesForOpportunities",
|
|
4271
4279
|
"summary": "getSearchableAttributesForOpportunities",
|
|
4272
|
-
"description": "Get all opportunity searchable attributes for a portal user",
|
|
4280
|
+
"description": "Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.",
|
|
4281
|
+
"deprecated": true,
|
|
4273
4282
|
"tags": [
|
|
4274
4283
|
"ECP"
|
|
4275
4284
|
],
|
|
@@ -4340,7 +4349,8 @@
|
|
|
4340
4349
|
"post": {
|
|
4341
4350
|
"operationId": "getSearchResultsForOpportunities",
|
|
4342
4351
|
"summary": "getSearchResultsForOpportunities",
|
|
4343
|
-
"description": "Get all opportunity with the given
|
|
4352
|
+
"description": "Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.",
|
|
4353
|
+
"deprecated": true,
|
|
4344
4354
|
"tags": [
|
|
4345
4355
|
"ECP"
|
|
4346
4356
|
],
|
|
@@ -4449,7 +4459,8 @@
|
|
|
4449
4459
|
"get": {
|
|
4450
4460
|
"operationId": "getOpportunity",
|
|
4451
4461
|
"summary": "getOpportunity",
|
|
4452
|
-
"description": "Get an opportunity by id",
|
|
4462
|
+
"description": "Get an opportunity by id. Use getPortalUserEntity instead.",
|
|
4463
|
+
"deprecated": true,
|
|
4453
4464
|
"tags": [
|
|
4454
4465
|
"ECP"
|
|
4455
4466
|
],
|
|
@@ -4536,7 +4547,8 @@
|
|
|
4536
4547
|
"patch": {
|
|
4537
4548
|
"operationId": "updateOpportunity",
|
|
4538
4549
|
"summary": "updateOpportunity",
|
|
4539
|
-
"description": "Update an opportunity by id",
|
|
4550
|
+
"description": "Update an opportunity by id.",
|
|
4551
|
+
"deprecated": true,
|
|
4540
4552
|
"tags": [
|
|
4541
4553
|
"ECP"
|
|
4542
4554
|
],
|
|
@@ -4602,7 +4614,8 @@
|
|
|
4602
4614
|
"get": {
|
|
4603
4615
|
"operationId": "getAllRequests",
|
|
4604
4616
|
"summary": "getAllRequests",
|
|
4605
|
-
"description": "Get all opportunities & orders of a portal user",
|
|
4617
|
+
"description": "Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.",
|
|
4618
|
+
"deprecated": true,
|
|
4606
4619
|
"tags": [
|
|
4607
4620
|
"ECP"
|
|
4608
4621
|
],
|
|
@@ -4698,7 +4711,8 @@
|
|
|
4698
4711
|
"get": {
|
|
4699
4712
|
"operationId": "getAllContracts",
|
|
4700
4713
|
"summary": "getAllContracts",
|
|
4701
|
-
"description": "Get all contracts for a portal user",
|
|
4714
|
+
"description": "Get all contracts for a portal user. Use searchPortalUserEntities instead.",
|
|
4715
|
+
"deprecated": true,
|
|
4702
4716
|
"tags": [
|
|
4703
4717
|
"ECP"
|
|
4704
4718
|
],
|
|
@@ -4778,7 +4792,8 @@
|
|
|
4778
4792
|
"get": {
|
|
4779
4793
|
"operationId": "getContract",
|
|
4780
4794
|
"summary": "getContract",
|
|
4781
|
-
"description": "Get a contract by id",
|
|
4795
|
+
"description": "Get a contract by id. Use getPortalUserEntity instead.",
|
|
4796
|
+
"deprecated": true,
|
|
4782
4797
|
"tags": [
|
|
4783
4798
|
"ECP"
|
|
4784
4799
|
],
|
|
@@ -4871,7 +4886,8 @@
|
|
|
4871
4886
|
"patch": {
|
|
4872
4887
|
"operationId": "updateContract",
|
|
4873
4888
|
"summary": "updateContract",
|
|
4874
|
-
"description": "Update a contract by id",
|
|
4889
|
+
"description": "Update a contract by id. Use getPortalUserEntity instead.",
|
|
4890
|
+
"deprecated": true,
|
|
4875
4891
|
"tags": [
|
|
4876
4892
|
"ECP"
|
|
4877
4893
|
],
|
|
@@ -5730,7 +5746,8 @@
|
|
|
5730
5746
|
"get": {
|
|
5731
5747
|
"operationId": "getFileById",
|
|
5732
5748
|
"summary": "getFileById",
|
|
5733
|
-
"description": "Fetch a document with ID",
|
|
5749
|
+
"description": "Fetch a document with ID. Use getPortalUserEntity instead.",
|
|
5750
|
+
"deprecated": true,
|
|
5734
5751
|
"tags": [
|
|
5735
5752
|
"ECP"
|
|
5736
5753
|
],
|
|
@@ -6126,6 +6143,10 @@
|
|
|
6126
6143
|
},
|
|
6127
6144
|
"origin": {
|
|
6128
6145
|
"$ref": "#/components/schemas/Origin"
|
|
6146
|
+
},
|
|
6147
|
+
"portal_id": {
|
|
6148
|
+
"type": "string",
|
|
6149
|
+
"description": "The portal ID to look up the portal config. When provided, takes precedence over origin."
|
|
6129
6150
|
}
|
|
6130
6151
|
}
|
|
6131
6152
|
}
|
|
@@ -7464,6 +7485,74 @@
|
|
|
7464
7485
|
}
|
|
7465
7486
|
}
|
|
7466
7487
|
},
|
|
7488
|
+
"/v2/portal/pages/interpolate": {
|
|
7489
|
+
"post": {
|
|
7490
|
+
"operationId": "interpolatePortalPages",
|
|
7491
|
+
"summary": "interpolatePortalPages",
|
|
7492
|
+
"description": "Interpolate template variables in portal pages without reading from the database. Accepts pages in the request body and returns them with templates resolved.",
|
|
7493
|
+
"tags": [
|
|
7494
|
+
"ECP Admin"
|
|
7495
|
+
],
|
|
7496
|
+
"security": [
|
|
7497
|
+
{
|
|
7498
|
+
"EitherAuth": []
|
|
7499
|
+
}
|
|
7500
|
+
],
|
|
7501
|
+
"requestBody": {
|
|
7502
|
+
"required": true,
|
|
7503
|
+
"content": {
|
|
7504
|
+
"application/json": {
|
|
7505
|
+
"schema": {
|
|
7506
|
+
"type": "object",
|
|
7507
|
+
"required": [
|
|
7508
|
+
"pages"
|
|
7509
|
+
],
|
|
7510
|
+
"properties": {
|
|
7511
|
+
"pages": {
|
|
7512
|
+
"type": "array",
|
|
7513
|
+
"items": {
|
|
7514
|
+
"$ref": "#/components/schemas/Page"
|
|
7515
|
+
},
|
|
7516
|
+
"description": "The pages to interpolate"
|
|
7517
|
+
},
|
|
7518
|
+
"context_entities": {
|
|
7519
|
+
"$ref": "#/components/schemas/ContextEntities"
|
|
7520
|
+
},
|
|
7521
|
+
"evaluate_targeting": {
|
|
7522
|
+
"type": "boolean",
|
|
7523
|
+
"description": "When true, evaluates targeting conditions and annotates each page/block visibility with _targeting_status ('visible' | 'hidden' | 'no_targeting'). Blocks and pages are never removed — for preview/builder use only."
|
|
7524
|
+
}
|
|
7525
|
+
}
|
|
7526
|
+
}
|
|
7527
|
+
}
|
|
7528
|
+
}
|
|
7529
|
+
},
|
|
7530
|
+
"responses": {
|
|
7531
|
+
"200": {
|
|
7532
|
+
"description": "The portal pages have been interpolated successfully.",
|
|
7533
|
+
"content": {
|
|
7534
|
+
"application/json": {
|
|
7535
|
+
"schema": {
|
|
7536
|
+
"type": "array",
|
|
7537
|
+
"items": {
|
|
7538
|
+
"$ref": "#/components/schemas/Page"
|
|
7539
|
+
}
|
|
7540
|
+
}
|
|
7541
|
+
}
|
|
7542
|
+
}
|
|
7543
|
+
},
|
|
7544
|
+
"401": {
|
|
7545
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
7546
|
+
},
|
|
7547
|
+
"403": {
|
|
7548
|
+
"$ref": "#/components/responses/Forbidden"
|
|
7549
|
+
},
|
|
7550
|
+
"500": {
|
|
7551
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
7552
|
+
}
|
|
7553
|
+
}
|
|
7554
|
+
}
|
|
7555
|
+
},
|
|
7467
7556
|
"/v2/portal/pages/default": {
|
|
7468
7557
|
"get": {
|
|
7469
7558
|
"operationId": "getDefaultPages",
|
|
@@ -8544,6 +8633,40 @@
|
|
|
8544
8633
|
"$ref": "#/components/schemas/EntityId",
|
|
8545
8634
|
"description": "List of contact IDs representing the contacts / business partners the invited user should be added to.\nWhen omitted, the user is automatically added to all contacts / business partners linked to the account.\n"
|
|
8546
8635
|
}
|
|
8636
|
+
},
|
|
8637
|
+
"contact_data": {
|
|
8638
|
+
"type": "object",
|
|
8639
|
+
"description": "Additional contact entity fields to set when creating the contact for the invited user.\nThese are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).\nValues can be strings or arrays of strings (for multiselect attributes).\n",
|
|
8640
|
+
"additionalProperties": {
|
|
8641
|
+
"oneOf": [
|
|
8642
|
+
{
|
|
8643
|
+
"type": "string"
|
|
8644
|
+
},
|
|
8645
|
+
{
|
|
8646
|
+
"type": "array",
|
|
8647
|
+
"items": {
|
|
8648
|
+
"type": "string"
|
|
8649
|
+
}
|
|
8650
|
+
}
|
|
8651
|
+
]
|
|
8652
|
+
}
|
|
8653
|
+
},
|
|
8654
|
+
"portal_user_data": {
|
|
8655
|
+
"type": "object",
|
|
8656
|
+
"description": "Additional portal user entity fields to set when creating the portal user for the invited user.\nThese are mapped directly to portal_user entity attributes.\nValues can be strings or arrays of strings (for multiselect attributes).\n",
|
|
8657
|
+
"additionalProperties": {
|
|
8658
|
+
"oneOf": [
|
|
8659
|
+
{
|
|
8660
|
+
"type": "string"
|
|
8661
|
+
},
|
|
8662
|
+
{
|
|
8663
|
+
"type": "array",
|
|
8664
|
+
"items": {
|
|
8665
|
+
"type": "string"
|
|
8666
|
+
}
|
|
8667
|
+
}
|
|
8668
|
+
]
|
|
8669
|
+
}
|
|
8547
8670
|
}
|
|
8548
8671
|
}
|
|
8549
8672
|
}
|
|
@@ -9159,6 +9282,7 @@
|
|
|
9159
9282
|
"properties": {
|
|
9160
9283
|
"confirmAccount": {
|
|
9161
9284
|
"$ref": "#/components/schemas/EntityId",
|
|
9285
|
+
"nullable": true,
|
|
9162
9286
|
"description": "ID of the confirmation email template upon registration"
|
|
9163
9287
|
},
|
|
9164
9288
|
"advancedAuth": {
|
|
@@ -9190,10 +9314,12 @@
|
|
|
9190
9314
|
},
|
|
9191
9315
|
"forgotPassword": {
|
|
9192
9316
|
"$ref": "#/components/schemas/EntityId",
|
|
9317
|
+
"nullable": true,
|
|
9193
9318
|
"description": "ID of the email template for forgot password"
|
|
9194
9319
|
},
|
|
9195
9320
|
"invitation": {
|
|
9196
9321
|
"$ref": "#/components/schemas/EntityId",
|
|
9322
|
+
"nullable": true,
|
|
9197
9323
|
"description": "ID of the email template for invitation when the user is just invited to register on the portal."
|
|
9198
9324
|
},
|
|
9199
9325
|
"partnerInvitation": {
|
|
@@ -9203,26 +9329,32 @@
|
|
|
9203
9329
|
},
|
|
9204
9330
|
"onNewQuote": {
|
|
9205
9331
|
"$ref": "#/components/schemas/EntityId",
|
|
9332
|
+
"nullable": true,
|
|
9206
9333
|
"description": "ID of the email template for new quote"
|
|
9207
9334
|
},
|
|
9208
9335
|
"onMapAPendingUser": {
|
|
9209
9336
|
"$ref": "#/components/schemas/EntityId",
|
|
9337
|
+
"nullable": true,
|
|
9210
9338
|
"description": "ID of the email template for mapping a pending portal user with a contact"
|
|
9211
9339
|
},
|
|
9212
9340
|
"onDocUpload": {
|
|
9213
9341
|
"$ref": "#/components/schemas/EntityId",
|
|
9342
|
+
"nullable": true,
|
|
9214
9343
|
"description": "ID of the email template for document upload"
|
|
9215
9344
|
},
|
|
9216
9345
|
"onWorkflowStepAssigned": {
|
|
9217
9346
|
"$ref": "#/components/schemas/EntityId",
|
|
9347
|
+
"nullable": true,
|
|
9218
9348
|
"description": "ID of the email template for workflow step assignment"
|
|
9219
9349
|
},
|
|
9220
9350
|
"confirmEmailUpdate": {
|
|
9221
9351
|
"$ref": "#/components/schemas/EntityId",
|
|
9352
|
+
"nullable": true,
|
|
9222
9353
|
"description": "ID of the email template for setting password while updating email"
|
|
9223
9354
|
},
|
|
9224
9355
|
"verifyCodeToSetPassword": {
|
|
9225
9356
|
"$ref": "#/components/schemas/EntityId",
|
|
9357
|
+
"nullable": true,
|
|
9226
9358
|
"description": "ID of the email template for setting password while verifying code"
|
|
9227
9359
|
}
|
|
9228
9360
|
}
|
|
@@ -9567,18 +9699,21 @@
|
|
|
9567
9699
|
"type": "boolean",
|
|
9568
9700
|
"description": "Mark true if the domain is an Epilot domain"
|
|
9569
9701
|
},
|
|
9570
|
-
"epilot_domain": {
|
|
9571
|
-
"type": "string",
|
|
9572
|
-
"description": "The URL on which the portal is accessible",
|
|
9573
|
-
"example": "example-portal-12345.ecp.epilot.cloud"
|
|
9574
|
-
},
|
|
9575
|
-
"domain_settings": {
|
|
9576
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
9577
|
-
},
|
|
9578
9702
|
"design_id": {
|
|
9579
9703
|
"$ref": "#/components/schemas/EntityId",
|
|
9580
9704
|
"description": "ID of the design used to build the portal"
|
|
9581
9705
|
},
|
|
9706
|
+
"allowed_portal_entities": {
|
|
9707
|
+
"type": "array",
|
|
9708
|
+
"items": {
|
|
9709
|
+
"type": "string"
|
|
9710
|
+
},
|
|
9711
|
+
"description": "Allowed portal entities for the portal",
|
|
9712
|
+
"example": [
|
|
9713
|
+
"contact",
|
|
9714
|
+
"contract"
|
|
9715
|
+
]
|
|
9716
|
+
},
|
|
9582
9717
|
"self_registration_setting": {
|
|
9583
9718
|
"type": "string",
|
|
9584
9719
|
"enum": [
|
|
@@ -9681,6 +9816,48 @@
|
|
|
9681
9816
|
"example": "eu-central-1_CUEQRNbUb",
|
|
9682
9817
|
"description": "Cognito user pool ID"
|
|
9683
9818
|
},
|
|
9819
|
+
"timeouts": {
|
|
9820
|
+
"type": "object",
|
|
9821
|
+
"description": "Timeouts for the cognito tokens",
|
|
9822
|
+
"properties": {
|
|
9823
|
+
"refresh_token": {
|
|
9824
|
+
"type": "integer",
|
|
9825
|
+
"example": 300,
|
|
9826
|
+
"description": "Timeout for the refresh token"
|
|
9827
|
+
},
|
|
9828
|
+
"access_token": {
|
|
9829
|
+
"type": "integer",
|
|
9830
|
+
"example": 300,
|
|
9831
|
+
"description": "Timeout for the access token"
|
|
9832
|
+
},
|
|
9833
|
+
"id_token": {
|
|
9834
|
+
"type": "integer",
|
|
9835
|
+
"example": 300,
|
|
9836
|
+
"description": "Timeout for the id token"
|
|
9837
|
+
}
|
|
9838
|
+
}
|
|
9839
|
+
},
|
|
9840
|
+
"advanced_authentication": {
|
|
9841
|
+
"type": "object",
|
|
9842
|
+
"description": "Advanced authentication settings for the portal",
|
|
9843
|
+
"properties": {
|
|
9844
|
+
"user_activity_logging": {
|
|
9845
|
+
"type": "boolean",
|
|
9846
|
+
"example": true,
|
|
9847
|
+
"description": "Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring."
|
|
9848
|
+
},
|
|
9849
|
+
"adaptive_authentication": {
|
|
9850
|
+
"type": "boolean",
|
|
9851
|
+
"example": true,
|
|
9852
|
+
"description": "Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time."
|
|
9853
|
+
},
|
|
9854
|
+
"compromised_credentials_detection": {
|
|
9855
|
+
"type": "boolean",
|
|
9856
|
+
"example": true,
|
|
9857
|
+
"description": "Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials."
|
|
9858
|
+
}
|
|
9859
|
+
}
|
|
9860
|
+
},
|
|
9684
9861
|
"password_policy": {
|
|
9685
9862
|
"type": "object",
|
|
9686
9863
|
"description": "Password policy for the portal",
|
|
@@ -10070,24 +10247,6 @@
|
|
|
10070
10247
|
}
|
|
10071
10248
|
}
|
|
10072
10249
|
},
|
|
10073
|
-
"DomainSettings": {
|
|
10074
|
-
"type": "object",
|
|
10075
|
-
"description": "Domain settings for the portal",
|
|
10076
|
-
"properties": {
|
|
10077
|
-
"is_custom_domain_enabled": {
|
|
10078
|
-
"type": "boolean",
|
|
10079
|
-
"description": "Whether the custom domain is enabled"
|
|
10080
|
-
},
|
|
10081
|
-
"is_epilot_domain_enabled": {
|
|
10082
|
-
"type": "boolean",
|
|
10083
|
-
"description": "Whether the Epilot domain is enabled"
|
|
10084
|
-
},
|
|
10085
|
-
"is_redirection_enabled": {
|
|
10086
|
-
"type": "boolean",
|
|
10087
|
-
"description": "Whether the redirection is enabled"
|
|
10088
|
-
}
|
|
10089
|
-
}
|
|
10090
|
-
},
|
|
10091
10250
|
"WidgetBase": {
|
|
10092
10251
|
"type": "object",
|
|
10093
10252
|
"required": [
|
|
@@ -10110,7 +10269,8 @@
|
|
|
10110
10269
|
"PAYMENT_WIDGET",
|
|
10111
10270
|
"METER_READING_WIDGET",
|
|
10112
10271
|
"METER_CHART_WIDGET",
|
|
10113
|
-
"CAMPAIGN_WIDGET"
|
|
10272
|
+
"CAMPAIGN_WIDGET",
|
|
10273
|
+
"PRODUCT_RECOMMENDATIONS_WIDGET"
|
|
10114
10274
|
]
|
|
10115
10275
|
},
|
|
10116
10276
|
"listIndex": {
|
|
@@ -10340,6 +10500,22 @@
|
|
|
10340
10500
|
}
|
|
10341
10501
|
]
|
|
10342
10502
|
},
|
|
10503
|
+
"ProductRecommendationsWidget": {
|
|
10504
|
+
"allOf": [
|
|
10505
|
+
{
|
|
10506
|
+
"$ref": "#/components/schemas/TeaserWidget"
|
|
10507
|
+
},
|
|
10508
|
+
{
|
|
10509
|
+
"type": "object",
|
|
10510
|
+
"properties": {
|
|
10511
|
+
"campaign_id": {
|
|
10512
|
+
"type": "string",
|
|
10513
|
+
"description": "ID of the campaign"
|
|
10514
|
+
}
|
|
10515
|
+
}
|
|
10516
|
+
}
|
|
10517
|
+
]
|
|
10518
|
+
},
|
|
10343
10519
|
"PortalWidget": {
|
|
10344
10520
|
"anyOf": [
|
|
10345
10521
|
{
|
|
@@ -10368,6 +10544,9 @@
|
|
|
10368
10544
|
},
|
|
10369
10545
|
{
|
|
10370
10546
|
"$ref": "#/components/schemas/CampaignWidget"
|
|
10547
|
+
},
|
|
10548
|
+
{
|
|
10549
|
+
"$ref": "#/components/schemas/ProductRecommendationsWidget"
|
|
10371
10550
|
}
|
|
10372
10551
|
]
|
|
10373
10552
|
},
|
|
@@ -10735,6 +10914,31 @@
|
|
|
10735
10914
|
"type": "string",
|
|
10736
10915
|
"example": "contact"
|
|
10737
10916
|
},
|
|
10917
|
+
"EntitySlugConfig": {
|
|
10918
|
+
"description": "Per-slug search configuration with scoped targets and templates",
|
|
10919
|
+
"type": "object",
|
|
10920
|
+
"required": [
|
|
10921
|
+
"slug"
|
|
10922
|
+
],
|
|
10923
|
+
"properties": {
|
|
10924
|
+
"slug": {
|
|
10925
|
+
"$ref": "#/components/schemas/EntitySlug"
|
|
10926
|
+
},
|
|
10927
|
+
"targets": {
|
|
10928
|
+
"type": "array",
|
|
10929
|
+
"items": {
|
|
10930
|
+
"type": "string",
|
|
10931
|
+
"format": "uuid"
|
|
10932
|
+
}
|
|
10933
|
+
},
|
|
10934
|
+
"templates": {
|
|
10935
|
+
"type": "object",
|
|
10936
|
+
"additionalProperties": {
|
|
10937
|
+
"type": "string"
|
|
10938
|
+
}
|
|
10939
|
+
}
|
|
10940
|
+
}
|
|
10941
|
+
},
|
|
10738
10942
|
"EntityId": {
|
|
10739
10943
|
"type": "string",
|
|
10740
10944
|
"format": "uuid",
|
|
@@ -10911,6 +11115,9 @@
|
|
|
10911
11115
|
"type": "number",
|
|
10912
11116
|
"description": "Number of entities returned in this response",
|
|
10913
11117
|
"example": 10
|
|
11118
|
+
},
|
|
11119
|
+
"includes": {
|
|
11120
|
+
"$ref": "#/components/schemas/SearchIncludes"
|
|
10914
11121
|
}
|
|
10915
11122
|
}
|
|
10916
11123
|
},
|
|
@@ -10993,6 +11200,22 @@
|
|
|
10993
11200
|
"type": "number",
|
|
10994
11201
|
"description": "Number of groups returned in this response",
|
|
10995
11202
|
"example": 5
|
|
11203
|
+
},
|
|
11204
|
+
"includes": {
|
|
11205
|
+
"$ref": "#/components/schemas/SearchIncludes"
|
|
11206
|
+
}
|
|
11207
|
+
}
|
|
11208
|
+
},
|
|
11209
|
+
"SearchIncludes": {
|
|
11210
|
+
"type": "object",
|
|
11211
|
+
"description": "Side-loaded enrichment data requested via the `include` parameter.",
|
|
11212
|
+
"properties": {
|
|
11213
|
+
"active_workflow": {
|
|
11214
|
+
"type": "object",
|
|
11215
|
+
"description": "The active workflow execution for each entity, keyed by entity ID. Only entities with an active workflow are present.",
|
|
11216
|
+
"additionalProperties": {
|
|
11217
|
+
"type": "object"
|
|
11218
|
+
}
|
|
10996
11219
|
}
|
|
10997
11220
|
}
|
|
10998
11221
|
},
|
|
@@ -12303,9 +12526,16 @@
|
|
|
12303
12526
|
"$ref": "#/components/schemas/EntitySlug"
|
|
12304
12527
|
},
|
|
12305
12528
|
"minItems": 1
|
|
12529
|
+
},
|
|
12530
|
+
{
|
|
12531
|
+
"type": "array",
|
|
12532
|
+
"items": {
|
|
12533
|
+
"$ref": "#/components/schemas/EntitySlugConfig"
|
|
12534
|
+
},
|
|
12535
|
+
"minItems": 1
|
|
12306
12536
|
}
|
|
12307
12537
|
],
|
|
12308
|
-
"description": "
|
|
12538
|
+
"description": "Entity slug, array of slugs, or array of per-slug configurations"
|
|
12309
12539
|
},
|
|
12310
12540
|
"q": {
|
|
12311
12541
|
"type": "string",
|
|
@@ -12469,6 +12699,19 @@
|
|
|
12469
12699
|
"example": [
|
|
12470
12700
|
"3ec28ab5-8598-41ef-9486-b57fca1d5e2a"
|
|
12471
12701
|
]
|
|
12702
|
+
},
|
|
12703
|
+
"include": {
|
|
12704
|
+
"type": "array",
|
|
12705
|
+
"description": "Optional enrichment data to side-load alongside results under the `includes` response key.",
|
|
12706
|
+
"items": {
|
|
12707
|
+
"type": "string",
|
|
12708
|
+
"enum": [
|
|
12709
|
+
"active_workflow"
|
|
12710
|
+
]
|
|
12711
|
+
},
|
|
12712
|
+
"example": [
|
|
12713
|
+
"active_workflow"
|
|
12714
|
+
]
|
|
12472
12715
|
}
|
|
12473
12716
|
},
|
|
12474
12717
|
"required": [
|
|
@@ -13090,6 +13333,9 @@
|
|
|
13090
13333
|
"type": "boolean",
|
|
13091
13334
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13092
13335
|
"default": false
|
|
13336
|
+
},
|
|
13337
|
+
"secure_proxy": {
|
|
13338
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13093
13339
|
}
|
|
13094
13340
|
},
|
|
13095
13341
|
"required": [
|
|
@@ -13189,6 +13435,9 @@
|
|
|
13189
13435
|
"type": "boolean",
|
|
13190
13436
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13191
13437
|
"default": false
|
|
13438
|
+
},
|
|
13439
|
+
"secure_proxy": {
|
|
13440
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13192
13441
|
}
|
|
13193
13442
|
},
|
|
13194
13443
|
"required": [
|
|
@@ -13296,6 +13545,9 @@
|
|
|
13296
13545
|
"type": "boolean",
|
|
13297
13546
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13298
13547
|
"default": false
|
|
13548
|
+
},
|
|
13549
|
+
"secure_proxy": {
|
|
13550
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13299
13551
|
}
|
|
13300
13552
|
},
|
|
13301
13553
|
"required": [
|
|
@@ -13371,6 +13623,9 @@
|
|
|
13371
13623
|
"type": "boolean",
|
|
13372
13624
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13373
13625
|
"default": false
|
|
13626
|
+
},
|
|
13627
|
+
"secure_proxy": {
|
|
13628
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13374
13629
|
}
|
|
13375
13630
|
},
|
|
13376
13631
|
"required": [
|
|
@@ -13445,6 +13700,9 @@
|
|
|
13445
13700
|
"type": "boolean",
|
|
13446
13701
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13447
13702
|
"default": false
|
|
13703
|
+
},
|
|
13704
|
+
"secure_proxy": {
|
|
13705
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13448
13706
|
}
|
|
13449
13707
|
},
|
|
13450
13708
|
"required": [
|
|
@@ -13519,6 +13777,9 @@
|
|
|
13519
13777
|
"type": "boolean",
|
|
13520
13778
|
"description": "If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.",
|
|
13521
13779
|
"default": false
|
|
13780
|
+
},
|
|
13781
|
+
"secure_proxy": {
|
|
13782
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13522
13783
|
}
|
|
13523
13784
|
},
|
|
13524
13785
|
"required": [
|
|
@@ -13526,6 +13787,25 @@
|
|
|
13526
13787
|
"call"
|
|
13527
13788
|
]
|
|
13528
13789
|
},
|
|
13790
|
+
"SecureProxyConfig": {
|
|
13791
|
+
"type": "object",
|
|
13792
|
+
"description": "Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.",
|
|
13793
|
+
"properties": {
|
|
13794
|
+
"integration_id": {
|
|
13795
|
+
"type": "string",
|
|
13796
|
+
"format": "uuid",
|
|
13797
|
+
"description": "Integration ID that owns the secure_proxy use case."
|
|
13798
|
+
},
|
|
13799
|
+
"use_case_slug": {
|
|
13800
|
+
"type": "string",
|
|
13801
|
+
"description": "Use case slug for the secure proxy use case."
|
|
13802
|
+
}
|
|
13803
|
+
},
|
|
13804
|
+
"required": [
|
|
13805
|
+
"integration_id",
|
|
13806
|
+
"use_case_slug"
|
|
13807
|
+
]
|
|
13808
|
+
},
|
|
13529
13809
|
"ExtensionAuthBlock": {
|
|
13530
13810
|
"type": "object",
|
|
13531
13811
|
"properties": {
|
|
@@ -13676,7 +13956,7 @@
|
|
|
13676
13956
|
"timestamp": {
|
|
13677
13957
|
"type": "string",
|
|
13678
13958
|
"description": "If the value is not provided, the system will be set with the time the request is processed.",
|
|
13679
|
-
"example": "2022-10-
|
|
13959
|
+
"example": "2022-10-10"
|
|
13680
13960
|
},
|
|
13681
13961
|
"source": {
|
|
13682
13962
|
"$ref": "#/components/schemas/Source",
|
|
@@ -14212,7 +14492,65 @@
|
|
|
14212
14492
|
"visibility": {
|
|
14213
14493
|
"type": "object",
|
|
14214
14494
|
"description": "The conditions that need to be met for the block to be shown",
|
|
14215
|
-
"additionalProperties": true
|
|
14495
|
+
"additionalProperties": true,
|
|
14496
|
+
"properties": {
|
|
14497
|
+
"is_hidden": {
|
|
14498
|
+
"type": "boolean",
|
|
14499
|
+
"description": "Block is fully hidden from portal users"
|
|
14500
|
+
},
|
|
14501
|
+
"hidden_on_mobile": {
|
|
14502
|
+
"type": "boolean",
|
|
14503
|
+
"description": "Block is hidden on mobile viewports"
|
|
14504
|
+
},
|
|
14505
|
+
"hidden_on_desktop": {
|
|
14506
|
+
"type": "boolean",
|
|
14507
|
+
"description": "Block is hidden on desktop viewports"
|
|
14508
|
+
},
|
|
14509
|
+
"hidden_in_app": {
|
|
14510
|
+
"type": "boolean",
|
|
14511
|
+
"description": "Block is hidden in the mobile app"
|
|
14512
|
+
},
|
|
14513
|
+
"start_date": {
|
|
14514
|
+
"type": "string",
|
|
14515
|
+
"format": "date-time",
|
|
14516
|
+
"description": "Schedule visibility start date. If only start_date is set, block is visible from this date onwards."
|
|
14517
|
+
},
|
|
14518
|
+
"end_date": {
|
|
14519
|
+
"type": "string",
|
|
14520
|
+
"format": "date-time",
|
|
14521
|
+
"description": "Schedule visibility end date. If only end_date is set, block is visible until this date."
|
|
14522
|
+
},
|
|
14523
|
+
"visible_for_targets": {
|
|
14524
|
+
"type": "array",
|
|
14525
|
+
"items": {
|
|
14526
|
+
"type": "string"
|
|
14527
|
+
},
|
|
14528
|
+
"description": "Target IDs that must match for the block to be visible"
|
|
14529
|
+
},
|
|
14530
|
+
"visible_for_operator": {
|
|
14531
|
+
"type": "string",
|
|
14532
|
+
"enum": [
|
|
14533
|
+
"and",
|
|
14534
|
+
"or"
|
|
14535
|
+
],
|
|
14536
|
+
"description": "Operator for visible_for_targets matching"
|
|
14537
|
+
},
|
|
14538
|
+
"hidden_for_targets": {
|
|
14539
|
+
"type": "array",
|
|
14540
|
+
"items": {
|
|
14541
|
+
"type": "string"
|
|
14542
|
+
},
|
|
14543
|
+
"description": "Target IDs that if matched will hide the block"
|
|
14544
|
+
},
|
|
14545
|
+
"hidden_for_operator": {
|
|
14546
|
+
"type": "string",
|
|
14547
|
+
"enum": [
|
|
14548
|
+
"and",
|
|
14549
|
+
"or"
|
|
14550
|
+
],
|
|
14551
|
+
"description": "Operator for hidden_for_targets matching"
|
|
14552
|
+
}
|
|
14553
|
+
}
|
|
14216
14554
|
},
|
|
14217
14555
|
"content": {
|
|
14218
14556
|
"type": "object",
|
|
@@ -14311,7 +14649,57 @@
|
|
|
14311
14649
|
"visibility": {
|
|
14312
14650
|
"type": "object",
|
|
14313
14651
|
"description": "The conditions that need to be met for the page to be shown",
|
|
14314
|
-
"additionalProperties": true
|
|
14652
|
+
"additionalProperties": true,
|
|
14653
|
+
"properties": {
|
|
14654
|
+
"is_hidden": {
|
|
14655
|
+
"type": "boolean",
|
|
14656
|
+
"description": "Page is fully hidden from portal users"
|
|
14657
|
+
},
|
|
14658
|
+
"hidden_in_app": {
|
|
14659
|
+
"type": "boolean",
|
|
14660
|
+
"description": "Page is hidden in the mobile app"
|
|
14661
|
+
},
|
|
14662
|
+
"start_date": {
|
|
14663
|
+
"type": "string",
|
|
14664
|
+
"format": "date-time",
|
|
14665
|
+
"description": "Schedule visibility start date. If only start_date is set, page is visible from this date onwards."
|
|
14666
|
+
},
|
|
14667
|
+
"end_date": {
|
|
14668
|
+
"type": "string",
|
|
14669
|
+
"format": "date-time",
|
|
14670
|
+
"description": "Schedule visibility end date. If only end_date is set, page is visible until this date."
|
|
14671
|
+
},
|
|
14672
|
+
"visible_for_targets": {
|
|
14673
|
+
"type": "array",
|
|
14674
|
+
"items": {
|
|
14675
|
+
"type": "string"
|
|
14676
|
+
},
|
|
14677
|
+
"description": "Target IDs that must match for the page to be visible"
|
|
14678
|
+
},
|
|
14679
|
+
"visible_for_operator": {
|
|
14680
|
+
"type": "string",
|
|
14681
|
+
"enum": [
|
|
14682
|
+
"and",
|
|
14683
|
+
"or"
|
|
14684
|
+
],
|
|
14685
|
+
"description": "Operator for visible_for_targets matching"
|
|
14686
|
+
},
|
|
14687
|
+
"hidden_for_targets": {
|
|
14688
|
+
"type": "array",
|
|
14689
|
+
"items": {
|
|
14690
|
+
"type": "string"
|
|
14691
|
+
},
|
|
14692
|
+
"description": "Target IDs that if matched will hide the page"
|
|
14693
|
+
},
|
|
14694
|
+
"hidden_for_operator": {
|
|
14695
|
+
"type": "string",
|
|
14696
|
+
"enum": [
|
|
14697
|
+
"and",
|
|
14698
|
+
"or"
|
|
14699
|
+
],
|
|
14700
|
+
"description": "Operator for hidden_for_targets matching"
|
|
14701
|
+
}
|
|
14702
|
+
}
|
|
14315
14703
|
},
|
|
14316
14704
|
"content": {
|
|
14317
14705
|
"type": "object",
|
|
@@ -14349,6 +14737,11 @@
|
|
|
14349
14737
|
"description": "The schema of the detail page",
|
|
14350
14738
|
"example": "contact"
|
|
14351
14739
|
},
|
|
14740
|
+
"show_in_navigation": {
|
|
14741
|
+
"type": "boolean",
|
|
14742
|
+
"description": "Whether the detail page should appear in the main navigation",
|
|
14743
|
+
"example": false
|
|
14744
|
+
},
|
|
14352
14745
|
"is_public": {
|
|
14353
14746
|
"type": "boolean",
|
|
14354
14747
|
"description": "Whether the page is public",
|
|
@@ -14356,6 +14749,7 @@
|
|
|
14356
14749
|
},
|
|
14357
14750
|
"parentId": {
|
|
14358
14751
|
"type": "string",
|
|
14752
|
+
"nullable": true,
|
|
14359
14753
|
"description": "The id of the parent page",
|
|
14360
14754
|
"example": "c495fef9-eeca-4019-a989-8390dcd9825b"
|
|
14361
14755
|
},
|
|
@@ -14418,18 +14812,21 @@
|
|
|
14418
14812
|
"type": "boolean",
|
|
14419
14813
|
"description": "Mark true if the domain is an Epilot domain"
|
|
14420
14814
|
},
|
|
14421
|
-
"epilot_domain": {
|
|
14422
|
-
"type": "string",
|
|
14423
|
-
"description": "The Epilot domain on which the portal is accessible",
|
|
14424
|
-
"example": "example-portal-1.ecp.epilot.io"
|
|
14425
|
-
},
|
|
14426
|
-
"domain_settings": {
|
|
14427
|
-
"$ref": "#/components/schemas/DomainSettings"
|
|
14428
|
-
},
|
|
14429
14815
|
"design_id": {
|
|
14430
14816
|
"$ref": "#/components/schemas/EntityId",
|
|
14431
14817
|
"description": "ID of the design used to build the portal"
|
|
14432
14818
|
},
|
|
14819
|
+
"allowed_portal_entities": {
|
|
14820
|
+
"type": "array",
|
|
14821
|
+
"items": {
|
|
14822
|
+
"type": "string"
|
|
14823
|
+
},
|
|
14824
|
+
"description": "Allowed portal entities for the portal",
|
|
14825
|
+
"example": [
|
|
14826
|
+
"contact",
|
|
14827
|
+
"contract"
|
|
14828
|
+
]
|
|
14829
|
+
},
|
|
14433
14830
|
"self_registration_setting": {
|
|
14434
14831
|
"type": "string",
|
|
14435
14832
|
"enum": [
|
|
@@ -14532,6 +14929,48 @@
|
|
|
14532
14929
|
"example": "eu-central-1_CUEQRNbUb",
|
|
14533
14930
|
"description": "Cognito user pool ID"
|
|
14534
14931
|
},
|
|
14932
|
+
"timeouts": {
|
|
14933
|
+
"type": "object",
|
|
14934
|
+
"description": "Timeouts for the cognito tokens",
|
|
14935
|
+
"properties": {
|
|
14936
|
+
"refresh_token": {
|
|
14937
|
+
"type": "integer",
|
|
14938
|
+
"example": 300,
|
|
14939
|
+
"description": "Timeout for the refresh token"
|
|
14940
|
+
},
|
|
14941
|
+
"access_token": {
|
|
14942
|
+
"type": "integer",
|
|
14943
|
+
"example": 300,
|
|
14944
|
+
"description": "Timeout for the access token"
|
|
14945
|
+
},
|
|
14946
|
+
"id_token": {
|
|
14947
|
+
"type": "integer",
|
|
14948
|
+
"example": 300,
|
|
14949
|
+
"description": "Timeout for the id token"
|
|
14950
|
+
}
|
|
14951
|
+
}
|
|
14952
|
+
},
|
|
14953
|
+
"advanced_authentication": {
|
|
14954
|
+
"type": "object",
|
|
14955
|
+
"description": "Advanced authentication settings for the portal",
|
|
14956
|
+
"properties": {
|
|
14957
|
+
"user_activity_logging": {
|
|
14958
|
+
"type": "boolean",
|
|
14959
|
+
"example": true,
|
|
14960
|
+
"description": "Enables detailed logging of user authentication attempts including risk assessments, IP addresses, user agents, and device information. These logs can be used for security analysis and monitoring."
|
|
14961
|
+
},
|
|
14962
|
+
"adaptive_authentication": {
|
|
14963
|
+
"type": "boolean",
|
|
14964
|
+
"example": true,
|
|
14965
|
+
"description": "Automatically assesses risk for every authentication session. Based on risk ratings, can block authentication or require MFA for suspicious sign-in attempts. Helps protect user accounts from potential attacks by adapting security measures in real-time."
|
|
14966
|
+
},
|
|
14967
|
+
"compromised_credentials_detection": {
|
|
14968
|
+
"type": "boolean",
|
|
14969
|
+
"example": true,
|
|
14970
|
+
"description": "Checks passwords against databases of leaked and commonly-guessed passwords during sign-up, sign-in, and password reset. Blocks or warns users when insecure passwords are detected, preventing unauthorized access from compromised credentials."
|
|
14971
|
+
}
|
|
14972
|
+
}
|
|
14973
|
+
},
|
|
14535
14974
|
"password_policy": {
|
|
14536
14975
|
"type": "object",
|
|
14537
14976
|
"description": "Password policy for the portal",
|
|
@@ -14929,11 +15368,6 @@
|
|
|
14929
15368
|
"is_canary": {
|
|
14930
15369
|
"type": "boolean",
|
|
14931
15370
|
"description": "Whether the org is in canary mode"
|
|
14932
|
-
},
|
|
14933
|
-
"redirect_to": {
|
|
14934
|
-
"type": "string",
|
|
14935
|
-
"description": "The URL to redirect to",
|
|
14936
|
-
"example": "https://example.com"
|
|
14937
15371
|
}
|
|
14938
15372
|
}
|
|
14939
15373
|
},
|