lib/client/crm/README.md

8.4 KiB

crm

Crm - JavaScript client for crm Customer Information Microservice This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 0.0.2
  • Package version: 0.0.2
  • Build package: org.openapitools.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 crm --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your crm from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

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):

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 Crm = require('crm');

var defaultClient = Crm.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-API-Key'] = "Token"

var api = new Crm.AccountsApi()
var opts = {
  'accountId': "accountId_example" // {String} Taxnexus Record Id of an Account
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAccount(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://crm.vernonkeenan.com:8080/v1

Class Method HTTP request Description
Crm.AccountsApi deleteAccount DELETE /accounts Delete An Account
Crm.AccountsApi getAccounts GET /accounts Get a list of accounts
Crm.AccountsApi getAccountsObservable GET /accounts/observable Get Taxnexus Accounts in an observable array
Crm.AccountsApi postAccounts POST /accounts Add a new account to Taxnexus
Crm.AccountsApi putAccount PUT /accounts Update a single account
Crm.AssetsApi deleteAsset DELETE /assets Delete An Asset
Crm.AssetsApi getAssets GET /assets Get a list of assets
Crm.AssetsApi getAssetsObservable GET /assets/observable Get Taxnexus Assets in an observable array
Crm.AssetsApi postAssets POST /assets Add a new asset to Taxnexus
Crm.AssetsApi putAsset PUT /assets Update a single asset
Crm.ContactsApi deleteContact DELETE /contacts Delete a Contact
Crm.ContactsApi getContacts GET /contacts Get a list of contacts
Crm.ContactsApi getContactsObservable GET /contacts/observable Get Taxnexus Contacts in an observable array
Crm.ContactsApi postContacts POST /contacts Add new contacts
Crm.ContactsApi putContacts PUT /contacts Update Contact
Crm.ContractsApi deleteContract DELETE /contracts Delete An Contract
Crm.ContractsApi getContracts GET /contracts Get a list of contracts
Crm.ContractsApi getContractsObservable GET /contracts/observable Get Taxnexus Contracts in an observable array
Crm.ContractsApi postContracts POST /contracts Add a new contract to Taxnexus
Crm.ContractsApi putContract PUT /contracts Update a single contract
Crm.CorsApi accountOptions OPTIONS /accounts
Crm.CorsApi accountOptionsObservable OPTIONS /accounts/observable
Crm.CorsApi assetOptions OPTIONS /assets
Crm.CorsApi assetOptionsObservable OPTIONS /assets/observable
Crm.CorsApi contactOptions OPTIONS /contacts
Crm.CorsApi contactOptionsObservable OPTIONS /contacts/observable
Crm.CorsApi contractOptions OPTIONS /contracts
Crm.CorsApi contractOptionsObservable OPTIONS /contracts/observable
Crm.CorsApi leadOptions OPTIONS /leads
Crm.CorsApi leadOptionsObservable OPTIONS /leads/observable
Crm.LeadsApi deleteLead DELETE /leads Delete a Contact
Crm.LeadsApi getLeads GET /leads Get a list of contacts
Crm.LeadsApi getLeadsObservable GET /leads/observable Get Taxnexus Leads in an observable array
Crm.LeadsApi postLeads POST /leads Add new Leads
Crm.LeadsApi putLeads PUT /leads Update Leads

Documentation for Models

Documentation for Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header