@epilot/sdk 2.8.5 → 2.8.7
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/definitions/access-token-runtime.json +1 -1
- package/definitions/access-token.json +1 -155
- package/definitions/app.json +8 -101
- package/definitions/automation.json +0 -120
- package/definitions/blueprint-manifest-runtime.json +1 -1
- package/definitions/blueprint-manifest.json +349 -1643
- package/definitions/configuration-hub-runtime.json +1 -1
- package/definitions/configuration-hub.json +0 -623
- package/definitions/customer-portal-runtime.json +1 -1
- package/definitions/customer-portal.json +78 -383
- package/definitions/design-runtime.json +1 -1
- package/definitions/design.json +12 -52
- package/definitions/event-catalog-runtime.json +1 -1
- package/definitions/event-catalog.json +12 -168
- package/definitions/file-runtime.json +1 -1
- package/definitions/file.json +4 -152
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +16 -785
- package/definitions/journey-runtime.json +1 -1
- package/definitions/journey.json +1 -21
- package/definitions/notes-runtime.json +1 -1
- package/definitions/notes.json +1 -123
- package/definitions/pricing.json +406 -224
- package/definitions/targeting-runtime.json +1 -1
- package/definitions/targeting.json +7 -257
- package/definitions/user-runtime.json +1 -1
- package/definitions/user.json +0 -441
- package/definitions/webhooks.json +0 -31
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.cts +2 -2
- package/dist/apis/targeting.d.ts +2 -2
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-XRIEGQXL.cjs → chunk-7LIGFCRI.cjs} +1 -1
- package/dist/{chunk-5FXMXMNX.js → chunk-CMANJ4LY.js} +1 -1
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/{targeting-DAFJBPIZ.cjs → targeting-WC62BBZN.cjs} +1 -1
- package/dist/{targeting-TGPCRRI6.js → targeting-X4Y2ODBT.js} +1 -1
- package/dist/{targeting.d-DxHQbn7-.d.cts → targeting.d-0rNF7ErD.d.cts} +11 -4
- package/dist/{targeting.d-DxHQbn7-.d.ts → targeting.d-0rNF7ErD.d.ts} +11 -4
- package/docs/targeting.md +6 -3
- package/package.json +1 -1
- package/definitions/snapshot-runtime.json +0 -1
- package/definitions/snapshot.json +0 -950
|
@@ -1867,13 +1867,6 @@
|
|
|
1867
1867
|
"example": "CAA_ERROR"
|
|
1868
1868
|
}
|
|
1869
1869
|
}
|
|
1870
|
-
},
|
|
1871
|
-
"identity_providers": {
|
|
1872
|
-
"type": "array",
|
|
1873
|
-
"description": "SSO identity providers configured for the portal. Includes raw\n`oidc_config.client_secret` values so the admin UI can round-trip\nthem. Customers are encouraged to reference secrets via env\ntemplates (`{{ env.VAR }}`) rather than embed raw values.\n",
|
|
1874
|
-
"items": {
|
|
1875
|
-
"$ref": "#/components/schemas/ProviderConfig"
|
|
1876
|
-
}
|
|
1877
1870
|
}
|
|
1878
1871
|
}
|
|
1879
1872
|
}
|
|
@@ -2001,13 +1994,6 @@
|
|
|
2001
1994
|
"example": "CAA_ERROR"
|
|
2002
1995
|
}
|
|
2003
1996
|
}
|
|
2004
|
-
},
|
|
2005
|
-
"identity_providers": {
|
|
2006
|
-
"type": "array",
|
|
2007
|
-
"description": "SSO identity providers configured for the portal. Includes raw\n`oidc_config.client_secret` values so the admin UI can round-trip\nthem. Customers are encouraged to reference secrets via env\ntemplates (`{{ env.VAR }}`) rather than embed raw values.\n",
|
|
2008
|
-
"items": {
|
|
2009
|
-
"$ref": "#/components/schemas/ProviderConfig"
|
|
2010
|
-
}
|
|
2011
1997
|
}
|
|
2012
1998
|
}
|
|
2013
1999
|
}
|
|
@@ -7682,7 +7668,7 @@
|
|
|
7682
7668
|
],
|
|
7683
7669
|
"responses": {
|
|
7684
7670
|
"200": {
|
|
7685
|
-
"description": "Resolved public SSO provider configuration
|
|
7671
|
+
"description": "Resolved public SSO provider configuration",
|
|
7686
7672
|
"content": {
|
|
7687
7673
|
"application/json": {
|
|
7688
7674
|
"schema": {
|
|
@@ -8395,96 +8381,6 @@
|
|
|
8395
8381
|
}
|
|
8396
8382
|
}
|
|
8397
8383
|
},
|
|
8398
|
-
"/v2/portal/config/triggered-journeys/{trigger_name}": {
|
|
8399
|
-
"parameters": [
|
|
8400
|
-
{
|
|
8401
|
-
"in": "path",
|
|
8402
|
-
"name": "trigger_name",
|
|
8403
|
-
"required": true,
|
|
8404
|
-
"schema": {
|
|
8405
|
-
"type": "string",
|
|
8406
|
-
"enum": [
|
|
8407
|
-
"FIRST_LOGIN",
|
|
8408
|
-
"ACCEPT_ORDER",
|
|
8409
|
-
"DECLINE_ORDER"
|
|
8410
|
-
]
|
|
8411
|
-
},
|
|
8412
|
-
"description": "The trigger event for the auto-triggered journey"
|
|
8413
|
-
}
|
|
8414
|
-
],
|
|
8415
|
-
"get": {
|
|
8416
|
-
"operationId": "getTriggeredJourney",
|
|
8417
|
-
"summary": "getTriggeredJourney",
|
|
8418
|
-
"description": "Returns the auto-triggered journey configured for the given trigger\nwith handlebars templates in `context_params` already resolved.\nUses the caller's auth context (contact, portal user) plus any\n`context_entities` supplied at trigger time (e.g. the order being\naccepted) — same resolver as `getPortalPages`.\n",
|
|
8419
|
-
"tags": [
|
|
8420
|
-
"ECP"
|
|
8421
|
-
],
|
|
8422
|
-
"security": [
|
|
8423
|
-
{
|
|
8424
|
-
"PortalAuth": []
|
|
8425
|
-
}
|
|
8426
|
-
],
|
|
8427
|
-
"parameters": [
|
|
8428
|
-
{
|
|
8429
|
-
"in": "query",
|
|
8430
|
-
"name": "context_entities",
|
|
8431
|
-
"required": false,
|
|
8432
|
-
"description": "Additional entities to include in the resolution context (e.g. the order being accepted at trigger time). Portal User and Contact entities are automatically part of the context.",
|
|
8433
|
-
"schema": {
|
|
8434
|
-
"$ref": "#/components/schemas/ContextEntities"
|
|
8435
|
-
}
|
|
8436
|
-
}
|
|
8437
|
-
],
|
|
8438
|
-
"responses": {
|
|
8439
|
-
"200": {
|
|
8440
|
-
"description": "The triggered journey has been resolved successfully.",
|
|
8441
|
-
"content": {
|
|
8442
|
-
"application/json": {
|
|
8443
|
-
"schema": {
|
|
8444
|
-
"type": "object",
|
|
8445
|
-
"properties": {
|
|
8446
|
-
"trigger_name": {
|
|
8447
|
-
"type": "string",
|
|
8448
|
-
"enum": [
|
|
8449
|
-
"FIRST_LOGIN",
|
|
8450
|
-
"ACCEPT_ORDER",
|
|
8451
|
-
"DECLINE_ORDER"
|
|
8452
|
-
]
|
|
8453
|
-
},
|
|
8454
|
-
"journey_id": {
|
|
8455
|
-
"$ref": "#/components/schemas/EntityId"
|
|
8456
|
-
},
|
|
8457
|
-
"context_params": {
|
|
8458
|
-
"type": "array",
|
|
8459
|
-
"items": {
|
|
8460
|
-
"type": "object",
|
|
8461
|
-
"properties": {
|
|
8462
|
-
"key": {
|
|
8463
|
-
"type": "string"
|
|
8464
|
-
},
|
|
8465
|
-
"value": {
|
|
8466
|
-
"type": "string"
|
|
8467
|
-
}
|
|
8468
|
-
}
|
|
8469
|
-
}
|
|
8470
|
-
}
|
|
8471
|
-
}
|
|
8472
|
-
}
|
|
8473
|
-
}
|
|
8474
|
-
}
|
|
8475
|
-
},
|
|
8476
|
-
"401": {
|
|
8477
|
-
"$ref": "#/components/responses/Unauthorized"
|
|
8478
|
-
},
|
|
8479
|
-
"404": {
|
|
8480
|
-
"$ref": "#/components/responses/NotFound"
|
|
8481
|
-
},
|
|
8482
|
-
"500": {
|
|
8483
|
-
"$ref": "#/components/responses/InternalServerError"
|
|
8484
|
-
}
|
|
8485
|
-
}
|
|
8486
|
-
}
|
|
8487
|
-
},
|
|
8488
8384
|
"/v2/portal/pages/default": {
|
|
8489
8385
|
"get": {
|
|
8490
8386
|
"operationId": "getDefaultPages",
|
|
@@ -10812,18 +10708,14 @@
|
|
|
10812
10708
|
"description": "Default admin users for pending user notification to notify"
|
|
10813
10709
|
}
|
|
10814
10710
|
}
|
|
10815
|
-
},
|
|
10816
|
-
"identity_providers": {
|
|
10817
|
-
"type": "array",
|
|
10818
|
-
"description": "SSO identity providers for the portal. When sent on a portal save (PUT/POST),\nthe list is fully synced — incoming providers are upserted and any existing\nproviders not in the list are deleted. Omit the field to leave SSO\nconfiguration unchanged; send an empty array to remove all providers.\n\nEach provider is persisted verbatim — `oidc_config.client_secret` is stored\nas sent. Customers are encouraged to reference an org env secret via\n`{{ env.VAR }}` rather than embed raw values.\n",
|
|
10819
|
-
"items": {
|
|
10820
|
-
"$ref": "#/components/schemas/ProviderConfig"
|
|
10821
|
-
}
|
|
10822
10711
|
}
|
|
10823
10712
|
}
|
|
10824
10713
|
},
|
|
10825
10714
|
"CommonConfigAttributes": {
|
|
10826
10715
|
"type": "object",
|
|
10716
|
+
"required": [
|
|
10717
|
+
"domain"
|
|
10718
|
+
],
|
|
10827
10719
|
"properties": {
|
|
10828
10720
|
"enabled": {
|
|
10829
10721
|
"type": "boolean",
|
|
@@ -10879,19 +10771,14 @@
|
|
|
10879
10771
|
},
|
|
10880
10772
|
"self_registration_account_setting": {
|
|
10881
10773
|
"type": "string",
|
|
10882
|
-
"description": "Controls behavior of self-registration when account is
|
|
10774
|
+
"description": "Controls behavior of self-registration when account is used as the registration entity",
|
|
10883
10775
|
"enum": [
|
|
10884
|
-
"
|
|
10776
|
+
"ALLOW_WITH_CONTACT_CREATION",
|
|
10885
10777
|
"DENY",
|
|
10886
|
-
"
|
|
10887
|
-
"BLOCK_IF_PORTAL_USER_EXISTS",
|
|
10778
|
+
"ALWAYS_CREATE_CONTACT",
|
|
10888
10779
|
"DISALLOW_COMPLETELY"
|
|
10889
10780
|
]
|
|
10890
10781
|
},
|
|
10891
|
-
"block_registration_if_portal_user_exists": {
|
|
10892
|
-
"type": "boolean",
|
|
10893
|
-
"description": "Account-mode only. Reject registration when the resolved account already\nhas any portal user (any portal user whose mapped contact is linked to\nthe account).\n"
|
|
10894
|
-
},
|
|
10895
10782
|
"self_registration_entity": {
|
|
10896
10783
|
"type": "string",
|
|
10897
10784
|
"description": "Entity type used as the primary identifier for self-registration",
|
|
@@ -11208,40 +11095,6 @@
|
|
|
11208
11095
|
}
|
|
11209
11096
|
]
|
|
11210
11097
|
},
|
|
11211
|
-
"contact_identifiers_for_account": {
|
|
11212
|
-
"type": "array",
|
|
11213
|
-
"description": "Account-mode only. Identifiers on the contact entity of the primarily\nidentified account. Used to pick an existing related contact within the\nresolved account; if none matches, the values are written onto the new\ncontact that is created and linked to the account.\n",
|
|
11214
|
-
"items": {
|
|
11215
|
-
"$ref": "#/components/schemas/RegistrationIdentifier"
|
|
11216
|
-
},
|
|
11217
|
-
"example": [
|
|
11218
|
-
{
|
|
11219
|
-
"name": "first_name",
|
|
11220
|
-
"schema": "contact"
|
|
11221
|
-
},
|
|
11222
|
-
{
|
|
11223
|
-
"name": "last_name",
|
|
11224
|
-
"schema": "contact"
|
|
11225
|
-
}
|
|
11226
|
-
]
|
|
11227
|
-
},
|
|
11228
|
-
"additional_contact_attributes": {
|
|
11229
|
-
"type": "array",
|
|
11230
|
-
"description": "Contact attributes collected from the user during self-registration that are\nwritten onto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
11231
|
-
"items": {
|
|
11232
|
-
"$ref": "#/components/schemas/AdditionalContactAttribute"
|
|
11233
|
-
},
|
|
11234
|
-
"example": [
|
|
11235
|
-
{
|
|
11236
|
-
"name": "first_name",
|
|
11237
|
-
"required": true
|
|
11238
|
-
},
|
|
11239
|
-
{
|
|
11240
|
-
"name": "last_name",
|
|
11241
|
-
"required": true
|
|
11242
|
-
}
|
|
11243
|
-
]
|
|
11244
|
-
},
|
|
11245
11098
|
"triggered_journeys": {
|
|
11246
11099
|
"type": "array",
|
|
11247
11100
|
"description": "Journeys automatically opened on a portal user action",
|
|
@@ -11258,21 +11111,6 @@
|
|
|
11258
11111
|
},
|
|
11259
11112
|
"journey_id": {
|
|
11260
11113
|
"$ref": "#/components/schemas/EntityId"
|
|
11261
|
-
},
|
|
11262
|
-
"context_params": {
|
|
11263
|
-
"type": "array",
|
|
11264
|
-
"description": "Context parameters forwarded to the journey when it is\nauto-triggered. Values may contain handlebars templates\nthat reference the available context (e.g.\n`{{contact._id}}`, `{{portal_user.email}}`,\n`{{order._id}}`) — these are resolved at trigger time by\n`GET /v2/portal/config/triggered-journeys/{trigger_name}`\nusing the caller's auth context plus runtime entities\nsupplied via the `context_entities` query param.\n",
|
|
11265
|
-
"items": {
|
|
11266
|
-
"type": "object",
|
|
11267
|
-
"properties": {
|
|
11268
|
-
"key": {
|
|
11269
|
-
"type": "string"
|
|
11270
|
-
},
|
|
11271
|
-
"value": {
|
|
11272
|
-
"type": "string"
|
|
11273
|
-
}
|
|
11274
|
-
}
|
|
11275
|
-
}
|
|
11276
11114
|
}
|
|
11277
11115
|
}
|
|
11278
11116
|
}
|
|
@@ -11384,6 +11222,9 @@
|
|
|
11384
11222
|
}
|
|
11385
11223
|
},
|
|
11386
11224
|
"UpsertPortalConfig": {
|
|
11225
|
+
"required": [
|
|
11226
|
+
"domain"
|
|
11227
|
+
],
|
|
11387
11228
|
"allOf": [
|
|
11388
11229
|
{
|
|
11389
11230
|
"$ref": "#/components/schemas/UpdateOnlyPortalConfigAttributes"
|
|
@@ -11961,28 +11802,6 @@
|
|
|
11961
11802
|
}
|
|
11962
11803
|
}
|
|
11963
11804
|
},
|
|
11964
|
-
"contact_identifiers_for_account": {
|
|
11965
|
-
"type": "object",
|
|
11966
|
-
"description": "Account-mode only. Values for the contact identifiers configured\nunder `contact_identifiers_for_account` on the portal. Used to\nfind an existing related contact within the resolved account, or\nwritten onto the new contact if none matches.\n",
|
|
11967
|
-
"additionalProperties": {
|
|
11968
|
-
"type": "string"
|
|
11969
|
-
},
|
|
11970
|
-
"example": {
|
|
11971
|
-
"first_name": "John",
|
|
11972
|
-
"last_name": "Doe"
|
|
11973
|
-
}
|
|
11974
|
-
},
|
|
11975
|
-
"additional_contact_attributes": {
|
|
11976
|
-
"type": "object",
|
|
11977
|
-
"description": "Values for the contact attributes configured under\n`additional_contact_attributes` on the portal. These are written\nonto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
11978
|
-
"additionalProperties": {
|
|
11979
|
-
"type": "string"
|
|
11980
|
-
},
|
|
11981
|
-
"example": {
|
|
11982
|
-
"first_name": "John",
|
|
11983
|
-
"last_name": "Doe"
|
|
11984
|
-
}
|
|
11985
|
-
},
|
|
11986
11805
|
"account_id": {
|
|
11987
11806
|
"type": "string",
|
|
11988
11807
|
"description": "ID of the account"
|
|
@@ -14096,24 +13915,6 @@
|
|
|
14096
13915
|
}
|
|
14097
13916
|
}
|
|
14098
13917
|
},
|
|
14099
|
-
"AdditionalContactAttribute": {
|
|
14100
|
-
"type": "object",
|
|
14101
|
-
"description": "A contact attribute that is collected from the user during self-registration\nand written onto the newly created contact, but is NOT used to identify\nan existing contact.\n",
|
|
14102
|
-
"required": [
|
|
14103
|
-
"name"
|
|
14104
|
-
],
|
|
14105
|
-
"properties": {
|
|
14106
|
-
"name": {
|
|
14107
|
-
"type": "string",
|
|
14108
|
-
"description": "Name of the contact attribute"
|
|
14109
|
-
},
|
|
14110
|
-
"required": {
|
|
14111
|
-
"type": "boolean",
|
|
14112
|
-
"description": "Whether the user must provide a value for this attribute",
|
|
14113
|
-
"default": false
|
|
14114
|
-
}
|
|
14115
|
-
}
|
|
14116
|
-
},
|
|
14117
13918
|
"ContractIdentifier": {
|
|
14118
13919
|
"type": "object",
|
|
14119
13920
|
"properties": {
|
|
@@ -14261,9 +14062,6 @@
|
|
|
14261
14062
|
"contractIdentification": {
|
|
14262
14063
|
"type": "object",
|
|
14263
14064
|
"properties": {
|
|
14264
|
-
"app": {
|
|
14265
|
-
"$ref": "#/components/schemas/PublicAppDetails"
|
|
14266
|
-
},
|
|
14267
14065
|
"extension": {
|
|
14268
14066
|
"$ref": "#/components/schemas/PublicExtensionDetails"
|
|
14269
14067
|
},
|
|
@@ -14842,8 +14640,7 @@
|
|
|
14842
14640
|
},
|
|
14843
14641
|
"result": {
|
|
14844
14642
|
"type": "string",
|
|
14845
|
-
"
|
|
14846
|
-
"description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14643
|
+
"description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14847
14644
|
}
|
|
14848
14645
|
},
|
|
14849
14646
|
"required": [
|
|
@@ -14851,20 +14648,6 @@
|
|
|
14851
14648
|
"headers"
|
|
14852
14649
|
]
|
|
14853
14650
|
},
|
|
14854
|
-
"resolved": {
|
|
14855
|
-
"type": "object",
|
|
14856
|
-
"properties": {
|
|
14857
|
-
"result": {
|
|
14858
|
-
"type": "string",
|
|
14859
|
-
"description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
|
|
14860
|
-
},
|
|
14861
|
-
"error_message_path": {
|
|
14862
|
-
"type": "string",
|
|
14863
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14864
|
-
"example": "error.message"
|
|
14865
|
-
}
|
|
14866
|
-
}
|
|
14867
|
-
},
|
|
14868
14651
|
"use_static_ips": {
|
|
14869
14652
|
"type": "boolean",
|
|
14870
14653
|
"deprecated": true,
|
|
@@ -14927,8 +14710,7 @@
|
|
|
14927
14710
|
},
|
|
14928
14711
|
"result": {
|
|
14929
14712
|
"type": "string",
|
|
14930
|
-
"
|
|
14931
|
-
"description": "Deprecated. Use `resolved.result` instead. Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14713
|
+
"description": "Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation."
|
|
14932
14714
|
}
|
|
14933
14715
|
},
|
|
14934
14716
|
"required": [
|
|
@@ -14936,20 +14718,6 @@
|
|
|
14936
14718
|
"headers"
|
|
14937
14719
|
]
|
|
14938
14720
|
},
|
|
14939
|
-
"resolved": {
|
|
14940
|
-
"type": "object",
|
|
14941
|
-
"properties": {
|
|
14942
|
-
"result": {
|
|
14943
|
-
"type": "string",
|
|
14944
|
-
"description": "Contract or Contact ID usually retrieved from the response body, e.g. `{{CallResponse.data.contact_id}}`. If no result is passed and the request suceeds, we attempt to resolve the Contact ID automatically. Supports variable interpolation. Supersedes the deprecated `call.result`."
|
|
14945
|
-
},
|
|
14946
|
-
"error_message_path": {
|
|
14947
|
-
"type": "string",
|
|
14948
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
14949
|
-
"example": "error.message"
|
|
14950
|
-
}
|
|
14951
|
-
}
|
|
14952
|
-
},
|
|
14953
14721
|
"assignment_mode": {
|
|
14954
14722
|
"type": "string",
|
|
14955
14723
|
"enum": [
|
|
@@ -15054,16 +14822,11 @@
|
|
|
15054
14822
|
"type": "object",
|
|
15055
14823
|
"description": "Response to the call",
|
|
15056
14824
|
"properties": {
|
|
15057
|
-
"
|
|
14825
|
+
"dataPath": {
|
|
15058
14826
|
"type": "string",
|
|
15059
14827
|
"description": "Optional path to an array in the response. If specified and the path points to an array,\nthe hook will map over each item using 'Item' variable for interpolation.\nRelevant only if plausibility_mode is \"range\".\n",
|
|
15060
14828
|
"example": "data.results"
|
|
15061
14829
|
},
|
|
15062
|
-
"dataPath": {
|
|
15063
|
-
"type": "string",
|
|
15064
|
-
"deprecated": true,
|
|
15065
|
-
"description": "Deprecated. Use `data_path` instead."
|
|
15066
|
-
},
|
|
15067
14830
|
"counter_identifiers": {
|
|
15068
14831
|
"description": "Counter identifier(s) used to match against the meter's counters.\nCan be a string (counter ID) or an object with counter properties.\nThe backend resolves this to meter_counter_id in the final response.\nRelevant only if plausibility_mode is \"range\".\n",
|
|
15069
14832
|
"oneOf": [
|
|
@@ -15096,11 +14859,6 @@
|
|
|
15096
14859
|
"type": "string",
|
|
15097
14860
|
"description": "Lower allowed limit of the meter reading",
|
|
15098
14861
|
"example": "{{CallResponse.data.lower_limit}}"
|
|
15099
|
-
},
|
|
15100
|
-
"error_message_path": {
|
|
15101
|
-
"type": "string",
|
|
15102
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15103
|
-
"example": "error.message"
|
|
15104
14862
|
}
|
|
15105
14863
|
}
|
|
15106
14864
|
},
|
|
@@ -15177,19 +14935,9 @@
|
|
|
15177
14935
|
"resolved": {
|
|
15178
14936
|
"type": "object",
|
|
15179
14937
|
"properties": {
|
|
15180
|
-
"data_path": {
|
|
15181
|
-
"type": "string",
|
|
15182
|
-
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15183
|
-
},
|
|
15184
14938
|
"dataPath": {
|
|
15185
14939
|
"type": "string",
|
|
15186
|
-
"
|
|
15187
|
-
"description": "Deprecated. Use `data_path` instead."
|
|
15188
|
-
},
|
|
15189
|
-
"error_message_path": {
|
|
15190
|
-
"type": "string",
|
|
15191
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15192
|
-
"example": "error.message"
|
|
14940
|
+
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15193
14941
|
}
|
|
15194
14942
|
}
|
|
15195
14943
|
},
|
|
@@ -15265,19 +15013,9 @@
|
|
|
15265
15013
|
"resolved": {
|
|
15266
15014
|
"type": "object",
|
|
15267
15015
|
"properties": {
|
|
15268
|
-
"data_path": {
|
|
15269
|
-
"type": "string",
|
|
15270
|
-
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15271
|
-
},
|
|
15272
15016
|
"dataPath": {
|
|
15273
15017
|
"type": "string",
|
|
15274
|
-
"
|
|
15275
|
-
"description": "Deprecated. Use `data_path` instead."
|
|
15276
|
-
},
|
|
15277
|
-
"error_message_path": {
|
|
15278
|
-
"type": "string",
|
|
15279
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15280
|
-
"example": "error.message"
|
|
15018
|
+
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15281
15019
|
}
|
|
15282
15020
|
}
|
|
15283
15021
|
},
|
|
@@ -15357,16 +15095,6 @@
|
|
|
15357
15095
|
"url"
|
|
15358
15096
|
]
|
|
15359
15097
|
},
|
|
15360
|
-
"resolved": {
|
|
15361
|
-
"type": "object",
|
|
15362
|
-
"properties": {
|
|
15363
|
-
"error_message_path": {
|
|
15364
|
-
"type": "string",
|
|
15365
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15366
|
-
"example": "error.message"
|
|
15367
|
-
}
|
|
15368
|
-
}
|
|
15369
|
-
},
|
|
15370
15098
|
"use_static_ips": {
|
|
15371
15099
|
"type": "boolean",
|
|
15372
15100
|
"deprecated": true,
|
|
@@ -15439,19 +15167,9 @@
|
|
|
15439
15167
|
"resolved": {
|
|
15440
15168
|
"type": "object",
|
|
15441
15169
|
"properties": {
|
|
15442
|
-
"data_path": {
|
|
15443
|
-
"type": "string",
|
|
15444
|
-
"description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
|
|
15445
|
-
},
|
|
15446
15170
|
"dataPath": {
|
|
15447
15171
|
"type": "string",
|
|
15448
|
-
"
|
|
15449
|
-
"description": "Deprecated. Use `data_path` instead."
|
|
15450
|
-
},
|
|
15451
|
-
"error_message_path": {
|
|
15452
|
-
"type": "string",
|
|
15453
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15454
|
-
"example": "error.message"
|
|
15172
|
+
"description": "Optional path to the metadata object in the response. If omitted, the metadata is assumed to be on the top level."
|
|
15455
15173
|
}
|
|
15456
15174
|
}
|
|
15457
15175
|
},
|
|
@@ -15527,19 +15245,9 @@
|
|
|
15527
15245
|
"resolved": {
|
|
15528
15246
|
"type": "object",
|
|
15529
15247
|
"properties": {
|
|
15530
|
-
"data_path": {
|
|
15531
|
-
"type": "string",
|
|
15532
|
-
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15533
|
-
},
|
|
15534
15248
|
"dataPath": {
|
|
15535
15249
|
"type": "string",
|
|
15536
|
-
"
|
|
15537
|
-
"description": "Deprecated. Use `data_path` instead."
|
|
15538
|
-
},
|
|
15539
|
-
"error_message_path": {
|
|
15540
|
-
"type": "string",
|
|
15541
|
-
"description": "Optional path to a human-readable error message in the third-party response body, used when the call fails (non-2xx status).\nIf specified and the path resolves to a string, that message is forwarded to the end user instead of a generic error.\n",
|
|
15542
|
-
"example": "error.message"
|
|
15250
|
+
"description": "Optional path to the data (array) in the response. If omitted, the data is assumed to be on the top level."
|
|
15543
15251
|
}
|
|
15544
15252
|
}
|
|
15545
15253
|
},
|
|
@@ -15903,7 +15611,7 @@
|
|
|
15903
15611
|
"$ref": "#/components/schemas/ProviderDisplayName"
|
|
15904
15612
|
},
|
|
15905
15613
|
"oidc_config": {
|
|
15906
|
-
"$ref": "#/components/schemas/
|
|
15614
|
+
"$ref": "#/components/schemas/OIDCProviderPublicConfig"
|
|
15907
15615
|
},
|
|
15908
15616
|
"mobile_oidc_config": {
|
|
15909
15617
|
"$ref": "#/components/schemas/MoblieOIDCConfig"
|
|
@@ -16053,7 +15761,7 @@
|
|
|
16053
15761
|
},
|
|
16054
15762
|
"OIDCProviderConfig": {
|
|
16055
15763
|
"type": "object",
|
|
16056
|
-
"description": "OIDC provider configuration.
|
|
15764
|
+
"description": "OIDC provider configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MY_PROVIDER_CLIENT_SECRET }}`.\n",
|
|
16057
15765
|
"properties": {
|
|
16058
15766
|
"type": {
|
|
16059
15767
|
"type": "string",
|
|
@@ -16101,8 +15809,61 @@
|
|
|
16101
15809
|
"enum": [
|
|
16102
15810
|
"login",
|
|
16103
15811
|
"select_account",
|
|
16104
|
-
"consent"
|
|
16105
|
-
|
|
15812
|
+
"consent"
|
|
15813
|
+
]
|
|
15814
|
+
}
|
|
15815
|
+
},
|
|
15816
|
+
"required": [
|
|
15817
|
+
"oidc_issuer",
|
|
15818
|
+
"client_id",
|
|
15819
|
+
"scope"
|
|
15820
|
+
]
|
|
15821
|
+
},
|
|
15822
|
+
"OIDCProviderPublicConfig": {
|
|
15823
|
+
"type": "object",
|
|
15824
|
+
"description": "Public OIDC provider configuration. Same as OIDCProviderConfig but never includes\nthe `client_secret` field — it is kept server-side and only used to exchange the\nauthorization code at the SSO callback. String fields are returned with env var\nplaceholders already resolved when fetched via `GET /v2/portal/public/sso/providers/{provider_slug}`.\n",
|
|
15825
|
+
"properties": {
|
|
15826
|
+
"type": {
|
|
15827
|
+
"type": "string",
|
|
15828
|
+
"enum": [
|
|
15829
|
+
"authorization_code",
|
|
15830
|
+
"implicit"
|
|
15831
|
+
],
|
|
15832
|
+
"default": "implicit"
|
|
15833
|
+
},
|
|
15834
|
+
"oidc_issuer": {
|
|
15835
|
+
"type": "string",
|
|
15836
|
+
"description": "Issuing Authority URL",
|
|
15837
|
+
"example": "https://login.microsoftonline.com/33d4f3e5-3df2-421e-b92e-a63cfa680a88/v2.0"
|
|
15838
|
+
},
|
|
15839
|
+
"redirect_uri": {
|
|
15840
|
+
"type": "string",
|
|
15841
|
+
"description": "Redirect URI for the OIDC flow",
|
|
15842
|
+
"example": "https://customer-portal.com/login"
|
|
15843
|
+
},
|
|
15844
|
+
"client_id": {
|
|
15845
|
+
"type": "string",
|
|
15846
|
+
"example": "ab81daf8-8b1f-42d6-94ca-c51621054c75"
|
|
15847
|
+
},
|
|
15848
|
+
"has_client_secret": {
|
|
15849
|
+
"type": "boolean",
|
|
15850
|
+
"description": "Whether the client secret is present (the value itself is kept server-side)",
|
|
15851
|
+
"example": true
|
|
15852
|
+
},
|
|
15853
|
+
"scope": {
|
|
15854
|
+
"type": "string",
|
|
15855
|
+
"description": "Space-separated list of OAuth 2.0 scopes to request from OpenID Connect",
|
|
15856
|
+
"example": "openid email"
|
|
15857
|
+
},
|
|
15858
|
+
"metadata": {
|
|
15859
|
+
"$ref": "#/components/schemas/OIDCProviderMetadata"
|
|
15860
|
+
},
|
|
15861
|
+
"prompt": {
|
|
15862
|
+
"type": "string",
|
|
15863
|
+
"enum": [
|
|
15864
|
+
"login",
|
|
15865
|
+
"select_account",
|
|
15866
|
+
"consent"
|
|
16106
15867
|
]
|
|
16107
15868
|
}
|
|
16108
15869
|
},
|
|
@@ -16114,7 +15875,7 @@
|
|
|
16114
15875
|
},
|
|
16115
15876
|
"MoblieOIDCConfig": {
|
|
16116
15877
|
"type": "object",
|
|
16117
|
-
"description": "Mobile OIDC configuration.
|
|
15878
|
+
"description": "Mobile OIDC configuration. All string fields support env var interpolation\n(incl. secrets) via mustache-like templates, e.g. `{{ env.MOBILE_CLIENT_SECRET }}`.\n",
|
|
16118
15879
|
"properties": {
|
|
16119
15880
|
"client_id": {
|
|
16120
15881
|
"type": "string",
|
|
@@ -16131,18 +15892,6 @@
|
|
|
16131
15892
|
"OIDCProviderMetadata": {
|
|
16132
15893
|
"type": "object",
|
|
16133
15894
|
"properties": {
|
|
16134
|
-
"response_modes_supported": {
|
|
16135
|
-
"type": "array",
|
|
16136
|
-
"description": "Response modes the provider accepts (e.g. `form_post` for Apple)",
|
|
16137
|
-
"items": {
|
|
16138
|
-
"type": "string",
|
|
16139
|
-
"enum": [
|
|
16140
|
-
"form_post",
|
|
16141
|
-
"fragment",
|
|
16142
|
-
"query"
|
|
16143
|
-
]
|
|
16144
|
-
}
|
|
16145
|
-
},
|
|
16146
15895
|
"authorization_endpoint": {
|
|
16147
15896
|
"type": "string",
|
|
16148
15897
|
"description": "URL of the authorization endpoint",
|
|
@@ -16658,19 +16407,14 @@
|
|
|
16658
16407
|
},
|
|
16659
16408
|
"self_registration_account_setting": {
|
|
16660
16409
|
"type": "string",
|
|
16661
|
-
"description": "Controls behavior of self-registration when account is
|
|
16410
|
+
"description": "Controls behavior of self-registration when account is used as the registration entity",
|
|
16662
16411
|
"enum": [
|
|
16663
|
-
"
|
|
16412
|
+
"ALLOW_WITH_CONTACT_CREATION",
|
|
16664
16413
|
"DENY",
|
|
16665
|
-
"
|
|
16666
|
-
"BLOCK_IF_PORTAL_USER_EXISTS",
|
|
16414
|
+
"ALWAYS_CREATE_CONTACT",
|
|
16667
16415
|
"DISALLOW_COMPLETELY"
|
|
16668
16416
|
]
|
|
16669
16417
|
},
|
|
16670
|
-
"block_registration_if_portal_user_exists": {
|
|
16671
|
-
"type": "boolean",
|
|
16672
|
-
"description": "Account-mode only. Reject registration when the resolved account already\nhas any portal user (any portal user whose mapped contact is linked to\nthe account).\n"
|
|
16673
|
-
},
|
|
16674
16418
|
"self_registration_entity": {
|
|
16675
16419
|
"type": "string",
|
|
16676
16420
|
"description": "Entity type used as the primary identifier for self-registration",
|
|
@@ -16987,40 +16731,6 @@
|
|
|
16987
16731
|
}
|
|
16988
16732
|
]
|
|
16989
16733
|
},
|
|
16990
|
-
"contact_identifiers_for_account": {
|
|
16991
|
-
"type": "array",
|
|
16992
|
-
"description": "Account-mode only. Identifiers on the contact entity of the primarily\nidentified account. Used to pick an existing related contact within the\nresolved account; if none matches, the values are written onto the new\ncontact that is created and linked to the account.\n",
|
|
16993
|
-
"items": {
|
|
16994
|
-
"$ref": "#/components/schemas/RegistrationIdentifier"
|
|
16995
|
-
},
|
|
16996
|
-
"example": [
|
|
16997
|
-
{
|
|
16998
|
-
"name": "first_name",
|
|
16999
|
-
"schema": "contact"
|
|
17000
|
-
},
|
|
17001
|
-
{
|
|
17002
|
-
"name": "last_name",
|
|
17003
|
-
"schema": "contact"
|
|
17004
|
-
}
|
|
17005
|
-
]
|
|
17006
|
-
},
|
|
17007
|
-
"additional_contact_attributes": {
|
|
17008
|
-
"type": "array",
|
|
17009
|
-
"description": "Contact attributes collected from the user during self-registration that are\nwritten onto the newly created contact but are not used to identify an\nexisting one.\n",
|
|
17010
|
-
"items": {
|
|
17011
|
-
"$ref": "#/components/schemas/AdditionalContactAttribute"
|
|
17012
|
-
},
|
|
17013
|
-
"example": [
|
|
17014
|
-
{
|
|
17015
|
-
"name": "first_name",
|
|
17016
|
-
"required": true
|
|
17017
|
-
},
|
|
17018
|
-
{
|
|
17019
|
-
"name": "last_name",
|
|
17020
|
-
"required": true
|
|
17021
|
-
}
|
|
17022
|
-
]
|
|
17023
|
-
},
|
|
17024
16734
|
"triggered_journeys": {
|
|
17025
16735
|
"type": "array",
|
|
17026
16736
|
"description": "Journeys automatically opened on a portal user action",
|
|
@@ -17037,21 +16747,6 @@
|
|
|
17037
16747
|
},
|
|
17038
16748
|
"journey_id": {
|
|
17039
16749
|
"$ref": "#/components/schemas/EntityId"
|
|
17040
|
-
},
|
|
17041
|
-
"context_params": {
|
|
17042
|
-
"type": "array",
|
|
17043
|
-
"description": "Context parameters forwarded to the journey when it is\nauto-triggered. Values may contain handlebars templates\nthat reference the available context (e.g.\n`{{contact._id}}`, `{{portal_user.email}}`,\n`{{order._id}}`) — these are resolved at trigger time by\n`GET /v2/portal/config/triggered-journeys/{trigger_name}`\nusing the caller's auth context plus runtime entities\nsupplied via the `context_entities` query param.\n",
|
|
17044
|
-
"items": {
|
|
17045
|
-
"type": "object",
|
|
17046
|
-
"properties": {
|
|
17047
|
-
"key": {
|
|
17048
|
-
"type": "string"
|
|
17049
|
-
},
|
|
17050
|
-
"value": {
|
|
17051
|
-
"type": "string"
|
|
17052
|
-
}
|
|
17053
|
-
}
|
|
17054
|
-
}
|
|
17055
16750
|
}
|
|
17056
16751
|
}
|
|
17057
16752
|
}
|