@matech/thebigpos-sdk 2.40.6-rc1 → 2.41.0-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
@@ -53,6 +53,7 @@ export type Environment = "Development" | "Staging" | "UAT" | "Production";
53
53
  export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
54
54
  export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
55
55
  export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
56
+ export type EncompassEnvironment = "Production" | "UAT";
56
57
  export type DraftType = "NewLoan" | "EditLoan";
57
58
  export type CustomFieldEntityType = "Loan";
58
59
  export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
@@ -116,7 +117,7 @@ export interface AccountBilling {
116
117
  contractedRate: number;
117
118
  }
118
119
  export interface AccountBillingRequest {
119
- billingType: AccountBillingRequestBillingTypeEnum;
120
+ billingType: "ClosedLoan" | "LoanOfficer";
120
121
  /**
121
122
  * @format double
122
123
  * @min 0
@@ -455,7 +456,7 @@ export interface AuditLogEntry {
455
456
  /** @format uuid */
456
457
  id: string;
457
458
  entityType: string;
458
- changeType: AuditLogEntryChangeTypeEnum;
459
+ changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
459
460
  /** @format uuid */
460
461
  entityId: string;
461
462
  performedBy?: AuditLogUser | null;
@@ -739,7 +740,7 @@ export interface CorporateSearchCriteria {
739
740
  isActive?: boolean | null;
740
741
  }
741
742
  export interface CreateAccessScopeRequest {
742
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
743
+ scopeType: "User" | "Branch";
743
744
  /** @format uuid */
744
745
  userId?: string | null;
745
746
  /** @format uuid */
@@ -762,7 +763,7 @@ export interface CreateAccountRequest {
762
763
  */
763
764
  nlmsid: number;
764
765
  settings: AccountSettingsRequest;
765
- environment: CreateAccountRequestEnvironmentEnum;
766
+ environment: "Development" | "Staging" | "UAT" | "Production";
766
767
  losIntegration: LOSIntegration;
767
768
  billingSettings: AccountBillingRequest;
768
769
  }
@@ -798,8 +799,8 @@ export interface CreateCustomFieldDefinitionRequest {
798
799
  name: string;
799
800
  defaultValue?: string | null;
800
801
  regexPattern?: string | null;
801
- dataType: CreateCustomFieldDefinitionRequestDataTypeEnum;
802
- entityType: CreateCustomFieldDefinitionRequestEntityTypeEnum;
802
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
803
+ entityType: "Loan";
803
804
  options?: CustomFieldOptionRequest[] | null;
804
805
  permissions?: CustomFieldPermissionRequest[] | null;
805
806
  }
@@ -819,7 +820,7 @@ export interface CreateDocumentTemplateRequest {
819
820
  export interface CreateGroupMemberRequest {
820
821
  /** @format uuid */
821
822
  userId: string;
822
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
823
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
823
824
  }
824
825
  export interface CreateInviteRequest {
825
826
  /** @minLength 1 */
@@ -830,7 +831,7 @@ export interface CreateInviteRequest {
830
831
  emailAddress: string;
831
832
  phoneNumber?: string | null;
832
833
  /** @deprecated */
833
- relationship: CreateInviteRequestRelationshipEnum;
834
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
834
835
  loanID: string;
835
836
  route?: string | null;
836
837
  /** @format uuid */
@@ -860,7 +861,7 @@ export interface CreateLoanImportRequest {
860
861
  * @minLength 1
861
862
  */
862
863
  startDate: string;
863
- importMode: CreateLoanImportRequestImportModeEnum;
864
+ importMode: "All" | "NewOnly" | "UpdateOnly";
864
865
  }
865
866
  export interface CreateSession {
866
867
  sessionId: string;
@@ -878,7 +879,7 @@ export interface CreateUserDeviceRequest {
878
879
  token: string;
879
880
  }
880
881
  export interface CreateUserDraft {
881
- loanRole: CreateUserDraftLoanRoleEnum;
882
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
882
883
  }
883
884
  export interface CreateUserGroupRequest {
884
885
  /**
@@ -959,8 +960,8 @@ export interface CustomFieldDefinition {
959
960
  name: string;
960
961
  defaultValue?: string | null;
961
962
  regexPattern?: string | null;
962
- dataType: CustomFieldDefinitionDataTypeEnum;
963
- entityType: CustomFieldDefinitionEntityTypeEnum;
963
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
964
+ entityType: "Loan";
964
965
  options: CustomFieldOption[];
965
966
  permissions: CustomFieldPermission[];
966
967
  encompassMapping?: EncompassMapping | null;
@@ -974,7 +975,7 @@ export interface CustomFieldEntry {
974
975
  displayOrder: number;
975
976
  name: string;
976
977
  value: string;
977
- dataType: CustomFieldEntryDataTypeEnum;
978
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
978
979
  }
979
980
  export interface CustomFieldOption {
980
981
  /** @format uuid */
@@ -991,12 +992,12 @@ export interface CustomFieldOptionRequest {
991
992
  export interface CustomFieldPermission {
992
993
  /** @format uuid */
993
994
  id: string;
994
- role: CustomFieldPermissionRoleEnum;
995
- accessLevel: CustomFieldPermissionAccessLevelEnum;
995
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
996
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
996
997
  }
997
998
  export interface CustomFieldPermissionRequest {
998
- role: CustomFieldPermissionRequestRoleEnum;
999
- accessLevel: CustomFieldPermissionRequestAccessLevelEnum;
999
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
1000
+ accessLevel: "NoAccess" | "ReadOnly" | "ReadWrite";
1000
1001
  }
1001
1002
  export interface CustomFieldValue {
1002
1003
  /** @format uuid */
@@ -1007,7 +1008,7 @@ export interface CustomFieldValue {
1007
1008
  customFieldDefinitionID: string;
1008
1009
  value: string;
1009
1010
  definitionName: string;
1010
- dataType: CustomFieldValueDataTypeEnum;
1011
+ dataType: "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
1011
1012
  }
1012
1013
  export interface DetailedUser {
1013
1014
  /** @format date-time */
@@ -1248,7 +1249,7 @@ export interface Draft {
1248
1249
  siteConfiguration: SiteConfigurationReduced;
1249
1250
  /** @format uuid */
1250
1251
  loanID?: string | null;
1251
- type: DraftTypeEnum;
1252
+ type: "NewLoan" | "EditLoan";
1252
1253
  isCoBorrower: boolean;
1253
1254
  }
1254
1255
  export interface DraftContent {
@@ -1266,7 +1267,7 @@ export interface DraftContent {
1266
1267
  siteConfiguration: SiteConfigurationReduced;
1267
1268
  /** @format uuid */
1268
1269
  loanID?: string | null;
1269
- type: DraftContentTypeEnum;
1270
+ type: "NewLoan" | "EditLoan";
1270
1271
  isCoBorrower: boolean;
1271
1272
  applicationPayload: any;
1272
1273
  }
@@ -1349,8 +1350,11 @@ export interface EncompassCredentialsDetail {
1349
1350
  loanTemplate?: string | null;
1350
1351
  defaultLoanOfficerUserName?: string | null;
1351
1352
  clearStateIfUnlicensed: boolean;
1353
+ /** @deprecated */
1352
1354
  baseUrl?: string | null;
1353
- signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1355
+ encompassEnvironment: "Production" | "UAT";
1356
+ consumerConnectWidgetHost?: string | null;
1357
+ signingMethod: "ConsumerConnect" | "POSF";
1354
1358
  subscriptionId?: string | null;
1355
1359
  environment?: string | null;
1356
1360
  }
@@ -1364,8 +1368,11 @@ export interface EncompassCredentialsRequest {
1364
1368
  loanTemplate?: string | null;
1365
1369
  defaultLoanOfficerUserName?: string | null;
1366
1370
  clearStateIfUnlicensed: boolean;
1371
+ /** @deprecated */
1367
1372
  baseUrl?: string | null;
1368
- signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1373
+ encompassEnvironment: "Production" | "UAT";
1374
+ consumerConnectWidgetHost?: string | null;
1375
+ signingMethod: "ConsumerConnect" | "POSF";
1369
1376
  subscriptionId?: string | null;
1370
1377
  environment?: string | null;
1371
1378
  clientID?: string | null;
@@ -1399,6 +1406,9 @@ export interface EncompassFieldListItem {
1399
1406
  fieldType: string;
1400
1407
  inUse: boolean;
1401
1408
  }
1409
+ export interface EncompassIntegrationSettings {
1410
+ consumerConnectWidgetHost?: string | null;
1411
+ }
1402
1412
  export interface EncompassLogSearchCriteria {
1403
1413
  searchText?: string | null;
1404
1414
  operationTypes?: EncompassLogOperationType[] | null;
@@ -1471,8 +1481,8 @@ export interface EncompassRequestLog {
1471
1481
  losId?: string | null;
1472
1482
  /** @format uuid */
1473
1483
  accountId: string;
1474
- operationType: EncompassRequestLogOperationTypeEnum;
1475
- outcome: EncompassRequestLogOutcomeEnum;
1484
+ operationType: "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1485
+ outcome: "Success" | "Failure" | "PartialSuccess";
1476
1486
  message: string;
1477
1487
  endpoint?: string | null;
1478
1488
  httpMethod?: string | null;
@@ -1685,7 +1695,7 @@ export interface FusionFieldDisplay {
1685
1695
  fieldValue: string;
1686
1696
  }
1687
1697
  export interface FusionReportFilter {
1688
- filterType: FusionReportFilterFilterTypeEnum;
1698
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1689
1699
  targetField: string;
1690
1700
  targetValue: string;
1691
1701
  }
@@ -1799,7 +1809,7 @@ export interface GuidPatchOperation {
1799
1809
  from?: string | null;
1800
1810
  }
1801
1811
  export interface IPAddress {
1802
- addressFamily: IpAddressAddressFamilyEnum;
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";
1803
1813
  /** @format int64 */
1804
1814
  scopeId: number;
1805
1815
  isIPv6Multicast: boolean;
@@ -1856,6 +1866,9 @@ export interface ImportUserLoanTaskRequest {
1856
1866
  */
1857
1867
  userID: string;
1858
1868
  }
1869
+ export interface IntegrationSettings {
1870
+ encompass?: EncompassIntegrationSettings | null;
1871
+ }
1859
1872
  export interface Invite {
1860
1873
  /** @format uuid */
1861
1874
  id: string;
@@ -2053,7 +2066,7 @@ export interface Loan {
2053
2066
  userLoans: UserLoan[];
2054
2067
  contacts: LoanContact[];
2055
2068
  customFields: CustomFieldEntry[];
2056
- signingMethod: LoanSigningMethodEnum;
2069
+ signingMethod: "ConsumerConnect" | "POSF";
2057
2070
  }
2058
2071
  export interface LoanApplication {
2059
2072
  /** @format uuid */
@@ -2109,7 +2122,7 @@ export interface LoanBorrower {
2109
2122
  citizenship?: LoanCitizenship | null;
2110
2123
  maritalStatus?: LoanMaritalStatus | null;
2111
2124
  languagePreference?: LoanLanguagePreference | null;
2112
- applicationStatus: LoanBorrowerApplicationStatusEnum;
2125
+ applicationStatus: "Draft" | "Complete";
2113
2126
  /** @format int32 */
2114
2127
  numberOfDependents?: number | null;
2115
2128
  isPrimaryBorrower: boolean;
@@ -2967,7 +2980,7 @@ export interface LoanContact {
2967
2980
  email?: string | null;
2968
2981
  phone?: string | null;
2969
2982
  companyName?: string | null;
2970
- role: LoanContactRoleEnum;
2983
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
2971
2984
  }
2972
2985
  export interface LoanContactList {
2973
2986
  email: string;
@@ -3016,12 +3029,12 @@ export interface LoanDocumentFolderPermission {
3016
3029
  id: string;
3017
3030
  /** @format uuid */
3018
3031
  loanDocumentFolderID: string;
3019
- role: LoanDocumentFolderPermissionRoleEnum;
3020
- level: LoanDocumentFolderPermissionLevelEnum;
3032
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3033
+ level: "None" | "Read" | "Write" | "Manage";
3021
3034
  }
3022
3035
  export interface LoanDocumentFolderPermissionRequest {
3023
- role: LoanDocumentFolderPermissionRequestRoleEnum;
3024
- level: LoanDocumentFolderPermissionRequestLevelEnum;
3036
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3037
+ level: "None" | "Read" | "Write" | "Manage";
3025
3038
  }
3026
3039
  export interface LoanDocumentFolderUsage {
3027
3040
  /** @format uuid */
@@ -3129,13 +3142,13 @@ export interface LoanImport {
3129
3142
  /** @format int32 */
3130
3143
  importedCount: number;
3131
3144
  statusMessage?: string | null;
3132
- status: LoanImportStatusEnum;
3133
- importMode: LoanImportImportModeEnum;
3145
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3146
+ importMode: "All" | "NewOnly" | "UpdateOnly";
3134
3147
  /** @format date-time */
3135
3148
  createdAt?: string | null;
3136
3149
  }
3137
3150
  export interface LoanImportLog {
3138
- level: LoanImportLogLevelEnum;
3151
+ level: "None" | "Info" | "Warning" | "Error";
3139
3152
  message: string;
3140
3153
  /** @format date-time */
3141
3154
  createdAt: string;
@@ -3190,8 +3203,8 @@ export interface LoanListPaginated {
3190
3203
  export interface LoanLog {
3191
3204
  /** @format uuid */
3192
3205
  id: string;
3193
- level: LoanLogLevelEnum;
3194
- type: LoanLogTypeEnum;
3206
+ level: "None" | "Info" | "Warning" | "Error";
3207
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
3195
3208
  message: string;
3196
3209
  /** @format date-time */
3197
3210
  createdAt: string;
@@ -3199,8 +3212,8 @@ export interface LoanLog {
3199
3212
  export interface LoanLogDetail {
3200
3213
  /** @format uuid */
3201
3214
  id: string;
3202
- level: LoanLogDetailLevelEnum;
3203
- type: LoanLogDetailTypeEnum;
3215
+ level: "None" | "Info" | "Warning" | "Error";
3216
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
3204
3217
  message: string;
3205
3218
  /** @format date-time */
3206
3219
  createdAt: string;
@@ -3470,7 +3483,7 @@ export interface LoanTaskSearchRequest {
3470
3483
  loanStatus?: LoanTaskActivityFilter | null;
3471
3484
  }
3472
3485
  export interface LoanTaskStatusSummary {
3473
- status: LoanTaskStatusSummaryStatusEnum;
3486
+ status: "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3474
3487
  /** @format int32 */
3475
3488
  count: number;
3476
3489
  }
@@ -3482,7 +3495,7 @@ export interface LoanUser {
3482
3495
  email: string;
3483
3496
  phone?: string | null;
3484
3497
  role: string;
3485
- loanRole: LoanUserLoanRoleEnum;
3498
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
3486
3499
  isUser: boolean;
3487
3500
  /** @format date-time */
3488
3501
  createdAt: string;
@@ -3515,7 +3528,7 @@ export interface LosOperationTracking {
3515
3528
  operationType: string;
3516
3529
  correlationKey: string;
3517
3530
  lastTriggerSource?: string | null;
3518
- status: LosOperationTrackingStatusEnum;
3531
+ status: "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
3519
3532
  /** @format date-time */
3520
3533
  createdAt: string;
3521
3534
  /** @format date-time */
@@ -3576,7 +3589,7 @@ export interface LosSyncStep {
3576
3589
  /** @format int32 */
3577
3590
  order: number;
3578
3591
  name: string;
3579
- severity: LosSyncStepSeverityEnum;
3592
+ severity: "Success" | "Info" | "Warning" | "Error";
3580
3593
  message: string;
3581
3594
  /** @format date-time */
3582
3595
  atUtc: string;
@@ -3887,7 +3900,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3887
3900
  }
3888
3901
  export interface Operation {
3889
3902
  op?: string;
3890
- value?: object | null;
3903
+ value?: string | number | boolean | null | object;
3891
3904
  path?: string;
3892
3905
  }
3893
3906
  export interface OverridePasswordRequest {
@@ -4223,7 +4236,7 @@ export interface SSOTokenRequest {
4223
4236
  redirectUri: string;
4224
4237
  }
4225
4238
  export interface SamlMetadataRequest {
4226
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4239
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
4227
4240
  }
4228
4241
  export interface SendForgotPasswordRequest {
4229
4242
  /**
@@ -4274,7 +4287,7 @@ export interface SiteConfiguration {
4274
4287
  deletedAt?: string | null;
4275
4288
  /** @format uuid */
4276
4289
  id: string;
4277
- type: SiteConfigurationTypeEnum;
4290
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4278
4291
  /** @format uuid */
4279
4292
  entityID: string;
4280
4293
  /** @format int32 */
@@ -4468,7 +4481,7 @@ export interface SiteConfigurationByUrl {
4468
4481
  deletedAt?: string | null;
4469
4482
  /** @format uuid */
4470
4483
  id: string;
4471
- type: SiteConfigurationByUrlTypeEnum;
4484
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4472
4485
  /** @format uuid */
4473
4486
  entityID: string;
4474
4487
  /** @format int32 */
@@ -4679,7 +4692,7 @@ export interface SiteConfigurationForm {
4679
4692
  export interface SiteConfigurationReduced {
4680
4693
  /** @format uuid */
4681
4694
  id: string;
4682
- type: SiteConfigurationReducedTypeEnum;
4695
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4683
4696
  url?: string | null;
4684
4697
  name: string;
4685
4698
  /** @format int64 */
@@ -4696,7 +4709,7 @@ export interface SiteConfigurationRequest {
4696
4709
  entityID: string;
4697
4710
  /** @format int32 */
4698
4711
  entityType: number;
4699
- type: SiteConfigurationRequestTypeEnum;
4712
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4700
4713
  url: string;
4701
4714
  name: string;
4702
4715
  introduction?: string | null;
@@ -4871,7 +4884,7 @@ export interface SiteConfigurationSearchCriteria {
4871
4884
  export interface SiteConfigurationSummary {
4872
4885
  /** @format uuid */
4873
4886
  id: string;
4874
- type: SiteConfigurationSummaryTypeEnum;
4887
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4875
4888
  url?: string | null;
4876
4889
  name: string;
4877
4890
  /** @format int64 */
@@ -5487,7 +5500,7 @@ export interface UserDevice {
5487
5500
  export interface UserDraft {
5488
5501
  /** @format uuid */
5489
5502
  draftID: string;
5490
- role: UserDraftRoleEnum;
5503
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5491
5504
  user: User;
5492
5505
  }
5493
5506
  export interface UserDraftPaginated {
@@ -5511,7 +5524,7 @@ export interface UserGroupAccessScope {
5511
5524
  id: string;
5512
5525
  /** @format uuid */
5513
5526
  groupId: string;
5514
- scopeType: UserGroupAccessScopeScopeTypeEnum;
5527
+ scopeType: "User" | "Branch";
5515
5528
  /** @format uuid */
5516
5529
  userId?: string | null;
5517
5530
  /** @format uuid */
@@ -5544,7 +5557,7 @@ export interface UserLoan {
5544
5557
  deletedAt?: string | null;
5545
5558
  loanID: string;
5546
5559
  user: User;
5547
- role: UserLoanRoleEnum;
5560
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5548
5561
  /** @format int32 */
5549
5562
  borrowerPair?: number | null;
5550
5563
  /** @format int32 */
@@ -5556,11 +5569,11 @@ export interface UserLoanConsent {
5556
5569
  id: string;
5557
5570
  /** @format uuid */
5558
5571
  userLoanID: string;
5559
- type: UserLoanConsentTypeEnum;
5572
+ type: "Econsent" | "CreditAuthorization" | "Tcpa";
5560
5573
  providedConsent: boolean;
5561
5574
  source?: ConsentSource | null;
5562
5575
  ipAddress?: string | null;
5563
- losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5576
+ losSyncStatus: "NotStarted" | "Failed" | "Success";
5564
5577
  /** @format date-time */
5565
5578
  createdAt: string;
5566
5579
  /** @format date-time */
@@ -5701,7 +5714,7 @@ export interface UserSummary {
5701
5714
  id: string;
5702
5715
  name?: string | null;
5703
5716
  email?: string | null;
5704
- role: UserSummaryRoleEnum;
5717
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5705
5718
  }
5706
5719
  export interface VerifyPasswordRequest {
5707
5720
  /**
@@ -5734,70 +5747,6 @@ export interface Workflow {
5734
5747
  tileSubtitle: string;
5735
5748
  icon: string;
5736
5749
  }
5737
- export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5738
- export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated";
5739
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5740
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5741
- export type CreateCustomFieldDefinitionRequestDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5742
- export type CreateCustomFieldDefinitionRequestEntityTypeEnum = "Loan";
5743
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5744
- /** @deprecated */
5745
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5746
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5747
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5748
- export type CustomFieldDefinitionDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5749
- export type CustomFieldDefinitionEntityTypeEnum = "Loan";
5750
- export type CustomFieldEntryDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5751
- export type CustomFieldPermissionRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5752
- export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5753
- export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5754
- export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
5755
- export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
5756
- export type DraftTypeEnum = "NewLoan" | "EditLoan";
5757
- export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5758
- export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5759
- export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5760
- export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5761
- export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5762
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5763
- 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";
5764
- export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5765
- export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5766
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5767
- export type LoanDocumentFolderPermissionRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5768
- export type LoanDocumentFolderPermissionLevelEnum = "None" | "Read" | "Write" | "Manage";
5769
- export type LoanDocumentFolderPermissionRequestRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5770
- export type LoanDocumentFolderPermissionRequestLevelEnum = "None" | "Read" | "Write" | "Manage";
5771
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5772
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5773
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5774
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5775
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5776
- export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5777
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent";
5778
- export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
5779
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5780
- export type LosOperationTrackingStatusEnum = "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure" | "Locked";
5781
- export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
5782
- export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5783
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5784
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5785
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5786
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5787
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5788
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5789
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5790
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
5791
- export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5792
- export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5793
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5794
- export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
5795
- /** @default "Realtor" */
5796
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5797
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5798
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5799
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5800
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5801
5750
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5802
5751
  export type QueryParamsType = Record<string | number, any>;
5803
5752
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5821,6 +5770,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5821
5770
  format?: ResponseType;
5822
5771
  }
5823
5772
  export declare enum ContentType {
5773
+ JsonPatch = "application/json-patch+json",
5824
5774
  Json = "application/json",
5825
5775
  JsonApi = "application/vnd.api+json",
5826
5776
  FormData = "multipart/form-data",
@@ -5842,7 +5792,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5842
5792
  }
5843
5793
  /**
5844
5794
  * @title The Big POS API
5845
- * @version v2.40.5
5795
+ * @version v2.41.0
5846
5796
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5847
5797
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5848
5798
  */
@@ -6527,7 +6477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6527
6477
  * @response `200` `(CustomFieldDefinition)[]` Success
6528
6478
  */
6529
6479
  getCustomFieldDefinitions: (query?: {
6530
- entityType?: GetCustomFieldDefinitionsParamsEntityTypeEnum;
6480
+ entityType?: "Loan";
6531
6481
  }, params?: RequestParams) => Promise<AxiosResponse<CustomFieldDefinition[], any, {}>>;
6532
6482
  /**
6533
6483
  * No description
@@ -7296,6 +7246,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7296
7246
  * @response `200` `FormVersion` Success
7297
7247
  */
7298
7248
  deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
7249
+ /**
7250
+ * No description
7251
+ *
7252
+ * @tags IntegrationSettings
7253
+ * @name GetIntegrationSettings
7254
+ * @summary Get Integration Settings
7255
+ * @request GET:/api/integrations/settings
7256
+ * @secure
7257
+ * @response `200` `IntegrationSettings` Success
7258
+ */
7259
+ getIntegrationSettings: (params?: RequestParams) => Promise<AxiosResponse<IntegrationSettings, any, {}>>;
7299
7260
  /**
7300
7261
  * No description
7301
7262
  *
@@ -9223,7 +9184,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9223
9184
  getPartners: (query?: {
9224
9185
  showAll?: boolean;
9225
9186
  /** @default "Realtor" */
9226
- role?: GetPartnersParamsRoleEnum;
9187
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
9227
9188
  /** @format int32 */
9228
9189
  pageSize?: number;
9229
9190
  /** @format int32 */
@@ -9401,7 +9362,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9401
9362
  * @response `200` `File` Success
9402
9363
  * @response `404` `ProblemDetails` Not Found
9403
9364
  */
9404
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9365
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9405
9366
  /**
9406
9367
  * No description
9407
9368
  *
@@ -9412,7 +9373,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9412
9373
  * @secure
9413
9374
  * @response `200` `File` Success
9414
9375
  */
9415
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9376
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any, {}>>;
9416
9377
  /**
9417
9378
  * No description
9418
9379
  *