@epilot/customer-portal-client 0.34.0 → 0.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +102 -6
- package/dist/openapi.d.ts +394 -47
- package/package.json +14 -13
- package/src/openapi-runtime.json +102 -6
- package/src/openapi.json +477 -38
- package/LICENSE +0 -21
- package/src/openapi.d.ts +0 -15754
package/src/openapi.json
CHANGED
|
@@ -199,7 +199,7 @@
|
|
|
199
199
|
"post": {
|
|
200
200
|
"operationId": "createUserV3",
|
|
201
201
|
"summary": "createUserV3",
|
|
202
|
-
"description": "Registers a portal user
|
|
202
|
+
"description": "Registers a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
203
203
|
"security": [],
|
|
204
204
|
"tags": [
|
|
205
205
|
"Public"
|
|
@@ -208,11 +208,20 @@
|
|
|
208
208
|
{
|
|
209
209
|
"in": "query",
|
|
210
210
|
"name": "portal_id",
|
|
211
|
-
"required":
|
|
211
|
+
"required": false,
|
|
212
212
|
"schema": {
|
|
213
213
|
"$ref": "#/components/schemas/PortalId"
|
|
214
214
|
},
|
|
215
|
-
"description": "
|
|
215
|
+
"description": "Portal ID (required if domain is not provided)"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"in": "query",
|
|
219
|
+
"name": "domain",
|
|
220
|
+
"required": false,
|
|
221
|
+
"schema": {
|
|
222
|
+
"type": "string"
|
|
223
|
+
},
|
|
224
|
+
"description": "Portal domain for identification (alternative to portal_id)"
|
|
216
225
|
}
|
|
217
226
|
],
|
|
218
227
|
"requestBody": {
|
|
@@ -2110,7 +2119,8 @@
|
|
|
2110
2119
|
"get": {
|
|
2111
2120
|
"operationId": "getPublicPortalWidgets",
|
|
2112
2121
|
"summary": "getPublicPortalWidgets",
|
|
2113
|
-
"description": "Retrieves the public widgets of a portal",
|
|
2122
|
+
"description": "Retrieves the public widgets of a portal.",
|
|
2123
|
+
"deprecated": true,
|
|
2114
2124
|
"tags": [
|
|
2115
2125
|
"Public"
|
|
2116
2126
|
],
|
|
@@ -2164,6 +2174,7 @@
|
|
|
2164
2174
|
"operationId": "upsertPortalWidget",
|
|
2165
2175
|
"summary": "upsertPortalWidget",
|
|
2166
2176
|
"description": "Upsert widget for a portal of an organization.",
|
|
2177
|
+
"deprecated": true,
|
|
2167
2178
|
"security": [
|
|
2168
2179
|
{
|
|
2169
2180
|
"EpilotAuth": []
|
|
@@ -2222,7 +2233,8 @@
|
|
|
2222
2233
|
"get": {
|
|
2223
2234
|
"operationId": "getPortalWidgets",
|
|
2224
2235
|
"summary": "getPortalWidgets",
|
|
2225
|
-
"description": "Retrieves the widgets of a portal",
|
|
2236
|
+
"description": "Retrieves the widgets of a portal.",
|
|
2237
|
+
"deprecated": true,
|
|
2226
2238
|
"tags": [
|
|
2227
2239
|
"ECP Admin",
|
|
2228
2240
|
"ECP"
|
|
@@ -2275,6 +2287,194 @@
|
|
|
2275
2287
|
}
|
|
2276
2288
|
}
|
|
2277
2289
|
},
|
|
2290
|
+
"/v3/portal/widgets": {
|
|
2291
|
+
"get": {
|
|
2292
|
+
"operationId": "getPortalWidgetsV3",
|
|
2293
|
+
"summary": "getPortalWidgetsV3",
|
|
2294
|
+
"description": "Retrieves the widgets of a portal by portal_id.",
|
|
2295
|
+
"tags": [
|
|
2296
|
+
"ECP Admin",
|
|
2297
|
+
"ECP"
|
|
2298
|
+
],
|
|
2299
|
+
"security": [
|
|
2300
|
+
{
|
|
2301
|
+
"EitherAuth": []
|
|
2302
|
+
}
|
|
2303
|
+
],
|
|
2304
|
+
"parameters": [
|
|
2305
|
+
{
|
|
2306
|
+
"in": "query",
|
|
2307
|
+
"name": "portal_id",
|
|
2308
|
+
"required": true,
|
|
2309
|
+
"schema": {
|
|
2310
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2311
|
+
},
|
|
2312
|
+
"description": "PortalId of the portal"
|
|
2313
|
+
},
|
|
2314
|
+
{
|
|
2315
|
+
"in": "query",
|
|
2316
|
+
"name": "contract_id",
|
|
2317
|
+
"required": false,
|
|
2318
|
+
"schema": {
|
|
2319
|
+
"$ref": "#/components/schemas/EntityId"
|
|
2320
|
+
},
|
|
2321
|
+
"description": "Contract context for widgets"
|
|
2322
|
+
}
|
|
2323
|
+
],
|
|
2324
|
+
"responses": {
|
|
2325
|
+
"200": {
|
|
2326
|
+
"description": "Retrieved the portal widgets successfully.",
|
|
2327
|
+
"content": {
|
|
2328
|
+
"application/json": {
|
|
2329
|
+
"schema": {
|
|
2330
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2331
|
+
}
|
|
2332
|
+
}
|
|
2333
|
+
}
|
|
2334
|
+
},
|
|
2335
|
+
"401": {
|
|
2336
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2337
|
+
},
|
|
2338
|
+
"403": {
|
|
2339
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2340
|
+
},
|
|
2341
|
+
"500": {
|
|
2342
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2343
|
+
}
|
|
2344
|
+
}
|
|
2345
|
+
},
|
|
2346
|
+
"post": {
|
|
2347
|
+
"operationId": "upsertPortalWidgetV3",
|
|
2348
|
+
"summary": "upsertPortalWidgetV3",
|
|
2349
|
+
"description": "Upsert widget for a portal by portal_id.",
|
|
2350
|
+
"security": [
|
|
2351
|
+
{
|
|
2352
|
+
"EpilotAuth": []
|
|
2353
|
+
}
|
|
2354
|
+
],
|
|
2355
|
+
"tags": [
|
|
2356
|
+
"ECP Admin"
|
|
2357
|
+
],
|
|
2358
|
+
"parameters": [
|
|
2359
|
+
{
|
|
2360
|
+
"in": "query",
|
|
2361
|
+
"name": "portal_id",
|
|
2362
|
+
"required": true,
|
|
2363
|
+
"schema": {
|
|
2364
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2365
|
+
},
|
|
2366
|
+
"description": "PortalId of the portal"
|
|
2367
|
+
}
|
|
2368
|
+
],
|
|
2369
|
+
"requestBody": {
|
|
2370
|
+
"description": "Portal widgets payload",
|
|
2371
|
+
"required": true,
|
|
2372
|
+
"content": {
|
|
2373
|
+
"application/json": {
|
|
2374
|
+
"schema": {
|
|
2375
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2376
|
+
}
|
|
2377
|
+
}
|
|
2378
|
+
}
|
|
2379
|
+
},
|
|
2380
|
+
"responses": {
|
|
2381
|
+
"201": {
|
|
2382
|
+
"description": "Portal widget configuration upserted successfully.",
|
|
2383
|
+
"content": {
|
|
2384
|
+
"application/json": {
|
|
2385
|
+
"schema": {
|
|
2386
|
+
"$ref": "#/components/schemas/UpsertPortalWidget"
|
|
2387
|
+
}
|
|
2388
|
+
}
|
|
2389
|
+
}
|
|
2390
|
+
},
|
|
2391
|
+
"400": {
|
|
2392
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
2393
|
+
},
|
|
2394
|
+
"401": {
|
|
2395
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2396
|
+
},
|
|
2397
|
+
"403": {
|
|
2398
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2399
|
+
},
|
|
2400
|
+
"500": {
|
|
2401
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
2405
|
+
},
|
|
2406
|
+
"/v3/portal/portal/files": {
|
|
2407
|
+
"post": {
|
|
2408
|
+
"operationId": "savePortalFilesV3",
|
|
2409
|
+
"summary": "savePortalFilesV3",
|
|
2410
|
+
"description": "Add files to portal by portal_id",
|
|
2411
|
+
"tags": [
|
|
2412
|
+
"ECP Admin"
|
|
2413
|
+
],
|
|
2414
|
+
"security": [
|
|
2415
|
+
{
|
|
2416
|
+
"EpilotAuth": []
|
|
2417
|
+
}
|
|
2418
|
+
],
|
|
2419
|
+
"parameters": [
|
|
2420
|
+
{
|
|
2421
|
+
"in": "query",
|
|
2422
|
+
"name": "portal_id",
|
|
2423
|
+
"required": true,
|
|
2424
|
+
"schema": {
|
|
2425
|
+
"$ref": "#/components/schemas/PortalId"
|
|
2426
|
+
},
|
|
2427
|
+
"description": "PortalId of the portal"
|
|
2428
|
+
}
|
|
2429
|
+
],
|
|
2430
|
+
"requestBody": {
|
|
2431
|
+
"description": "portal files request",
|
|
2432
|
+
"required": true,
|
|
2433
|
+
"content": {
|
|
2434
|
+
"application/json": {
|
|
2435
|
+
"schema": {
|
|
2436
|
+
"$ref": "#/components/schemas/SavePortalFile"
|
|
2437
|
+
}
|
|
2438
|
+
}
|
|
2439
|
+
}
|
|
2440
|
+
},
|
|
2441
|
+
"responses": {
|
|
2442
|
+
"201": {
|
|
2443
|
+
"description": "The files have been saved to the portal successfully.",
|
|
2444
|
+
"content": {
|
|
2445
|
+
"application/json": {
|
|
2446
|
+
"schema": {
|
|
2447
|
+
"type": "object",
|
|
2448
|
+
"properties": {
|
|
2449
|
+
"createdFiles": {
|
|
2450
|
+
"type": "array",
|
|
2451
|
+
"items": {
|
|
2452
|
+
"$ref": "#/components/schemas/File"
|
|
2453
|
+
}
|
|
2454
|
+
}
|
|
2455
|
+
}
|
|
2456
|
+
}
|
|
2457
|
+
}
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"400": {
|
|
2461
|
+
"$ref": "#/components/responses/InvalidRequest"
|
|
2462
|
+
},
|
|
2463
|
+
"401": {
|
|
2464
|
+
"$ref": "#/components/responses/Unauthorized"
|
|
2465
|
+
},
|
|
2466
|
+
"403": {
|
|
2467
|
+
"$ref": "#/components/responses/Forbidden"
|
|
2468
|
+
},
|
|
2469
|
+
"404": {
|
|
2470
|
+
"$ref": "#/components/responses/NotFound"
|
|
2471
|
+
},
|
|
2472
|
+
"500": {
|
|
2473
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
2474
|
+
}
|
|
2475
|
+
}
|
|
2476
|
+
}
|
|
2477
|
+
},
|
|
2278
2478
|
"/v2/portal/replace-ecp-template-variables": {
|
|
2279
2479
|
"post": {
|
|
2280
2480
|
"operationId": "replaceECPTemplateVariables",
|
|
@@ -2826,6 +3026,7 @@
|
|
|
2826
3026
|
"operationId": "updateContact",
|
|
2827
3027
|
"summary": "updateContact",
|
|
2828
3028
|
"description": "Updates the contact details.",
|
|
3029
|
+
"deprecated": true,
|
|
2829
3030
|
"tags": [
|
|
2830
3031
|
"ECP"
|
|
2831
3032
|
],
|
|
@@ -2997,7 +3198,7 @@
|
|
|
2997
3198
|
"post": {
|
|
2998
3199
|
"operationId": "checkContactExistsV3",
|
|
2999
3200
|
"summary": "checkContactExistsV3",
|
|
3000
|
-
"description": "True if contact with given identifiers exists.",
|
|
3201
|
+
"description": "True if contact with given identifiers exists.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
3001
3202
|
"security": [],
|
|
3002
3203
|
"tags": [
|
|
3003
3204
|
"Public"
|
|
@@ -3006,11 +3207,20 @@
|
|
|
3006
3207
|
{
|
|
3007
3208
|
"in": "query",
|
|
3008
3209
|
"name": "portal_id",
|
|
3009
|
-
"required":
|
|
3210
|
+
"required": false,
|
|
3010
3211
|
"schema": {
|
|
3011
3212
|
"$ref": "#/components/schemas/PortalId"
|
|
3012
3213
|
},
|
|
3013
|
-
"description": "PortalId of the portal"
|
|
3214
|
+
"description": "PortalId of the portal (required if domain is not provided)"
|
|
3215
|
+
},
|
|
3216
|
+
{
|
|
3217
|
+
"in": "query",
|
|
3218
|
+
"name": "domain",
|
|
3219
|
+
"required": false,
|
|
3220
|
+
"schema": {
|
|
3221
|
+
"type": "string"
|
|
3222
|
+
},
|
|
3223
|
+
"description": "Portal domain for identification (alternative to portal_id)"
|
|
3014
3224
|
}
|
|
3015
3225
|
],
|
|
3016
3226
|
"requestBody": {
|
|
@@ -3613,7 +3823,7 @@
|
|
|
3613
3823
|
"get": {
|
|
3614
3824
|
"operationId": "userExistsV3",
|
|
3615
3825
|
"summary": "userExistsV3",
|
|
3616
|
-
"description": "Checks whether a user exists in the portal",
|
|
3826
|
+
"description": "Checks whether a user exists in the portal.\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
|
|
3617
3827
|
"tags": [
|
|
3618
3828
|
"Public"
|
|
3619
3829
|
],
|
|
@@ -3632,10 +3842,10 @@
|
|
|
3632
3842
|
{
|
|
3633
3843
|
"in": "query",
|
|
3634
3844
|
"name": "org_id",
|
|
3635
|
-
"required":
|
|
3845
|
+
"required": false,
|
|
3636
3846
|
"schema": {
|
|
3637
3847
|
"type": "string",
|
|
3638
|
-
"description": "Organization ID",
|
|
3848
|
+
"description": "Organization ID (required if domain is not provided)",
|
|
3639
3849
|
"example": 123
|
|
3640
3850
|
}
|
|
3641
3851
|
},
|
|
@@ -3643,10 +3853,19 @@
|
|
|
3643
3853
|
"in": "query",
|
|
3644
3854
|
"name": "portal_id",
|
|
3645
3855
|
"required": false,
|
|
3646
|
-
"description": "
|
|
3856
|
+
"description": "Checks if user exists in the given portal ID. If not provided, checks in all portals.",
|
|
3647
3857
|
"schema": {
|
|
3648
3858
|
"$ref": "#/components/schemas/PortalId"
|
|
3649
3859
|
}
|
|
3860
|
+
},
|
|
3861
|
+
{
|
|
3862
|
+
"in": "query",
|
|
3863
|
+
"name": "domain",
|
|
3864
|
+
"required": false,
|
|
3865
|
+
"schema": {
|
|
3866
|
+
"type": "string"
|
|
3867
|
+
},
|
|
3868
|
+
"description": "Portal domain for identification (alternative to org_id + portal_id)"
|
|
3650
3869
|
}
|
|
3651
3870
|
],
|
|
3652
3871
|
"responses": {
|
|
@@ -3881,7 +4100,8 @@
|
|
|
3881
4100
|
"get": {
|
|
3882
4101
|
"operationId": "getAllOrders",
|
|
3883
4102
|
"summary": "getAllOrders",
|
|
3884
|
-
"description": "Get all orders for the portal user",
|
|
4103
|
+
"description": "Get all orders for the portal user. Use searchPortalUserEntities instead.",
|
|
4104
|
+
"deprecated": true,
|
|
3885
4105
|
"tags": [
|
|
3886
4106
|
"ECP"
|
|
3887
4107
|
],
|
|
@@ -4028,7 +4248,8 @@
|
|
|
4028
4248
|
"get": {
|
|
4029
4249
|
"operationId": "getOrder",
|
|
4030
4250
|
"summary": "getOrder",
|
|
4031
|
-
"description": "Get an order by id",
|
|
4251
|
+
"description": "Get an order by id. Use getPortalUserEntity instead.",
|
|
4252
|
+
"deprecated": true,
|
|
4032
4253
|
"tags": [
|
|
4033
4254
|
"ECP"
|
|
4034
4255
|
],
|
|
@@ -4122,7 +4343,8 @@
|
|
|
4122
4343
|
"patch": {
|
|
4123
4344
|
"operationId": "updateOrder",
|
|
4124
4345
|
"summary": "updateOrder",
|
|
4125
|
-
"description": "Update an order by id",
|
|
4346
|
+
"description": "Update an order by id. Use getPortalUserEntity instead.",
|
|
4347
|
+
"deprecated": true,
|
|
4126
4348
|
"tags": [
|
|
4127
4349
|
"ECP"
|
|
4128
4350
|
],
|
|
@@ -4186,7 +4408,8 @@
|
|
|
4186
4408
|
"get": {
|
|
4187
4409
|
"operationId": "getAllOpportunities",
|
|
4188
4410
|
"summary": "getAllOpportunities",
|
|
4189
|
-
"description": "Get all opportunities of a portal user",
|
|
4411
|
+
"description": "Get all opportunities of a portal user. Use searchPortalUserEntities instead.",
|
|
4412
|
+
"deprecated": true,
|
|
4190
4413
|
"tags": [
|
|
4191
4414
|
"ECP"
|
|
4192
4415
|
],
|
|
@@ -4269,7 +4492,8 @@
|
|
|
4269
4492
|
"get": {
|
|
4270
4493
|
"operationId": "getSearchableAttributesForOpportunities",
|
|
4271
4494
|
"summary": "getSearchableAttributesForOpportunities",
|
|
4272
|
-
"description": "Get all opportunity searchable attributes for a portal user",
|
|
4495
|
+
"description": "Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.",
|
|
4496
|
+
"deprecated": true,
|
|
4273
4497
|
"tags": [
|
|
4274
4498
|
"ECP"
|
|
4275
4499
|
],
|
|
@@ -4340,7 +4564,8 @@
|
|
|
4340
4564
|
"post": {
|
|
4341
4565
|
"operationId": "getSearchResultsForOpportunities",
|
|
4342
4566
|
"summary": "getSearchResultsForOpportunities",
|
|
4343
|
-
"description": "Get all opportunity with the given
|
|
4567
|
+
"description": "Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.",
|
|
4568
|
+
"deprecated": true,
|
|
4344
4569
|
"tags": [
|
|
4345
4570
|
"ECP"
|
|
4346
4571
|
],
|
|
@@ -4449,7 +4674,8 @@
|
|
|
4449
4674
|
"get": {
|
|
4450
4675
|
"operationId": "getOpportunity",
|
|
4451
4676
|
"summary": "getOpportunity",
|
|
4452
|
-
"description": "Get an opportunity by id",
|
|
4677
|
+
"description": "Get an opportunity by id. Use getPortalUserEntity instead.",
|
|
4678
|
+
"deprecated": true,
|
|
4453
4679
|
"tags": [
|
|
4454
4680
|
"ECP"
|
|
4455
4681
|
],
|
|
@@ -4536,7 +4762,8 @@
|
|
|
4536
4762
|
"patch": {
|
|
4537
4763
|
"operationId": "updateOpportunity",
|
|
4538
4764
|
"summary": "updateOpportunity",
|
|
4539
|
-
"description": "Update an opportunity by id",
|
|
4765
|
+
"description": "Update an opportunity by id.",
|
|
4766
|
+
"deprecated": true,
|
|
4540
4767
|
"tags": [
|
|
4541
4768
|
"ECP"
|
|
4542
4769
|
],
|
|
@@ -4602,7 +4829,8 @@
|
|
|
4602
4829
|
"get": {
|
|
4603
4830
|
"operationId": "getAllRequests",
|
|
4604
4831
|
"summary": "getAllRequests",
|
|
4605
|
-
"description": "Get all opportunities & orders of a portal user",
|
|
4832
|
+
"description": "Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.",
|
|
4833
|
+
"deprecated": true,
|
|
4606
4834
|
"tags": [
|
|
4607
4835
|
"ECP"
|
|
4608
4836
|
],
|
|
@@ -4698,7 +4926,8 @@
|
|
|
4698
4926
|
"get": {
|
|
4699
4927
|
"operationId": "getAllContracts",
|
|
4700
4928
|
"summary": "getAllContracts",
|
|
4701
|
-
"description": "Get all contracts for a portal user",
|
|
4929
|
+
"description": "Get all contracts for a portal user. Use searchPortalUserEntities instead.",
|
|
4930
|
+
"deprecated": true,
|
|
4702
4931
|
"tags": [
|
|
4703
4932
|
"ECP"
|
|
4704
4933
|
],
|
|
@@ -4778,7 +5007,8 @@
|
|
|
4778
5007
|
"get": {
|
|
4779
5008
|
"operationId": "getContract",
|
|
4780
5009
|
"summary": "getContract",
|
|
4781
|
-
"description": "Get a contract by id",
|
|
5010
|
+
"description": "Get a contract by id. Use getPortalUserEntity instead.",
|
|
5011
|
+
"deprecated": true,
|
|
4782
5012
|
"tags": [
|
|
4783
5013
|
"ECP"
|
|
4784
5014
|
],
|
|
@@ -4871,7 +5101,8 @@
|
|
|
4871
5101
|
"patch": {
|
|
4872
5102
|
"operationId": "updateContract",
|
|
4873
5103
|
"summary": "updateContract",
|
|
4874
|
-
"description": "Update a contract by id",
|
|
5104
|
+
"description": "Update a contract by id. Use getPortalUserEntity instead.",
|
|
5105
|
+
"deprecated": true,
|
|
4875
5106
|
"tags": [
|
|
4876
5107
|
"ECP"
|
|
4877
5108
|
],
|
|
@@ -5730,7 +5961,8 @@
|
|
|
5730
5961
|
"get": {
|
|
5731
5962
|
"operationId": "getFileById",
|
|
5732
5963
|
"summary": "getFileById",
|
|
5733
|
-
"description": "Fetch a document with ID",
|
|
5964
|
+
"description": "Fetch a document with ID. Use getPortalUserEntity instead.",
|
|
5965
|
+
"deprecated": true,
|
|
5734
5966
|
"tags": [
|
|
5735
5967
|
"ECP"
|
|
5736
5968
|
],
|
|
@@ -6102,7 +6334,7 @@
|
|
|
6102
6334
|
"post": {
|
|
6103
6335
|
"operationId": "loginToPortalAsUser",
|
|
6104
6336
|
"summary": "loginToPortalAsUser",
|
|
6105
|
-
"description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n",
|
|
6337
|
+
"description": "Generate a token to log in to a portal impersonating a users.\n\nToken is valid for 5 minutes.\n\nSupports three identification methods (at least one required):\n1. Using portal_id (takes precedence)\n2. Using domain\n3. Using origin (legacy)\n",
|
|
6106
6338
|
"tags": [
|
|
6107
6339
|
"ECP Admin"
|
|
6108
6340
|
],
|
|
@@ -6126,6 +6358,14 @@
|
|
|
6126
6358
|
},
|
|
6127
6359
|
"origin": {
|
|
6128
6360
|
"$ref": "#/components/schemas/Origin"
|
|
6361
|
+
},
|
|
6362
|
+
"portal_id": {
|
|
6363
|
+
"type": "string",
|
|
6364
|
+
"description": "The portal ID to look up the portal config. When provided, takes precedence over origin."
|
|
6365
|
+
},
|
|
6366
|
+
"domain": {
|
|
6367
|
+
"type": "string",
|
|
6368
|
+
"description": "Portal domain for identification. Alternative to portal_id or origin."
|
|
6129
6369
|
}
|
|
6130
6370
|
}
|
|
6131
6371
|
}
|
|
@@ -6220,7 +6460,7 @@
|
|
|
6220
6460
|
"post": {
|
|
6221
6461
|
"operationId": "triggerEntityAccessEventV3",
|
|
6222
6462
|
"summary": "triggerEntityAccessEventV3",
|
|
6223
|
-
"description": "Trigger entity access event for a portal user",
|
|
6463
|
+
"description": "Trigger entity access event for a portal user.\nSupports two identification methods:\n1. Using portal_id\n2. Using domain\n",
|
|
6224
6464
|
"tags": [
|
|
6225
6465
|
"ECP"
|
|
6226
6466
|
],
|
|
@@ -6252,11 +6492,20 @@
|
|
|
6252
6492
|
{
|
|
6253
6493
|
"name": "portal_id",
|
|
6254
6494
|
"in": "query",
|
|
6255
|
-
"required":
|
|
6256
|
-
"description": "Portal ID",
|
|
6495
|
+
"required": false,
|
|
6496
|
+
"description": "Portal ID (required if domain is not provided)",
|
|
6257
6497
|
"schema": {
|
|
6258
6498
|
"$ref": "#/components/schemas/PortalId"
|
|
6259
6499
|
}
|
|
6500
|
+
},
|
|
6501
|
+
{
|
|
6502
|
+
"name": "domain",
|
|
6503
|
+
"in": "query",
|
|
6504
|
+
"required": false,
|
|
6505
|
+
"description": "Portal domain for identification (alternative to portal_id)",
|
|
6506
|
+
"schema": {
|
|
6507
|
+
"type": "string"
|
|
6508
|
+
}
|
|
6260
6509
|
}
|
|
6261
6510
|
],
|
|
6262
6511
|
"responses": {
|
|
@@ -6936,7 +7185,7 @@
|
|
|
6936
7185
|
"post": {
|
|
6937
7186
|
"operationId": "ssoLoginV3",
|
|
6938
7187
|
"summary": "ssoLoginV3",
|
|
6939
|
-
"description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito\n",
|
|
7188
|
+
"description": "Initiate login using external SSO identity.\n\nVerifies the user with the issuer and matches the identity to an epilot user (or creates a new user).\n\nReturns parameters to be used with CUSTOM_AUTH flow against Cognito.\n\nSupports two identification methods:\n1. Using org_id + portal_id\n2. Using domain\n",
|
|
6940
7189
|
"security": [
|
|
6941
7190
|
{
|
|
6942
7191
|
"ExternalOIDCAuth": []
|
|
@@ -6946,8 +7195,8 @@
|
|
|
6946
7195
|
{
|
|
6947
7196
|
"in": "query",
|
|
6948
7197
|
"name": "portal_id",
|
|
6949
|
-
"required":
|
|
6950
|
-
"description": "ID of the Portal",
|
|
7198
|
+
"required": false,
|
|
7199
|
+
"description": "ID of the Portal (required if domain is not provided)",
|
|
6951
7200
|
"schema": {
|
|
6952
7201
|
"$ref": "#/components/schemas/PortalId"
|
|
6953
7202
|
}
|
|
@@ -6955,13 +7204,22 @@
|
|
|
6955
7204
|
{
|
|
6956
7205
|
"in": "query",
|
|
6957
7206
|
"name": "org_id",
|
|
6958
|
-
"description": "epilot organization id",
|
|
6959
|
-
"required":
|
|
7207
|
+
"description": "epilot organization id (required if domain is not provided)",
|
|
7208
|
+
"required": false,
|
|
6960
7209
|
"schema": {
|
|
6961
7210
|
"type": "string",
|
|
6962
7211
|
"example": 123
|
|
6963
7212
|
}
|
|
6964
7213
|
},
|
|
7214
|
+
{
|
|
7215
|
+
"in": "query",
|
|
7216
|
+
"name": "domain",
|
|
7217
|
+
"description": "Portal domain for identification (alternative to org_id + portal_id)",
|
|
7218
|
+
"required": false,
|
|
7219
|
+
"schema": {
|
|
7220
|
+
"type": "string"
|
|
7221
|
+
}
|
|
7222
|
+
},
|
|
6965
7223
|
{
|
|
6966
7224
|
"in": "query",
|
|
6967
7225
|
"name": "contact_id",
|
|
@@ -7496,6 +7754,10 @@
|
|
|
7496
7754
|
},
|
|
7497
7755
|
"context_entities": {
|
|
7498
7756
|
"$ref": "#/components/schemas/ContextEntities"
|
|
7757
|
+
},
|
|
7758
|
+
"evaluate_targeting": {
|
|
7759
|
+
"type": "boolean",
|
|
7760
|
+
"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."
|
|
7499
7761
|
}
|
|
7500
7762
|
}
|
|
7501
7763
|
}
|
|
@@ -8611,9 +8873,36 @@
|
|
|
8611
8873
|
},
|
|
8612
8874
|
"contact_data": {
|
|
8613
8875
|
"type": "object",
|
|
8614
|
-
"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).\n",
|
|
8876
|
+
"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",
|
|
8615
8877
|
"additionalProperties": {
|
|
8616
|
-
"
|
|
8878
|
+
"oneOf": [
|
|
8879
|
+
{
|
|
8880
|
+
"type": "string"
|
|
8881
|
+
},
|
|
8882
|
+
{
|
|
8883
|
+
"type": "array",
|
|
8884
|
+
"items": {
|
|
8885
|
+
"type": "string"
|
|
8886
|
+
}
|
|
8887
|
+
}
|
|
8888
|
+
]
|
|
8889
|
+
}
|
|
8890
|
+
},
|
|
8891
|
+
"portal_user_data": {
|
|
8892
|
+
"type": "object",
|
|
8893
|
+
"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",
|
|
8894
|
+
"additionalProperties": {
|
|
8895
|
+
"oneOf": [
|
|
8896
|
+
{
|
|
8897
|
+
"type": "string"
|
|
8898
|
+
},
|
|
8899
|
+
{
|
|
8900
|
+
"type": "array",
|
|
8901
|
+
"items": {
|
|
8902
|
+
"type": "string"
|
|
8903
|
+
}
|
|
8904
|
+
}
|
|
8905
|
+
]
|
|
8617
8906
|
}
|
|
8618
8907
|
}
|
|
8619
8908
|
}
|
|
@@ -13281,6 +13570,9 @@
|
|
|
13281
13570
|
"type": "boolean",
|
|
13282
13571
|
"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.",
|
|
13283
13572
|
"default": false
|
|
13573
|
+
},
|
|
13574
|
+
"secure_proxy": {
|
|
13575
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13284
13576
|
}
|
|
13285
13577
|
},
|
|
13286
13578
|
"required": [
|
|
@@ -13380,6 +13672,9 @@
|
|
|
13380
13672
|
"type": "boolean",
|
|
13381
13673
|
"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.",
|
|
13382
13674
|
"default": false
|
|
13675
|
+
},
|
|
13676
|
+
"secure_proxy": {
|
|
13677
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13383
13678
|
}
|
|
13384
13679
|
},
|
|
13385
13680
|
"required": [
|
|
@@ -13487,6 +13782,9 @@
|
|
|
13487
13782
|
"type": "boolean",
|
|
13488
13783
|
"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.",
|
|
13489
13784
|
"default": false
|
|
13785
|
+
},
|
|
13786
|
+
"secure_proxy": {
|
|
13787
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13490
13788
|
}
|
|
13491
13789
|
},
|
|
13492
13790
|
"required": [
|
|
@@ -13562,6 +13860,9 @@
|
|
|
13562
13860
|
"type": "boolean",
|
|
13563
13861
|
"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.",
|
|
13564
13862
|
"default": false
|
|
13863
|
+
},
|
|
13864
|
+
"secure_proxy": {
|
|
13865
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13565
13866
|
}
|
|
13566
13867
|
},
|
|
13567
13868
|
"required": [
|
|
@@ -13636,6 +13937,9 @@
|
|
|
13636
13937
|
"type": "boolean",
|
|
13637
13938
|
"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.",
|
|
13638
13939
|
"default": false
|
|
13940
|
+
},
|
|
13941
|
+
"secure_proxy": {
|
|
13942
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13639
13943
|
}
|
|
13640
13944
|
},
|
|
13641
13945
|
"required": [
|
|
@@ -13710,6 +14014,9 @@
|
|
|
13710
14014
|
"type": "boolean",
|
|
13711
14015
|
"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.",
|
|
13712
14016
|
"default": false
|
|
14017
|
+
},
|
|
14018
|
+
"secure_proxy": {
|
|
14019
|
+
"$ref": "#/components/schemas/SecureProxyConfig"
|
|
13713
14020
|
}
|
|
13714
14021
|
},
|
|
13715
14022
|
"required": [
|
|
@@ -13717,6 +14024,25 @@
|
|
|
13717
14024
|
"call"
|
|
13718
14025
|
]
|
|
13719
14026
|
},
|
|
14027
|
+
"SecureProxyConfig": {
|
|
14028
|
+
"type": "object",
|
|
14029
|
+
"description": "Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.",
|
|
14030
|
+
"properties": {
|
|
14031
|
+
"integration_id": {
|
|
14032
|
+
"type": "string",
|
|
14033
|
+
"format": "uuid",
|
|
14034
|
+
"description": "Integration ID that owns the secure_proxy use case."
|
|
14035
|
+
},
|
|
14036
|
+
"use_case_slug": {
|
|
14037
|
+
"type": "string",
|
|
14038
|
+
"description": "Use case slug for the secure proxy use case."
|
|
14039
|
+
}
|
|
14040
|
+
},
|
|
14041
|
+
"required": [
|
|
14042
|
+
"integration_id",
|
|
14043
|
+
"use_case_slug"
|
|
14044
|
+
]
|
|
14045
|
+
},
|
|
13720
14046
|
"ExtensionAuthBlock": {
|
|
13721
14047
|
"type": "object",
|
|
13722
14048
|
"properties": {
|
|
@@ -14403,7 +14729,65 @@
|
|
|
14403
14729
|
"visibility": {
|
|
14404
14730
|
"type": "object",
|
|
14405
14731
|
"description": "The conditions that need to be met for the block to be shown",
|
|
14406
|
-
"additionalProperties": true
|
|
14732
|
+
"additionalProperties": true,
|
|
14733
|
+
"properties": {
|
|
14734
|
+
"is_hidden": {
|
|
14735
|
+
"type": "boolean",
|
|
14736
|
+
"description": "Block is fully hidden from portal users"
|
|
14737
|
+
},
|
|
14738
|
+
"hidden_on_mobile": {
|
|
14739
|
+
"type": "boolean",
|
|
14740
|
+
"description": "Block is hidden on mobile viewports"
|
|
14741
|
+
},
|
|
14742
|
+
"hidden_on_desktop": {
|
|
14743
|
+
"type": "boolean",
|
|
14744
|
+
"description": "Block is hidden on desktop viewports"
|
|
14745
|
+
},
|
|
14746
|
+
"hidden_in_app": {
|
|
14747
|
+
"type": "boolean",
|
|
14748
|
+
"description": "Block is hidden in the mobile app"
|
|
14749
|
+
},
|
|
14750
|
+
"start_date": {
|
|
14751
|
+
"type": "string",
|
|
14752
|
+
"format": "date-time",
|
|
14753
|
+
"description": "Schedule visibility start date. If only start_date is set, block is visible from this date onwards."
|
|
14754
|
+
},
|
|
14755
|
+
"end_date": {
|
|
14756
|
+
"type": "string",
|
|
14757
|
+
"format": "date-time",
|
|
14758
|
+
"description": "Schedule visibility end date. If only end_date is set, block is visible until this date."
|
|
14759
|
+
},
|
|
14760
|
+
"visible_for_targets": {
|
|
14761
|
+
"type": "array",
|
|
14762
|
+
"items": {
|
|
14763
|
+
"type": "string"
|
|
14764
|
+
},
|
|
14765
|
+
"description": "Target IDs that must match for the block to be visible"
|
|
14766
|
+
},
|
|
14767
|
+
"visible_for_operator": {
|
|
14768
|
+
"type": "string",
|
|
14769
|
+
"enum": [
|
|
14770
|
+
"and",
|
|
14771
|
+
"or"
|
|
14772
|
+
],
|
|
14773
|
+
"description": "Operator for visible_for_targets matching"
|
|
14774
|
+
},
|
|
14775
|
+
"hidden_for_targets": {
|
|
14776
|
+
"type": "array",
|
|
14777
|
+
"items": {
|
|
14778
|
+
"type": "string"
|
|
14779
|
+
},
|
|
14780
|
+
"description": "Target IDs that if matched will hide the block"
|
|
14781
|
+
},
|
|
14782
|
+
"hidden_for_operator": {
|
|
14783
|
+
"type": "string",
|
|
14784
|
+
"enum": [
|
|
14785
|
+
"and",
|
|
14786
|
+
"or"
|
|
14787
|
+
],
|
|
14788
|
+
"description": "Operator for hidden_for_targets matching"
|
|
14789
|
+
}
|
|
14790
|
+
}
|
|
14407
14791
|
},
|
|
14408
14792
|
"content": {
|
|
14409
14793
|
"type": "object",
|
|
@@ -14502,7 +14886,57 @@
|
|
|
14502
14886
|
"visibility": {
|
|
14503
14887
|
"type": "object",
|
|
14504
14888
|
"description": "The conditions that need to be met for the page to be shown",
|
|
14505
|
-
"additionalProperties": true
|
|
14889
|
+
"additionalProperties": true,
|
|
14890
|
+
"properties": {
|
|
14891
|
+
"is_hidden": {
|
|
14892
|
+
"type": "boolean",
|
|
14893
|
+
"description": "Page is fully hidden from portal users"
|
|
14894
|
+
},
|
|
14895
|
+
"hidden_in_app": {
|
|
14896
|
+
"type": "boolean",
|
|
14897
|
+
"description": "Page is hidden in the mobile app"
|
|
14898
|
+
},
|
|
14899
|
+
"start_date": {
|
|
14900
|
+
"type": "string",
|
|
14901
|
+
"format": "date-time",
|
|
14902
|
+
"description": "Schedule visibility start date. If only start_date is set, page is visible from this date onwards."
|
|
14903
|
+
},
|
|
14904
|
+
"end_date": {
|
|
14905
|
+
"type": "string",
|
|
14906
|
+
"format": "date-time",
|
|
14907
|
+
"description": "Schedule visibility end date. If only end_date is set, page is visible until this date."
|
|
14908
|
+
},
|
|
14909
|
+
"visible_for_targets": {
|
|
14910
|
+
"type": "array",
|
|
14911
|
+
"items": {
|
|
14912
|
+
"type": "string"
|
|
14913
|
+
},
|
|
14914
|
+
"description": "Target IDs that must match for the page to be visible"
|
|
14915
|
+
},
|
|
14916
|
+
"visible_for_operator": {
|
|
14917
|
+
"type": "string",
|
|
14918
|
+
"enum": [
|
|
14919
|
+
"and",
|
|
14920
|
+
"or"
|
|
14921
|
+
],
|
|
14922
|
+
"description": "Operator for visible_for_targets matching"
|
|
14923
|
+
},
|
|
14924
|
+
"hidden_for_targets": {
|
|
14925
|
+
"type": "array",
|
|
14926
|
+
"items": {
|
|
14927
|
+
"type": "string"
|
|
14928
|
+
},
|
|
14929
|
+
"description": "Target IDs that if matched will hide the page"
|
|
14930
|
+
},
|
|
14931
|
+
"hidden_for_operator": {
|
|
14932
|
+
"type": "string",
|
|
14933
|
+
"enum": [
|
|
14934
|
+
"and",
|
|
14935
|
+
"or"
|
|
14936
|
+
],
|
|
14937
|
+
"description": "Operator for hidden_for_targets matching"
|
|
14938
|
+
}
|
|
14939
|
+
}
|
|
14506
14940
|
},
|
|
14507
14941
|
"content": {
|
|
14508
14942
|
"type": "object",
|
|
@@ -14589,6 +15023,11 @@
|
|
|
14589
15023
|
"format": "date-time",
|
|
14590
15024
|
"description": "Last modified timestamp of the Page",
|
|
14591
15025
|
"example": "2021-02-09T12:41:43.662Z"
|
|
15026
|
+
},
|
|
15027
|
+
"portal_id": {
|
|
15028
|
+
"type": "string",
|
|
15029
|
+
"description": "The id of the portal",
|
|
15030
|
+
"example": "453ad7bf-86d5-46c8-8252-bcc868df5e3c"
|
|
14592
15031
|
}
|
|
14593
15032
|
}
|
|
14594
15033
|
}
|