@matech/thebigpos-sdk 2.27.11-rc1 → 2.28.2-rc.0

package/src/index.ts

@@ -43,6 +43,12 @@ export type OperationType =
 
 export type LogLevel = "None" | "Info" | "Warning" | "Error";
 
+export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
+
+export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
+
+export type LoanTitleHeld = "Self" | "JointlyWithSpouse" | "JointlyWithAnother";
+
 export type LoanRole =
   | "Borrower"
   | "CoBorrower"
@@ -57,6 +63,8 @@ export type LoanRole =
   | "EscrowAgent"
   | "SettlementAgent";
 
+export type LoanRealEstateStatus = "Sold" | "Pending" | "Retained";
+
 export type LoanQueueType =
   | "Unknown"
   | "New"
@@ -68,12 +76,127 @@ export type LoanQueueType =
 
 export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
 
+export type LoanPurpose = "Purchase" | "Refinance";
+
+export type LoanPropertyType =
+  | "SingleFamily"
+  | "MultiFamily"
+  | "Condominium"
+  | "Townhouse"
+  | "ManufacturedHome"
+  | "PlannedUnitDevelopment"
+  | "ModularHome"
+  | "Other";
+
+export type LoanPhoneNumberType = "Home" | "Cell" | "Work" | "Fax" | "Other";
+
+export type LoanPacificIslanderRace =
+  | "NativeHawaiian"
+  | "GuamanianOrChamorro"
+  | "Samoan"
+  | "Other";
+
+export type LoanOtherLiabilityType =
+  | "Alimony"
+  | "ChildSupport"
+  | "SeparateMaintenance"
+  | "JobRelatedExpense"
+  | "Other";
+
+export type LoanOtherIncomeType =
+  | "Alimony"
+  | "AutomobileAllowance"
+  | "BoarderIncome"
+  | "CapitalGains"
+  | "ChildSupport"
+  | "Disability"
+  | "FosterCare"
+  | "Housing"
+  | "InterestAndDividends"
+  | "MortgageCreditCertificate"
+  | "MortgageDifferentialPayments"
+  | "NotesReceivable"
+  | "PublicAssistance"
+  | "Retirement"
+  | "RoyaltyPayments"
+  | "SeparateMaintenance"
+  | "SocialSecurity"
+  | "Trust"
+  | "Unemployment"
+  | "VaCompensation"
+  | "Other";
+
+export type LoanOtherAssetType =
+  | "ProceedsRealEstate"
+  | "ProceedsNonRealEstate"
+  | "SecuredBorrowerFunds"
+  | "UnsecuredBorrowerFunds"
+  | "EarnestMoney"
+  | "EmployerAssistance"
+  | "LotEquity"
+  | "ReAddressFunds"
+  | "RentCredit"
+  | "SweatEquity"
+  | "TradeEquity"
+  | "Other";
+
+export type LoanOccupancyType =
+  | "PrimaryResidence"
+  | "SecondHome"
+  | "InvestmentProperty"
+  | "Other";
+
+export type LoanNameSuffix =
+  | "Jr"
+  | "Sr"
+  | "II"
+  | "III"
+  | "IV"
+  | "V"
+  | "VI"
+  | "VII";
+
+export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
+
+export type LoanMilitaryServiceType =
+  | "Current"
+  | "RetiredDischargedSeparated"
+  | "NonActivatedNationalGuard"
+  | "SurvivingSpouse";
+
+export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
+
 export type LoanLogType =
   | "Loan"
   | "Queue"
   | "POSFlagChanged"
   | "Verification"
-  | "DocumentUploaded";
+  | "DocumentUploaded"
+  | "LoanCreated"
+  | "WorkflowSubmitted"
+  | "UserInvitationSent"
+  | "CoBorrowerAdded"
+  | "TaskCompleted"
+  | "LoanStatusChanged"
+  | "EConsent";
+
+export type LoanLienPosition = "First" | "Subordinate";
+
+export type LoanLiabilityType =
+  | "Revolving"
+  | "Installment"
+  | "Open30Day"
+  | "Lease"
+  | "Other";
+
+export type LoanLanguagePreference =
+  | "English"
+  | "Chinese"
+  | "Korean"
+  | "Spanish"
+  | "Tagalog"
+  | "Vietnamese"
+  | "Other";
 
 export type LoanImportStatus =
   | "WaitingProcess"
@@ -84,6 +207,69 @@ export type LoanImportStatus =
 
 export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
 
+export type LoanHousingType = "NoExpense" | "Own" | "Rent";
+
+export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
+
+export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
+
+export type LoanHispanicEthnicity =
+  | "Mexican"
+  | "PuertoRican"
+  | "Cuban"
+  | "Other";
+
+export type LoanGiftSource =
+  | "CommunityNonProfit"
+  | "Employer"
+  | "FederalAgency"
+  | "LocalAgency"
+  | "Relative"
+  | "ReligiousNonProfit"
+  | "StateAgency"
+  | "UnmarriedPartner"
+  | "Lender"
+  | "Other";
+
+export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
+
+export type LoanGenderType = "Male" | "Female";
+
+export type LoanCitizenship =
+  | "Us"
+  | "PermanentResidentAlien"
+  | "NonPermanentResidentAlien";
+
+export type LoanBankruptcyType =
+  | "Chapter7"
+  | "Chapter11"
+  | "Chapter12"
+  | "Chapter13";
+
+export type LoanAsianRace =
+  | "AsianIndian"
+  | "Chinese"
+  | "Filipino"
+  | "Japanese"
+  | "Korean"
+  | "Vietnamese"
+  | "Other";
+
+export type LoanAccountAssetType =
+  | "Checking"
+  | "Savings"
+  | "MoneyMarket"
+  | "CertificateOfDeposit"
+  | "MutualFund"
+  | "Stocks"
+  | "Bonds"
+  | "Retirement"
+  | "BridgeLoanProceeds"
+  | "IndividualDevelopmentAccount"
+  | "TrustAccount"
+  | "CashValueOfLifeInsurance"
+  | "Other";
+
 export type LoanAccessScopeType = "User" | "Branch";
 
 export type LOSStatus =
@@ -128,6 +314,41 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
 
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 
+export type AddressFamily =
+  | "Unspecified"
+  | "Unix"
+  | "InterNetwork"
+  | "ImpLink"
+  | "Pup"
+  | "Chaos"
+  | "NS"
+  | "Ipx"
+  | "Iso"
+  | "Osi"
+  | "Ecma"
+  | "DataKit"
+  | "Ccitt"
+  | "Sna"
+  | "DecNet"
+  | "DataLink"
+  | "Lat"
+  | "HyperChannel"
+  | "AppleTalk"
+  | "NetBios"
+  | "VoiceView"
+  | "FireFox"
+  | "Banyan"
+  | "Atm"
+  | "InterNetworkV6"
+  | "Cluster"
+  | "Ieee12844"
+  | "Irda"
+  | "NetworkDesigners"
+  | "Max"
+  | "Packet"
+  | "ControllerAreaNetwork"
+  | "Unknown";
+
 export interface ASOSettings {
   enabled: boolean;
   softPull: boolean;
@@ -209,6 +430,7 @@ export interface AddressRequest {
   /** @minLength 1 */
   street: string;
   unit?: string | null;
+  unitType?: string | null;
   /** @minLength 1 */
   city: string;
   /** @minLength 1 */
@@ -676,7 +898,7 @@ export interface CorporateSearchCriteria {
 }
 
 export interface CreateAccessScopeRequest {
-  scopeType: "User" | "Branch";
+  scopeType: CreateAccessScopeRequestScopeTypeEnum;
   /** @format uuid */
   userId?: string | null;
   /** @format uuid */
@@ -700,7 +922,7 @@ export interface CreateAccountRequest {
    */
   nlmsid: number;
   settings: AccountSettingsRequest;
-  environment: "Development" | "Staging" | "UAT" | "Production";
+  environment: CreateAccountRequestEnvironmentEnum;
   losIntegration: LOSIntegration;
 }
 
@@ -732,19 +954,7 @@ export interface CreateDocumentTemplateRequest {
 export interface CreateGroupMemberRequest {
   /** @format uuid */
   userId: string;
-  loanRole:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  loanRole: CreateGroupMemberRequestLoanRoleEnum;
 }
 
 export interface CreateInviteRequest {
@@ -756,7 +966,7 @@ export interface CreateInviteRequest {
   emailAddress: string;
   phoneNumber?: string | null;
   /** @deprecated */
-  relationship: "NotApplicable" | "Spouse" | "NonSpouse";
+  relationship: CreateInviteRequestRelationshipEnum;
   loanID: string;
   route?: string | null;
   /** @format uuid */
@@ -779,7 +989,7 @@ export interface CreateLoanImportRequest {
    * @minLength 1
    */
   startDate: string;
-  importMode: "All" | "NewOnly" | "UpdateOnly";
+  importMode: CreateLoanImportRequestImportModeEnum;
 }
 
 export interface CreateUserDeviceRequest {
@@ -787,19 +997,7 @@ export interface CreateUserDeviceRequest {
 }
 
 export interface CreateUserDraft {
-  loanRole:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  loanRole: CreateUserDraftLoanRoleEnum;
 }
 
 export interface CreateUserGroupRequest {
@@ -1086,7 +1284,7 @@ export interface Draft {
   siteConfiguration: SiteConfigurationReduced;
   /** @format uuid */
   loanID?: string | null;
-  type: "NewLoan" | "EditLoan";
+  type: DraftTypeEnum;
   isCoBorrower: boolean;
 }
 
@@ -1105,7 +1303,7 @@ export interface DraftContent {
   siteConfiguration: SiteConfigurationReduced;
   /** @format uuid */
   loanID?: string | null;
-  type: "NewLoan" | "EditLoan";
+  type: DraftContentTypeEnum;
   isCoBorrower: boolean;
   applicationPayload: any;
 }
@@ -1403,20 +1601,7 @@ export interface FusionFieldDisplay {
 }
 
 export interface FusionReportFilter {
-  filterType:
-    | "DateGreaterThanOrEqualTo"
-    | "DateGreaterThan"
-    | "DateLessThan"
-    | "DateLessThanOrEqualTo"
-    | "DateEquals"
-    | "DateDoesntEqual"
-    | "DateNonEmpty"
-    | "DateEmpty"
-    | "StringContains"
-    | "StringEquals"
-    | "StringNotEmpty"
-    | "StringNotEquals"
-    | "StringNotContains";
+  filterType: FusionReportFilterFilterTypeEnum;
   targetField: string;
   targetValue: string;
 }
@@ -1538,6 +1723,23 @@ export interface GetWorkflowRequest {
 
 export type IContractResolver = object;
 
+export interface IPAddress {
+  addressFamily: IpAddressAddressFamilyEnum;
+  /** @format int64 */
+  scopeId: number;
+  isIPv6Multicast: boolean;
+  isIPv6LinkLocal: boolean;
+  isIPv6SiteLocal: boolean;
+  isIPv6Teredo: boolean;
+  isIPv6UniqueLocal: boolean;
+  isIPv4MappedToIPv6: boolean;
+  /**
+   * @deprecated
+   * @format int64
+   */
+  address: number;
+}
+
 export interface ImpersonatedDetailedUser {
   /** @format date-time */
   createdAt?: string | null;
@@ -1775,6 +1977,308 @@ export interface Loan {
   contacts: LoanContact[];
 }
 
+export interface LoanBorrowerAccountAssetRequest {
+  name?: string | null;
+  accountNumber?: string | null;
+  financialInstitution?: string | null;
+  /** @format double */
+  value?: number | null;
+  type?: LoanAccountAssetType | null;
+}
+
+export interface LoanBorrowerAddressRequest {
+  street?: string | null;
+  unit?: string | null;
+  unitType?: string | null;
+  city?: string | null;
+  state?: string | null;
+  county?: string | null;
+  postalCode?: string | null;
+  housing?: LoanHousingType | null;
+  /** @format double */
+  rentAmount?: number | null;
+  isCurrent?: boolean | null;
+  isMailingAddress?: boolean | null;
+  timeAtAddress?: TimeAtAddressRequest | null;
+}
+
+export interface LoanBorrowerAlternateNameRequest {
+  suffix?: string | null;
+  lastName?: string | null;
+  firstName?: string | null;
+  middleName?: string | null;
+}
+
+export interface LoanBorrowerBankruptcyDeclarationRequest {
+  isAffirmative?: boolean | null;
+  description?: string | null;
+  types?: LoanBankruptcyType[] | null;
+}
+
+export interface LoanBorrowerConsentRequest {
+  type?: ConsentType | null;
+  providedConsent?: boolean | null;
+  ipAddress?: IPAddress | null;
+}
+
+export interface LoanBorrowerDeclarationsRequest {
+  borrowingMoney?: LoanBorrowerMoneyDeclarationRequest | null;
+  bankruptcy?: LoanBorrowerBankruptcyDeclarationRequest | null;
+  primaryResidence?: LoanBorrowerPrimaryResidenceDeclarationRequest | null;
+  foreclosure?: LoanBorrowerSimpleDeclarationRequest | null;
+  coSignerOnDebt?: LoanBorrowerSimpleDeclarationRequest | null;
+  partyToLawsuit?: LoanBorrowerSimpleDeclarationRequest | null;
+  outstandingJudgments?: LoanBorrowerSimpleDeclarationRequest | null;
+  applyingForNewCredit?: LoanBorrowerSimpleDeclarationRequest | null;
+  subjectToLienPriority?: LoanBorrowerSimpleDeclarationRequest | null;
+  inDelinquencyOrDefault?: LoanBorrowerSimpleDeclarationRequest | null;
+  relationshipWithSeller?: LoanBorrowerSimpleDeclarationRequest | null;
+  preForeclosureOrShortSale?: LoanBorrowerSimpleDeclarationRequest | null;
+  applyingForAnotherMortgage?: LoanBorrowerSimpleDeclarationRequest | null;
+  conveyedTitleToPropertyForeclosure?: LoanBorrowerSimpleDeclarationRequest | null;
+}
+
+export interface LoanBorrowerDemographicsEthnicityRequest {
+  isDeclined?: boolean | null;
+  isHispanicOrLatino?: boolean | null;
+  otherHispanicOrLatino?: string | null;
+  hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
+}
+
+export interface LoanBorrowerDemographicsGenderRequest {
+  isDeclined?: boolean | null;
+  gender?: LoanGenderType | null;
+}
+
+export interface LoanBorrowerDemographicsRaceRequest {
+  isAmericanIndianOrAlaskanNative?: boolean | null;
+  otherAmericanIndianOrAlaskanNative?: string | null;
+  isAsian?: boolean | null;
+  asianRaces?: LoanAsianRace[] | null;
+  otherAsianRace?: string | null;
+  isBlackOrAfrican?: boolean | null;
+  isPacificIslander?: boolean | null;
+  pacificIslanderRace?: LoanPacificIslanderRace[] | null;
+  otherPacificIslanderRace?: string | null;
+  isWhite?: boolean | null;
+  isDeclined?: boolean | null;
+}
+
+export interface LoanBorrowerDemographicsRequest {
+  race?: LoanBorrowerDemographicsRaceRequest | null;
+  gender?: LoanBorrowerDemographicsGenderRequest | null;
+  ethnicity?: LoanBorrowerDemographicsEthnicityRequest | null;
+}
+
+export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
+  /** @format double */
+  base?: number | null;
+  /** @format double */
+  other?: number | null;
+  /** @format double */
+  bonus?: number | null;
+  /** @format double */
+  overtime?: number | null;
+  /** @format double */
+  commission?: number | null;
+  /** @format double */
+  militaryEntitlements?: number | null;
+}
+
+export interface LoanBorrowerEmploymentCurrentOwnershipRequest {
+  isOwner?: boolean | null;
+  hasOwnershipOver25Percent?: boolean | null;
+  /** @format double */
+  monthlyIncome?: number | null;
+}
+
+export interface LoanBorrowerEmploymentCurrentRequest {
+  name?: string | null;
+  title?: string | null;
+  phoneNumber?: string | null;
+  /** @format date */
+  startDate?: string | null;
+  isSelfEmployed?: boolean | null;
+  isEmployedByPartyInTransaction?: boolean | null;
+  address?: AddressRequest | null;
+  ownership?: LoanBorrowerEmploymentCurrentOwnershipRequest | null;
+  grossIncome?: LoanBorrowerEmploymentCurrentGrossIncomeRequest | null;
+  timeInLineOfWork?: LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest | null;
+}
+
+export interface LoanBorrowerEmploymentCurrentTimeInLineOfWorkRequest {
+  /** @format int32 */
+  years?: number | null;
+  /** @format int32 */
+  months?: number | null;
+}
+
+export interface LoanBorrowerEmploymentPreviousRequest {
+  name?: string | null;
+  title?: string | null;
+  phoneNumber?: string | null;
+  /** @format date */
+  startDate?: string | null;
+  /** @format date */
+  endDate?: string | null;
+  /** @format double */
+  grossIncome?: number | null;
+  isSelfEmployed?: boolean | null;
+  address?: AddressRequest | null;
+}
+
+export interface LoanBorrowerGiftRequest {
+  /** @format double */
+  value?: number | null;
+  isDeposited?: boolean | null;
+  source?: LoanGiftSource | null;
+  assetType?: LoanGiftAssetType | null;
+}
+
+export interface LoanBorrowerHomeOwnershipProviderRequest {
+  name?: string | null;
+  phoneNumber?: string | null;
+  address?: AddressRequest | null;
+}
+
+export interface LoanBorrowerHomeOwnershipRequest {
+  /** @format date */
+  dateCompleted?: string | null;
+  type?: LoanHomeOwnershipType | null;
+  format?: LoanHomeOwnershipFormat | null;
+  provider?: LoanBorrowerHomeOwnershipProviderRequest | null;
+}
+
+export interface LoanBorrowerLiabilityRequest {
+  type?: LoanLiabilityType | null;
+  name?: string | null;
+  accountNumber?: string | null;
+  financialInstitution?: string | null;
+  /** @format double */
+  balance?: number | null;
+  /** @format double */
+  monthlyPayment?: number | null;
+  /** @format int32 */
+  monthsLeftToPay?: number | null;
+  isPaidOffBeforeClosing?: boolean | null;
+}
+
+export interface LoanBorrowerMilitaryServiceRequest {
+  hasServed?: boolean | null;
+  /** @format date */
+  endDate?: string | null;
+  type?: LoanMilitaryServiceType | null;
+}
+
+export interface LoanBorrowerMoneyDeclarationRequest {
+  isAffirmative?: boolean | null;
+  description?: string | null;
+  /** @format double */
+  amount?: number | null;
+}
+
+export interface LoanBorrowerOtherAssetRequest {
+  type?: LoanOtherAssetType | null;
+  other?: string | null;
+  /** @format double */
+  value?: number | null;
+}
+
+export interface LoanBorrowerOtherIncomeRequest {
+  /** @format double */
+  value?: number | null;
+  type?: LoanOtherIncomeType | null;
+}
+
+export interface LoanBorrowerOtherLiabilityRequest {
+  /** @format double */
+  monthlyPayment?: number | null;
+  type?: LoanOtherLiabilityType | null;
+}
+
+export interface LoanBorrowerPhoneNumberRequest {
+  ext?: string | null;
+  number?: string | null;
+  type?: LoanPhoneNumberType | null;
+}
+
+export interface LoanBorrowerPrimaryResidenceDeclarationRequest {
+  isAffirmative?: boolean | null;
+  description?: string | null;
+  hasInterestInLastThreeYears?: boolean | null;
+  titleHeld?: LoanTitleHeld | null;
+  propertyType?: LoanOccupancyType | null;
+}
+
+export interface LoanBorrowerRealEstateAssetMortgageRequest {
+  creditor?: string | null;
+  accountNumber?: string | null;
+  /** @format double */
+  balance?: number | null;
+  /** @format double */
+  creditLimit?: number | null;
+  /** @format double */
+  monthlyMortgagePayment?: number | null;
+  isBalancePaidBeforeClosing?: boolean | null;
+  loanType?: LoanType | null;
+}
+
+export interface LoanBorrowerRealEstateAssetRequest {
+  status?: LoanRealEstateStatus | null;
+  occupancy?: LoanOccupancyType | null;
+  /** @format double */
+  marketValue?: number | null;
+  /** @format double */
+  monthlyInsTaxDues?: number | null;
+  /** @format double */
+  monthlyRentalIncome?: number | null;
+  address?: AddressRequest | null;
+  mortgages?: LoanBorrowerRealEstateAssetMortgageRequest[] | null;
+}
+
+export interface LoanBorrowerRequest {
+  ssn?: string | null;
+  email?: string | null;
+  lastName?: string | null;
+  firstName?: string | null;
+  middleName?: string | null;
+  prefix?: LoanNamePrefix | null;
+  suffix?: LoanNameSuffix | null;
+  /** @format date-time */
+  birthDate?: string | null;
+  citizenship?: LoanCitizenship | null;
+  maritalStatus?: LoanMaritalStatus | null;
+  languagePreference?: LoanLanguagePreference | null;
+  /** @format int32 */
+  numberOfDependents?: number | null;
+  isPrimaryBorrower: boolean;
+  isFirstTimeHomeBuyer?: boolean | null;
+  hasJointAssetsAndLiabilities?: boolean | null;
+  dependentAges?: number[] | null;
+  demographics?: LoanBorrowerDemographicsRequest | null;
+  declarations?: LoanBorrowerDeclarationsRequest | null;
+  militaryService?: LoanBorrowerMilitaryServiceRequest | null;
+  gifts: LoanBorrowerGiftRequest[];
+  addresses: LoanBorrowerAddressRequest[];
+  consents: LoanBorrowerConsentRequest[];
+  liabilities: LoanBorrowerLiabilityRequest[];
+  otherAssets: LoanBorrowerOtherAssetRequest[];
+  otherIncome: LoanBorrowerOtherIncomeRequest[];
+  phoneNumbers: LoanBorrowerPhoneNumberRequest[];
+  accountAssets: LoanBorrowerAccountAssetRequest[];
+  homeOwnership: LoanBorrowerHomeOwnershipRequest[];
+  alternateNames: LoanBorrowerAlternateNameRequest[];
+  otherLiabilities: LoanBorrowerOtherLiabilityRequest[];
+  realEstateAssets: LoanBorrowerRealEstateAssetRequest[];
+  currentEmployment: LoanBorrowerEmploymentCurrentRequest[];
+  previousEmployment: LoanBorrowerEmploymentPreviousRequest[];
+}
+
+export interface LoanBorrowerSimpleDeclarationRequest {
+  isAffirmative?: boolean | null;
+  description?: string | null;
+}
+
 export interface LoanComparison {
   loanID: string;
   scenarios: LoanComparisonScenario[];
@@ -1912,19 +2416,7 @@ export interface LoanContact {
   email?: string | null;
   phone?: string | null;
   companyName?: string | null;
-  role:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  role: LoanContactRoleEnum;
 }
 
 export interface LoanContactList {
@@ -1937,6 +2429,20 @@ export interface LoanCreateRequest {
    * @minLength 1
    */
   draftId: string;
+  loanOfficerEmail?: string | null;
+  type?: LoanType | null;
+  purpose?: LoanPurpose | null;
+  lienPosition?: LoanLienPosition | null;
+  number?: string | null;
+  program?: string | null;
+  channel?: string | null;
+  isPOSLoan?: boolean | null;
+  /** @format date-time */
+  startDate?: string | null;
+  property?: LoanPropertyRequest | null;
+  financial?: LoanFinancialRequest | null;
+  borrowers: LoanBorrowerRequest[];
+  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
 }
 
 export interface LoanCustomFieldsRequest {
@@ -2008,6 +2514,16 @@ export interface LoanDraftSearchCriteria {
   draftTypes?: DraftType[] | null;
 }
 
+export interface LoanFinancialRequest {
+  isDebtsAssetsReviewed?: boolean | null;
+  /** @format double */
+  cashToClose?: number | null;
+  /** @format double */
+  cashDownPayment?: number | null;
+  /** @format double */
+  maximumPurchasePrice?: number | null;
+}
+
 export interface LoanIdentifier {
   /** @format uuid */
   id: string;
@@ -2027,19 +2543,14 @@ export interface LoanImport {
   /** @format int32 */
   importedCount: number;
   statusMessage?: string | null;
-  status:
-    | "WaitingProcess"
-    | "InProgress"
-    | "Completed"
-    | "Failed"
-    | "Cancelled";
-  importMode: "All" | "NewOnly" | "UpdateOnly";
+  status: LoanImportStatusEnum;
+  importMode: LoanImportImportModeEnum;
   /** @format date-time */
   createdAt?: string | null;
 }
 
 export interface LoanImportLog {
-  level: "None" | "Info" | "Warning" | "Error";
+  level: LoanImportLogLevelEnum;
   message: string;
   /** @format date-time */
   createdAt: string;
@@ -2088,13 +2599,8 @@ export interface LoanListPaginated {
 export interface LoanLog {
   /** @format uuid */
   id: string;
-  level: "None" | "Info" | "Warning" | "Error";
-  type:
-    | "Loan"
-    | "Queue"
-    | "POSFlagChanged"
-    | "Verification"
-    | "DocumentUploaded";
+  level: LoanLogLevelEnum;
+  type: LoanLogTypeEnum;
   message: string;
   /** @format date-time */
   createdAt: string;
@@ -2113,6 +2619,16 @@ export interface LoanLogSearchCriteria {
   levels?: LogLevel[] | null;
 }
 
+export interface LoanNonOwningBorrowerRequest {
+  email?: string | null;
+  lastName?: string | null;
+  firstName?: string | null;
+  middleName?: string | null;
+  prefix?: LoanNamePrefix | null;
+  suffix?: LoanNameSuffix | null;
+  consents: LoanBorrowerConsentRequest[];
+}
+
 export interface LoanOfficer {
   /** @format uuid */
   id: string;
@@ -2148,6 +2664,45 @@ export interface LoanOfficerSearchCriteria {
   brand?: string | null;
 }
 
+export interface LoanPropertyMortgageRequest {
+  creditor?: string | null;
+  /** @format double */
+  loanAmount?: number | null;
+  /** @format double */
+  creditLimit?: number | null;
+  /** @format double */
+  monthlyPayment?: number | null;
+  lienType?: LoanLienPosition | null;
+}
+
+export interface LoanPropertyRequest {
+  trustType?: LoanTrustType | null;
+  occupancy?: LoanOccupancyType | null;
+  propertyType?: LoanPropertyType | null;
+  referenceId?: string | null;
+  /** @format int32 */
+  yearBuilt?: number | null;
+  /** @format int32 */
+  yearAcquired?: number | null;
+  /** @format int32 */
+  numberOfUnits?: number | null;
+  /** @format double */
+  salePrice?: number | null;
+  /** @format double */
+  propertyValue?: number | null;
+  /** @format double */
+  purchasePrice?: number | null;
+  /** @format double */
+  estimatedValue?: number | null;
+  /** @format double */
+  monthlyRentalIncome?: number | null;
+  isMixedUseProperty?: boolean | null;
+  isManufacturedHome?: boolean | null;
+  isFhaSecondaryResidence?: boolean | null;
+  address?: AddressRequest | null;
+  mortgages: LoanPropertyMortgageRequest[];
+}
+
 export interface LoanQueue {
   /** @format date-time */
   createdAt: string;
@@ -2231,14 +2786,7 @@ export interface LoanUpdateRequestJsonPatchDocument {
 }
 
 export interface LoanUpdateRequestOperation {
-  operationType:
-    | "Add"
-    | "Remove"
-    | "Replace"
-    | "Move"
-    | "Copy"
-    | "Test"
-    | "Invalid";
+  operationType: LoanUpdateRequestOperationOperationTypeEnum;
   path?: string | null;
   op?: string | null;
   from?: string | null;
@@ -2253,19 +2801,7 @@ export interface LoanUser {
   email: string;
   phone?: string | null;
   role: string;
-  loanRole:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  loanRole: LoanUserLoanRoleEnum;
   isUser: boolean;
   /** @format date-time */
   createdAt: string;
@@ -2549,7 +3085,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 
 export interface Operation {
   op?: string;
-  value?: string | number | boolean | null | object;
+  value?: object | null;
   path?: string;
 }
 
@@ -2896,7 +3432,7 @@ export interface SSOTokenRequest {
 }
 
 export interface SamlMetadataRequest {
-  ssoIntegration: "ConsumerConnect" | "TheBigPOS";
+  ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
 }
 
 export interface SendForgotPasswordRequest {
@@ -2935,7 +3471,7 @@ export interface SiteConfiguration {
   deletedAt?: string | null;
   /** @format uuid */
   id: string;
-  type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+  type: SiteConfigurationTypeEnum;
   /** @format uuid */
   entityID: string;
   /** @format int32 */
@@ -3130,7 +3666,7 @@ export interface SiteConfigurationByUrl {
   deletedAt?: string | null;
   /** @format uuid */
   id: string;
-  type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+  type: SiteConfigurationByUrlTypeEnum;
   /** @format uuid */
   entityID: string;
   /** @format int32 */
@@ -3343,7 +3879,7 @@ export interface SiteConfigurationForm {
 export interface SiteConfigurationReduced {
   /** @format uuid */
   id: string;
-  type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+  type: SiteConfigurationReducedTypeEnum;
   url?: string | null;
   name: string;
   /** @format int64 */
@@ -3361,7 +3897,7 @@ export interface SiteConfigurationRequest {
   entityID: string;
   /** @format int32 */
   entityType: number;
-  type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+  type: SiteConfigurationRequestTypeEnum;
   url: string;
   name: string;
   introduction?: string | null;
@@ -3538,7 +4074,7 @@ export interface SiteConfigurationSearchCriteria {
 export interface SiteConfigurationSummary {
   /** @format uuid */
   id: string;
-  type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+  type: SiteConfigurationSummaryTypeEnum;
   url?: string | null;
   name: string;
   /** @format int64 */
@@ -3736,6 +4272,13 @@ export interface Theme {
   iconColor?: string | null;
 }
 
+export interface TimeAtAddressRequest {
+  /** @format int32 */
+  years?: number | null;
+  /** @format int32 */
+  months?: number | null;
+}
+
 export interface Token {
   token_type: string;
   /** @format int32 */
@@ -3977,19 +4520,7 @@ export interface UserDevice {
 export interface UserDraft {
   /** @format uuid */
   draftID: string;
-  role:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  role: UserDraftRoleEnum;
   user: User;
 }
 
@@ -4016,7 +4547,7 @@ export interface UserGroupAccessScope {
   id: string;
   /** @format uuid */
   groupId: string;
-  scopeType: "User" | "Branch";
+  scopeType: UserGroupAccessScopeScopeTypeEnum;
   /** @format uuid */
   userId?: string | null;
   /** @format uuid */
@@ -4052,19 +4583,7 @@ export interface UserLoan {
   deletedAt?: string | null;
   loanID: string;
   user: User;
-  role:
-    | "Borrower"
-    | "CoBorrower"
-    | "NonBorrower"
-    | "LoanOfficer"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "SupportingLoanOfficer"
-    | "BuyerAgent"
-    | "SellerAgent"
-    | "TitleInsuranceAgent"
-    | "EscrowAgent"
-    | "SettlementAgent";
+  role: UserLoanRoleEnum;
   /** @format int32 */
   borrowerPair?: number | null;
   /** @format int32 */
@@ -4077,7 +4596,7 @@ export interface UserLoanConsent {
   id: string;
   /** @format uuid */
   userLoanID: string;
-  type: "Econsent" | "CreditAuthorization" | "Tcpa";
+  type: UserLoanConsentTypeEnum;
   providedConsent: boolean;
   ipAddress?: string | null;
   /** @format date-time */
@@ -4224,17 +4743,7 @@ export interface UserSummary {
   id: string;
   name?: string | null;
   email?: string | null;
-  role:
-    | "Borrower"
-    | "LoanOfficer"
-    | "Admin"
-    | "SuperAdmin"
-    | "Realtor"
-    | "SettlementAgent"
-    | "LoanProcessor"
-    | "LoanOfficerAssistant"
-    | "BranchManager"
-    | "SystemAdmin";
+  role: UserSummaryRoleEnum;
 }
 
 export interface VerifyPasswordRequest {
@@ -4270,6 +4779,289 @@ export interface Workflow {
   icon: string;
 }
 
+export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
+
+export type CreateAccountRequestEnvironmentEnum =
+  | "Development"
+  | "Staging"
+  | "UAT"
+  | "Production";
+
+export type CreateGroupMemberRequestLoanRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+/** @deprecated */
+export type CreateInviteRequestRelationshipEnum =
+  | "NotApplicable"
+  | "Spouse"
+  | "NonSpouse";
+
+export type CreateLoanImportRequestImportModeEnum =
+  | "All"
+  | "NewOnly"
+  | "UpdateOnly";
+
+export type CreateUserDraftLoanRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type DraftTypeEnum = "NewLoan" | "EditLoan";
+
+export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
+
+export type FusionReportFilterFilterTypeEnum =
+  | "DateGreaterThanOrEqualTo"
+  | "DateGreaterThan"
+  | "DateLessThan"
+  | "DateLessThanOrEqualTo"
+  | "DateEquals"
+  | "DateDoesntEqual"
+  | "DateNonEmpty"
+  | "DateEmpty"
+  | "StringContains"
+  | "StringEquals"
+  | "StringNotEmpty"
+  | "StringNotEquals"
+  | "StringNotContains";
+
+export type IpAddressAddressFamilyEnum =
+  | "Unspecified"
+  | "Unix"
+  | "InterNetwork"
+  | "ImpLink"
+  | "Pup"
+  | "Chaos"
+  | "NS"
+  | "Ipx"
+  | "Iso"
+  | "Osi"
+  | "Ecma"
+  | "DataKit"
+  | "Ccitt"
+  | "Sna"
+  | "DecNet"
+  | "DataLink"
+  | "Lat"
+  | "HyperChannel"
+  | "AppleTalk"
+  | "NetBios"
+  | "VoiceView"
+  | "FireFox"
+  | "Banyan"
+  | "Atm"
+  | "InterNetworkV6"
+  | "Cluster"
+  | "Ieee12844"
+  | "Irda"
+  | "NetworkDesigners"
+  | "Max"
+  | "Packet"
+  | "ControllerAreaNetwork"
+  | "Unknown";
+
+export type LoanContactRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type LoanImportStatusEnum =
+  | "WaitingProcess"
+  | "InProgress"
+  | "Completed"
+  | "Failed"
+  | "Cancelled";
+
+export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
+
+export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
+
+export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
+
+export type LoanLogTypeEnum =
+  | "Loan"
+  | "Queue"
+  | "POSFlagChanged"
+  | "Verification"
+  | "DocumentUploaded"
+  | "LoanCreated"
+  | "WorkflowSubmitted"
+  | "UserInvitationSent"
+  | "CoBorrowerAdded"
+  | "TaskCompleted"
+  | "LoanStatusChanged"
+  | "EConsent";
+
+export type LoanUpdateRequestOperationOperationTypeEnum =
+  | "Add"
+  | "Remove"
+  | "Replace"
+  | "Move"
+  | "Copy"
+  | "Test"
+  | "Invalid";
+
+export type LoanUserLoanRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type SamlMetadataRequestSsoIntegrationEnum =
+  | "ConsumerConnect"
+  | "TheBigPOS";
+
+export type SiteConfigurationTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type SiteConfigurationByUrlTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type SiteConfigurationReducedTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type SiteConfigurationRequestTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type SiteConfigurationSummaryTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type UserDraftRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
+
+export type UserLoanRoleEnum =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type UserLoanConsentTypeEnum =
+  | "Econsent"
+  | "CreditAuthorization"
+  | "Tcpa";
+
+export type UserSummaryRoleEnum =
+  | "Borrower"
+  | "LoanOfficer"
+  | "Admin"
+  | "SuperAdmin"
+  | "Realtor"
+  | "SettlementAgent"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "BranchManager"
+  | "SystemAdmin";
+
+/** @default "Realtor" */
+export type GetPartnersParamsRoleEnum =
+  | "Borrower"
+  | "LoanOfficer"
+  | "Admin"
+  | "SuperAdmin"
+  | "Realtor"
+  | "SettlementAgent"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "BranchManager"
+  | "SystemAdmin";
+
+export type GetSamlMetadataParamsSSoIntegrationEnum =
+  | "ConsumerConnect"
+  | "TheBigPOS";
+
+export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
+
+export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum =
+  | "ConsumerConnect"
+  | "TheBigPOS";
+
+export type CreateOrReplaceSamlMetadataParamsEnum =
+  | "ConsumerConnect"
+  | "TheBigPOS";
+
 import type {
   AxiosInstance,
   AxiosRequestConfig,
@@ -4312,7 +5104,6 @@ export interface ApiConfig<SecurityDataType = unknown>
 }
 
 export enum ContentType {
-  JsonPatch = "application/json-patch+json",
   Json = "application/json",
   JsonApi = "application/vnd.api+json",
   FormData = "multipart/form-data",
@@ -4448,7 +5239,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.27.9
+ * @version v2.28.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -6631,7 +7422,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -6733,7 +7524,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -6759,7 +7550,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -6999,7 +7790,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -7079,7 +7870,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -8530,7 +9321,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.JsonPatch,
+        type: ContentType.Json,
         format: "json",
         ...params,
       }),
@@ -9578,17 +10369,7 @@ export class Api<
       query?: {
         showAll?: boolean;
         /** @default "Realtor" */
-        role?:
-          | "Borrower"
-          | "LoanOfficer"
-          | "Admin"
-          | "SuperAdmin"
-          | "Realtor"
-          | "SettlementAgent"
-          | "LoanProcessor"
-          | "LoanOfficerAssistant"
-          | "BranchManager"
-          | "SystemAdmin";
+        role?: GetPartnersParamsRoleEnum;
         /** @format int32 */
         pageSize?: number;
         /** @format int32 */
@@ -9924,7 +10705,7 @@ export class Api<
      * @response `404` `ProblemDetails` Not Found
      */
     getSamlMetadata: (
-      sSoIntegration: "ConsumerConnect" | "TheBigPOS",
+      sSoIntegration: GetSamlMetadataParamsEnum,
       ssoIntegration: string,
       params: RequestParams = {},
     ) =>
@@ -9946,7 +10727,7 @@ export class Api<
      * @response `200` `File` Success
      */
     createOrReplaceSamlMetadata: (
-      sSoIntegration: "ConsumerConnect" | "TheBigPOS",
+      sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
       ssoIntegration: string,
       params: RequestParams = {},
     ) =>