api_models library

Generated OpenAPI models and API clients for Engine.

Import with a prefix when using Flutter in the same library:

import "package:engine_mobile_flutter_sdk/api_models.dart" as openapi;

Classes

ApiApprovedEventData
ApiClient
ApiError
ApiKeyAuth
ApiRejectedEventData
AppliedEventData
ApprovedEventData
AprType
AprTypeTypeTransformer
Transformation class that can encode an instance of AprType to String, and decode dynamic data back to AprType.
Authentication
BankAccountType
BankAccountTypeTypeTransformer
Transformation class that can encode an instance of BankAccountType to String, and decode dynamic data back to BankAccountType.
BatchConsentVersion
BatchConsentVersionTypeTransformer
Transformation class that can encode an instance of BatchConsentVersion to String, and decode dynamic data back to BatchConsentVersion.
CardBenefit
Benefits or benefit categories related to a credit card
CardBenefitTypeTransformer
Transformation class that can encode an instance of CardBenefit to String, and decode dynamic data back to CardBenefit.
CardPurpose
Purposes or categories related to a credit card
CardPurposeTypeTransformer
Transformation class that can encode an instance of CardPurpose to String, and decode dynamic data back to CardPurpose.
CardType
CardTypeTypeTransformer
Transformation class that can encode an instance of CardType to String, and decode dynamic data back to CardType.
CarrierDecisionType
Carrier decision speed
CarrierDecisionTypeTypeTransformer
Transformation class that can encode an instance of CarrierDecisionType to String, and decode dynamic data back to CarrierDecisionType.
CitizenshipStatus
Citizenship status
CitizenshipStatusTypeTransformer
Transformation class that can encode an instance of CitizenshipStatus to String, and decode dynamic data back to CitizenshipStatus.
CompoundingMethod
CompoundingMethodTypeTransformer
Transformation class that can encode an instance of CompoundingMethod to String, and decode dynamic data back to CompoundingMethod.
ConversionEventData
CreditCardOffer
CreditCardOfferDetails
DeserializationMessage
Primarily intended for use in an isolate.
EducationLevel
EducationLevelTypeTransformer
Transformation class that can encode an instance of EducationLevel to String, and decode dynamic data back to EducationLevel.
EmploymentPayFrequency
EmploymentPayFrequencyTypeTransformer
Transformation class that can encode an instance of EmploymentPayFrequency to String, and decode dynamic data back to EmploymentPayFrequency.
EmploymentStatus
EmploymentStatusTypeTransformer
Transformation class that can encode an instance of EmploymentStatus to String, and decode dynamic data back to EmploymentStatus.
EventData
EventType
EventTypeTypeTransformer
Transformation class that can encode an instance of EventType to String, and decode dynamic data back to EventType.
FeaturedFinancialInstitution
FederalInsuranceType
FederalInsuranceTypeTypeTransformer
Transformation class that can encode an instance of FederalInsuranceType to String, and decode dynamic data back to FederalInsuranceType.
FundedEventData
Gender
GenderTypeTransformer
Transformation class that can encode an instance of Gender to String, and decode dynamic data back to Gender.
GraduateDegreeType
GraduateDegreeTypeTypeTransformer
Transformation class that can encode an instance of GraduateDegreeType to String, and decode dynamic data back to GraduateDegreeType.
HttpBasicAuth
HttpBearerAuth
IdType
IdTypeTypeTransformer
Transformation class that can encode an instance of IdType to String, and decode dynamic data back to IdType.
IncentiveDetails
IncentiveType
Unit of measure for incentives.
IncentiveTypeTypeTransformer
Transformation class that can encode an instance of IncentiveType to String, and decode dynamic data back to IncentiveType.
IncentiveUnit
Unit of measure for incentives.
IncentiveUnitTypeTransformer
Transformation class that can encode an instance of IncentiveUnit to String, and decode dynamic data back to IncentiveUnit.
IntroOfferType
IntroOfferTypeTypeTransformer
Transformation class that can encode an instance of IntroOfferType to String, and decode dynamic data back to IntroOfferType.
Lead
LeadAction
LeadActionType
LeadActionTypeTypeTransformer
Transformation class that can encode an instance of LeadActionType to String, and decode dynamic data back to LeadActionType.
LeadAutoInsuranceInformationJson
LeadAutoInsuranceInformationJsonAdditionalOperatorsInner
LeadAutoInsuranceInformationJsonAdditionalOperatorsInnerRelationshipEnum
LeadAutoInsuranceInformationJsonAdditionalOperatorsInnerRelationshipEnumTypeTransformer
Transformation class that can encode an instance of LeadAutoInsuranceInformationJsonAdditionalOperatorsInnerRelationshipEnum to String, and decode dynamic data back to LeadAutoInsuranceInformationJsonAdditionalOperatorsInnerRelationshipEnum.
LeadAutoInsuranceInformationJsonPolicyHolderInformation
LeadAutoInsuranceInformationJsonVehiclesInner
LeadAutoInsuranceInformationJsonVehiclesInnerOwnershipStatusEnum
LeadAutoInsuranceInformationJsonVehiclesInnerOwnershipStatusEnumTypeTransformer
Transformation class that can encode an instance of LeadAutoInsuranceInformationJsonVehiclesInnerOwnershipStatusEnum to String, and decode dynamic data back to LeadAutoInsuranceInformationJsonVehiclesInnerOwnershipStatusEnum.
LeadAutoInsuranceInformationJsonVehiclesInnerPrimaryUseEnum
LeadAutoInsuranceInformationJsonVehiclesInnerPrimaryUseEnumTypeTransformer
Transformation class that can encode an instance of LeadAutoInsuranceInformationJsonVehiclesInnerPrimaryUseEnum to String, and decode dynamic data back to LeadAutoInsuranceInformationJsonVehiclesInnerPrimaryUseEnum.
LeadAutoInsuranceIssuerJson
LeadAutoInsuranceVehicleMakeJson
LeadAutoInsuranceVehicleMakesJson
LeadAutoInsuranceVehicleModelJson
LeadAutoInsuranceVehicleModelsJson
LeadAutoInsuranceVehicleTrimsJson
LeadAutoInsuranceVehicleTrimsJsonTrimsInner
LeadAutoInsuranceVehicleYearsJson
LeadBestTimeToCall
LeadBestTimeToCallTypeTransformer
Transformation class that can encode an instance of LeadBestTimeToCall to String, and decode dynamic data back to LeadBestTimeToCall.
LeadClientTag
LeadClientTagsResponse
LeadCoApplicantInformationJson
LeadCreateData
LeadCreditCardInformationJson
LeadCreditInformationJson
LeadEducationInformationJson
LeadEmploymentInformationJson
LeadEvent
LeadEventResponse
LeadFinancialInformation
LeadHealthInformationJson
LeadIdentificationInformationJson
LeadInfoResponse
LeadInfoResponseData
LeadLegalInformationJson
LeadLoanInformationJson
LeadMortgageInformationJson
LeadPayout
LeadPayoutResponse
LeadPersonalInformation
LeadPersonalReferenceInformationJson
LeadRefinanceLoanInformationJson
LeadSavingsInformationJson
LeadSessionInformationJson
LeadUuid
LifeInsuranceOffer
LifeInsuranceOfferDetails
ListedEventData
LoanOffer
LoanPurpose
LoanPurposeTypeTransformer
Transformation class that can encode an instance of LoanPurpose to String, and decode dynamic data back to LoanPurpose.
MaritalStatus
MaritalStatusTypeTransformer
Transformation class that can encode an instance of MaritalStatus to String, and decode dynamic data back to MaritalStatus.
MedicalExam
Medical exam requirement
MedicalExamTypeTransformer
Transformation class that can encode an instance of MedicalExam to String, and decode dynamic data back to MedicalExam.
MortechCreditRating
MortechCreditRatingTypeTransformer
Transformation class that can encode an instance of MortechCreditRating to String, and decode dynamic data back to MortechCreditRating.
MortgageAdjustmentType
MortgageAdjustmentTypeTypeTransformer
Transformation class that can encode an instance of MortgageAdjustmentType to String, and decode dynamic data back to MortgageAdjustmentType.
MortgageLoanType
MortgageLoanTypeTypeTransformer
Transformation class that can encode an instance of MortgageLoanType to String, and decode dynamic data back to MortgageLoanType.
MortgageOffer
MortgageOfferDetails
MortgageType
MortgageTypeTypeTransformer
Transformation class that can encode an instance of MortgageType to String, and decode dynamic data back to MortgageType.
OAuth
OccupancyType
OccupancyTypeTypeTransformer
Transformation class that can encode an instance of OccupancyType to String, and decode dynamic data back to OccupancyType.
Offer
OfferClickedEventData
OfferDisplay
OfferDisplayCreateData
OpenedEventData
Originator
OriginatorImage
PackageType
Life insurance package types
PackageTypeTypeTransformer
Transformation class that can encode an instance of PackageType to String, and decode dynamic data back to PackageType.
Partner
PendingResponse
PersonalReferenceRelationType
PersonalReferenceRelationTypeTypeTransformer
Transformation class that can encode an instance of PersonalReferenceRelationType to String, and decode dynamic data back to PersonalReferenceRelationType.
PrefillApi
PrefillResponse
PreviewDetail
ProductSubType
A type of financial product
ProductSubTypeTypeTransformer
Transformation class that can encode an instance of ProductSubType to String, and decode dynamic data back to ProductSubType.
ProductType
ProductTypeTypeTransformer
Transformation class that can encode an instance of ProductType to String, and decode dynamic data back to ProductType.
PropertySearchStatus
PropertySearchStatusTypeTransformer
Transformation class that can encode an instance of PropertySearchStatus to String, and decode dynamic data back to PropertySearchStatus.
PropertyStatus
PropertyStatusTypeTransformer
Transformation class that can encode an instance of PropertyStatus to String, and decode dynamic data back to PropertyStatus.
PropertyType
PropertyTypeTypeTransformer
Transformation class that can encode an instance of PropertyType to String, and decode dynamic data back to PropertyType.
ProvidedCreditRating
ProvidedCreditRatingTypeTransformer
Transformation class that can encode an instance of ProvidedCreditRating to String, and decode dynamic data back to ProvidedCreditRating.
PurchaseStatus
PurchaseStatusTypeTransformer
Transformation class that can encode an instance of PurchaseStatus to String, and decode dynamic data back to PurchaseStatus.
QueryParam
RateTable
RateTableAdditionalOffers
RefinanceLoanType
RefinanceLoanTypeTypeTransformer
Transformation class that can encode an instance of RefinanceLoanType to String, and decode dynamic data back to RefinanceLoanType.
RefinanceType
RefinanceTypeTypeTransformer
Transformation class that can encode an instance of RefinanceType to String, and decode dynamic data back to RefinanceType.
RejectReason
RejectReasonTypeTransformer
Transformation class that can encode an instance of RejectReason to String, and decode dynamic data back to RejectReason.
SavingsOffer
SavingsOfferDetails
SessionInit
SessionInitCreateData
SpecialOffer
State
A two character upper case state, Puerto Rico, or District of Columbia code
StateTypeTransformer
Transformation class that can encode an instance of State to String, and decode dynamic data back to State.
TermUnit
Unit of measure for offer term lengths, or open for a single term.
TermUnitTypeTransformer
Transformation class that can encode an instance of TermUnit to String, and decode dynamic data back to TermUnit.
VehicleDetails
VehicleInformation

Properties

defaultApiClient ↔ ApiClient
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
getter/setter pair

Functions

decodeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
deserializeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) → Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) → DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) → String
Format the given parameter object into a String.
serializeAsync(Object? value) → Future<String>
Primarily intended for use in an isolate.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException