@moneylion/react-native-offer-carousel 1.0.0 → 1.0.2

package/src/capabilities/offers/pipeline/src/sources/ratetables/offer-catalog/types/oas/offer-catalog.ts

@@ -0,0 +1,2272 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+/** WithRequired type helpers */
+type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }
+
+export interface components {
+	schemas: {
+		ApiError: {
+			/** @description The attribute that this error applies to. Omitted if this error is not in the context of a resource, or cannot be isolated to a single attribute. */
+			attribute?: string;
+			/** @description A classification for this error, which can be used to render the appropriate custom error template, or take other programmatic actions. */
+			type?: string;
+			/** @description Variables associated with this error that can be injected into a custom error template, or used to parameterize any other programatic actions. */
+			details?: {
+				[key: string]: string;
+			};
+			/** @description A human-readable, English description of the error. */
+			message?: string;
+		};
+		/** @enum {string} */
+		AprType: "variable" | "regular" | "fixed";
+		AutoInsuranceInformation: {
+			/** Format: int32 */
+			numberOfVehicles?: number;
+			hasAutoInsurance?: boolean;
+		};
+		/** @enum {string} */
+		BankAccountType: "checking" | "savings" | "other";
+		BasicRateTablePendingResponse: {
+			partner: components["schemas"]["DemandPartner"];
+			/** @description Limits results to leads that have the specified productTypes from the Product catalog */
+			offerCatalogProductTypes: string[];
+		};
+		/** @enum {string} */
+		BestTimeToCall: "morning" | "afternoon" | "evening" | "night";
+		/** @description Personalized values calculated for a specific bonus, such as a Sign On Bonus */
+		BonusPersonalization: {
+			/** @description Were the conditions of the bonus met */
+			minimumSpendMet?: boolean;
+			/** @description The amount of spend the user had within the time period of the bonus */
+			qualifyingSpend?: string;
+		};
+		/**
+		 * @description Benefits or benefit categories related to a credit card
+		 * @enum {string}
+		 */
+		CardBenefits:
+			| "No Foreign Transaction Fees"
+			| "Purchase Protection"
+			| "Return Protection"
+			| "Price Protection"
+			| "Fraud Protection"
+			| "Extended Warranty"
+			| "Travel Accident Insurance"
+			| "Trip Interruption Insurance"
+			| "Car Rental Insurance"
+			| "Baggage Insurance"
+			| "Baggage Delay Insurance"
+			| "Hotel Burglary Insurance"
+			| "Travel & Emergency Assistance"
+			| "Roadside Assistance"
+			| "Concierge Service"
+			| "Lounge Access"
+			| "Identity Theft Assistance"
+			| "In-Flight Savings"
+			| "Free Checked Bag"
+			| "Priority Boarding"
+			| "No Blackout Dates"
+			| "Free Companion Ticket"
+			| "Discount Companion Ticket"
+			| "Global Entry or TSA PreCheck"
+			| "Private Jet Perks"
+			| "Lounge Access Discount"
+			| "24/7 Cardholder Support"
+			| "Authorized User"
+			| "Entertainment Access"
+			| "Airline Fee Credit"
+			| "Late Fee Pass"
+			| "Credit Score Reporting"
+			| "No Flight Change Fees"
+			| "24/7 Account Monitoring"
+			| "Amex Offers"
+			| "Visa Signature Offers"
+			| "MasterCard Offers"
+			| "Free Hotel Stay"
+			| "Extended Hotel Stay"
+			| "Dining Concierge"
+			| "2 Lounge Passes"
+			| "Hilton Honors Silver Membership"
+			| "Hilton Honors Gold Membership"
+			| "World of Hyatt Discoverist Status"
+			| "SPG Gold Membership"
+			| "Marriott Rewards Silver Status"
+			| "Hertz Presidents Circle Elite Status"
+			| "2 Free Checked Bags"
+			| "Auto Discounts"
+			| "InCircle Partnership"
+			| "ShopRunner"
+			| "WiFi Access"
+			| "ShopSafe"
+			| "BoA Preferred Rewards"
+			| "MasterCard Fuel Rewards Network"
+			| "Missed Event Ticket Protection"
+			| "Account Freezing"
+			| "Cell Phone Protection"
+			| "GPA Rewards"
+			| "In-Flight WiFi Credit"
+			| "Citi Private Pass"
+			| "Priceless Cities"
+			| "The Hotel Collection"
+			| "By Invitation Only"
+			| "Luxury Hotel Collection"
+			| "Expedia+ Silver Status"
+			| "Expedia+ Gold Status"
+			| "$100 American Airlines Discount"
+			| "Disney Parks Perks and Savings"
+			| "Ritz-Carlton Gold Elite Status"
+			| "Ritz-Carlton Club Level Upgrade"
+			| "Annual Travel Credit"
+			| "IHG Platinum Elite Status"
+			| "QuickBooks Connect"
+			| "ReceiptMatch"
+			| "Employee Spending Limits"
+			| "FX International Payments"
+			| "No Pre-Set Spending Limit"
+			| "Purchase Financing"
+			| "Amex Open Savings"
+			| "Amazon Special Financing"
+			| "$100 Ritz-Carlton Hotel Credit"
+			| "British Airways Companion Ticket"
+			| "Mercedes-Benz Gift Certificates"
+			| "Mercedes-Benz Excess Mileage Waiver"
+			| "JetBlue Annual Statement Credit"
+			| "20% Discount on Delta Flights for Delta Private Jet Members"
+			| "Expense Report Features"
+			| "Business Cell Phone Protection"
+			| "Free Shipping on most Target.com orders"
+			| "30 Extra Days for Returns"
+			| "Free clothing altertaions"
+			| "Personal shopping"
+			| "Shopmyway Savings"
+			| "Online Subscription Credit"
+			| "Uber Exclusive Access"
+			| "Airline Benefits"
+			| "Hotel Benefits"
+			| "Other Travel Benefits"
+			| "Emergency Assistance"
+			| "Experiences"
+			| "Shopping Benefits"
+			| "Cardholder Benefits"
+			| "Enhanced Security"
+			| "Business Benefits"
+			| "Other Benefits"
+			| "In-Flight Discounts"
+			| "Fee Coverage"
+			| "Flight Credits & Discounts"
+			| "Hotel Membership Status"
+			| "Hotel Credit & Free Stays"
+			| "Travel Credit"
+			| "Travel Experiences Programs"
+			| "Car Rental Membership Status"
+			| "Extra Gas Rewards"
+			| "Shopping Protection"
+			| "Shopping Discounts"
+			| "Free Shipping"
+			| "The Boingo American Express Preferred Plan"
+			| "AirSpace Lounge"
+			| "Uber Monthly Credit"
+			| "Ride Share Benefits"
+			| "Delta Sky Club"
+			| "Admirals Club Membership"
+			| "Priority Pass Select Membership (Prestige)"
+			| "Priority Pass Select Membership (Standard Plus)"
+			| "Daily Breakfast"
+			| "Early Check-in & Late Check-out"
+			| "Room Upgrades"
+			| "Complementary WiFi"
+			| "Amex Hotel Collection Credit"
+			| "Temporary Account Numbers"
+			| "One-Time 50% Discount on Companion Ticket"
+			| "Airline Travel Credit"
+			| "United Club Membership"
+			| "Chip Technology"
+			| "Earn More Miles for Sharing Travel Stories"
+			| "Mastercard World Elite Concierge and Luxury Travel Benefits"
+			| "20% Savings on Delta In-Flight Purchases"
+			| "25% Savings on United In-Flight Food and Drink Purchases"
+			| "$100 Hilton Properties Credit"
+			| "$250 Hilton Resort Credit"
+			| "Hilton Honors Diamond Membership"
+			| "Free Birthday Gift"
+			| "2x Points During Your Birthday Month"
+			| "Car Rental VIP Perks"
+			| "Free shipping with the purchase of a bra"
+			| "Monthly Dining Credit"
+			| "Amazon Prime Student";
+		/**
+		 * @description Purposes or categories related to a credit card
+		 * @enum {string}
+		 */
+		CardPurpose:
+			| "balance_transfer"
+			| "cash_back"
+			| "earning_rewards"
+			| "improve_credit"
+			| "low_interest"
+			| "new_to_credit"
+			| "student"
+			| "travel_incentives";
+		/** @enum {string} */
+		CardType: "visa" | "mastercard" | "american_express" | "discover";
+		/**
+		 * @description Carrier decision speed
+		 * @enum {string}
+		 */
+		CarrierDecisionType: "instant" | "non_instant";
+		/**
+		 * @description Citizenship status
+		 * @enum {string}
+		 */
+		CitizenshipStatus: "citizen" | "permanent_resident" | "other";
+		/**
+		 * @description Arbitrary key-values mappings to associate with a `Lead`. This field can be use to attach `subid`s to a `Lead`
+		 * @example {
+		 *   "subid": [
+		 *     "123"
+		 *   ]
+		 * }
+		 */
+		ClientTags: {
+			[key: string]: string[];
+		};
+		/**
+		 * @description The personal information of a co-applicant that may be considered in the
+		 * underwriting and approval of a loan.
+		 */
+		CoApplicantInformation: {
+			firstName?: string;
+			lastName?: string;
+			/** Format: date */
+			dateOfBirth?: string;
+			/** Format: int32 */
+			annualIncome?: number;
+			/** @description Street address (primary address line) */
+			streetAddress1?: string;
+			/** @description Secondary address line */
+			streetAddress2?: string;
+			city?: string;
+			state?: components["schemas"]["State"];
+			zipcode?: string;
+		};
+		CreditCardInformation: {
+			allowAnnualFee?: boolean;
+			/** @description A list of card purposes in which the lead is interested */
+			cardPurposes?: components["schemas"]["CardPurpose"][];
+		};
+		/** @description Credit history information relating to a `Lead` */
+		CreditInformation: {
+			providedCreditRating?: components["schemas"]["ProvidedCreditRating"];
+			/**
+			 * Format: int32
+			 * @description FICO credit score provided by a `Lead`
+			 */
+			providedNumericCreditScore?: number;
+		};
+		/** @enum {string} */
+		CreditCardIntroOfferType: "miles" | "points" | "statement_credit";
+		/** @description An offer for a credit card */
+		CreditCardOffer: WithRequired<
+			{
+				details: components["schemas"]["CreditCardOfferDetails"];
+			} & components["schemas"]["Offer"],
+			"details"
+		>;
+		CreditCardOfferDetails: {
+			/** @description Display name of the card */
+			cardName?: string;
+			/** Format: url */
+			cardImageUrl: string;
+			cardPurposes?: components["schemas"]["CardPurpose"][];
+			/**
+			 * Format: url
+			 * @description External link to card rates, terms and conditions
+			 */
+			ratesUrl?: string;
+			maxPurchaseApr?: number;
+			minPurchaseApr?: number;
+			purchaseAprText?: string;
+			maxPurchaseIntroApr?: number;
+			minPurchaseIntroApr?: number;
+			/** Format: int32 */
+			purchaseIntroAprTerm?: number;
+			purchaseIntroAprTermUnit?: components["schemas"]["LoanTermUnit"];
+			purchaseIntroAprText?: string;
+			maxCashAdvanceApr?: number;
+			minCashAdvanceApr?: number;
+			cashAdvanceAprText?: string;
+			maxCashAdvanceIntroApr?: number;
+			minCashAdvanceIntroApr?: number;
+			/** Format: int32 */
+			cashAdvanceIntroAprTerm?: number;
+			cashAdvanceIntroAprTermUnit?: components["schemas"]["LoanTermUnit"];
+			cashAdvanceIntroAprText?: string;
+			maxBalanceTransferApr?: number;
+			minBalanceTransferApr?: number;
+			balanceTransferAprText?: string;
+			maxBalanceTransferIntroApr?: number;
+			minBalanceTransferIntroApr?: number;
+			/** Format: int32 */
+			balanceTransferIntroAprTerm?: number;
+			balanceTransferIntroAprTermUnit?: components["schemas"]["LoanTermUnit"];
+			balanceTransferIntroAprText?: string;
+			maxAnnualFee?: number;
+			minAnnualFee?: number;
+			annualIntroFee?: number;
+			/**
+			 * Format: int32
+			 * @description Number of _years_ the introductory anual fee is in effect
+			 */
+			annualIntroFeeTerm?: number;
+			introOfferAmount?: number;
+			introOfferText?: string;
+			introOfferType?: components["schemas"]["CreditCardIntroOfferType"];
+			/** @description List of card features which must be prominently displayed with the offer */
+			details?: string[];
+			/** @description List of card features which must be displayed with the offer */
+			additionalDetails?: string[];
+			cardType: components["schemas"]["CardType"];
+			minimumCreditLine?: number;
+			minimumPenaltyApr?: number;
+			maximumPenaltyApr?: number;
+			balanceTransferFee?: number;
+			cashAdvanceFee?: number;
+			lateFee?: number;
+			foreignExchangeFee?: number;
+			accountOpeningFee?: number;
+			returnPaymentFee?: number;
+			monthlyServiceFee?: number;
+			recommendedCreditRatings?: components["schemas"]["ProvidedCreditRating"][];
+			preQualified: boolean;
+			preApproved: boolean;
+			/** @description Indicates that Engine by MoneyLion has determined that the user has an increased likelihood of being approved for this card. */
+			preSelected: boolean;
+			/**
+			 * Format: double
+			 * @description Percentage represented in decimal format added to all foreign transactions
+			 */
+			foreignTransactionFee?: number;
+			cardBenefits?: components["schemas"]["CardBenefits"][];
+		};
+		DeduplicationConfiguration: {
+			/**
+			 * Format: int64
+			 * @description A unique, internal identifier for this resource.
+			 */
+			id: number;
+			/**
+			 * Format: int64
+			 * @description The ID of the supply sub-account for this configuration.
+			 */
+			supplySubAccountId: number;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the supply sub-account for this configuration.
+			 */
+			supplySubAccountUuid: string;
+			/**
+			 * Format: int32
+			 * @description The number of minutes to look back when looking for duplicate leads.
+			 */
+			durationMinutes: number;
+			/**
+			 * Format: date-time
+			 * @description When the resource was created.
+			 */
+			createdAt: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the access token that was used to create this resource.
+			 */
+			createdBy: string;
+			/**
+			 * Format: date-time
+			 * @description When the resource was deleted.
+			 */
+			deletedAt?: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the access token that was used to delete this resource.
+			 */
+			deletedBy?: string;
+		};
+		/** @enum {string} */
+		DeduplicationConfigurationSort:
+			| "id"
+			| "supplySubAccountId"
+			| "durationMinutes"
+			| "createdAt"
+			| "deletedAt";
+		DemandPartner: {
+			/** Format: uuid */
+			uuid: string;
+			name: string;
+			description: string;
+			disclaimer: string;
+			supportsPreSelect: boolean;
+			shouldDisplayPreSelect: boolean;
+			/** @description Whether the partner supports returning pre-qualified or pre-approved offers */
+			supportsPersonalizedOffers: boolean;
+			/** Format: url */
+			imageUrl: string;
+			subtextOverride?: string;
+		};
+		/** @description An earning event which is based on spend or is over time */
+		EarningBonus: {
+			type: components["schemas"]["EarningBonusType"];
+			name: components["schemas"]["EarningBonusName"];
+			bonus: string;
+			redemptionValue: string;
+			requirement: string;
+			personalization?: components["schemas"]["BonusPersonalization"];
+		};
+		/** @enum {string} */
+		EarningBonusName:
+			| "Sign-Up Bonus"
+			| "Anniversary Bonus"
+			| "Annual Bonus"
+			| "Usage Bonus";
+		/** @enum {string} */
+		EarningBonusType: "One Time" | "Recurring";
+		/** @description A context around a nuumber of earning groups, such as caps, tiers, etc */
+		EarningContext: {
+			type: components["schemas"]["EarningContextType"];
+			/** @description The earning groups relevent in this context */
+			groups: components["schemas"]["EarningGroup"][];
+			/** @description A phrase describing the context around the earning groups */
+			detail?: string;
+			/** @description A full sentence describing the context around the earning groups */
+			explaination?: string;
+			personalization?: components["schemas"]["EarningItemPersonalization"];
+		};
+		/**
+		 * @description The type of context this is. Basic contexts have no details.
+		 * @enum {string}
+		 */
+		EarningContextType:
+			| "basic"
+			| "calculation"
+			| "introductory"
+			| "rotating"
+			| "capped";
+		/** @description A group of qualifiers which share the same default earn rate */
+		EarningGroup: {
+			/** @description Numerical representation of the earn rate for this group */
+			earnRate: number;
+			/** @description Display text for what the group earns */
+			earnRateText: string;
+			items: components["schemas"]["EarningItem"][];
+			personalization?: components["schemas"]["EarningItemPersonalization"];
+		};
+		/** @description An association of an earn rate and a qualifier, like a category or merchant */
+		EarningItem: {
+			type: components["schemas"]["EarningItemType"];
+			/** @description Numerical representation of the default earn rate per dollar spent of the item */
+			earnRate?: number;
+			personalization?: components["schemas"]["EarningItemPersonalization"];
+			/** @description An association of an earn rate and a category */
+			category?: components["schemas"]["MerchantCategory"];
+			/** @description An association of an earn rate and a merchant */
+			merchant?: components["schemas"]["Merchant"];
+		};
+		/** @description Personalized values calculated for a specific item, such as an earning group or bonus */
+		EarningItemPersonalization: {
+			/** @description The amount the user spent in dollars within a calendar year */
+			totalSpent?: number;
+			/** @description The amount of points/miles/dollars the user would have received within a calendar year */
+			totalEarned?: number;
+			/** @description The value in USD of the totalEarned amount based on the user's custom point valuation */
+			totalValue?: number;
+		};
+		/**
+		 * @description Refers to the type (and schema) of the item
+		 * @enum {string}
+		 */
+		EarningItemType: "category" | "merchant" | "ebp" | "paymentMethod";
+		/** @description Reward earning data for the card */
+		EarningProgram: {
+			/** @description Grouped by earn rate, the rules that earn multipliers on each transaction */
+			transactionLevelEarningScheme: components["schemas"]["EarningContext"][];
+			/** @description Card level bonuses, such as sign-on and anniversary bonuses */
+			cardLevelEarningScheme: components["schemas"]["EarningBonus"][];
+			/** @description Annual value of this card for the user, only returned in a simulation */
+			personalization?: components["schemas"]["EarningProgramPersonalization"];
+		};
+		/** @description Annual value of this card for the user, only returned in a simulation */
+		EarningProgramPersonalization: {
+			/** @description The amount the user spent in dollars within a calendar year */
+			totalSpent?: number;
+			/** @description The amount of points/miles/dollars the user would have received within a calendar year */
+			totalEarned?: number;
+			/** @description The value in USD of the totalEarned amount based on the user's custom point valuation, minus fees */
+			totalValue?: number;
+		};
+		EducationInformation: {
+			educationLevel?: components["schemas"]["EducationLevel"];
+			graduateDegreeType?: components["schemas"]["GraduateDegreeType"];
+			/**
+			 * @deprecated
+			 * @description Name of university where a lead received their undergraduate degree.
+			 * A lookup service for possible universities is available from using the /leads/universities endpoint.
+			 * To maximize returned offers, this string must match one of the names returned from the lookup.
+			 */
+			universityAttended?: string;
+			universityOpeId?: components["schemas"]["OpeId"];
+			/**
+			 * Format: date
+			 * @deprecated
+			 * @description Date the lead graudated from undergrad (YYYY-MM-DD)
+			 */
+			graduationDate?: string;
+			/**
+			 * Format: date
+			 * @description Lead's graduate school graduation date (YYYY-MM-DD)
+			 */
+			graduateGraduationDate?: string;
+			/**
+			 * Format: date
+			 * @description Lead's last attended month/year for graduate school (YYYY-MM-DD)
+			 */
+			graduateLastAttendedDate?: string;
+			/**
+			 * @description Name of university where a lead received their graduate degree.
+			 * A lookup service for possible universities is available from using the /leads/universities endpoint.
+			 * To maximize returned offers, this string must match one of the names returned from the lookup.
+			 */
+			graduateUniversityAttended?: string;
+			graduateUniversityOpeId?: components["schemas"]["OpeId"];
+			/**
+			 * Format: date
+			 * @description Date the lead graduated from undergrad (YYYY-MM-DD).
+			 */
+			undergraduateGraduationDate?: string;
+			/**
+			 * Format: date
+			 * @description Lead's last attended month/year for undergrad (YYYY-MM-DD)
+			 */
+			undergraduateLastAttendedDate?: string;
+			/**
+			 * @description Name of university where a lead received their undergraduate degree.
+			 * A lookup service for possible universities is available from using the /leads/universities endpoint.
+			 * To maximize returned offers, this string must match one of the names returned from the lookup.
+			 */
+			undergraduateUniversityAttended?: string;
+			undergraduateUniversityOpeId?: components["schemas"]["OpeId"];
+		};
+		/** @enum {string} */
+		EducationLevel:
+			| "high_school"
+			| "associate"
+			| "bachelors"
+			| "masters"
+			| "doctorate"
+			| "other_grad_degree"
+			| "certificate"
+			| "did_not_graduate"
+			| "still_enrolled"
+			| "other";
+		/** Format: email */
+		Email: string;
+		EmploymentInformation: {
+			employerName?: string;
+			employerAddress?: string;
+			employerAddress2?: string;
+			employerCity?: string;
+			employerPhone?: string;
+			employerState?: string;
+			employerZip?: string;
+			jobTitle?: string;
+			/** Format: int32 */
+			monthsEmployed?: number;
+			/** @description Whether a `Lead` uses direct deposit for their salary */
+			directDeposit?: boolean;
+			/** Format: date */
+			payDate1?: string;
+			/** Format: date */
+			payDate2?: string;
+			/**
+			 * Format: date
+			 * @description The date the lead started working at their current employer (YYYY-MM-DD)
+			 */
+			startDate?: string;
+		};
+		/** @enum {string} */
+		EmploymentPayFrequency: "weekly" | "biweekly" | "twice_monthly" | "monthly";
+		/** @enum {string} */
+		EmploymentStatus:
+			| "employed"
+			| "employed_full_time"
+			| "employed_part_time"
+			| "military"
+			| "not_employed"
+			| "self_employed"
+			| "retired"
+			| "other";
+		/** @enum {string} */
+		FederalInsuranceType: "fdic" | "ncua";
+		FinancialInformation: {
+			employmentStatus?: components["schemas"]["EmploymentStatus"];
+			employmentPayFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** Format: int32 */
+			annualIncome?: number;
+			/** Format: int32 */
+			monthlyNetIncome?: number;
+			bankName?: string;
+			bankRoutingNumber?: string;
+			bankAccountType?: components["schemas"]["BankAccountType"];
+			/** Format: int32 */
+			creditCardDebt?: number;
+			/** Format: int32 */
+			monthsAtBank?: number;
+			bankAccountNumber?: string;
+			/** Format: int32 */
+			monthlyDebt?: number;
+			/** Format: int32 */
+			totalAssets?: number;
+			/** Format: int32 */
+			monthlyHousingPayment?: number;
+			/** Format: int32 */
+			availableAssets?: number;
+			/**
+			 * Format: int32
+			 * @description The amount of additional income the lead recieves
+			 */
+			additionalIncome?: number;
+			/** @description The frequency the lead recieves additional income */
+			additionalIncomeFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** @description Do you have a direct deposit? */
+			hasDirectDeposit?: boolean;
+			/**
+			 * Format: int32
+			 * @description Approximate total unsecured debt in dollars
+			 */
+			totalUnsecuredDebt?: number;
+		};
+		FinancialInformationRequest: {
+			employmentStatus?: components["schemas"]["EmploymentStatus"];
+			employmentPayFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** Format: int32 */
+			annualIncome?: number;
+			/** Format: int32 */
+			monthlyNetIncome?: number;
+			bankName?: string;
+			bankRoutingNumber?: string;
+			bankAccountType?: components["schemas"]["BankAccountType"];
+			/** Format: int32 */
+			creditCardDebt?: number;
+			/** Format: int32 */
+			monthsAtBank?: number;
+			bankAccountNumber?: string;
+			/** Format: int32 */
+			monthlyDebt?: number;
+			/** Format: int32 */
+			totalAssets?: number;
+			/** Format: int32 */
+			monthlyHousingPayment?: number;
+			/** Format: int32 */
+			availableAssets?: number;
+			/**
+			 * Format: int32
+			 * @description The amount of additional income the lead recieves
+			 */
+			additionalIncome?: number;
+			/** @description The frequency the lead recieves additional income */
+			additionalIncomeFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** @description Do you have a direct deposit? */
+			hasDirectDeposit?: boolean;
+			/**
+			 * Format: int32
+			 * @description Approximate total unsecured debt in dollars
+			 */
+			totalUnsecuredDebt?: number;
+		};
+		FinancialInformationResponse: {
+			employmentStatus?: components["schemas"]["EmploymentStatus"];
+			employmentPayFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** Format: int32 */
+			annualIncome?: number;
+			/** Format: int32 */
+			monthlyNetIncome?: number;
+			bankName?: string;
+			bankRoutingNumber?: string;
+			bankAccountType?: components["schemas"]["BankAccountType"];
+			/** Format: int32 */
+			creditCardDebt?: number;
+			/** Format: int32 */
+			monthsAtBank?: number;
+			bankAccountNumber?: string;
+			/** Format: int32 */
+			monthlyDebt?: number;
+			/** Format: int32 */
+			totalAssets?: number;
+			/** Format: int32 */
+			monthlyHousingPayment?: number;
+			/** Format: int32 */
+			availableAssets?: number;
+			/**
+			 * Format: int32
+			 * @description The amount of additional income the lead recieves
+			 */
+			additionalIncome?: number;
+			/** @description The frequency the lead recieves additional income */
+			additionalIncomeFrequency?: components["schemas"]["EmploymentPayFrequency"];
+			/** @description Do you have a direct deposit? */
+			hasDirectDeposit?: boolean;
+			/**
+			 * Format: int32
+			 * @description Approximate total unsecured debt in dollars
+			 */
+			totalUnsecuredDebt?: number;
+			bankAccountNumberHash?: string;
+		};
+		/** @enum {string} */
+		IdType: "driver_license" | "state_id" | "passport";
+		IncentiveDetails: {
+			/** Format: double */
+			amount: number;
+			unit: components["schemas"]["IncentiveUnit"];
+			display: string;
+			type: components["schemas"]["IncentiveType"];
+		};
+		/**
+		 * @description Unit of measure for incentives.
+		 *
+		 * @enum {string}
+		 */
+		IncentiveType: "cash_back" | "other";
+		/**
+		 * @description Unit of measure for incentives.
+		 *
+		 * @enum {string}
+		 */
+		IncentiveUnit: "usd" | "other";
+		/** @enum {string} */
+		Gender: "male" | "female";
+		/** @enum {string} */
+		GraduateDegreeType:
+			| "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"
+			| "other";
+		HealthInformation: {
+			gender?: components["schemas"]["Gender"];
+			/** Format: int32 */
+			heightInInches?: number;
+			/** Format: int32 */
+			weightInPounds?: number;
+			tobaccoSmoker?: boolean;
+		};
+		IdentificationInformation: {
+			/** @description The ID number supplied by the lead */
+			idNumber?: string;
+			/** @description The state of issue of the supplied ID */
+			idState?: string;
+			/** @description The form of the ID number supplied by the lead */
+			idType?: components["schemas"]["IdType"];
+		};
+		LeadAction: {
+			/** Format: uuid */
+			uuid: string;
+			actionType: components["schemas"]["LeadActionType"];
+			/** Format: date-time */
+			actionDate: string;
+			originatorKey?: string;
+			/** Format: int64 */
+			demandSubAccountId: number;
+			rejectReason?: components["schemas"]["LeadActionRejectReason"];
+			/** Format: int32 */
+			amount?: number;
+			/** Format: int32 */
+			originationFee?: number;
+			/** Format: int64 */
+			offerClickId?: number;
+			/** Format: date-time */
+			createdAt: string;
+			/** Format: date-time */
+			deletedAt?: string;
+		};
+		/** @enum {string} */
+		LeadActionRejectReason:
+			| "low_fico"
+			| "no_fico"
+			| "major_derogatory"
+			| "underwriting_decline"
+			| "debt_to_income_ratio"
+			| "not_in_active_state"
+			| "incorrect_data_provided"
+			| "duplicate";
+		/** @enum {string} */
+		LeadActionType:
+			| "initialized"
+			| "api_rejected"
+			| "api_approved"
+			| "api_listing"
+			| "clicked_referral_link"
+			| "clicked_special_offer_link"
+			| "special_offer_conversion"
+			| "applied"
+			| "rejected"
+			| "approved"
+			| "listed"
+			| "funded"
+			| "not_funded"
+			| "clicked_credit_card_offer_link"
+			| "clicked_mortgage_offer_link"
+			| "clicked_savings_offer_link"
+			| "lender_qualified_lead";
+		LeadClientTag: {
+			/**
+			 * Format: int64
+			 * @description A unique, internal identifier for this resource.
+			 */
+			id: number;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the associated lead.
+			 */
+			leadUuid: string;
+			/** @description The tag key. */
+			key: string;
+			/** @description The tag value. */
+			value: string;
+			/**
+			 * Format: date-time
+			 * @description When the client tag was created.
+			 */
+			createdAt: string;
+			/**
+			 * Format: date-time
+			 * @description When the client tag was deleted.
+			 */
+			deletedAt?: string;
+		};
+		/**
+		 * @example {
+		 *   "summary": "A lead request",
+		 *   "value": {
+		 *     "productTypes": [
+		 *       "loan",
+		 *       "savings"
+		 *     ],
+		 *     "personalInformation": {
+		 *       "firstName": "John",
+		 *       "lastName": "Doe",
+		 *       "email": "john@example.com",
+		 *       "city": "New York",
+		 *       "state": "NY",
+		 *       "workPhone": "2125551234",
+		 *       "primaryPhone": "2125556789",
+		 *       "address1": "45 West 21st Street",
+		 *       "address2": "5th Floor",
+		 *       "zipcode": "10010",
+		 *       "monthsAtAddress": 5,
+		 *       "driversLicenseNumber": "111222333",
+		 *       "driversLicenseState": "NY",
+		 *       "ipAddress": "8.8.8.8",
+		 *       "activeMilitary": false,
+		 *       "militaryVeteran": true,
+		 *       "dateOfBirth": "1993-10-09",
+		 *       "ssn": "111-22-3333"
+		 *     },
+		 *     "loanInformation": {
+		 *       "purpose": "debt_consolidation",
+		 *       "loanAmount": 10000
+		 *     },
+		 *     "mortgageInformation": {
+		 *       "propertyType": "condo",
+		 *       "propertyStatus": "own_with_mortgage",
+		 *       "propertyValue": 200000,
+		 *       "mortgageBalance": 10000,
+		 *       "lenderName": "Bank OF NY",
+		 *       "hasFHALoan": true,
+		 *       "currentWithLoan": true
+		 *     },
+		 *     "creditCardInformation": {
+		 *       "allowAnnualFee": true,
+		 *       "cardPurposes": [
+		 *         "travel_incentives"
+		 *       ]
+		 *     },
+		 *     "savingsInformation": {
+		 *       "minDepositAmount": 1000
+		 *     },
+		 *     "creditInformation": {
+		 *       "providedCreditRating": "excellent",
+		 *       "providedNumericCreditScore": 750
+		 *     },
+		 *     "financialInformation": {
+		 *       "creditCardDebt": 5000,
+		 *       "employmentStatus": "employed",
+		 *       "employmentPayFrequency": "weekly",
+		 *       "annualIncome": 120000,
+		 *       "monthlyNetIncome": 10000,
+		 *       "bankName": "Santander",
+		 *       "bankRoutingNumber": "231372691",
+		 *       "bankAccountType": "savings",
+		 *       "monthsAtBank": 10,
+		 *       "bankAccountNumber": "1234567890"
+		 *     },
+		 *     "employmentInformation": {
+		 *       "employerName": "Engine by MoneyLion",
+		 *       "employerAddress": "45 W 21st St",
+		 *       "employerCity": "New York",
+		 *       "employerState": "NY",
+		 *       "employerZip": "10010",
+		 *       "jobTitle": "Software Engineer",
+		 *       "monthsEmployed": 14,
+		 *       "directDeposit": true,
+		 *       "payDate1": "2004-10-06",
+		 *       "payDate2": "2004-11-06"
+		 *     },
+		 *     "educationInformation": {
+		 *       "educationLevel": "masters",
+		 *       "graduateDegreeType": "master_of_science",
+		 *       "universityAttended": "Johns Hopkins University"
+		 *     },
+		 *     "coApplicantInformation": {
+		 *       "firstName": "Jane",
+		 *       "lastName": "Doe",
+		 *       "dateOfBirth": "1984-03-06",
+		 *       "annualIncome": 100000,
+		 *       "streetAddress1": "45 West 21st Street",
+		 *       "streetAddress2": "5th Floor",
+		 *       "city": "New York",
+		 *       "state": "NY",
+		 *       "zipcode": "10010"
+		 *     },
+		 *     "healthInformation": {
+		 *       "gender": "male",
+		 *       "heightInInches": 72,
+		 *       "weightInPounds": 195,
+		 *       "tobaccoSmoker": false
+		 *     },
+		 *     "autoInsuranceInformation": {
+		 *       "numberOfVehicles": 1,
+		 *       "hasAutoInsurance": true
+		 *     },
+		 *     "legalInformation": {
+		 *       "consentsToFcra": true,
+		 *       "consentsToTcpa": true,
+		 *       "fcraLanguage": "By checking this box/clicking 'agree' I hereby consent to the 'E-Sign Agreement', the 'Credit Authorization Agreement', the Terms of Service and Privacy Policy, and I am providing written consent under the Fair Credit Reporting Act (FCRA) for [Engine by MoneyLion and/or Insert Company Name], its partners and financial institutions to obtain consumer report information from my credit profile. I request that my information be provided to their partners, lenders, and financial services partners to provide me with financial recommendations, which may also include debt relief, credit repair, credit monitoring or other related services",
+		 *       "tcpaLanguage": "I agree to be contacted by [Engine by MoneyLion and/or Insert Company Name] its partners and their affiliated companies and financial institutions via email, postal mail service and/or at the telephone number(s) I have provided above to explore various financial products and services I inquired about, including contact through automatic dialing systems, artificial or pre-recorded voice messaging, or text message. Consent is not required as a condition to utilize the service, and you may choose to be contacted by an individual customer care representative(s) by calling XXXXX or emailing XXXX"
+		 *     },
+		 *     "clientTags": {
+		 *       "hello": [
+		 *         "world",
+		 *         "there"
+		 *       ],
+		 *       "something": [
+		 *         "else"
+		 *       ]
+		 *     }
+		 *   }
+		 * }
+		 */
+		LeadRequest: {
+			/** @description Product types in which the `Lead` is interested */
+			productTypes?: components["schemas"]["ProductType"][];
+			/**
+			 * Format: uuid
+			 * @description Primary UUID for a `Lead`
+			 */
+			uuid?: string;
+			/**
+			 * Format: uuid
+			 * @description UUID used to link leads across verticals, unique per user per supply sub-account
+			 */
+			sessionUuid?: string;
+			/**
+			 * Format: uuid
+			 * @description Unique identifier for the lead's device.
+			 */
+			deviceId?: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the profile that this lead belongs to.
+			 */
+			profileUuid?: string;
+			loanInformation?: components["schemas"]["LoanInformation"];
+			personalInformation?: components["schemas"]["PersonalInformationRequest"];
+			personalReferenceInformation?: components["schemas"]["PersonalReferenceInformation"];
+			mortgageInformation?: components["schemas"]["MorgageInformation"];
+			creditCardInformation?: components["schemas"]["CreditCardInformation"];
+			savingsInformation?: components["schemas"]["SavingsInformation"];
+			creditInformation?: components["schemas"]["CreditInformation"];
+			financialInformation?: components["schemas"]["FinancialInformationRequest"];
+			employmentInformation?: components["schemas"]["EmploymentInformation"];
+			legalInformation?: components["schemas"]["LegalInformation"];
+			educationInformation?: components["schemas"]["EducationInformation"];
+			coApplicantInformation?: components["schemas"]["CoApplicantInformation"];
+			healthInformation?: components["schemas"]["HealthInformation"];
+			vehicleInformation?: components["schemas"]["VehicleInformation"];
+			lifeInsuranceInformation?: components["schemas"]["LifeInsuranceInformation"];
+			autoInsuranceInformation?: components["schemas"]["AutoInsuranceInformation"];
+			/** @description One or more loans that the lead wishes to refinance or consolidate */
+			refinanceLoans?: components["schemas"]["RefinanceLoanInformation"][];
+			identificationInformation?: components["schemas"]["IdentificationInformation"];
+			clientTags?: components["schemas"]["ClientTags"];
+			sessionInformation?: components["schemas"]["SessionInformation"];
+			/**
+			 * @deprecated
+			 * @description Whether the `Lead` has completed an application form
+			 */
+			formCompleted?: boolean;
+			/**
+			 * Format: uuid
+			 * @deprecated
+			 * @description UUID of company from which the `Lead` was referred
+			 */
+			referralCompanyUuid?: string;
+			/**
+			 * Format: uuid
+			 * @deprecated
+			 * @description UUID for internal Engine by MoneyLion tracking purposes. This field should never be set by 3rd party API consumers
+			 */
+			trackingUuid?: string;
+		};
+		LeadRequestOfferCatalog: {
+			/** @description Product types in which the `Lead` is interested */
+			productTypes?: string[];
+			/**
+			 * Format: uuid
+			 * @description Primary UUID for a `Lead`
+			 */
+			uuid?: string;
+			/**
+			 * Format: uuid
+			 * @description UUID used to link leads across verticals, unique per user per supply sub-account
+			 */
+			sessionUuid?: string;
+			/**
+			 * Format: uuid
+			 * @description Unique identifier for the lead's device.
+			 */
+			deviceId?: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the profile that this lead belongs to.
+			 */
+			profileUuid?: string;
+			loanInformation?: components["schemas"]["LoanInformation"];
+			personalInformation?: components["schemas"]["PersonalInformationRequest"];
+			personalReferenceInformation?: components["schemas"]["PersonalReferenceInformation"];
+			mortgageInformation?: components["schemas"]["MorgageInformation"];
+			creditCardInformation?: components["schemas"]["CreditCardInformation"];
+			savingsInformation?: components["schemas"]["SavingsInformation"];
+			creditInformation?: components["schemas"]["CreditInformation"];
+			financialInformation?: components["schemas"]["FinancialInformationRequest"];
+			employmentInformation?: components["schemas"]["EmploymentInformation"];
+			legalInformation?: components["schemas"]["LegalInformation"];
+			educationInformation?: components["schemas"]["EducationInformation"];
+			coApplicantInformation?: components["schemas"]["CoApplicantInformation"];
+			healthInformation?: components["schemas"]["HealthInformation"];
+			vehicleInformation?: components["schemas"]["VehicleInformation"];
+			autoInsuranceInformation?: components["schemas"]["AutoInsuranceInformation"];
+			lifeInsuranceInformation?: components["schemas"]["LifeInsuranceInformation"];
+			/** @description One or more loans that the lead wishes to refinance or consolidate */
+			refinanceLoans?: components["schemas"]["RefinanceLoanInformation"][];
+			identificationInformation?: components["schemas"]["IdentificationInformation"];
+			clientTags?: components["schemas"]["ClientTags"];
+			sessionInformation?: components["schemas"]["SessionInformation"];
+		};
+		LeadResponse: {
+			/** @description Product types in which the `Lead` is interested */
+			productTypes?: components["schemas"]["ProductType"][];
+			/** @description Limits results to leads that have the specified productTypes from the Product catalog */
+			offerCatalogProductTypes?: string[];
+			productTypesHistory: components["schemas"]["ProductTypeHistory"][];
+			/** @description Name of company which provided the lead */
+			leadProviderName: string;
+			personalInformation?: components["schemas"]["PersonalInformationResponse"];
+			personalReferenceInformation?: components["schemas"]["PersonalReferenceInformation"];
+			loanInformation?: components["schemas"]["LoanInformation"];
+			mortgageInformation?: components["schemas"]["MorgageInformation"];
+			creditCardInformation?: components["schemas"]["CreditCardInformation"];
+			savingsInformation?: components["schemas"]["SavingsInformation"];
+			creditInformation?: components["schemas"]["CreditInformation"];
+			financialInformation?: components["schemas"]["FinancialInformationResponse"];
+			employmentInformation?: components["schemas"]["EmploymentInformation"];
+			legalInformation?: components["schemas"]["LegalInformation"];
+			educationInformation?: components["schemas"]["EducationInformation"];
+			coApplicantInformation?: components["schemas"]["CoApplicantInformation"];
+			healthInformation?: components["schemas"]["HealthInformation"];
+			identificationInformation?: components["schemas"]["IdentificationInformation"];
+			lifeInsuranceInformation?: components["schemas"]["LifeInsuranceInformation"];
+			vehicleInformation?: components["schemas"]["VehicleInformation"];
+			autoInsuranceInformation?: components["schemas"]["AutoInsuranceInformation"];
+			refinanceLoans?: components["schemas"]["RefinanceLoanInformation"][];
+			clientTags?: components["schemas"]["ClientTags"];
+			sessionInformation?: components["schemas"]["SessionInformation"];
+			leadActions?: components["schemas"]["LeadAction"][];
+			/**
+			 * Format: uuid
+			 * @description Primary UUID for a `Lead`
+			 */
+			uuid: string;
+			/**
+			 * Format: uuid
+			 * @description UUID for a company which created the `Lead`
+			 */
+			companyUUID: string;
+			/**
+			 * Format: uuid
+			 * @description UUID used to link leads across verticals, unique per user per supply sub-account
+			 */
+			sessionUuid?: string;
+			/**
+			 * Format: uuid
+			 * @description Unique identifier for the lead's device.
+			 */
+			deviceId?: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the profile that this lead belongs to.
+			 */
+			profileUuid?: string;
+			/**
+			 * Format: uuid
+			 * @deprecated
+			 */
+			referralCompanyUuid?: string;
+			/** Format: uuid */
+			trackingUuid?: string;
+			/** @description Whether a `Lead` was created using a test access token */
+			isTest: boolean;
+			/** @description The furthest step of the funnel a `Lead` has reached */
+			status: components["schemas"]["LeadActionType"];
+			/** Format: date-time */
+			createdAt: string;
+			/** Format: date-time */
+			updatedAt: string;
+			/** Format: int64 */
+			supplySubAccountId: number;
+		};
+		LeadResponseWrapper: {
+			leads: components["schemas"]["LeadResponse"][];
+			/** Format: int32 */
+			offset: number;
+			/** Format: int32 */
+			limit: number;
+		};
+		LeadSummary: {
+			/**
+			 * Format: uuid
+			 * @description A unique identifier for this resource.
+			 */
+			uuid: string;
+			/** @description Product types in which the `Lead` is interested */
+			productTypes?: components["schemas"]["ProductType"][];
+			/**
+			 * Format: uuid
+			 * @description The UUID of the supply sub-account for this configuration.
+			 */
+			supplySubAccountUuid?: string;
+			/** Format: uuid */
+			sessionUuid?: string;
+			/**
+			 * Format: uuid
+			 * @description Unique identifier for the lead's device.
+			 */
+			deviceId?: string;
+			/** Format: uuid */
+			profileUuid?: string;
+			/** @description Whether a `Lead` was created using a test access token */
+			isTest: boolean;
+			/**
+			 * Format: int64
+			 * @description Number of rate tables for this lead
+			 */
+			rateTableCount: number;
+			/**
+			 * Format: int64
+			 * @description Number of rate tables with offers for this lead
+			 */
+			rateTableWithOfferCount: number;
+			/**
+			 * Format: date-time
+			 * @description When the resource was created.
+			 */
+			createdAt: string;
+			/**
+			 * Format: date-time
+			 * @description When the resource was last updated.
+			 */
+			updatedAt: string;
+		};
+		LeadSummaryWrapper: {
+			leads: components["schemas"]["LeadSummary"][];
+			/** Format: int32 */
+			offset: number;
+			/** Format: int32 */
+			limit: number;
+		};
+		LeadSurveyResult: {
+			/**
+			 * Format: int64
+			 * @description A unique, internal identifier for this resource.
+			 */
+			id: number;
+			/**
+			 * Format: uuid
+			 * @description The UUID for the lead for the results.
+			 */
+			leadUuid: string;
+			/** @description The recorded results of the survey. */
+			results: string;
+			surveyKey: components["schemas"]["SurveyKey"];
+			submittedFrom: components["schemas"]["SubmittedFrom"];
+			/**
+			 * Format: date-time
+			 * @description When the resource was created.
+			 */
+			createdAt: string;
+		};
+		LeadSurveyResultCreateData: {
+			/**
+			 * Format: uuid
+			 * @description The uuid of the lead the survey result belongs to.
+			 */
+			leadUuid: string;
+			/** @description The recorded results of the survey. */
+			results: string;
+			surveyKey: components["schemas"]["SurveyKey"];
+			submittedFrom: components["schemas"]["SubmittedFrom"];
+		};
+		/** @enum {string} */
+		LeadSurveyResultSortBy: "id" | "surveyKey" | "results";
+		LeadUuid: {
+			/**
+			 * Format: uuid
+			 * @description UUID corresponding to the created `Lead`
+			 */
+			uuid: string;
+		};
+		/** @description Information regarding a `Lead`'s communication concent */
+		LegalInformation: {
+			/** @description Whether the lead was shown, and consented to a Fair Credit Reporting Act notice */
+			consentsToFcra?: boolean;
+			/** @description The lead agrees to recieve SMS text messages from the Financial Institution */
+			consentsToSms?: boolean;
+			/** @description Whether the lead was shown, and consented to a Telephone Consumer Protection Act notice */
+			consentsToTcpa?: boolean;
+			/** @description The exact FCRA language to which the lead consented */
+			fcraLanguage?: string;
+			/** @description The exact TCPA language to which the lead consented */
+			tcpaLanguage?: string;
+		};
+		/**
+		 * Life insurance information
+		 * @description Life insurance information
+		 */
+		LifeInsuranceInformation: {
+			/**
+			 * Format: uuid
+			 * @description Carrier UUID of the policy
+			 */
+			carrierUuid?: string;
+			/**
+			 * Format: int32
+			 * @description Duration, in years
+			 */
+			duration?: number;
+			/**
+			 * Format: int32
+			 * @description Policy amount, in dollars
+			 */
+			policyAmount?: number;
+			packageTypes?: components["schemas"]["PackageType"][];
+		};
+		/** @description An offer for a life insurance lead */
+		LifeInsuranceOffer: WithRequired<
+			{
+				details: components["schemas"]["LifeInsuranceOfferDetails"];
+			} & components["schemas"]["Offer"],
+			"details"
+		>;
+		LifeInsuranceOfferDetails: {
+			/**
+			 * Format: int64
+			 * @description Policy amount, in dollars
+			 */
+			policyAmount: number;
+			/** Format: int64 */
+			termLength?: number;
+			termUnit?: components["schemas"]["LoanTermUnit"];
+			/** @description Monthly premium amount, in dollars */
+			monthlyPremiumAmount: number;
+			/** @description Annual premium amount, in dollars */
+			annualPremiumAmount?: number;
+			/** @description Semi-annual premium amount, in dollars */
+			semiAnnualPremiumAmount?: number;
+			/** @description Online application is available */
+			onlineAppAvailable?: boolean;
+			noMedicalTest?: boolean;
+			packageType?: components["schemas"]["PackageType"];
+			/** @description Policy is recommended */
+			recommended?: boolean;
+			medicalExam?: components["schemas"]["MedicalExam"];
+			/** @description The name of policy */
+			policyName?: string;
+			carrierDecisionType?: components["schemas"]["CarrierDecisionType"];
+			partnerQuoteId?: string;
+			convertToPermanent?: boolean;
+			childRider?: string;
+			acceleratedDeathBenefit?: boolean;
+			waiverOfPremium?: string;
+			isOnlineApplication?: boolean;
+			deliveryMethod?: string;
+			examRequired?: string;
+		};
+		LoanInformation: {
+			purpose?: components["schemas"]["LoanPurpose"];
+			/** Format: int32 */
+			loanAmount?: number;
+		};
+		LoanOffer: {
+			/** Format: uuid */
+			uuid: string;
+			productType: components["schemas"]["ProductType"];
+			productSubType: components["schemas"]["ProductSubType"];
+			productSubTypeDisclaimer?: string;
+			/** Format: url */
+			url?: string;
+			originator: components["schemas"]["Originator"];
+			originatorId?: string;
+			preQualified: boolean;
+			preApproved: boolean;
+			secured: boolean;
+			coApplicant: boolean;
+			/** @deprecated */
+			sponsored: boolean;
+			/** Format: int32 */
+			maxAmount: number;
+			/** Format: int32 */
+			minAmount?: number;
+			/** Format: int32 */
+			termLength?: number;
+			termUnit?: components["schemas"]["LoanTermUnit"];
+			displayTermUnit?: string;
+			termDescription?: string;
+			maxApr?: number;
+			minApr?: number;
+			meanApr?: number;
+			aprType: components["schemas"]["AprType"];
+			aprDescription?: string;
+			/**
+			 * @deprecated
+			 * @description The maximum percent of loan amount fee for an offer. `maxFeeRate` should be used instead
+			 */
+			feeRate?: number;
+			maxFeeRate?: number;
+			minFeeRate?: number;
+			/**
+			 * @deprecated
+			 * @description The maximum fee, in dollars, for an offer. `maxFeeFixed` should be used instead
+			 */
+			feeFixed?: number;
+			maxFeeFixed?: number;
+			minFeeFixed?: number;
+			allowPrepayment: boolean;
+			prepaymentFee?: number;
+			/**
+			 * @deprecated
+			 * @description The estimated maximum monthly payment, in dollars, for an offer. `maxMonthlyPayment` should be used instead
+			 */
+			monthlyPayment?: number;
+			maxMonthlyPayment?: number;
+			minMonthlyPayment?: number;
+			monthlyPaymentDescription?: string;
+			meanMonthlyPayment?: number;
+			maxTotalPayment?: number;
+			minTotalPayment?: number;
+			meanTotalPayment?: number;
+			recommendationScore?: number;
+			payout?: number;
+			conversionProbability?: number;
+			terms?: string;
+			/** @description Some loan offers require a prefix (e.g. `up to*`) to be displayed to the left of the displayed loan amount. This is a nullable field that may be up to six characters long. */
+			amountPrefix?: string;
+		};
+		/** @enum {string} */
+		LoanPurpose:
+			| "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"
+			| "other"
+			| "rv"
+			| "special_occasion"
+			| "student_loan"
+			| "student_loan_refi"
+			| "taxes"
+			| "unknown"
+			| "vacation"
+			| "wedding";
+		/**
+		 * @description Unit of measure for offer term lengths, or open for a single term.
+		 *
+		 * @enum {string}
+		 */
+		LoanTermUnit: "day" | "month" | "year" | "open";
+		/** @description Make of the vehicle. Must be a valid NADA make for the given year. */
+		Make: string;
+		/**
+		 * @description Medical exam requirement
+		 * @enum {string}
+		 */
+		MedicalExam:
+			| "no_exam_if_qualified"
+			| "no_exam_guaranteed"
+			| "exam_required";
+		/** @description A business or store that is affiliated with a credit card earning program */
+		Merchant: {
+			/** Format: uuid */
+			uuid?: string;
+			/** @description The merchant's name */
+			name?: string;
+			/** @description Logo URL */
+			logo?: string;
+			category?: components["schemas"]["MerchantCategory"];
+		};
+		/** @description A Category */
+		MerchantCategory: {
+			/** Format: uuid */
+			uuid?: string;
+			/** @description A detailed name for the category */
+			name?: string;
+			/** @description A more user friendly name for the category */
+			displayName?: string;
+			/** @description Sentence friendly */
+			phrase?: string;
+		};
+		/** @description Model of the vehicle. Must be a valid NADA model for the given make and year. */
+		Model: string;
+		/** @enum {string} */
+		MorgageAdjustmentType: "credits" | "par" | "points";
+		MorgageInformation: {
+			propertyType?: components["schemas"]["MortgagePropertyType"];
+			/** Format: int32 */
+			propertyValue?: number;
+			/** Format: int32 */
+			mortgageBalance?: number;
+			lenderName?: string;
+			hasFHALoan?: boolean;
+			currentWithLoan?: boolean;
+			propertyStatus?: components["schemas"]["MortgagePropertyStatus"];
+			mortgageType?: components["schemas"]["MortgageType"];
+			/**
+			 * Format: int32
+			 * @description Amount the lead will borrow
+			 */
+			mortgageAmount?: number;
+			/** Format: int32 */
+			downPaymentAmount?: number;
+			propertyState?: string;
+			propertyCounty?: string;
+			/** @description Street address (primary address line) */
+			propertyAddress1?: string;
+			/** @description Secondary address line */
+			propertyAddress2?: string;
+			propertyZipcode?: string;
+			propertyCity?: string;
+			/**
+			 * Format: int32
+			 * @description Amount the lead will borrow for refinancing an existing mortgage
+			 */
+			refinanceAmount?: number;
+			/**
+			 * Format: int32
+			 * @description Additional amount the lead will borrow against existing home equity in the case of refinance
+			 */
+			cashOutAmount?: number;
+			occupancyType?: components["schemas"]["MortgageOccupancyType"];
+			refinanceType?: components["schemas"]["MortgageRefinanceType"];
+			propertySearchStatus?: components["schemas"]["MortgagePropertySearchStatus"];
+			/**
+			 * Format: int32
+			 * @description The number of legal units on the property
+			 */
+			numUnits?: number;
+			/** Format: date */
+			closingDate?: string;
+			purchaseStatus?: components["schemas"]["MortgagePurchaseStatus"];
+			/** Format: date */
+			purchaseDate?: string;
+			/**
+			 * Format: float
+			 * @description The amount of the HOA fee for the lead
+			 */
+			monthlyHoaFee?: number;
+			/** @description The name of the company holding the lead's mortgage */
+			mortgageCompany?: string;
+			/**
+			 * Format: float
+			 * @description The amount of escrow the lead pays
+			 */
+			mortgageEscrowAmount?: number;
+		};
+		/** @enum {string} */
+		MorgageLoanType:
+			| "fifteen_year_fixed"
+			| "thirty_year_fixed"
+			| "five_one_adjustable"
+			| "seven_one_adjustable"
+			| "ten_one_adjustable";
+		/** @enum {string} */
+		MortgageOccupancyType: "primary" | "secondary" | "investment";
+		/** @description An offer for a mortgage */
+		MortgageOffer: WithRequired<
+			{
+				details: components["schemas"]["MortgageOfferDetails"];
+			} & components["schemas"]["Offer"],
+			"details"
+		>;
+		MortgageOfferDetails: {
+			interestRate: number;
+			loanType: components["schemas"]["MorgageLoanType"];
+			priceAdjustment: number;
+			monthlyPayment: number;
+			netClosingCosts: number;
+			apr: number;
+			/** Format: int32 */
+			loanTerm: number;
+			adjustmentType: components["schemas"]["MorgageAdjustmentType"];
+		};
+		/** @enum {string} */
+		MortgagePropertySearchStatus: "found" | "not_found";
+		/** @enum {string} */
+		MortgagePropertyStatus: "own_outright" | "own_with_mortgage" | "rent";
+		/** @enum {string} */
+		MortgagePropertyType:
+			| "rent"
+			| "condo"
+			| "multi_unit"
+			| "single_family"
+			| "townhouse";
+		/** @enum {string} */
+		MortgagePurchaseStatus:
+			| "no_offer"
+			| "offer_accepted"
+			| "offer_pending"
+			| "under_contract";
+		/** @enum {string} */
+		MortgageRefinanceType: "cash_out" | "rate_term";
+		/** @enum {string} */
+		MortgageType: "purchase" | "refinance";
+		NadaVehicleDetails: {
+			/**
+			 * Format: int32
+			 * @description Year of the vehicle.
+			 */
+			year: number;
+			/** @description Make of the vehicle. */
+			make: string;
+			/** @description Model of the vehicle. */
+			model: string;
+			/** @description Trim of the vehicle. */
+			trim: string;
+			/**
+			 * Format: int64
+			 * @description NADA Used Card Guide vehicle id.
+			 */
+			ucgVehicleId: number;
+		};
+		NadaVehicleUpdateCriteria: {
+			/**
+			 * Format: int32
+			 * @description Download only vehicles for supplied year
+			 */
+			year: number;
+			/** @description Download only vehicles that match on make (for given year) */
+			make?: string;
+		};
+		NewDeduplicationConfiguration: {
+			/**
+			 * Format: int64
+			 * @description The ID of the supply sub-account for this configuration.
+			 */
+			supplySubAccountId?: number;
+			/**
+			 * Format: uuid
+			 * @description The UUID of the supply sub-account for this configuration.
+			 */
+			supplySubAccountUuid?: string;
+			/**
+			 * Format: int32
+			 * @description The number of minutes to look back when looking for duplicate leads.
+			 */
+			durationMinutes: number;
+		};
+		Offer: {
+			/** Format: uuid */
+			uuid: string;
+			partner: components["schemas"]["DemandPartner"];
+			marketplace?: components["schemas"]["DemandPartner"];
+			productType: components["schemas"]["ProductType"];
+			productSubType: components["schemas"]["ProductSubType"];
+			/** Format: url */
+			url: string;
+			recommendationScore?: number;
+			disclaimer?: string;
+			productSubTypeDisclaimer?: string;
+			/** Format: date-time */
+			expiresAt?: string;
+		};
+		/** @description identification number used by the U.S. Department of Education's Office of Postsecondary Education (OPE) to identify schools that have Program Participation Agreements (PPA) so that its students are eligible to participate in Federal Student Financial Assistance programs under Title IV regulations. This is a 6-digit number followed by a 2-digit suffix used to identify branches, additional locations, and other entities that are part of the eligible institution. */
+		OpeId: string;
+		/** @enum {string} */
+		Order: "asc" | "desc";
+		Originator: {
+			key: string;
+			name: string;
+			description?: string;
+			images: components["schemas"]["OriginatorImage"][];
+			disclaimer?: string;
+			/** Format: uuid */
+			companyUuid?: string;
+			/**
+			 * Format: uuid
+			 * @description A unique identifier for the associated financial institution. Only present for event types associated with financial institutions.
+			 */
+			financialInstitutionUuid?: string;
+		};
+		OriginatorImage: {
+			sizeKey: string;
+			url: string;
+		};
+		/**
+		 * @description Life insurance package types
+		 * @enum {string}
+		 */
+		PackageType: "basic" | "essential" | "elite";
+		PendingResponse: {
+			partner: components["schemas"]["DemandPartner"];
+			productTypes: components["schemas"]["ProductType"][];
+		};
+		PersonalInformation: {
+			firstName?: string;
+			lastName?: string;
+			/** @description The first name the lead uses as an alias */
+			aliasFirstName?: string;
+			/** @description The last name the lead uses as an alias */
+			aliasLastName?: string;
+			email?: components["schemas"]["Email"];
+			city?: string;
+			state?: components["schemas"]["State"];
+			workPhone?: string;
+			primaryPhone?: string;
+			bestTimeToCall?: components["schemas"]["BestTimeToCall"];
+			/** @description Street address (primary address line) */
+			address1?: string;
+			/** @description Secondary address line */
+			address2?: string;
+			/**
+			 * Format: date
+			 * @description The date the lead moved into their current address
+			 */
+			addressMoveInDate?: string;
+			zipcode?: string;
+			/**
+			 * Format: int32
+			 * @description Number of months the provided address has been the lead's primary residence
+			 */
+			monthsAtAddress?: number;
+			driversLicenseNumber?: string;
+			/** @description State in which the driver's license was issued */
+			driversLicenseState?: string;
+			/**
+			 * Format: ip
+			 * @description IP address
+			 */
+			ipAddress?: string;
+			/** @description Whether the lead is currently in the military (not a veteran) */
+			activeMilitary?: boolean;
+			/** @description Whether the lead is a veteran (should not be used if the lead is active in the military) */
+			militaryVeteran?: boolean;
+			/** Format: date */
+			dateOfBirth?: string;
+			/** @deprecated */
+			educationLevel?: components["schemas"]["EducationLevel"];
+			ssn?: components["schemas"]["Ssn"];
+			citizenshipStatus?: components["schemas"]["CitizenshipStatus"];
+		};
+		PersonalInformationRequest: {
+			firstName?: string;
+			lastName?: string;
+			/** @description The first name the lead uses as an alias */
+			aliasFirstName?: string;
+			/** @description The last name the lead uses as an alias */
+			aliasLastName?: string;
+			email?: components["schemas"]["Email"];
+			city?: string;
+			state?: components["schemas"]["State"];
+			workPhone?: string;
+			primaryPhone?: string;
+			bestTimeToCall?: components["schemas"]["BestTimeToCall"];
+			/** @description Street address (primary address line) */
+			address1?: string;
+			/** @description Secondary address line */
+			address2?: string;
+			/**
+			 * Format: date
+			 * @description The date the lead moved into their current address
+			 */
+			addressMoveInDate?: string;
+			zipcode?: string;
+			/**
+			 * Format: int32
+			 * @description Number of months the provided address has been the lead's primary residence
+			 */
+			monthsAtAddress?: number;
+			driversLicenseNumber?: string;
+			/** @description State in which the driver's license was issued */
+			driversLicenseState?: string;
+			/**
+			 * Format: ip
+			 * @description IP address
+			 */
+			ipAddress?: string;
+			/** @description Whether the lead is currently in the military (not a veteran) */
+			activeMilitary?: boolean;
+			/** @description Whether the lead is a veteran (should not be used if the lead is active in the military) */
+			militaryVeteran?: boolean;
+			/** Format: date */
+			dateOfBirth?: string;
+			/** @deprecated */
+			educationLevel?: components["schemas"]["EducationLevel"];
+			ssn?: components["schemas"]["Ssn"];
+			citizenshipStatus?: components["schemas"]["CitizenshipStatus"];
+		};
+		PersonalInformationResponse: {
+			firstName?: string;
+			lastName?: string;
+			/** @description The first name the lead uses as an alias */
+			aliasFirstName?: string;
+			/** @description The last name the lead uses as an alias */
+			aliasLastName?: string;
+			email?: string;
+			city?: string;
+			state?: components["schemas"]["State"];
+			workPhone?: string;
+			primaryPhone?: string;
+			bestTimeToCall?: components["schemas"]["BestTimeToCall"];
+			/** @description Street address (primary address line) */
+			address1?: string;
+			/** @description Secondary address line */
+			address2?: string;
+			/**
+			 * Format: date
+			 * @description The date the lead moved into their current address
+			 */
+			addressMoveInDate?: string;
+			zipcode?: string;
+			/**
+			 * Format: int32
+			 * @description Number of months the provided address has been the lead's primary residence
+			 */
+			monthsAtAddress?: number;
+			driversLicenseNumber?: string;
+			/** @description State in which the driver's license was issued */
+			driversLicenseState?: string;
+			/**
+			 * Format: ip
+			 * @description IP address
+			 */
+			ipAddress?: string;
+			/** @description Whether the lead is currently in the military (not a veteran) */
+			activeMilitary?: boolean;
+			/** @description Whether the lead is a veteran (should not be used if the lead is active in the military) */
+			militaryVeteran?: boolean;
+			/** Format: date */
+			dateOfBirth?: string;
+			/** @deprecated */
+			educationLevel?: components["schemas"]["EducationLevel"];
+			ssn?: string;
+			citizenshipStatus?: components["schemas"]["CitizenshipStatus"];
+			driversLicenseNumberHash?: string;
+			ssnHash?: string;
+		};
+		PersonalReferenceInformation: {
+			/** @description The first name of the personal reference supplied by the lead */
+			firstName?: string;
+			/** @description The last name of the personal reference supplied by the lead */
+			lastName?: string;
+			/** @description The phone number of the personal reference supplied by the lead */
+			primaryPhone?: string;
+			/** @description The relation of the personal reference supplied by the lead */
+			relationType?: components["schemas"]["PersonalReferenceRelationType"];
+		};
+		/** @enum {string} */
+		PersonalReferenceRelationType:
+			| "parent"
+			| "employer"
+			| "spouse"
+			| "guardian"
+			| "sibling"
+			| "relative"
+			| "friend"
+			| "other";
+		/**
+		 * @description A type of financial product
+		 * @enum {string}
+		 */
+		ProductSubType:
+			| "credit_card"
+			| "secured_card"
+			| "student_card"
+			| "personal_loan"
+			| "secured_loan"
+			| "student_loan_refinance"
+			| "co_applicant_loan"
+			| "line_of_credit"
+			| "automobile_refinance"
+			| "home_equity_line_of_credit"
+			| "purchase"
+			| "refinance"
+			| "savings_account"
+			| "money_market_account"
+			| "certificate_of_deposit"
+			| "individual_retirement_account"
+			| "cash_management_account"
+			| "high_interest_checking"
+			| "checking"
+			| "accidental_death_benefits"
+			| "term_life"
+			| "term_life_instant"
+			| "whole_life"
+			| "debt_relief"
+			| "installment_loans"
+			| "credit_builder"
+			| "cash_advance"
+			| "credit_repair"
+			| "education_offers"
+			| "employment_opportunity"
+			| "financial_wellness"
+			| "direct_affiliate"
+			| "overdraft_protection"
+			| "revenue_based_financing"
+			| "installment_loan_more_offers"
+			| "credit_card_more_offers"
+			| "credit_repair_more_offers"
+			| "student_loan"
+			| "health"
+			| "auto_and_vehicle"
+			| "games"
+			| "home"
+			| "rewards"
+			| "life_insurance"
+			| "auto_insurance"
+			| "specialty_vehicle_insurance"
+			| "home_owners_insurance"
+			| "renters_insurance"
+			| "uncategorized"
+			| "cash_advance_moneylion"
+			| "unknown";
+		/** @enum {string} */
+		ProductType:
+			| "credit_card"
+			| "generic"
+			| "auto_insurance"
+			| "insurance"
+			| "life_insurance"
+			| "loan"
+			| "mortgage"
+			| "savings"
+			| "other"
+			| "unknown";
+		ProductTypeHistory: {
+			value: components["schemas"]["ProductType"][];
+			/** Format: date-time */
+			createdAt: string;
+		};
+		/** @enum {string} */
+		ProvidedCreditRating:
+			| "excellent"
+			| "good"
+			| "fair"
+			| "poor"
+			| "limited"
+			| "unknown";
+		/** @description A `RateTable` sourced from generic offers customized to a `Lead` input */
+		BasicRateTable: {
+			/**
+			 * Format: uuid
+			 * @description Primary UUID for a `RateTable`
+			 */
+			uuid: string;
+			/**
+			 * Format: uuid
+			 * @description UUID of the associated `Lead`
+			 */
+			leadUuid: string;
+			offers: Record<string, never>[];
+			/** @description List of demand partners which have been queried, but have not responded yet. It is a guarantee that no offers will be added to the rate table after this list is empty */
+			pendingResponses?: components["schemas"]["BasicRateTablePendingResponse"][];
+		};
+		/** @description A `RateTable` customized to a `Lead` input */
+		RateTablePublic: {
+			/**
+			 * Format: uuid
+			 * @description Primary UUID for a `RateTable`
+			 */
+			uuid: string;
+			/**
+			 * Format: uuid
+			 * @description UUID of the associated `Lead`
+			 */
+			leadUuid: string;
+			/**
+			 * Format: int32
+			 * @description `Lead`'s provided loan amount at the time of `RateTable` creation
+			 */
+			loanAmount?: number;
+			creditCardOffers: components["schemas"]["CreditCardOffer"][];
+			lifeInsuranceOffers: components["schemas"]["LifeInsuranceOffer"][];
+			loanOffers: components["schemas"]["LoanOffer"][];
+			mortgageOffers: components["schemas"]["MortgageOffer"][];
+			savingsOffers: components["schemas"]["SavingsOffer"][];
+			specialOffers: components["schemas"]["SpecialOffer"][];
+			/**
+			 * @deprecated
+			 * @description List of originators which have been queried, but have not responded yet. This list only contains loan originators, and should no longer be used
+			 */
+			pendingOriginators: components["schemas"]["Originator"][];
+			/** @description List of demand partners which have been queried, but have not responded yet. It is a guarantee that no offers will be added to the rate table after this list is empty */
+			pendingResponses: components["schemas"]["PendingResponse"][];
+		};
+		/** Refinance loan information */
+		RefinanceLoanInformation: {
+			/** @description The account number for a loan the lead is refinancing */
+			accountNumber?: string;
+			/** @description If the repayment is income-based for a loan the lead is refinancing */
+			incomeBasedRepayment?: boolean;
+			/**
+			 * Format: float
+			 * @description The interest rate for a loan the lead is refinancing
+			 */
+			interestRate?: number;
+			/**
+			 * Format: int32
+			 * @description The loan amount for a loan the lead is refinancing
+			 */
+			loanAmount?: number;
+			/** @description The name of a loan servicer of a loan the lead is refinancing */
+			loanServicer?: string;
+			/** @description The loan type for a loan the lead is refinancing */
+			loanType?: components["schemas"]["RefinanceLoanType"];
+			/**
+			 * Format: float
+			 * @description The amount the next payment will be on a loan the lead is refinancing
+			 */
+			nextPaymentAmount?: number;
+			/**
+			 * Format: date
+			 * @description The next payment date for a loan the lead is refinancing
+			 */
+			nextPaymentDate?: string;
+		};
+		/** @enum {string} */
+		RefinanceLoanType: "federal_student_loan" | "private_student_loan";
+		/** @enum {string} */
+		SavingsCompoundingMethod:
+			| "annually"
+			| "continuous"
+			| "daily"
+			| "monthly"
+			| "quarterly"
+			| "semiAnnually"
+			| "simple"
+			| "weekly";
+		SavingsInformation: {
+			/**
+			 * Format: int64
+			 * @description The minimum amount a `Lead` is interested in depositing when opening a new savings account
+			 */
+			minDepositAmount?: number;
+			/**
+			 * Format: int64
+			 * @description The maximum amount a `Lead` is interested in depositing when opening a new savings account
+			 */
+			maxDepositAmount?: number;
+		};
+		/** @description An offer for a savings account */
+		SavingsOffer: WithRequired<
+			{
+				details: components["schemas"]["SavingsOfferDetails"];
+			} & components["schemas"]["Offer"],
+			"details"
+		>;
+		SavingsOfferDetails: {
+			name?: string;
+			description?: string;
+			details?: string;
+			/** @description Annual interest rate */
+			rate?: number;
+			annualPercentYield: number;
+			compoundingMethod: components["schemas"]["SavingsCompoundingMethod"];
+			/** Format: int32 */
+			introductoryPeriodMonths?: number;
+			introductoryRate?: number;
+			minimumDeposit: number;
+			minimumDepositWithFees?: number;
+			monthlyFee: number;
+			/** @description Whether the account allows checks */
+			checkWriting?: boolean;
+			/**
+			 * Format: date-time
+			 * @description When the offer was last validated, formatted as yyyy-MM-ddTHH:mm:ss.SSSZZ
+			 */
+			effectiveAsOf: string;
+			/**
+			 * @description The type of federal deposit insurance that applies to this offer, if
+			 * it was provided by the financial institution. Could be one of `fdic` for
+			 * the Federal Deposit Insurance Corporation, or `ncua` for the National
+			 * Credit Union Administration.
+			 */
+			federalInsuranceType?: components["schemas"]["FederalInsuranceType"];
+			incentiveDetails?: components["schemas"]["IncentiveDetails"][];
+			cdTermUnit?: components["schemas"]["LoanTermUnit"];
+			/** Format: int32 */
+			cdTermLength?: number;
+		};
+		/** @description Browsing session information accociated with a `Lead` */
+		SessionInformation: {
+			ipAddress?: string;
+			userAgent?: string;
+			browserFingerprint?: string;
+		};
+		SpecialOffer: {
+			/** Format: uuid */
+			uuid: string;
+			name: string;
+			/** @description Description */
+			desc: string;
+			/** Format: url */
+			url: string;
+			partnerName: string;
+			/** Format: url */
+			partnerImageUrl: string;
+			recommendationScore?: number;
+			payout?: number;
+			productSubType: components["schemas"]["ProductSubType"];
+			disclaimer?: string;
+			/**
+			 * Format: uuid
+			 * @description A unique identifier for the associated financial institution. Only present for event types associated with financial institutions.
+			 */
+			financialInstitutionUuid?: string;
+		};
+		Ssn: string;
+		/**
+		 * state
+		 * Format: state
+		 * @description A two character upper case state, Puerto Rico, or District of Columbia code
+		 * @enum {string}
+		 */
+		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";
+		/**
+		 * @description The key used to identify from where the survey was submitted.
+		 *
+		 * @enum {string}
+		 */
+		SubmittedFrom: "app_results" | "remarketing_email" | "transactional_email";
+		/**
+		 * @description The key used to identify which survey the result is for.
+		 *
+		 * @enum {string}
+		 */
+		SurveyKey: "lead_sentiment";
+		/** @enum {string} */
+		TimestampField: "createdAt" | "updatedAt";
+		University: {
+			/** Format: int64 */
+			id: number;
+			opeId: string;
+			name: string;
+			/** Format: date-time */
+			createdAt: string;
+			/** Format: uuid */
+			createdByUuid: string;
+		};
+		UuidAndTrim: {
+			/**
+			 * Format: uuid
+			 * @description The uuid of the vehicle.
+			 */
+			uuid?: string;
+			/** @description Trim of the vehicle. Must be a valid NADA trim body for the given make, model, and year. */
+			trim?: string;
+		};
+		VehicleCreateData: {
+			/**
+			 * Format: int32
+			 * @description Year of the vehicle.
+			 */
+			year: number;
+			/** @description Make of the vehicle. */
+			make: string;
+			/** @description Model of the vehicle. */
+			model: string;
+			/** @description Legacy trim string of the vehicle. */
+			legacyTrim: string;
+			/** @description Trim of the vehicle. */
+			trim: string;
+			/** @description Type of the vehicle. */
+			type: string;
+			/** Format: int64 */
+			ucgVehicleId: number;
+		};
+		/** Vehicle information */
+		VehicleInformation: {
+			/**
+			 * Format: int32
+			 * @description The lead's monthly auto loan payment
+			 */
+			monthlyPayment?: number;
+			/**
+			 * Format: integer
+			 * @description The vehicle's estimated number of miles driven
+			 */
+			estimatedMileage?: number;
+			/** @description The vehicle identification number (VIN) of the financed vehicle */
+			vehicleIdentificationNumber?: string;
+			/**
+			 * Format: uuid
+			 * @description The UUID representing the unique Year/Make/Model/Trim of the financed vehicle
+			 */
+			vehicleUuid?: string;
+		};
+		/**
+		 * Format: int32
+		 * @description Year of the vehicle. Must be a valid NADA year.
+		 */
+		Year: number;
+	};
+	responses: {
+		/** @description Invalid request */
+		InvalidRequest: {
+			content: {
+				"application/json": components["schemas"]["ApiError"][];
+			};
+		};
+		/** @description Malformed request */
+		MalformedRequest: {
+			content: {
+				"application/json": components["schemas"]["ApiError"][];
+			};
+		};
+		/** @description Resource not found */
+		NotFound: {
+			content: {
+				"application/json": components["schemas"]["ApiError"][];
+			};
+		};
+		/** @description Unauthorized request */
+		UnauthorizedRequest: {
+			content: {
+				"application/json": components["schemas"]["ApiError"][];
+			};
+		};
+	};
+	parameters: never;
+	requestBodies: never;
+	headers: never;
+	pathItems: never;
+}