Zoho CRM Developer

https://www.zoho.com/crm/developer/docs
Admin
Zoho CRM Developer provides documentation, APIs, SDKs, and tools for developers to extend,...
Tokens:3,888,296
Snippets:24,031
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Sample Multi-user Implementation

Source: https://www.zoho.com/crm/developer/docs/typescript-sdk/v2/multiuser.html

A comprehensive example showing the setup of logger, user signature, environment, and OAuth token for a multi-user environment.

```typescript
import { UserSignature } from "@zohocrm/typescript-sdk-2.0/routes/user_signature"
import { SDKConfigBuilder } from "@zohocrm/typescript-sdk-2.0/routes/sdk_config_builder"
import { DBStore } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_store"
import { DBBuilder } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_builder"
import { FileStore } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/file_store"
import { SDKConfig } from "@zohocrm/typescript-sdk-2.0/routes/sdk_config"
import { Levels, Logger } from "@zohocrm/typescript-sdk-2.0/routes/logger/logger"
import { LogBuilder } from "@zohocrm/typescript-sdk-2.0/routes/logger/log_builder"
import { Environment } from "@zohocrm/typescript-sdk-2.0/routes/dc/environment"
import { USDataCenter } from "@zohocrm/typescript-sdk-2.0/routes/dc/us_data_center"
import { EUDataCenter } from "@zohocrm/typescript-sdk-2.0/routes/dc/eu_data_center"
import { OAuthToken } from "@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_token"
import { OAuthBuilder } from "@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_builder"
import { InitializeBuilder } from "@zohocrm/typescript-sdk-2.0/routes/initialize_builder"
import { Initializer } from "@zohocrm/typescript-sdk-2.0/routes/initializer"
import { RequestProxy } from "@zohocrm/typescript-sdk-2.0/routes/request_proxy"

import { RecordOperations, GetRecordsHeader, GetRecordsParam } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record_operations";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/response_wrapper";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/response_handler";
import { Record } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import { Tag } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";

import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { SDKException } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/exception/sdk_exception";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { HeaderMap } from "@zohocrm/typescript-sdk-2.0/routes/header_map";
class SampleRecord {

    public static async call() {

           /*
            * Create an instance of Logger Class that takes two parameters
            * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
            * filePath -> Absolute file path, where messages need to be logged.
            */
            let logger: Logger= new LogBuilder()
            .level(Levels.INFO)
            .filePath("/Users/user_name/Documents/ts_sdk_log.log")
            .build();

            /*
            * Create an UserSignature instance that takes user Email as parameter
            */
            let user1 = new UserSignature("abc@zoho.com");

            /*
            * Configure the environment
            * which is of the pattern Domain.Environment
            * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
            * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
            */
            let environment1: Environment = USDataCenter.PRODUCTION();

            /*
            * Create a Token instance
            * clientId -> OAuth client id.
            * clientSecret -> OAuth client secret.
            * grantToken -> OAuth Grant Token. 
            * refreshToken -> OAuth Refresh Token token.
            * redirectURL -> OAuth Redirect URL.
            */
            let token1: OAuthToken = new OAuthBuilder()
            .clientId("clientId")
            .clientSecret("clientSecret")
            .refreshToken("refreshToken")
            .redirectURL("redirectURL")
            .build();
```

--------------------------------

### Initialize a new widget project

Source: https://www.zoho.com/crm/developer/docs/widgets/create-widget.html

Run this command to create a new project structure after installing the Zoho CLI.

```bash
zet init
```

--------------------------------

### Install ZDK CLI

Source: https://www.zoho.com/crm/developer/docs/zdk-cli/quick-start.html

Use this command to install the ZDK CLI globally on your system. If installation fails, try using sudo.

```bash
npm install -g @zohocrm/zdk-cli
```

--------------------------------

### Check Node.js and NPM versions

Source: https://www.zoho.com/crm/developer/docs/zdk-cli/quick-start.html

Run these commands in your terminal to verify that Node.js and NPM are installed on your system.

```bash
node -v
npm -v
```

--------------------------------

### Initialize the widget

Source: https://www.zoho.com/crm/developer/docs/widgets/create-widget.html

This code initializes the widget and enables it to start listening to events within the CRM application.

```javascript
ZOHO.embeddedApp.init()
```

--------------------------------

### .zdkignore file example

Source: https://www.zoho.com/crm/developer/docs/zdk-cli/directory-structure.html

Specifies files or directories to ignore during zdk org:push, zdk:org:push:result, and zdk org:status commands. Supports file paths and regex patterns.

```text
                        crm/meta/roles/Manager.roles-meta.json
```

--------------------------------

### Pull specific metadata configuration

Source: https://www.zoho.com/crm/developer/docs/zdk-cli/directory-structure.html

A detailed meta.json configuration example specifying individual resources to pull, including profiles, roles, modules, fields, layouts, and widgets.

```json
        {
          "resource_type": "specific",
          "resources": [
            {
              "resource_type": "profiles",
              "resources": [
                {
                  "api_name": "*"
                }
              ]
            },
            {
              "resource_type": "roles",
              "resources": [
                {
                  "api_name": "*"
                }
              ]
            },
            {
              "resource_type": "modules",
              "resources": [
                {
                  "api_name": "Accounts"
                }
              ]
            },
            {
              "resource_type": "fields",
              "resources": [
                {
                  "api_name": "Accounts.Account_Name"
                }
              ]
            },
            {
              "resource_type": "layouts",
              "resources": [
                {
                  "api_name": "Accounts.*"
                }
              ]
            },
            {
              "resource_type": "widgets",
              "resources": [
                {
                  "api_name": "Maps"
                }
              ]
            }
          ]
        }
```

--------------------------------

### Get a Variable by its ID

Source: https://www.zoho.com/crm/developer/docs/typescript-sdk/v2/variables-samples.html?src=create_variables

This example demonstrates how to use the getVariableById method to retrieve details of a specific variable by its unique ID. It includes handling for successful responses and API exceptions.

```typescript
import {DeleteVariablesParam,GetVariableByIDParam,GetVariableForAPINameParam,GetVariablesParam,VariablesOperations} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/variables_operations";
import {ActionHandler} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/action_handler";
import {ActionResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/action_response";
import {SuccessResponse} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/success_response";
import {ActionWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/action_wrapper";
import {APIException} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/api_exception";
import {BodyWrapper} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/body_wrapper";
import { ParameterMap } from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import { APIResponse } from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
import { ResponseHandler } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/response_handler";
import { ResponseWrapper } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/response_wrapper";
import { Variable } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variables/variable";
import { VariableGroup } from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/variable_groups/variable_group";

export class Variables{

    /**
     * Get Variable By Id
   * This method is used to get the details of any specific variable.
   * Specify the unique ID of the variable in your API request to get the data for that particular variable group.
     * @param variableId The ID of the Variable to be obtained
     */
    public static async getVariableById(variableId: bigint) {

        //Get instance of VariablesOperations Class
        let variablesOperations: VariablesOperations = new VariablesOperations();

        //Get instance of ParameterMap Class
        let paramInstance: ParameterMap = new ParameterMap();

        /* Possible parameters of Get Variable By ID operation */
        // await paramInstance.add(GetVariableByIDParam.GROUP, "34770613089001");

        //Call getVariableByGroupId method that takes paramInstance and variableId as parameter
        let response: APIResponse = await variablesOperations.getVariableById(variableId, paramInstance);

        if (response != null) {

            //Get the status code from response
            console.log("Status Code: " + response.getStatusCode());

            if ([204, 304].includes(response.getStatusCode())) {
                console.log(response.getStatusCode() == 204 ? "No Content" : "Not Modified");

                return;
            }

            //Get object from response
            let responseObject: ResponseHandler = response.getObject();

            if (responseObject != null) {

                //Check if expected ResponseWrapper instance is received
                if (responseObject instanceof ResponseWrapper) {

                    //Get the array of obtained Variable instances
                    let variables: Variable[] = responseObject.getVariables();

                    variables.forEach(variable => {

                        //Get the ID of each Variable
                        console.log("Variable ID: " + variable.getId());
```

--------------------------------

### Get Record from Leads Module via cURL

Source: https://www.zoho.com/crm/developer/docs/api/v8/gdpr-compliance.html

Example of a GET request to retrieve a record, including the private_fields parameter to access protected fields.

```bash
curl "https://www.zohoapis.com/crm/v8/Leads/111111000000034001?include=private_fields"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

--------------------------------

### Initialize SDK Configuration

Source: https://www.zoho.com/crm/developer/docs/javascript-sdk/v2/responses.html

Example showing how to configure the logger, environment, OAuth token, and SDK settings.

```javascript
class Record {
    static async call() {
        /*
         * Create an instance of Logger Class that takes parameter
         * 1 -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
        */
        let logger = Logger.getInstance(Levels.ALL);

        /*
         * Configure the environment
         * which is of the pattern Domain.Environment
         * Available Domains: US, EU, IN, CN, AU, JP
         * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        */
        let environment = DataCenter.US.PRODUCTION();

        /*
         * Create a Token instance
         * clientId -> OAuth client id.
         * scope -> OAuth client scope.
         * redirectURL -> OAuth Redirect URL.
         */
        let token = new OAuthBuilder()
            .clientId("clientId")
            .scope("scope")
            .redirectURL("redirectURL")
            .build();

        /*
          * autoRefreshFields
          * if true - all the modules' fields will be auto-refreshed in the background, every hour.
          * if false - the fields will not be auto-refreshed in the background. The user can manually delete the cache or refresh the fields using methods from ModuleFieldsHandler
          *
          * cacheStore
          * A boolean field that allows or disallows the storage of module field information in cache.
          * True - the SDK stores all the modules' field information in cache, and refreshes every hour, if autoRefreshFields is true.
          * False - the SDK temporarily stores the modules' field information in a Map.
          *
          * pickListValidation
          * A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
          * True - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
          * False - the SDK does not validate the input and makes the API request with the user’s input to the pick list
          *
          * timeout
          * representing the number of milliseconds a request can take before automatically being terminated.
        */
        let sdkConfig = new SDKConfigBuilder()
        .autoRefreshFields(true)
        .pickListValidation(false)
        .cacheStore(true)
        .build();
```

--------------------------------

### Get Bulk Read Job Details Setup

Source: https://www.zoho.com/crm/developer/docs/scala-sdk/v2/bulk-read-samples.html?src=download_result

Initial setup and imports required for the Bulkread object to retrieve bulk read job details.

```scala
package com.zoho.crm.sample.bulkread

import java.io.File
import java.io.FileOutputStream
import java.io.InputStream
import java.io.OutputStream
import java.lang.reflect.Field
import java.util

import com.zoho.crm.api.bulkread.APIException
import com.zoho.crm.api.bulkread.ActionHandler
import com.zoho.crm.api.bulkread.ActionResponse
import com.zoho.crm.api.bulkread.ActionWrapper
import com.zoho.crm.api.bulkread.BulkReadOperations
import com.zoho.crm.api.bulkread.CallBack
import com.zoho.crm.api.bulkread.Criteria
import com.zoho.crm.api.bulkread.FileBodyWrapper
import com.zoho.crm.api.bulkread.JobDetail
import com.zoho.crm.api.bulkread.Query
import com.zoho.crm.api.bulkread.RequestWrapper
import com.zoho.crm.api.bulkread.ResponseHandler
import com.zoho.crm.api.bulkread.ResponseWrapper
import com.zoho.crm.api.bulkread.Result
import com.zoho.crm.api.bulkread.SuccessResponse
import com.zoho.crm.api.util.Choice
import com.zoho.crm.api.util.APIResponse
import com.zoho.crm.api.util.Model
import com.zoho.crm.api.util.StreamWrapper

import scala.collection.mutable.ArrayBuffer


object Bulkread {
  /**
   *  Get BulkRead Job Details
```

--------------------------------

### Initialize SDK and Fetch Records

Source: https://www.zoho.com/crm/developer/docs/python-sdk/v2/python-multiuser.html

This example demonstrates how to configure the SDK environment, authentication, and logging, followed by an API call to retrieve records from the Leads module.

```python
from datetime import datetime
from zcrmsdk.src.com.zoho.crm.api.user_signature import UserSignature
from zcrmsdk.src.com.zoho.crm.api.dc import USDataCenter
from zcrmsdk.src.com.zoho.api.authenticator.store import DBStore
from zcrmsdk.src.com.zoho.api.logger import Logger
from zcrmsdk.src.com.zoho.crm.api.initializer import Initializer
from zcrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken
from zcrmsdk.src.com.zoho.crm.api.record import *
from zcrmsdk.src.com.zoho.crm.api import HeaderMap, ParameterMap
from zcrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig


class Record(object):

    def __init__(self):
        pass

    @staticmethod
    def get_records():

        """
        Create an instance of Logger Class that takes two parameters
        1 -> Level of the log messages to be logged. Can be configured by typing Logger.Levels "." and choose any level from the list displayed.
        2 -> Absolute file path, where messages need to be logged.
        """
        logger = Logger.get_instance(level=Logger.Levels.INFO,
                                     file_path="/Users/user_name/Documents/python_sdk_log.log")

        # Create an UserSignature instance that takes user Email as parameter
        user = UserSignature(email="abc@zoho.com")

        """
        Configure the environment
        which is of the pattern Domain.Environment
        Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        """
        environment = USDataCenter.PRODUCTION()

        """
        Create a Token instance that takes the following parameters
        1 -> OAuth client id.
        2 -> OAuth client secret.
        3 -> Grant token.
        4 -> Refresh token.
        5 -> OAuth redirect URL.
        6 -> id
        """
        token = OAuthToken(client_id="clientId", client_secret="clientSecret", grant_token="grant_token", refresh_token="refresh_token", redirect_url="redirectURL", id="id")

        """
        Create an instance of TokenStore
        1 -> DataBase host name. Default value "localhost"
        2 -> DataBase name. Default value "zohooauth"
        3 -> DataBase user name. Default value "root"
        4 -> DataBase password. Default value ""
        5 -> DataBase port number. Default value "3306"
        6 -> DataBase table name . Default value "oauthtoken"
        """
        store = DBStore()

        """
        auto_refresh_fields (Default value is False)
            if True - all the modules' fields will be auto-refreshed in the background, every hour.
            if False - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler(zcrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py)

        pick_list_validation (Default value is True)
            A boolean field that validates user input for a pick list field and allows or disallows the addition of a new value to the list.
            if True - the SDK validates the input. If the value does not exist in the pick list, the SDK throws an error.
            if False - the SDK does not validate the input and makes the API request with the user’s input to the pick list
         connect_timeout (Default value is None) 
            A  Float field to set connect timeout
  
         read_timeout (Default value is None) 
            A  Float field to set read timeout
         """
        config = SDKConfig(auto_refresh_fields=True, pick_list_validation=False, connect_timeout=None, read_timeout=None)

        """
        The path containing the absolute directory path (in the key resource_path) to store user-specific files containing information about fields in modules. 
        """
        resource_path = '/Users/user_name/Documents/python-app'

        """
        Call the static initialize method of Initializer class that takes the following arguments
        1 -> UserSignature instance
        2 -> Environment instance
        3 -> Token instance
        4 -> TokenStore instance
        5 -> SDKConfig instance
        6 -> resource_path
        7 -> Logger instance
        """
        Initializer.initialize(user=user, environment=environment, token=token, store=store, sdk_config=config, resource_path=resource_path, logger=logger)

        try:
            module_api_name = 'Leads'

            param_instance = ParameterMap()

            param_instance.add(GetRecordsParam.converted, 'both')

            param_instance.add(GetRecordsParam.cvid, '12712717217218')

            header_instance = HeaderMap()

            header_instance.add(GetRecordsHeader.if_modified_since, datetime.now())

            response = RecordOperations().get_records(module_api_name, param_instance, header_instance)

            if response is not None:
```

--------------------------------

### Sample Multi-user SDK Initialization

Source: https://www.zoho.com/crm/developer/docs/nodejs-sdk/v2/nodejs-multiuser.html

A comprehensive example showing how to configure the logger, user signature, environment, OAuth token, and token store for the SDK.

```javascript
const UserSignature = require( "@zohocrm/nodejs-sdk-2.0/routes/user_signature").UserSignature;
const USDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/us_data_center").USDataCenter;
const EUDataCenter = require( "@zohocrm/nodejs-sdk-2.0/routes/dc/eu_data_center").EUDataCenter;
const {RecordOperations, GetRecordsHeader, GetRecordsParam} = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/record_operations");
const ParameterMap = require("@zohocrm/nodejs-sdk-2.0/routes/parameter_map").ParameterMap;
const HeaderMap = require("@zohocrm/nodejs-sdk-2.0/routes/header_map").HeaderMap;
const ResponseWrapper = require("@zohocrm/nodejs-sdk-2.0/core/com/zoho/crm/api/record/response_wrapper").ResponseWrapper;
const InitializeBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/initialize_builder").InitializeBuilder;
const Initializer = require("@zohocrm/nodejs-sdk-2.0/routes/initializer").Initializer;
const OAuthBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/oauth_builder").OAuthBuilder;
const Levels = require("@zohocrm/nodejs-sdk-2.0/routes/logger/logger").Levels;
const LogBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/logger/log_builder").LogBuilder;
const DBBuilder = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/db_builder").DBBuilder;
const FileStore = require("@zohocrm/nodejs-sdk-2.0/models/authenticator/store/file_store").FileStore;
const SDKConfigBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/sdk_config_builder").SDKConfigBuilder;
const ProxyBuilder = require("@zohocrm/nodejs-sdk-2.0/routes/proxy_builder").ProxyBuilder;

class Record {
    static async call() {
        /*
         * Create an instance of Logger Class that takes two parameters
         * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
         * filePath -> Absolute file path, where messages need to be logged.
         */
        let logger = new LogBuilder()
        .level(Levels.INFO)
        .filePath("/Users/user_name/Documents/node_sdk_log.log")
        .build();
    
        /*
        * Create an UserSignature instance that takes user Email as parameter
        */
        let user = new UserSignature("abc@zoho.com");

        /*
        * Configure the environment
        * which is of the pattern Domain.Environment
        * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
        */
        let environment1 = USDataCenter.PRODUCTION();

        /*
        * Create a Token instance
        * clientId -> OAuth client id.
        * clientSecret -> OAuth client secret.
        * grantToken -> OAuth Grant Token. 
        * refreshToken -> OAuth Refresh Token token.
        * redirectURL -> OAuth Redirect URL.
        */
        let token1 = new OAuthBuilder()
        .clientId("clientId")
        .clientSecret("clientSecret")
        .refreshToken("refreshToken")
        .redirectURL("redirectURL")
        .build();

        /*
        * Create an instance of TokenStore.
        * host -> DataBase host name. Default "localhost"
        * databaseName -> DataBase name. Default "zohooauth"
        * userName -> DataBase user name. Default "root"
        * password -> DataBase password. Default ""
        * portNumber -> DataBase port number. Default "3306"
        * tableName -> DataBase table name. Default "oauthtoken"
        */
        let tokenstore = new DBBuilder()
        .host("hostName")
        .databaseName("databaseName")
        .userName("userName")
        .portNumber("portNumber")
        .tableName("tableName")
        .password("password")
        .build();

        /*
        * Create an instance of FileStore that takes absolute file path as parameter
        */
        // let store = new FileStore("/Users/userName/Desktop/nodejs_sdk_tokens.txt");
```

--------------------------------

### Connection Call

Source: https://www.zoho.com/crm/developer/docs/functions/language-guide/zrc.html

Example of configuring a connection and performing a GET request to the CRM.

```text
config = RequestConfig()  
config.set_base_url('https://www.crm.zoho.com')  
config.set_headers({'Content-Type': 'application/json'})  
config.set_connection("zohocrm") # connection name  
response = ZRC.get('/crm/v2/Leads', config)
```

--------------------------------

### Get Notes Sample Request

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-notes.html

Examples of how to retrieve notes using cURL and Deluge.

```curl
curl "https://www.zohoapis.com/crm/v8/Notes?fields=Parent_Id,Owner,Created_Time,Note_Title"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
```

```deluge
response = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/Notes?fields=Owner,Created_Time,Note_Title"
	type: GET
	connection:"crm_oauth_connection"
];
info response;
```

--------------------------------

### SDK Sample Code Initialization

Source: https://www.zoho.com/crm/developer/docs/scala-sdk/v2/threading.html

Basic setup for the SDK including Logger, UserSignature, and Environment configuration.

```scala
package com.zoho.crm.sample.threading.multiuser;
package com.zoho.crm.main

import com.zoho.api.authenticator.Token
import com.zoho.api.authenticator.store.DBStore
import com.zoho.api.authenticator.store.TokenStore
import com.zoho.api.authenticator.OAuthToken
import com.zoho.crm.api.HeaderMap
import com.zoho.crm.api.Initializer
import com.zoho.crm.api.ParameterMap
import com.zoho.crm.api.SDKConfig
import com.zoho.crm.api.UserSignature
import com.zoho.crm.api.dc.DataCenter.Environment
import com.zoho.crm.api.dc.USDataCenter
import com.zoho.api.logger.Logger
import com.zoho.api.logger.Logger.Levels
import com.zoho.crm.api.exception.SDKException
import com.zoho.crm.api.record.RecordOperations
import com.zoho.crm.api.record.APIException
import com.zoho.crm.api.record.ResponseHandler
import com.zoho.crm.api.record.ResponseWrapper
import com.zoho.crm.api.tags.Tag
import com.zoho.crm.api.record.RecordOperations.GetRecordsHeader
import com.zoho.crm.api.record.RecordOperations.GetRecordsParam
import com.zoho.crm.api.util.APIResponse

import java.time.OffsetDateTime
import java.time.ZoneOffset
import java.util

object Record {
  @throws[SDKException]
  def main(args: Array[String]): Unit = {
    /*
      * Create an instance of Logger Class that takes two parameters
      * level -> Level of the log messages to be logged. Can be configured by typing Levels "." and choose any level from the list displayed.
      * filePath -> Absolute file path, where messages need to be logged.
    */
    val loggerInstance = new Logger.Builder()
      .level(Logger.Levels.ALL)
      .filePath("/Users/user_name/Documents/scala-sdk-logs.log")
      .build

    //Create an UserSignature instance that takes user Email as parameter
    val user = new UserSignature("abc@zoho.com")

    /*
      * Configure the environment
      * which is of the pattern Domain.Environment
      * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
      * Available Environments: PRODUCTION, DEVELOPER, SANDBOX
    */
    val environment = USDataCenter.PRODUCTION
```

--------------------------------

### Querying with Subquery

Source: https://www.zoho.com/crm/developer/docs/api/v8/COQL-subquery.html

Example of using a subquery to retrieve contact records where the account name starts with 'A'.

```json
{
"select_query" : "select Full_Name from Contacts where Account_Name in (select id from Accounts where Account_Name like 'A%') LIMIT 2000"
}
```

--------------------------------

### Initialize SDK for Multiple Users

Source: https://www.zoho.com/crm/developer/docs/nodejs-sdk/v2/nodejs-multiuser.html

Configures the SDK with user-specific settings and initializes the environment. This example demonstrates setting up the first user and then switching to a second user context.

```javascript
/*
* A Boolean value to allow or prevent auto-refreshing of the modules' fields in the background.
* if true - all the modules' fields will be auto-refreshed in the background whenever there is any change.
* if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or the specific module's fields using methods from ModuleFieldsHandler
*/
let sdkConfig1 = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

/*
* The path containing the absolute directory path to store user specific JSON files containing module fields information. 
*/
let resourcePath = "/Users/user_name/Documents/nodejs-app";

// let requestProxy = new ProxyBuilder()
// .host("proxyHost")
// .port("proxyPort")
// .user("proxyUser")
// .password("password")
// .build();
/*
* Call the static initialize method of Initializer class that takes the following arguments
* user -> UserSignature instance
* environment -> Environment instance
* token -> Token instance
* store -> TokenStore instance
* SDKConfig -> SDKConfig instance
* resourcePath -> resourcePath
* logger -> Logger instance
*/
try {
    (await new InitializeBuilder())
        .user(user1)
        .environment(environment1)
        .token(token1)
        .store(tokenstore)
        .SDKConfig(sdkConfig1)
        .resourcePath(resourcePath)
        .logger(logger)
        .initialize();
} catch (error) {
    console.log(error);
}

await Record.getRecords("Leads");

await Initializer.removeUserConfiguration(user1, environment1);

let user2 = new UserSignature("abc2@zoho.eu");

let environment2 = EUDataCenter.SANDBOX();

let token2 = = new OAuthBuilder()
.clientId("clientId")
.clientSecret("clientSecret")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();

let sdkConfig2 = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

(await new InitializeBuilder())
.user(user2)
.environment(environment2)
.token(token2)
.SDKConfig(sdkConfig2)
.switchUser();

await Record.getRecords("Leads");
```

--------------------------------

### Querying with JOIN

Source: https://www.zoho.com/crm/developer/docs/api/v8/COQL-subquery.html

Example of using a JOIN to retrieve contact records where the account name starts with 'A'.

```json
{
 "select_query" : "select Full_Name from Contacts where Account_Name.Account_Name like 'A%' limit 2000"
}
```

--------------------------------

### Initialize the SDK

Source: https://www.zoho.com/crm/developer/docs/ruby-sdk/v3/initialize.html

This code demonstrates how to set up the SDK by configuring logging, user signature, environment, authentication token, token storage, SDK configuration, and optional request proxy settings before calling the Initializer.initialize method.

```ruby
require 'ZOHOCRMSDK2_0'

class Initialize
    def self.initialize() 
        # Create an instance of Log::SDKLog Class that takes two parameters
        #1 -> Level of the log messages to be logged. Can be configured by typing Levels "::" and choose any level from the list displayed.
        # 2 -> Absolute file path, where messages need to be logged.
        
        log = ZOHOCRMSDK::SDKLog::Log.initialize(level:Levels::INFO, path:"/Users/user_name/Documents/rubysdk_log.log")

        #Create an UserSignature instance that takes user Email as parameter
        user_signature = ZOHOCRMSDK::UserSignature.new('abc@zohocorp.com')

        
        # Configure the environment
        # which is of the pattern Domain.Environment
        # Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
        # Available Environments: PRODUCTION, DEVELOPER, SANDBOX
        
        environment = ZOHOCRMSDK::DC::USDataCenter.PRODUCTION

         #Create a Token instance
         #1 -> OAuth client id.
         #2 -> OAuth client secret.
         #3 -> grant token
         #4 -> refresh token
         #5 -> OAuth redirect URL.
         #6 -> id 
    
    
        token = ZOHOCRMSDK::Authenticator::OAuthToken.new(client_id: "clientId", client_secret:"clientSecret", grant_token:"grant_token", refresh_token:"refresh_token", redirect_url:"redirectURL", id:"id")

        #Create an instance of TokenStore.
        #1 -> DataBase host name. Default "localhost"
        #2 -> DataBase name. Default "zohooauth"
        #3 -> DataBase user name. Default "root"
        #4 -> DataBase password. Default ""
        #5 -> DataBase port number. Default "3306"

        tokenstore = ZOHOCRMSDK::Store::DBStore.new(host: "host_name", database_name: "database_name", table_name: "table_name", user_name: "user_name",password: "password", port_number:"port_number")

        #tokenstore = ZOHOCRMSDK::Store::FileStore.new("/Users/user_name/Documents/ruby_sdk_token.txt"


        # auto_refresh_fields
        # if true - all the modules' fields will be auto-refreshed in the background, every    hour.
        # if false - the fields will not be auto-refreshed in the background. The user can manually delete the file(s) or refresh the fields using methods from ModuleFieldsHandler (Util::ModuleFieldsHandler)
        #
        # pickListValidation
        # if true - value for any picklist field will be validated with the available values.
        # if false - value for any picklist field will not be validated, resulting in creation of a new value.
        #
        # open_timeout
        # Number of seconds to wait for the connection to open (default 60 seconds)
        # 
        # read_timeout
        # Number of seconds to wait for one block to be read (via one read(2) call) (default 60 seconds)
        # 
        # write_timeout
        # Number of seconds to wait for one block to be written (via one write(2) call) (default 60 seconds)
        # 
        # keep_alive_timeout
        # Seconds to reuse the connection of the previous request(default 2 seconds)
        # 
        
        sdk_config = ZOHOCRMSDK::SDKConfig.new(auto_refresh_fields: false, pick_list_validation: true, open_timeout: 60, read_timeout: 60, write_timeout: 60, keep_alive_timeout: 2)

        resource_path = "/Users/user_name/Documents/rubysdk-application"
        
        # Create an instance of RequestProxy class that takes the following parameters
        # 1 -> Host
        # 2 -> Port Number
        # 3 -> User Name
        # 4 -> Password
        
        request_proxy = ZOHOCRMSDK::RequestProxy.new(host:"proxyHost", post:"proxyPort", user_name:"proxyUser", password:"password")

        
        # The initialize method of Initializer class that takes the following arguments
        # 1 -> UserSignature instance
        # 2 -> Environment instance
        # 3 -> Token instance
        # 4 -> TokenStore instance
        # 5 -> SDKConfig instance
        # 6 -> resourcePath - A String
        # 7 -> Log instance (optional)
        # 8 -> RequestProxy instance (optional)

        #The following is the initialize method

        ZOHOCRMSDK::Initializer.initialize(user: user_signature, environment: environment, token: token, store: tokenstore, sdk_config: sdk_config, resources_path: resource_path,log:log,request_proxy: request_proxy)
    end
end
```

--------------------------------

### Java SDK Initialization and API Trigger Sample

Source: https://www.zoho.com/crm/developer/docs/pathfinder/sdk.html

Example demonstrating how to initialize the SDK with the US Production DataCenter and execute an API trigger with various parameter types.

```java
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.util.Calendar;
import java.util.Date;
import com.zoho.Initializer;
import com.zoho.Param;
import com.zoho.ParameterMap;
import com.zoho.crm.apitrigger.APIGET;
import com.zoho.crm.apitrigger.ApiTriggerOperations;
import com.zoho.crm.apitrigger.ApiTriggerOperations.GetAPIParam;
import com.zoho.dc.DataCenter.Environment;
import com.zoho.dc.USDataCenter;
import com.zoho.util.APIResponse;

public class MainClass {
	
	public static void main(String args[]) throws Exception {
		new Initializer.Builder()
		.environment(USDataCenter.PRODUCTION)
		.initialize();
		
		ApiTriggerOperations primaryOperations = new ApiTriggerOperations();
		ParameterMap paramInstance = new ParameterMap();
		paramInstance.add(GetAPIParam.PROCESSNAME, "sdkprocess");
		paramInstance.add(GetAPIParam.STATENAME, "state1");
		paramInstance.add(GetAPIParam.DIGESTKEY, "641xxxe64a");
		paramInstance.add(GetAPIParam.IDENTIFIER1, "test11");
		paramInstance.add(GetAPIParam.IDENTIFIER2, "test2");
		paramInstance.add(GetAPIParam.IDENTIFIER3, "test3");
		paramInstance.add(GetAPIParam.IDENTIFIER4, "test4");
		paramInstance.add(GetAPIParam.IDENTIFIER5, "test5");
		paramInstance.add(new Param<String>("stringparam", null), "ak2");
		OffsetDateTime datetimeParam = OffsetDateTime.of(2022, 11, 15, 11, 00, 00, 01, ZoneOffset.of("+05:30"));
		paramInstance.add(new Param<OffsetDateTime>("datetimeparam", null), datetimeParam);
		paramInstance.add(new Param<Integer>("integerparam", null), 10);
		paramInstance.add(new Param<Boolean>("booleanparam", null), true);
		LocalDate date = LocalDate.of(2022,10,15);
		paramInstance.add(new Param<LocalDate>("dateparam", null), date);
		APIResponse<APIGET> apiResponse = primaryOperations.getAPITriggerWithParam(paramInstance);
	}
}
```

--------------------------------

### Sample Response JSON

Source: https://www.zoho.com/crm/developer/docs/api/v8/get-users.html

A partial example of the JSON structure returned by the Get Users API.

```json
{
    "users": [
        {
            "country": "US",
            "name_format__s": "Salutation,First Name,Last Name",
            "language": "en_US",
            "microsoft": false,
            "$shift_effective_from": null,
            "id": "5725767000000411001",
            "state": "Karnataka",
            "fax": null,
            "country_locale": "en_US",
            "sandboxDeveloper": false,
            "zip": null,
            "decimal_separator": "Period",
            "created_time": "2023-04-12T02:08:05-07:00",
            "time_format": "hh:mm a",
            "offset": -28800000,
            "profile": {
                "name": "Administrator",
                "id": "5725767000000026011"
            },
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "zuid": "808233918"
```

--------------------------------

### Get Field Metadata Setup

Source: https://www.zoho.com/crm/developer/docs/python-sdk/v2/fields-samples.html?src=get_fields

Initializes the Field class structure for retrieving field metadata.

```python
from zcrmsdk.src.com.zoho.crm.api.fields import *
from zcrmsdk.src.com.zoho.crm.api import ParameterMap
class Field(object):
    @staticmethod
    def get_field(module_api_name, field_id):
```

--------------------------------

### SDK Multi-user Initialization and Record Retrieval

Source: https://www.zoho.com/crm/developer/docs/typescript-sdk/v2/multiuser.html

This example demonstrates initializing the SDK with user credentials and fetching records. It includes the necessary imports and the setup of the SampleRecord class.

```typescript
import { UserSignature } from "@zohocrm/typescript-sdk-2.0/routes/user_signature"
import { SDKConfigBuilder } from "@zohocrm/typescript-sdk-2.0/routes/sdk_config_builder"
import { DBStore } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_store"
import { FileStore } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/file_store"
import { SDKConfig } from "@zohocrm/typescript-sdk-2.0/routes/sdk_config"
import { Levels, Logger } from "@zohocrm/typescript-sdk-2.0/routes/logger/logger"
import { LogBuilder } from "@zohocrm/typescript-sdk-2.0/routes/logger/log_builder"
import { Environment } from "@zohocrm/typescript-sdk-2.0/routes/dc/environment"
import { USDataCenter } from "@zohocrm/typescript-sdk-2.0/routes/dc/us_data_center"
import { OAuthBuilder } from "@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_builder"
import { InitializeBuilder } from "@zohocrm/typescript-sdk-2.0/routes/initialize_builder"
import { RequestProxy } from "@zohocrm/typescript-sdk-2.0/routes/request_proxy"
import { ProxyBuilder } from "@zohocrm/typescript-sdk-2.0/routes/proxy_builder"
import { DBBuilder } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_builder";

import {RecordOperations, GetRecordsHeader, GetRecordsParam} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record_operations";
import {ParameterMap} from "@zohocrm/typescript-sdk-2.0/routes/parameter_map";
import {HeaderMap} from "@zohocrm/typescript-sdk-2.0/routes/header_map";
import {ResponseWrapper} from  "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/response_wrapper";
import {ResponseHandler} from  "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/response_handler";
import {Record} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/record/record";
import {Tag} from "@zohocrm/typescript-sdk-2.0/core/com/zoho/crm/api/tags/tag";

import {APIResponse} from "@zohocrm/typescript-sdk-2.0/routes/controllers/api_response";
class SampleRecord {

    public static async getRecords(){

            let user: UserSignature = new UserSignature("abc@zoho.com");

            let myLogger: Logger = new LogBuilder()
            .level(Levels.INFO)
            .filePath("/Users/user_name/Documents/ts_sdk_log.log")
            .build();

            let dc: Environment = USDataCenter.PRODUCTION();

            let sdkConfig: SDKConfig = new SDKConfigBuilder().autoRefreshFields(false).pickListValidation(true).build();

            let store: FileStore = new FileStore("/Users/username/Documents/ts_sdk_tokens.txt");

            let token: OAuthToken= new OAuthBuilder()
            .clientId("clientId")
            .clientSecret("clientSecret")
            .refreshToken("refreshToken")
            .redirectURL("redirectURL")
            .build();

            let path: string = "/Users/user_name/Documents/ts-app";

            try {
            (await new InitializeBuilder())
                .user(user)
                .environment(dc)
                .token(token)
                .store(store)
                .SDKConfig(sdkConfig)
                .resourcePath(path)
                .logger(myLogger)
                .initialize();
            } catch (error) {
                console.log(error);
            }

            try {
                let moduleAPIName = "Leads";
                //Get instance of RecordOperations Class
                let recordOperations: RecordOperations = new RecordOperations();
                let paramInstance: ParameterMap = new ParameterMap();
                await paramInstance.add(GetRecordsParam.APPROVED, "both");
                let headerInstance: HeaderMap  = new HeaderMap();
                await headerInstance.add(GetRecordsHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T00:00:00+05:30"));
                //Call getRecords method that takes paramInstance, headerInstance and moduleAPIName as parameters
                let response: APIResponse = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
                if(response != null){
```

--------------------------------

### Configure Get Record Parameters and Headers

Source: https://www.zoho.com/crm/developer/docs/nodejs-sdk/v2/record-samples.html?src=get_photo

Demonstrates how to initialize parameter and header instances for the getRecord method, including commented-out examples of optional configurations.

```javascript
/* Possible parameters for Get Record operation*/
        // await paramInstance.add(GetRecordParam.APPROVED, "true");

        // await paramInstance.add(GetRecordParam.CONVERTED, "false");

        // await paramInstance.add(GetRecordParam.CVID, "34096430087501");

        let fieldsArray = ["id", "Company"];

        // await paramInstance.add(GetRecordParam.FIELDS, fieldsArray.toString());

        /* Month is zero-indexed. 
        0 -> January ..... 11 -> December
        */
        // let startDateTime = new Date(2020,7,10,10,10,10);

        // await paramInstance.add(GetRecordParam.STARTDATETIME, startDateTime);

        // let endDateTime = new Date(2020,7,10,12,12,12);

        // await paramInstance.add(GetRecordParam.ENDDATETIME, endDateTime);

        // await paramInstance.add(GetRecordParam.TERRITORY_ID, "34096430505351");

        // await paramInstance.add(GetRecordParam.INCLUDE_CHILD, "true");

        // await paramInstance.add(GetRecordParam.UID, "34096430500741");

        //Get instance of HeaderMap Class
        let headerInstance = new HeaderMap();

        /* Possible headers for Get Record operation*/
        // await headerInstance.add(GetRecordHeader.IF_MODIFIED_SINCE, new Date("2020-01-01T01:01:01+05:30"));

        // await headerInstance.add(GetRecordHeader.X_EXTERNAL, "Leads.External");
```

--------------------------------

### Get Record Using External ID

Source: https://www.zoho.com/crm/developer/docs/python-sdk/v2/record-samples.html?src=get_photo

Initial setup for retrieving a record using an external ID.

```python
import os
from datetime import date, datetime
```
Tokens:
Raw