@toothfairyai/sdk 0.6.3 → 0.6.4

package/README.md

@@ -2,6 +2,40 @@
 
 Official TypeScript SDK for the ToothFairyAI API - A comprehensive toolkit for building AI-powered applications with chat, document processing, agent management, and more.
 
+**Status**: Production Ready | **Version**: 0.6.4
+
+## Test Results
+
+The SDK includes comprehensive verification tests ensuring all managers and methods are properly implemented:
+
+```
+Test Suites: 1 passed, 1 total
+Tests:       62 passed, 62 total
+
+✓ SDK Structure (3 tests)
+  - Client initialization with proper parameters
+  - All 24 managers accessible
+  - Expected methods on each manager
+
+✓ Method Signatures (17 tests)
+  - Agent, Chat, Document, Entity, Streaming, Billing managers
+
+✓ Error Handling (5 tests)
+  - Missing API key/workspace ID validation
+  - ToothFairyError properties and inheritance
+
+✓ SDK Completeness (27 tests)
+  - Core files present
+  - All 24 manager directories with manager files
+  - Proper export structure
+
+✓ Type Definitions (4 tests)
+  - AgentMode, EntityType, DocumentType, StreamEventType
+
+✓ Client Methods (6 tests)
+  - testConnection, getHealth, getStreamingUrl, getWorkspaceId, getConfig, request, aiRequest
+```
+
 ## Installation
 
 ```bash
@@ -697,26 +731,33 @@ const cloned = await client.prompts.clone('prompt-id', 'user-123', {
 #### Create an Agent Function
 
 ```typescript
-const func = await client.agentFunctions.create({
-  id: 'function-1',
-  name: 'Weather API',
+// Create a GET function
+const getFunc = await client.agentFunctions.create('Weather API', {
+  description: 'Get current weather data for a location',
   url: 'https://api.weather.com/current',
-  model: 'gpt-4',
   requestType: 'GET',
   authorisationType: 'bearer',
   authorisationKey: 'your-token',
-  description: 'Get current weather data',
   parameters: [
     { name: 'location', type: 'string', required: true }
   ]
 });
+
+// Create a POST function with headers
+const postFunc = await client.agentFunctions.create('Create Order', {
+  description: 'Create a new order in the system',
+  url: 'https://api.example.com/orders',
+  requestType: 'POST',
+  authorisationType: 'apikey',
+  headers: [{ key: 'Content-Type', value: 'application/json' }],
+  staticArgs: [{ key: 'source', value: 'chatbot' }]
+});
 ```
 
 #### Update Agent Function
 
 ```typescript
-const func = await client.agentFunctions.update({
-  id: 'function-1',
+const func = await client.agentFunctions.update('function-id', {
   name: 'Updated Function Name',
   url: 'https://new-url.com'
 });
@@ -725,13 +766,13 @@ const func = await client.agentFunctions.update({
 #### Delete Agent Function
 
 ```typescript
-await client.agentFunctions.delete('function-1');
+await client.agentFunctions.delete('function-id');
 ```
 
 #### Get Agent Function
 
 ```typescript
-const func = await client.agentFunctions.get('function-1');
+const func = await client.agentFunctions.get('function-id');
 console.log(`Name: ${func.name}`);
 console.log(`URL: ${func.url}`);
 ```
@@ -739,23 +780,40 @@ console.log(`URL: ${func.url}`);
 #### List Agent Functions
 
 ```typescript
-const functions = await client.agentFunctions.list(20);
+const functions = await client.agentFunctions.list(20, 0);
 for (const func of functions.items) {
   console.log(`${func.name}`);
 }
 ```
 
+#### Search Agent Functions
+
+```typescript
+const results = await client.agentFunctions.search('weather');
+for (const func of results) {
+  console.log(`${func.name}`);
+}
+```
+
 ### Authorisations
 
 #### Create an Authorisation
 
 ```typescript
-const auth = await client.authorisations.create({
-  id: 'auth-1',
-  name: 'GitHub OAuth',
-  type: 'oauth',
-  tokenSecret: 'encrypted-token',
-  description: 'GitHub OAuth token for API access',
+// API Key authorisation
+const apiKeyAuth = await client.authorisations.create('External API Key', 'apikey', {
+  description: 'API key for external service',
+  tokenSecret: 'your-api-key-value'
+});
+
+// Bearer token authorisation
+const bearerAuth = await client.authorisations.create('Service Token', 'bearer', {
+  tokenSecret: 'your-bearer-token'
+});
+
+// OAuth authorisation
+const oauthAuth = await client.authorisations.create('GitHub OAuth', 'oauth', {
+  description: 'GitHub OAuth for API access',
   scope: 'repo,user',
   grantType: 'authorization_code',
   clientId: 'github-client-id',
@@ -768,23 +826,22 @@ const auth = await client.authorisations.create({
 #### Update Authorisation
 
 ```typescript
-const auth = await client.authorisations.update({
-  id: 'auth-1',
+const auth = await client.authorisations.update('auth-id', {
   name: 'Updated Auth Name',
-  scope: 'repo,user,admin'
+  description: 'New description'
 });
 ```
 
 #### Delete Authorisation
 
 ```typescript
-await client.authorisations.delete('auth-1');
+await client.authorisations.delete('auth-id');
 ```
 
 #### Get Authorisation
 
 ```typescript
-const auth = await client.authorisations.get('auth-1');
+const auth = await client.authorisations.get('auth-id');
 console.log(`Name: ${auth.name}`);
 console.log(`Type: ${auth.type}`);
 ```
@@ -792,23 +849,35 @@ console.log(`Type: ${auth.type}`);
 #### List Authorisations
 
 ```typescript
-const auths = await client.authorisations.list(20);
+const auths = await client.authorisations.list(20, 0);
 for (const auth of auths.items) {
   console.log(`${auth.name} (${auth.type})`);
 }
 ```
 
+#### Get Authorisations by Type
+
+```typescript
+const apiKeys = await client.authorisations.getByType('apikey');
+const oauthAuths = await client.authorisations.getByType('oauth');
+```
+
+#### Search Authorisations
+
+```typescript
+const results = await client.authorisations.search('github');
+for (const auth of results) {
+  console.log(`${auth.name}`);
+}
+```
+
 ### Channels
 
 #### Create a Channel
 
 ```typescript
-const channel = await client.channels.create({
-  id: 'channel-1',
-  name: 'SMS Channel',
-  channel: 'sms',
-  provider: 'twilio',
-  senderid: '+1234567890',
+const channel = await client.channels.create('SMS Channel', 'sms', 'twilio', {
+  senderId: '+1234567890',
   description: 'SMS notifications via Twilio',
   isActive: true
 });
@@ -817,8 +886,7 @@ const channel = await client.channels.create({
 #### Update Channel
 
 ```typescript
-const channel = await client.channels.update({
-  id: 'channel-1',
+const channel = await client.channels.update('channel-id', {
   name: 'Updated Channel',
   isActive: false
 });
@@ -827,13 +895,13 @@ const channel = await client.channels.update({
 #### Delete Channel
 
 ```typescript
-await client.channels.delete('channel-1');
+await client.channels.delete('channel-id');
 ```
 
 #### Get Channel
 
 ```typescript
-const channel = await client.channels.get('channel-1');
+const channel = await client.channels.get('channel-id');
 console.log(`Name: ${channel.name}`);
 console.log(`Provider: ${channel.provider}`);
 ```
@@ -841,7 +909,7 @@ console.log(`Provider: ${channel.provider}`);
 #### List Channels
 
 ```typescript
-const channels = await client.channels.list(20);
+const channels = await client.channels.list(20, 0);
 for (const channel of channels.items) {
   console.log(`${channel.name} (${channel.provider})`);
 }
@@ -861,12 +929,28 @@ console.log(`Host: ${connection.host}`);
 #### List Connections
 
 ```typescript
-const connections = await client.connections.list(20);
+const connections = await client.connections.list(20, 0);
 for (const conn of connections.items) {
   console.log(`${conn.name} (${conn.type})`);
 }
 ```
 
+#### Get Connections by Type
+
+```typescript
+const postgresConns = await client.connections.getByType('postgres');
+const mysqlConns = await client.connections.getByType('mysql');
+```
+
+#### Search Connections
+
+```typescript
+const results = await client.connections.search('database');
+for (const conn of results) {
+  console.log(`${conn.name}`);
+}
+```
+
 #### Delete Connection
 
 ```typescript
@@ -923,7 +1007,7 @@ console.log(`Status: ${site.status}`);
 #### List Sites
 
 ```typescript
-const sites = await client.sites.list(20);
+const sites = await client.sites.list(20, 0);
 for (const site of sites.items) {
   console.log(`${site.name} - ${site.url}`);
 }
@@ -932,8 +1016,7 @@ for (const site of sites.items) {
 #### Update Site
 
 ```typescript
-const site = await client.sites.update({
-  id: 'site-id',
+const site = await client.sites.update('site-id', {
   name: 'Updated Site',
   status: 'active',
   allowedPaths: ['/docs', '/blog']
@@ -951,9 +1034,7 @@ await client.sites.delete('site-id');
 #### Create a Benchmark
 
 ```typescript
-const benchmark = await client.benchmarks.create({
-  id: 'benchmark-1',
-  name: 'Customer Support Test',
+const benchmark = await client.benchmarks.create('Customer Support Test', {
   description: 'Test agent performance on customer support queries',
   questions: [
     {
@@ -970,8 +1051,7 @@ const benchmark = await client.benchmarks.create({
 #### Update Benchmark
 
 ```typescript
-const benchmark = await client.benchmarks.update({
-  id: 'benchmark-1',
+const benchmark = await client.benchmarks.update('benchmark-id', {
   name: 'Updated Benchmark',
   description: 'New description'
 });
@@ -980,13 +1060,13 @@ const benchmark = await client.benchmarks.update({
 #### Delete Benchmark
 
 ```typescript
-await client.benchmarks.delete('benchmark-1');
+await client.benchmarks.delete('benchmark-id');
 ```
 
 #### Get Benchmark
 
 ```typescript
-const benchmark = await client.benchmarks.get('benchmark-1');
+const benchmark = await client.benchmarks.get('benchmark-id');
 console.log(`Name: ${benchmark.name}`);
 console.log(`Questions: ${benchmark.questions?.length}`);
 ```
@@ -994,7 +1074,7 @@ console.log(`Questions: ${benchmark.questions?.length}`);
 #### List Benchmarks
 
 ```typescript
-const benchmarks = await client.benchmarks.list(20);
+const benchmarks = await client.benchmarks.list(20, 0);
 for (const benchmark of benchmarks.items) {
   console.log(`${benchmark.name}`);
 }
@@ -1005,14 +1085,11 @@ for (const benchmark of benchmarks.items) {
 #### Create a Hook
 
 ```typescript
-const hook = await client.hooks.create({
-  id: 'hook-1',
-  name: 'Data Processing Hook',
-  functionName: 'process_data',
+const hook = await client.hooks.create('Data Processing Hook', 'process_data', {
   customExecutionCode: 'def process_data(data): return data.upper()',
   customExecutionInstructions: 'Process incoming data',
   availableLibraries: 'pandas,numpy',
-  allowExternalAPI: true,
+  allowExternalApi: true,
   hardcodedScript: false
 });
 ```
@@ -1020,8 +1097,7 @@ const hook = await client.hooks.create({
 #### Update Hook
 
 ```typescript
-const hook = await client.hooks.update({
-  id: 'hook-1',
+const hook = await client.hooks.update('hook-id', {
   name: 'Updated Hook',
   customExecutionCode: 'def process_data(data): return data.lower()'
 });
@@ -1030,13 +1106,13 @@ const hook = await client.hooks.update({
 #### Delete Hook
 
 ```typescript
-await client.hooks.delete('hook-1');
+await client.hooks.delete('hook-id');
 ```
 
 #### Get Hook
 
 ```typescript
-const hook = await client.hooks.get('hook-1');
+const hook = await client.hooks.get('hook-id');
 console.log(`Name: ${hook.name}`);
 console.log(`Function: ${hook.functionName}`);
 ```
@@ -1044,7 +1120,7 @@ console.log(`Function: ${hook.functionName}`);
 #### List Hooks
 
 ```typescript
-const hooks = await client.hooks.list(20);
+const hooks = await client.hooks.list(20, 0);
 for (const hook of hooks.items) {
   console.log(`${hook.name}`);
 }
@@ -1055,12 +1131,10 @@ for (const hook of hooks.items) {
 #### Create a Scheduled Job
 
 ```typescript
-const job = await client.scheduledJobs.create({
-  id: 'job-1',
-  name: 'Daily Report',
+const job = await client.scheduledJobs.create('Daily Report', {
   description: 'Generate daily report at 9 AM',
-  agentID: 'agent-id',
-  customPromptID: 'prompt-id',
+  agentId: 'agent-id',
+  customPromptId: 'prompt-id',
   forcedPrompt: 'Generate a daily summary report',
   schedule: {
     frequency: 'DAILY',
@@ -1076,8 +1150,7 @@ const job = await client.scheduledJobs.create({
 #### Update Scheduled Job
 
 ```typescript
-const job = await client.scheduledJobs.update({
-  id: 'job-1',
+const job = await client.scheduledJobs.update('job-id', {
   name: 'Updated Job',
   isActive: false,
   schedule: {
@@ -1091,13 +1164,13 @@ const job = await client.scheduledJobs.update({
 #### Delete Scheduled Job
 
 ```typescript
-await client.scheduledJobs.delete('job-1');
+await client.scheduledJobs.delete('job-id');
 ```
 
 #### Get Scheduled Job
 
 ```typescript
-const job = await client.scheduledJobs.get('job-1');
+const job = await client.scheduledJobs.get('job-id');
 console.log(`Name: ${job.name}`);
 console.log(`Status: ${job.status}`);
 console.log(`Schedule: ${JSON.stringify(job.schedule)}`);
@@ -1106,7 +1179,7 @@ console.log(`Schedule: ${JSON.stringify(job.schedule)}`);
 #### List Scheduled Jobs
 
 ```typescript
-const jobs = await client.scheduledJobs.list(20);
+const jobs = await client.scheduledJobs.list(20, 0);
 for (const job of jobs.items) {
   console.log(`${job.name} (${job.status})`);
 }
@@ -1114,20 +1187,41 @@ for (const job of jobs.items) {
 
 ### Secrets
 
+Secrets are linked to authorisations. You must first create an authorisation, then create a secret for it.
+
 #### Create a Secret
 
 ```typescript
-const secret = await client.secrets.create({
-  id: 'secret-1',
-  name: 'API Key',
-  description: 'External API key for service X'
+// First, create an authorisation
+const auth = await client.authorisations.create('External Service Auth', 'apikey', {
+  description: 'Authorisation for external service'
 });
+
+// Then create a secret linked to that authorisation
+const secret = await client.secrets.create(auth.id, 'your-secret-api-key-12345');
+console.log(`Secret created: ${secret.name}`);
+```
+
+#### Get a Secret
+
+```typescript
+const secret = await client.secrets.get('secret-id');
+console.log(`Secret: ${secret.name}`);
+```
+
+#### List Secrets
+
+```typescript
+const secrets = await client.secrets.list(20, 0);
+for (const secret of secrets.items) {
+  console.log(`${secret.name}`);
+}
 ```
 
 #### Delete Secret
 
 ```typescript
-await client.secrets.delete('secret-1');
+await client.secrets.delete('secret-id');
 ```
 
 ### Dictionary
@@ -1169,13 +1263,12 @@ for (const emb of embeddings) {
 
 ```typescript
 // Get charting settings
-const settings = await client.chartingSettings.get('settings-id');
+const settings = await client.chartingSettings.get();
 console.log(`Primary Color: ${settings.primaryColor}`);
 console.log(`Secondary Color: ${settings.secondaryColor}`);
 
 // Update charting settings
 const updated = await client.chartingSettings.update({
-  id: 'settings-id',
   primaryColor: '#FF5733',
   secondaryColor: '#33FF57',
   lineColor: '#3357FF'
@@ -1186,13 +1279,12 @@ const updated = await client.chartingSettings.update({
 
 ```typescript
 // Get embeddings settings
-const settings = await client.embeddingsSettings.get('settings-id');
+const settings = await client.embeddingsSettings.get();
 console.log(`Max Chunk Words: ${settings.maxChunkWords}`);
 console.log(`Chunking Strategy: ${settings.chunkingStrategy}`);
 
 // Update embeddings settings
 const updated = await client.embeddingsSettings.update({
-  id: 'settings-id',
   maxChunkWords: 1000,
   chunkingStrategy: 'summary',
   imageExtractionStrategy: 'safe'
@@ -1204,10 +1296,14 @@ const updated = await client.embeddingsSettings.update({
 #### Get Monthly Costs
 
 ```typescript
-const costs = await client.billing.getMonthCosts();
+// Using get() method (like Python SDK)
+const costs = await client.billing.get();
 console.log(`API Usage: ${JSON.stringify(costs.apiUsage)}`);
 console.log(`Training Usage: ${JSON.stringify(costs.trainingUsage)}`);
 console.log(`Total Cost: $${costs.apiUsage?.totalCostUSD || 0}`);
+
+// Or using getMonthCosts() alias
+const costs2 = await client.billing.getMonthCosts();
 ```
 
 ### Streams

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toothfairyai/sdk",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "JavaScript/TypeScript SDK for ToothFairyAI API integration",
   "main": "build/index.js",
   "types": "build/index.d.ts",