@moneylion/engine-api 1.0.0 → 1.0.2

package/README.md

@@ -4,5 +4,79 @@ This is a Javascript interface to the [Engine](https://engine.tech/docs/api-refe
 
 ## Getting Started
 
-1. `npm install`
-2. `npm build`
+Install the library
+
+```
+npm add @moneylion/engine-api
+```
+
+Request an authentication token and API endpoint from Engine.
+
+### Creating a Client Instance
+
+Normally you won't have to create a client instance, but you can do so if you want to make a request that this library doesn't support.
+
+```
+import { Client } from "@moneylion/engine-api";
+
+new Client(endpoint, authentication_token);
+```
+
+This provides `get`, `post`, and `patch` methods that accept a REST endpoint and a request body.
+The request body will be serialized to JSON before being sent.
+If you want to pass a body as a string or use a different HTTP method, use the `request` method.
+
+```
+client.request("/endpoint", "DELETE", "body as a string");
+```
+
+### Creating a Lead
+
+To create a lead, you can do the following:
+
+```
+import { Lead } from "@moneylion/engine-api";
+
+new Lead(endpoint, authentication_token).create(lead);
+```
+
+This will return a promise that resolves with an AsyncRateTable.
+You can use the `AsyncRateTable.resolve()` method to turn it into a real RateTable.
+You can also use `createBlocking` which will resolve with a RateTable, but you will potentially spend longer waiting for network requests.
+
+### Updating a Lead
+
+To update a lead, you can do the following:
+
+```
+import { Lead } from "@moneylion/engine-api";
+
+new Lead(endpoint, authentication_token).update(leadUuid, updatedLead);
+```
+
+This returns a promise but will *not* resolve with a rate table and will instead resolve the lead UUID back to you when it finishes.
+
+### Rate Tables
+
+Rate tables are returned when you create a lead.
+If you would like to retrieve a rate table manually you can request it by its UUID.
+
+```
+import { AsyncRateTable } from "@moneylion/engine-api";
+
+new AsyncRateTable({ uuid: rateTableUuid, host: endpoint, api_token: authentication_token }).resolve();
+
+// You can also pass a pre-created client instead of endpoint and token
+new AsyncRateTable({ uuid: rateTableUuid, client: client }).resolve();
+
+// You can also pass a RateTable object instead of a uuid.
+new AsyncRateTable({ rateTable: rateTable, client: client }).resolve();
+```
+
+## For Contributors
+
+This is a relatively normal NPM and Typescript project.
+
+1. `npm install` to install dependencies
+2. `npm run build` to build the project
+3. `npm test` to run the tests

package/dist/client_tags.d.ts

@@ -0,0 +1,2 @@
+import { components } from "./generated/schema";
+export type ClientTags = components["schemas"]["ClientTags"];

package/dist/client_tags.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { Client } from "./client.js";
 export * from "./leads.js";
 export * from "./rate_tables.js";
+export * from "./client_tags.js";

package/dist/index.js

@@ -1,3 +1,4 @@
 export { Client } from "./client.js";
 export * from "./leads.js";
 export * from "./rate_tables.js";
+export * from "./client_tags.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moneylion/engine-api",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Interface to engine.tech API",
   "type": "module",
   "main": "dist/index.js",