@matech/thebigpos-sdk 2.41.0-rc1 → 2.42.1

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
@@ -117,7 +117,7 @@ export interface AccountBilling {
117
117
  contractedRate: number;
118
118
  }
119
119
  export interface AccountBillingRequest {
120
- billingType: "ClosedLoan" | "LoanOfficer";
120
+ billingType: AccountBillingRequestBillingTypeEnum;
121
121
  /**
122
122
  * @format double
123
123
  * @min 0
@@ -163,7 +163,7 @@ export interface Action {
163
163
  comments?: string | null;
164
164
  /** @format uuid */
165
165
  siteConfigurationID: string;
166
- applicationSettings?: any;
166
+ applicationSettings?: any | null;
167
167
  surveysToken?: string | null;
168
168
  }
169
169
  export interface Address {
@@ -456,14 +456,14 @@ export interface AuditLogEntry {
456
456
  /** @format uuid */
457
457
  id: string;
458
458
  entityType: string;
459
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
459
+ changeType: AuditLogEntryChangeTypeEnum;
460
460
  /** @format uuid */
461
461
  entityId: string;
462
462
  performedBy?: AuditLogUser | null;
463
463
  rootEntityType?: string | null;
464
464
  /** @format uuid */
465
465
  rootEntityId?: string | null;
466
- changes?: any;
466
+ changes?: any | null;
467
467
  /** @format date-time */
468
468
  createdAt: string;
469
469
  }
@@ -740,7 +740,7 @@ export interface CorporateSearchCriteria {
740
740
  isActive?: boolean | null;
741
741
  }
742
742
  export interface CreateAccessScopeRequest {
743
- scopeType: "User" | "Branch";
743
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
744
744
  /** @format uuid */
745
745
  userId?: string | null;
746
746
  /** @format uuid */
@@ -763,7 +763,7 @@ export interface CreateAccountRequest {
763
763
  */
764
764
  nlmsid: number;
765
765
  settings: AccountSettingsRequest;
766
- environment: "Development" | "Staging" | "UAT" | "Production";
766
+ environment: CreateAccountRequestEnvironmentEnum;
767
767
  losIntegration: LOSIntegration;
768
768
  billingSettings: AccountBillingRequest;
769
769
  }
@@ -799,8 +799,8 @@ export interface CreateCustomFieldDefinitionRequest {
799
799
  name: string;
800
800
  defaultValue?: string | null;
801
801
  regexPattern?: string | null;
802
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
803
- entityType: "Loan";
802
+ dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
803
+ entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
804
804
  options?: CustomFieldOptionRequest[] | null;
805
805
  permissions?: CustomFieldPermissionRequest[] | null;
806
806
  }
@@ -820,7 +820,7 @@ export interface CreateDocumentTemplateRequest {
820
820
  export interface CreateGroupMemberRequest {
821
821
  /** @format uuid */
822
822
  userId: string;
823
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
823
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
824
824
  }
825
825
  export interface CreateInviteRequest {
826
826
  /** @minLength 1 */
@@ -831,7 +831,7 @@ export interface CreateInviteRequest {
831
831
  emailAddress: string;
832
832
  phoneNumber?: string | null;
833
833
  /** @deprecated */
834
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
834
+ relationship: CreateInviteRequestRelationshipEnum;
835
835
  loanID: string;
836
836
  route?: string | null;
837
837
  /** @format uuid */
@@ -861,7 +861,7 @@ export interface CreateLoanImportRequest {
861
861
  * @minLength 1
862
862
  */
863
863
  startDate: string;
864
- importMode: "All" | "NewOnly" | "UpdateOnly";
864
+ importMode: CreateLoanImportRequestImportModeEnum;
865
865
  }
866
866
  export interface CreateSession {
867
867
  sessionId: string;
@@ -879,7 +879,7 @@ export interface CreateUserDeviceRequest {
879
879
  token: string;
880
880
  }
881
881
  export interface CreateUserDraft {
882
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
882
+ loanRole: CreateUserDraftLoanRoleEnum;
883
883
  }
884
884
  export interface CreateUserGroupRequest {
885
885
  /**
@@ -960,8 +960,8 @@ export interface CustomFieldDefinition {
960
960
  name: string;
961
961
  defaultValue?: string | null;
962
962
  regexPattern?: string | null;
963
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
964
- entityType: "Loan";
963
+ dataType: CustomFieldDefinitionDataTypeEnum;
964
+ entityType: CustomFieldDefinitionEntityTypeEnum;
965
965
  options: CustomFieldOption[];
966
966
  permissions: CustomFieldPermission[];
967
967
  encompassMapping?: EncompassMapping | null;
@@ -975,7 +975,7 @@ export interface CustomFieldEntry {
975
975
  displayOrder: number;
976
976
  name: string;
977
977
  value: string;
978
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
978
+ dataType: CustomFieldEntryDataTypeEnum;
979
979
  }
980
980
  export interface CustomFieldOption {
981
981
  /** @format uuid */
@@ -992,12 +992,12 @@ export interface CustomFieldOptionRequest {
992
992
  export interface CustomFieldPermission {
993
993
  /** @format uuid */
994
994
  id: string;
995
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
996
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
995
+ role: CustomFieldPermissionRoleEnum;
996
+ accessLevel: CustomFieldPermissionAccessLevelEnum;
997
997
  }
998
998
  export interface CustomFieldPermissionRequest {
999
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1000
- accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
999
+ role: CustomFieldPermissionRequestRoleEnum;
1000
+ accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
1001
1001
  }
1002
1002
  export interface CustomFieldValue {
1003
1003
  /** @format uuid */
@@ -1008,7 +1008,7 @@ export interface CustomFieldValue {
1008
1008
  customFieldDefinitionID: string;
1009
1009
  value: string;
1010
1010
  definitionName: string;
1011
- dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1011
+ dataType: CustomFieldValueDataTypeEnum;
1012
1012
  }
1013
1013
  export interface DetailedUser {
1014
1014
  /** @format date-time */
@@ -1249,7 +1249,7 @@ export interface Draft {
1249
1249
  siteConfiguration: SiteConfigurationReduced;
1250
1250
  /** @format uuid */
1251
1251
  loanID?: string | null;
1252
- type: "NewLoan" | "EditLoan";
1252
+ type: DraftTypeEnum;
1253
1253
  isCoBorrower: boolean;
1254
1254
  }
1255
1255
  export interface DraftContent {
@@ -1267,7 +1267,7 @@ export interface DraftContent {
1267
1267
  siteConfiguration: SiteConfigurationReduced;
1268
1268
  /** @format uuid */
1269
1269
  loanID?: string | null;
1270
- type: "NewLoan" | "EditLoan";
1270
+ type: DraftContentTypeEnum;
1271
1271
  isCoBorrower: boolean;
1272
1272
  applicationPayload: any;
1273
1273
  }
@@ -1283,7 +1283,7 @@ export interface DraftLoanOfficerReassignRequest {
1283
1283
  }
1284
1284
  export interface DraftRequest {
1285
1285
  applicationPayload: any;
1286
- customData?: any;
1286
+ customData?: any | null;
1287
1287
  isCoBorrower: boolean;
1288
1288
  }
1289
1289
  export interface EnabledServices {
@@ -1352,9 +1352,9 @@ export interface EncompassCredentialsDetail {
1352
1352
  clearStateIfUnlicensed: boolean;
1353
1353
  /** @deprecated */
1354
1354
  baseUrl?: string | null;
1355
- encompassEnvironment: "Production" | "UAT";
1355
+ encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
1356
1356
  consumerConnectWidgetHost?: string | null;
1357
- signingMethod: "ConsumerConnect" | "POSF";
1357
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1358
1358
  subscriptionId?: string | null;
1359
1359
  environment?: string | null;
1360
1360
  }
@@ -1370,9 +1370,9 @@ export interface EncompassCredentialsRequest {
1370
1370
  clearStateIfUnlicensed: boolean;
1371
1371
  /** @deprecated */
1372
1372
  baseUrl?: string | null;
1373
- encompassEnvironment: "Production" | "UAT";
1373
+ encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
1374
1374
  consumerConnectWidgetHost?: string | null;
1375
- signingMethod: "ConsumerConnect" | "POSF";
1375
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1376
1376
  subscriptionId?: string | null;
1377
1377
  environment?: string | null;
1378
1378
  clientID?: string | null;
@@ -1481,8 +1481,8 @@ export interface EncompassRequestLog {
1481
1481
  losId?: string | null;
1482
1482
  /** @format uuid */
1483
1483
  accountId: string;
1484
- operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1485
- outcome: "Success" | "Failure" | "PartialSuccess";
1484
+ operationType: EncompassRequestLogOperationTypeEnum;
1485
+ outcome: EncompassRequestLogOutcomeEnum;
1486
1486
  message: string;
1487
1487
  endpoint?: string | null;
1488
1488
  httpMethod?: string | null;
@@ -1490,7 +1490,7 @@ export interface EncompassRequestLog {
1490
1490
  httpStatusCode?: number | null;
1491
1491
  /** @format int64 */
1492
1492
  durationMs?: number | null;
1493
- context?: any;
1493
+ context?: any | null;
1494
1494
  /** @format date-time */
1495
1495
  createdAt: string;
1496
1496
  }
@@ -1533,7 +1533,7 @@ export interface FileSearchCriteria {
1533
1533
  export interface FileWithBytes {
1534
1534
  name: string;
1535
1535
  /** @format byte */
1536
- data: string;
1536
+ data: Blob;
1537
1537
  fileName: string;
1538
1538
  mimeType?: string | null;
1539
1539
  extension?: string | null;
@@ -1609,7 +1609,7 @@ export interface FormSubmission {
1609
1609
  subjectPropertyAddressCounty?: string | null;
1610
1610
  subjectPropertyAddressState?: string | null;
1611
1611
  subjectPropertyAddressZip?: string | null;
1612
- data?: any;
1612
+ data?: any | null;
1613
1613
  /** @format uuid */
1614
1614
  listingID?: string | null;
1615
1615
  listing?: Listing | null;
@@ -1644,7 +1644,7 @@ export interface FormSubmissionRequest {
1644
1644
  subjectPropertyAddressCounty?: string | null;
1645
1645
  subjectPropertyAddressState?: string | null;
1646
1646
  subjectPropertyAddressZip?: string | null;
1647
- data?: any;
1647
+ data?: any | null;
1648
1648
  /** @format uuid */
1649
1649
  listingID?: string | null;
1650
1650
  }
@@ -1695,7 +1695,7 @@ export interface FusionFieldDisplay {
1695
1695
  fieldValue: string;
1696
1696
  }
1697
1697
  export interface FusionReportFilter {
1698
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1698
+ filterType: FusionReportFilterFilterTypeEnum;
1699
1699
  targetField: string;
1700
1700
  targetValue: string;
1701
1701
  }
@@ -1805,11 +1805,11 @@ export interface GetWorkflowRequest {
1805
1805
  export interface GuidPatchOperation {
1806
1806
  op: string;
1807
1807
  path: string;
1808
- value?: any;
1808
+ value?: any | null;
1809
1809
  from?: string | null;
1810
1810
  }
1811
1811
  export interface IPAddress {
1812
- 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";
1812
+ addressFamily: IpAddressAddressFamilyEnum;
1813
1813
  /** @format int64 */
1814
1814
  scopeId: number;
1815
1815
  isIPv6Multicast: boolean;
@@ -2066,7 +2066,7 @@ export interface Loan {
2066
2066
  userLoans: UserLoan[];
2067
2067
  contacts: LoanContact[];
2068
2068
  customFields: CustomFieldEntry[];
2069
- signingMethod: "ConsumerConnect" | "POSF";
2069
+ signingMethod: LoanSigningMethodEnum;
2070
2070
  }
2071
2071
  export interface LoanApplication {
2072
2072
  /** @format uuid */
@@ -2103,7 +2103,7 @@ export interface LoanApplicationRequest {
2103
2103
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2104
2104
  /** @format uuid */
2105
2105
  draftId?: string | null;
2106
- additionalFields?: Record<string, any>;
2106
+ additionalFields?: Record<string, any> | null;
2107
2107
  /** @format uuid */
2108
2108
  existingLoanId?: string | null;
2109
2109
  }
@@ -2122,7 +2122,7 @@ export interface LoanBorrower {
2122
2122
  citizenship?: LoanCitizenship | null;
2123
2123
  maritalStatus?: LoanMaritalStatus | null;
2124
2124
  languagePreference?: LoanLanguagePreference | null;
2125
- applicationStatus: "Draft" | "Complete";
2125
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
2126
2126
  /** @format int32 */
2127
2127
  numberOfDependents?: number | null;
2128
2128
  isPrimaryBorrower: boolean;
@@ -2962,7 +2962,7 @@ export interface LoanConsentRequest {
2962
2962
  borrowerEConsent?: boolean | null;
2963
2963
  borrowerCreditAuth?: boolean | null;
2964
2964
  borrowerTCPAOptIn?: boolean | null;
2965
- additionalFields?: Record<string, string>;
2965
+ additionalFields?: Record<string, string> | null;
2966
2966
  }
2967
2967
  export interface LoanContact {
2968
2968
  /** @format date-time */
@@ -2980,13 +2980,13 @@ export interface LoanContact {
2980
2980
  email?: string | null;
2981
2981
  phone?: string | null;
2982
2982
  companyName?: string | null;
2983
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2983
+ role: LoanContactRoleEnum;
2984
2984
  }
2985
2985
  export interface LoanContactList {
2986
2986
  email: string;
2987
2987
  }
2988
2988
  export interface LoanCustomFieldsRequest {
2989
- additionalFields?: Record<string, string>;
2989
+ additionalFields?: Record<string, string> | null;
2990
2990
  }
2991
2991
  export interface LoanDocument {
2992
2992
  /** @format date-time */
@@ -3029,12 +3029,12 @@ export interface LoanDocumentFolderPermission {
3029
3029
  id: string;
3030
3030
  /** @format uuid */
3031
3031
  loanDocumentFolderID: string;
3032
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3033
- level: "None" | "Read" | "Write" | "Manage";
3032
+ role: LoanDocumentFolderPermissionRoleEnum;
3033
+ level: LoanDocumentFolderPermissionLevelEnum;
3034
3034
  }
3035
3035
  export interface LoanDocumentFolderPermissionRequest {
3036
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3037
- level: "None" | "Read" | "Write" | "Manage";
3036
+ role: LoanDocumentFolderPermissionRequestRoleEnum;
3037
+ level: LoanDocumentFolderPermissionRequestLevelEnum;
3038
3038
  }
3039
3039
  export interface LoanDocumentFolderUsage {
3040
3040
  /** @format uuid */
@@ -3142,13 +3142,13 @@ export interface LoanImport {
3142
3142
  /** @format int32 */
3143
3143
  importedCount: number;
3144
3144
  statusMessage?: string | null;
3145
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3146
- importMode: "All" | "NewOnly" | "UpdateOnly";
3145
+ status: LoanImportStatusEnum;
3146
+ importMode: LoanImportImportModeEnum;
3147
3147
  /** @format date-time */
3148
3148
  createdAt?: string | null;
3149
3149
  }
3150
3150
  export interface LoanImportLog {
3151
- level: "None" | "Info" | "Warning" | "Error";
3151
+ level: LoanImportLogLevelEnum;
3152
3152
  message: string;
3153
3153
  /** @format date-time */
3154
3154
  createdAt: string;
@@ -3203,8 +3203,8 @@ export interface LoanListPaginated {
3203
3203
  export interface LoanLog {
3204
3204
  /** @format uuid */
3205
3205
  id: string;
3206
- level: "None" | "Info" | "Warning" | "Error";
3207
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
3206
+ level: LoanLogLevelEnum;
3207
+ type: LoanLogTypeEnum;
3208
3208
  message: string;
3209
3209
  /** @format date-time */
3210
3210
  createdAt: string;
@@ -3212,8 +3212,8 @@ export interface LoanLog {
3212
3212
  export interface LoanLogDetail {
3213
3213
  /** @format uuid */
3214
3214
  id: string;
3215
- level: "None" | "Info" | "Warning" | "Error";
3216
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
3215
+ level: LoanLogDetailLevelEnum;
3216
+ type: LoanLogDetailTypeEnum;
3217
3217
  message: string;
3218
3218
  /** @format date-time */
3219
3219
  createdAt: string;
@@ -3452,7 +3452,7 @@ export interface LoanQueueWithData {
3452
3452
  user: UserPublic;
3453
3453
  loanOfficer: LoanOfficerPublic;
3454
3454
  siteConfiguration: SiteConfigurationReduced;
3455
- data?: any;
3455
+ data?: any | null;
3456
3456
  }
3457
3457
  export interface LoanRecord {
3458
3458
  loanGuid: string;
@@ -3483,7 +3483,7 @@ export interface LoanTaskSearchRequest {
3483
3483
  loanStatus?: LoanTaskActivityFilter | null;
3484
3484
  }
3485
3485
  export interface LoanTaskStatusSummary {
3486
- status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3486
+ status: LoanTaskStatusSummaryStatusEnum;
3487
3487
  /** @format int32 */
3488
3488
  count: number;
3489
3489
  }
@@ -3495,7 +3495,7 @@ export interface LoanUser {
3495
3495
  email: string;
3496
3496
  phone?: string | null;
3497
3497
  role: string;
3498
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3498
+ loanRole: LoanUserLoanRoleEnum;
3499
3499
  isUser: boolean;
3500
3500
  /** @format date-time */
3501
3501
  createdAt: string;
@@ -3528,7 +3528,7 @@ export interface LosOperationTracking {
3528
3528
  operationType: string;
3529
3529
  correlationKey: string;
3530
3530
  lastTriggerSource?: string | null;
3531
- status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3531
+ status: LosOperationTrackingStatusEnum;
3532
3532
  /** @format date-time */
3533
3533
  createdAt: string;
3534
3534
  /** @format date-time */
@@ -3589,7 +3589,7 @@ export interface LosSyncStep {
3589
3589
  /** @format int32 */
3590
3590
  order: number;
3591
3591
  name: string;
3592
- severity: "Success" | "Info" | "Warning" | "Error";
3592
+ severity: LosSyncStepSeverityEnum;
3593
3593
  message: string;
3594
3594
  /** @format date-time */
3595
3595
  atUtc: string;
@@ -3689,7 +3689,7 @@ export interface ModuleParameterValue {
3689
3689
  parameterID: string;
3690
3690
  parameterName: string;
3691
3691
  parameterType: string;
3692
- value?: any;
3692
+ value?: any | null;
3693
3693
  isInherited: boolean;
3694
3694
  }
3695
3695
  export interface MonthlyPaymentCalculator {
@@ -3900,7 +3900,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3900
3900
  }
3901
3901
  export interface Operation {
3902
3902
  op?: string;
3903
- value?: string | number | boolean | null | object;
3903
+ value?: object | null;
3904
3904
  path?: string;
3905
3905
  }
3906
3906
  export interface OverridePasswordRequest {
@@ -4236,7 +4236,7 @@ export interface SSOTokenRequest {
4236
4236
  redirectUri: string;
4237
4237
  }
4238
4238
  export interface SamlMetadataRequest {
4239
- ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4239
+ ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4240
4240
  }
4241
4241
  export interface SendForgotPasswordRequest {
4242
4242
  /**
@@ -4287,7 +4287,7 @@ export interface SiteConfiguration {
4287
4287
  deletedAt?: string | null;
4288
4288
  /** @format uuid */
4289
4289
  id: string;
4290
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4290
+ type: SiteConfigurationTypeEnum;
4291
4291
  /** @format uuid */
4292
4292
  entityID: string;
4293
4293
  /** @format int32 */
@@ -4481,7 +4481,7 @@ export interface SiteConfigurationByUrl {
4481
4481
  deletedAt?: string | null;
4482
4482
  /** @format uuid */
4483
4483
  id: string;
4484
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4484
+ type: SiteConfigurationByUrlTypeEnum;
4485
4485
  /** @format uuid */
4486
4486
  entityID: string;
4487
4487
  /** @format int32 */
@@ -4692,7 +4692,7 @@ export interface SiteConfigurationForm {
4692
4692
  export interface SiteConfigurationReduced {
4693
4693
  /** @format uuid */
4694
4694
  id: string;
4695
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4695
+ type: SiteConfigurationReducedTypeEnum;
4696
4696
  url?: string | null;
4697
4697
  name: string;
4698
4698
  /** @format int64 */
@@ -4709,7 +4709,7 @@ export interface SiteConfigurationRequest {
4709
4709
  entityID: string;
4710
4710
  /** @format int32 */
4711
4711
  entityType: number;
4712
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4712
+ type: SiteConfigurationRequestTypeEnum;
4713
4713
  url: string;
4714
4714
  name: string;
4715
4715
  introduction?: string | null;
@@ -4884,7 +4884,7 @@ export interface SiteConfigurationSearchCriteria {
4884
4884
  export interface SiteConfigurationSummary {
4885
4885
  /** @format uuid */
4886
4886
  id: string;
4887
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4887
+ type: SiteConfigurationSummaryTypeEnum;
4888
4888
  url?: string | null;
4889
4889
  name: string;
4890
4890
  /** @format int64 */
@@ -5500,7 +5500,7 @@ export interface UserDevice {
5500
5500
  export interface UserDraft {
5501
5501
  /** @format uuid */
5502
5502
  draftID: string;
5503
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5503
+ role: UserDraftRoleEnum;
5504
5504
  user: User;
5505
5505
  }
5506
5506
  export interface UserDraftPaginated {
@@ -5524,7 +5524,7 @@ export interface UserGroupAccessScope {
5524
5524
  id: string;
5525
5525
  /** @format uuid */
5526
5526
  groupId: string;
5527
- scopeType: "User" | "Branch";
5527
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5528
5528
  /** @format uuid */
5529
5529
  userId?: string | null;
5530
5530
  /** @format uuid */
@@ -5557,7 +5557,7 @@ export interface UserLoan {
5557
5557
  deletedAt?: string | null;
5558
5558
  loanID: string;
5559
5559
  user: User;
5560
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5560
+ role: UserLoanRoleEnum;
5561
5561
  /** @format int32 */
5562
5562
  borrowerPair?: number | null;
5563
5563
  /** @format int32 */
@@ -5569,11 +5569,11 @@ export interface UserLoanConsent {
5569
5569
  id: string;
5570
5570
  /** @format uuid */
5571
5571
  userLoanID: string;
5572
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5572
+ type: UserLoanConsentTypeEnum;
5573
5573
  providedConsent: boolean;
5574
5574
  source?: ConsentSource | null;
5575
5575
  ipAddress?: string | null;
5576
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5576
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5577
5577
  /** @format date-time */
5578
5578
  createdAt: string;
5579
5579
  /** @format date-time */
@@ -5714,7 +5714,7 @@ export interface UserSummary {
5714
5714
  id: string;
5715
5715
  name?: string | null;
5716
5716
  email?: string | null;
5717
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5717
+ role: UserSummaryRoleEnum;
5718
5718
  }
5719
5719
  export interface VerifyPasswordRequest {
5720
5720
  /**
@@ -5747,6 +5747,72 @@ export interface Workflow {
5747
5747
  tileSubtitle: string;
5748
5748
  icon: string;
5749
5749
  }
5750
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5751
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5752
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5753
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5754
+ export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5755
+ export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5756
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5757
+ /** @deprecated */
5758
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5759
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5760
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5761
+ export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5762
+ export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5763
+ export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5764
+ export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5765
+ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5766
+ export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5767
+ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5768
+ export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5769
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
5770
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5771
+ export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
5772
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5773
+ export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
5774
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5775
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5776
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5777
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5778
+ 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";
5779
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5780
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5781
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5782
+ export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5783
+ export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5784
+ export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5785
+ export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5786
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5787
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5788
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5789
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5790
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5791
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5792
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5793
+ export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5794
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5795
+ export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5796
+ export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5797
+ export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5798
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5799
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5800
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5801
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5802
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5803
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5804
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5805
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5806
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5807
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5808
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5809
+ export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5810
+ /** @default "Realtor" */
5811
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5812
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5813
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5814
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5815
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5750
5816
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5751
5817
  export type QueryParamsType = Record<string | number, any>;
5752
5818
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5769,14 +5835,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5769
5835
  secure?: boolean;
5770
5836
  format?: ResponseType;
5771
5837
  }
5772
- export declare enum ContentType {
5773
- JsonPatch = "application/json-patch+json",
5774
- Json = "application/json",
5775
- JsonApi = "application/vnd.api+json",
5776
- FormData = "multipart/form-data",
5777
- UrlEncoded = "application/x-www-form-urlencoded",
5778
- Text = "text/plain"
5779
- }
5838
+ export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
5780
5839
  export declare class HttpClient<SecurityDataType = unknown> {
5781
5840
  instance: AxiosInstance;
5782
5841
  private securityData;
@@ -5792,7 +5851,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5792
5851
  }
5793
5852
  /**
5794
5853
  * @title The Big POS API
5795
- * @version v2.41.0
5854
+ * @version v2.42.0
5796
5855
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5797
5856
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5798
5857
  */
@@ -6477,7 +6536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6477
6536
  * @response `200` `(CustomFieldDefinition)[]` Success
6478
6537
  */
6479
6538
  getCustomFieldDefinitions: (query?: {
6480
- entityType?: "Loan";
6539
+ entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
6481
6540
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
6482
6541
  /**
6483
6542
  * No description
@@ -7978,10 +8037,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7978
8037
  * @summary Download By ID
7979
8038
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
7980
8039
  * @secure
7981
- * @response `200` `string` Success
8040
+ * @response `200` `Blob` Success
7982
8041
  * @response `404` `ProblemDetails` Not Found
7983
8042
  */
7984
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
8043
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
7985
8044
  /**
7986
8045
  * No description
7987
8046
  *
@@ -9184,7 +9243,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9184
9243
  getPartners: (query?: {
9185
9244
  showAll?: boolean;
9186
9245
  /** @default "Realtor" */
9187
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
9246
+ role?: GetPartnersParamsRoleEnum;
9188
9247
  /** @format int32 */
9189
9248
  pageSize?: number;
9190
9249
  /** @format int32 */
@@ -9362,7 +9421,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9362
9421
  * @response `200` `File` Success
9363
9422
  * @response `404` `ProblemDetails` Not Found
9364
9423
  */
9365
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9424
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9366
9425
  /**
9367
9426
  * No description
9368
9427
  *
@@ -9373,7 +9432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9373
9432
  * @secure
9374
9433
  * @response `200` `File` Success
9375
9434
  */
9376
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9435
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9377
9436
  /**
9378
9437
  * No description
9379
9438
  *