@epilot/sdk 2.8.6 → 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 -258
- package/definitions/user-runtime.json +1 -1
- package/definitions/user.json +0 -441
- package/definitions/webhooks.json +0 -31
- package/package.json +1 -1
- package/definitions/snapshot-runtime.json +0 -1
- package/definitions/snapshot.json +0 -950
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://targeting.sls.epilot.io","o":[["changeCampaignStatus","post","/v1/campaign/{campaign_id}/status",[["CampaignIdPathParam"]]],["getCampaignJobStatus","get","/v1/campaign/{campaign_id}/job",[["CampaignIdPathParam"]]],["getCampaignPortals","get","/v1/campaign/{campaign_id}/portals",[["CampaignIdPathParam"]]],["retriggerCampaignAutomations","post","/v1/campaign/{campaign_id}/automations:retrigger",[["CampaignIdPathParam"]],1],["
|
|
1
|
+
{"s":"https://targeting.sls.epilot.io","o":[["changeCampaignStatus","post","/v1/campaign/{campaign_id}/status",[["CampaignIdPathParam"]]],["getCampaignJobStatus","get","/v1/campaign/{campaign_id}/job",[["CampaignIdPathParam"]]],["getCampaignPortals","get","/v1/campaign/{campaign_id}/portals",[["CampaignIdPathParam"]]],["retriggerCampaignAutomations","post","/v1/campaign/{campaign_id}/automations:retrigger",[["CampaignIdPathParam"]],1],["matchCampaigns","post","/v1/campaign:match",null,1],["matchTargets","post","/v1/target:match",null,1],["getTargetQueries","post","/v1/target/queries",null,1],["createRecipient","post","/v1/campaign/{campaign_id}/recipient",[["CampaignIdPathParam"]],1],["updateRecipient","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["updateRecipientPortalStatus","patch","/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status",[["CampaignIdPathParam"],["RecipientIdPathParam"]],1],["getRecipients","get","/v1/campaign/{campaign_id}/recipients",[["CampaignIdPathParam"],["limit","q"],["next","q"],["q","q"],["automation_status","q"],["portal_status","q"]]]],"v":"3.0.3","cp":{"CampaignIdPathParam":["campaign_id","p",true],"RecipientIdPathParam":["recipient_id","p",true]}}
|
|
@@ -31,6 +31,13 @@
|
|
|
31
31
|
"servers": [
|
|
32
32
|
{
|
|
33
33
|
"url": "https://targeting.sls.epilot.io"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"url": "https://targeting.sls.epilot.io"
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"url": "https://targeting.sls.epilot.io",
|
|
40
|
+
"description": "Production Server"
|
|
34
41
|
}
|
|
35
42
|
],
|
|
36
43
|
"paths": {
|
|
@@ -171,42 +178,6 @@
|
|
|
171
178
|
}
|
|
172
179
|
}
|
|
173
180
|
},
|
|
174
|
-
"/v1/campaign:setup": {
|
|
175
|
-
"post": {
|
|
176
|
-
"operationId": "setupCampaign",
|
|
177
|
-
"summary": "Set up a campaign with related entities and configurations",
|
|
178
|
-
"description": "Creates a `campaign` entity together with its related entities and configurations in a single call.\nUsed by the campaign wizard UI, but not restricted to it.\n",
|
|
179
|
-
"tags": [
|
|
180
|
-
"Campaign"
|
|
181
|
-
],
|
|
182
|
-
"security": [
|
|
183
|
-
{
|
|
184
|
-
"EpilotAuth": []
|
|
185
|
-
}
|
|
186
|
-
],
|
|
187
|
-
"requestBody": {
|
|
188
|
-
"required": true,
|
|
189
|
-
"content": {
|
|
190
|
-
"application/json": {
|
|
191
|
-
"schema": {
|
|
192
|
-
"$ref": "#/components/schemas/SetupCampaignRequest"
|
|
193
|
-
}
|
|
194
|
-
}
|
|
195
|
-
}
|
|
196
|
-
},
|
|
197
|
-
"responses": {
|
|
198
|
-
"201": {
|
|
199
|
-
"$ref": "#/components/responses/SetupCampaignResponse"
|
|
200
|
-
},
|
|
201
|
-
"400": {
|
|
202
|
-
"$ref": "#/components/responses/ClientErrorResponse"
|
|
203
|
-
},
|
|
204
|
-
"500": {
|
|
205
|
-
"$ref": "#/components/responses/ServerErrorResponse"
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
|
-
}
|
|
209
|
-
},
|
|
210
181
|
"/v1/campaign:match": {
|
|
211
182
|
"post": {
|
|
212
183
|
"operationId": "matchCampaigns",
|
|
@@ -1210,208 +1181,6 @@
|
|
|
1210
1181
|
"required": [
|
|
1211
1182
|
"status"
|
|
1212
1183
|
]
|
|
1213
|
-
},
|
|
1214
|
-
"SetupCampaignRequest": {
|
|
1215
|
-
"description": "Discriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n",
|
|
1216
|
-
"oneOf": [
|
|
1217
|
-
{
|
|
1218
|
-
"$ref": "#/components/schemas/SetupTariffChangeCampaignRequest"
|
|
1219
|
-
}
|
|
1220
|
-
],
|
|
1221
|
-
"discriminator": {
|
|
1222
|
-
"propertyName": "type",
|
|
1223
|
-
"mapping": {
|
|
1224
|
-
"tariff_change": "#/components/schemas/SetupTariffChangeCampaignRequest"
|
|
1225
|
-
}
|
|
1226
|
-
}
|
|
1227
|
-
},
|
|
1228
|
-
"SetupTariffChangeCampaignRequest": {
|
|
1229
|
-
"type": "object",
|
|
1230
|
-
"properties": {
|
|
1231
|
-
"type": {
|
|
1232
|
-
"type": "string",
|
|
1233
|
-
"enum": [
|
|
1234
|
-
"tariff_change"
|
|
1235
|
-
]
|
|
1236
|
-
},
|
|
1237
|
-
"product_recommendation": {
|
|
1238
|
-
"type": "object",
|
|
1239
|
-
"properties": {
|
|
1240
|
-
"name": {
|
|
1241
|
-
"type": "string",
|
|
1242
|
-
"description": "Optional name of the product recommendation. Defaults to the campaign name."
|
|
1243
|
-
},
|
|
1244
|
-
"source_product_id": {
|
|
1245
|
-
"allOf": [
|
|
1246
|
-
{
|
|
1247
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1248
|
-
}
|
|
1249
|
-
],
|
|
1250
|
-
"description": "Optional source product entity ID for the recommendation."
|
|
1251
|
-
},
|
|
1252
|
-
"source_price_id": {
|
|
1253
|
-
"allOf": [
|
|
1254
|
-
{
|
|
1255
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1256
|
-
}
|
|
1257
|
-
],
|
|
1258
|
-
"description": "Optional source price entity ID for the recommendation."
|
|
1259
|
-
},
|
|
1260
|
-
"offers": {
|
|
1261
|
-
"type": "array",
|
|
1262
|
-
"description": "Offer blocks for the product_recommendation entity.",
|
|
1263
|
-
"items": {
|
|
1264
|
-
"type": "object",
|
|
1265
|
-
"properties": {
|
|
1266
|
-
"target_id": {
|
|
1267
|
-
"$ref": "#/components/schemas/BaseUUID",
|
|
1268
|
-
"description": "Optional per-offer target entity ID."
|
|
1269
|
-
},
|
|
1270
|
-
"items": {
|
|
1271
|
-
"type": "array",
|
|
1272
|
-
"description": "Product/price pairs within this offer.",
|
|
1273
|
-
"items": {
|
|
1274
|
-
"type": "object",
|
|
1275
|
-
"properties": {
|
|
1276
|
-
"product_id": {
|
|
1277
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1278
|
-
},
|
|
1279
|
-
"price_id": {
|
|
1280
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1281
|
-
},
|
|
1282
|
-
"highlight_config": {
|
|
1283
|
-
"type": "object",
|
|
1284
|
-
"description": "Opaque per-item highlight/comparison config persisted as-is on the entity.",
|
|
1285
|
-
"additionalProperties": true
|
|
1286
|
-
}
|
|
1287
|
-
},
|
|
1288
|
-
"required": [
|
|
1289
|
-
"product_id",
|
|
1290
|
-
"price_id"
|
|
1291
|
-
],
|
|
1292
|
-
"additionalProperties": false
|
|
1293
|
-
}
|
|
1294
|
-
}
|
|
1295
|
-
},
|
|
1296
|
-
"required": [
|
|
1297
|
-
"items"
|
|
1298
|
-
],
|
|
1299
|
-
"additionalProperties": false
|
|
1300
|
-
}
|
|
1301
|
-
}
|
|
1302
|
-
},
|
|
1303
|
-
"additionalProperties": false
|
|
1304
|
-
},
|
|
1305
|
-
"campaign": {
|
|
1306
|
-
"type": "object",
|
|
1307
|
-
"properties": {
|
|
1308
|
-
"name": {
|
|
1309
|
-
"type": "string"
|
|
1310
|
-
},
|
|
1311
|
-
"goal": {
|
|
1312
|
-
"type": "string"
|
|
1313
|
-
},
|
|
1314
|
-
"target_ids": {
|
|
1315
|
-
"type": "array",
|
|
1316
|
-
"description": "List of target entity IDs to attach to the campaign. Today only a single\nentry is supported (campaign.target is has_one) but the array shape is kept\nfor forward-compatibility — only `target_ids[0]` is used.\n",
|
|
1317
|
-
"items": {
|
|
1318
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1319
|
-
}
|
|
1320
|
-
}
|
|
1321
|
-
},
|
|
1322
|
-
"required": [
|
|
1323
|
-
"name",
|
|
1324
|
-
"target_ids"
|
|
1325
|
-
],
|
|
1326
|
-
"additionalProperties": false
|
|
1327
|
-
},
|
|
1328
|
-
"journey": {
|
|
1329
|
-
"type": "object",
|
|
1330
|
-
"description": "Optional journey configuration selected in the wizard. Only sent by the\nconsumer once a journey has been chosen.\n",
|
|
1331
|
-
"properties": {
|
|
1332
|
-
"journey_id": {
|
|
1333
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1334
|
-
}
|
|
1335
|
-
},
|
|
1336
|
-
"required": [
|
|
1337
|
-
"journey_id"
|
|
1338
|
-
],
|
|
1339
|
-
"additionalProperties": false
|
|
1340
|
-
},
|
|
1341
|
-
"channels": {
|
|
1342
|
-
"type": "object",
|
|
1343
|
-
"description": "Optional delivery channel configuration. Each channel is only sent by the\nconsumer once it has been enabled and fully configured in the wizard.\n",
|
|
1344
|
-
"properties": {
|
|
1345
|
-
"portal_widget": {
|
|
1346
|
-
"type": "object",
|
|
1347
|
-
"description": "Portal widget placement for the product recommendation block. Only sent by\nthe consumer once both a portal and a block have been selected.\n",
|
|
1348
|
-
"properties": {
|
|
1349
|
-
"portal_id": {
|
|
1350
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1351
|
-
},
|
|
1352
|
-
"block_id": {
|
|
1353
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1354
|
-
}
|
|
1355
|
-
},
|
|
1356
|
-
"required": [
|
|
1357
|
-
"portal_id",
|
|
1358
|
-
"block_id"
|
|
1359
|
-
],
|
|
1360
|
-
"additionalProperties": false
|
|
1361
|
-
},
|
|
1362
|
-
"email": {
|
|
1363
|
-
"type": "object",
|
|
1364
|
-
"description": "Email campaign delivery. An automation flow (legacy) and/or an email\ntemplate can be provided to send the campaign emails. The selection is\npersisted as the campaign's `flow_id`. If `automation_id` is provided it is\nused as-is; otherwise a flow is created from `template_id`. Only sent by the\nconsumer once one has been selected.\n",
|
|
1365
|
-
"properties": {
|
|
1366
|
-
"automation_id": {
|
|
1367
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1368
|
-
},
|
|
1369
|
-
"template_id": {
|
|
1370
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1371
|
-
}
|
|
1372
|
-
},
|
|
1373
|
-
"minProperties": 1,
|
|
1374
|
-
"additionalProperties": false
|
|
1375
|
-
}
|
|
1376
|
-
},
|
|
1377
|
-
"additionalProperties": false
|
|
1378
|
-
}
|
|
1379
|
-
},
|
|
1380
|
-
"required": [
|
|
1381
|
-
"type",
|
|
1382
|
-
"product_recommendation",
|
|
1383
|
-
"campaign"
|
|
1384
|
-
],
|
|
1385
|
-
"additionalProperties": false
|
|
1386
|
-
},
|
|
1387
|
-
"SetupTariffChangeCampaignResponse": {
|
|
1388
|
-
"type": "object",
|
|
1389
|
-
"properties": {
|
|
1390
|
-
"type": {
|
|
1391
|
-
"type": "string",
|
|
1392
|
-
"enum": [
|
|
1393
|
-
"tariff_change"
|
|
1394
|
-
]
|
|
1395
|
-
},
|
|
1396
|
-
"product_recommendation_id": {
|
|
1397
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1398
|
-
},
|
|
1399
|
-
"campaign_id": {
|
|
1400
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1401
|
-
},
|
|
1402
|
-
"journey_id": {
|
|
1403
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1404
|
-
},
|
|
1405
|
-
"portal_widget_id": {
|
|
1406
|
-
"$ref": "#/components/schemas/BaseUUID"
|
|
1407
|
-
}
|
|
1408
|
-
},
|
|
1409
|
-
"required": [
|
|
1410
|
-
"type",
|
|
1411
|
-
"product_recommendation_id",
|
|
1412
|
-
"campaign_id"
|
|
1413
|
-
],
|
|
1414
|
-
"additionalProperties": false
|
|
1415
1184
|
}
|
|
1416
1185
|
},
|
|
1417
1186
|
"securitySchemes": {
|
|
@@ -1673,26 +1442,6 @@
|
|
|
1673
1442
|
}
|
|
1674
1443
|
}
|
|
1675
1444
|
},
|
|
1676
|
-
"SetupCampaignResponse": {
|
|
1677
|
-
"description": "Discriminated by `type`, mirroring the request. Each campaign variant has its\nown response shape; new variants extend the `oneOf` list alongside the request.\n",
|
|
1678
|
-
"content": {
|
|
1679
|
-
"application/json": {
|
|
1680
|
-
"schema": {
|
|
1681
|
-
"oneOf": [
|
|
1682
|
-
{
|
|
1683
|
-
"$ref": "#/components/schemas/SetupTariffChangeCampaignResponse"
|
|
1684
|
-
}
|
|
1685
|
-
],
|
|
1686
|
-
"discriminator": {
|
|
1687
|
-
"propertyName": "type",
|
|
1688
|
-
"mapping": {
|
|
1689
|
-
"tariff_change": "#/components/schemas/SetupTariffChangeCampaignResponse"
|
|
1690
|
-
}
|
|
1691
|
-
}
|
|
1692
|
-
}
|
|
1693
|
-
}
|
|
1694
|
-
}
|
|
1695
|
-
},
|
|
1696
1445
|
"RetriggerAutomationsResponse": {
|
|
1697
1446
|
"description": "Response to a request to retrigger automations for campaign recipients",
|
|
1698
1447
|
"content": {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["
|
|
1
|
+
{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUsersV2","get","/v2/users",[["query","q"],["limit","q"],["offset","q"]]],["getUserV2","get","/v2/users/{id}",[["id","p",true]]],["updateUserV2","patch","/v2/users/{id}",[["id","p",true]],1],["deleteUserV2","delete","/v2/users/{id}",[["id","p",true]]],["inviteUser","post","/v2/users/invite",null,1],["resendUserInvitation","post","/v2/users/invite:resendEmail",null,1],["getGroupsForUser","get","/v2/users/{id}/groups",[["id","p",true]]],["getGroups","get","/v1/groups",[["query","q"],["limit","q"],["offset","q"],["hydrate","q"]]],["createGroup","post","/v1/groups",null,1],["getGroup","get","/v1/groups/{id}",[["id","p",true],["hydrate","q"]]],["updateGroup","patch","/v1/groups/{id}",[["id","p",true]],1],["deleteGroup","delete","/v1/groups/{id}",[["id","p",true]]],["advanceUserAssignment","post","/v1/groups/{id}/user:next",[["id","p",true]]],["createNavigation","post","/v2/user/navigations",null,1],["getNavigation","get","/v2/user/navigations/{id}",[["id","p",true]]],["verifyEmailWithToken","post","/v2/users/public/verifyEmail",[["token","q",true]],1],["checkInviteToken","get","/v2/users/public/checkToken",[["token","q",true]]],["activateUser","post","/v2/users/public/activate",[["token","q",true]],1],["rejectInvite","delete","/v2/users/public/reject",[["token","q",true]]],["getUserLoginParametersV2","get","/v2/users/public/username/{username}:getLoginParameters",[["username","p",true]]],["beginPasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBegin",null,1],["beginDiscoverablePasskeyAuthentication","post","/v2/users/public/passkeys:authenticateBeginDiscoverable"],["resolveDiscoverableCredential","post","/v2/users/public/passkeys:resolveCredential",null,1],["beginPasskeyRegistration","post","/v2/users/me/passkeys:registerBegin",null,1],["completePasskeyRegistration","post","/v2/users/me/passkeys:registerComplete",null,1],["listPasskeys","get","/v2/users/me/passkeys"],["deletePasskey","delete","/v2/users/me/passkeys/{credentialId}",[["credentialId","p",true]]],["switchOrganization","post","/v2/users/switchOrganization",null,1],["getMe","get","/v1/users/me"],["listUsers","get","/v1/users",[["org_ids","q",false,"form",false],["query","q"],["limit","q"],["offset","q"]]],["getUser","get","/v1/users/{id}",[["id","p",true]]],["getUserLoginParameters","get","/v1/users/username/{username}:getLoginParameters",[["username","p",true]]]]}
|