@moneylion/engine-api 1.3.4 → 1.3.6

package/README.md

@@ -85,6 +85,65 @@ new AsyncRateTable({ uuid: rateTableUuid, client: client }).resolve();
 new AsyncRateTable({ rateTable: rateTable, client: client }).resolve();
 ```
 
+### Offer Catalog Rate Tables
+
+Offer catalog rate tables work similarly to regular rate tables but use different endpoints and require `offerCatalogProductTypes` instead of `productTypes`.
+
+#### Creating an Offer Catalog Rate Table
+
+```
+import { Leads } from "@moneylion/engine-api";
+
+const leads = new Leads(endpoint, authentication_token);
+
+// The lead data should include offerCatalogProductTypes
+const leadData = {
+  personalInformation: {
+    firstName: "John",
+    lastName: "Doe",
+    email: "john@example.com",
+    // ... other fields
+  },
+  financialInformation: {
+    annualIncome: 75000,
+    // ... other fields
+  },
+  loanInformation: {
+    purpose: "debt_consolidation",
+    loanAmount: 10000
+  },
+  productTypes: ["DebtSettlement"]  // Product types for offer catalog
+};
+
+// First, create or get a lead UUID
+const leadUuid = await leads.create(leadData);
+
+// Non-blocking: returns AsyncOfferCatalogRateTable that you can resolve
+const asyncRateTable = await leads.getOfferCatalogRateTable(leadUuid, leadData);
+const rateTable = await asyncRateTable.resolve();
+
+// Blocking: waits for the final rate table
+const rateTable = await leads.getOfferCatalogRateTableBlocking(leadUuid, leadData);
+```
+
+#### Fetching an Existing Offer Catalog Rate Table
+
+If you already have a rate table UUID, you can fetch it directly:
+
+```
+import { AsyncOfferCatalogRateTable } from "@moneylion/engine-api";
+
+new AsyncOfferCatalogRateTable({ uuid: offerCatalogRateTableUuid, host: endpoint, auth_token: authentication_token }).resolve();
+
+// You can also pass a pre-created client instead of endpoint and token
+new AsyncOfferCatalogRateTable({ uuid: offerCatalogRateTableUuid, client: client }).resolve();
+
+// You can also pass an OfferCatalogRateTable object instead of a uuid.
+new AsyncOfferCatalogRateTable({ rateTable: offerCatalogRateTable, client: client }).resolve();
+```
+
+The `AsyncOfferCatalogRateTable` class handles polling automatically, just like `AsyncRateTable`, waiting for all pending responses to complete before resolving.
+
 ## For Contributors
 
 This is a relatively normal NPM and Typescript project.

package/dist/decoders.d.ts

@@ -43,4 +43,35 @@ type TempRateTableWithNulledFields = {
 export type FixedRateTable = FixNull<TempRateTableWithNulledFields>;
 export declare const rateTableDecoder: Decoder<FixedRateTable>;
 export declare const leadUuidDecoder: Decoder<components["schemas"]["LeadUuid"]>;
+type OfferCatalogOffer = FixNull<{
+    uuid: string;
+    version?: number;
+    productVersions?: number[];
+    productType: string;
+    productDisplayName?: string;
+    headline: string;
+    descriptionPoints: string[];
+    stateExclusions?: string[];
+    badges?: string[];
+    url: string;
+    financialInstitutionUuid: string;
+    financialInstitutionDisplayName: string;
+    financialInstitutionImageUrl: string;
+    enrollmentFeeBasisPointsMin?: number;
+    enrollmentFeeBasisPointsMax?: number;
+    debtAmountCentsMin?: number;
+    recommendationScore: number;
+    isMonetized?: boolean;
+    status?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}>;
+export declare const offerCatalogOfferDecoder: Decoder<OfferCatalogOffer>;
+export type FixedOfferCatalogRateTable = FixNull<{
+    uuid: string;
+    leadUuid: string;
+    offers: Array<OfferCatalogOffer>;
+    pendingResponses?: Array<FixNull<components["schemas"]["PendingResponse"]>>;
+}>;
+export declare const offerCatalogRateTableDecoder: Decoder<FixedOfferCatalogRateTable>;
 export {};

package/dist/decoders.js

@@ -221,3 +221,32 @@ export const rateTableDecoder = object({
 export const leadUuidDecoder = object({
     uuid: string(),
 });
+export const offerCatalogOfferDecoder = object({
+    uuid: string(),
+    version: optional(number()),
+    productVersions: optional(array(number())),
+    productType: string(),
+    productDisplayName: optional(string()),
+    headline: string(),
+    descriptionPoints: array(string()),
+    stateExclusions: optional(array(string())),
+    badges: optional(array(string())),
+    url: string(),
+    financialInstitutionUuid: string(),
+    financialInstitutionDisplayName: string(),
+    financialInstitutionImageUrl: string(),
+    enrollmentFeeBasisPointsMin: optional(number()),
+    enrollmentFeeBasisPointsMax: optional(number()),
+    debtAmountCentsMin: optional(number()),
+    recommendationScore: number(),
+    isMonetized: optional(boolean()),
+    status: optional(string()),
+    createdAt: optional(string()),
+    updatedAt: optional(string()),
+});
+export const offerCatalogRateTableDecoder = object({
+    uuid: string(),
+    leadUuid: string(),
+    offers: array(offerCatalogOfferDecoder),
+    pendingResponses: optional(array(pendingResponseDecoder)),
+});

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/leads.d.ts

@@ -1,4 +1,5 @@
 import { AsyncRateTable, type RateTable } from "./rate_tables.js";
+import { AsyncOfferCatalogRateTable, type OfferCatalogRateTable } from "./offer_catalog_rate_tables.js";
 import type { components } from "./generated/schema";
 export type LeadCreateData = components["schemas"]["LeadCreateData"];
 /**
@@ -89,4 +90,31 @@ export declare class Leads {
      * Only use this if you can handle waiting for that amount of time.
      */
     getRateTableBlocking(leadUuid: string, lead: LeadCreateData): Promise<RateTable>;
+    /**
+     * Create a new offer catalog rate table for a lead.
+     *
+     * @param leadUuid - The UUID of the lead for which to create the rate table.
+     * @param lead - An object representing the lead information.
+     *
+     * @returns AsyncOfferCatalogRateTable
+     *
+     * @remarks
+     * This method returns an AsyncOfferCatalogRateTable.
+     * Use the resolve method on the returned object to retrieve the final Offer Catalog Rate Table.
+     */
+    getOfferCatalogRateTable(leadUuid: string, lead: LeadCreateData): Promise<AsyncOfferCatalogRateTable>;
+    /**
+     * Create a new offer catalog rate table, immediately resolving it.
+     *
+     * @param leadUuid - The UUID of the lead for which to create the rate table.
+     * @param lead - An object representing the lead information.
+     *
+     * @returns OfferCatalogRateTable
+     *
+     * @remarks
+     * This method will immediately resolve the final Offer Catalog 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.
+     */
+    getOfferCatalogRateTableBlocking(leadUuid: string, lead: LeadCreateData): Promise<OfferCatalogRateTable>;
 }

package/dist/leads.js

@@ -9,7 +9,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { Client } from "./client.js";
 import { AsyncRateTable } from "./rate_tables.js";
-import { leadUuidDecoder, rateTableDecoder } from "./decoders.js";
+import { AsyncOfferCatalogRateTable, } from "./offer_catalog_rate_tables.js";
+import { leadUuidDecoder, rateTableDecoder, offerCatalogRateTableDecoder, } 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.
@@ -143,4 +144,47 @@ export class Leads {
             return rateTable;
         });
     }
+    /**
+     * Create a new offer catalog rate table for a lead.
+     *
+     * @param leadUuid - The UUID of the lead for which to create the rate table.
+     * @param lead - An object representing the lead information.
+     *
+     * @returns AsyncOfferCatalogRateTable
+     *
+     * @remarks
+     * This method returns an AsyncOfferCatalogRateTable.
+     * Use the resolve method on the returned object to retrieve the final Offer Catalog Rate Table.
+     */
+    getOfferCatalogRateTable(leadUuid, lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post(`leads/${leadUuid}/offerCatalogRateTables`, lead);
+            const rateTable = offerCatalogRateTableDecoder.runWithException(resp);
+            const asyncRateTable = new AsyncOfferCatalogRateTable({
+                rateTable,
+                client: this.client,
+            });
+            return asyncRateTable;
+        });
+    }
+    /**
+     * Create a new offer catalog rate table, immediately resolving it.
+     *
+     * @param leadUuid - The UUID of the lead for which to create the rate table.
+     * @param lead - An object representing the lead information.
+     *
+     * @returns OfferCatalogRateTable
+     *
+     * @remarks
+     * This method will immediately resolve the final Offer Catalog 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.
+     */
+    getOfferCatalogRateTableBlocking(leadUuid, lead) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.client.post(`blocking/leads/${leadUuid}/offerCatalogRateTables`, lead);
+            const rateTable = offerCatalogRateTableDecoder.runWithException(resp);
+            return rateTable;
+        });
+    }
 }

package/dist/leads.test.js

@@ -12,6 +12,7 @@ import { Leads } from "./leads";
 import { setupServer } from "msw/node";
 import { http, HttpResponse } from "msw";
 import { AsyncRateTable } from "./rate_tables";
+import { AsyncOfferCatalogRateTable } from "./offer_catalog_rate_tables";
 const testLeadData = {
     personalInformation: {
         firstName: "testFirst",
@@ -176,6 +177,56 @@ const pendingRateTable = {
         },
     ],
 };
+const fullOfferCatalogRateTable = {
+    uuid: "full-offer-catalog-rate-table-uuid",
+    leadUuid: "full-lead-uuid",
+    offers: [
+        {
+            uuid: "full-special-offer-uuid",
+            productType: "CreditBuilder",
+            headline: "Mock Credit Builder Offer",
+            descriptionPoints: ["Description of the credit builder offer"],
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 1",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+    ],
+    pendingResponses: [],
+};
+const pendingOfferCatalogRateTable = {
+    uuid: "pending-offer-catalog-rate-table-uuid",
+    leadUuid: "pending-lead-uuid",
+    offers: [
+        {
+            uuid: "pending-special-offer-uuid",
+            productType: "DebtSettlement",
+            headline: "Mock Debt Settlement Offer",
+            descriptionPoints: ["Description of the debt settlement offer"],
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 2",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+    ],
+    pendingResponses: [
+        {
+            partner: {
+                uuid: "partner-uuid",
+                name: "partner",
+                description: "partner-description",
+                disclaimer: "partner-disclaimer",
+                supportsPreSelect: false,
+                shouldDisplayPreSelect: false,
+                supportsPersonalizedOffers: false,
+                imageUrl: "partner-image",
+            },
+            productTypes: ["other"],
+        },
+    ],
+};
 const doublePollUuid = "double-poll-uuid";
 const testHost = "https://engine.com";
 const token = "good_auth_token";
@@ -184,6 +235,8 @@ 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 getOfferCatalogRateTableLeadUuid = "get-offer-catalog-rate-table-lead-uuid";
+const getOfferCatalogRateTableLeadUuidBlocking = "get-offer-catalog-rate-table-lead-uuid-blocking";
 const handlers = [
     http.post(`${testHost}/blocking/leads/rateTables`, () => {
         return new HttpResponse(JSON.stringify(fullRateTable), { status: 200 });
@@ -223,6 +276,22 @@ const handlers = [
             status: 200,
         });
     }),
+    // Offer Catalog endpoints
+    http.post(`${testHost}/leads/${getOfferCatalogRateTableLeadUuid}/offerCatalogRateTables`, () => {
+        return new HttpResponse(JSON.stringify(pendingOfferCatalogRateTable), {
+            status: 200,
+        });
+    }),
+    http.post(`${testHost}/blocking/leads/${getOfferCatalogRateTableLeadUuidBlocking}/offerCatalogRateTables`, () => {
+        return new HttpResponse(JSON.stringify(fullOfferCatalogRateTable), {
+            status: 200,
+        });
+    }),
+    http.get(`${testHost}/originator/offerCatalogRateTables/${pendingOfferCatalogRateTable.uuid}`, () => {
+        return new HttpResponse(JSON.stringify(fullOfferCatalogRateTable), {
+            status: 200,
+        });
+    }),
 ];
 const server = setupServer(...handlers);
 describe("Leads", () => {
@@ -269,4 +338,16 @@ describe("Leads", () => {
         const resp = yield leads.getRateTableBlocking(getRateTableLeadUuidBlocking, testLeadData);
         expect(resp).toEqual(fullRateTable);
     }));
+    test("Get offer catalog 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.getOfferCatalogRateTable(getOfferCatalogRateTableLeadUuid, testLeadData);
+        expect(resp).toBeInstanceOf(AsyncOfferCatalogRateTable);
+        const rateTable = yield resp.resolve();
+        expect(rateTable).toEqual(fullOfferCatalogRateTable);
+    }));
+    test("Get offer catalog 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.getOfferCatalogRateTableBlocking(getOfferCatalogRateTableLeadUuidBlocking, testLeadData);
+        expect(resp).toEqual(fullOfferCatalogRateTable);
+    }));
 });

package/dist/offer_catalog_rate_tables.d.ts

@@ -0,0 +1,45 @@
+import { Client } from "./client.js";
+import { type FixedOfferCatalogRateTable } from "./decoders.js";
+export type OfferCatalogRateTable = FixedOfferCatalogRateTable;
+export interface AsyncOfferCatalogRateTableCtorArgs {
+    rateTable?: OfferCatalogRateTable;
+    client?: Client;
+    uuid?: string;
+    host?: string;
+    auth_token?: string;
+}
+/**
+ * The class used to fetch offer catalog rate tables from the Engine API.
+ * This class will handle polling the offer catalog rate tables endpoint until the pending responses are fulfilled.
+ */
+export declare class AsyncOfferCatalogRateTable {
+    private rateTable?;
+    private client;
+    private uuid?;
+    /**
+     * Construct a new AsyncOfferCatalogRateTable instance.
+     * @param rateTable - An existing Offer Catalog Rate Table structure to start from.
+     * @param uuid - A UUID of an existing Offer Catalog 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, }: AsyncOfferCatalogRateTableCtorArgs);
+    /**
+     * Resolve the async Offer Catalog Rate Table into a real Offer Catalog Rate Table.
+     *
+     * @returns An Offer Catalog 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<OfferCatalogRateTable>;
+    private getRateTable;
+}

package/dist/offer_catalog_rate_tables.js

@@ -0,0 +1,96 @@
+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 { offerCatalogRateTableDecoder, } from "./decoders.js";
+const pollInterval = 1000; // 1 second
+/**
+ * The class used to fetch offer catalog rate tables from the Engine API.
+ * This class will handle polling the offer catalog rate tables endpoint until the pending responses are fulfilled.
+ */
+export class AsyncOfferCatalogRateTable {
+    /**
+     * Construct a new AsyncOfferCatalogRateTable instance.
+     * @param rateTable - An existing Offer Catalog Rate Table structure to start from.
+     * @param uuid - A UUID of an existing Offer Catalog 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, }) {
+        if (client && host && auth_token) {
+            throw new TypeError("Client cannot be provided at the same time as a host and auth_token.");
+        }
+        if (rateTable && uuid) {
+            throw new TypeError("Rate table and uuid cannot be provided at the same time.");
+        }
+        if (client) {
+            this.client = client;
+        }
+        else if (host && auth_token) {
+            this.client = new Client(host, auth_token);
+        }
+        else {
+            throw new TypeError("Either client must be provided or host and auth_token must be provided.");
+        }
+        this.rateTable = rateTable;
+        this.uuid = uuid;
+        if (!this.rateTable && !this.uuid) {
+            throw new TypeError("Either a rate table or a uuid must be provided.");
+        }
+    }
+    /**
+     * Resolve the async Offer Catalog Rate Table into a real Offer Catalog Rate Table.
+     *
+     * @returns An Offer Catalog 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() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.rateTable &&
+                this.rateTable.pendingResponses &&
+                this.rateTable.pendingResponses.length > 0) {
+                const resolved = yield this.getRateTable(this.rateTable.uuid);
+                return new Promise((resolve) => {
+                    setTimeout(() => {
+                        resolve(resolved.resolve());
+                    }, pollInterval);
+                });
+            }
+            if (this.uuid) {
+                const resolved = yield this.getRateTable(this.uuid);
+                return resolved.resolve();
+            }
+            if (this.rateTable) {
+                return this.rateTable;
+            }
+            throw new TypeError("No uuid or rate table was provided to resolve");
+        });
+    }
+    getRateTable(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `originator/offerCatalogRateTables/${uuid}`;
+            const resp = yield this.client.get(endpoint);
+            const rateTable = offerCatalogRateTableDecoder.runWithException(resp);
+            return new AsyncOfferCatalogRateTable({
+                rateTable,
+                client: this.client,
+            });
+        });
+    }
+}

package/dist/offer_catalog_rate_tables.test.d.ts

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

package/dist/offer_catalog_rate_tables.test.js

@@ -0,0 +1,215 @@
+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 { Client } from "./client";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { AsyncOfferCatalogRateTable, } from "./offer_catalog_rate_tables";
+const fullRateTable = {
+    uuid: "full-offer-catalog-rate-table-uuid",
+    leadUuid: "full-lead-uuid",
+    offers: [
+        {
+            uuid: "full-special-offer-uuid",
+            productType: "CreditBuilder",
+            headline: "Mock Credit Builder Offer",
+            descriptionPoints: ["Description of the credit builder offer"],
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 1",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+        {
+            uuid: "full-special-offer-uuid-2",
+            productType: "DebtSettlement",
+            headline: "Mock Debt Relief Offer",
+            descriptionPoints: ["Description of the debt relief offer"],
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 2",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+        {
+            uuid: "full-special-offer-uuid-3",
+            productType: "InstallmentLoans",
+            headline: "Mock Installment Loans Offer",
+            descriptionPoints: ["Description of the installment loans offer"],
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 3",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+    ],
+    pendingResponses: [],
+};
+const pendingRateTable = {
+    uuid: "pending-offer-catalog-rate-table-uuid",
+    leadUuid: "pending-lead-uuid",
+    offers: [
+        {
+            uuid: "pending-special-offer-uuid",
+            productType: "CreditBuilder",
+            headline: "Mock Credit Builder Offer",
+            descriptionPoints: ["Description of the credit builder offer"],
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 1",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+        {
+            uuid: "pending-special-offer-uuid-2",
+            productType: "DebtSettlement",
+            headline: "Mock Debt Relief Offer",
+            descriptionPoints: ["Description of the debt relief offer"],
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 2",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+        {
+            uuid: "pending-special-offer-uuid-3",
+            productType: "InstallmentLoans",
+            headline: "Mock Installment Loans Offer",
+            descriptionPoints: ["Description of the installment loans offer"],
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            financialInstitutionDisplayName: "Engine Demo Loans Demand Sub Account 3",
+            financialInstitutionImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            financialInstitutionUuid: "financial-institution-uuid",
+        },
+    ],
+    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 handlers = [
+    http.get(`${testHost}/originator/offerCatalogRateTables/${pendingRateTable.uuid}`, () => {
+        return new HttpResponse(JSON.stringify(fullRateTable), {
+            status: 200,
+        });
+    }),
+    http.get(`${testHost}/originator/offerCatalogRateTables/${doublePollUuid}`, () => {
+        return new HttpResponse(JSON.stringify(pendingRateTable), {
+            status: 200,
+        });
+    }),
+];
+const server = setupServer(...handlers);
+describe("OfferCatalogRateTables", () => {
+    beforeAll(() => server.listen({
+        onUnhandledRequest: "error",
+    }));
+    afterEach(() => server.resetHandlers());
+    afterAll(() => server.close());
+    test("Either client or host and auth_token must be provided to constructor", () => {
+        expect(() => new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncOfferCatalogRateTable({
+            client: new Client(testHost, token),
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncOfferCatalogRateTable({ uuid: "test-uuid" })).toThrowError(TypeError);
+    });
+    test("Either a rate table or a uuid must be provided to constructor", () => {
+        expect(() => new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+        })).toThrowError(TypeError);
+        expect(() => new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        })).not.toThrowError();
+    });
+    test("Providing both a rate table and a uuid to constructor is an error", () => {
+        expect(() => new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+            uuid: "test-uuid",
+        })).toThrowError(TypeError);
+    });
+    test("Providing both a client instance and a host/auth_token pair is an error", () => {
+        expect(() => new AsyncOfferCatalogRateTable({
+            client: new Client(testHost, token),
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).toThrowError(TypeError);
+    });
+    test("Providing a UUID resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: doublePollUuid,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("Providing a rate table with pending responses resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: pendingRateTable,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("Providing a rate table with no pending responses resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("If there are no pending responses no requests are made when resolving.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncOfferCatalogRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        });
+        let requestSent = false;
+        server.events.on("request:start", () => {
+            requestSent = true;
+        });
+        yield rateTables.resolve();
+        expect(requestSent).toBe(false);
+    }));
+});

package/package.json

@@ -1,48 +1,48 @@
 {
-  "name": "@moneylion/engine-api",
-  "version": "1.3.4",
-  "description": "Interface to engine.tech API",
-  "type": "module",
-  "main": "dist/index.js",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "lint": "prettier . --check && eslint src/",
-    "lint:fix": "prettier . --write && eslint --fix src/",
-    "test": "npm run build && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest dist/",
-    "generate:schema": "openapi-typescript https://even-api-reference.s3.amazonaws.com/releases/branches/public@1.49.0/latest/open-api/public/spec.json -o src/generated/schema.d.ts"
-  },
-  "author": "",
-  "license": "MIT",
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@tsconfig/node18": "^18.2.2",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-tsdoc": "^0.2.17",
-    "jest": "^29.7.0",
-    "msw": "^2.2.10",
-    "openapi-typescript": "^6.7.5",
-    "prettier": "3.2.5",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.2.2"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "dependencies": {
-    "@mojotech/json-type-validation": "^3.1.0",
-    "node-fetch": "^3.3.2"
-  },
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": false,
-    "tabWidth": 4,
-    "trailingComma": "es5",
-    "useTabs": true
-  }
+	"name": "@moneylion/engine-api",
+	"version": "1.3.6",
+	"description": "Interface to engine.tech API",
+	"type": "module",
+	"main": "dist/index.js",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"lint": "prettier . --check && eslint src/",
+		"lint:fix": "prettier . --write && eslint --fix src/",
+		"test": "npm run build && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest dist/",
+		"generate:schema": "openapi-typescript https://even-api-reference.s3.amazonaws.com/releases/branches/public@1.49.0/latest/open-api/public/spec.json -o src/generated/schema.d.ts"
+	},
+	"author": "",
+	"license": "MIT",
+	"devDependencies": {
+		"@jest/globals": "^29.7.0",
+		"@tsconfig/node18": "^18.2.2",
+		"@typescript-eslint/eslint-plugin": "^7.3.1",
+		"@typescript-eslint/parser": "^7.3.1",
+		"eslint": "^8.57.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-tsdoc": "^0.2.17",
+		"jest": "^29.7.0",
+		"msw": "^2.2.10",
+		"openapi-typescript": "^6.7.5",
+		"prettier": "3.2.5",
+		"ts-jest": "^29.1.2",
+		"typescript": "^5.2.2"
+	},
+	"engines": {
+		"node": ">=18"
+	},
+	"dependencies": {
+		"@mojotech/json-type-validation": "^3.1.0",
+		"node-fetch": "^3.3.2"
+	},
+	"prettier": {
+		"quoteProps": "consistent",
+		"singleQuote": false,
+		"tabWidth": 4,
+		"trailingComma": "es5",
+		"useTabs": true
+	}
 }