ninjapear

v1.2.0

Published

5 days ago

JavaScript client for the NinjaPear API - B2B data platform for customer discovery

0High
0Medium
0Low

Ninjapear - JavaScript client for ninjapear NinjaPear is a data platform that seeks to serve as the single source of truth for B2B data, be it to power your data-driven applications or your sales-driven workflow.

As a data client of NinjaPear API, you can:

Look up the customers, investors, and partners/platforms of any business globally.
(FREE) Retrieve the logo of any company.
(FREE) Find out the nature of an email address.
(FREE) Check your credit balance.
Monitor companies for updates (blog posts, X/Twitter posts, website changes) via RSS feeds. This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Generator version: 7.19.0
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 ninjapear --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 ninjapear 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 Ninjapear = require('ninjapear');

var defaultClient = Ninjapear.ApiClient.instance;
// Configure Bearer access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new Ninjapear.CompanyAPIApi()
var website = "https://www.stripe.com"; // {String} The website URL of the target company
var opts = {
  'includeEmployeeCount': false // {Boolean} Fetch fresh employee count data via web search. Adds 2 credits.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompanyDetails(website, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://nubela.co

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Ninjapear.CompanyAPIApi | getCompanyDetails | GET /api/v1/company/details | Company Details Ninjapear.CompanyAPIApi | getCompanyLogo | GET /api/v1/company/logo | Company Logo Ninjapear.CompanyAPIApi | getEmployeeCount | GET /api/v1/company/employee-count | Employee Count Ninjapear.ContactAPIApi | checkDisposableEmail | GET /api/v1/contact/disposable-email | Disposable Email Checker Ninjapear.CustomerAPIApi | getCustomerListing | GET /api/v1/customer/listing | Customer Listing Ninjapear.MetaAPIApi | getCreditBalance | GET /api/v1/meta/credit-balance | View Credit Balance Ninjapear.UpdatesAPIApi | addTarget | POST /api/v1/feeds/{feed_id}/targets | Add Target Ninjapear.UpdatesAPIApi | createFeed | POST /api/v1/feeds | Create Feed Ninjapear.UpdatesAPIApi | deleteFeed | DELETE /api/v1/feeds/{feed_id} | Delete Feed Ninjapear.UpdatesAPIApi | deleteTarget | DELETE /api/v1/feeds/{feed_id}/targets/{target_id} | Delete Target Ninjapear.UpdatesAPIApi | getFeed | GET /api/v1/feeds/{feed_id} | Get Feed Ninjapear.UpdatesAPIApi | getRssFeed | GET /api/v1/feeds/{feed_id}/rss.xml | Get RSS Feed Ninjapear.UpdatesAPIApi | listFeeds | GET /api/v1/feeds | List Feeds Ninjapear.UpdatesAPIApi | updateFeed | PATCH /api/v1/feeds/{feed_id} | Update Feed Ninjapear.UpdatesAPIApi | updateTarget | PATCH /api/v1/feeds/{feed_id}/targets/{target_id} | Update Target

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme