ninjapear 1.0.0

package/README.md

@@ -0,0 +1,154 @@
+# ninjapear
+
+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:
+1. Look up the customers, investors, and partners/platforms of any business globally.
+2. (FREE) Retrieve the logo of any company.
+3. (FREE) Find out the nature of an email address.
+4. (FREE) Check your credit balance.
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install ninjapear --save
+```
+
+Finally, you need to build the module:
+
+```shell
+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:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+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:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+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:
+
+```shell
+    npm install GIT_USER_ID/GIT_REPO_ID --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
+
+```shell
+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:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+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
+api.getCompanyLogo(website).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://nubela.co*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*NinjaPear.CompanyAPIApi* | [**getCompanyLogo**](docs/CompanyAPIApi.md#getCompanyLogo) | **GET** /api/v1/company/logo | Company Logo
+*NinjaPear.ContactAPIApi* | [**checkDisposableEmail**](docs/ContactAPIApi.md#checkDisposableEmail) | **GET** /api/v1/contact/disposable-email | Disposable Email Checker
+*NinjaPear.CustomerAPIApi* | [**getCustomerListing**](docs/CustomerAPIApi.md#getCustomerListing) | **GET** /api/v1/customer/listing | Customer Listing
+*NinjaPear.MetaAPIApi* | [**getCreditBalance**](docs/MetaAPIApi.md#getCreditBalance) | **GET** /api/v1/meta/credit-balance | View Credit Balance
+
+
+## Documentation for Models
+
+ - [NinjaPear.CreditBalanceResponse](docs/CreditBalanceResponse.md)
+ - [NinjaPear.CustomerCompany](docs/CustomerCompany.md)
+ - [NinjaPear.CustomerListingResponse](docs/CustomerListingResponse.md)
+ - [NinjaPear.DisposableEmailResponse](docs/DisposableEmailResponse.md)
+ - [NinjaPear.Error](docs/Error.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
+
+- **Type**: Bearer authentication
+