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

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 } from './types';
+import { ZohoConfig, QueryParams, SearchParams, UsersResponse, RolesResponse, ProfilesResponse, ContactsResponse, ContactResponse, LeadsResponse, LeadResponse, AccountsResponse, AccountResponse, TokenResponse, CreateNoteData, NotesResponse, NoteListResponse, NotificationWatchConfig, NotificationResponse, NotificationDetailsResponse } from './types';
 export declare class Api extends OAuth2Requester {
     URLs: Record<string, string | ((id: string) => string)>;
     private static readonly CONTACTS_DEFAULT_FIELDS;
@@ -9,6 +9,14 @@ export declare class Api extends OAuth2Requester {
     getAuthUri(): string;
     getTokenFromCode(code: string): Promise<TokenResponse>;
     _delete(options: any): Promise<any>;
+    /**
+     * Build URL for notes endpoints with proper encoding
+     * @param module - Module API name (e.g., 'Contacts', 'Leads')
+     * @param recordId - Record ID
+     * @param noteId - Optional note ID for specific note operations
+     * @returns Encoded URL path for notes endpoint
+     */
+    private buildNotesUrl;
     listUsers(queryParams?: QueryParams): Promise<UsersResponse>;
     getUser(userId: string): Promise<UsersResponse>;
     createUser(body?: any): Promise<any>;
@@ -29,4 +37,65 @@ export declare class Api extends OAuth2Requester {
     listAccounts(queryParams?: QueryParams): Promise<AccountsResponse>;
     getAccount(accountId: string): Promise<AccountResponse>;
     searchAccounts(searchParams?: SearchParams): Promise<AccountsResponse>;
+    /**
+     * List all notes for a specific record
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID to get notes for
+     * @param queryParams - Optional query parameters (per_page, page, etc.)
+     * @returns Promise<NoteListResponse> Notes list response
+     */
+    listNotes(module: string, recordId: string, queryParams?: QueryParams): Promise<NoteListResponse>;
+    /**
+     * Get a specific note by ID
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to retrieve
+     * @returns Promise<NotesResponse> Note details
+     */
+    getNote(module: string, recordId: string, noteId: string): Promise<NotesResponse>;
+    /**
+     * Create a note for a specific record
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID to attach note to
+     * @param noteData - Note data with Note_Content (required) and optional Note_Title
+     * @returns Promise<NotesResponse> Created note response
+     */
+    createNote(module: string, recordId: string, noteData: CreateNoteData): Promise<NotesResponse>;
+    /**
+     * Update an existing note
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to update
+     * @param noteData - Updated note data. At least one of Note_Content or Note_Title must be provided.
+     * @returns Promise<NotesResponse> Updated note response
+     */
+    updateNote(module: string, recordId: string, noteId: string, noteData: Partial<CreateNoteData>): Promise<NotesResponse>;
+    /**
+     * Delete a note
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to delete
+     * @returns Promise<NotesResponse> Deletion response
+     */
+    deleteNote(module: string, recordId: string, noteId: string): Promise<NotesResponse>;
+    /**
+     * Enable notification channel to receive real-time events
+     * @param body - Notification configuration with watch items
+     * @returns Promise<NotificationResponse> Response with channel details
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/enable.html
+     */
+    enableNotification(body: NotificationWatchConfig): Promise<NotificationResponse>;
+    /**
+     * Disable notification channels
+     * @param channelIds - Array of channel IDs to disable
+     * @returns Promise<NotificationResponse> Response confirming deletion
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/disable.html
+     */
+    disableNotification(channelIds: Array<string | number>): Promise<NotificationResponse>;
+    /**
+     * Get details of all active notification channels
+     * @returns Promise<NotificationDetailsResponse> Details of all active channels
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/get-details.html
+     */
+    getNotificationDetails(): Promise<NotificationDetailsResponse>;
 }

package/dist/api.js

@@ -26,6 +26,7 @@ class Api extends core_1.OAuth2Requester {
             accounts: '/Accounts',
             account: (accountId) => `/Accounts/${accountId}`,
             accountSearch: '/Accounts/search',
+            notificationsWatch: '/actions/watch',
         };
     }
     getAuthUri() {
@@ -52,6 +53,20 @@ class Api extends core_1.OAuth2Requester {
         const response = await super._delete(options);
         return await this.parsedBody(response);
     }
+    /**
+     * Build URL for notes endpoints with proper encoding
+     * @param module - Module API name (e.g., 'Contacts', 'Leads')
+     * @param recordId - Record ID
+     * @param noteId - Optional note ID for specific note operations
+     * @returns Encoded URL path for notes endpoint
+     */
+    buildNotesUrl(module, recordId, noteId) {
+        const segments = [module, recordId, 'Notes'];
+        if (noteId)
+            segments.push(noteId);
+        const encodedPath = segments.map(encodeURIComponent).join('/');
+        return `${this.baseUrl}/${encodedPath}`;
+    }
     async listUsers(queryParams = {}) {
         return this._get({
             url: this.baseUrl + this.URLs.users,
@@ -281,6 +296,224 @@ class Api extends core_1.OAuth2Requester {
             throw error;
         }
     }
+    /**
+     * List all notes for a specific record
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID to get notes for
+     * @param queryParams - Optional query parameters (per_page, page, etc.)
+     * @returns Promise<NoteListResponse> Notes list response
+     */
+    async listNotes(module, recordId, queryParams = {}) {
+        if (!module) {
+            throw new Error('module is required');
+        }
+        if (!recordId) {
+            throw new Error('recordId is required');
+        }
+        try {
+            return await this._get({
+                url: this.buildNotesUrl(module, recordId),
+                query: queryParams,
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Get a specific note by ID
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to retrieve
+     * @returns Promise<NotesResponse> Note details
+     */
+    async getNote(module, recordId, noteId) {
+        if (!module) {
+            throw new Error('module is required');
+        }
+        if (!recordId) {
+            throw new Error('recordId is required');
+        }
+        if (!noteId) {
+            throw new Error('noteId is required');
+        }
+        try {
+            return await this._get({
+                url: this.buildNotesUrl(module, recordId, noteId),
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Create a note for a specific record
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID to attach note to
+     * @param noteData - Note data with Note_Content (required) and optional Note_Title
+     * @returns Promise<NotesResponse> Created note response
+     */
+    async createNote(module, recordId, noteData) {
+        if (!module) {
+            throw new Error('module is required');
+        }
+        if (!recordId) {
+            throw new Error('recordId is required');
+        }
+        if (!noteData || !noteData.Note_Content) {
+            throw new Error('noteData.Note_Content is required');
+        }
+        const body = {
+            data: [{
+                    Note_Content: noteData.Note_Content,
+                    ...(noteData.Note_Title && { Note_Title: noteData.Note_Title }),
+                }]
+        };
+        try {
+            return await this._post({
+                url: this.buildNotesUrl(module, recordId),
+                body: body,
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Update an existing note
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to update
+     * @param noteData - Updated note data. At least one of Note_Content or Note_Title must be provided.
+     * @returns Promise<NotesResponse> Updated note response
+     */
+    async updateNote(module, recordId, noteId, noteData) {
+        if (!module) {
+            throw new Error('module is required');
+        }
+        if (!recordId) {
+            throw new Error('recordId is required');
+        }
+        if (!noteId) {
+            throw new Error('noteId is required');
+        }
+        if (!noteData || (!noteData.Note_Content && !noteData.Note_Title)) {
+            throw new Error('noteData must contain Note_Content or Note_Title');
+        }
+        const body = {
+            data: [{
+                    ...(noteData.Note_Content && { Note_Content: noteData.Note_Content }),
+                    ...(noteData.Note_Title && { Note_Title: noteData.Note_Title }),
+                }]
+        };
+        try {
+            return await this._put({
+                url: this.buildNotesUrl(module, recordId, noteId),
+                body: body,
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Delete a note
+     * @param module - Module API name (Contacts, Leads, Accounts, etc.)
+     * @param recordId - Record ID the note is attached to
+     * @param noteId - Note ID to delete
+     * @returns Promise<NotesResponse> Deletion response
+     */
+    async deleteNote(module, recordId, noteId) {
+        if (!module) {
+            throw new Error('module is required');
+        }
+        if (!recordId) {
+            throw new Error('recordId is required');
+        }
+        if (!noteId) {
+            throw new Error('noteId is required');
+        }
+        try {
+            return await this._delete({
+                url: this.buildNotesUrl(module, recordId, noteId),
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Enable notification channel to receive real-time events
+     * @param body - Notification configuration with watch items
+     * @returns Promise<NotificationResponse> Response with channel details
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/enable.html
+     */
+    async enableNotification(body) {
+        if (!body || !body.watch || !Array.isArray(body.watch)) {
+            throw new Error('Body must contain watch array');
+        }
+        // Validate each watch item
+        body.watch.forEach((item, index) => {
+            if (!item.channel_id) {
+                throw new Error(`watch[${index}].channel_id is required`);
+            }
+            if (!item.events || !Array.isArray(item.events) || item.events.length === 0) {
+                throw new Error(`watch[${index}].events must be a non-empty array`);
+            }
+            if (!item.notify_url) {
+                throw new Error(`watch[${index}].notify_url is required`);
+            }
+            if (item.token && item.token.length > 50) {
+                throw new Error(`watch[${index}].token must be 50 characters or less`);
+            }
+        });
+        try {
+            return await this._post({
+                url: this.baseUrl + this.URLs.notificationsWatch,
+                body: body,
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Disable notification channels
+     * @param channelIds - Array of channel IDs to disable
+     * @returns Promise<NotificationResponse> Response confirming deletion
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/disable.html
+     */
+    async disableNotification(channelIds) {
+        if (!channelIds || !Array.isArray(channelIds) || channelIds.length === 0) {
+            throw new Error('channelIds must be a non-empty array');
+        }
+        try {
+            return await this._delete({
+                url: this.baseUrl + this.URLs.notificationsWatch,
+                query: {
+                    channel_ids: channelIds.join(',')
+                },
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Get details of all active notification channels
+     * @returns Promise<NotificationDetailsResponse> Details of all active channels
+     * @see https://www.zoho.com/crm/developer/docs/api/v8/notifications/get-details.html
+     */
+    async getNotificationDetails() {
+        try {
+            return await this._get({
+                url: this.baseUrl + this.URLs.notificationsWatch,
+            });
+        }
+        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

@@ -195,6 +195,61 @@ export interface DeleteResponse {
     message: string;
     status: string;
 }
+export interface ZohoNote {
+    id: string;
+    Note_Title?: string;
+    Note_Content: string;
+    Parent_Id?: {
+        module: {
+            api_name: string;
+            id: string;
+        };
+        id: string;
+    };
+    Owner?: {
+        name: string;
+        id: string;
+    };
+    Created_Time?: string;
+    Modified_Time?: string;
+    Created_By?: {
+        name: string;
+        id: string;
+    };
+    Modified_By?: {
+        name: string;
+        id: string;
+    };
+    [key: string]: any;
+}
+export interface CreateNoteData {
+    Note_Content: string;
+    Note_Title?: string;
+}
+export interface NotesResponse {
+    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;
+    }>;
+}
+export interface NoteListResponse {
+    data: ZohoNote[];
+    info?: PaginationInfo;
+}
 export interface QueryParams {
     fields?: string;
     per_page?: number;
@@ -220,3 +275,82 @@ export interface TokenResponse {
     token_type: string;
     expires_in: number;
 }
+/**
+ * Configuration for a single notification watch item
+ */
+export interface NotificationWatchItem {
+    /** Unique channel ID (use timestamp or UUID) */
+    channel_id: number | string;
+    /** Events to watch in format: "Module.operation" (e.g., "Contacts.all", "Contacts.create", "Accounts.edit") */
+    events: string[];
+    /** Callback URL to receive notifications */
+    notify_url: string;
+    /** Optional verification token (max 50 characters) */
+    token?: string;
+    /** Channel expiry time (ISO 8601 format, max 1 week from now) */
+    channel_expiry?: string;
+    /** Include field changes in callback payload */
+    return_affected_field_values?: boolean;
+    /** Trigger notifications on related record actions */
+    notify_on_related_action?: boolean;
+}
+/**
+ * Request body for enabling notifications
+ */
+export interface NotificationWatchConfig {
+    watch: NotificationWatchItem[];
+}
+/**
+ * Response from notification API operations
+ */
+export interface NotificationResponse {
+    watch: Array<{
+        code: string;
+        details: {
+            channel_id: number | string;
+            events: string[];
+            channel_expiry: string;
+            resource_uri: string;
+            resource_id: string;
+            resource_name: string;
+        };
+        message: string;
+        status: string;
+    }>;
+}
+/**
+ * Response from getting notification details
+ */
+export interface NotificationDetailsResponse {
+    watch: Array<{
+        channel_id: number | string;
+        events: string[];
+        channel_expiry: string;
+        notify_url: string;
+        resource_uri: string;
+        resource_id: string;
+        resource_name: string;
+        token?: string;
+    }>;
+}
+/**
+ * Payload received in notification callback
+ */
+export interface NotificationCallbackPayload {
+    /** Server timestamp */
+    server_time: number;
+    /** Module name (e.g., "Contacts", "Accounts") */
+    module: string;
+    /** Resource URI */
+    resource_uri: string;
+    /** Array of affected record IDs */
+    ids: string[];
+    /** Fields that were affected (if return_affected_field_values enabled) */
+    affected_fields?: string[];
+    /** Operation type: "insert", "update", or "delete" */
+    operation: 'insert' | 'update' | 'delete';
+    /** Channel ID that triggered this notification */
+    channel_id: number | string;
+    /** Verification token (if provided during setup) */
+    token?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/api-module-zoho-crm",
-  "version": "2.0.0-next.1",
+  "version": "2.0.0-next.2",
   "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": "5b22500d5eb6b9032389753acad2279ddd70a8dd"
+  "gitHead": "fa3f5ec40cbb9300511849233bddb0c463bfab2a"
 }