cloud-elements-zoho-crm v0.1.0

{element-name}

{ElementName} - JavaScript client for {element-name} This SDK is automatically generated by the Swagger Codegen project:

• API version: api-v2
• Package version: api-v2
• Build date: 2016-04-26T11:48:17.170-06:00
• Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install {element-name} --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/YOUR_GIT_REPO_ID then install it via:

npm install YOUR_USERNAME/YOUR_GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var {ElementName} = require('{element-name}');

var api = new {ElementName}.ZohocrmApi()

var authorization = "authorization_example"; // {String} The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

var opts = { 
  'where': "where_example", // {String} The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query. For example, to search for accounts last modified on or after 'Jan 15, 2014', the search expression will be <i>where=lastModifiedDate>='2014-01-15T00:00:00.000Z'</i>. When this parameter is omitted, all accounts are returned in a paginated fashion.
  'includeDeleted': true, // {Boolean} Specify if deleted accounts should be included in the search.
  'page': 789, // {Integer} The start page for pagination, which defaults to 1 if not supplied
  'pageSize': 789 // {Integer} The page size for pagination, which defaults to 200 if not supplied
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.accountsGET(authorization, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://console.cloud-elements.com/elements/api-v2/hubs/crm

Documentation for Models

• {ElementName}.Account
• {ElementName}.Calls
• {ElementName}.Campaign
• {ElementName}.Contact
• {ElementName}.Events
• {ElementName}.Lead
• {ElementName}.Notes
• {ElementName}.NotesPOST
• {ElementName}.Opportunity
• {ElementName}.Product
• {ElementName}.Tasks
• {ElementName}.User

Documentation for Authorization

All endpoints do not require authorization.