@epilot/sdk 2.8.0-rc.0 → 2.8.1

package/docs/targeting.md

@@ -28,6 +28,7 @@ const { data } = await targetingClient.changeCampaignStatus(...)
 - [`changeCampaignStatus`](#changecampaignstatus)
 - [`getCampaignJobStatus`](#getcampaignjobstatus)
 - [`getCampaignPortals`](#getcampaignportals)
+- [`setupCampaign`](#setupcampaign)
 - [`matchCampaigns`](#matchcampaigns)
 
 **Campaign Delivery**
@@ -76,6 +77,9 @@ const { data } = await targetingClient.changeCampaignStatus(...)
 - [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)
 - [`RetriggerAutomationsResult`](#retriggerautomationsresult)
 - [`UpdatePortalStatusRequest`](#updateportalstatusrequest)
+- [`SetupCampaignRequest`](#setupcampaignrequest)
+- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)
+- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)
 
 ### `changeCampaignStatus`
 
@@ -116,8 +120,8 @@ const { data } = await client.changeCampaignStatus({
     "name": "string",
     "goal": "string",
     "status": "draft",
-    "start_date": "string",
-    "end_date": "string",
+    "start_date": "1970-01-01",
+    "end_date": "1970-01-01",
     "flow_id": "string",
     "job_id": "string",
     "target": {
@@ -245,6 +249,72 @@ const { data } = await client.retriggerCampaignAutomations(
 
 ---
 
+### `setupCampaign`
+
+Set up a campaign with related entities and configurations
+
+`POST /v1/campaign:setup`
+
+```ts
+const { data } = await client.setupCampaign(
+  null,
+  {
+    type: 'tariff_change',
+    product_recommendation: {
+      name: 'string',
+      source_product_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+      source_price_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+      offers: [
+        {
+          target_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+          items: [
+            {
+              product_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+              price_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+              highlight_config: {}
+            }
+          ]
+        }
+      ]
+    },
+    campaign: {
+      name: 'string',
+      goal: 'string',
+      target_ids: ['b8c01433-5556-4e2b-aad4-6f5348d1df84']
+    },
+    journey: {
+      journey_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84'
+    },
+    channels: {
+      portal_widget: {
+        portal_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
+        block_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84'
+      },
+      email: {
+        automation_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84'
+      }
+    }
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "type": "tariff_change",
+  "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",
+  "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",
+  "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",
+  "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"
+}
+```
+
+</details>
+
+---
+
 ### `matchCampaigns`
 
 Match campaigns
@@ -296,8 +366,8 @@ const { data } = await client.matchCampaigns(
         "name": "string",
         "goal": "string",
         "status": "draft",
-        "start_date": "string",
-        "end_date": "string",
+        "start_date": "1970-01-01",
+        "end_date": "1970-01-01",
         "flow_id": "string",
         "job_id": "string",
         "target": {
@@ -957,3 +1027,87 @@ type UpdatePortalStatusRequest = {
   status: "sent" | "seen" | "dismissed" | "clicked"
 }
 ```
+
+### `SetupCampaignRequest`
+
+Discriminated by `type`. Each campaign variant has its own request shape;
+new variants are added by introducing a new schema and extending the `oneOf` list.
+
+
+```ts
+type SetupCampaignRequest = {
+  type: "tariff_change"
+  product_recommendation: {
+    name?: string
+    source_product_id?: string // uuid
+    source_price_id?: string // uuid
+    offers?: Array<{
+      target_id?: { ... }
+      items: { ... }
+    }>
+  }
+  campaign: {
+    name: string
+    goal?: string
+    target_ids: string // uuid[]
+  }
+  journey?: {
+    journey_id: string // uuid
+  }
+  channels?: {
+    portal_widget?: {
+      portal_id: { ... }
+      block_id: { ... }
+    }
+    email?: {
+      automation_id: { ... }
+    }
+  }
+}
+```
+
+### `SetupTariffChangeCampaignRequest`
+
+```ts
+type SetupTariffChangeCampaignRequest = {
+  type: "tariff_change"
+  product_recommendation: {
+    name?: string
+    source_product_id?: string // uuid
+    source_price_id?: string // uuid
+    offers?: Array<{
+      target_id?: { ... }
+      items: { ... }
+    }>
+  }
+  campaign: {
+    name: string
+    goal?: string
+    target_ids: string // uuid[]
+  }
+  journey?: {
+    journey_id: string // uuid
+  }
+  channels?: {
+    portal_widget?: {
+      portal_id: { ... }
+      block_id: { ... }
+    }
+    email?: {
+      automation_id: { ... }
+    }
+  }
+}
+```
+
+### `SetupTariffChangeCampaignResponse`
+
+```ts
+type SetupTariffChangeCampaignResponse = {
+  type: "tariff_change"
+  product_recommendation_id: string // uuid
+  campaign_id: string // uuid
+  journey_id?: string // uuid
+  portal_widget_id?: string // uuid
+}
+```

package/docs/webhooks.md

@@ -475,7 +475,8 @@ const { data } = await client.getEventById({
   },
   "status": "succeeded",
   "http_method": "GET",
-  "payload": "string"
+  "payload": "string",
+  "retry_attempt": 0
 }
 ```
 
@@ -605,7 +606,8 @@ const { data } = await client.getWebhookEventsV2(
       },
       "status": "succeeded",
       "http_method": "GET",
-      "payload": "string"
+      "payload": "string",
+      "retry_attempt": 0
     }
   ],
   "next_cursor": {
@@ -683,6 +685,7 @@ type EventListResponse = {
     status?: "succeeded" | "failed" | "in_progress" | "skipped"
     http_method?: "GET" | "POST" | "PUT"
     payload?: string
+    retry_attempt?: number
   }>
   next_cursor?: {
     created_at?: string // date-time
@@ -826,6 +829,7 @@ type WebhookConfig = {
   id?: string
   name: string
   eventName: string
+  eventVersion?: string
   url?: string
   creationTime?: string
   updatedTime?: string
@@ -879,6 +883,10 @@ type WebhookConfig = {
     fileSource?: string
     extraFields?: Record<string, string>
   }
+  retryPolicy?: {
+    enabled: boolean
+    maxAttempts?: number
+  }
   filterConditions?: {
     conditions?: Array<{
       field: { ... }
@@ -1045,6 +1053,7 @@ type WebhookEvent = {
   status?: "succeeded" | "failed" | "in_progress" | "skipped"
   http_method?: "GET" | "POST" | "PUT"
   payload?: string
+  retry_attempt?: number
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.8.0-rc.0",
+  "version": "2.8.1",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -165,12 +165,6 @@
       "require": "./dist/apis/file.cjs"
     },
     "./file/openapi.json": "./definitions/file.json",
-    "./focus-pocus": {
-      "types": "./dist/apis/focus-pocus.d.ts",
-      "import": "./dist/apis/focus-pocus.js",
-      "require": "./dist/apis/focus-pocus.cjs"
-    },
-    "./focus-pocus/openapi.json": "./definitions/focus-pocus.json",
     "./iban": {
       "types": "./dist/apis/iban.d.ts",
       "import": "./dist/apis/iban.js",
@@ -322,16 +316,6 @@
     },
     "./workflow-definition/openapi.json": "./definitions/workflow-definition.json"
   },
-  "scripts": {
-    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "biome check src",
-    "lint:fix": "biome check src --fix",
-    "prepublishOnly": "npm run build"
-  },
   "keywords": [
     "epilot",
     "sdk",
@@ -446,9 +430,6 @@
       "file": [
         "./dist/apis/file.d.ts"
       ],
-      "focus-pocus": [
-        "./dist/apis/focus-pocus.d.ts"
-      ],
       "iban": [
         "./dist/apis/iban.d.ts"
       ],
@@ -525,5 +506,14 @@
         "./dist/apis/workflow-definition.d.ts"
       ]
     }
+  },
+  "scripts": {
+    "generate": "tsx ../../scripts/generate-sdk-v2.ts && pnpm lint:fix",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "biome check src",
+    "lint:fix": "biome check src --fix"
   }
-}
+}

package/definitions/focus-pocus-runtime.json

@@ -1 +0,0 @@
-{"s":"https://focus-pocus.dev.sls.epilot.io","o":[["getHealth","get","/v1/health"],["listAchievements","get","/v1/achievements"],["getAchievement","get","/v1/achievements/{id}",[["AchievementOrChallengeId"]]],["getSuggestedChallenge","get","/v1/challenges/suggest",[["route","q"],["entity_type","q"],["category_hint","q"]]],["acceptChallenge","post","/v1/challenges/{id}/accept",[["ChallengeId"]]],["dismissChallenge","post","/v1/challenges/{id}/dismiss",[["ChallengeId"]]],["listActiveChallenges","get","/v1/challenges/active"],["postEvent","post","/v1/events",null,1]],"v":"3.0.3","cp":{"AchievementId":["id","p",true],"AchievementOrChallengeId":["id","p",true],"ChallengeId":["id","p",true],"Cursor":["cursor","q"],"Size":["size","q"]}}