@moneylion/engine-api 1.0.0

package/README.md

@@ -0,0 +1,8 @@
+# Engine API
+
+This is a Javascript interface to the [Engine](https://engine.tech/docs/api-reference/) API service.
+
+## Getting Started
+
+1. `npm install`
+2. `npm build`

package/dist/builders.d.ts

@@ -0,0 +1,206 @@
+import { components } from "./generated/schema";
+export type LeadCreateData = components["schemas"]["LeadCreateData"];
+export declare class LeadCreateBuilder {
+    private leadData;
+    constructor(startingData?: LeadCreateData);
+    build(): {
+        productTypes?: ("credit_card" | "insurance" | "life_insurance" | "loan" | "mortgage" | "savings" | "other")[] | undefined;
+        uuid?: string | undefined;
+        sessionUuid?: string | undefined;
+        loanInformation?: {
+            purpose?: "other" | "unknown" | "auto" | "auto_purchase" | "auto_refinance" | "baby" | "boat" | "business" | "car_repair" | "cosmetic" | "credit_card_refi" | "debt_consolidation" | "emergency" | "engagement" | "green" | "home_improvement" | "home_purchase" | "home_refi" | "household_expenses" | "large_purchases" | "life_event" | "medical_dental" | "motorcycle" | "moving_relocation" | "rv" | "special_occasion" | "student_loan" | "student_loan_refi" | "taxes" | "vacation" | "wedding" | undefined;
+            loanAmount?: number | undefined;
+        } | undefined;
+        personalInformation?: {
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            aliasFirstName?: string | undefined;
+            aliasLastName?: string | undefined;
+            email?: string | undefined;
+            city?: string | undefined;
+            state?: "AK" | "AL" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VI" | "VT" | "WA" | "WI" | "WV" | "WY" | undefined;
+            workPhone?: string | undefined;
+            primaryPhone?: string | undefined;
+            bestTimeToCall?: "morning" | "afternoon" | "evening" | "night" | undefined;
+            address1?: string | undefined;
+            address2?: string | undefined;
+            addressMoveInDate?: string | undefined;
+            zipcode?: string | undefined;
+            monthsAtAddress?: number | undefined;
+            driversLicenseNumber?: string | undefined;
+            driversLicenseState?: string | undefined;
+            ipAddress?: string | undefined;
+            activeMilitary?: boolean | undefined;
+            militaryVeteran?: boolean | undefined;
+            dateOfBirth?: string | undefined;
+            educationLevel?: "other" | "high_school" | "associate" | "bachelors" | "masters" | "doctorate" | "other_grad_degree" | "certificate" | "did_not_graduate" | "still_enrolled" | undefined;
+            ssn?: string | undefined;
+            citizenshipStatus?: "other" | "citizen" | "permanent_resident" | undefined;
+        } | undefined;
+        personalReferenceInformation?: {
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            primaryPhone?: string | undefined;
+            relationType?: "other" | "parent" | "employer" | "spouse" | "guardian" | "sibling" | "relative" | "friend" | undefined;
+        } | undefined;
+        mortgageInformation?: {
+            propertyType?: "rent" | "condo" | "multi_unit" | "single_family" | "townhouse" | undefined;
+            propertyValue?: number | undefined;
+            mortgageBalance?: number | undefined;
+            lenderName?: string | undefined;
+            hasFHALoan?: boolean | undefined;
+            currentWithLoan?: boolean | undefined;
+            propertyStatus?: "own_outright" | "own_with_mortgage" | "rent" | undefined;
+            mortgageType?: "purchase" | "refinance" | undefined;
+            mortgageAmount?: number | undefined;
+            downPaymentAmount?: number | undefined;
+            propertyState?: string | undefined;
+            propertyCounty?: string | undefined;
+            propertyAddress1?: string | undefined;
+            propertyAddress2?: string | undefined;
+            propertyZipcode?: string | undefined;
+            propertyCity?: string | undefined;
+            refinanceAmount?: number | undefined;
+            cashOutAmount?: number | undefined;
+            occupancyType?: "primary" | "secondary" | "investment" | undefined;
+            refinanceType?: "cash_out" | "rate_term" | undefined;
+            propertySearchStatus?: "found" | "not_found" | undefined;
+            numUnits?: number | undefined;
+            closingDate?: string | undefined;
+            purchaseStatus?: "no_offer" | "offer_accepted" | "offer_pending" | "under_contract" | undefined;
+            purchaseDate?: string | undefined;
+            monthlyHoaFee?: number | undefined;
+            mortgageCompany?: string | undefined;
+            mortgageEscrowAmount?: number | undefined;
+        } | undefined;
+        creditCardInformation?: {
+            allowAnnualFee?: boolean | undefined;
+            cardPurposes?: ("balance_transfer" | "cash_back" | "earning_rewards" | "improve_credit" | "low_interest" | "new_to_credit" | "student" | "travel_incentives")[] | undefined;
+        } | undefined;
+        savingsInformation?: {
+            minDepositAmount?: number | undefined;
+            maxDepositAmount?: number | undefined;
+        } | undefined;
+        creditInformation?: {
+            providedCreditRating?: "excellent" | "good" | "fair" | "poor" | "limited" | "unknown" | undefined;
+            providedNumericCreditScore?: number | undefined;
+        } | undefined;
+        financialInformation?: {
+            employmentStatus?: "other" | "employed" | "employed_full_time" | "employed_part_time" | "military" | "not_employed" | "self_employed" | "retired" | undefined;
+            employmentPayFrequency?: "monthly" | "weekly" | "biweekly" | "twice_monthly" | undefined;
+            annualIncome?: number | undefined;
+            monthlyNetIncome?: number | undefined;
+            bankName?: string | undefined;
+            bankRoutingNumber?: string | undefined;
+            bankAccountType?: "savings" | "other" | "checking" | undefined;
+            creditCardDebt?: number | undefined;
+            monthsAtBank?: number | undefined;
+            bankAccountNumber?: string | undefined;
+            monthlyDebt?: number | undefined;
+            totalAssets?: number | undefined;
+            monthlyHousingPayment?: number | undefined;
+            availableAssets?: number | undefined;
+            additionalIncome?: number | undefined;
+            additionalIncomeFrequency?: "monthly" | "weekly" | "biweekly" | "twice_monthly" | undefined;
+            hasDirectDeposit?: boolean | undefined;
+            totalUnsecuredDebt?: number | undefined;
+        } | undefined;
+        employmentInformation?: {
+            employerName?: string | undefined;
+            employerAddress?: string | undefined;
+            employerAddress2?: string | undefined;
+            employerCity?: string | undefined;
+            employerPhone?: string | undefined;
+            employerState?: string | undefined;
+            employerZip?: string | undefined;
+            jobTitle?: string | undefined;
+            monthsEmployed?: number | undefined;
+            directDeposit?: boolean | undefined;
+            payDate1?: string | undefined;
+            payDate2?: string | undefined;
+            startDate?: string | undefined;
+        } | undefined;
+        legalInformation?: {
+            consentsToFcra?: boolean | undefined;
+            consentsToSms?: boolean | undefined;
+            consentsToTcpa?: boolean | undefined;
+            fcraLanguage?: string | undefined;
+            tcpaLanguage?: string | undefined;
+        } | undefined;
+        educationInformation?: {
+            educationLevel?: "other" | "high_school" | "associate" | "bachelors" | "masters" | "doctorate" | "other_grad_degree" | "certificate" | "did_not_graduate" | "still_enrolled" | undefined;
+            graduateDegreeType?: "other" | "doctor_of_medicine" | "doctor_of_osteopathic_medicine" | "doctor_of_optometry" | "doctor_of_dental_medicine" | "dentariae_medicinae_doctoris" | "doctor_of_dental_surgery" | "doctor_of_veterinary_medicine" | "doctor_of_pharmacy" | "veterinariae_medicinae_doctoris" | "master_of_arts" | "master_of_science" | "master_of_research" | "master_of_research_project" | "master_of_studies" | "master_of_business_administration" | "master_of_library_science" | "master_of_public_administration" | "master_of_public_health" | "master_of_laws" | "master_of_arts_liberal_studies" | "master_of_fine_arts" | "master_of_music" | "master_of_education" | "master_of_engineering" | "master_of_architecture" | "juris_doctor" | undefined;
+            universityAttended?: string | undefined;
+            universityOpeId?: string | undefined;
+            graduationDate?: string | undefined;
+            graduateGraduationDate?: string | undefined;
+            graduateLastAttendedDate?: string | undefined;
+            graduateUniversityAttended?: string | undefined;
+            graduateUniversityOpeId?: string | undefined;
+            undergraduateGraduationDate?: string | undefined;
+            undergraduateLastAttendedDate?: string | undefined;
+            undergraduateUniversityAttended?: string | undefined;
+            undergraduateUniversityOpeId?: string | undefined;
+        } | undefined;
+        coApplicantInformation?: {
+            firstName?: string | undefined;
+            lastName?: string | undefined;
+            dateOfBirth?: string | undefined;
+            annualIncome?: number | undefined;
+            streetAddress1?: string | undefined;
+            streetAddress2?: string | undefined;
+            city?: string | undefined;
+            state?: "AK" | "AL" | "AR" | "AZ" | "CA" | "CO" | "CT" | "DC" | "DE" | "FL" | "GA" | "HI" | "IA" | "ID" | "IL" | "IN" | "KS" | "KY" | "LA" | "MA" | "MD" | "ME" | "MI" | "MN" | "MO" | "MS" | "MT" | "NC" | "ND" | "NE" | "NH" | "NJ" | "NM" | "NV" | "NY" | "OH" | "OK" | "OR" | "PA" | "PR" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VA" | "VI" | "VT" | "WA" | "WI" | "WV" | "WY" | undefined;
+            zipcode?: string | undefined;
+        } | undefined;
+        healthInformation?: {
+            gender?: "male" | "female" | undefined;
+            heightInInches?: number | undefined;
+            weightInPounds?: number | undefined;
+            tobaccoSmoker?: boolean | undefined;
+        } | undefined;
+        refinanceLoans?: {
+            accountNumber?: string | undefined;
+            incomeBasedRepayment?: boolean | undefined;
+            interestRate?: number | undefined;
+            loanAmount?: number | undefined;
+            loanServicer?: string | undefined;
+            loanType?: "federal_student_loan" | "private_student_loan" | undefined;
+            nextPaymentAmount?: number | undefined;
+            nextPaymentDate?: string | undefined;
+        }[] | undefined;
+        identificationInformation?: {
+            idNumber?: string | undefined;
+            idState?: string | undefined;
+            idType?: "driver_license" | "state_id" | "passport" | undefined;
+        } | undefined;
+        clientTags?: {
+            [key: string]: string[];
+        } | undefined;
+        sessionInformation?: {
+            ipAddress?: string | undefined;
+            userAgent?: string | undefined;
+        } | undefined;
+        formCompleted?: boolean | undefined;
+        referralCompanyUuid?: string | undefined;
+        trackingUuid?: string | undefined;
+    };
+    productTypes(types: components["schemas"]["ProductType"][]): this;
+    loanInformation(loanInfo: components["schemas"]["LeadLoanInformation"]): this;
+    personalInformation(personalInfo: components["schemas"]["LeadPersonalInformation"]): this;
+    personalReferenceInformation(pRefInfo: components["schemas"]["PersonalReferenceInformation"]): this;
+    mortgageInformation(mortgageInfo: components["schemas"]["LeadMortgageInformation"]): this;
+    creditCardInformation(creditCardInformation: components["schemas"]["LeadCreditCardInformation"]): this;
+    savingsInformation(savingsInformation: components["schemas"]["LeadSavingsInformation"]): this;
+    creditInformation(creditInformation: components["schemas"]["LeadCreditInformation"]): this;
+    financialInformation(financialInformation: components["schemas"]["LeadFinancialInformation"]): this;
+    employmentInformation(employmentInformation: components["schemas"]["LeadEmploymentInformation"]): this;
+    legalInformation(legalInformation: components["schemas"]["LeadLegalInformation"]): this;
+    educationInformation(educationInformation: components["schemas"]["LeadEducationInformation"]): this;
+    coApplicantInformation(coApplicantInformation: components["schemas"]["LeadCoApplicantInformation"]): this;
+    healthInformation(healthInformation: components["schemas"]["LeadHealthInformation"]): this;
+    refinanceLoans(refinanceLoans: components["schemas"]["RefinanceLoanInformation"][]): this;
+    identificationInformation(identificationInformation: components["schemas"]["LeadIdentificationInformation"]): this;
+    clientTags(clientTags: components["schemas"]["ClientTags"]): this;
+    sessionInformation(sessionInformation: components["schemas"]["LeadSessionInformation"]): this;
+}

package/dist/builders.js

@@ -0,0 +1,80 @@
+export class LeadCreateBuilder {
+    constructor(startingData = {}) {
+        this.leadData = startingData;
+    }
+    build() {
+        return this.leadData;
+    }
+    productTypes(types) {
+        this.leadData.productTypes = types;
+        return this;
+    }
+    loanInformation(loanInfo) {
+        this.leadData.loanInformation = loanInfo;
+        return this;
+    }
+    personalInformation(personalInfo) {
+        this.leadData.personalInformation = personalInfo;
+        return this;
+    }
+    personalReferenceInformation(pRefInfo) {
+        this.leadData.personalReferenceInformation = pRefInfo;
+        return this;
+    }
+    mortgageInformation(mortgageInfo) {
+        this.leadData.mortgageInformation = mortgageInfo;
+        return this;
+    }
+    creditCardInformation(creditCardInformation) {
+        this.leadData.creditCardInformation = creditCardInformation;
+        return this;
+    }
+    savingsInformation(savingsInformation) {
+        this.leadData.savingsInformation = savingsInformation;
+        return this;
+    }
+    creditInformation(creditInformation) {
+        this.leadData.creditInformation = creditInformation;
+        return this;
+    }
+    financialInformation(financialInformation) {
+        this.leadData.financialInformation = financialInformation;
+        return this;
+    }
+    employmentInformation(employmentInformation) {
+        this.leadData.employmentInformation = employmentInformation;
+        return this;
+    }
+    legalInformation(legalInformation) {
+        this.leadData.legalInformation = legalInformation;
+        return this;
+    }
+    educationInformation(educationInformation) {
+        this.leadData.educationInformation = educationInformation;
+        return this;
+    }
+    coApplicantInformation(coApplicantInformation) {
+        this.leadData.coApplicantInformation = coApplicantInformation;
+        return this;
+    }
+    healthInformation(healthInformation) {
+        this.leadData.healthInformation = healthInformation;
+        return this;
+    }
+    refinanceLoans(refinanceLoans) {
+        this.leadData.refinanceLoans = refinanceLoans;
+        return this;
+    }
+    identificationInformation(identificationInformation) {
+        this.leadData.identificationInformation = identificationInformation;
+        return this;
+    }
+    clientTags(clientTags) {
+        this.leadData.clientTags = clientTags;
+        return this;
+    }
+    sessionInformation(sessionInformation) {
+        this.leadData.sessionInformation = sessionInformation;
+        return this;
+    }
+}

package/dist/client.d.ts

@@ -0,0 +1,91 @@
+type HttpMethod = "GET" | "POST" | "PATCH" | "DELETE";
+/**
+ * The base HTTP client that the API clients depend on.
+ * It handles setting the appropriate headers and also handles serialization and deserialization.
+ * Error status codes will be raised as an exception.
+ *
+ * You should not need to use this in regular usage.
+ * It is provided as an escape hatch in case something isn't covered by the more specific APIs.
+ */
+export declare class Client {
+    private host;
+    private auth_token;
+    /**
+     * Construct a new client instance.
+     * @param host - The API host URL. Example: https://www.example.com. Should not include a trailing slash.
+     * @param auth_token - The auth token used for authenticating with the API.
+     */
+    constructor(host: string | undefined, auth_token: string);
+    /**
+     * Make a GET request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise
+     */
+    get(endpoint: string): Promise<object>;
+    /**
+     * Make a POST request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param body - A javascript object to be serialized and sent with the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    post(endpoint: string, body?: object): Promise<object>;
+    /**
+     * Make a PATCH request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param body - A javascript object to be serialized and sent with the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    patch(endpoint: string, body?: object): Promise<object>;
+    /**
+     * Make a request with an arbitrary method.
+     *
+     * @remarks
+     * You should not need to use this during regular usage of the client.
+     * It's provided as an escape hatch in case you need something that isn't provided.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param method - An HTTP method name as a string. One of "GET", "PUT", "PATCH", or "DELETE".
+     * @param body - A string representing the serialized body of the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    request(endpoint: string, method: HttpMethod, body?: string): Promise<object>;
+}
+/** The generic error class used to represent error status codes such as 400 Bad Request.
+ */
+export declare class ApiError extends Error {
+    /** The HTTP status code.
+     */
+    failureStatus: number;
+    /** The url that was requested.
+     */
+    url: string;
+    /** The HTTP method that was used for the request.
+     */
+    method: HttpMethod;
+    /** The serialized body.
+     */
+    body?: string;
+    constructor(failureStatus: number, failureReason: string, url: string, method: HttpMethod, body?: string);
+}
+/**
+ * An error that the caller has made in the request.
+ * You should fix the error and then repeat the request.
+ */
+export declare class ClientError extends ApiError {
+}
+/** An error that occurred on the server.
+ */
+export declare class ServerError extends ApiError {
+}
+/** An error that occurred during authentication.
+ */
+export declare class AuthenticationError extends ApiError {
+}
+export {};

package/dist/client.js

@@ -0,0 +1,127 @@
+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());
+    });
+};
+/**
+ * The base HTTP client that the API clients depend on.
+ * It handles setting the appropriate headers and also handles serialization and deserialization.
+ * Error status codes will be raised as an exception.
+ *
+ * You should not need to use this in regular usage.
+ * It is provided as an escape hatch in case something isn't covered by the more specific APIs.
+ */
+export class Client {
+    /**
+     * Construct a new client instance.
+     * @param host - The API host URL. Example: https://www.example.com. Should not include a trailing slash.
+     * @param auth_token - The auth token used for authenticating with the API.
+     */
+    constructor(host = "https://api.evenfinancial.com", auth_token) {
+        this.host = host;
+        this.auth_token = auth_token;
+    }
+    /**
+     * Make a GET request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise
+     */
+    get(endpoint) {
+        return this.request(endpoint, "GET");
+    }
+    /**
+     * Make a POST request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param body - A javascript object to be serialized and sent with the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    post(endpoint, body) {
+        return this.request(endpoint, "POST", body ? JSON.stringify(body) : body);
+    }
+    /**
+     * Make a PATCH request.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param body - A javascript object to be serialized and sent with the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    patch(endpoint, body) {
+        return this.request(endpoint, "PATCH", body ? JSON.stringify(body) : body);
+    }
+    /**
+     * Make a request with an arbitrary method.
+     *
+     * @remarks
+     * You should not need to use this during regular usage of the client.
+     * It's provided as an escape hatch in case you need something that isn't provided.
+     *
+     * @param endpoint - The endpoint to make the request against. Should not include a leading slash.
+     * @param method - An HTTP method name as a string. One of "GET", "PUT", "PATCH", or "DELETE".
+     * @param body - A string representing the serialized body of the request.
+     *
+     * @returns A deserialized Javascript object wrapped in a Promise.
+     */
+    request(endpoint, method, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const url = `${this.host}/${endpoint}`;
+            const response = yield fetch(url, {
+                method: method,
+                headers: {
+                    "Content-Type": "application/json",
+                    "Accept": "application/json",
+                    "Authorization": `Bearer ${this.auth_token}`,
+                },
+                body: body,
+            });
+            if (response.status >= 500) {
+                throw new ServerError(response.status, response.statusText, url, method, body);
+            }
+            if (response.status >= 400) {
+                if (response.status === 401 || response.status === 403) {
+                    throw new AuthenticationError(response.status, response.statusText, url, method, body);
+                }
+                throw new ClientError(response.status, response.statusText, url, method, body);
+            }
+            /* node-fetch types json() as Promise<unknown> to ensure the consumer makes a decision about the
+             * type. We are deciding here to treat it as an object so that consumers of this method can introspect
+             * it further more easily.
+             */
+            const json = (yield response.json());
+            return json;
+        });
+    }
+}
+/** The generic error class used to represent error status codes such as 400 Bad Request.
+ */
+export class ApiError extends Error {
+    constructor(failureStatus, failureReason, url, method, body) {
+        super(failureReason);
+        this.failureStatus = failureStatus;
+        this.url = url;
+        this.method = method;
+        this.body = body;
+    }
+}
+/**
+ * An error that the caller has made in the request.
+ * You should fix the error and then repeat the request.
+ */
+export class ClientError extends ApiError {
+}
+/** An error that occurred on the server.
+ */
+export class ServerError extends ApiError {
+}
+/** An error that occurred during authentication.
+ */
+export class AuthenticationError extends ApiError {
+}

package/dist/client.test.d.ts

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

package/dist/client.test.js

@@ -0,0 +1,78 @@
+import { describe, expect, test, beforeAll, afterEach, afterAll, } from "@jest/globals";
+import { Client, AuthenticationError, ClientError, ServerError, } from "./client";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+const successBody = { response: "Okay" };
+const handlers = [
+    http.get("https://example.com/auth_error", () => {
+        return new HttpResponse(null, { status: 401 });
+    }),
+    http.post("https://example.com/bad_request", () => {
+        return new HttpResponse(null, { status: 400 });
+    }),
+    http.get("https://example.com/server_error", () => {
+        return new HttpResponse(null, { status: 500 });
+    }),
+    http.get("https://example.com/network_error", () => {
+        return HttpResponse.error();
+    }),
+    http.get("https://example.com/success", () => {
+        return HttpResponse.json(successBody);
+    }),
+    http.post("https://example.com/success", () => {
+        return HttpResponse.json(successBody);
+    }),
+    http.patch("https://example.com/success", () => {
+        return HttpResponse.json(successBody);
+    }),
+];
+const server = setupServer(...handlers);
+describe("Client", () => {
+    beforeAll(() => server.listen({
+        onUnhandledRequest: "error",
+    }));
+    afterEach(() => server.resetHandlers());
+    afterAll(() => server.close());
+    const testEndpoint = "https://example.com";
+    test("Authentication error is raised when auth token is incorrect", () => {
+        const bad_token = "bad_token";
+        const client = new Client(testEndpoint, bad_token);
+        const response = client.request("auth_error", "GET");
+        return expect(response).rejects.toThrow(AuthenticationError);
+    });
+    test("Client error is raised when request is incorrect", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.request("bad_request", "POST", JSON.stringify({ test: "body" }));
+        return expect(response).rejects.toThrow(ClientError);
+    });
+    test("Server error is raised when the server encounters a problem", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.request("server_error", "GET");
+        return expect(response).rejects.toThrow(ServerError);
+    });
+    test("Successful response returns decoded JSON object", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.request("success", "GET");
+        return expect(response).resolves.toEqual(successBody);
+    });
+    test("Can make GET requests", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.get("success");
+        return expect(response).resolves.toEqual(successBody);
+    });
+    test("Can make POST requests", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.post("success", { test: "body" });
+        return expect(response).resolves.toEqual(successBody);
+    });
+    test("Can make PATCH requests", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.patch("success", { test: "body" });
+        return expect(response).resolves.toEqual(successBody);
+    });
+    test("Network error is raised when there is a network error", () => {
+        const client = new Client(testEndpoint, "good_token");
+        const response = client.request("network_error", "GET");
+        return expect(response).rejects.toThrow(TypeError);
+    });
+});

package/dist/decoders.d.ts

@@ -0,0 +1,40 @@
+import { Decoder } from "@mojotech/json-type-validation";
+import { components } from "./generated/schema";
+type FixNull<T> = T extends object ? {
+    [P in keyof T]: undefined extends T[P] ? FixNull<T[P] | null> : FixNull<T[P]>;
+} : T extends Array<infer X> ? FixNull<X>[] : T;
+export declare const cardPurposeDecoder: Decoder<components["schemas"]["CardPurpose"]>;
+export declare const termUnitDecoder: Decoder<components["schemas"]["TermUnit"]>;
+export declare const introOfferTypeDecoder: Decoder<components["schemas"]["IntroOfferType"]>;
+export declare const cardTypeDecoder: Decoder<components["schemas"]["CardType"]>;
+export declare const providedCreditRatingDecoder: Decoder<components["schemas"]["ProvidedCreditRating"]>;
+type CardBenefit = components["schemas"]["CardBenefit"];
+export declare const cardBenefitDecoder: Decoder<CardBenefit>;
+export declare const creditCardOfferDetailsDecoder: Decoder<FixNull<components["schemas"]["CreditCardOfferDetails"]>>;
+export declare const partnerDecoder: Decoder<FixNull<components["schemas"]["Partner"]>>;
+export declare const productTypeDecoder: Decoder<components["schemas"]["ProductType"]>;
+type ProductSubType = components["schemas"]["ProductSubType"];
+export declare const productSubTypeDecoder: Decoder<ProductSubType>;
+export declare const offerDecoder: Decoder<FixNull<components["schemas"]["Offer"]>>;
+export declare const creditCardOfferDecoder: Decoder<FixNull<components["schemas"]["CreditCardOffer"]>>;
+export declare const originatorImageDecoder: Decoder<components["schemas"]["OriginatorImage"]>;
+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>;
+export declare const loanOfferDecoder: Decoder<LoanOffer>;
+export declare const mortgageLoanTypeDecoder: Decoder<components["schemas"]["MortgageLoanType"]>;
+export declare const mortgageAdjustmentTypeDecoder: Decoder<components["schemas"]["MortgageAdjustmentType"]>;
+export declare const mortageOfferDetailsDecoder: Decoder<components["schemas"]["MortgageOfferDetails"]>;
+export declare const mortgageOfferDecoder: Decoder<FixNull<components["schemas"]["MortgageOffer"]>>;
+export declare const compoundingMethodDecoder: Decoder<components["schemas"]["CompoundingMethod"]>;
+export declare const federalInsuranceTypeDecoder: Decoder<components["schemas"]["FederalInsuranceType"]>;
+export declare const savingsOfferDetailsDecoder: Decoder<FixNull<components["schemas"]["SavingsOfferDetails"]>>;
+export declare const savingsOfferDecoder: Decoder<FixNull<components["schemas"]["SavingsOffer"]>>;
+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>;
+export declare const rateTableDecoder: Decoder<FixedRateTable>;
+export declare const leadUuidDecoder: Decoder<components["schemas"]["LeadUuid"]>;
+export {};