# @airinstitute/deepint-connector

> Deep Intelligence API calls

Latest version **1.0.16** (published 2022-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @airinstitute/deepint-connector
pnpm add @airinstitute/deepint-connector
yarn add @airinstitute/deepint-connector
bun add @airinstitute/deepint-connector
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.16 |
| Published | 2022-07-25 |
| First published | 2022-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Miguel Chaveinte - Deep Intelligence |
| Maintainers | raullb34, amartdom, airuser |
| Keywords | deepint, api, deep intelligence, connector, node |

## Links

- npm: https://www.npmjs.com/package/@airinstitute/deepint-connector
- Repository: https://github.com/deepintdev/deepint-node-connector
- Homepage: https://github.com/deepintdev/deepint-node-connector#readme
- Issues: https://github.com/deepintdev/deepint-node-connector/issues
- npm.io page: https://npm.io/package/@airinstitute/deepint-connector

## Dependencies (3)

- [dotenv](https://npm.io/package/dotenv.md) ^16.0.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7
- [@types/node-fetch](https://npm.io/package/@types/node-fetch.md) ^2.6.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 1.0.16 (latest) — 2022-07-25
- 1.0.14 — 2022-07-25
- 1.0.12 — 2022-07-25
- 1.0.10 — 2022-07-25
- 1.0.9 — 2022-07-25
- 1.0.8 — 2022-07-25

## README

# Deep Intelligence Node connector

<div align="center">
    <img src="https://deepint.net/sites/default/files/logo2.svg" alt="Logo" width="300" height="200">
</div>

</br>

This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/) for connect with the [Deep Intelligence's API](https://app.deepint.net/api/v1/).

This module lets you connect the platform [Deep Intelligence](https://deepint.net/),using their functions, to your projects.
It encapsulates by means of functions the different calls to the API in order to obtain the required data from it.

</br>

<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li><a href="#install">Install</a></li>
    <li>
      <a href="#usage">Usage</a>
      <ul>
        <li><a href="#example">Example</a></li>
        <li><a href="#functions">Functions</a></li>
        <ul>
          <li><a href="#authentication">Authentication</a></li>
          <li><a href="#account">Account</a></li>
          <li><a href="#workspaces">Workspaces</a></li>
          <li><a href="#tasks">Tasks</a></li>
          <li><a href="#sources">Sources</a></li>
          <li><a href="#models">Models</a></li>
          <li><a href="#alerts">Alerts</a></li>
          <li><a href="#emails">Emails</a></li>
          <li><a href="#visualizations">Visualizations</a></li>
          <li><a href="#dashboards">Dashboards</a></li>
        </ul>
        <li><a href="#configuration">Configuration</a></li>
      </ul>
    </li>
    <li><a href="#development-commands">Development Commands</a></li>
    <li><a href="#built-with">Built With</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ol>
</details>

</br>

---
### ✅ Install
---

</br>

```bash
npm i @airinstitute/deepint-connector
```

</br>

---
### 🚩 Usage
---

</br>

### Example 🔻
---

```js
const deepint = require('@airinstitute/deepint-connector');
deepint.getWorkspaces()
    .then(workspaces => {
        console.log(workspaces);
    })
    .catch(err => {
        console.log(err);
    });
```

</br>

### Functions 🔻
---

The module contains all API functions with a characteristic function name: 'methodAPI'+'groupAsociated'+'groupFunctions'+'informationFunction'. Eg: get+Workspace+Visualization+ById = getWorkspaceVisualizationById(params);.

Here there is a list of functions you can use:

- #### Authentication
    - postLoginToken
    - postRevokeToken

- #### Account 
    - getProfile
    - getSession

- #### Workspaces 
    - getWorkspaces
    - postWorkspaces
    - postWorkspacesImport
    - getWorkspaceById
    - postWorkspaceById
    - deleteWorkspaceById
    - postIframe
    - postWorkspace
    - postWorkspaceClone

- #### Tasks 
    - getWorkspaceTasks
    - getWorkspaceTaskById
    - deleteWorkspaceTaskById

- #### Sources 
    - getWorkspaceSources
    - postWorkspaceSource
    - postSourceClone
    - postSourceDerived
    - postSourceExternal
    - postSourceOther
    - getWorkspaceSourceById
    - postWorkspaceSourceById
    - deleteWorkspaceSourceById
    - getConnectionSourceById
    - postConnectionSourceById
    - getAutoUpdateSourceById
    - postAutoUpdateSourceById
    - postTransformFeaturesSourcesById
    - getSourceInstances
    - postSourceInstances
    - deleteSourceInstances
    - postExternalSources

- #### Models
    - getWorkspaceModels
    - postWorkspaceModels
    - getWorkspaceModelById
    - postWorkspaceModelById
    - deleteWorkspaceModelById
    - getModelEvaluation
    - getModelPredict
    - postModelBatchPredict
    - postModelPredict1d

- #### Alerts 
    - getWorkspaceAlerts
    - postWorkspaceAlerts
    - getWorkspaceAlertById
    - postWorkspaceAlertById
    - deleteWorkspaceAlertById
    - getWorkspaceAlertInstances

- #### Emails 
    - getWorkspaceEmails
    - postWorkspaceEmails
    - deleteWorkspaceEmailById

- #### Visualizations
    - getWorkspaceVisualizations
    - postWorkspaceVisualizations
    - getWorkspaceVisualizationById
    - postWorkspaceVisualizationById
    - deleteWorkspaceVisualizationById
    - postCloneVisualizationById

- #### Dashboards 
    - getWorkspaces
    - postWorkspaces
    - postWorkspacesImport
    - getWorkspaceById
    - postWorkspaceById
    - deleteWorkspaceById
    - postIframe
    - postWorkspace
    - postWorkspaceClone


These functions work asynchronously, so they return a promise.

</br>

### Configuration 🔻
---

To configure the module, set the following environment variables:

</br>

| Variable Name | Description |
|---|---|
| X_AUTH_TOKEN |Token Authorization to connect to the API | 
| X_DEEPINT_ORGANIZATION | Organization Token | 
| DEEPINT_API_URL | Deep Intelligence API URL, default is `https://app.deepint.net/api/v1/` |

</br>

For source configuration, set the following variables:

| Variable Name | Description |
|---|---|
| SOURCE_PUB_KEY | Public key of the external source | |
| SOURCE_SECRET_KEY | External source secret key | |


</br>

---
### ⌨️ Development Commands
---

</br>

Module repository for more information: https://github.com/deepintdev/deepint-node-connector

Start by running `npm install` inside the module folder.
`npm run tsc` to build the module,
`npm run start` to build the module,
`npm run pre` to run it in development mode.

To get the documentation of the module functions: `npx typedoc --out docs` .

</br>

---
### 🌐 Built With
---

</br>

This project has been developed with TypeScript, Node Js and Express languages and technologies.

[![TypeScript][TypeScript.js]][TypeScript-url]
[![Node][Node.js]][Node-url]

</br>

---
### 🙏 Acknowledgments
---

</br>

To express our gratitude to the following people involved in this project:

* Miguel Chaveinte García: https://github.com/miguelchaveinte
* Pablo Chamoso Santos: https://github.com/chamoso
* Francisco Pinto Santos: https://github.com/GandalFran
* Raúl López Blanco: https://github.com/raullb34
* Ángel Martín Domínguez: https://github.com/amartdom
* Alberto Galante Melero: https://github.com/Galazord

</br>

<div align="center">
  <a href="#deep-intelligence-node-connector">
    <img 
      src="https://upload.wikimedia.org/wikipedia/commons/thumb/2/20/Circle-icons-arrow-up.svg/512px-Circle-icons-arrow-up.svg.png?20160314153305" 
      alt="Logo"
      width="60" height="60"
    >
  </a>
</div>

</br>

<!-- MARKDOWN LINKS & IMAGES -->
[TypeScript.js]: https://img.shields.io/badge/typescript%20-%23007ACC.svg?&style=for-the-badge&logo=typescript&logoColor=white
[TypeScript-url]: https://www.typescriptlang.org/
[Node.js]: https://img.shields.io/badge/node.js%20-%2343853D.svg?&style=for-the-badge&logo=node.js&logoColor=white
[Node-url]: https://nodejs.org/es/

---
_Source: https://npm.io/package/@airinstitute/deepint-connector · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._