@moneylion/engine-api 1.0.0

package/dist/decoders.js

@@ -0,0 +1,220 @@
+import { object, array, union, intersection, oneOf, constant, string, optional as optionalUndefined, number, boolean, } from "@mojotech/json-type-validation";
+const optional = (d) => union(optionalUndefined(d), constant(null));
+export const cardPurposeDecoder = union(constant("balance_transfer"), constant("cash_back"), constant("earning_rewards"), constant("improve_credit"), constant("low_interest"), constant("new_to_credit"), constant("student"), constant("travel_incentives"));
+export const termUnitDecoder = union(constant("day"), constant("month"), constant("year"), constant("open"));
+export const introOfferTypeDecoder = union(constant("miles"), constant("points"), constant("statement_credit"));
+export const cardTypeDecoder = union(constant("visa"), constant("mastercard"), constant("american_express"), constant("discover"));
+export const providedCreditRatingDecoder = union(constant("excellent"), constant("good"), constant("fair"), constant("poor"), constant("limited"), constant("unknown"));
+export const cardBenefitDecoder = oneOf(constant("No Foreign Transaction Fees"), constant("Purchase Protection"), constant("Return Protection"), constant("Price Protection"), constant("Fraud Protection"), constant("Extended Warranty"), constant("Travel Accident Insurance"), constant("Trip Interruption Insurance"), constant("Car Rental Insurance"), constant("Baggage Insurance"), constant("Baggage Delay Insurance"), constant("Hotel Burglary Insurance"), constant("Travel & Emergency Assistance"), constant("Roadside Assistance"), constant("Concierge Service"), constant("Lounge Access"), constant("Identity Theft Assistance"), constant("In-Flight Savings"), constant("Free Checked Bag"), constant("Priority Boarding"), constant("No Blackout Dates"), constant("Free Companion Ticket"), constant("Discount Companion Ticket"), constant("Global Entry or TSA PreCheck"), constant("Private Jet Perks"), constant("Lounge Access Discount"), constant("24/7 Cardholder Support"), constant("Authorized User"), constant("Entertainment Access"), constant("Airline Fee Credit"), constant("Late Fee Pass"), constant("Credit Score Reporting"), constant("No Flight Change Fees"), constant("24/7 Account Monitoring"), constant("Amex Offers"), constant("Visa Signature Offers"), constant("MasterCard Offers"), constant("Free Hotel Stay"), constant("Extended Hotel Stay"), constant("Dining Concierge"), constant("2 Lounge Passes"), constant("Hilton Honors Silver Membership"), constant("Hilton Honors Gold Membership"), constant("World of Hyatt Discoverist Status"), constant("SPG Gold Membership"), constant("Marriott Rewards Silver Status"), constant("Hertz Presidents Circle Elite Status"), constant("2 Free Checked Bags"), constant("Auto Discounts"), constant("InCircle Partnership"), constant("ShopRunner"), constant("WiFi Access"), constant("ShopSafe"), constant("BoA Preferred Rewards"), constant("MasterCard Fuel Rewards Network"), constant("Missed Event Ticket Protection"), constant("Account Freezing"), constant("Cell Phone Protection"), constant("GPA Rewards"), constant("In-Flight WiFi Credit"), constant("Citi Private Pass"), constant("Priceless Cities"), constant("The Hotel Collection"), constant("By Invitation Only"), constant("Luxury Hotel Collection"), constant("Expedia+ Silver Status"), constant("Expedia+ Gold Status"), constant("$100 American Airlines Discount"), constant("Disney Parks Perks and Savings"), constant("Ritz-Carlton Gold Elite Status"), constant("Ritz-Carlton Club Level Upgrade"), constant("Annual Travel Credit"), constant("IHG Platinum Elite Status"), constant("QuickBooks Connect"), constant("ReceiptMatch"), constant("Employee Spending Limits"), constant("FX International Payments"), constant("No Pre-Set Spending Limit"), constant("Purchase Financing"), constant("Amex Open Savings"), constant("Amazon Special Financing"), constant("$100 Ritz-Carlton Hotel Credit"), constant("British Airways Companion Ticket"), constant("Mercedes-Benz Gift Certificates"), constant("Mercedes-Benz Excess Mileage Waiver"), constant("JetBlue Annual Statement Credit"), constant("20% Discount on Delta Flights for Delta Private Jet Members"), constant("Expense Report Features"), constant("Business Cell Phone Protection"), constant("Free Shipping on most Target.com orders"), constant("30 Extra Days for Returns"), constant("Free clothing altertaions"), constant("Personal shopping"), constant("Shopmyway Savings"), constant("Online Subscription Credit"), constant("Uber Exclusive Access"), constant("Airline Benefits"), constant("Hotel Benefits"), constant("Other Travel Benefits"), constant("Emergency Assistance"), constant("Experiences"), constant("Shopping Benefits"), constant("Cardholder Benefits"), constant("Enhanced Security"), constant("Business Benefits"), constant("Other Benefits"), constant("In-Flight Discounts"), constant("Fee Coverage"), constant("Flight Credits & Discounts"), constant("Hotel Membership Status"), constant("Hotel Credit & Free Stays"), constant("Travel Credit"), constant("Travel Experiences Programs"), constant("Car Rental Membership Status"), constant("Extra Gas Rewards"), constant("Shopping Protection"), constant("Shopping Discounts"), constant("Free Shipping"), constant("The Boingo American Express Preferred Plan"), constant("AirSpace Lounge"), constant("Uber Monthly Credit"), constant("Ride Share Benefits"), constant("Delta Sky Club"), constant("Admirals Club Membership"), constant("Priority Pass Select Membership (Prestige)"), constant("Priority Pass Select Membership (Standard Plus)"), constant("Daily Breakfast"), constant("Early Check-in & Late Check-out"), constant("Room Upgrades"), constant("Complementary WiFi"), constant("Amex Hotel Collection Credit"), constant("Temporary Account Numbers"), constant("One-Time 50% Discount on Companion Ticket"), constant("Airline Travel Credit"), constant("United Club Membership"), constant("Chip Technology"), constant("Earn More Miles for Sharing Travel Stories"), constant("Mastercard World Elite Concierge and Luxury Travel Benefits"), constant("20% Savings on Delta In-Flight Purchases"), constant("25% Savings on United In-Flight Food and Drink Purchases"), constant("$100 Hilton Properties Credit"), constant("$250 Hilton Resort Credit"), constant("Hilton Honors Diamond Membership"), constant("Free Birthday Gift"), constant("2x Points During Your Birthday Month"), constant("Car Rental VIP Perks"), constant("Free shipping with the purchase of a bra"), constant("Monthly Dining Credit"), constant("Amazon Prime Student"));
+export const creditCardOfferDetailsDecoder = object({
+    cardName: optional(string()),
+    cardImageUrl: string(),
+    cardPurposes: optional(array(cardPurposeDecoder)),
+    ratesUrl: optional(string()),
+    maxPurchaseApr: optional(number()),
+    minPurchaseApr: optional(number()),
+    purchaseAprText: optional(string()),
+    maxPurchaseIntroApr: optional(number()),
+    minPurchaseIntroApr: optional(number()),
+    purchaseIntroAprTerm: optional(number()),
+    purchaseIntroAprTermUnit: optional(termUnitDecoder),
+    purchaseIntroAprText: optional(string()),
+    maxCashAdvanceApr: optional(number()),
+    minCashAdvanceApr: optional(number()),
+    cashAdvanceAprText: optional(string()),
+    maxCashAdvanceIntroApr: optional(number()),
+    minCashAdvanceIntroApr: optional(number()),
+    cashAdvanceIntroAprTerm: optional(number()),
+    cashAdvanceIntroAprTermUnit: optional(termUnitDecoder),
+    cashAdvanceIntroAprText: optional(string()),
+    maxBalanceTransferApr: optional(number()),
+    minBalanceTransferApr: optional(number()),
+    balanceTransferAprText: optional(string()),
+    maxBalanceTransferIntroApr: optional(number()),
+    minBalanceTransferIntroApr: optional(number()),
+    balanceTransferIntroAprTerm: optional(number()),
+    balanceTransferIntroAprTermUnit: optional(termUnitDecoder),
+    balanceTransferIntroAprText: optional(string()),
+    maxAnnualFee: optional(number()),
+    minAnnualFee: optional(number()),
+    annualIntroFee: optional(number()),
+    annualIntroFeeTerm: optional(number()),
+    introOfferAmount: optional(number()),
+    introOfferText: optional(string()),
+    introOfferType: optional(introOfferTypeDecoder),
+    details: optional(array(string())),
+    additionalDetails: optional(array(string())),
+    cardType: cardTypeDecoder,
+    minimumCreditLine: optional(number()),
+    minimumPenaltyApr: optional(number()),
+    maximumPenaltyApr: optional(number()),
+    balanceTransferFee: optional(number()),
+    cashAdvanceFee: optional(number()),
+    lateFee: optional(number()),
+    foreignExchangeFee: optional(number()),
+    accountOpeningFee: optional(number()),
+    returnPaymentFee: optional(number()),
+    monthlyServiceFee: optional(number()),
+    recommendedCreditRatings: optional(array(providedCreditRatingDecoder)),
+    preQualified: boolean(),
+    preApproved: boolean(),
+    preSelected: boolean(),
+    foreignTransactionFee: optional(number()),
+    cardBenefits: optional(array(cardBenefitDecoder)),
+});
+export const partnerDecoder = object({
+    uuid: string(),
+    name: string(),
+    description: string(),
+    disclaimer: string(),
+    supportsPreSelect: boolean(),
+    shouldDisplayPreSelect: boolean(),
+    supportsPersonalizedOffers: boolean(),
+    imageUrl: string(),
+    subtextOverride: optional(string()),
+});
+export const productTypeDecoder = union(constant("credit_card"), constant("insurance"), constant("life_insurance"), constant("loan"), constant("mortgage"), constant("savings"), constant("other"));
+export const productSubTypeDecoder = oneOf(constant("credit_card"), constant("secured_card"), constant("personal_loan"), constant("secured_loan"), constant("student_loan_refinance"), constant("co_applicant_loan"), constant("line_of_credit"), constant("automobile_refinance"), constant("home_equity_line_of_credit"), constant("purchase"), constant("refinance"), constant("savings_account"), constant("money_market_account"), constant("certificate_of_deposit"), constant("individual_retirement_account"), constant("cash_management_account"), constant("high_interest_checking"), constant("checking"), constant("accidental_death_benefits"), constant("term_life"), constant("term_life_instant"), constant("whole_life"), constant("debt_relief"), constant("installment_loans"), constant("credit_builder"), constant("cash_advance"), constant("credit_repair"), constant("education_offers"), constant("employment_opportunity"), constant("financial_wellness"), constant("direct_affiliate"), constant("overdraft_protection"), constant("revenue_based_financing"), constant("uncategorized"));
+export const offerDecoder = object({
+    uuid: string(),
+    partner: partnerDecoder,
+    marketplace: optional(partnerDecoder),
+    productType: productTypeDecoder,
+    productSubType: productSubTypeDecoder,
+    url: string(),
+    recommendationScore: optional(number()),
+    disclaimer: optional(string()),
+    productSubTypeDisclaimer: optional(string()),
+    expiresAt: optional(string()),
+});
+export const creditCardOfferDecoder = intersection(object({
+    details: creditCardOfferDetailsDecoder,
+}), offerDecoder);
+export const originatorImageDecoder = object({
+    sizeKey: string(),
+    url: string(),
+});
+export const originatorDecoder = object({
+    key: string(),
+    name: string(),
+    description: optional(string()),
+    images: array(originatorImageDecoder),
+    disclaimer: optional(string()),
+    companyUuid: optional(string()),
+    financialInstitutionUuid: optional(string()),
+});
+export const aprTypeDecoder = union(constant("variable"), constant("regular"), constant("fixed"));
+export const loanOfferDecoder = object({
+    uuid: string(),
+    productType: productTypeDecoder,
+    productSubType: productSubTypeDecoder,
+    productSubTypeDisclaimer: optional(string()),
+    url: optional(string()),
+    originator: originatorDecoder,
+    originatorId: optional(string()),
+    preQualified: boolean(),
+    preApproved: boolean(),
+    secured: boolean(),
+    coApplicant: boolean(),
+    sponsored: boolean(),
+    maxAmount: number(),
+    minAmount: optional(number()),
+    termLength: number(),
+    termUnit: termUnitDecoder,
+    displayTermUnit: optional(string()),
+    termDescription: optional(string()),
+    maxApr: optional(number()),
+    minApr: optional(number()),
+    meanApr: optional(number()),
+    aprType: aprTypeDecoder,
+    aprDescription: optional(string()),
+    feeRate: optional(number()),
+    maxFeeRate: optional(number()),
+    minFeeRate: optional(number()),
+    feeFixed: optional(number()),
+    maxFeeFixed: optional(number()),
+    minFeeFixed: optional(number()),
+    allowPrepayment: boolean(),
+    prepaymentFee: optional(number()),
+    monthlyPayment: optional(number()),
+    maxMonthlyPayment: optional(number()),
+    minMonthlyPayment: optional(number()),
+    monthlyPaymentDescription: optional(string()),
+    meanMonthlyPayment: optional(number()),
+    maxTotalPayment: optional(number()),
+    minTotalPayment: optional(number()),
+    meanTotalPayment: optional(number()),
+    recommendationScore: optional(number()),
+    payout: optional(number()),
+    conversionProbability: optional(number()),
+    terms: optional(string()),
+    amountPrefix: optional(string()),
+});
+export const mortgageLoanTypeDecoder = union(constant("fifteen_year_fixed"), constant("thirty_year_fixed"), constant("five_one_adjustable"), constant("seven_one_adjustable"), constant("ten_one_adjustable"));
+export const mortgageAdjustmentTypeDecoder = union(constant("credits"), constant("par"), constant("points"));
+export const mortageOfferDetailsDecoder = object({
+    interestRate: number(),
+    loanType: mortgageLoanTypeDecoder,
+    priceAdjustment: number(),
+    monthlyPayment: number(),
+    netClosingCosts: number(),
+    apr: number(),
+    loanTerm: number(),
+    adjustmentType: mortgageAdjustmentTypeDecoder,
+});
+export const mortgageOfferDecoder = intersection(object({
+    details: mortageOfferDetailsDecoder,
+}), offerDecoder);
+export const compoundingMethodDecoder = union(constant("annually"), constant("continuous"), constant("daily"), constant("monthly"), constant("quarterly"), constant("semiAnnually"), constant("simple"), constant("weekly"));
+export const federalInsuranceTypeDecoder = union(constant("fdic"), constant("ncua"));
+export const savingsOfferDetailsDecoder = object({
+    name: optional(string()),
+    description: optional(string()),
+    details: optional(string()),
+    rate: optional(number()),
+    annualPercentYield: number(),
+    compoundingMethod: compoundingMethodDecoder,
+    introductoryPeriodMonths: optional(number()),
+    introductoryRate: optional(number()),
+    minimumDeposit: number(),
+    minimumDepositWithFees: optional(number()),
+    monthlyFee: number(),
+    checkWriting: optional(boolean()),
+    effectiveAsOf: string(),
+    federalInsuranceType: optional(federalInsuranceTypeDecoder),
+});
+export const savingsOfferDecoder = intersection(object({
+    details: savingsOfferDetailsDecoder,
+}), offerDecoder);
+export const specialOfferDecoder = object({
+    uuid: string(),
+    name: string(),
+    desc: string(),
+    url: string(),
+    partnerName: string(),
+    partnerImageUrl: string(),
+    recommendationScore: optional(number()),
+    payout: optional(number()),
+    productSubType: productSubTypeDecoder,
+});
+export const pendingResponseDecoder = object({
+    partner: partnerDecoder,
+    productTypes: array(productTypeDecoder),
+});
+export const rateTableDecoder = object({
+    uuid: string(),
+    leadUuid: string(),
+    loanAmount: optional(number()),
+    embedUrl: optional(string()),
+    partnerPageUrl: optional(string()),
+    creditCardOffers: array(creditCardOfferDecoder),
+    loanOffers: array(loanOfferDecoder),
+    mortgageOffers: array(mortgageOfferDecoder),
+    savingsOffers: array(savingsOfferDecoder),
+    specialOffers: array(specialOfferDecoder),
+    pendingOriginators: array(originatorDecoder),
+    pendingResponses: array(pendingResponseDecoder),
+});
+export const leadUuidDecoder = object({
+    uuid: string(),
+});

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/leads.d.ts

@@ -0,0 +1,54 @@
+import { AsyncRateTable, RateTable } from "./rate_tables.js";
+import { components } from "./generated/schema";
+export type LeadCreateData = components["schemas"]["LeadCreateData"];
+/**
+ * The class used to manage leads.
+ * Both blocking and non-blocking methods are provided, depending on when you want to resolve the returned Rate Table.
+ */
+export declare class Leads {
+    private client;
+    /**
+     * Create a new instance of the Leads class.
+     *
+     * @param host - A hostname used to construct a Client instance.
+     * @param auth_token - An authentication token used to construct a Client instance.
+     */
+    constructor(host: string, auth_token: string);
+    /**
+     * Create a new lead.
+     *
+     * @param lead - An object representing the required information to create a Lead.
+     *
+     * @returns AsyncRateTable
+     *
+     * @remarks
+     * This method returns an AsyncRateTable.
+     * Use the resolve method on the returned object to retrieve the final Rate Table.
+     */
+    create(lead: LeadCreateData): Promise<AsyncRateTable>;
+    /**
+     * Create a new lead, immediately resolving the final Rate Table.
+     *
+     * @param lead - An object representing the required information to create a Lead.
+     *
+     * @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.
+     */
+    createBlocking(lead: LeadCreateData): Promise<RateTable>;
+    /**
+     * Update an existing lead, merging the given data with the already existing data.
+     *
+     * @param leadUuid - The UUID of the lead to be updated.
+     * @param lead - New lead data to merge into the lead.
+     *
+     * @returns lead uuid
+     *
+     * @remarks
+     * This method returns the UUID of the lead that was updated.
+     */
+    update(leadUuid: string, lead: LeadCreateData): Promise<string>;
+}

package/dist/leads.js

@@ -0,0 +1,86 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Client } from "./client.js";
+import { AsyncRateTable } from "./rate_tables.js";
+import { leadUuidDecoder, rateTableDecoder } from "./decoders.js";
+/**
+ * The class used to manage leads.
+ * Both blocking and non-blocking methods are provided, depending on when you want to resolve the returned Rate Table.
+ */
+export class Leads {
+    /**
+     * Create a new instance of the Leads class.
+     *
+     * @param host - A hostname used to construct a Client instance.
+     * @param auth_token - An authentication token used to construct a Client instance.
+     */
+    constructor(host, auth_token) {
+        this.client = new Client(host, auth_token);
+    }
+    /**
+     * Create a new lead.
+     *
+     * @param lead - An object representing the required information to create a Lead.
+     *
+     * @returns AsyncRateTable
+     *
+     * @remarks
+     * This method returns an AsyncRateTable.
+     * Use the resolve method on the returned object to retrieve the final Rate Table.
+     */
+    create(lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post("leads/rateTables", lead);
+            const rateTable = rateTableDecoder.runWithException(resp);
+            const asyncRateTable = new AsyncRateTable({
+                rateTable,
+                client: this.client,
+            });
+            return asyncRateTable;
+        });
+    }
+    /**
+     * Create a new lead, immediately resolving the final Rate Table.
+     *
+     * @param lead - An object representing the required information to create a Lead.
+     *
+     * @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.
+     */
+    createBlocking(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;
+        });
+    }
+    /**
+     * Update an existing lead, merging the given data with the already existing data.
+     *
+     * @param leadUuid - The UUID of the lead to be updated.
+     * @param lead - New lead data to merge into the lead.
+     *
+     * @returns lead uuid
+     *
+     * @remarks
+     * This method returns the UUID of the lead that was updated.
+     */
+    update(leadUuid, lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.patch(`leads/${leadUuid}`, lead);
+            const leadUuidResponse = leadUuidDecoder.runWithException(resp);
+            return leadUuidResponse.uuid;
+        });
+    }
+}

package/dist/leads.test.d.ts

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

package/dist/leads.test.js

@@ -0,0 +1,231 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { describe, expect, test, beforeAll, afterEach, afterAll, } from "@jest/globals";
+import { Leads } from "./leads";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { AsyncRateTable } from "./rate_tables";
+const testLeadData = {
+    personalInformation: {
+        firstName: "testFirst",
+        lastName: "testLast",
+        email: "test@test.com",
+        city: "New York",
+        state: "NY",
+        primaryPhone: "4842017710",
+        address1: "245 W 17th St",
+        zipcode: "10011",
+        dateOfBirth: "1987-01-01",
+        ssn: "222-33-4444",
+    },
+    personalReferenceInformation: {},
+    loanInformation: {
+        purpose: "credit_card_refi",
+        loanAmount: 10000,
+    },
+    sessionInformation: {
+        ipAddress: "x.x.x.x",
+    },
+    mortgageInformation: {
+        propertyStatus: "rent",
+    },
+    creditCardInformation: {},
+    savingsInformation: {},
+    creditInformation: {
+        providedCreditRating: "excellent",
+    },
+    financialInformation: {
+        employmentStatus: "employed",
+        employmentPayFrequency: "biweekly",
+        annualIncome: 100000,
+    },
+    employmentInformation: {
+        directDeposit: true,
+    },
+    legalInformation: {
+        consentsToFcra: true,
+        consentsToSms: false,
+        consentsToTcpa: true,
+        tcpaLanguage: 'By tapping "See my offers", I am consenting to MoneyLion sharing the information above with ML Enterprise Inc. and their network of financial services partners to see what offers I may receive for financial products and services, which may include debt relief, credit repair, credit monitoring or other related services.',
+    },
+    educationInformation: {
+        educationLevel: "bachelors",
+    },
+    coApplicantInformation: {},
+    healthInformation: {},
+    refinanceLoans: [],
+    identificationInformation: {},
+    productTypes: ["loan", "other"],
+};
+const fullRateTable = {
+    uuid: "full-rate-table-uuid",
+    leadUuid: "full-lead-uuid",
+    loanAmount: 10000,
+    creditCardOffers: [],
+    loanOffers: [],
+    mortgageOffers: [],
+    savingsOffers: [],
+    specialOffers: [
+        {
+            uuid: "full-special-offer-uuid",
+            name: "Mock Credit Builder Offer",
+            desc: "Description of the credit builder offer",
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            partnerName: "Engine Demo Loans Demand Sub Account 1",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "credit_builder",
+        },
+        {
+            uuid: "full-special-offer-uuid-2",
+            name: "Mock Debt Relief Offer",
+            desc: "Description of the debt relief offer",
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            partnerName: "Engine Demo Loans Demand Sub Account 2",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "debt_relief",
+        },
+        {
+            uuid: "full-special-offer-uuid-3",
+            name: "Mock Installment Loans Offer",
+            desc: "Description of the installment loans offer",
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            partnerName: "Engine Demo Loans Demand Sub Account 3",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "installment_loans",
+        },
+    ],
+    pendingOriginators: [],
+    pendingResponses: [],
+};
+const pendingRateTable = {
+    uuid: "pending-rate-table-uuid",
+    leadUuid: "pending-lead-uuid",
+    loanAmount: 20000,
+    creditCardOffers: [],
+    loanOffers: [],
+    mortgageOffers: [],
+    savingsOffers: [],
+    specialOffers: [
+        {
+            uuid: "pending-special-offer-uuid",
+            name: "Mock Credit Builder Offer",
+            desc: "Description of the credit builder offer",
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            partnerName: "Engine Demo Loans Demand Sub Account 1",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "credit_builder",
+        },
+        {
+            uuid: "pending-special-offer-uuid-2",
+            name: "Mock Debt Relief Offer",
+            desc: "Description of the debt relief offer",
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            partnerName: "Engine Demo Loans Demand Sub Account 2",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "debt_relief",
+        },
+        {
+            uuid: "pending-special-offer-uuid-3",
+            name: "Mock Installment Loans Offer",
+            desc: "Description of the installment loans offer",
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            partnerName: "Engine Demo Loans Demand Sub Account 3",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "installment_loans",
+        },
+    ],
+    pendingOriginators: [],
+    pendingResponses: [
+        {
+            partner: {
+                uuid: "partner-uuid",
+                name: "partner",
+                description: "partner-description",
+                disclaimer: "partner-disclaimer",
+                supportsPreSelect: false,
+                shouldDisplayPreSelect: false,
+                supportsPersonalizedOffers: false,
+                imageUrl: "partner-image",
+            },
+            productTypes: ["credit_card"],
+        },
+    ],
+};
+const doublePollUuid = "double-poll-uuid";
+const testHost = "https://engine.com";
+const token = "good_auth_token";
+const patchLeadUuid = "patch-lead-uuid";
+const patchLeadUuidResponse = "patch-lead-uuid-response";
+const handlers = [
+    http.post(`${testHost}/blocking/leads/rateTables`, () => {
+        return new HttpResponse(JSON.stringify(fullRateTable), { status: 200 });
+    }),
+    http.post(`${testHost}/leads/rateTables`, () => {
+        return new HttpResponse(JSON.stringify(pendingRateTable), {
+            status: 200,
+        });
+    }),
+    http.get(`${testHost}/originator/rateTables/${pendingRateTable["uuid"]}`, () => {
+        return new HttpResponse(JSON.stringify(fullRateTable), {
+            status: 200,
+        });
+    }),
+    http.get(`${testHost}/originator/rateTables/${doublePollUuid}`, () => {
+        return new HttpResponse(JSON.stringify(pendingRateTable), {
+            status: 200,
+        });
+    }),
+    http.patch(`${testHost}/leads/${patchLeadUuid}`, () => {
+        return new HttpResponse(JSON.stringify({
+            uuid: patchLeadUuidResponse,
+        }));
+    }),
+];
+const server = setupServer(...handlers);
+describe("Leads", () => {
+    beforeAll(() => server.listen({
+        onUnhandledRequest: "error",
+    }));
+    afterEach(() => server.resetHandlers());
+    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);
+        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);
+        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 rateTable = yield resp.resolve();
+        expect(rateTable).toEqual(fullRateTable);
+    }));
+    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);
+    }));
+});

package/dist/rate_tables.d.ts

@@ -0,0 +1,45 @@
+import { Client } from "./client.js";
+import { FixedRateTable } from "./decoders.js";
+export type RateTable = FixedRateTable;
+export interface AsyncRateTableCtorArgs {
+    rateTable?: RateTable;
+    client?: Client;
+    uuid?: string;
+    host?: string;
+    auth_token?: string;
+}
+/**
+ * The class used to fetch rate tables from the Engine API.
+ * This class will handle polling the rate tables endpoint until the pending responses are fulfilled.
+ */
+export declare class AsyncRateTable {
+    private rateTable?;
+    private client;
+    private uuid?;
+    /**
+     * Construct a new AsyncRateTable instance.
+     * @param rateTable - An existing Rate Table structure to start from.
+     * @param uuid - A UUID of an existing Rate Table to fetch.
+     * @param client - A Client instance to use for fetching the data.
+     * @param host - A host used to construct a Client instance if none is provided.
+     * @param auth_token - An authentication token used to construct a Client instance if none is provided.
+     *
+     * @remarks
+     * Either one of rateTable or uuid is required, but providing both is an error.
+     * Similarly, provide either a pre-constructed Client instance or the host and auth_token parameters to construct one but not both.
+     */
+    constructor({ rateTable, uuid, client, host, auth_token, }: AsyncRateTableCtorArgs);
+    /**
+     * Resolve the async Rate Table into a real Rate Table.
+     *
+     * @returns A Rate Table with no pending responses.
+     *
+     * @remarks
+     *
+     * This will only make a network request if one is required.
+     * A network request is required if only a UUID was provided to the constructor, or if the provided Rate Table has pending responses.
+     * This method will also poll the API every second until the returned Rate Table has no more pending responses.
+     */
+    resolve(): Promise<RateTable>;
+    private getRateTable;
+}