@matech/thebigpos-sdk 2.49.0-rc0 → 2.49.3-rc1

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
@@ -5,15 +5,20 @@ export type SiteTileLocation = "HomePage" | "Dashboard";
5
5
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6
6
  export type SigningMethod = "ConsumerConnect" | "POSF";
7
7
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
8
+ export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
9
+ export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
8
10
  export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
9
11
  export type LosOperationStatus = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
12
+ export type LosCredentialHealthStatus = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
10
13
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
11
14
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
12
15
  export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
13
16
  export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
14
17
  export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
15
18
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
16
- export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
19
+ export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
20
+ export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "InvestmentProperty" | "FHASecondaryResidence";
21
+ export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
17
22
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
18
23
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
19
24
  export type LoanPurpose = "Purchase" | "Refinance";
@@ -37,18 +42,18 @@ export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "
37
42
  export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
38
43
  export type LoanHousingType = "NoExpense" | "Own" | "Rent";
39
44
  export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
40
- export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
45
+ export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone" | "FaceToFace" | "Hybrid" | "Internet";
41
46
  export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other";
42
47
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower";
43
- export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
48
+ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
44
49
  export type LoanGenderType = "Male" | "Female";
45
- export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
50
+ export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
46
51
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
47
52
  export type LoanCitizenship = "USCitizen" | "PermanentResidentAlien" | "NonPermanentResidentAlien";
48
53
  export type LoanBankruptcyType = "Chapter7" | "Chapter11" | "Chapter12" | "Chapter13";
49
54
  export type LoanAsianRace = "AsianIndian" | "Chinese" | "Filipino" | "Japanese" | "Korean" | "Vietnamese" | "Other";
50
55
  export type LoanAmortizationType = "Fixed" | "Arm" | "Balloon" | "Other";
51
- export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other";
56
+ export type LoanAccountAssetType = "Checking" | "Savings" | "MoneyMarket" | "CertificateOfDeposit" | "MutualFund" | "Stocks" | "Bonds" | "Retirement" | "BridgeLoanProceeds" | "IndividualDevelopmentAccount" | "TrustAccount" | "CashValueOfLifeInsurance" | "Other" | "StockOptions";
52
57
  export type LoanAccessScopeType = "User" | "Branch";
53
58
  export type LinkTarget = "Self" | "Blank";
54
59
  export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently" | "Uploaded" | "PendingSync";
@@ -74,7 +79,7 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
74
79
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
75
80
  export type BorrowerApplicationStatus = "Draft" | "Complete";
76
81
  export type BillingType = "ClosedLoan" | "LoanOfficer";
77
- export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
82
+ export type AuditChangeType = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
78
83
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
79
84
  export type AiUrlSourceCategory = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
80
85
  export type AiStructuredDataType = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages";
@@ -140,31 +145,12 @@ export interface AccountBillingRequest {
140
145
  /** @format double */
141
146
  contractedRate: number;
142
147
  }
143
- export interface AccountDeactivated {
144
- accountDeactivated: boolean;
145
- email: string;
146
- }
147
148
  export interface AccountFailureCount {
148
149
  /** @format uuid */
149
150
  accountId: string;
150
151
  /** @format int32 */
151
152
  count: number;
152
153
  }
153
- export interface AccountReactivationCompleteRequest {
154
- /** @format uuid */
155
- token: string;
156
- /** @minLength 8 */
157
- newPassword: string;
158
- }
159
- export interface AccountReactivationRequest {
160
- /**
161
- * @format email
162
- * @minLength 1
163
- */
164
- email: string;
165
- /** @format uuid */
166
- siteConfigurationId: string;
167
- }
168
154
  export interface AccountSettings {
169
155
  isSmsEnabled: boolean;
170
156
  isLoanEditEnabled: boolean;
@@ -1060,6 +1046,7 @@ export interface CompanyDocument {
1060
1046
  /** @format int64 */
1061
1047
  fileSizeBytes: number;
1062
1048
  inlineContent?: string | null;
1049
+ previewImage?: string | null;
1063
1050
  indexStatus: CompanyDocumentIndexStatusEnum;
1064
1051
  indexError?: string | null;
1065
1052
  /** @format date-time */
@@ -1090,6 +1077,9 @@ export interface CompanyDocumentPaginated {
1090
1077
  /** @format int64 */
1091
1078
  count: number;
1092
1079
  }
1080
+ export interface CompanyDocumentPreviewsRequest {
1081
+ documentIds: string[];
1082
+ }
1093
1083
  export interface CompanyDocumentSearchCriteria {
1094
1084
  searchText?: string | null;
1095
1085
  /** @format uuid */
@@ -2304,6 +2294,9 @@ export interface Invite {
2304
2294
  oneTimeToken: string;
2305
2295
  /** @format date-time */
2306
2296
  createdAt: string;
2297
+ /** @format date-time */
2298
+ expiresAt?: string | null;
2299
+ status: string;
2307
2300
  invitedBy?: User | null;
2308
2301
  loan: LoanIdentifier;
2309
2302
  url: string;
@@ -2908,10 +2901,16 @@ export interface LoanBorrowerGiftRequest {
2908
2901
  isDeposited?: boolean | null;
2909
2902
  source?: LoanGiftSource | null;
2910
2903
  assetType?: LoanGiftAssetType | null;
2904
+ grantorDonorName?: string | null;
2905
+ /** @format double */
2906
+ amountAppliedToDownPayment?: number | null;
2907
+ /** @format double */
2908
+ amountAppliedToClosingCosts?: number | null;
2911
2909
  }
2912
2910
  export interface LoanBorrowerHomeOwnership {
2913
2911
  /** @format uuid */
2914
2912
  id?: string | null;
2913
+ isCompleted?: boolean | null;
2915
2914
  /** @format date */
2916
2915
  dateCompleted?: string | null;
2917
2916
  type?: LoanHomeOwnershipType | null;
@@ -2923,14 +2922,17 @@ export interface LoanBorrowerHomeOwnershipProvider {
2923
2922
  id?: string | null;
2924
2923
  name?: string | null;
2925
2924
  phoneNumber?: string | null;
2925
+ hudAgencyId?: string | null;
2926
2926
  address?: AddressV3 | null;
2927
2927
  }
2928
2928
  export interface LoanBorrowerHomeOwnershipProviderRequest {
2929
2929
  name?: string | null;
2930
2930
  phoneNumber?: string | null;
2931
+ hudAgencyId?: string | null;
2931
2932
  address?: AddressRequest | null;
2932
2933
  }
2933
2934
  export interface LoanBorrowerHomeOwnershipRequest {
2935
+ isCompleted?: boolean | null;
2934
2936
  /** @format date */
2935
2937
  dateCompleted?: string | null;
2936
2938
  type?: LoanHomeOwnershipType | null;
@@ -3063,7 +3065,9 @@ export interface LoanBorrowerRealEstateAsset {
3063
3065
  /** @format uuid */
3064
3066
  id?: string | null;
3065
3067
  status?: LoanRealEstateStatus | null;
3066
- occupancy?: LoanOccupancyType | null;
3068
+ occupancy?: LoanRealEstateOccupancyType | null;
3069
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3070
+ intendedUsageOtherDescription?: string | null;
3067
3071
  /** @format double */
3068
3072
  marketValue?: number | null;
3069
3073
  /** @format double */
@@ -3118,7 +3122,9 @@ export interface LoanBorrowerRealEstateAssetMortgageRequest {
3118
3122
  }
3119
3123
  export interface LoanBorrowerRealEstateAssetRequest {
3120
3124
  status?: LoanRealEstateStatus | null;
3121
- occupancy?: LoanOccupancyType | null;
3125
+ occupancy?: LoanRealEstateOccupancyType | null;
3126
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3127
+ intendedUsageOtherDescription?: string | null;
3122
3128
  /** @format double */
3123
3129
  marketValue?: number | null;
3124
3130
  /** @format double */
@@ -3905,6 +3911,14 @@ export interface LoanUser {
3905
3911
  /** @format date-time */
3906
3912
  createdAt: string;
3907
3913
  }
3914
+ export interface LosCredentialHealth {
3915
+ /** @format uuid */
3916
+ accountId: string;
3917
+ status: LosCredentialHealthStatusEnum;
3918
+ /** @format date-time */
3919
+ checkedAtUtc: string;
3920
+ message: string;
3921
+ }
3908
3922
  export interface LosCredentials {
3909
3923
  /** @format uuid */
3910
3924
  id: string;
@@ -3912,6 +3926,71 @@ export interface LosCredentials {
3912
3926
  accountID: string;
3913
3927
  instanceID: string;
3914
3928
  }
3929
+ export interface LosIntegration {
3930
+ /** @format uuid */
3931
+ accountId: string;
3932
+ accountName?: string | null;
3933
+ instanceID: string;
3934
+ encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
3935
+ signingMethod: LosIntegrationSigningMethodEnum;
3936
+ consumerConnectWidgetHost?: string | null;
3937
+ defaultLoanOfficerUserName?: string | null;
3938
+ loanTemplate?: string | null;
3939
+ loanAssignmentRole?: string | null;
3940
+ clearStateIfUnlicensed: boolean;
3941
+ subscriptionId?: string | null;
3942
+ environment?: string | null;
3943
+ hasSigningKey: boolean;
3944
+ health?: LosCredentialHealth | null;
3945
+ webhooks?: LosWebhookInventory | null;
3946
+ }
3947
+ export interface LosIntegrationCredentials {
3948
+ /** @format uuid */
3949
+ id: string;
3950
+ /** @format uuid */
3951
+ accountID: string;
3952
+ instanceID: string;
3953
+ encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
3954
+ signingMethod: LosIntegrationCredentialsSigningMethodEnum;
3955
+ consumerConnectWidgetHost?: string | null;
3956
+ defaultLoanOfficerUserName?: string | null;
3957
+ loanTemplate?: string | null;
3958
+ loanAssignmentRole?: string | null;
3959
+ clearStateIfUnlicensed: boolean;
3960
+ subscriptionId?: string | null;
3961
+ environment?: string | null;
3962
+ clientID?: string | null;
3963
+ clientSecret?: string | null;
3964
+ signingKeyId?: string | null;
3965
+ signingKey?: string | null;
3966
+ secretsDecrypted: boolean;
3967
+ }
3968
+ export interface LosIntegrationPaginated {
3969
+ rows: LosIntegration[];
3970
+ pagination: Pagination;
3971
+ /** @format int64 */
3972
+ count: number;
3973
+ }
3974
+ export interface LosIntegrationsBatchRequest {
3975
+ accountIds: string[];
3976
+ }
3977
+ export interface LosIntegrationsSearchCriteria {
3978
+ searchText?: string | null;
3979
+ }
3980
+ export interface LosIntegrationsSummary {
3981
+ /** @format int32 */
3982
+ totalIntegrations: number;
3983
+ /** @format int32 */
3984
+ healthyCount: number;
3985
+ /** @format int32 */
3986
+ failingCount: number;
3987
+ /** @format int32 */
3988
+ unknownCount: number;
3989
+ /** @format int32 */
3990
+ accountsMissingExpectedWebhook: number;
3991
+ /** @format int32 */
3992
+ webhookUnknownCount: number;
3993
+ }
3915
3994
  export interface LosLoanCreationRequest {
3916
3995
  loanOfficerUserName?: string | null;
3917
3996
  loanTemplate?: string | null;
@@ -4033,6 +4112,27 @@ export interface LosWebhook {
4033
4112
  events: string[];
4034
4113
  enableSubscription: boolean;
4035
4114
  }
4115
+ export interface LosWebhookEntry {
4116
+ path: string;
4117
+ endpoint: string;
4118
+ resource: string;
4119
+ events: string[];
4120
+ /** @format uuid */
4121
+ subscriptionId?: string | null;
4122
+ enableSubscription?: boolean | null;
4123
+ status: LosWebhookEntryStatusEnum;
4124
+ }
4125
+ export interface LosWebhookInventory {
4126
+ /** @format uuid */
4127
+ accountId: string;
4128
+ overallStatus: LosWebhookInventoryOverallStatusEnum;
4129
+ entries: LosWebhookEntry[];
4130
+ /** @format int32 */
4131
+ missingCount: number;
4132
+ /** @format date-time */
4133
+ checkedAtUtc: string;
4134
+ message: string;
4135
+ }
4036
4136
  export interface ManualDocumentClassificationRequest {
4037
4137
  documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4038
4138
  }
@@ -5887,6 +5987,10 @@ export interface UserBase {
5887
5987
  lastName: string;
5888
5988
  email: string;
5889
5989
  }
5990
+ export interface UserDeactivated {
5991
+ accountDeactivated: boolean;
5992
+ email: string;
5993
+ }
5890
5994
  export interface UserDevice {
5891
5995
  /** @format uuid */
5892
5996
  id: string;
@@ -6057,6 +6161,21 @@ export interface UserPublic {
6057
6161
  phone?: string | null;
6058
6162
  title?: string | null;
6059
6163
  }
6164
+ export interface UserReactivationCompleteRequest {
6165
+ /** @format uuid */
6166
+ token: string;
6167
+ /** @minLength 8 */
6168
+ newPassword: string;
6169
+ }
6170
+ export interface UserReactivationRequest {
6171
+ /**
6172
+ * @format email
6173
+ * @minLength 1
6174
+ */
6175
+ email: string;
6176
+ /** @format uuid */
6177
+ siteConfigurationId: string;
6178
+ }
6060
6179
  export interface UserRelation {
6061
6180
  /** @format uuid */
6062
6181
  userId1: string;
@@ -6147,7 +6266,7 @@ export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "Docum
6147
6266
  export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
6148
6267
  export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
6149
6268
  export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
6150
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
6269
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
6151
6270
  export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6152
6271
  export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6153
6272
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
@@ -6201,9 +6320,16 @@ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
6201
6320
  export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed";
6202
6321
  export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
6203
6322
  export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
6323
+ export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
6324
+ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
6325
+ export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
6326
+ export type LosIntegrationCredentialsEncompassEnvironmentEnum = "Production" | "UAT";
6327
+ export type LosIntegrationCredentialsSigningMethodEnum = "ConsumerConnect" | "POSF";
6204
6328
  export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
6205
6329
  export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6206
- export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy";
6330
+ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" | "Extra";
6331
+ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
6332
+ export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
6207
6333
  export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6208
6334
  export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
6209
6335
  export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -6270,7 +6396,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
6270
6396
  }
6271
6397
  /**
6272
6398
  * @title The Big POS API
6273
- * @version v2.49.0
6399
+ * @version v2.49.3
6274
6400
  * @termsOfService https://www.thebigpos.com/terms-of-use/
6275
6401
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
6276
6402
  */
@@ -6344,29 +6470,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6344
6470
  * @response `422` `UnprocessableEntity` Unprocessable Content
6345
6471
  */
6346
6472
  updateSiteConfigurationForAccount: (data: SiteConfiguration, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
6347
- /**
6348
- * No description
6349
- *
6350
- * @tags AccountReactivation
6351
- * @name RequestAccountReactivation
6352
- * @summary Request account reactivation
6353
- * @request POST:/api/account/reactivation/request
6354
- * @secure
6355
- * @response `204` `void` No Content
6356
- */
6357
- requestAccountReactivation: (data: AccountReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6358
- /**
6359
- * No description
6360
- *
6361
- * @tags AccountReactivation
6362
- * @name CompleteAccountReactivation
6363
- * @summary Complete account reactivation with new password
6364
- * @request POST:/api/account/reactivation/complete
6365
- * @secure
6366
- * @response `204` `void` No Content
6367
- * @response `400` `ProblemDetails` Bad Request
6368
- */
6369
- completeAccountReactivation: (data: AccountReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
6370
6473
  /**
6371
6474
  * No description
6372
6475
  *
@@ -7359,10 +7462,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7359
7462
  * @summary Get Token
7360
7463
  * @request POST:/api/token
7361
7464
  * @secure
7362
- * @response `200` `AccountDeactivated` OK
7465
+ * @response `200` `UserDeactivated` OK
7363
7466
  * @response `422` `UnprocessableEntity` Unprocessable Content
7364
7467
  */
7365
- getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
7468
+ getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
7366
7469
  /**
7367
7470
  * No description
7368
7471
  *
@@ -7371,10 +7474,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7371
7474
  * @summary Get Token From Challenge Code
7372
7475
  * @request POST:/api/token/code
7373
7476
  * @secure
7374
- * @response `200` `AccountDeactivated` OK
7477
+ * @response `200` `UserDeactivated` OK
7375
7478
  * @response `422` `UnprocessableEntity` Unprocessable Content
7376
7479
  */
7377
- getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<AccountDeactivated, any, {}>>;
7480
+ getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<UserDeactivated, any, {}>>;
7378
7481
  /**
7379
7482
  * No description
7380
7483
  *
@@ -7729,7 +7832,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7729
7832
  * @response `200` `CompanyDocument` OK
7730
7833
  * @response `404` `ProblemDetails` Not Found
7731
7834
  */
7732
- getCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7835
+ getCompanyDocument: (id: string, query?: {
7836
+ /** @default false */
7837
+ preview?: boolean;
7838
+ }, params?: RequestParams) => Promise<AxiosResponse<CompanyDocument, any, {}>>;
7733
7839
  /**
7734
7840
  * No description
7735
7841
  *
@@ -7756,6 +7862,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7756
7862
  * @response `404` `ProblemDetails` Not Found
7757
7863
  */
7758
7864
  deleteCompanyDocument: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
7865
+ /**
7866
+ * No description
7867
+ *
7868
+ * @tags CompanyDocuments
7869
+ * @name GetCompanyDocumentPreviews
7870
+ * @summary Get company document previews in batch
7871
+ * @request POST:/api/company-documents/previews
7872
+ * @secure
7873
+ * @response `200` `Record<string,string>` OK
7874
+ * @response `400` `ProblemDetails` Bad Request
7875
+ */
7876
+ getCompanyDocumentPreviews: (data: CompanyDocumentPreviewsRequest, params?: RequestParams) => Promise<AxiosResponse<Record<string, string>, any, {}>>;
7759
7877
  /**
7760
7878
  * No description
7761
7879
  *
@@ -8471,6 +8589,155 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8471
8589
  * @response `500` `EncompassError` Internal Server Error
8472
8590
  */
8473
8591
  createEncompassSession: (data: CreateSessionRequest, params?: RequestParams) => Promise<AxiosResponse<CreateSession, any, {}>>;
8592
+ /**
8593
+ * No description
8594
+ *
8595
+ * @tags EncompassIntegrations
8596
+ * @name SearchEncompassIntegrations
8597
+ * @summary Search registered Encompass integrations across accounts (SuperAdmin)
8598
+ * @request POST:/api/monitoring/encompass-integrations/search
8599
+ * @secure
8600
+ * @response `200` `LosIntegrationPaginated` OK
8601
+ * @response `400` `ProblemDetails` Bad Request
8602
+ * @response `401` `ProblemDetails` Unauthorized
8603
+ * @response `403` `ProblemDetails` Forbidden
8604
+ */
8605
+ searchEncompassIntegrations: (data: LosIntegrationsSearchCriteria, query?: {
8606
+ /** @format int32 */
8607
+ pageSize?: number;
8608
+ /** @format int32 */
8609
+ pageNumber?: number;
8610
+ sortBy?: string;
8611
+ sortDirection?: string;
8612
+ /** @format uuid */
8613
+ accountId?: string;
8614
+ }, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationPaginated, any, {}>>;
8615
+ /**
8616
+ * No description
8617
+ *
8618
+ * @tags EncompassIntegrations
8619
+ * @name GetEncompassIntegrationsSummary
8620
+ * @summary Summarize registered Encompass integration health across accounts (SuperAdmin)
8621
+ * @request POST:/api/monitoring/encompass-integrations/summary
8622
+ * @secure
8623
+ * @response `200` `LosIntegrationsSummary` OK
8624
+ * @response `401` `ProblemDetails` Unauthorized
8625
+ * @response `403` `ProblemDetails` Forbidden
8626
+ */
8627
+ getEncompassIntegrationsSummary: (data: LosIntegrationsSearchCriteria, query?: {
8628
+ /** @format uuid */
8629
+ accountId?: string;
8630
+ }, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationsSummary, any, {}>>;
8631
+ /**
8632
+ * No description
8633
+ *
8634
+ * @tags EncompassIntegrations
8635
+ * @name GetEncompassIntegrationsHealth
8636
+ * @summary Get Encompass login health for a set of accounts (SuperAdmin)
8637
+ * @request POST:/api/monitoring/encompass-integrations/health
8638
+ * @secure
8639
+ * @response `200` `(LosCredentialHealth)[]` OK
8640
+ * @response `400` `ProblemDetails` Bad Request
8641
+ * @response `401` `ProblemDetails` Unauthorized
8642
+ * @response `403` `ProblemDetails` Forbidden
8643
+ */
8644
+ getEncompassIntegrationsHealth: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth[], any, {}>>;
8645
+ /**
8646
+ * No description
8647
+ *
8648
+ * @tags EncompassIntegrations
8649
+ * @name RecheckEncompassIntegrationHealth
8650
+ * @summary Force a fresh Encompass login health check for one account (SuperAdmin)
8651
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/health/recheck
8652
+ * @secure
8653
+ * @response `200` `LosCredentialHealth` OK
8654
+ * @response `401` `ProblemDetails` Unauthorized
8655
+ * @response `403` `ProblemDetails` Forbidden
8656
+ */
8657
+ recheckEncompassIntegrationHealth: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosCredentialHealth, any, {}>>;
8658
+ /**
8659
+ * No description
8660
+ *
8661
+ * @tags EncompassIntegrations
8662
+ * @name GetEncompassIntegrationsWebhooks
8663
+ * @summary Get registered-versus-expected Encompass webhooks for a set of accounts (SuperAdmin)
8664
+ * @request POST:/api/monitoring/encompass-integrations/webhooks
8665
+ * @secure
8666
+ * @response `200` `(LosWebhookInventory)[]` OK
8667
+ * @response `400` `ProblemDetails` Bad Request
8668
+ * @response `401` `ProblemDetails` Unauthorized
8669
+ * @response `403` `ProblemDetails` Forbidden
8670
+ */
8671
+ getEncompassIntegrationsWebhooks: (data: LosIntegrationsBatchRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory[], any, {}>>;
8672
+ /**
8673
+ * No description
8674
+ *
8675
+ * @tags EncompassIntegrations
8676
+ * @name RecheckEncompassIntegrationWebhooks
8677
+ * @summary Force a fresh Encompass webhook inventory read for one account (SuperAdmin)
8678
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/recheck
8679
+ * @secure
8680
+ * @response `200` `LosWebhookInventory` OK
8681
+ * @response `401` `ProblemDetails` Unauthorized
8682
+ * @response `403` `ProblemDetails` Forbidden
8683
+ */
8684
+ recheckEncompassIntegrationWebhooks: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosWebhookInventory, any, {}>>;
8685
+ /**
8686
+ * No description
8687
+ *
8688
+ * @tags EncompassIntegrations
8689
+ * @name GetEncompassIntegrationCredentials
8690
+ * @summary Get Encompass credentials including secrets for a specific account (SuperAdmin)
8691
+ * @request GET:/api/monitoring/encompass-integrations/{accountId}/credentials
8692
+ * @secure
8693
+ * @response `200` `LosIntegrationCredentials` OK
8694
+ * @response `401` `ProblemDetails` Unauthorized
8695
+ * @response `403` `ProblemDetails` Forbidden
8696
+ * @response `404` `ProblemDetails` Not Found
8697
+ */
8698
+ getEncompassIntegrationCredentials: (accountId: string, params?: RequestParams) => Promise<AxiosResponse<LosIntegrationCredentials, any, {}>>;
8699
+ /**
8700
+ * No description
8701
+ *
8702
+ * @tags EncompassIntegrations
8703
+ * @name UpdateEncompassIntegrationCredentials
8704
+ * @summary Update Encompass credentials for a specific account (SuperAdmin)
8705
+ * @request PUT:/api/monitoring/encompass-integrations/{accountId}/credentials
8706
+ * @secure
8707
+ * @response `200` `EncompassCredentialsDetail` OK
8708
+ * @response `401` `ProblemDetails` Unauthorized
8709
+ * @response `403` `ProblemDetails` Forbidden
8710
+ * @response `404` `ProblemDetails` Not Found
8711
+ */
8712
+ updateEncompassIntegrationCredentials: (accountId: string, data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any, {}>>;
8713
+ /**
8714
+ * No description
8715
+ *
8716
+ * @tags EncompassIntegrations
8717
+ * @name RegisterEncompassIntegrationWebhook
8718
+ * @summary Register an expected Encompass webhook for a specific account (SuperAdmin)
8719
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks
8720
+ * @secure
8721
+ * @response `201` `LosWebhook` Created
8722
+ * @response `400` `ProblemDetails` Bad Request
8723
+ * @response `401` `ProblemDetails` Unauthorized
8724
+ * @response `403` `ProblemDetails` Forbidden
8725
+ */
8726
+ registerEncompassIntegrationWebhook: (accountId: string, data: CreateWebhookRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhook, any, {}>>;
8727
+ /**
8728
+ * No description
8729
+ *
8730
+ * @tags EncompassIntegrations
8731
+ * @name DeleteEncompassIntegrationWebhook
8732
+ * @summary Delete an Encompass webhook for a specific account (SuperAdmin)
8733
+ * @request DELETE:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookId}
8734
+ * @secure
8735
+ * @response `204` `void` No Content
8736
+ * @response `401` `ProblemDetails` Unauthorized
8737
+ * @response `403` `ProblemDetails` Forbidden
8738
+ * @response `404` `ProblemDetails` Not Found
8739
+ */
8740
+ deleteEncompassIntegrationWebhook: (accountId: string, webhookId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
8474
8741
  /**
8475
8742
  * No description
8476
8743
  *
@@ -9805,6 +10072,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9805
10072
  * @response `404` `ProblemDetails` Not Found
9806
10073
  */
9807
10074
  inviteLoanContacts: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<Invite[], any, {}>>;
10075
+ /**
10076
+ * No description
10077
+ *
10078
+ * @tags LoanInvites
10079
+ * @name DeleteLoanInvite
10080
+ * @summary Delete Invite
10081
+ * @request DELETE:/api/loans/{loanId}/invites/{id}
10082
+ * @secure
10083
+ * @response `204` `void` No Content
10084
+ * @response `404` `ProblemDetails` Not Found
10085
+ */
10086
+ deleteLoanInvite: (loanId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
9808
10087
  /**
9809
10088
  * No description
9810
10089
  *
@@ -11758,6 +12037,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11758
12037
  * @request PUT:/api/users/invites/{id}/resend
11759
12038
  * @secure
11760
12039
  * @response `204` `void` No Content
12040
+ * @response `400` `ProblemDetails` Bad Request
11761
12041
  * @response `401` `UnprocessableEntity` Unauthorized
11762
12042
  * @response `404` `UnprocessableEntity` Not Found
11763
12043
  */
@@ -11771,9 +12051,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11771
12051
  * @request GET:/api/users/invites/{token}/verify
11772
12052
  * @secure
11773
12053
  * @response `200` `Invite` OK
12054
+ * @response `400` `ProblemDetails` Bad Request
11774
12055
  * @response `422` `UnprocessableEntity` Unprocessable Content
11775
12056
  */
11776
12057
  verifyUserInvite: (token: string, params?: RequestParams) => Promise<AxiosResponse<Invite, any, {}>>;
12058
+ /**
12059
+ * No description
12060
+ *
12061
+ * @tags UserReactivation
12062
+ * @name RequestUserReactivation
12063
+ * @summary Request user reactivation
12064
+ * @request POST:/api/users/reactivation/request
12065
+ * @secure
12066
+ * @response `204` `void` No Content
12067
+ */
12068
+ requestUserReactivation: (data: UserReactivationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
12069
+ /**
12070
+ * No description
12071
+ *
12072
+ * @tags UserReactivation
12073
+ * @name CompleteUserReactivation
12074
+ * @summary Complete user reactivation with new password
12075
+ * @request POST:/api/users/reactivation/complete
12076
+ * @secure
12077
+ * @response `204` `void` No Content
12078
+ * @response `400` `ProblemDetails` Bad Request
12079
+ */
12080
+ completeUserReactivation: (data: UserReactivationCompleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11777
12081
  /**
11778
12082
  * No description
11779
12083
  *
@@ -11845,6 +12149,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11845
12149
  * @request POST:/api/users
11846
12150
  * @secure
11847
12151
  * @response `200` `DetailedUser` OK
12152
+ * @response `409` `ProblemDetails` Conflict
11848
12153
  * @response `422` `UnprocessableEntity` Unprocessable Content
11849
12154
  */
11850
12155
  createUser: (data: CreateUserRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
@@ -12021,6 +12326,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12021
12326
  * @request PUT:/api/users/me
12022
12327
  * @secure
12023
12328
  * @response `200` `DetailedUser` OK
12329
+ * @response `403` `ProblemDetails` Forbidden
12330
+ * @response `409` `ProblemDetails` Conflict
12024
12331
  */
12025
12332
  replaceMe: (data: UpdateMeRequest, params?: RequestParams) => Promise<AxiosResponse<DetailedUser, any, {}>>;
12026
12333
  /**