saasgrids v1.0.16

saasgrids

crms - JavaScript client for saasgrids Saasgrids CRM grid This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: 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 saasgrids --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your saasgrids from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('saasgrids') in javascript files from the directory you ran the last command above from.

git

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

    npm install GIT_USER_ID/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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var crms = require('saasgrids');

var defaultClient = crms.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new crms.AccountsApi()

var userId = "userId_example"; // {String} User instance id returned from saasgrids after authorization

var body = new crms.Account(); // {Account} Account object that needs to be created

api.createAccount(userId, body).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.saasgrids.com/apis/crms/

Documentation for Models

• crms.Account
• crms.Appointment
• crms.Call
• crms.Contact
• crms.Customfield
• crms.Deal
• crms.Email
• crms.Field
• crms.Filter
• crms.InlineResponse200
• crms.InlineResponse2001
• crms.InlineResponse2002
• crms.InlineResponse2003
• crms.InlineResponse2004
• crms.InlineResponse2005
• crms.InlineResponse2006
• crms.InlineResponse2007
• crms.Lead
• crms.Note
• crms.Task
• crms.User

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication