@moneylion/engine-api 1.0.2 → 1.2.0

package/README.md

@@ -40,9 +40,21 @@ import { Lead } from "@moneylion/engine-api";
 new Lead(endpoint, authentication_token).create(lead);
 ```
 
+This will return a promise that resolves with the UUID of the lead that was just created.
+It will not create a rate table yet.
+In order to create a rate table you can do the following:
+
+```
+import { Lead } from "@moneylion/engine-api";
+
+new Lead(endpoint, authentication_token).getRateTable(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.
+You can also use `getRateTableBlocking` which will resolve with a RateTable, but you will potentially spend longer waiting for network requests.
+
+You can do the lead creation and rate table fetch in one step using the `createAndGetRateTable` and `createAndGetRateTableBlocking` methods.
 
 ### Updating a Lead
 
@@ -54,7 +66,7 @@ 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.
+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
 
@@ -80,3 +92,11 @@ 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
+
+# Publishing to NPM
+
+Run the following steps to publish the library to NPM.
+
+0. Update the version number in `package.json`. Commit this change.
+1. `npm run build` - This will run Typescript to compile the Javascript.
+2. `npm publish --access=public`. This will publish the library.

package/dist/decoders.d.ts

@@ -21,7 +21,10 @@ export declare const originatorImageDecoder: Decoder<components["schemas"]["Orig
 export declare const originatorDecoder: Decoder<FixNull<components["schemas"]["Originator"]>>;
 export declare const aprTypeDecoder: Decoder<components["schemas"]["AprType"]>;
 type OldLoanOffer = components["schemas"]["LoanOffer"];
-type LoanOffer = FixNull<OldLoanOffer>;
+type TempLoanOfferWithNulledFields = {
+    [P in keyof OldLoanOffer]: P extends "termLength" | "termUnit" ? OldLoanOffer[P] | null | undefined : OldLoanOffer[P];
+};
+type LoanOffer = FixNull<TempLoanOfferWithNulledFields>;
 export declare const loanOfferDecoder: Decoder<LoanOffer>;
 export declare const mortgageLoanTypeDecoder: Decoder<components["schemas"]["MortgageLoanType"]>;
 export declare const mortgageAdjustmentTypeDecoder: Decoder<components["schemas"]["MortgageAdjustmentType"]>;
@@ -34,7 +37,10 @@ export declare const savingsOfferDecoder: Decoder<FixNull<components["schemas"][
 export declare const specialOfferDecoder: Decoder<FixNull<components["schemas"]["SpecialOffer"]>>;
 export declare const pendingResponseDecoder: Decoder<FixNull<components["schemas"]["PendingResponse"]>>;
 type OldRateTable = components["schemas"]["RateTable"];
-export type FixedRateTable = FixNull<OldRateTable>;
+type TempRateTableWithNulledFields = {
+    [P in keyof OldRateTable]: P extends "loanOffers" ? Array<LoanOffer> : OldRateTable[P];
+};
+export type FixedRateTable = FixNull<TempRateTableWithNulledFields>;
 export declare const rateTableDecoder: Decoder<FixedRateTable>;
 export declare const leadUuidDecoder: Decoder<components["schemas"]["LeadUuid"]>;
 export {};

package/dist/decoders.js

@@ -119,8 +119,8 @@ export const loanOfferDecoder = object({
     sponsored: boolean(),
     maxAmount: number(),
     minAmount: optional(number()),
-    termLength: number(),
-    termUnit: termUnitDecoder,
+    termLength: optional(number()),
+    termUnit: optional(termUnitDecoder),
     displayTermUnit: optional(string()),
     termDescription: optional(string()),
     maxApr: optional(number()),

package/dist/leads.d.ts

@@ -15,7 +15,7 @@ export declare class Leads {
      */
     constructor(host: string, auth_token: string);
     /**
-     * Create a new lead.
+     * Create a new lead and retrieve its rate table.
      *
      * @param lead - An object representing the required information to create a Lead.
      *
@@ -25,7 +25,7 @@ export declare class Leads {
      * This method returns an AsyncRateTable.
      * Use the resolve method on the returned object to retrieve the final Rate Table.
      */
-    create(lead: LeadCreateData): Promise<AsyncRateTable>;
+    createAndGetRateTable(lead: LeadCreateData): Promise<AsyncRateTable>;
     /**
      * Create a new lead, immediately resolving the final Rate Table.
      *
@@ -38,7 +38,18 @@ export declare class Leads {
      * This may mean waiting a significant amount of time before it is finalized.
      * Only use this if you can handle waiting for that amount of time.
      */
-    createBlocking(lead: LeadCreateData): Promise<RateTable>;
+    createAndGetRateTableBlocking(lead: LeadCreateData): Promise<RateTable>;
+    /**
+     * Create a new lead.
+     *
+     * @param lead - New lead data to merge into the lead.
+     *
+     * @returns lead uuid
+     *
+     * @remarks
+     * This method returns the UUID of the lead that was created.
+     */
+    create(lead: LeadCreateData): Promise<string>;
     /**
      * Update an existing lead, merging the given data with the already existing data.
      *
@@ -51,4 +62,31 @@ export declare class Leads {
      * This method returns the UUID of the lead that was updated.
      */
     update(leadUuid: string, lead: LeadCreateData): Promise<string>;
+    /**
+     * Retrieve the rate table for a lead.
+     *
+     * @param leadUuid - The UUID of the lead whose rate table you wish to retrieve.
+     * @param lead - An object representing the any information the lead should be updated with.
+     *
+     * @returns AsyncRateTable
+     *
+     * @remarks
+     * This method returns an AsyncRateTable.
+     * Use the resolve method on the returned object to retrieve the final Rate Table.
+     */
+    getRateTable(leadUuid: string, lead: LeadCreateData): Promise<AsyncRateTable>;
+    /**
+     * Retrieve the rate table for a lead, immediately resolving it.
+     *
+     * @param leadUuid - The UUID of the lead whose rate table you wish to retrieve.
+     * @param lead - An object representing the any information the lead should be updated with.
+     *
+     * @returns RateTable
+     *
+     * @remarks
+     * This method will immediately resolve the final Rate Table.
+     * This may mean waiting a significant amount of time before it is finalized.
+     * Only use this if you can handle waiting for that amount of time.
+     */
+    getRateTableBlocking(leadUuid: string, lead: LeadCreateData): Promise<RateTable>;
 }

package/dist/leads.js

@@ -25,7 +25,7 @@ export class Leads {
         this.client = new Client(host, auth_token);
     }
     /**
-     * Create a new lead.
+     * Create a new lead and retrieve its rate table.
      *
      * @param lead - An object representing the required information to create a Lead.
      *
@@ -35,7 +35,7 @@ export class Leads {
      * This method returns an AsyncRateTable.
      * Use the resolve method on the returned object to retrieve the final Rate Table.
      */
-    create(lead) {
+    createAndGetRateTable(lead) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.client.post("leads/rateTables", lead);
             const rateTable = rateTableDecoder.runWithException(resp);
@@ -58,13 +58,30 @@ export class Leads {
      * This may mean waiting a significant amount of time before it is finalized.
      * Only use this if you can handle waiting for that amount of time.
      */
-    createBlocking(lead) {
+    createAndGetRateTableBlocking(lead) {
         return __awaiter(this, void 0, void 0, function* () {
             const resp = yield this.client.post("blocking/leads/rateTables", lead);
             const rateTable = rateTableDecoder.runWithException(resp);
             return rateTable;
         });
     }
+    /**
+     * Create a new lead.
+     *
+     * @param lead - New lead data to merge into the lead.
+     *
+     * @returns lead uuid
+     *
+     * @remarks
+     * This method returns the UUID of the lead that was created.
+     */
+    create(lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post("leads", lead);
+            const leadUuidResponse = leadUuidDecoder.runWithException(resp);
+            return leadUuidResponse.uuid;
+        });
+    }
     /**
      * Update an existing lead, merging the given data with the already existing data.
      *
@@ -83,4 +100,47 @@ export class Leads {
             return leadUuidResponse.uuid;
         });
     }
+    /**
+     * Retrieve the rate table for a lead.
+     *
+     * @param leadUuid - The UUID of the lead whose rate table you wish to retrieve.
+     * @param lead - An object representing the any information the lead should be updated with.
+     *
+     * @returns AsyncRateTable
+     *
+     * @remarks
+     * This method returns an AsyncRateTable.
+     * Use the resolve method on the returned object to retrieve the final Rate Table.
+     */
+    getRateTable(leadUuid, lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post(`leads/${leadUuid}/rateTables`, lead);
+            const rateTable = rateTableDecoder.runWithException(resp);
+            const asyncRateTable = new AsyncRateTable({
+                rateTable,
+                client: this.client,
+            });
+            return asyncRateTable;
+        });
+    }
+    /**
+     * Retrieve the rate table for a lead, immediately resolving it.
+     *
+     * @param leadUuid - The UUID of the lead whose rate table you wish to retrieve.
+     * @param lead - An object representing the any information the lead should be updated with.
+     *
+     * @returns RateTable
+     *
+     * @remarks
+     * This method will immediately resolve the final Rate Table.
+     * This may mean waiting a significant amount of time before it is finalized.
+     * Only use this if you can handle waiting for that amount of time.
+     */
+    getRateTableBlocking(leadUuid, lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post(`blocking/leads/${leadUuid}/rateTables`, lead);
+            const rateTable = rateTableDecoder.runWithException(resp);
+            return rateTable;
+        });
+    }
 }

package/dist/leads.test.js

@@ -175,6 +175,9 @@ const testHost = "https://engine.com";
 const token = "good_auth_token";
 const patchLeadUuid = "patch-lead-uuid";
 const patchLeadUuidResponse = "patch-lead-uuid-response";
+const createLeadUuidResponse = "create-lead-uuid-response";
+const getRateTableLeadUuid = "get-rate-table-lead-uuid";
+const getRateTableLeadUuidBlocking = "get-rate-table-lead-uuid-blocking";
 const handlers = [
     http.post(`${testHost}/blocking/leads/rateTables`, () => {
         return new HttpResponse(JSON.stringify(fullRateTable), { status: 200 });
@@ -194,11 +197,26 @@ const handlers = [
             status: 200,
         });
     }),
+    http.post(`${testHost}/leads`, () => {
+        return new HttpResponse(JSON.stringify({
+            uuid: createLeadUuidResponse,
+        }));
+    }),
     http.patch(`${testHost}/leads/${patchLeadUuid}`, () => {
         return new HttpResponse(JSON.stringify({
             uuid: patchLeadUuidResponse,
         }));
     }),
+    http.post(`${testHost}/leads/${getRateTableLeadUuid}/rateTables`, () => {
+        return new HttpResponse(JSON.stringify(pendingRateTable), {
+            status: 200,
+        });
+    }),
+    http.post(`${testHost}/blocking/leads/${getRateTableLeadUuidBlocking}/rateTables`, () => {
+        return new HttpResponse(JSON.stringify(fullRateTable), {
+            status: 200,
+        });
+    }),
 ];
 const server = setupServer(...handlers);
 describe("Leads", () => {
@@ -209,23 +227,40 @@ describe("Leads", () => {
     afterAll(() => server.close());
     test("Blocking leads endpoint returns a resolved rate table", () => __awaiter(void 0, void 0, void 0, function* () {
         const leads = new Leads(testHost, token);
-        const resp = yield leads.createBlocking(testLeadData);
+        const resp = yield leads.createAndGetRateTableBlocking(testLeadData);
         expect(resp).toEqual(fullRateTable);
     }));
     test("Async leads endpoint returns an async rate table", () => __awaiter(void 0, void 0, void 0, function* () {
         const leads = new Leads(testHost, token);
-        const resp = yield leads.create(testLeadData);
+        const resp = yield leads.createAndGetRateTable(testLeadData);
         expect(resp).toBeInstanceOf(AsyncRateTable);
     }));
     test("Async leads endpoint can be further resolved to a final rate table", () => __awaiter(void 0, void 0, void 0, function* () {
         const leads = new Leads(testHost, token);
-        const resp = yield leads.create(testLeadData);
+        const resp = yield leads.createAndGetRateTable(testLeadData);
         const rateTable = yield resp.resolve();
         expect(rateTable).toEqual(fullRateTable);
     }));
+    test("Create lead endpoint returns the uuid of the created lead", () => __awaiter(void 0, void 0, void 0, function* () {
+        const leads = new Leads(testHost, token);
+        const resp = yield leads.create(testLeadData);
+        expect(resp).toEqual(createLeadUuidResponse);
+    }));
     test("Patch leads endpoint returns the uuid of the lead", () => __awaiter(void 0, void 0, void 0, function* () {
         const leads = new Leads(testHost, token);
         const resp = yield leads.update(patchLeadUuid, testLeadData);
         expect(resp).toEqual(patchLeadUuidResponse);
     }));
+    test("Get lead rate table endpoint returns an async rate table", () => __awaiter(void 0, void 0, void 0, function* () {
+        const leads = new Leads(testHost, token);
+        const resp = yield leads.getRateTable(getRateTableLeadUuid, testLeadData);
+        expect(resp).toBeInstanceOf(AsyncRateTable);
+        const rateTable = yield resp.resolve();
+        expect(rateTable).toEqual(fullRateTable);
+    }));
+    test("Get lead rate table blocking endpoint returns a resolved rate table", () => __awaiter(void 0, void 0, void 0, function* () {
+        const leads = new Leads(testHost, token);
+        const resp = yield leads.getRateTableBlocking(getRateTableLeadUuidBlocking, testLeadData);
+        expect(resp).toEqual(fullRateTable);
+    }));
 });

package/package.json

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