cloud-elements-zoho-crm

v0.1.0

Published

2 years ago

Client library of the Cloud Elements Zoho CRM Element

Downloads

0High
0Medium
0Low

nuralphonso

{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 &lt;token&gt;, User &lt;user secret&gt;'

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

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- {ElementName}.ZohocrmApi | accountsGET | GET /accounts | Find accounts in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all accounts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | accountsPOST | POST /accounts | Create a new account in the CRM system. Account creation will flow through Cloud Elements to your CRM service. With the exception of the 'ACCOUNTID' field, the required fields indicated in the 'Account' model are those required to create a new account. {ElementName}.ZohocrmApi | accountsaccountIdnotesGET | GET /accounts/{accountId}/notes | List notes for an account {ElementName}.ZohocrmApi | accountsaccountIdnotesPOST | POST /accounts/{accountId}/notes | Create a note for an account {ElementName}.ZohocrmApi | accountsaccountIdnotesnoteIdDELETE | DELETE /accounts/{accountId}/notes/{noteId} | Delete a note for an account {ElementName}.ZohocrmApi | accountsaccountIdnotesnoteIdGET | GET /accounts/{accountId}/notes/{noteId} | Retrieve a note for an account {ElementName}.ZohocrmApi | accountsaccountIdnotesnoteIdPATCH | PATCH /accounts/{accountId}/notes/{noteId} | Update a note for an account {ElementName}.ZohocrmApi | accountsidDELETE | DELETE /accounts/{id} | Delete an account associated with a given ACCOUNTID from your CRM system.\nSpecifying an account associated with a given ACCOUNTID that does not exist will result in an error message. {ElementName}.ZohocrmApi | accountsidGET | GET /accounts/{id} | Retrieve an account associated with a given ACCOUNTID from the CRM system.Specifying an account with a specified ACCOUNTID that does not exist will result in an error response. {ElementName}.ZohocrmApi | accountsidPATCH | PATCH /accounts/{id} | Update an account associated with a given ACCOUNTID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the account object will be updated, and those fields not provided will be left aloneUpdating an account with a specified ACCOUNTID that does not exist will result in an error response. {ElementName}.ZohocrmApi | activitiesCallsGET | GET /activities-calls | Search for calls {ElementName}.ZohocrmApi | activitiesCallsPOST | POST /activities-calls | Create a call {ElementName}.ZohocrmApi | activitiesCallscallIdDELETE | DELETE /activities-calls/{callId} | Delete a call {ElementName}.ZohocrmApi | activitiesCallscallIdGET | GET /activities-calls/{callId} | Retrieve a call {ElementName}.ZohocrmApi | activitiesCallscallIdPATCH | PATCH /activities-calls/{callId} | Update a call {ElementName}.ZohocrmApi | activitiesEventsGET | GET /activities-events | Search for events {ElementName}.ZohocrmApi | activitiesEventsPOST | POST /activities-events | Create an event {ElementName}.ZohocrmApi | activitiesEventseventIdDELETE | DELETE /activities-events/{eventId} | Delete an event {ElementName}.ZohocrmApi | activitiesEventseventIdGET | GET /activities-events/{eventId} | Retrieve an event {ElementName}.ZohocrmApi | activitiesEventseventIdPATCH | PATCH /activities-events/{eventId} | Update an event {ElementName}.ZohocrmApi | bulkidobjectNameGET | GET /bulk/{id}/{objectName} | beta Retrieve the results of an asynchronous bulk query. {ElementName}.ZohocrmApi | bulkidstatusGET | GET /bulk/{id}/status | beta Retrieve the status of a bulk job. {ElementName}.ZohocrmApi | bulkobjectNamePOST | POST /bulk/{objectName} | beta Upload a file of objects to be bulk uploaded to the provider. {ElementName}.ZohocrmApi | bulkqueryPOST | POST /bulk/query | beta Create an asynchronous bulk query job. {ElementName}.ZohocrmApi | campaignsGET | GET /campaigns | Find campaigns in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'jones', the search expression parameter will be where=name='%jones%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | campaignsPOST | POST /campaigns | Create a new campaign in the CRM system. Campaign creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Campaign' model are those required to create a new campaign. {ElementName}.ZohocrmApi | campaignsidDELETE | DELETE /campaigns/{id} | Delete a campaign associated with a given CAMPAIGNID from your CRM system.\nSpecifying a contact associated with a given CAMPAIGNID that does not exist will result in an error message. . {ElementName}.ZohocrmApi | campaignsidGET | GET /campaigns/{id} | Retrieve a campaign associated with a given CAMPAIGNID from the CRM system.Specifying a contact with a specified CAMPAIGNID that does not exist will result in an error response. {ElementName}.ZohocrmApi | campaignsidPATCH | PATCH /campaigns/{id} | Update the contact associated with the given CAMPAIGNID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the contact object will be updated, and those fields not provided will be left aloneUpdating a contact with a specified CAMPAIGNID that does not exist will result in an error response. {ElementName}.ZohocrmApi | contactsGET | GET /contacts | Find contacts in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'jones', the search expression parameter will be where=name='%jones%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | contactsPOST | POST /contacts | Create a new contact in the CRM system. Contact creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Contact' model are those required to create a new contact. {ElementName}.ZohocrmApi | contactscontactIdnotesGET | GET /contacts/{contactId}/notes | List notes for a contact {ElementName}.ZohocrmApi | contactscontactIdnotesPOST | POST /contacts/{contactId}/notes | Create a note for a contact {ElementName}.ZohocrmApi | contactscontactIdnotesnoteIdDELETE | DELETE /contacts/{contactId}/notes/{noteId} | Delete a note for a contact {ElementName}.ZohocrmApi | contactscontactIdnotesnoteIdGET | GET /contacts/{contactId}/notes/{noteId} | Retrieve a note for a contact {ElementName}.ZohocrmApi | contactscontactIdnotesnoteIdPATCH | PATCH /contacts/{contactId}/notes/{noteId} | Update a note for a contact {ElementName}.ZohocrmApi | contactsidDELETE | DELETE /contacts/{id} | Delete a contact associated with a given CONTACTID from your CRM system.\nSpecifying a contact associated with a given CONTACTID that does not exist will result in an error message. . {ElementName}.ZohocrmApi | contactsidGET | GET /contacts/{id} | Retrieve a contact associated with a given CONTACTID from the CRM system.Specifying a contact with a specified CONTACTID that does not exist will result in an error response. {ElementName}.ZohocrmApi | contactsidPATCH | PATCH /contacts/{id} | Update the contact associated with the given CONTACTID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the contact object will be updated, and those fields not provided will be left aloneUpdating a contact with a specified CONTACTID that does not exist will result in an error response. {ElementName}.ZohocrmApi | leadsGET | GET /leads | Find leads in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all leads whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | leadsPOST | POST /leads | Create a new lead in the CRM system. Lead creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Lead' model are those required to create a new lead. {ElementName}.ZohocrmApi | leadsidDELETE | DELETE /leads/{id} | Delete a lead associated with a given LEADID from the CRM system. Specifying a leadassociated with a given LEADID that does not exist will result in an error message. \n {ElementName}.ZohocrmApi | leadsidGET | GET /leads/{id} | Retrieve a lead associated with a given LEADID from the CRM system.Specifying a lead with a specified LEADID that does not exist will result in an errorresponse. {ElementName}.ZohocrmApi | leadsidPATCH | PATCH /leads/{id} | Update a lead associated with the given LEADID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the lead object will be updated, and those fields not provided will be left alone.Updating a lead with a specified LEADID that does not exist will result in an error response. {ElementName}.ZohocrmApi | leadsleadIdnotesGET | GET /leads/{leadId}/notes | List notes for a lead {ElementName}.ZohocrmApi | leadsleadIdnotesPOST | POST /leads/{leadId}/notes | Create a note for a lead {ElementName}.ZohocrmApi | leadsleadIdnotesnoteIdDELETE | DELETE /leads/{leadId}/notes/{noteId} | Delete a note for a lead {ElementName}.ZohocrmApi | leadsleadIdnotesnoteIdGET | GET /leads/{leadId}/notes/{noteId} | Retrieve a note for a lead {ElementName}.ZohocrmApi | leadsleadIdnotesnoteIdPATCH | PATCH /leads/{leadId}/notes/{noteId} | Update a note for a lead {ElementName}.ZohocrmApi | objectNameGET | GET /{objectName} | Find objects in the CRM system, using the provided object name and CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all contacts whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | objectNamePOST | POST /{objectName} | Create a new object in the CRM system. The provided objectName can be that of a custom or standard object. Object creation will flow through Cloud Elements to your CRM service.
{ElementName}.ZohocrmApi | objectNameidDELETE | DELETE /{objectName}/{id} | Delete an object associated with a given object name and ID from the CRM system. Specifying an object associated with a given objectName and ID that does not exist will result in an error message. {ElementName}.ZohocrmApi | objectNameidGET | GET /{objectName}/{id} | Retrieve an object associated with a given ID from the CRM system.Specifying an object with a specified ID that does not exist will result in an error response. {ElementName}.ZohocrmApi | objectNameidPATCH | PATCH /{objectName}/{id} | Update an object associated with a given object name and ID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the object will be updated, and those fields not provided will be left alone.Updating an object with a specified ID that does not exist will result in an error response. {ElementName}.ZohocrmApi | objectsGET | GET /objects | Get a list of all the available objects. {ElementName}.ZohocrmApi | objectsobjectNamemetadataGET | GET /objects/{objectName}/metadata | Get a list of all the field for an object. {ElementName}.ZohocrmApi | opportunitiesGET | GET /opportunities | Find opportunities in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all opportunities whose name contains the word 'data', the search expression parameter will be where=name like '%data%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records. {ElementName}.ZohocrmApi | opportunitiesPOST | POST /opportunities | Create a new opportunity in the CRM system. Opportunity creation will flow through Cloud Elements to your CRM service. With the exception of the 'id' field, the required fields indicated in the 'Opportunity' model are those required to create a new opportunity. {ElementName}.ZohocrmApi | opportunitiesidDELETE | DELETE /opportunities/{id} | Delete an opportunity associated with a given POTENTIALID from the CRM system. Specifying an opportunity associated with a given POTENTIALID that does not exist will result in an error message. {ElementName}.ZohocrmApi | opportunitiesidGET | GET /opportunities/{id} | Retrieve an opportunity associated with a given POTENTIALID from the CRM system.Specifying an opportunity with a specified POTENTIALID that does not exist will result in an error response. {ElementName}.ZohocrmApi | opportunitiesidPATCH | PATCH /opportunities/{id} | Update the opportunity associated with the given POTENTIALID in the CRM system. The update API uses the PATCH HTTP verb, so only those fields provided in the opportunity object will be updated, and those fields not provided will be left alone.Updating an opportunity with a specified POTENTIALID that does not exist will result in an error response. {ElementName}.ZohocrmApi | opportunitiesopportunityIdnotesGET | GET /opportunities/{opportunityId}/notes | List notes for an opportunity {ElementName}.ZohocrmApi | opportunitiesopportunityIdnotesPOST | POST /opportunities/{opportunityId}/notes | Create a note for an opportunity {ElementName}.ZohocrmApi | opportunitiesopportunityIdnotesnoteIdDELETE | DELETE /opportunities/{opportunityId}/notes/{noteId} | Delete a note for an opportunity {ElementName}.ZohocrmApi | opportunitiesopportunityIdnotesnoteIdGET | GET /opportunities/{opportunityId}/notes/{noteId} | Retrieve a note for an opportunity {ElementName}.ZohocrmApi | opportunitiesopportunityIdnotesnoteIdPATCH | PATCH /opportunities/{opportunityId}/notes/{noteId} | Update a note for an opportunity {ElementName}.ZohocrmApi | pingGET | GET /ping | Ping the Element to confirm that the Hub Element has a heartbeat. If the Element does not have a heartbeat, an error message will be returned. {ElementName}.ZohocrmApi | tasksGET | GET /tasks | Search for tasks {ElementName}.ZohocrmApi | tasksPOST | POST /tasks | Create a task {ElementName}.ZohocrmApi | taskstaskIdDELETE | DELETE /tasks/{taskId} | Delete a task {ElementName}.ZohocrmApi | taskstaskIdGET | GET /tasks/{taskId} | Retrieve a task {ElementName}.ZohocrmApi | taskstaskIdPATCH | PATCH /tasks/{taskId} | Update a task {ElementName}.ZohocrmApi | usersGET | GET /users | Find users in the CRM system, using the provided CEQL search expression. The search expression in CEQL is the WHERE clause in a typical SQL query, but without the WHERE keyword. For example, to search for all users whose name contains the word 'smith', the search expression parameter will be where=name='%smith%'. If a search expression is not provided, then the first 200 records will be returned. If a value of true is specified for the includeDeleted flag, then any soft-deleted records will also be considered in the searched records.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme