@zohocrm/typescript-sdk-2.0

v7.0.0

Published

2 years ago

TypeScript SDK for Zoho CRM

Downloads

1,933

0High
0Medium
0Low

zohocrm

Node Zoho CRM OAuth2 API Typescript TS

ZOHO CRM TYPESCRIPT SDK - 2.0

Overview

Zoho CRM TypeScript SDK offers a way to create client TypeScript applications that can be integrated with Zoho CRM.

Registering a Zoho Client

Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app:

Visit this page https://api-console.zoho.com/
Click ADD CLIENT.
Choose the Client Type.
Enter Client Name, Client Domain or Homepage URL and Authorized Redirect URIs then click CREATE.
Your Client app will be created.
Select the created OAuth client.
Generate grant token by providing the necessary scopes, time duration (the duration for which the generated token is valid) and Scope Description.

Note:

For Contact Roles and Records API, you will need to provide the ZohoCRM.settings.fields.ALL scope along with the ZohoCRM.modules.ALL scope while generating the OAuthtoken. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error
For Related Records API, the scopes required for generating OAuthtoken are ZohoCRM.modules.ALL, ZohoCRM.settings.fields.ALL, and ZohoCRM.settings.related_lists.ALL. Otherwise, the system returns the OAUTH-SCOPE-MISMATCH error

Environmental Setup

TypeScript SDK is installable through npm. npm is a tool for dependency management in TypeScript. SDK expects the following from the client app:

Client app must have Node(version 12 and above)
TypeScript SDK must be installed in the client app through npm.

Including the SDK in your project

Install Node from nodejs.org (if not installed).
Install TypeScript NPM package.
```
npm install -g typescript
```
Install TypeScript SDK
- Navigate to the workspace of your client app.
- Run the command below:
```
npm install @zohocrm/typescript-sdk-2.0
```
The TypeScript SDK will be installed and a package named @zohocrm/typescript-sdk-2.0 will be created in the local machine.
Another method to install the SDK:
- Add dependencies to the package.json of the node server with the latest version (recommended)
- Run npm install in the directory which installs all the dependencies mentioned in package.json.

Token Persistence

Token persistence refers to storing and utilizing the authentication tokens that are provided by Zoho. There are three ways provided by the SDK in which persistence can be utilized. They are DataBase Persistence, File Persistence and Custom Persistence.

Implementing OAuth Persistence

Once the application is authorized, OAuth access and refresh tokens can be used for subsequent user data requests to Zoho CRM. Hence, they need to be persisted by the client app.

The persistence is achieved by writing an implementation of the inbuilt TokenStore Class, which has the following callback methods.

getToken(user : UserSignature, token : Token) - invoked before firing a request to fetch the saved tokens. This method should return implementation Token Class object for the library to process it.
saveToken(user: UserSignature, token : Token) - invoked after fetching access and refresh tokens from Zoho.
deleteToken(token : Token) - invoked before saving the latest tokens.
getTokens() - The method to retrieve all the stored tokens.
deleteTokens() - The method to delete all the stored tokens.
getTokenById(id, token) - The method to retrieve the user's token details based on unique ID.

Note:

id is a string.
user is an instance of UserSignature.
token is an instance of Token interface.

DataBase Persistence

In case the user prefers to use default DataBase persistence, MySQL can be used.

The database name should be zohooauth.
There must be a table name oauthtoken with columns.
- id varchar(255)
- user_mail varchar(255)
- client_id varchar(255)
- client_secret varchar(255)
- refresh_token varchar(255)
- access_token varchar(255)
- grant_token varchar(255)
- expiry_time varchar(20)
- redirect_url varchar(255)

Note:

Custom database name and table name can be set in DBStore instance.

MySQL Query

CREATE TABLE oauthtoken (
  id varchar(255) NOT NULL,
  user_mail varchar(255) NOT NULL,
  client_id varchar(255),
  client_secret varchar(255),
  refresh_token varchar(255),
  access_token varchar(255),
  grant_token varchar(255),
  expiry_time varchar(20),
  redirect_url varchar(255),
  primary key (id)
);

Create DBStore object

import {DBBuilder} from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_builder";

/*
* hostName -> DataBase host name. Default value "localhost"
* databaseName -> DataBase name. Default  value "zohooauth"
* userName -> DataBase user name. Default value "root"
* password -> DataBase password. Default value ""
* portNumber -> DataBase port number. Default value "3306"
* tableName -> Table Name. Default value "oauthtoken"
*/
let tokenstore: DBStore = new DBStore().build();

let tokenstore: DBStore = new DBBuilder()
.host("hostName")
.databaseName("databaseName")
.userName("userName")
.portNumber("portNumber")
.tableName("tableName")
.password("password")
.build();

File Persistence

In case of default File Persistence, the user can persist tokens in the local drive, by providing the the absolute file path to the FileStore object.

The File contains
- id
- user_mail
- client_id
- client_secret
- refresh_token
- access_token
- grant_token
- expiry_time
- redirect_url

Create FileStore object

import {FileStore} from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/file_store";
/*
 * FileStore takes the following parameter
 * 1 -> Absolute file path of the file to persist tokens
*/
let tokenstore: FileStore = new FileStore("/Users/username/Documents/ts_sdk_tokens.txt");

Custom Persistence

To use Custom Persistence, you must extend TokenStore Class (@zohocrm/typescript-sdk-2.0/models/authenticator/store/token_store) and override the methods.

import { TokenStore } from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/token_store";

export class CustomStore implements TokenStore {

    constructor(){
    }

    /**
     *
     * @param {UserSignature} user A UserSignature class instance.
     * @param {Token} token A Token (@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_token) class instance.
     * @returns A Token class instance representing the user token details.
     * @throws {SDKException} if any error occurs.
     */
    async getToken(user: UserSignature, token: Token): Promise<Token | undefined> {
        // Add code to get the token
        return undefined;
    }

    /**
     *
     * @param {UserSignature} user A UserSignature class instance.
     * @param {Token} token A Token (@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_token) class instance.
     * @throws {SDKException} if any error occurs.
     */
    async saveToken(user: UserSignature, token: Token): Promise<void>{
        // Add code to save the token
    }

    /**
     *
     * @param {Token} token A Token (@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_token) class instance.
     * @throws {SDKException} if any error occurs.
     */
    async deleteToken(token: Token): Promise<void> {
        // Add code to delete the token
    }

    /**
     * @returns {Array} - An array of Token class instances
     * @throws {SDKException}
     */
    async getTokens(): Promise<Array<Token> | undefined> {
        //Add code to retrieve all the stored tokens.
    }

    /**
     * @throws {SDKException}
     */
    deleteTokens(): void {
        //Add code to delete all the stored tokens.
    }

    /**
     * This method is used to retrieve the user token details based on unique ID
     * @param {String} id - A String representing the unique ID
     * @param {Token} token - A Token class instance.
     * @return {Token} A Token class instance representing the user token details.
     * @throws SDKException
     */
    getTokenById(id: string, token: Token): Promise<Token | undefined> {
      // Add code to get the token using unique id
    }
}

Configuration

Before you get started with creating your TypeScript application, you need to register your client and authenticate the app with Zoho.

| Mandatory Keys | Optional Keys | | :---------------- | :------------ | | user | logger | | environment | tokenstore | | token | sdkConfig | | | requestProxy | | | resourcePath |

Create an instance of UserSignature Class that identifies the current user.

import {UserSignature} from "@zohocrm/typescript-sdk-2.0/routes/user_signature"
//Create an UserSignature instance that takes user Email as parameter
let user: UserSignature = new UserSignature("[email protected]");

Configure API environment which decides the domain and the URL to make API calls.

import {USDataCenter} from "@zohocrm/typescript-sdk-2.0/routes/dc/us_data_center"
/*
 * Configure the environment
 * which is of the pattern Domain.Environment
 * Available Domains: USDataCenter, EUDataCenter, INDataCenter, CNDataCenter, AUDataCenter
 * Available Environments: PRODUCTION(), DEVELOPER(), SANDBOX()
*/
let environment: Environment = USDataCenter.PRODUCTION();

Create an instance of OAuthToken with the information that you get after registering your Zoho client.

import { OAuthToken } from "@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_token"
import { OAuthBuilder } from "@zohocrm/typescript-sdk-2.0/models/authenticator/oauth_builder"
  
/*
* Create a Token instance that requires the following
* clientId -> OAuth client id.
* clientSecret -> OAuth client secret.
* refreshToken -> REFRESH token.
* accessToken -> Access token.
* grantToken -> GRANT token.
* id -> User unique id.
* redirectURL -> OAuth redirect URL.
*/
//Create a Token instance
// if refresh token is available
// The SDK throws an exception, if the given id is invalid.
let token: OAuthToken = new OAuthBuilder()
.id("id")
.build();

// if grant token is available
let token: OAuthToken = new OAuthBuilder()
.clientId("clientId")
.clientSecret("clientSecret")
.grantToken("grantToken")
.redirectURL("redirectURL")
.build();
  
// if ID (obtained from persistence) is available
let token: OAuthToken = new OAuthBuilder()
.clientId("clientId")
.clientSecret("clientSecret")
.refreshToken("refreshToken")
.redirectURL("redirectURL")
.build();

// if access token is available
let token: OAuthToken = new OAuthBuilder()
.accessToken("accessToken")
.build();

Create an instance of Logger Class to log exception and API information. By default, the SDK constructs a Logger instance with level - INFO and file_path - (sdk_logs.log parallel to node_modules)

import {Levels,Logger} from "@zohocrm/typescript-sdk-2.0/routes/logger/logger"
import {LogBuilder} from "@zohocrm/typescript-sdk-2.0/routes/logger/log_builder"
/*
* 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/node_sdk_logs.log")
.build();

Create an instance of TokenStore to persist tokens, used for authenticating all the requests. By default, the SDK creates the sdk_tokens.txt file (parallel to node_modules folder) to persist the tokens.

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 {DBBuilder} from "@zohocrm/typescript-sdk-2.0/models/authenticator/store/db_builder";
  
/*
* hostName -> DataBase host name. Default value "localhost"
* databaseName -> DataBase name. Default  value "zohooauth"
* userName -> DataBase user name. Default value "root"
* password -> DataBase password. Default value ""
* portNumber -> DataBase port number. Default value "3306"
* tableName -> Table Name. Default value "oauthtoken"
*/
let tokenstore: DBStore = new DBStore().build();

let tokenstore: DBStore = new DBBuilder()
.host("hostName")
.databaseName("databaseName")
.userName("userName")
.portNumber("portNumber")
.tableName("tableName")
.password("password")
.build();

//let tokenstore: FileStore = new FileStore("/Users/userName/tssdk-tokens.txt")

Create an instance of SDKConfig containing the SDK configuration.

import {SDKConfig} from "@zohocrm/typescript-sdk-2.0/routes/sdk_config";
import {SDKConfigBuilder} from "@zohocrm/typescript-sdk-2.0/routes/sdk_config_builder";

/*
 * By default, the SDK creates the SDKConfig instance
 * autoRefreshFields (default - 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(utils/util/module_fields_handler.ts)
 *
 * pickListValidation (default - 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
 */
let sdkConfig: SDKConfig = new SDKConfigBuilder().pickListValidation(false).autoRefreshFields(true).build();

Create an instance of RequestProxy containing the proxy properties of the user.

import { RequestProxy} from "@zohocrm/typescript-sdk-2.0/routes/request_proxy"
import { ProxyBuilder} from "@zohocrm/typescript-sdk-2.0/routes/proxy_builder"

/*
 * RequestProxy class takes the following parameters
 * host -> Host
 * port -> Port Number
 * user -> User Name. Default null.
 * password -> Password. Default null
 */
let requestProxy: RequestProxy = new ProxyBuilder()
.host("proxyHost")
.port("proxyPort")
.user("proxyUser")
.password("password")
.build();

The path containing the absolute directory path to store user specific files containing module fields information. By default, the SDK stores the user-specific files in a folder parallel to node_modules
```
let resourcePath: string = "/Users/user_name/Documents/typescript-app";
```

Initializing the Application

Initialize the SDK using the following code.

    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";

    export class Initializer {

        public static async initialize() {

            /*
            * 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 user: UserSignature = new UserSignature("[email protected]");

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

           /*
            * Create a Token instance that requires the following
            * clientId -> OAuth client id.
            * clientSecret -> OAuth client secret.
            * refreshToken -> REFRESH token.
            * grantToken -> GRANT token.
            * id -> User unique id.
            * redirectURL -> OAuth redirect URL.
            */
            // if ID (obtained from persistence) is available
            let token: OAuthToken= new OAuthBuilder()
            .clientId("clientId")
            .clientSecret("clientSecret")
            .refreshToken("refreshToken")
            .redirectURL("redirectURL")
            .build();

            /*
            * hostName -> DataBase host name. Default value "localhost"
            * databaseName -> DataBase name. Default  value "zohooauth"
            * userName -> DataBase user name. Default value "root"
            * password -> DataBase password. Default value ""
            * portNumber -> DataBase port number. Default value "3306"
            * tableName -> Table Name. Default value "oauthtoken"
            */
            let tokenstore: DBStore = 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/ts_sdk_tokens.txt");

            /*
            * 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 file(s) or refresh the fields using methods from ModuleFieldsHandler(utils/util/module_fields_handler.js)
            * 
            * 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.
            * 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
            */
            let sdkConfig: SDKConfig = new SDKConfigBuilder().pickListValidation(false).autoRefreshFields(true).build();

            /*
            * The path containing the absolute directory path to store user specific JSON files containing module fields information.
            */
            let resourcePath: string = "/Users/user_name/tsssdk-application";

            /*
            * RequestProxy class takes the following parameters
            * host -> Host
            * port -> Port Number
            * user -> User Name. Default null.
            * password -> Password. Default null
            */
            let requestProxy: 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
            */
            await (await new InitializeBuilder())
                .user(user)
                .environment(environment)
                .token(token)
                .store(tokenstore)
                .SDKConfig(sdkConfig)
                .resourcePath(resourcePath)
                .logger(logger)
                .initialize().catch(err => { console.log(err) });
        }
    }

    Initializer.initialize()

You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK.

Class Hierarchy

classdiagram

Responses and Exceptions

All SDK method calls return an instance of APIResponse.

After a successful API request, the getObject() method returns an instance of the ResponseWrapper (for GET) or the ActionWrapper (for POST, PUT, DELETE).

Whenever the API returns an error response, the getObject() returns an instance of APIException class.

ResponseWrapper (for GET requests) and ActionWrapper (for POST, PUT, DELETE requests) are the expected objects for Zoho CRM APIs’ responses

However, some specific operations have different expected objects, such as the following

Operations involving records in Tags
- RecordActionWrapper
Getting Record Count for a specific Tag operation
- CountWrapper
Operations involving BaseCurrency
- BaseCurrencyActionWrapper
Lead convert operation
- ConvertActionWrapper
Retrieving Deleted records operation
- DeletedRecordsWrapper
Record image download operation
- FileBodyWrapper
MassUpdate record operations
- MassUpdateActionWrapper
- MassUpdateResponseWrapper

GET Requests

The getObject() returns instance of one of the following classes, based on the return type.
- For application/json responses
  - ResponseWrapper
  - CountWrapper
  - DeletedRecordsWrapper
  - MassUpdateResponseWrapper
  - APIException
- For file download responses
  - FileBodyWrapper
  - APIException

POST, PUT, DELETE Requests

The getObject() returns instance of one of the following classes
- ActionWrapper
- RecordActionWrapper
- BaseCurrencyActionWrapper
- MassUpdateActionWrapper
- ConvertActionWrapper
- APIException
These wrapper classes may contain one or an array of instances of the following classes, depending on the response
- SuccessResponse Class, if the request was successful.
- APIException Class, if the request was erroneous.

For example, when you insert two records, and one of them was inserted successfully while the other one failed, the ActionWrapper will contain one instance each of the SuccessResponse and APIException classes.

All other exceptions such as SDK anomalies and other unexpected behaviours are thrown under the SDKException class.

Multi-User support in the TypeScript SDK

The TypeScript SDK (from version 1.x.x) supports both single-user and multi-user app.

Multi-user App

Multi-users functionality is achieved using Initializer's static switchUser() method.

await (await new InitializeBuilder())
    .user(user)
    .environment(environment)
    .token(token)
    .SDKConfig(sdkConfig)
    .switchUser().catch(err => { console.log(err) });

To Remove a user's configuration in SDK. Use the below code

await Initializer.removeUserConfiguration(user, environment)

Sample Multi-user code

    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() {
            try {
            /*
                * 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("[email protected]");

                /*
                * 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();

                /*
                * 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 store: DBStore = new DBBuilder().build();

                // 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: FileStore = new FileStore("/Users/username/ts_sdk_tokens.txt");

                /*
                * 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 file(s) or refresh the fields using methods from ModuleFieldsHandler(utils/util/module_fields_handler.ts)
                *
                * 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
                */
                let sdkConfig: SDKConfig = new SDKConfigBuilder().pickListValidation(false).autoRefreshFields(true).build();

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

                /*
                * 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
                */
                await (await new InitializeBuilder())
                    .user(user1)
                    .environment(environment1)
                    .token(token1)
                    .store(store)
                    .SDKConfig(sdkConfig)
                    .resourcePath(resourcePath)
                    .logger(logger)
                    .initialize().catch(err => { console.log(err) });

                await SampleRecord.getRecords("Leads");

                await Initializer.removeUserConfiguration(user1, environment1);

                let user2: UserSignature = new UserSignature("[email protected]");

                let environment2: Environment = EUDataCenter.SANDBOX();

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

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

                await(await new InitializeBuilder())
                .user(user2)
                .environment(environment2)
                .token(token2)
                .SDKConfig(sdkConfig2)
                .switchUser().catch(err => { console.log(err) });;

                await SampleRecord.getRecords("Leads");
            } catch (error) {
                console.log(error);
            }
        }

        static async getRecords(moduleAPIName: string) {
            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<ResponseHandler> = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
                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 the 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 Record instances
                            let records: Record[] = responseObject.getData();
                            for (let record of records) {

                                //Get the ID of each Record
                                console.log("Record ID: " + record.getId());
                                //Get the createdBy User instance of each Record
                                let createdBy = record.getCreatedBy();
                                //Check if createdBy is not null
                                if(createdBy != null)
                                {
                                    //Get the ID of the createdBy User
                                    console.log("Record Created By User-ID: " + createdBy.getId());
                                    //Get the name of the createdBy User
                                    console.log("Record Created By User-Name: " + createdBy.getName());
                                    //Get the Email of the createdBy User
                                    console.log("Record Created By User-Email: " + createdBy.getEmail());
                                }
                                //Get the CreatedTime of each Record
                                console.log("Record CreatedTime: " + record.getCreatedTime());
                                //Get the modifiedBy User instance of each Record
                                let modifiedBy = record.getModifiedBy();
                                //Check if modifiedBy is not null
                                if(modifiedBy != null){
                                    //Get the ID of the modifiedBy User
                                    console.log("Record Modified By User-ID: " + modifiedBy.getId());
                                    //Get the name of the modifiedBy User
                                    console.log("Record Modified By User-Name: " + modifiedBy.getName());
                                    //Get the Email of the modifiedBy User
                                    console.log("Record Modified By User-Email: " + modifiedBy.getEmail());
                                }
                                //Get the ModifiedTime of each Record
                                console.log("Record ModifiedTime: " + record.getModifiedTime());
                                //Get the list of Tag instance each Record
                                let tags: Tag[] = record.getTag();
                                //Check if tags is not null
                                if(tags != null){
                                    tags.forEach(tag => {
                                        //Get the Name of each Tag
                                        console.log("Record Tag Name: " + tag.getName());
                                        //Get the Id of each Tag
                                        console.log("Record Tag ID: " + tag.getId());
                                    });
                                }
                                //To get particular field value
                                console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName

                                console.log("Record KeyValues: " );
                                let keyValues: Map<string,any> = record.getKeyValues();
                                let keyArray: string[] = Array.from(keyValues.keys());
                                for (let keyName of keyArray) {
                                    let value: any = keyValues.get(keyName);
                                    console.log(keyName + " : " + value);
                                }
                            }
                        }
                    }
                }
            } catch (error) {
                console.log(error);
            }
        }
    }

    SampleRecord.call();

The program execution starts from call().
The details of "user1" are is given in the variables user1, token1, environment1.
Similarly, the details of another user "user2" is given in the variables user2, token2, environment2.
The switchUser() function is used to switch between the "user1" and "user2" as required.
Based on the latest switched user, the SampleRecord.getRecords(moduleAPIName) will fetch records.

SDK Sample code

    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(){
            try{
                let user: UserSignature = new UserSignature("[email protected]");

                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";

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

                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<ResponseHandler> = await recordOperations.getRecords(moduleAPIName, paramInstance, headerInstance);
                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 the 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 Record instances
                            let records: Record[] = responseObject.getData();
                            for (let record of records) {

                                //Get the ID of each Record
                                console.log("Record ID: " + record.getId());
                                //Get the createdBy User instance of each Record
                                let createdBy = record.getCreatedBy();
                                //Check if createdBy is not null
                                if(createdBy != null)
                                {
                                    //Get the ID of the createdBy User
                                    console.log("Record Created By User-ID: " + createdBy.getId());
                                    //Get the name of the createdBy User
                                    console.log("Record Created By User-Name: " + createdBy.getName());
                                    //Get the Email of the createdBy User
                                    console.log("Record Created By User-Email: " + createdBy.getEmail());
                                }
                                //Get the CreatedTime of each Record
                                console.log("Record CreatedTime: " + record.getCreatedTime());
                                //Get the modifiedBy User instance of each Record
                                let modifiedBy = record.getModifiedBy();
                                //Check if modifiedBy is not null
                                if(modifiedBy != null){
                                    //Get the ID of the modifiedBy User
                                    console.log("Record Modified By User-ID: " + modifiedBy.getId());
                                    //Get the name of the modifiedBy User
                                    console.log("Record Modified By User-Name: " + modifiedBy.getName());
                                    //Get the Email of the modifiedBy User
                                    console.log("Record Modified By User-Email: " + modifiedBy.getEmail());
                                }
                                //Get the ModifiedTime of each Record
                                console.log("Record ModifiedTime: " + record.getModifiedTime());
                                //Get the list of Tag instance each Record
                                let tags: Tag[] = record.getTag();
                                //Check if tags is not null
                                if(tags != null){
                                    tags.forEach(tag => {
                                        //Get the Name of each Tag
                                        console.log("Record Tag Name: " + tag.getName());
                                        //Get the Id of each Tag
                                        console.log("Record Tag ID: " + tag.getId());
                                    });
                                }
                                //To get particular field value
                                console.log("Record Field Value: " + record.getKeyValue("Last_Name"));// FieldApiName

                                console.log("Record KeyValues: " );
                                let keyValues: Map<string,any> = record.getKeyValues();
                                let keyArray: string[] = Array.from(keyValues.keys());
                                for (let keyName of keyArray) {
                                    let value: any = keyValues.get(keyName);
                                    console.log(keyName + " : " + value);
                                }
                            }
                        }
                    }
                }
            } catch (error) {
                console.log(error);
            }
        }
    }

    SampleRecord.getRecords();

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

ZOHO CRM TYPESCRIPT SDK - 2.0

Table Of Contents

Overview

Registering a Zoho Client

Note:

Environmental Setup

Including the SDK in your project

Token Persistence

Table of Contents

Implementing OAuth Persistence

DataBase Persistence

MySQL Query

Create DBStore object

File Persistence

Create FileStore object

Custom Persistence

Configuration

| Mandatory Keys | Optional Keys | | :---------------- | :------------ | | user | logger | | environment | tokenstore | | token | sdkConfig | | | requestProxy | | | resourcePath |

Initializing the Application

Class Hierarchy

Responses and Exceptions

GET Requests

POST, PUT, DELETE Requests

Multi-User support in the TypeScript SDK

Multi-user App

Sample Multi-user code

SDK Sample code