@kortex-ai/hub-client 0.0.1 → 0.2.0

package/README.md

@@ -31,12 +31,12 @@ import { KortexClient } from '@kortex-ai/hub-client'
 
 // Initialize the client
 const client = new KortexClient({
-  apiToken: 'your-api-token',
+  organizationToken: 'your-organization-token',
   baseUrl: 'https://kortex-dashboard.vercel.app', // Optional, this is the default
 })
 
 // Use the client with Result pattern (never throws)
-const result = await client.sendMessage({
+const result = await client.sendTemplate({
   waId: '1234567890',
   message: {
     type: 'text',
@@ -60,26 +60,15 @@ if (result.error) {
 ```typescript
 interface KortexClientConfig {
   /**
-   * API token for authentication (required)
+   * Kortex Organization token for authentication (required)
    */
-  apiToken: string
+  organizationToken: string
 
   /**
    * Base URL of the Kortex Hub API
    * @default 'https://kortex-dashboard.vercel.app'
    */
   baseUrl?: string
-
-  /**
-   * Optional custom fetch implementation
-   */
-  fetch?: typeof fetch
-
-  /**
-   * Optional request timeout in milliseconds
-   * @default 30000 (30 seconds)
-   */
-  timeout?: number
 }
 ```
 
@@ -136,13 +125,13 @@ await client.sendNotification({
 
 ---
 
-#### `sendMessage(payload)`
+#### `sendTemplate(payload)`
 
 Send a message (text, note, or template) to a WhatsApp conversation.
 
 ```typescript
 // Send a text message
-await client.sendMessage({
+await client.sendTemplate({
   waId: '1234567890',
   message: {
     type: 'text',
@@ -150,11 +139,10 @@ await client.sendMessage({
       text: 'Hello!',
     },
   },
-  clientName: 'John Doe', // Optional
 })
 
 // Send a template message
-await client.sendMessage({
+await client.sendTemplate({
   waId: '1234567890',
   message: {
     type: 'template',
@@ -173,9 +161,8 @@ await client.sendMessage({
 - `message` (object, required) - Message object with type and content
   - `type`: `'text'` | `'note'` | `'template'`
   - `content`: Varies by message type
-- `clientName` (string, optional) - Client name for context
 
-**Returns:** `Promise<Result<SendMessageResponse, KortexAPIError>>`
+**Returns:** `Promise<Result<SendTemplateResponse, KortexAPIError>>`
 
 ---
 
@@ -247,11 +234,9 @@ const result = await client.sendMessage({
 if (result.error) {
   // Error - access error details
   console.error('Failed:', result.error.message)
-  console.error('Status:', result.error.statusCode)
-  console.error('Response:', result.error.response)
 } else {
   // Success - access data
-  console.log('Message sent:', result.data.message)
+  console.log('Message sent:', result.data)
 }
 
 // Or destructure for cleaner code
@@ -267,76 +252,10 @@ if (error) {
 console.log('Success:', data)
 ```
 
-## Advanced Usage
-
-### Custom Fetch Implementation
-
-```typescript
-import { KortexClient } from '@kortex-ai/hub-client'
-import fetch from 'node-fetch'
-
-const client = new KortexClient({
-  apiToken: 'your-token',
-  fetch: fetch as any, // Use node-fetch in Node.js < 18
-})
-```
-
-### Custom Timeout
-
-```typescript
-const client = new KortexClient({
-  apiToken: 'your-token',
-  timeout: 60000, // 60 seconds
-})
-```
-
-### Using with Different Environments
-
-The package works seamlessly across different JavaScript environments:
-
-```typescript
-// Node.js (18+)
-import { KortexClient } from '@kortex-ai/hub-client'
-
-// Node.js (< 18) - install node-fetch
-import fetch from 'node-fetch'
-const client = new KortexClient({
-  apiToken: 'token',
-  fetch: fetch as any,
-})
-
-// Deno
-import { KortexClient } from 'npm:@kortex-ai/hub-client'
-
-// Browser
-import { KortexClient } from '@kortex-ai/hub-client'
-```
-
-## Type Exports
-
-All TypeScript types and schemas are exported for your convenience:
-
-```typescript
-import type {
-  AssignTagsPayload,
-  SendMessagePayload,
-  SendNotificationPayload,
-  ConversationWithTags,
-  BareNotification,
-  // ... and more
-} from '@kortex-ai/hub-client'
-
-import {
-  AssignTagsSchema,
-  SendMessageSchema,
-  // ... Zod schemas for validation
-} from '@kortex-ai/hub-client'
-```
-
 ## License
 
 MIT
 
 ## Support
 
-For issues and questions, please visit [GitHub Issues](https://github.com/kortex/kortex-dashboard/issues) or contact support.
+For issues and questions, please contact support.

package/dist/index.d.mts

@@ -68,32 +68,19 @@ type SendNotificationPayload = z.infer<typeof SendNotificationSchema>;
 type SendNotificationResponse = {
     message: string;
 };
-declare const SendMessageSchema: z.ZodObject<{
+declare const SendTemplateSchema: z.ZodObject<{
     waId: z.ZodString;
-    message: z.ZodDiscriminatedUnion<[z.ZodObject<{
-        type: z.ZodLiteral<"text">;
-        content: z.ZodObject<{
-            text: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"note">;
-        content: z.ZodObject<{
-            text: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"template">;
-        content: z.ZodObject<{
-            name: z.ZodString;
-            language: z.ZodString;
-            header_variable: z.ZodOptional<z.ZodString>;
-            body_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            button_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>], "type">;
+    template: z.ZodObject<{
+        name: z.ZodString;
+        language: z.ZodOptional<z.ZodString>;
+        header_variable: z.ZodOptional<z.ZodString>;
+        body_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        button_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
     clientName: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-type SendMessagePayload = z.infer<typeof SendMessageSchema>;
-type SendMessageResponse = {
+type SendTemplatePayload = z.infer<typeof SendTemplateSchema>;
+type SendTemplateResponse = {
     message: string;
 };
 declare const StopConversationAiSchema: z.ZodObject<{
@@ -115,24 +102,22 @@ type UpsertConversationResponse = {
 };
 
 interface KortexClientConfig {
+    /**
+     * Kortex Organization token
+     */
+    organizationToken: string;
     /**
      * Base URL of the Kortex Hub API
      * @default 'https://kortex-dashboard.vercel.app'
      */
     baseUrl?: string;
-    /**
-     * API token for authentication
-     */
-    apiToken: string;
 }
 type KortexAPIError = {
     message: string;
-    statusCode?: number;
-    response?: unknown;
 };
 declare class KortexClient {
+    private readonly organizationToken;
     private readonly baseUrl;
-    private readonly apiToken;
     constructor(config: KortexClientConfig);
     /**
      * Internal method to make API requests
@@ -155,7 +140,7 @@ declare class KortexClient {
      * @param payload - The message details (waId, message type and content)
      * @returns Result with the success message or error
      */
-    sendMessage(payload: SendMessagePayload): Promise<Result<SendMessageResponse, KortexAPIError>>;
+    sendTemplate(payload: SendTemplatePayload): Promise<Result<SendTemplateResponse, KortexAPIError>>;
     /**
      * Stop or start AI for a conversation
      * @param payload - The waId and stopAi boolean
@@ -170,4 +155,4 @@ declare class KortexClient {
     upsertConversation(payload: UpsertConversationPayload): Promise<Result<UpsertConversationResponse, KortexAPIError>>;
 }
 
-export { type AssignTagsPayload, type AssignTagsResponse, AssignTagsSchema, type KortexAPIError, KortexClient, type KortexClientConfig, type SendMessagePayload, type SendMessageResponse, SendMessageSchema, type SendNotificationPayload, type SendNotificationResponse, SendNotificationSchema, type StopConversationAiPayload, type StopConversationAiResponse, StopConversationAiSchema, type UpsertConversationPayload, type UpsertConversationResponse, UpsertConversationSchema };
+export { type AssignTagsPayload, type AssignTagsResponse, type KortexAPIError, KortexClient, type KortexClientConfig, type SendNotificationPayload, type SendNotificationResponse, type SendTemplatePayload, type SendTemplateResponse, type StopConversationAiPayload, type StopConversationAiResponse, type UpsertConversationPayload, type UpsertConversationResponse };

package/dist/index.d.ts

@@ -68,32 +68,19 @@ type SendNotificationPayload = z.infer<typeof SendNotificationSchema>;
 type SendNotificationResponse = {
     message: string;
 };
-declare const SendMessageSchema: z.ZodObject<{
+declare const SendTemplateSchema: z.ZodObject<{
     waId: z.ZodString;
-    message: z.ZodDiscriminatedUnion<[z.ZodObject<{
-        type: z.ZodLiteral<"text">;
-        content: z.ZodObject<{
-            text: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"note">;
-        content: z.ZodObject<{
-            text: z.ZodString;
-        }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-        type: z.ZodLiteral<"template">;
-        content: z.ZodObject<{
-            name: z.ZodString;
-            language: z.ZodString;
-            header_variable: z.ZodOptional<z.ZodString>;
-            body_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
-            button_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>], "type">;
+    template: z.ZodObject<{
+        name: z.ZodString;
+        language: z.ZodOptional<z.ZodString>;
+        header_variable: z.ZodOptional<z.ZodString>;
+        body_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        button_variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
     clientName: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
-type SendMessagePayload = z.infer<typeof SendMessageSchema>;
-type SendMessageResponse = {
+type SendTemplatePayload = z.infer<typeof SendTemplateSchema>;
+type SendTemplateResponse = {
     message: string;
 };
 declare const StopConversationAiSchema: z.ZodObject<{
@@ -115,24 +102,22 @@ type UpsertConversationResponse = {
 };
 
 interface KortexClientConfig {
+    /**
+     * Kortex Organization token
+     */
+    organizationToken: string;
     /**
      * Base URL of the Kortex Hub API
      * @default 'https://kortex-dashboard.vercel.app'
      */
     baseUrl?: string;
-    /**
-     * API token for authentication
-     */
-    apiToken: string;
 }
 type KortexAPIError = {
     message: string;
-    statusCode?: number;
-    response?: unknown;
 };
 declare class KortexClient {
+    private readonly organizationToken;
     private readonly baseUrl;
-    private readonly apiToken;
     constructor(config: KortexClientConfig);
     /**
      * Internal method to make API requests
@@ -155,7 +140,7 @@ declare class KortexClient {
      * @param payload - The message details (waId, message type and content)
      * @returns Result with the success message or error
      */
-    sendMessage(payload: SendMessagePayload): Promise<Result<SendMessageResponse, KortexAPIError>>;
+    sendTemplate(payload: SendTemplatePayload): Promise<Result<SendTemplateResponse, KortexAPIError>>;
     /**
      * Stop or start AI for a conversation
      * @param payload - The waId and stopAi boolean
@@ -170,4 +155,4 @@ declare class KortexClient {
     upsertConversation(payload: UpsertConversationPayload): Promise<Result<UpsertConversationResponse, KortexAPIError>>;
 }
 
-export { type AssignTagsPayload, type AssignTagsResponse, AssignTagsSchema, type KortexAPIError, KortexClient, type KortexClientConfig, type SendMessagePayload, type SendMessageResponse, SendMessageSchema, type SendNotificationPayload, type SendNotificationResponse, SendNotificationSchema, type StopConversationAiPayload, type StopConversationAiResponse, StopConversationAiSchema, type UpsertConversationPayload, type UpsertConversationResponse, UpsertConversationSchema };
+export { type AssignTagsPayload, type AssignTagsResponse, type KortexAPIError, KortexClient, type KortexClientConfig, type SendNotificationPayload, type SendNotificationResponse, type SendTemplatePayload, type SendTemplateResponse, type StopConversationAiPayload, type StopConversationAiResponse, type UpsertConversationPayload, type UpsertConversationResponse };