@epilot/sdk 2.8.7 → 2.8.8

package/definitions/targeting-runtime.json

@@ -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]}}
+{"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],["setupCampaign","post","/v1/campaign:setup",null,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]}}

package/definitions/targeting.json

@@ -31,13 +31,6 @@
   "servers": [
     {
       "url": "https://targeting.sls.epilot.io"
-    },
-    {
-      "url": "https://targeting.sls.epilot.io"
-    },
-    {
-      "url": "https://targeting.sls.epilot.io",
-      "description": "Production Server"
     }
   ],
   "paths": {
@@ -178,6 +171,42 @@
         }
       }
     },
+    "/v1/campaign:setup": {
+      "post": {
+        "operationId": "setupCampaign",
+        "summary": "Set up a campaign with related entities and configurations",
+        "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",
+        "tags": [
+          "Campaign"
+        ],
+        "security": [
+          {
+            "EpilotAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/SetupCampaignRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "$ref": "#/components/responses/SetupCampaignResponse"
+          },
+          "400": {
+            "$ref": "#/components/responses/ClientErrorResponse"
+          },
+          "500": {
+            "$ref": "#/components/responses/ServerErrorResponse"
+          }
+        }
+      }
+    },
     "/v1/campaign:match": {
       "post": {
         "operationId": "matchCampaigns",
@@ -1181,6 +1210,208 @@
         "required": [
           "status"
         ]
+      },
+      "SetupCampaignRequest": {
+        "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",
+        "oneOf": [
+          {
+            "$ref": "#/components/schemas/SetupTariffChangeCampaignRequest"
+          }
+        ],
+        "discriminator": {
+          "propertyName": "type",
+          "mapping": {
+            "tariff_change": "#/components/schemas/SetupTariffChangeCampaignRequest"
+          }
+        }
+      },
+      "SetupTariffChangeCampaignRequest": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "tariff_change"
+            ]
+          },
+          "product_recommendation": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Optional name of the product recommendation. Defaults to the campaign name."
+              },
+              "source_product_id": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  }
+                ],
+                "description": "Optional source product entity ID for the recommendation."
+              },
+              "source_price_id": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  }
+                ],
+                "description": "Optional source price entity ID for the recommendation."
+              },
+              "offers": {
+                "type": "array",
+                "description": "Offer blocks for the product_recommendation entity.",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "target_id": {
+                      "$ref": "#/components/schemas/BaseUUID",
+                      "description": "Optional per-offer target entity ID."
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Product/price pairs within this offer.",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "product_id": {
+                            "$ref": "#/components/schemas/BaseUUID"
+                          },
+                          "price_id": {
+                            "$ref": "#/components/schemas/BaseUUID"
+                          },
+                          "highlight_config": {
+                            "type": "object",
+                            "description": "Opaque per-item highlight/comparison config persisted as-is on the entity.",
+                            "additionalProperties": true
+                          }
+                        },
+                        "required": [
+                          "product_id",
+                          "price_id"
+                        ],
+                        "additionalProperties": false
+                      }
+                    }
+                  },
+                  "required": [
+                    "items"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "additionalProperties": false
+          },
+          "campaign": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "goal": {
+                "type": "string"
+              },
+              "target_ids": {
+                "type": "array",
+                "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",
+                "items": {
+                  "$ref": "#/components/schemas/BaseUUID"
+                }
+              }
+            },
+            "required": [
+              "name",
+              "target_ids"
+            ],
+            "additionalProperties": false
+          },
+          "journey": {
+            "type": "object",
+            "description": "Optional journey configuration selected in the wizard. Only sent by the\nconsumer once a journey has been chosen.\n",
+            "properties": {
+              "journey_id": {
+                "$ref": "#/components/schemas/BaseUUID"
+              }
+            },
+            "required": [
+              "journey_id"
+            ],
+            "additionalProperties": false
+          },
+          "channels": {
+            "type": "object",
+            "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",
+            "properties": {
+              "portal_widget": {
+                "type": "object",
+                "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",
+                "properties": {
+                  "portal_id": {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  },
+                  "block_id": {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  }
+                },
+                "required": [
+                  "portal_id",
+                  "block_id"
+                ],
+                "additionalProperties": false
+              },
+              "email": {
+                "type": "object",
+                "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",
+                "properties": {
+                  "automation_id": {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  },
+                  "template_id": {
+                    "$ref": "#/components/schemas/BaseUUID"
+                  }
+                },
+                "minProperties": 1,
+                "additionalProperties": false
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        "required": [
+          "type",
+          "product_recommendation",
+          "campaign"
+        ],
+        "additionalProperties": false
+      },
+      "SetupTariffChangeCampaignResponse": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "tariff_change"
+            ]
+          },
+          "product_recommendation_id": {
+            "$ref": "#/components/schemas/BaseUUID"
+          },
+          "campaign_id": {
+            "$ref": "#/components/schemas/BaseUUID"
+          },
+          "journey_id": {
+            "$ref": "#/components/schemas/BaseUUID"
+          },
+          "portal_widget_id": {
+            "$ref": "#/components/schemas/BaseUUID"
+          }
+        },
+        "required": [
+          "type",
+          "product_recommendation_id",
+          "campaign_id"
+        ],
+        "additionalProperties": false
       }
     },
     "securitySchemes": {
@@ -1442,6 +1673,26 @@
           }
         }
       },
+      "SetupCampaignResponse": {
+        "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",
+        "content": {
+          "application/json": {
+            "schema": {
+              "oneOf": [
+                {
+                  "$ref": "#/components/schemas/SetupTariffChangeCampaignResponse"
+                }
+              ],
+              "discriminator": {
+                "propertyName": "type",
+                "mapping": {
+                  "tariff_change": "#/components/schemas/SetupTariffChangeCampaignResponse"
+                }
+              }
+            }
+          }
+        }
+      },
       "RetriggerAutomationsResponse": {
         "description": "Response to a request to retrigger automations for campaign recipients",
         "content": {

package/definitions/user-runtime.json

@@ -1 +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]]]]}
+{"s":"https://user.sls.epilot.io","o":[["signUpUser","post","/v2/users/public/signup",[["token","q"]],1],["getMeV2","get","/v2/users/me"],["listUserSettings","get","/v2/users/me/settings"],["getUserSettingsScope","get","/v2/users/me/settings/{scope}",[["scope","p",true]]],["getUserSetting","get","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["putUserSetting","put","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]],1],["deleteUserSetting","delete","/v2/users/me/settings/{scope}/{key}",[["scope","p",true],["key","p",true]]],["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],["sendUserPasswordReset","post","/v2/users:sendPasswordReset",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],["requestPasswordReset","post","/v2/users/public/requestPasswordReset",null,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]]]]}