@epilot/sdk 2.7.1 → 2.8.0-rc.0

package/docs/data-governance.md

@@ -125,7 +125,7 @@ const { data } = await client.createJob(
   {
     type: 'deletion',
     config_id: 'string',
-    scheduled_for: '1970-01-01',
+    scheduled_for: 'string',
     status: 'in_progress',
     started_at: '1970-01-01T00:00:00.000Z'
   },
@@ -141,7 +141,7 @@ const { data } = await client.createJob(
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -198,7 +198,7 @@ const { data } = await client.updateJob(
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -241,7 +241,7 @@ const { data } = await client.getJob({
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -325,13 +325,13 @@ const { data } = await client.getConfig({
   "schedule": {
     "frequency": "interval",
     "interval_days": 1,
-    "start_date": "1970-01-01",
-    "end_date": "1970-01-01"
+    "start_date": "string",
+    "end_date": "string"
   },
   "enabled": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "last_updated_at": "1970-01-01T00:00:00.000Z",
-  "next_run_at": "1970-01-01",
+  "next_run_at": "string",
   "relations_for_deletion": ["contact"],
   "last_run_at": "1970-01-01T00:00:00.000Z"
 }
@@ -362,7 +362,7 @@ const { data } = await client.createJobForConfig({
   "type": "deletion",
   "config_id": "string",
   "entity_schema": "string",
-  "scheduled_for": "1970-01-01",
+  "scheduled_for": "string",
   "status": "in_progress",
   "details": {},
   "started_at": "1970-01-01T00:00:00.000Z",
@@ -413,8 +413,8 @@ const { data } = await client.upsertConfig(
     schedule: {
       frequency: 'interval',
       interval_days: 1,
-      start_date: '1970-01-01',
-      end_date: '1970-01-01'
+      start_date: 'string',
+      end_date: 'string'
     },
     relations_for_deletion: ['contact'],
     enabled: true
@@ -446,13 +446,13 @@ const { data } = await client.upsertConfig(
   "schedule": {
     "frequency": "interval",
     "interval_days": 1,
-    "start_date": "1970-01-01",
-    "end_date": "1970-01-01"
+    "start_date": "string",
+    "end_date": "string"
   },
   "enabled": true,
   "created_at": "1970-01-01T00:00:00.000Z",
   "last_updated_at": "1970-01-01T00:00:00.000Z",
-  "next_run_at": "1970-01-01",
+  "next_run_at": "string",
   "relations_for_deletion": ["contact"],
   "last_run_at": "1970-01-01T00:00:00.000Z"
 }
@@ -505,13 +505,13 @@ const { data } = await client.listConfigs({
       "schedule": {
         "frequency": "interval",
         "interval_days": 1,
-        "start_date": "1970-01-01",
-        "end_date": "1970-01-01"
+        "start_date": "string",
+        "end_date": "string"
       },
       "enabled": true,
       "created_at": "1970-01-01T00:00:00.000Z",
       "last_updated_at": "1970-01-01T00:00:00.000Z",
-      "next_run_at": "1970-01-01",
+      "next_run_at": "string",
       "relations_for_deletion": ["contact"],
       "last_run_at": "1970-01-01T00:00:00.000Z"
     }
@@ -552,7 +552,7 @@ const { data } = await client.listJobs({
       "type": "deletion",
       "config_id": "string",
       "entity_schema": "string",
-      "scheduled_for": "1970-01-01",
+      "scheduled_for": "string",
       "status": "in_progress",
       "details": {},
       "started_at": "1970-01-01T00:00:00.000Z",

package/docs/design.md

@@ -1,6 +1,6 @@
 # Design Builder API v2
 
-- **Base URL:** `https://design-builder-api.{environment}.epilot.io`
+- **Base URL:** `https://design-builder-api.sls.epilot.io`
 - **Full API Docs:** [https://docs.epilot.io/api/design](https://docs.epilot.io/api/design)
 
 ## Usage

package/docs/focus-pocus.md

@@ -0,0 +1,460 @@
+# Focus Pocus API
+
+- **Base URL:** `https://focus-pocus.dev.sls.epilot.io`
+- **Full API Docs:** [https://docs.epilot.io/api/focus-pocus](https://docs.epilot.io/api/focus-pocus)
+
+## Usage
+
+```ts
+import { epilot } from '@epilot/sdk'
+
+epilot.authorize(() => '<token>')
+const { data } = await epilot.focusPocus.getHealth(...)
+```
+
+### Tree-shakeable import
+
+```ts
+import { getClient, authorize } from '@epilot/sdk/focus-pocus'
+
+const focusPocusClient = getClient()
+authorize(focusPocusClient, () => '<token>')
+const { data } = await focusPocusClient.getHealth(...)
+```
+
+## Operations
+
+**Health**
+- [`getHealth`](#gethealth)
+
+**Achievements**
+- [`listAchievements`](#listachievements)
+- [`getAchievement`](#getachievement)
+
+**Challenges**
+- [`getSuggestedChallenge`](#getsuggestedchallenge)
+- [`acceptChallenge`](#acceptchallenge)
+- [`dismissChallenge`](#dismisschallenge)
+- [`listActiveChallenges`](#listactivechallenges)
+
+**Events**
+- [`postEvent`](#postevent)
+
+**Schemas**
+- [`HealthResponse`](#healthresponse)
+- [`ErrorResponse`](#errorresponse)
+- [`ConflictError`](#conflicterror)
+- [`ChallengeSuggested`](#challengesuggested)
+- [`ChallengeActive`](#challengeactive)
+- [`ActiveChallengeListResponse`](#activechallengelistresponse)
+- [`AchievementFeedItem`](#achievementfeeditem)
+- [`AchievementFeedListResponse`](#achievementfeedlistresponse)
+- [`EventIngestRequest`](#eventingestrequest)
+- [`EventAccepted`](#eventaccepted)
+
+### `getHealth`
+
+Liveness probe for the Focus Pocus API. Requires a valid EpilotAuth token.
+
+`GET /v1/health`
+
+```ts
+const { data } = await client.getHealth()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "status": "ok",
+  "stage": "dev",
+  "service": "focus-pocus-api"
+}
+```
+
+</details>
+
+---
+
+### `listAchievements`
+
+Unified feed for the authenticated user: returns active challenges and completed
+v1 static achievement unlocks. The `userId` is read from the EpilotAuth claim —
+no user path or query parameter is acce
+
+`GET /v1/achievements`
+
+```ts
+const { data } = await client.listAchievements()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "id": "string",
+      "challenge_template_id": "string",
+      "category": "string",
+      "title": "string",
+      "description": "string",
+      "badge_image_url": "string",
+      "icon": "string",
+      "status": "active",
+      "accepted_at": "1970-01-01T00:00:00.000Z",
+      "deadline": "1970-01-01T00:00:00.000Z",
+      "time_remaining_ms": 0,
+      "unlocked_at": "1970-01-01T00:00:00.000Z",
+      "xp_awarded": 0,
+      "just_unlocked": true
+    }
+  ],
+  "total": 0
+}
+```
+
+</details>
+
+---
+
+### `getAchievement`
+
+Single user-scoped achievement or active-challenge item. Returns 404 if the id
+does not belong to the authenticated user.
+
+`GET /v1/achievements/{id}`
+
+```ts
+const { data } = await client.getAchievement({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "string",
+  "challenge_template_id": "string",
+  "category": "string",
+  "title": "string",
+  "description": "string",
+  "badge_image_url": "string",
+  "icon": "string",
+  "status": "active",
+  "accepted_at": "1970-01-01T00:00:00.000Z",
+  "deadline": "1970-01-01T00:00:00.000Z",
+  "time_remaining_ms": 0,
+  "unlocked_at": "1970-01-01T00:00:00.000Z",
+  "xp_awarded": 0,
+  "just_unlocked": true
+}
+```
+
+</details>
+
+---
+
+### `getSuggestedChallenge`
+
+Returns a suggested challenge for the authenticated user. The suggestion is
+persisted with a 7-day TTL. Calling again with the same `(user, category)`
+within 24h returns the existing suggestion withou
+
+`GET /v1/challenges/suggest`
+
+```ts
+const { data } = await client.getSuggestedChallenge({
+  route: 'example',
+  entity_type: 'example',
+  category_hint: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "string",
+  "challenge_template_id": "string",
+  "category": "string",
+  "title": "string",
+  "description": "string",
+  "badge_image_url": "string",
+  "default_duration_hours": 1,
+  "status": "suggested",
+  "suggested_at": "1970-01-01T00:00:00.000Z"
+}
+```
+
+</details>
+
+---
+
+### `acceptChallenge`
+
+Accept a suggested challenge. Atomically transitions the challenge from
+`suggested` to `active` using a conditional DynamoDB UpdateItem. Returns 409 if
+the challenge has already been transitioned or t
+
+`POST /v1/challenges/{id}/accept`
+
+```ts
+const { data } = await client.acceptChallenge({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "id": "string",
+  "challenge_template_id": "string",
+  "category": "string",
+  "title": "string",
+  "description": "string",
+  "badge_image_url": "string",
+  "status": "active",
+  "accepted_at": "1970-01-01T00:00:00.000Z",
+  "deadline": "1970-01-01T00:00:00.000Z",
+  "time_remaining_ms": 0
+}
+```
+
+</details>
+
+---
+
+### `dismissChallenge`
+
+Dismiss a suggested challenge. Atomically transitions the challenge from
+`suggested` to `dismissed`. The challenge template is filtered from `/suggest`
+responses for the next 24h. Returns 409 if the c
+
+`POST /v1/challenges/{id}/dismiss`
+
+```ts
+const { data } = await client.dismissChallenge({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+})
+```
+
+---
+
+### `listActiveChallenges`
+
+Returns all active challenges for the authenticated user. Challenges whose
+deadline has passed are lazily expired (fire-and-forget UpdateItem) and
+excluded from the response. The result set is bounded
+
+`GET /v1/challenges/active`
+
+```ts
+const { data } = await client.listActiveChallenges()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "id": "string",
+      "challenge_template_id": "string",
+      "category": "string",
+      "title": "string",
+      "description": "string",
+      "badge_image_url": "string",
+      "status": "active",
+      "accepted_at": "1970-01-01T00:00:00.000Z",
+      "deadline": "1970-01-01T00:00:00.000Z",
+      "time_remaining_ms": 0
+    }
+  ],
+  "total": 0
+}
+```
+
+</details>
+
+---
+
+### `postEvent`
+
+Persist-first event ingest. Accepts an activity event, writes it to the event log
+idempotently (keyed by `event_id`), and returns 202. Achievement evaluation happens
+asynchronously — no unlocks are re
+
+`POST /v1/events`
+
+```ts
+const { data } = await client.postEvent(
+  null,
+  {
+    event_id: 'string',
+    event_type: 'string',
+    actor_user_id: 'string',
+    occurred_at: '1970-01-01T00:00:00.000Z',
+    properties: {}
+  },
+)
+```
+
+---
+
+## Schemas
+
+### `HealthResponse`
+
+```ts
+type HealthResponse = {
+  status: "ok"
+  stage: string
+  service: string
+}
+```
+
+### `ErrorResponse`
+
+```ts
+type ErrorResponse = {
+  status: number
+  error: string
+}
+```
+
+### `ConflictError`
+
+```ts
+type ConflictError = {
+  status: 409
+  error: string
+  reason: "already_transitioned" | "too_many_active" | "deadline_passed"
+}
+```
+
+### `ChallengeSuggested`
+
+```ts
+type ChallengeSuggested = {
+  id: string
+  challenge_template_id: string
+  category: string
+  title: string
+  description: string
+  badge_image_url: string
+  default_duration_hours: number
+  status: "suggested"
+  suggested_at: string // date-time
+}
+```
+
+### `ChallengeActive`
+
+```ts
+type ChallengeActive = {
+  id: string
+  challenge_template_id: string
+  category: string
+  title: string
+  description: string
+  badge_image_url: string
+  status: "active"
+  accepted_at: string // date-time
+  deadline: string // date-time
+  time_remaining_ms: number
+}
+```
+
+### `ActiveChallengeListResponse`
+
+```ts
+type ActiveChallengeListResponse = {
+  results: Array<{
+    id: string
+    challenge_template_id: string
+    category: string
+    title: string
+    description: string
+    badge_image_url: string
+    status: "active"
+    accepted_at: string // date-time
+    deadline: string // date-time
+    time_remaining_ms: number
+  }>
+  total: number
+}
+```
+
+### `AchievementFeedItem`
+
+```ts
+type AchievementFeedItem = {
+  id: string
+  challenge_template_id?: string
+  category: string
+  title: string
+  description: string
+  badge_image_url?: string
+  icon?: string
+  status: "active" | "completed" | "expired"
+  accepted_at?: string // date-time
+  deadline?: string // date-time
+  time_remaining_ms?: number
+  unlocked_at?: string // date-time
+  xp_awarded?: number
+  just_unlocked: boolean
+}
+```
+
+### `AchievementFeedListResponse`
+
+```ts
+type AchievementFeedListResponse = {
+  results: Array<{
+    id: string
+    challenge_template_id?: string
+    category: string
+    title: string
+    description: string
+    badge_image_url?: string
+    icon?: string
+    status: "active" | "completed" | "expired"
+    accepted_at?: string // date-time
+    deadline?: string // date-time
+    time_remaining_ms?: number
+    unlocked_at?: string // date-time
+    xp_awarded?: number
+    just_unlocked: boolean
+  }>
+  total: number
+}
+```
+
+### `EventIngestRequest`
+
+```ts
+type EventIngestRequest = {
+  event_id: string
+  event_type: string
+  actor_user_id: string
+  occurred_at: string // date-time
+  properties?: Record<string, unknown>
+}
+```
+
+### `EventAccepted`
+
+```ts
+type EventAccepted = {
+  accepted: true
+}
+```

package/docs/journey.md

@@ -100,6 +100,7 @@ Get journey by id. Private journeys requires valid private token to be passed
 ```ts
 const { data } = await client.getJourney({
   id: '123e4567-e89b-12d3-a456-426614174000',
+  version: 1,
   source: 'example',
   orgId: 'example',
 })
@@ -1432,6 +1433,7 @@ Get journey by id
 ```ts
 const { data } = await client.getJourneyV2({
   id: '123e4567-e89b-12d3-a456-426614174000',
+  version: 1,
 })
 ```
 

package/docs/pricing.md

@@ -1368,7 +1368,7 @@ const { data } = await client.$computePrice(
     consumption_NT: 0,
     association_id: 'string',
     billing_period: 'monthly',
-    reference_date: '1970-01-01',
+    reference_date: 'string',
     type: 'power',
     meter_type: 'classic'
   },

package/docs/targeting.md

@@ -116,8 +116,8 @@ const { data } = await client.changeCampaignStatus({
     "name": "string",
     "goal": "string",
     "status": "draft",
-    "start_date": "1970-01-01",
-    "end_date": "1970-01-01",
+    "start_date": "string",
+    "end_date": "string",
     "flow_id": "string",
     "job_id": "string",
     "target": {
@@ -296,8 +296,8 @@ const { data } = await client.matchCampaigns(
         "name": "string",
         "goal": "string",
         "status": "draft",
-        "start_date": "1970-01-01",
-        "end_date": "1970-01-01",
+        "start_date": "string",
+        "end_date": "string",
         "flow_id": "string",
         "job_id": "string",
         "target": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.7.1",
+  "version": "2.8.0-rc.0",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -165,6 +165,12 @@
       "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",
@@ -440,6 +446,9 @@
       "file": [
         "./dist/apis/file.d.ts"
       ],
+      "focus-pocus": [
+        "./dist/apis/focus-pocus.d.ts"
+      ],
       "iban": [
         "./dist/apis/iban.d.ts"
       ],