@rnsk/toolkits 0.0.11 → 0.0.12

package/dist/toolkits/zoho/tools/get-related-records.js

@@ -0,0 +1,38 @@
+// @ts-nocheck
+import { tool } from 'ai';
+import { z } from 'zod';
+import { zohoFetch } from './utils.js';
+export const ZohoGetRelatedRecords = tool({
+    description: 'Fetch related-list records (e.g., Notes, Attachments, Emails) for a Zoho CRM parent record using related_list_api_name. Use ZOHO_GET_RELATED_LISTS first to discover the correct api_name for the related list you want to access. Supports pagination for large result sets (up to 2,000 records with page/',
+    inputSchema: z.object({
+        zohoToken: z.string().describe('Zoho OAuth access token (Zoho-oauthtoken).'),
+        ids: z.string().optional().describe('Comma-separated list of specific related record IDs to retrieve. Use this to fetch only certain related records instead of all related records. Example: \'4876876000000636001,4876876000000636002\''),
+        page: z.number().int().min(1).optional().describe('Page number to retrieve (default: 1). Without page_token, only the first 2,000 records are accessible using page/per_page pagination. Maximum page number is floor(2000/per_page). Do not use together w'),
+        fields: z.string().min(1).describe('Comma-separated API names of the fields to retrieve (required by Zoho for this API). Specify the field names from the related list module whose details you want to receive. Example: \'Note_Title,Note_'),
+        sort_by: z.string().optional().describe('Valid fields for sorting related records.'),
+        per_page: z.number().int().min(1).max(200).optional().describe('Number of records per page (default and maximum: 200). Applies to both page and page_token pagination.'),
+        converted: z.string().optional().describe('Filter for converted status (applicable to certain related lists).'),
+        record_id: z.string().describe('The unique identifier of the parent record for which to retrieve related records. This is the ID of the record in the specified module.'),
+        page_token: z.string().optional().describe('Token-based pagination parameter to fetch records beyond the 2,000-record discrete limit. Use the info.next_page_token from the previous response. Cannot be used together with page.'),
+        sort_order: z.string().optional().describe('Sort order for related records.'),
+        module_api_name: z.string().describe('The API name of the parent module containing the record. Examples: \'Leads\', \'Contacts\', \'Accounts\', \'Deals\', \'Tasks\', etc. This must be a valid module API name in Zoho CRM.'),
+        related_list_api_name: z.string().describe('The API name of the related list to retrieve (e.g., \'Notes\', \'Attachments\', \'Emails\'). IMPORTANT: Use the ZOHO_GET_RELATED_LISTS action first to discover the correct api_name for the related lis'),
+    }),
+    execute: async (params) => {
+        const { zohoToken, ...rest } = params;
+        if (!zohoToken)
+            return { error: 'Zoho token is required. Connect Zoho CRM first.' };
+        try {
+            const p = rest;
+            const path = `/${p.module_api_name}/${p.record_id}/${p.related_list_api_name}`;
+            const res = await zohoFetch(path, { zohoToken, method: 'GET', query: p });
+            if (!res.ok)
+                return { error: 'Failed', details: res.data };
+            return res.data;
+        }
+        catch (e) {
+            return { error: 'Error in ZohoGetRelatedRecords', message: e instanceof Error ? e.message : 'Unknown error' };
+        }
+    },
+});
+//# sourceMappingURL=get-related-records.js.map

package/dist/toolkits/zoho/tools/get-task.d.ts

@@ -0,0 +1,6 @@
+export declare const ZohoGetTask: import("ai").Tool<{
+    zohoToken: string;
+    record_id: string;
+    fields?: string | undefined;
+}, any>;
+//# sourceMappingURL=get-task.d.ts.map

package/dist/toolkits/zoho/tools/get-task.js

@@ -0,0 +1,34 @@
+// @ts-nocheck
+import { tool } from 'ai';
+import { z } from 'zod';
+import { zohoFetch } from './utils.js';
+export const ZohoGetTask = tool({
+    description: 'Retrieves a specific task record by its ID from Zoho CRM. Returns complete task data including all standard and custom fields, subforms, and multi-user lookup fields that are only available when fetching individual records. Use this action when you need to fetch detailed information about a single t',
+    inputSchema: z.object({
+        zohoToken: z.string().describe('Zoho OAuth access token (Zoho-oauthtoken).'),
+        fields: z.string().optional().describe('Comma-separated API names of the fields to retrieve (max 50). If not specified, all standard fields are returned. Common task fields: Subject, Description, Due_Date, Status, Priority, Owner, Who_Id, W'),
+        record_id: z.string().describe('The unique identifier of the task to retrieve.'),
+    }),
+    execute: async (params) => {
+        const { zohoToken, ...rest } = params;
+        if (!zohoToken)
+            return { error: 'Zoho token is required. Connect Zoho CRM first.' };
+        try {
+            const p = rest;
+            const path = `/Tasks/${p.record_id}`;
+            const query = {};
+            if (p.fields)
+                query.fields = p.fields;
+            if (p.module_api_name)
+                query.module = p.module_api_name;
+            const res = await zohoFetch(path, { zohoToken, method: 'GET', query });
+            if (!res.ok)
+                return { error: 'Failed to get', details: res.data };
+            return res.data;
+        }
+        catch (e) {
+            return { error: 'Error in ZohoGetTask', message: e instanceof Error ? e.message : 'Unknown error' };
+        }
+    },
+});
+//# sourceMappingURL=get-task.js.map

package/dist/toolkits/zoho/tools/get-user.d.ts

@@ -0,0 +1,5 @@
+export declare const ZohoGetUser: import("ai").Tool<{
+    user_id: string;
+    zohoToken: string;
+}, any>;
+//# sourceMappingURL=get-user.d.ts.map

package/dist/toolkits/zoho/tools/get-user.js

@@ -0,0 +1,33 @@
+// @ts-nocheck
+import { tool } from 'ai';
+import { z } from 'zod';
+import { zohoFetch } from './utils.js';
+export const ZohoGetUser = tool({
+    description: 'Retrieves a specific user from Zoho CRM by their user ID. Returns detailed user information including name, email, role, profile, status, and preferences. Use this action when you need to fetch information about a specific user by ID, or use \'me\' as the user_id to get the currently authenticated u',
+    inputSchema: z.object({
+        zohoToken: z.string().describe('Zoho OAuth access token (Zoho-oauthtoken).'),
+        user_id: z.string().describe('The unique identifier of the user to retrieve. This can be the user\'s ID from the Zoho CRM system or the special value \'me\' to retrieve the currently authenticated user\'s information.'),
+    }),
+    execute: async (params) => {
+        const { zohoToken, ...rest } = params;
+        if (!zohoToken)
+            return { error: 'Zoho token is required. Connect Zoho CRM first.' };
+        try {
+            const p = rest;
+            const path = `/users/${p.user_id}`;
+            const query = {};
+            if (p.fields)
+                query.fields = p.fields;
+            if (p.module_api_name)
+                query.module = p.module_api_name;
+            const res = await zohoFetch(path, { zohoToken, method: 'GET', query });
+            if (!res.ok)
+                return { error: 'Failed to get', details: res.data };
+            return res.data;
+        }
+        catch (e) {
+            return { error: 'Error in ZohoGetUser', message: e instanceof Error ? e.message : 'Unknown error' };
+        }
+    },
+});
+//# sourceMappingURL=get-user.js.map

package/dist/toolkits/zoho/tools/get-zoho-records.d.ts

@@ -0,0 +1,13 @@
+export declare const ZohoGetZohoRecords: import("ai").Tool<{
+    zohoToken: string;
+    module_api_name: string;
+    page?: number | undefined;
+    per_page?: number | undefined;
+    ids?: string | undefined;
+    page_token?: string | undefined;
+    fields?: string | undefined;
+    sort_by?: string | undefined;
+    sort_order?: string | undefined;
+    cvid?: number | undefined;
+}, any>;
+//# sourceMappingURL=get-zoho-records.d.ts.map

package/dist/toolkits/zoho/tools/get-zoho-records.js

@@ -0,0 +1,59 @@
+// @ts-nocheck
+import { tool } from 'ai';
+import { z } from 'zod';
+import { zohoFetch } from './utils.js';
+export const ZohoGetZohoRecords = tool({
+    description: 'Retrieves records from a specified module in Zoho CRM. Notes: - Discrete (page/per_page) pagination is limited to the first 2,000 records. To retrieve records beyond this, use token-based pagination via page_token from the previous response\'s info.next_page_token. - Do not use page together with pa',
+    inputSchema: z.object({
+        zohoToken: z.string().describe('Zoho OAuth access token (Zoho-oauthtoken).'),
+        ids: z.string().optional().describe('Comma-separated record IDs to fetch specific records. Note: This parameter is ignored when page_token is provided.'),
+        cvid: z.number().int().optional().describe('Custom view ID to filter the records. Cannot be used together with sort_by. Note: This parameter is ignored when page_token is provided.'),
+        page: z.number().int().min(1).optional().describe('Page number to retrieve. Without page_token, only the first 2,000 records are accessible using page/per_page. Maximum page number is floor(2000/per_page). Do not use together with page_token.'),
+        fields: z.string().min(1).optional().describe('Comma-separated API names of the fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Field names are module-specific. Common fields: First_Name, Last_Name, Em'),
+        sort_by: z.string().optional().describe('Valid fields for sorting Zoho CRM records.'),
+        per_page: z.number().int().optional().describe('Number of records per page (default and max is 200). Applies to both page and page_token pagination.'),
+        page_token: z.string().optional().describe('Token-based pagination parameter to fetch records beyond the 2,000-record discrete limit. Use the info.next_page_token from the previous response. Cannot be used together with page.'),
+        sort_order: z.string().optional().describe('Sort order for records.'),
+        module_api_name: z.string().describe('The API name of the module to retrieve records from. Common supported modules: Leads, Contacts, Accounts, Deals, Tasks, Events, Calls, Products, Quotes, Sales_Orders, Purchase_Orders, Invoices, Campai'),
+    }),
+    execute: async (params) => {
+        const { zohoToken, ...rest } = params;
+        if (!zohoToken)
+            return { error: 'Zoho token is required. Connect Zoho CRM first.' };
+        try {
+            const p = rest;
+            const path = `/${p.module_api_name}`;
+            const query = {};
+            if (p.fields)
+                query.fields = p.fields;
+            if (p.page)
+                query.page = p.page;
+            if (p.per_page)
+                query.per_page = p.per_page;
+            if (p.per_page)
+                query.per_page = p.per_page;
+            if (p.sort_by)
+                query.sort_by = p.sort_by;
+            if (p.sort_order)
+                query.sort_order = p.sort_order;
+            if (p.cvid)
+                query.cvid = p.cvid;
+            if (p.page_token)
+                query.page_token = p.page_token;
+            if (p.approved)
+                query.approved = p.approved;
+            if (p.territoryId)
+                query.territory_id = p.territoryId;
+            if (p.includeChild !== undefined)
+                query.include_child = p.includeChild;
+            const res = await zohoFetch(path, { zohoToken, method: 'GET', query });
+            if (!res.ok)
+                return { error: 'Failed to list', details: res.data };
+            return res.data;
+        }
+        catch (e) {
+            return { error: 'Error in ZohoGetZohoRecords', message: e instanceof Error ? e.message : 'Unknown error' };
+        }
+    },
+});
+//# sourceMappingURL=get-zoho-records.js.map

package/dist/toolkits/zoho/tools/get-zoho-users.d.ts

@@ -0,0 +1,9 @@
+export declare const ZohoGetZohoUsers: import("ai").Tool<{
+    zohoToken: string;
+    type?: string | undefined;
+    page?: number | undefined;
+    per_page?: number | undefined;
+    ids?: string | undefined;
+    if_modified_since?: string | undefined;
+}, any>;
+//# sourceMappingURL=get-zoho-users.d.ts.map

package/dist/toolkits/zoho/tools/get-zoho-users.js

@@ -0,0 +1,32 @@
+// @ts-nocheck
+import { tool } from 'ai';
+import { z } from 'zod';
+import { zohoFetch } from './utils.js';
+export const ZohoGetZohoUsers = tool({
+    description: 'Tool to retrieve users from Zoho CRM. Use when you need to fetch user information such as IDs, names, emails, roles, or status for setting Owner fields or performing user-related operations in CRM workflows.',
+    inputSchema: z.object({
+        zohoToken: z.string().describe('Zoho OAuth access token (Zoho-oauthtoken).'),
+        ids: z.string().optional().describe('Comma-separated list of user IDs to retrieve specific users. Maximum of 100 user IDs can be specified at once.'),
+        page: z.number().int().min(1).optional().describe('Page number to retrieve for paginated results. Default is 1.'),
+        type: z.string().optional().describe('The type of users to retrieve. Supported values: \'AllUsers\' (all users including inactive), \'ActiveUsers\' (only active users), \'DeactiveUsers\' (only deactivated users), \'ConfirmedUsers\' (users'),
+        per_page: z.number().int().min(1).max(200).optional().describe('Number of users to retrieve per page. Maximum is 200. Default is 200.'),
+        if_modified_since: z.string().optional().describe('Retrieve users modified after this timestamp. Use ISO 8601 format (e.g., \'2024-01-15T10:00:00+00:00\'). This will be sent as the \'If-Modified-Since\' header to the API.'),
+    }),
+    execute: async (params) => {
+        const { zohoToken, ...rest } = params;
+        if (!zohoToken)
+            return { error: 'Zoho token is required. Connect Zoho CRM first.' };
+        try {
+            const p = rest;
+            const path = `/users`;
+            const res = await zohoFetch(path, { zohoToken, method: 'GET', query: p });
+            if (!res.ok)
+                return { error: 'Failed', details: res.data };
+            return res.data;
+        }
+        catch (e) {
+            return { error: 'Error in ZohoGetZohoUsers', message: e instanceof Error ? e.message : 'Unknown error' };
+        }
+    },
+});
+//# sourceMappingURL=get-zoho-users.js.map