@matech/thebigpos-sdk 2.29.2 → 2.31.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,23 +1,24 @@
1
1
  export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
2
2
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3
- export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS";
3
+ export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
4
4
  export type OperationType = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
5
5
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
6
6
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
7
7
  export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
8
- export type LoanTitleHeld = "Self" | "JointlyWithSpouse" | "JointlyWithAnother";
8
+ export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
9
9
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
10
- export type LoanRealEstateStatus = "Sold" | "Pending" | "Retained";
10
+ export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
11
11
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
12
12
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
13
13
  export type LoanPurpose = "Purchase" | "Refinance";
14
14
  export type LoanPropertyType = "SingleFamily" | "MultiFamily" | "Condominium" | "Townhouse" | "ManufacturedHome" | "PlannedUnitDevelopment" | "ModularHome" | "Other";
15
15
  export type LoanPhoneNumberType = "Home" | "Cell" | "Work" | "Fax" | "Other";
16
16
  export type LoanPacificIslanderRace = "NativeHawaiian" | "GuamanianOrChamorro" | "Samoan" | "Other";
17
+ export type LoanOwnershipInterestPropertyType = "PrimaryResidence" | "FHASecondaryResidence" | "SecondaryResidence" | "Investment";
17
18
  export type LoanOtherLiabilityType = "Alimony" | "ChildSupport" | "SeparateMaintenance" | "JobRelatedExpense" | "Other";
18
- export type LoanOtherIncomeType = "Alimony" | "AutomobileAllowance" | "BoarderIncome" | "CapitalGains" | "ChildSupport" | "Disability" | "FosterCare" | "Housing" | "InterestAndDividends" | "MortgageCreditCertificate" | "MortgageDifferentialPayments" | "NotesReceivable" | "PublicAssistance" | "Retirement" | "RoyaltyPayments" | "SeparateMaintenance" | "SocialSecurity" | "Trust" | "Unemployment" | "VaCompensation" | "Other";
19
+ export type LoanOtherIncomeType = "AccessoryUnitIncome" | "Alimony" | "AutomobileAllowance" | "BoarderIncome" | "CapitalGains" | "ChildSupport" | "DefinedContributionPlan" | "Disability" | "DividendsInterest" | "EmploymentRelatedAccount" | "FosterCare" | "HousingAllowance" | "HousingChoiceVoucherProgram" | "MortgageCreditCertificate" | "MortgageDifferential" | "NonBorrowerHouseholdIncome" | "NotesReceivableInstallment" | "Pension" | "PublicAssistance" | "Royalties" | "SeparateMaintenance" | "SocialSecurity" | "TemporaryLeave" | "TipIncome" | "Trust" | "VABenefitsNonEducational" | "Other";
19
20
  export type LoanOtherAssetType = "ProceedsRealEstate" | "ProceedsNonRealEstate" | "SecuredBorrowerFunds" | "UnsecuredBorrowerFunds" | "EarnestMoney" | "EmployerAssistance" | "LotEquity" | "ReAddressFunds" | "RentCredit" | "SweatEquity" | "TradeEquity" | "Other";
20
- export type LoanOccupancyType = "PrimaryResidence" | "SecondHome" | "InvestmentProperty" | "Other";
21
+ export type LoanOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "Other";
21
22
  export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "VII";
22
23
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
23
24
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
@@ -35,12 +36,12 @@ export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other
35
36
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other";
36
37
  export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
37
38
  export type LoanGenderType = "Male" | "Female";
38
- export type LoanCitizenship = "Us" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
39
+ export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
39
40
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
40
41
  export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese" | "Korean" | "Vietnamese" | "Other";
41
42
  export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
42
43
  export type LoanAccessScopeType = "User" | "Branch";
43
- export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently";
44
+ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
44
45
  export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
45
46
  export type Environment = "Development" | "Staging" | "UAT" | "Production";
46
47
  export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
@@ -499,6 +500,38 @@ export interface ChangePasswordRequest {
499
500
  /** @minLength 8 */
500
501
  newPassword: string;
501
502
  }
503
+ export interface ClosedLoansReport {
504
+ /** @format int32 */
505
+ totalClosedPosLoans: number;
506
+ /** @format int32 */
507
+ totalClosedNonPosLoans: number;
508
+ /** @format double */
509
+ totalUtilization: number;
510
+ accounts: ClosedLoansReportAccount[];
511
+ }
512
+ export interface ClosedLoansReportAccount {
513
+ /** @format uuid */
514
+ id: string;
515
+ name: string;
516
+ /** @format int32 */
517
+ closedPosLoans: number;
518
+ /** @format int32 */
519
+ closedNonPosLoans: number;
520
+ /** @format double */
521
+ utilization: number;
522
+ }
523
+ export interface ClosedLoansReportRequest {
524
+ /**
525
+ * @format date
526
+ * @minLength 1
527
+ */
528
+ startDate: string;
529
+ /**
530
+ * @format date
531
+ * @minLength 1
532
+ */
533
+ endDate: string;
534
+ }
502
535
  export interface CommentUserInformation {
503
536
  entityId: string;
504
537
  entityType: string;
@@ -674,6 +707,18 @@ export interface CreateLoanImportRequest {
674
707
  startDate: string;
675
708
  importMode: "All" | "NewOnly" | "UpdateOnly";
676
709
  }
710
+ export interface CreateSession {
711
+ sessionId: string;
712
+ sessionUrl: string;
713
+ /** @format date-time */
714
+ createdAt: string;
715
+ /** @format date-time */
716
+ expiresAt?: string | null;
717
+ }
718
+ export interface CreateSessionRequest {
719
+ packageId: string;
720
+ recipientId: string;
721
+ }
677
722
  export interface CreateUserDeviceRequest {
678
723
  token: string;
679
724
  }
@@ -847,6 +892,10 @@ export interface DocumentDataRequest {
847
892
  password?: string | null;
848
893
  systemGenerated: boolean;
849
894
  }
895
+ export interface DocumentSync {
896
+ /** @format int32 */
897
+ syncedCount: number;
898
+ }
850
899
  export interface DocumentTemplate {
851
900
  /** @format date-time */
852
901
  createdAt?: string | null;
@@ -1042,6 +1091,29 @@ export interface EncompassContact {
1042
1091
  phone?: string | null;
1043
1092
  company?: string | null;
1044
1093
  }
1094
+ export interface EncompassError {
1095
+ errorCode: string;
1096
+ message: string;
1097
+ details?: string[] | null;
1098
+ }
1099
+ export interface EncompassPackageItem {
1100
+ packageId: string;
1101
+ status: string;
1102
+ /** @format date-time */
1103
+ createdAt: string;
1104
+ recipientId: string;
1105
+ }
1106
+ export interface EncompassPackageList {
1107
+ packages: EncompassPackageItem[];
1108
+ /** @format int32 */
1109
+ totalCount: number;
1110
+ /** @format int32 */
1111
+ page: number;
1112
+ /** @format int32 */
1113
+ pageSize: number;
1114
+ /** @format int32 */
1115
+ totalPages: number;
1116
+ }
1045
1117
  export interface Error {
1046
1118
  message: string;
1047
1119
  }
@@ -1615,20 +1687,10 @@ export interface LoanApplicationRequest {
1615
1687
  userID: string;
1616
1688
  /** @format uuid */
1617
1689
  siteConfigurationID: string;
1618
- /** @format uuid */
1619
- draftId?: string | null;
1620
1690
  loanOfficerEmail?: string | null;
1621
- type?: LoanType | null;
1622
1691
  purpose?: LoanPurpose | null;
1623
- lienPosition?: LoanLienPosition | null;
1624
- /** @maxLength 50 */
1625
- number?: string | null;
1626
- /** @maxLength 100 */
1627
- program?: string | null;
1628
- /** @maxLength 50 */
1629
- channel?: string | null;
1630
- /** @format date-time */
1631
- startDate?: string | null;
1692
+ referrer?: string | null;
1693
+ companyName?: string | null;
1632
1694
  property?: LoanPropertyRequest | null;
1633
1695
  financial?: LoanFinancialRequest | null;
1634
1696
  /** @minItems 1 */
@@ -1636,8 +1698,6 @@ export interface LoanApplicationRequest {
1636
1698
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
1637
1699
  /** @format uuid */
1638
1700
  existingLoanId?: string | null;
1639
- /** @format uuid */
1640
- formId?: string | null;
1641
1701
  }
1642
1702
  export interface LoanBorrower {
1643
1703
  /** @format uuid */
@@ -1689,10 +1749,6 @@ export interface LoanBorrowerAccountAsset {
1689
1749
  type?: LoanAccountAssetType | null;
1690
1750
  }
1691
1751
  export interface LoanBorrowerAccountAssetRequest {
1692
- /** @maxLength 255 */
1693
- name?: string | null;
1694
- /** @maxLength 50 */
1695
- accountNumber?: string | null;
1696
1752
  /** @maxLength 255 */
1697
1753
  financialInstitution?: string | null;
1698
1754
  /**
@@ -1760,6 +1816,12 @@ export interface LoanBorrowerAlternateNameRequest {
1760
1816
  /** @maxLength 100 */
1761
1817
  middleName?: string | null;
1762
1818
  }
1819
+ export interface LoanBorrowerBankruptcyChaptersRequest {
1820
+ chapter7?: boolean | null;
1821
+ chapter11?: boolean | null;
1822
+ chapter12?: boolean | null;
1823
+ chapter13?: boolean | null;
1824
+ }
1763
1825
  export interface LoanBorrowerBankruptcyDeclaration {
1764
1826
  /** @format uuid */
1765
1827
  id?: string | null;
@@ -1771,6 +1833,7 @@ export interface LoanBorrowerBankruptcyDeclarationRequest {
1771
1833
  isAffirmative?: boolean | null;
1772
1834
  /** @maxLength 1000 */
1773
1835
  description?: string | null;
1836
+ chapters?: LoanBorrowerBankruptcyChaptersRequest | null;
1774
1837
  types?: LoanBankruptcyType[] | null;
1775
1838
  }
1776
1839
  export interface LoanBorrowerConsent {
@@ -1778,7 +1841,7 @@ export interface LoanBorrowerConsent {
1778
1841
  id?: string | null;
1779
1842
  type?: ConsentType | null;
1780
1843
  providedConsent?: boolean | null;
1781
- ipAddress?: IPAddress | null;
1844
+ ipAddress?: string | null;
1782
1845
  }
1783
1846
  export interface LoanBorrowerConsentRequest {
1784
1847
  type?: ConsentType | null;
@@ -1835,10 +1898,14 @@ export interface LoanBorrowerDemographicsEthnicity {
1835
1898
  hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
1836
1899
  }
1837
1900
  export interface LoanBorrowerDemographicsEthnicityRequest {
1838
- isDeclined?: boolean | null;
1839
- isHispanicOrLatino?: boolean | null;
1901
+ OptOut?: boolean | null;
1902
+ Hispanic?: boolean | null;
1840
1903
  /** @maxLength 255 */
1841
- otherHispanicOrLatino?: string | null;
1904
+ OtherHispanic?: string | null;
1905
+ Mexican?: boolean | null;
1906
+ PuertoRican?: boolean | null;
1907
+ Cuban?: boolean | null;
1908
+ NotHispanic?: boolean | null;
1842
1909
  hispanicOrLatinoEthnicities?: LoanHispanicEthnicity[] | null;
1843
1910
  }
1844
1911
  export interface LoanBorrowerDemographicsGender {
@@ -1848,7 +1915,9 @@ export interface LoanBorrowerDemographicsGender {
1848
1915
  gender?: LoanGenderType | null;
1849
1916
  }
1850
1917
  export interface LoanBorrowerDemographicsGenderRequest {
1851
- isDeclined?: boolean | null;
1918
+ Male?: boolean | null;
1919
+ Female?: boolean | null;
1920
+ OptOut?: boolean | null;
1852
1921
  gender?: LoanGenderType | null;
1853
1922
  }
1854
1923
  export interface LoanBorrowerDemographicsRace {
@@ -1867,20 +1936,29 @@ export interface LoanBorrowerDemographicsRace {
1867
1936
  isDeclined?: boolean | null;
1868
1937
  }
1869
1938
  export interface LoanBorrowerDemographicsRaceRequest {
1870
- isAmericanIndianOrAlaskanNative?: boolean | null;
1939
+ AmericanIndian?: boolean | null;
1871
1940
  /** @maxLength 255 */
1872
- otherAmericanIndianOrAlaskanNative?: string | null;
1873
- isAsian?: boolean | null;
1874
- asianRaces?: LoanAsianRace[] | null;
1941
+ TribeName?: string | null;
1942
+ Asian?: boolean | null;
1943
+ AsianIndian?: boolean | null;
1944
+ Chinese?: boolean | null;
1945
+ Filipino?: boolean | null;
1946
+ Japanese?: boolean | null;
1947
+ Korean?: boolean | null;
1948
+ Vietnamese?: boolean | null;
1875
1949
  /** @maxLength 255 */
1876
- otherAsianRace?: string | null;
1877
- isBlackOrAfrican?: boolean | null;
1878
- isPacificIslander?: boolean | null;
1879
- pacificIslanderRace?: LoanPacificIslanderRace[] | null;
1950
+ OtherAsian?: string | null;
1951
+ Black?: boolean | null;
1952
+ NativeIslander?: boolean | null;
1953
+ NativeHawaiian?: boolean | null;
1954
+ Guamanian?: boolean | null;
1955
+ Samoan?: boolean | null;
1880
1956
  /** @maxLength 255 */
1881
- otherPacificIslanderRace?: string | null;
1882
- isWhite?: boolean | null;
1883
- isDeclined?: boolean | null;
1957
+ OtherNativeIslander?: string | null;
1958
+ White?: boolean | null;
1959
+ OptOut?: boolean | null;
1960
+ asianRaces?: LoanAsianRace[] | null;
1961
+ pacificIslanderRace?: LoanPacificIslanderRace[] | null;
1884
1962
  }
1885
1963
  export interface LoanBorrowerDemographicsRequest {
1886
1964
  race?: LoanBorrowerDemographicsRaceRequest | null;
@@ -1924,6 +2002,12 @@ export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
1924
2002
  * @min 0
1925
2003
  */
1926
2004
  base?: number | null;
2005
+ /** @format double */
2006
+ hourlyRate?: number | null;
2007
+ /** @format int32 */
2008
+ hoursPerWeek?: number | null;
2009
+ /** @format double */
2010
+ distributions?: number | null;
1927
2011
  /**
1928
2012
  * @format double
1929
2013
  * @min 0
@@ -2225,7 +2309,7 @@ export interface LoanBorrowerPrimaryResidenceDeclarationRequest {
2225
2309
  description?: string | null;
2226
2310
  hasInterestInLastThreeYears?: boolean | null;
2227
2311
  titleHeld?: LoanTitleHeld | null;
2228
- propertyType?: LoanOccupancyType | null;
2312
+ propertyType?: LoanOwnershipInterestPropertyType | null;
2229
2313
  }
2230
2314
  export interface LoanBorrowerRealEstateAsset {
2231
2315
  /** @format uuid */
@@ -2286,16 +2370,22 @@ export interface LoanBorrowerRealEstateAssetRequest {
2286
2370
  * @min 0
2287
2371
  */
2288
2372
  marketValue?: number | null;
2373
+ /** @format double */
2374
+ purchasePrice?: number | null;
2375
+ /** @format int32 */
2376
+ yearBuilt?: number | null;
2377
+ /** @format int32 */
2378
+ numberOfUnits?: number | null;
2289
2379
  /**
2290
2380
  * @format double
2291
2381
  * @min 0
2292
2382
  */
2293
- monthlyInsTaxDues?: number | null;
2383
+ monthlyRentalIncome?: number | null;
2294
2384
  /**
2295
2385
  * @format double
2296
2386
  * @min 0
2297
2387
  */
2298
- monthlyRentalIncome?: number | null;
2388
+ maintenanceExpense?: number | null;
2299
2389
  address?: AddressRequest | null;
2300
2390
  mortgages?: LoanBorrowerRealEstateAssetMortgageRequest[] | null;
2301
2391
  }
@@ -2576,6 +2666,11 @@ export interface LoanFinancialRequest {
2576
2666
  * @min 0
2577
2667
  */
2578
2668
  maximumPurchasePrice?: number | null;
2669
+ isDownPaymentGift?: boolean | null;
2670
+ /** @format double */
2671
+ downPaymentGiftAmount?: number | null;
2672
+ /** @format int32 */
2673
+ loanTermYears?: number | null;
2579
2674
  }
2580
2675
  export interface LoanIdentifier {
2581
2676
  /** @format uuid */
@@ -2642,6 +2737,39 @@ export interface LoanListPaginated {
2642
2737
  /** @format int64 */
2643
2738
  count: number;
2644
2739
  }
2740
+ export interface LoanListV3 {
2741
+ /** @format uuid */
2742
+ id: string;
2743
+ status?: string | null;
2744
+ number?: string | null;
2745
+ type?: LoanType | null;
2746
+ purpose?: LoanPurpose | null;
2747
+ /** @format double */
2748
+ totalLoanAmount?: number | null;
2749
+ /** @format date-time */
2750
+ startDate?: string | null;
2751
+ isActive: boolean;
2752
+ propertyAddress?: Address | null;
2753
+ loanOfficer?: LoanListV3LoanOfficer | null;
2754
+ borrowers: LoanListV3Borrower[];
2755
+ }
2756
+ export interface LoanListV3Borrower {
2757
+ /** @format uuid */
2758
+ id: string;
2759
+ firstName?: string | null;
2760
+ lastName?: string | null;
2761
+ email?: string | null;
2762
+ isPrimaryBorrower: boolean;
2763
+ }
2764
+ export interface LoanListV3LoanOfficer {
2765
+ name?: string | null;
2766
+ }
2767
+ export interface LoanListV3Paginated {
2768
+ rows: LoanListV3[];
2769
+ pagination: Pagination;
2770
+ /** @format int64 */
2771
+ count: number;
2772
+ }
2645
2773
  export interface LoanLog {
2646
2774
  /** @format uuid */
2647
2775
  id: string;
@@ -2789,13 +2917,13 @@ export interface LoanPropertyRequest {
2789
2917
  /**
2790
2918
  * @format int32
2791
2919
  * @min 1800
2792
- * @max 2035
2920
+ * @max 2036
2793
2921
  */
2794
2922
  yearBuilt?: number | null;
2795
2923
  /**
2796
2924
  * @format int32
2797
2925
  * @min 1900
2798
- * @max 2035
2926
+ * @max 2036
2799
2927
  */
2800
2928
  yearAcquired?: number | null;
2801
2929
  /** @format int32 */
@@ -2898,6 +3026,17 @@ export interface LoanSearchCriteria {
2898
3026
  /** @format uuid */
2899
3027
  siteConfigurationId?: string | null;
2900
3028
  }
3029
+ export interface LoanSearchV3Criteria {
3030
+ searchText?: string | null;
3031
+ /** @format uuid */
3032
+ loanOfficerId?: string | null;
3033
+ loanNumber?: string | null;
3034
+ isClosed?: boolean | null;
3035
+ purpose?: LoanPurpose | null;
3036
+ type?: LoanType | null;
3037
+ /** @format uuid */
3038
+ siteConfigurationId?: string | null;
3039
+ }
2901
3040
  export interface LoanSettings {
2902
3041
  excludeFromAutoTaskReminders: boolean;
2903
3042
  }
@@ -3061,6 +3200,10 @@ export interface MonthlyPaymentCalculatorRequest {
3061
3200
  */
3062
3201
  term: number;
3063
3202
  }
3203
+ export interface NoContentResult {
3204
+ /** @format int32 */
3205
+ statusCode: number;
3206
+ }
3064
3207
  export interface NotificationTemplate {
3065
3208
  /** @format date-time */
3066
3209
  createdAt?: string | null;
@@ -3515,7 +3658,7 @@ export interface SSOTokenRequest {
3515
3658
  redirectUri: string;
3516
3659
  }
3517
3660
  export interface SamlMetadataRequest {
3518
- ssoIntegration: "ConsumerConnect" | "TheBigPOS";
3661
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
3519
3662
  }
3520
3663
  export interface SendForgotPasswordRequest {
3521
3664
  /**
@@ -3732,7 +3875,7 @@ export interface SiteConfiguration {
3732
3875
  asoSettings?: ASOSettings | null;
3733
3876
  accountSettings: AccountSettings;
3734
3877
  autoTaskReminderIntervalsInDays?: number[] | null;
3735
- mobileSettings: MobileSettings;
3878
+ mobileSettings?: MobileSettings | null;
3736
3879
  losSettings?: LOSSettings | null;
3737
3880
  }
3738
3881
  export interface SiteConfigurationByUrl {
@@ -3926,7 +4069,7 @@ export interface SiteConfigurationByUrl {
3926
4069
  asoSettings?: ASOSettings | null;
3927
4070
  accountSettings: AccountSettings;
3928
4071
  autoTaskReminderIntervalsInDays?: number[] | null;
3929
- mobileSettings: MobileSettings;
4072
+ mobileSettings?: MobileSettings | null;
3930
4073
  losSettings?: LOSSettings | null;
3931
4074
  workflows: Workflow[];
3932
4075
  }
@@ -4844,7 +4987,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
4844
4987
  }
4845
4988
  /**
4846
4989
  * @title The Big POS API
4847
- * @version v2.29.1
4990
+ * @version v2.31.0
4848
4991
  * @termsOfService https://www.thebigpos.com/terms-of-use/
4849
4992
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
4850
4993
  */
@@ -4969,31 +5112,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4969
5112
  /** @default false */
4970
5113
  hardDelete?: boolean;
4971
5114
  }, params?: RequestParams) => Promise<AxiosResponse<Account, any>>;
4972
- /**
4973
- * No description
4974
- *
4975
- * @tags Accounts
4976
- * @name UpdateLoansByAccount
4977
- * @summary Update Loans
4978
- * @request PUT:/api/accounts/{id}/loan
4979
- * @secure
4980
- * @response `200` `void` Success
4981
- * @response `404` `ProblemDetails` Not Found
4982
- * @response `422` `UnprocessableEntity` Client Error
4983
- */
4984
- updateLoansByAccount: (id: string, data: Loan[], params?: RequestParams) => Promise<AxiosResponse<void, any>>;
4985
- /**
4986
- * No description
4987
- *
4988
- * @tags Accounts
4989
- * @name GetLoansByAccount
4990
- * @summary Get Loans
4991
- * @request GET:/api/accounts/{id}/loan
4992
- * @secure
4993
- * @response `200` `(Loan)[]` Success
4994
- * @response `404` `ProblemDetails` Not Found
4995
- */
4996
- getLoansByAccount: (id: string, params?: RequestParams) => Promise<AxiosResponse<Loan[], any>>;
4997
5115
  /**
4998
5116
  * No description
4999
5117
  *
@@ -5003,6 +5121,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5003
5121
  * @request POST:/api/refresh-token
5004
5122
  * @secure
5005
5123
  * @response `200` `Token` Success
5124
+ * @response `401` `ProblemDetails` Unauthorized
5006
5125
  * @response `422` `UnprocessableEntity` Client Error
5007
5126
  */
5008
5127
  getTokenFromRefreshToken: (data: RefreshTokenRequest, params?: RequestParams) => Promise<AxiosResponse<Token, any>>;
@@ -5062,10 +5181,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5062
5181
  * @summary Sign out (clear auth cookies)
5063
5182
  * @request POST:/api/logout
5064
5183
  * @secure
5065
- * @response `204` `void` No Content
5184
+ * @response `204` `NoContentResult` No Content
5066
5185
  * @response `422` `UnprocessableEntity` Client Error
5067
5186
  */
5068
- logOut: (params?: RequestParams) => Promise<AxiosResponse<void, any>>;
5187
+ logOut: (params?: RequestParams) => Promise<AxiosResponse<NoContentResult, any>>;
5069
5188
  /**
5070
5189
  * No description
5071
5190
  *
@@ -5279,6 +5398,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5279
5398
  * @response `200` `BusinessRule` Success
5280
5399
  */
5281
5400
  restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any>>;
5401
+ /**
5402
+ * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
5403
+ *
5404
+ * @tags ClosedLoanReports
5405
+ * @name GetClosedLoansReport
5406
+ * @summary Get Closed Loans Report
5407
+ * @request POST:/api/loans/reports/closed-loans
5408
+ * @secure
5409
+ * @response `200` `ClosedLoansReport` Success
5410
+ */
5411
+ getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any>>;
5282
5412
  /**
5283
5413
  * No description
5284
5414
  *
@@ -5659,6 +5789,47 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5659
5789
  * @response `200` `DocumentTemplateVersion` Success
5660
5790
  */
5661
5791
  deleteDocumentTemplateVersion: (documentId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<DocumentTemplateVersion, any>>;
5792
+ /**
5793
+ * No description
5794
+ *
5795
+ * @tags Encompass Packages
5796
+ * @name GetUserPackages
5797
+ * @request GET:/api/los/encompass/eclose/packages
5798
+ * @secure
5799
+ * @response `200` `EncompassPackageList` Success
5800
+ * @response `400` `EncompassError` Bad Request
5801
+ * @response `401` `EncompassError` Unauthorized
5802
+ * @response `500` `EncompassError` Server Error
5803
+ */
5804
+ getUserPackages: (query?: {
5805
+ /** @default "all" */
5806
+ status?: string;
5807
+ /**
5808
+ * @format int32
5809
+ * @default 1
5810
+ */
5811
+ page?: number;
5812
+ /**
5813
+ * @format int32
5814
+ * @default 20
5815
+ */
5816
+ pageSize?: number;
5817
+ }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any>>;
5818
+ /**
5819
+ * No description
5820
+ *
5821
+ * @tags Encompass Sessions
5822
+ * @name CreateEncompassSession
5823
+ * @request POST:/api/los/encompass/eclose/sessions
5824
+ * @secure
5825
+ * @response `200` `CreateSession` Success
5826
+ * @response `400` `EncompassError` Bad Request
5827
+ * @response `401` `EncompassError` Unauthorized
5828
+ * @response `403` `EncompassError` Forbidden
5829
+ * @response `404` `EncompassError` Not Found
5830
+ * @response `500` `EncompassError` Server Error
5831
+ */
5832
+ createEncompassSession: (data: CreateSessionRequest, params?: RequestParams) => Promise<AxiosResponse<CreateSession, any>>;
5662
5833
  /**
5663
5834
  * No description
5664
5835
  *
@@ -6584,6 +6755,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6584
6755
  * @response `404` `ProblemDetails` Not Found
6585
6756
  */
6586
6757
  sendLoanDocuments: (loanId: string, data: SendLoanDocumentsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
6758
+ /**
6759
+ * @description Fetches all documents from Encompass that don't exist locally and stores them in S3
6760
+ *
6761
+ * @tags LoanDocuments
6762
+ * @name SyncLoanDocumentsFromEncompass
6763
+ * @summary Sync documents from Encompass
6764
+ * @request POST:/api/loans/{loanId}/documents/sync
6765
+ * @secure
6766
+ * @response `200` `DocumentSync` Success
6767
+ * @response `404` `ProblemDetails` Not Found
6768
+ */
6769
+ syncLoanDocumentsFromEncompass: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<DocumentSync, any>>;
6770
+ /**
6771
+ * @description Re-attempts to push a failed document to Encompass
6772
+ *
6773
+ * @tags LoanDocuments
6774
+ * @name RetrySyncLoanDocumentToEncompass
6775
+ * @summary Retry syncing a document to Encompass
6776
+ * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
6777
+ * @secure
6778
+ * @response `200` `void` Success
6779
+ * @response `404` `ProblemDetails` Not Found
6780
+ * @response `423` `ProblemDetails` Client Error
6781
+ */
6782
+ retrySyncLoanDocumentToEncompass: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
6587
6783
  /**
6588
6784
  * No description
6589
6785
  *
@@ -6955,24 +7151,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6955
7151
  * @response `200` `GetApplications` Success
6956
7152
  */
6957
7153
  getLoans: (params?: RequestParams) => Promise<AxiosResponse<GetApplications, any>>;
6958
- /**
6959
- * No description
6960
- *
6961
- * @tags Loans
6962
- * @name GetLoansByAccountSetting
6963
- * @summary Get Loans by Account Setting
6964
- * @request POST:/api/loans/temp-pipeline
6965
- * @secure
6966
- * @response `200` `any` Success
6967
- */
6968
- getLoansByAccountSetting: (data: LoanSearchCriteria, query?: {
6969
- /** @format int32 */
6970
- pageSize?: number;
6971
- /** @format int32 */
6972
- pageNumber?: number;
6973
- sortBy?: string;
6974
- sortDirection?: string;
6975
- }, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
6976
7154
  /**
6977
7155
  * No description
6978
7156
  *
@@ -7026,20 +7204,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7026
7204
  */
7027
7205
  updateLoan: (loanId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
7028
7206
  /**
7029
- * @description Creates a new loan or adds borrowers to an existing loan based on the presence of LoanID
7207
+ * @description Retrieves a loan by its unique identifier
7030
7208
  *
7031
7209
  * @tags Loans V3
7032
- * @name SubmitLoanApplication
7033
- * @summary Submit Loan Application
7034
- * @request POST:/api/v3/loans/applications
7210
+ * @name GetLoanById
7211
+ * @summary Get Loan by ID
7212
+ * @request GET:/api/v3/loans/{id}
7035
7213
  * @secure
7036
- * @response `201` `LoanApplication` Created
7037
- * @response `400` `any` Bad Request
7214
+ * @response `200` `LoanApplication` Success
7038
7215
  * @response `401` `ProblemDetails` Unauthorized
7039
7216
  * @response `403` `ProblemDetails` Forbidden
7040
7217
  * @response `404` `ProblemDetails` Not Found
7041
7218
  */
7042
- submitLoanApplication: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
7219
+ getLoanById: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
7043
7220
  /**
7044
7221
  * @description Partially update a loan using GUID-based patch operations. Supports GUID lookups in collections, eliminating index ordering issues.
7045
7222
  *
@@ -7056,6 +7233,40 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7056
7233
  * @response `409` `any` Conflict
7057
7234
  */
7058
7235
  patchLoan: (id: string, data: any, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
7236
+ /**
7237
+ * @description Creates a new loan or adds borrowers to an existing loan based on the presence of LoanID
7238
+ *
7239
+ * @tags Loans V3
7240
+ * @name SubmitLoanApplication
7241
+ * @summary Submit Loan Application
7242
+ * @request POST:/api/v3/loans/applications
7243
+ * @secure
7244
+ * @response `201` `LoanApplication` Created
7245
+ * @response `400` `any` Bad Request
7246
+ * @response `401` `ProblemDetails` Unauthorized
7247
+ * @response `403` `ProblemDetails` Forbidden
7248
+ * @response `404` `ProblemDetails` Not Found
7249
+ */
7250
+ submitLoanApplication: (data: LoanApplicationRequest, params?: RequestParams) => Promise<AxiosResponse<LoanApplication, any>>;
7251
+ /**
7252
+ * @description Returns a paginated list of loans based on search criteria
7253
+ *
7254
+ * @tags Loans V3
7255
+ * @name SearchLoansV3
7256
+ * @summary Search Loans
7257
+ * @request POST:/api/v3/loans/search
7258
+ * @secure
7259
+ * @response `200` `LoanListV3Paginated` Success
7260
+ * @response `401` `ProblemDetails` Unauthorized
7261
+ */
7262
+ searchLoansV3: (data: LoanSearchV3Criteria, query?: {
7263
+ /** @format int32 */
7264
+ pageSize?: number;
7265
+ /** @format int32 */
7266
+ pageNumber?: number;
7267
+ sortBy?: string;
7268
+ sortDirection?: string;
7269
+ }, params?: RequestParams) => Promise<AxiosResponse<LoanListV3Paginated, any>>;
7059
7270
  /**
7060
7271
  * No description
7061
7272
  *
@@ -7765,7 +7976,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7765
7976
  * @response `200` `File` Success
7766
7977
  * @response `404` `ProblemDetails` Not Found
7767
7978
  */
7768
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
7979
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
7769
7980
  /**
7770
7981
  * No description
7771
7982
  *
@@ -7776,7 +7987,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7776
7987
  * @secure
7777
7988
  * @response `200` `File` Success
7778
7989
  */
7779
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
7990
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
7780
7991
  /**
7781
7992
  * No description
7782
7993
  *
@@ -8601,4 +8812,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8601
8812
  */
8602
8813
  getWorkflow: (data: GetWorkflowRequest, params?: RequestParams) => Promise<AxiosResponse<GetForm, any>>;
8603
8814
  };
8815
+ sso: {
8816
+ /**
8817
+ * No description
8818
+ *
8819
+ * @tags Saml
8820
+ * @name LogoutList
8821
+ * @request GET:/sso/logout
8822
+ * @secure
8823
+ * @response `200` `void` Success
8824
+ */
8825
+ logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any>>;
8826
+ };
8604
8827
  }