# @jerseydev/orca-loans

> Node wrapper for the Orca Loans API

Latest version **1.0.21-alpha.19** (published 2022-01-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install @jerseydev/orca-loans
pnpm add @jerseydev/orca-loans
yarn add @jerseydev/orca-loans
bun add @jerseydev/orca-loans
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.21-alpha.19 |
| Published | 2022-01-05 |
| First published | 2020-05-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 679.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | JerseyDev Inc |
| Maintainers | dalvare |
| Keywords | typescript, node, orca loans |

## Links

- npm: https://www.npmjs.com/package/@jerseydev/orca-loans
- Repository: https://gitlab.com/jerseydev/orca-loans-sdks/orca-loans-node
- Homepage: https://gitlab.com/jerseydev/orca-loans-sdks/orca-loans-node#readme
- Issues: https://gitlab.com/jerseydev/orca-loans-sdks/orca-loans-node/issues
- npm.io page: https://npm.io/package/@jerseydev/orca-loans

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.21.4
- [tinyify](https://npm.io/package/tinyify.md) ^3.0.0
- [browserify](https://npm.io/package/browserify.md) ^17.0.0

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.21-alpha.19 (latest) — 2022-01-05
- 1.0.21-alpha.18 (next) — 2021-12-07
- 1.0.21-alpha.17 — 2021-11-18
- 1.0.21-alpha.16 — 2021-11-18
- 1.0.21-alpha.15 — 2021-11-18
- 1.0.21-alpha.14 — 2021-11-18
- 1.0.21-alpha.13 — 2021-11-18
- 1.0.21-alpha.12 — 2021-11-18
- 1.0.21-alpha.11 — 2021-11-18
- 1.0.21-alpha.10 — 2021-11-17
- 1.0.21-alpha.9 — 2021-11-02
- 1.0.21-alpha.8 — 2021-11-02
- 1.0.21-alpha.7 — 2021-10-29
- 1.0.21-alpha.6 — 2021-10-27
- 1.0.21-alpha.5 — 2021-10-27
- … 23 more at https://npm.io/package/@jerseydev/orca-loans/versions

## README

# Orca Loans NodeJS Client

## Installation
Using npm:

```bash
$ npm install @jerseydev/orca-loans
```

Using yarn:

```bash
$ yarn add @jerseydev/orca-loans
```

Using CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
<script src="https://storage.googleapis.com/orcaloans/assets/js/orcaloans.min.js"></script>

var OrcaLoans = orcaloans.default;
```

Import
```js
// ES5
const OrcaLoans = require('@jerseydev/orca-loans');

// ES6
import OrcaLoans from "@jerseydev/orca-loans";

```

## Examples
Initialization
```js
OrcaLoans.init(process.env.ORCA_CLIENT_ID, process.env.ORCA_CLIENT_SECRET);
```

Authentication
```js
const email = 'my@email.com';
const password = 'mypassword';

OrcaLoans.getTokens(email, password)
  .send()
  .then(authResult => {
    // set the tokens for requests that require authorization
    OrcaLoans.tokens = { accessToken: authResult.data.access_token, refreshToken: authResult.data.refresh_token };

}).catch(err => {
  
});
```

Cancel a request
```js
const req = OrcaLoans.getBranches();
req.send().then(result => {
  const branches = result.data;
}).catch(err => {
  
});

req.cancel('cancelling request');
```

Invite an applicant
```js
const applicantData = {
  firstName: 'John',
  lastName: 'Smith',
  email: "johnsmith@email.com",
  timezone: 'America/New_York' // US timezones only. See https://momentjs.com/timezone/docs/#/using-timezones/getting-country-zones/ for reference
};

OrcaLoans.inviteUser(applicantData).send().then(result => {
  const newUser = result.data;
}).catch(err => {

});
```

Find a loan officer by email
```js
OrcaLoans.getLoanOfficerByEmail('my@loanofficer.com').send().then(result => {
  const loanOfficer = result.data;
}).catch(err => {
  
});
```

Create a loan application
```js
const loanOfficer = {_id: ''}; // loan officer object
const applicant = {_id: ''}; // user object

const loanData = {
    borrowers: [{
      firstName: 'John',
      lastName: 'Smith',
      email: 'johnsmith@email.com'
    }],
    loanOfficer: loanOfficer._id, // uuid
    user: applicant._id // uuid
};

OrcaLoans.addLoanApplication(loanData).send().then(loanResult => {
                
}).catch(err => {
    
});
```
___
© 2021 Jersey Dev Inc. All rights reserved

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