@friggframework/api-module-zoho-crm 2.0.0-next.2 → 2.0.0-next.3

package/README.md

@@ -52,7 +52,7 @@ If you've already done this, skip to the next section.
     ```shell
     ZOHO_CRM_CLIENT_ID=your_client_id
     ZOHO_CRM_CLIENT_SECRET=your_client_secret
-    ZOHO_CRM_SCOPE=ZohoCRM.users.ALL,ZohoCRM.org.ALL,ZohoCRM.settings.roles.ALL,ZohoCRM.settings.profiles.ALL,ZohoCRM.modules.contacts.ALL,ZohoCRM.modules.leads.ALL,ZohoCRM.modules.accounts.ALL
+    ZOHO_CRM_SCOPE=ZohoCRM.users.ALL ZohoCRM.org.ALL ZohoCRM.settings.roles.ALL ZohoCRM.settings.profiles.ALL ZohoCRM.modules.contacts.ALL ZohoCRM.modules.leads.ALL ZohoCRM.modules.accounts.ALL ZohoCRM.modules.calls.ALL
     REDIRECT_URI=http://localhost:3000/redirect
     ```
 
@@ -90,6 +90,21 @@ If you've already done this, skip to the next section.
 - `getAccount(accountId)` - Get a specific account by ID
 - `searchAccounts(searchParams)` - Search accounts by phone, criteria, or word
 
+### Calls
+- `logCall(callData)` - Log a call in the Zoho CRM Calls module
+- `updateCall(callId, callData)` - Update an existing call record
+
+**Call Data Fields:**
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `Subject` | string | Yes | Call subject/title |
+| `Call_Type` | string | Yes | `Inbound`, `Outbound`, or `Missed` |
+| `Call_Start_Time` | string | Yes | ISO 8601 datetime |
+| `Call_Duration` | string | Yes* | `mm:ss` format (*required for Inbound/Outbound, cannot be zero) |
+| `Description` | string | No | Call notes |
+| `Who_Id` | string | No | Contact/Lead ID to associate |
+| `$se_module` | string | No | Module for Who_Id: `Contacts` or `Leads` |
+
 ## Using the API Module from the Terminal
 
 With your `.env` in place, you can test the API from a Node terminal.

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { OAuth2Requester } from '@friggframework/core';
-import { ZohoConfig, QueryParams, SearchParams, UsersResponse, RolesResponse, ProfilesResponse, ContactsResponse, ContactResponse, LeadsResponse, LeadResponse, AccountsResponse, AccountResponse, TokenResponse, CreateNoteData, NotesResponse, NoteListResponse, NotificationWatchConfig, NotificationResponse, NotificationDetailsResponse } from './types';
+import { ZohoConfig, QueryParams, SearchParams, UsersResponse, RolesResponse, ProfilesResponse, ContactsResponse, ContactResponse, LeadsResponse, LeadResponse, AccountsResponse, AccountResponse, TokenResponse, CreateNoteData, NotesResponse, NoteListResponse, NotificationWatchConfig, NotificationResponse, NotificationDetailsResponse, ZohoCallData, CallsResponse } from './types';
 export declare class Api extends OAuth2Requester {
     URLs: Record<string, string | ((id: string) => string)>;
     private static readonly CONTACTS_DEFAULT_FIELDS;
@@ -98,4 +98,19 @@ export declare class Api extends OAuth2Requester {
      * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/get-details.html
      */
     getNotificationDetails(): Promise<NotificationDetailsResponse>;
+    /**
+     * Log a call in Zoho CRM Calls module
+     * @param callData - Call record data with Subject, Call_Type, Call_Start_Time, Call_Duration
+     * @returns Promise<CallsResponse> Created call response
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/insert-records.html
+     */
+    logCall(callData: ZohoCallData): Promise<CallsResponse>;
+    /**
+     * Update an existing call record in Zoho CRM Calls module
+     * @param callId - Zoho Call ID to update
+     * @param callData - Partial call data to update (e.g., Description, Subject)
+     * @returns Promise<CallsResponse> Updated call response
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/update-records.html
+     */
+    updateCall(callId: string, callData: Partial<ZohoCallData>): Promise<CallsResponse>;
 }

package/dist/api.js

@@ -26,6 +26,8 @@ class Api extends core_1.OAuth2Requester {
             accounts: '/Accounts',
             account: (accountId) => `/Accounts/${accountId}`,
             accountSearch: '/Accounts/search',
+            calls: '/Calls',
+            call: (callId) => `/Calls/${callId}`,
             notificationsWatch: '/actions/watch',
         };
     }
@@ -201,6 +203,12 @@ class Api extends core_1.OAuth2Requester {
             });
         }
         catch (error) {
+            // Zoho returns 204 No Content with empty body when no results found
+            // This causes JSON parsing to fail with "Unexpected end of JSON input"
+            if (error?.message?.includes('Unexpected end of JSON input') ||
+                error?.message?.includes('invalid json response body')) {
+                return { data: [], info: undefined };
+            }
             throw error;
         }
     }
@@ -247,6 +255,11 @@ class Api extends core_1.OAuth2Requester {
             });
         }
         catch (error) {
+            // Zoho returns 204 No Content with empty body when no results found
+            if (error?.message?.includes('Unexpected end of JSON input') ||
+                error?.message?.includes('invalid json response body')) {
+                return { data: [], info: undefined };
+            }
             throw error;
         }
     }
@@ -293,6 +306,11 @@ class Api extends core_1.OAuth2Requester {
             });
         }
         catch (error) {
+            // Zoho returns 204 No Content with empty body when no results found
+            if (error?.message?.includes('Unexpected end of JSON input') ||
+                error?.message?.includes('invalid json response body')) {
+                return { data: [], info: undefined };
+            }
             throw error;
         }
     }
@@ -514,6 +532,72 @@ class Api extends core_1.OAuth2Requester {
             throw error;
         }
     }
+    /**
+     * Log a call in Zoho CRM Calls module
+     * @param callData - Call record data with Subject, Call_Type, Call_Start_Time, Call_Duration
+     * @returns Promise<CallsResponse> Created call response
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/insert-records.html
+     */
+    async logCall(callData) {
+        if (!callData.Subject) {
+            throw new Error('callData.Subject is required');
+        }
+        if (!callData.Call_Type) {
+            throw new Error('callData.Call_Type is required');
+        }
+        if (!callData.Call_Start_Time) {
+            throw new Error('callData.Call_Start_Time is required');
+        }
+        // Duration is mandatory for Inbound/Outbound calls and cannot be zero
+        if ((callData.Call_Type === 'Inbound' || callData.Call_Type === 'Outbound') && !callData.Call_Duration) {
+            throw new Error('callData.Call_Duration is required for Inbound/Outbound calls');
+        }
+        const body = {
+            data: [callData]
+        };
+        try {
+            return await this._post({
+                url: this.baseUrl + this.URLs.calls,
+                body: body,
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Update an existing call record in Zoho CRM Calls module
+     * @param callId - Zoho Call ID to update
+     * @param callData - Partial call data to update (e.g., Description, Subject)
+     * @returns Promise<CallsResponse> Updated call response
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/update-records.html
+     */
+    async updateCall(callId, callData) {
+        if (!callId) {
+            throw new Error('callId is required');
+        }
+        if (!callData || Object.keys(callData).length === 0) {
+            throw new Error('callData must contain at least one field to update');
+        }
+        const body = {
+            data: [callData]
+        };
+        try {
+            return await this._put({
+                url: this.baseUrl + this.URLs.call(callId),
+                body: body,
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
 }
 exports.Api = Api;
 Api.CONTACTS_DEFAULT_FIELDS = 'id,First_Name,Last_Name,Email,Phone,Mobile,Account_Name,Company,Owner,Lead_Source,Created_Time,Modified_Time';

package/dist/types.d.ts

@@ -354,3 +354,47 @@ export interface NotificationCallbackPayload {
     /** Verification token (if provided during setup) */
     token?: string;
 }
+/**
+ * Data for creating/updating a call record in Zoho CRM Calls module
+ */
+export interface ZohoCallData {
+    /** Call subject/title (required) */
+    Subject: string;
+    /** Call type: Inbound, Outbound, or Missed (required) */
+    Call_Type: 'Inbound' | 'Outbound' | 'Missed';
+    /** Call start time in ISO 8601 format (required) */
+    Call_Start_Time: string;
+    /** Call duration in "HH:mm" or "mm:ss" format (required for Inbound/Outbound, cannot be zero) */
+    Call_Duration: string;
+    /** Call notes/description */
+    Description?: string;
+    /** Contact or Lead ID to associate the call with */
+    Who_Id?: string;
+    /** Module name for the Who_Id association: "Contacts" or "Leads" */
+    $se_module?: string;
+    /** Additional custom fields */
+    [key: string]: any;
+}
+/**
+ * Response from Calls module operations
+ */
+export interface CallsResponse {
+    data: Array<{
+        code: string;
+        details: {
+            id: string;
+            Created_Time: string;
+            Modified_Time: string;
+            Created_By?: {
+                name: string;
+                id: string;
+            };
+            Modified_By?: {
+                name: string;
+                id: string;
+            };
+        };
+        message: string;
+        status: string;
+    }>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-zoho-crm",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0-next.3",
   "prettier": "@friggframework/prettier-config",
   "description": "Zoho CRM API module that lets the Frigg Framework interact with Zoho CRM",
   "main": "dist/index.js",
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fa3f5ec40cbb9300511849233bddb0c463bfab2a"
+  "gitHead": "fd8e7d7ad197886b7bd94a68fd26c179358f4b67"
 }