Lead_to_cash_api NPM

lead_to_cash_api

LeadToCashApi - JavaScript client for lead_to_cash_api L2C API summary 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 lead_to_cash_api --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 lead_to_cash_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('lead_to_cash_api') 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 LeadToCashApi = require('lead_to_cash_api');

var api = new LeadToCashApi.BusinessUnitApi()

var body = new LeadToCashApi.Body4(); // {Body4} Business Unit object that needs to be added to the l2c system


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

Documentation for API Endpoints

All URIs are relative to http://35.189.71.62:8000/weave-srl/L2C/1.0.0

Class	Method	HTTP request	Description
LeadToCashApi.BusinessUnitApi	addBusinessUnit	POST /business-units	Add a new business unit to the l2c
LeadToCashApi.BusinessUnitApi	getBusinessUnitList	GET /business-units	Get list of business units
LeadToCashApi.CustomerApi	addCustomer	POST /customers	Add a new customer to the l2c
LeadToCashApi.CustomerApi	getCustomerById	GET /customers/{customerId}	Find customer by ID
LeadToCashApi.CustomerApi	getCustomerList	GET /customers	Get list of customers
LeadToCashApi.CustomerApi	partiallyUpdateCustomer	PATCH /customers/{customerId}	Updates a customer in the l2c system
LeadToCashApi.CustomerApi	updateCustomer	PUT /customers/{customerId}	Updates a customer in the l2c system
LeadToCashApi.LeadApi	addLead	POST /leads	Add a new lead to the l2c
LeadToCashApi.LeadApi	getLeadById	GET /leads/{leadId}	Find lead by ID
LeadToCashApi.LeadApi	getLeadList	GET /leads	Get list of leads
LeadToCashApi.LeadApi	partiallyUpdateLead	PATCH /leads/{leadId}	Updates a lead in the l2c system
LeadToCashApi.LeadApi	updateLead	PUT /leads/{leadId}	Updates a lead in the l2c system
LeadToCashApi.PersonApi	addPerson	POST /people	Add a new person to the l2c
LeadToCashApi.PersonApi	getPeopleList	GET /people	Get list of people
LeadToCashApi.ProposalApi	addProposal	POST /proposals	Add a new proposal to the l2c
LeadToCashApi.ProposalApi	getProposalById	GET /proposals/{proposalId}	Find proposal by ID
LeadToCashApi.ProposalApi	getProposalList	GET /proposals	Get list of proposals
LeadToCashApi.ProposalApi	partiallyUupdateProposal	PATCH /proposals/{proposalId}	Updates a proposal in the l2c system
LeadToCashApi.ProposalApi	updateProposal	PUT /proposals/{proposalId}	Updates a proposal in the l2c system
LeadToCashApi.TopicApi	addTopic	POST /topics	Add a new topic unit to the l2c
LeadToCashApi.TopicApi	getTopicList	GET /topics	Get list of topic
LeadToCashApi.UserApi	createUser	POST /users	Creates a new user
LeadToCashApi.UserApi	getUser	GET /users/{id}	Gets a user
LeadToCashApi.UserApi	getUsers	GET /users	Gets all users
LeadToCashApi.UserApi	removeUserById	DELETE /users/{id}
LeadToCashApi.UserApi	updateUserById	PATCH /users/{id}	Updates a single user by id