@amigo-ai/platform-sdk 0.4.0 → 0.4.2

package/dist/types/resources/services.d.ts

@@ -37,13 +37,13 @@ export declare class ServicesResource extends WorkspaceScopedResource {
         };
         voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     list(params?: ListServicesParams): Promise<{
         continuation_token?: number | null;
         has_more: boolean;
         items: components["schemas"]["ServiceResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     get(serviceId: ServiceId | string): Promise<{
         agent_id: string;
         agent_name?: string | null;
@@ -69,7 +69,7 @@ export declare class ServicesResource extends WorkspaceScopedResource {
         };
         voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     update(serviceId: ServiceId | string, body: components['schemas']['UpdateServiceRequest']): Promise<{
         agent_id: string;
         agent_name?: string | null;
@@ -95,7 +95,7 @@ export declare class ServicesResource extends WorkspaceScopedResource {
         };
         voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     delete(serviceId: ServiceId | string): Promise<void>;
 }
 //# sourceMappingURL=services.d.ts.map

package/dist/types/resources/settings.d.ts

@@ -20,7 +20,7 @@ export declare class SettingsResource extends WorkspaceScopedResource {
             transcript_correction_enabled: boolean;
             voice_id: string | null;
             volume: number | null;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["VoiceSettingsRequest"]) => Promise<{
             correction_categories: string[];
             keyterms: string[];
@@ -33,43 +33,43 @@ export declare class SettingsResource extends WorkspaceScopedResource {
             transcript_correction_enabled: boolean;
             voice_id: string | null;
             volume: number | null;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly branding: {
         get: () => Promise<{
             branding: components["schemas"]["BrandingConfig"];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["BrandingSettingsRequest"]) => Promise<{
             branding: components["schemas"]["BrandingConfig"];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly outreach: {
         get: () => Promise<{
             data_templates: components["schemas"]["DataTemplate-Output"][];
             rules: components["schemas"]["OutreachRule"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["OutreachSettingsRequest"]) => Promise<{
             data_templates: components["schemas"]["DataTemplate-Output"][];
             rules: components["schemas"]["OutreachRule"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly memory: {
         get: () => Promise<{
             backfill_requested: boolean;
             dimensions: components["schemas"]["MemoryDimension"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["MemorySettingsRequest"]) => Promise<{
             backfill_requested: boolean;
             dimensions: components["schemas"]["MemoryDimension"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly security: {
         get: () => Promise<{
             voice_auth_enabled?: boolean;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["SecuritySettingsRequest"]) => Promise<{
             voice_auth_enabled?: boolean;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly retention: {
         get: () => Promise<{
@@ -80,7 +80,7 @@ export declare class SettingsResource extends WorkspaceScopedResource {
             legal_hold_reason?: string | null;
             phi_data_days: number;
             world_events_days: number;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["RetentionPolicyRequest"]) => Promise<{
             audit_log_days: number;
             call_recordings_days: number;
@@ -89,15 +89,15 @@ export declare class SettingsResource extends WorkspaceScopedResource {
             legal_hold_reason?: string | null;
             phi_data_days: number;
             world_events_days: number;
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
     readonly workflows: {
         get: () => Promise<{
             workflows?: components["schemas"]["WorkflowSpec-Output"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
         update: (body: components["schemas"]["WorkflowSettingsRequest"]) => Promise<{
             workflows?: components["schemas"]["WorkflowSpec-Output"][];
-        }>;
+        } & import("../index.js").ResponseMetadata>;
     };
 }
 //# sourceMappingURL=settings.d.ts.map

package/dist/types/resources/simulations.d.ts

@@ -15,7 +15,7 @@ export declare class SimulationsResource extends WorkspaceScopedResource {
         is_terminal: boolean;
         session_id: string;
         snapshot: components["schemas"]["SimulationSnapshotResponse"];
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get the current snapshot of a session */
     getSession(sessionId: SimulationSessionId | string): Promise<{
         context_graph_topology?: {
@@ -37,11 +37,11 @@ export declare class SimulationsResource extends WorkspaceScopedResource {
         turn_policy?: components["schemas"]["SimulationTurnPolicyResponse"];
     } & {
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Delete a simulation session */
     deleteSession(sessionId: SimulationSessionId | string): Promise<{
         [key: string]: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /**
      * Send a caller utterance and advance the session by one turn.
      * Returns the agent's response observation and updated snapshot.
@@ -49,20 +49,20 @@ export declare class SimulationsResource extends WorkspaceScopedResource {
     step(body: components['schemas']['StepRequest']): Promise<{
         observation: components["schemas"]["SimulationObservation"];
         snapshot: components["schemas"]["SimulationSnapshotResponse"];
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /**
      * Get LLM-generated caller message suggestions for the current session state.
      * Helps exploratory testing by suggesting realistic next caller turns.
      */
     recommend(body: components['schemas']['RecommendRequest']): Promise<{
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get AI-generated call intelligence for a completed session */
     getIntelligence(sessionId: SimulationSessionId | string): Promise<{
         intelligence: {
             [key: string]: unknown;
         };
         session_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=simulations.d.ts.map

package/dist/types/resources/skills.d.ts

@@ -50,14 +50,14 @@ export declare class SkillsResource extends WorkspaceScopedResource {
         use_structured_output: boolean;
         version: number;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** List skills in the workspace */
     list(params?: ListSkillsParams): Promise<{
         continuation_token?: number | null;
         has_more: boolean;
         items: components["schemas"]["SkillResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get a single skill */
     get(skillId: SkillId | string): Promise<{
         approval_required: boolean;
@@ -96,7 +96,7 @@ export declare class SkillsResource extends WorkspaceScopedResource {
         use_structured_output: boolean;
         version: number;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Update a skill */
     update(skillId: SkillId | string, body: components['schemas']['UpdateSkillRequest']): Promise<{
         approval_required: boolean;
@@ -135,7 +135,7 @@ export declare class SkillsResource extends WorkspaceScopedResource {
         use_structured_output: boolean;
         version: number;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Delete a skill */
     delete(skillId: SkillId | string): Promise<void>;
     /**
@@ -151,6 +151,6 @@ export declare class SkillsResource extends WorkspaceScopedResource {
         result: string;
         rounds: number;
         sub_tool_logs: components["schemas"]["SubToolLog"][];
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=skills.d.ts.map

package/dist/types/resources/triggers.d.ts

@@ -7,7 +7,7 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         has_more: boolean;
         items: components["schemas"]["TriggerResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     create(body: components['schemas']['CreateTriggerRequest']): Promise<{
         action_id: string;
         created_at: string;
@@ -28,7 +28,7 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         timezone: string;
         updated_at: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     get(triggerId: string): Promise<{
         action_id: string;
         created_at: string;
@@ -49,7 +49,7 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         timezone: string;
         updated_at: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     update(triggerId: string, body: components['schemas']['UpdateTriggerRequest']): Promise<{
         action_id: string;
         created_at: string;
@@ -70,13 +70,13 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         timezone: string;
         updated_at: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     delete(triggerId: string): Promise<void>;
     fire(triggerId: string): Promise<{
         fired_event_id: string;
         status?: "fired";
         trigger_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     pause(triggerId: string): Promise<{
         action_id: string;
         created_at: string;
@@ -97,7 +97,7 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         timezone: string;
         updated_at: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     resume(triggerId: string): Promise<{
         action_id: string;
         created_at: string;
@@ -118,12 +118,12 @@ export declare class TriggersResource extends WorkspaceScopedResource {
         timezone: string;
         updated_at: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     listRuns(triggerId: string, params?: ListParams): Promise<{
         continuation_token?: number | null;
         has_more: boolean;
         items: components["schemas"]["TriggerRunResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=triggers.d.ts.map

package/dist/types/resources/webhook-destinations.d.ts

@@ -7,7 +7,7 @@ export declare class WebhookDestinationsResource extends WorkspaceScopedResource
         has_more: boolean;
         items: components["schemas"]["WebhookDestinationResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     create(body: components['schemas']['CreateWebhookDestinationRequest']): Promise<{
         accepted_event_types: string[];
         created_at: string;
@@ -25,7 +25,7 @@ export declare class WebhookDestinationsResource extends WorkspaceScopedResource
         updated_at: string;
         url: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     get(destinationId: string): Promise<{
         accepted_event_types: string[];
         created_at: string;
@@ -42,7 +42,7 @@ export declare class WebhookDestinationsResource extends WorkspaceScopedResource
         updated_at: string;
         url: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     update(destinationId: string, body: components['schemas']['UpdateWebhookDestinationRequest']): Promise<{
         accepted_event_types: string[];
         created_at: string;
@@ -59,17 +59,17 @@ export declare class WebhookDestinationsResource extends WorkspaceScopedResource
         updated_at: string;
         url: string;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     delete(destinationId: string): Promise<void>;
     listDeliveries(destinationId: string, params?: ListParams): Promise<{
         continuation_token?: number | null;
         has_more: boolean;
         items: components["schemas"]["DeliveryResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     rotateSecret(destinationId: string): Promise<{
         rotation_expires_at: string;
         secret: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=webhook-destinations.d.ts.map

package/dist/types/resources/workspaces.d.ts

@@ -22,14 +22,14 @@ export declare class WorkspacesResource extends WorkspaceScopedResource {
         region: string;
         slug: string;
         updated_at: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** List workspaces accessible to the current API key */
     list(params?: ListParams): Promise<{
         continuation_token?: number | null;
         has_more: boolean;
         items: components["schemas"]["WorkspaceResponse"][];
         total?: number | null;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get a single workspace by ID */
     get(id?: WorkspaceId | string): Promise<{
         backend_org_id: string | null;
@@ -42,7 +42,7 @@ export declare class WorkspacesResource extends WorkspaceScopedResource {
         region: string;
         slug: string;
         updated_at: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Update workspace metadata */
     update(body: components['schemas']['UpdateWorkspaceRequest'], id?: WorkspaceId | string): Promise<{
         backend_org_id: string | null;
@@ -55,7 +55,7 @@ export declare class WorkspacesResource extends WorkspaceScopedResource {
         region: string;
         slug: string;
         updated_at: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Archive (soft-delete) a workspace */
     archive(body: components['schemas']['ArchiveWorkspaceRequest'], id?: WorkspaceId | string): Promise<{
         backend_org_id: string | null;
@@ -68,6 +68,6 @@ export declare class WorkspacesResource extends WorkspaceScopedResource {
         region: string;
         slug: string;
         updated_at: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=workspaces.d.ts.map

package/dist/types/resources/world.d.ts

@@ -24,7 +24,7 @@ export declare class WorldResource extends WorkspaceScopedResource {
         has_more: boolean;
         next_offset?: number | null;
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get a single entity */
     getEntity(entityId: EntityId | string): Promise<{
         appointment_end?: string | null;
@@ -65,43 +65,43 @@ export declare class WorldResource extends WorkspaceScopedResource {
         tags?: string[] | null;
         updated_at?: string | null;
         workspace_id: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get all relationships for an entity */
     getRelationships(entityId: EntityId | string): Promise<{
         entity_id: string;
         relationships: import("../index.js").components["schemas"]["EntityRelationshipResponse"][];
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get the knowledge graph centered on an entity (entity + neighbors + edges) */
     getGraph(entityId: EntityId | string): Promise<{
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get provenance — which source systems contributed data for an entity */
     getProvenance(entityId: EntityId | string): Promise<{
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get lineage — merge history and canonical identity for an entity */
     getLineage(entityId: EntityId | string): Promise<{
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get merged entities for a canonical entity */
     getMerged(entityId: EntityId | string): Promise<{
         entity_id: string;
         linked_entities: import("../index.js").components["schemas"]["EntityResponse"][];
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** List registered entity types with counts and schemas */
     listEntityTypes(): Promise<{
         entity_types: import("../index.js").components["schemas"]["EntityTypeSummary"][];
         total_entities: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** List potential duplicate entity pairs for review or merging */
     listDuplicates(params?: {
         entity_type?: string | null;
         confidence_max?: number;
     }): Promise<{
         [key: string]: unknown;
-    }[]>;
+    }[] & import("../index.js").ResponseMetadata>;
     /** Semantic (vector) search over entities */
     search(params: {
         q: string;
@@ -112,7 +112,7 @@ export declare class WorldResource extends WorkspaceScopedResource {
         offset?: number;
     }): Promise<{
         [key: string]: unknown;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get the event timeline for an entity (reverse-chronological) */
     getTimeline(entityId: EntityId | string, params?: {
         domain?: string | null;
@@ -124,11 +124,11 @@ export declare class WorldResource extends WorkspaceScopedResource {
         has_more: boolean;
         next_offset?: number | null;
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get sync status grouped by sink (Lakebase, Delta, etc.) */
     getSyncStatusBySink(): Promise<{
         sinks: import("../index.js").components["schemas"]["SinkSyncStatus"][];
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** List sync events with status filtering */
     listSyncEvents(params: {
         status: 'pending' | 'failed';
@@ -143,7 +143,7 @@ export declare class WorldResource extends WorkspaceScopedResource {
         has_more: boolean;
         next_offset?: number | null;
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get current sync queue depth */
     getSyncQueueDepth(): Promise<{
         by_resource_type?: {
@@ -155,17 +155,17 @@ export declare class WorldResource extends WorkspaceScopedResource {
         last_sync_success_at?: string | null;
         oldest_pending_at?: string | null;
         pending_count: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Retry a single failed sync event */
     retrySyncEvent(eventId: string): Promise<{
         event_id: string;
         status: string;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Retry all failed sync events */
     retryAllSyncEvents(): Promise<{
         failed_to_publish: number;
         retried: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get aggregate entity and event statistics */
     getStats(): Promise<{
         by_event_type?: {
@@ -176,11 +176,11 @@ export declare class WorldResource extends WorkspaceScopedResource {
         sync_synced: number;
         total_entities: number;
         total_events: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
     /** Get entity counts broken down by source system */
     getSourceBreakdown(): Promise<{
         breakdown: import("../index.js").components["schemas"]["SourceBreakdownItem"][];
         total: number;
-    }>;
+    } & import("../index.js").ResponseMetadata>;
 }
 //# sourceMappingURL=world.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amigo-ai/platform-sdk",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Official TypeScript SDK for the Amigo Platform API",
   "publishConfig": {
     "access": "public"
@@ -37,6 +37,7 @@
   "types": "./dist/types/index.d.ts",
   "files": [
     "dist/",
+    "api.md",
     "README.md",
     "LICENSE"
   ],
@@ -46,8 +47,8 @@
     "openapi:sync": "node scripts/sync-openapi.mjs",
     "build": "npm run clean && npm run gen-types && npm run esbuild && tsc --project tsconfig.build.json",
     "esbuild": "node scripts/build.mjs",
-    "lint": "eslint 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}' 'scripts/**/*.{js,mjs}' --max-warnings 0",
-    "lint:fix": "eslint 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}' 'scripts/**/*.{js,mjs}' --fix",
+    "lint": "eslint 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}' 'examples/**/*.ts' 'scripts/**/*.{js,mjs}' --max-warnings 0",
+    "lint:fix": "eslint 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}' 'examples/**/*.ts' 'scripts/**/*.{js,mjs}' --fix",
     "format": "prettier --check .",
     "format:write": "prettier --write .",
     "test": "vitest run --project unit",
@@ -57,7 +58,8 @@
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage --project unit",
     "typecheck": "tsc --noEmit",
-    "prepublishOnly": "npm run build && npm test && npm run test:dist && npm run typecheck"
+    "typecheck:examples": "tsc --project examples/tsconfig.json --noEmit",
+    "prepublishOnly": "npm run build && npm test && npm run test:dist && npm run typecheck && npm run typecheck:examples"
   },
   "sideEffects": false,
   "dependencies": {
@@ -90,6 +92,10 @@
       "eslint --fix --max-warnings 0",
       "prettier --write"
     ],
+    "examples/**/*.ts": [
+      "eslint --fix --max-warnings 0",
+      "prettier --write"
+    ],
     "scripts/**/*.{js,mjs}": [
       "eslint --fix --max-warnings 0",
       "prettier --write"