@matech/thebigpos-sdk 2.38.0 → 2.38.2-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
@@ -1,11 +1,14 @@
1
1
  export type VersionStatusType = "Draft" | "Published";
2
2
  export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
3
+ export type TaskStatus = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
3
4
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5
+ export type SigningMethod = "ConsumerConnect" | "POSF";
4
6
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
5
7
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
6
8
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
7
9
  export type LoanTrustType = "Living" | "Land" | "Testamentary" | "Other";
8
10
  export type LoanTitleHeld = "Sole" | "JointWithSpouse" | "JointWithOtherThanSpouse";
11
+ export type LoanTaskActivityFilter = "Active" | "Inactive" | "All";
9
12
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
10
13
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
11
14
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
@@ -23,7 +26,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
23
26
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
24
27
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
25
28
  export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
26
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
29
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
27
30
  export type LoanLienPosition = "First" | "Subordinate";
28
31
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
29
32
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
@@ -48,6 +51,7 @@ export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "R
48
51
  export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
49
52
  export type EncompassLogOperationType = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
50
53
  export type DraftType = "NewLoan" | "EditLoan";
54
+ export type ConsumerConnectAssociationStatus = "Legacy" | "Pending" | "Success" | "Failed" | "ConfigurationError" | "PermanentFailure";
51
55
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
52
56
  export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
53
57
  export type BranchType = "Mortgage" | "RealEstate";
@@ -106,7 +110,7 @@ export interface AccountBilling {
106
110
  contractedRate: number;
107
111
  }
108
112
  export interface AccountBillingRequest {
109
- billingType: "ClosedLoan" | "LoanOfficer";
113
+ billingType: AccountBillingRequestBillingTypeEnum;
110
114
  /**
111
115
  * @format double
112
116
  * @min 0
@@ -418,11 +422,15 @@ export interface Attachment {
418
422
  fileName: string;
419
423
  base64Data: string;
420
424
  }
425
+ export interface AuditEntityType {
426
+ entityType: string;
427
+ rootEntityType?: string | null;
428
+ }
421
429
  export interface AuditLogEntry {
422
430
  /** @format uuid */
423
431
  id: string;
424
432
  entityType: string;
425
- changeType: "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
433
+ changeType: AuditLogEntryChangeTypeEnum;
426
434
  /** @format uuid */
427
435
  entityId: string;
428
436
  performedBy?: AuditLogUser | null;
@@ -450,9 +458,6 @@ export interface AuditLogSearchCriteria {
450
458
  startDate?: string | null;
451
459
  /** @format date-time */
452
460
  endDate?: string | null;
453
- rootEntityType?: string | null;
454
- /** @format uuid */
455
- rootEntityId?: string | null;
456
461
  }
457
462
  export interface AuditLogUser {
458
463
  /** @format uuid */
@@ -638,6 +643,28 @@ export interface ConditionComment {
638
643
  createdBy: string;
639
644
  createdByName: string;
640
645
  }
646
+ export interface ConsumerConnectRetry {
647
+ /** @format uuid */
648
+ userLoanId: string;
649
+ email: string;
650
+ status?: ConsumerConnectAssociationStatus | null;
651
+ success: boolean;
652
+ }
653
+ export interface ConsumerConnectStatus {
654
+ /** @format uuid */
655
+ userLoanId: string;
656
+ /** @format uuid */
657
+ userId: string;
658
+ email: string;
659
+ role: ConsumerConnectStatusRoleEnum;
660
+ status?: ConsumerConnectAssociationStatus | null;
661
+ /** @format int32 */
662
+ attemptCount: number;
663
+ /** @format date-time */
664
+ lastAttemptAt?: string | null;
665
+ /** @format date-time */
666
+ nextRetryAt?: string | null;
667
+ }
641
668
  export interface ContactInfo {
642
669
  phone: string;
643
670
  tollFreePhone?: string | null;
@@ -686,7 +713,7 @@ export interface CorporateSearchCriteria {
686
713
  isActive?: boolean | null;
687
714
  }
688
715
  export interface CreateAccessScopeRequest {
689
- scopeType: "User" | "Branch";
716
+ scopeType: CreateAccessScopeRequestScopeTypeEnum;
690
717
  /** @format uuid */
691
718
  userId?: string | null;
692
719
  /** @format uuid */
@@ -709,7 +736,7 @@ export interface CreateAccountRequest {
709
736
  */
710
737
  nlmsid: number;
711
738
  settings: AccountSettingsRequest;
712
- environment: "Development" | "Staging" | "UAT" | "Production";
739
+ environment: CreateAccountRequestEnvironmentEnum;
713
740
  losIntegration: LOSIntegration;
714
741
  billingSettings: AccountBillingRequest;
715
742
  }
@@ -739,7 +766,7 @@ export interface CreateDocumentTemplateRequest {
739
766
  export interface CreateGroupMemberRequest {
740
767
  /** @format uuid */
741
768
  userId: string;
742
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
769
+ loanRole: CreateGroupMemberRequestLoanRoleEnum;
743
770
  }
744
771
  export interface CreateInviteRequest {
745
772
  /** @minLength 1 */
@@ -750,7 +777,7 @@ export interface CreateInviteRequest {
750
777
  emailAddress: string;
751
778
  phoneNumber?: string | null;
752
779
  /** @deprecated */
753
- relationship: "NotApplicable" | "Spouse" | "NonSpouse";
780
+ relationship: CreateInviteRequestRelationshipEnum;
754
781
  loanID: string;
755
782
  route?: string | null;
756
783
  /** @format uuid */
@@ -772,7 +799,7 @@ export interface CreateLoanImportRequest {
772
799
  * @minLength 1
773
800
  */
774
801
  startDate: string;
775
- importMode: "All" | "NewOnly" | "UpdateOnly";
802
+ importMode: CreateLoanImportRequestImportModeEnum;
776
803
  }
777
804
  export interface CreateSession {
778
805
  sessionId: string;
@@ -790,7 +817,7 @@ export interface CreateUserDeviceRequest {
790
817
  token: string;
791
818
  }
792
819
  export interface CreateUserDraft {
793
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
820
+ loanRole: CreateUserDraftLoanRoleEnum;
794
821
  }
795
822
  export interface CreateUserGroupRequest {
796
823
  /**
@@ -842,6 +869,9 @@ export interface CreateUserRequest {
842
869
  userRole: string;
843
870
  isInternal?: boolean | null;
844
871
  }
872
+ export interface CreateWebhookRequest {
873
+ webhookPath: string;
874
+ }
845
875
  export interface CustomLoanData {
846
876
  eConsentInformation?: EConsentInformation | null;
847
877
  }
@@ -1084,7 +1114,7 @@ export interface Draft {
1084
1114
  siteConfiguration: SiteConfigurationReduced;
1085
1115
  /** @format uuid */
1086
1116
  loanID?: string | null;
1087
- type: "NewLoan" | "EditLoan";
1117
+ type: DraftTypeEnum;
1088
1118
  isCoBorrower: boolean;
1089
1119
  }
1090
1120
  export interface DraftContent {
@@ -1102,7 +1132,7 @@ export interface DraftContent {
1102
1132
  siteConfiguration: SiteConfigurationReduced;
1103
1133
  /** @format uuid */
1104
1134
  loanID?: string | null;
1105
- type: "NewLoan" | "EditLoan";
1135
+ type: DraftContentTypeEnum;
1106
1136
  isCoBorrower: boolean;
1107
1137
  applicationPayload: any;
1108
1138
  }
@@ -1182,6 +1212,40 @@ export interface EncompassContact {
1182
1212
  phone?: string | null;
1183
1213
  company?: string | null;
1184
1214
  }
1215
+ export interface EncompassCredentialsDetail {
1216
+ /** @format uuid */
1217
+ id: string;
1218
+ /** @format uuid */
1219
+ accountID: string;
1220
+ instanceID: string;
1221
+ loanAssignmentRole?: string | null;
1222
+ loanTemplate?: string | null;
1223
+ defaultLoanOfficerUserName?: string | null;
1224
+ clearStateIfUnlicensed: boolean;
1225
+ baseUrl?: string | null;
1226
+ signingMethod: EncompassCredentialsDetailSigningMethodEnum;
1227
+ subscriptionId?: string | null;
1228
+ environment?: string | null;
1229
+ }
1230
+ export interface EncompassCredentialsRequest {
1231
+ /** @format uuid */
1232
+ id: string;
1233
+ /** @format uuid */
1234
+ accountID: string;
1235
+ instanceID: string;
1236
+ loanAssignmentRole?: string | null;
1237
+ loanTemplate?: string | null;
1238
+ defaultLoanOfficerUserName?: string | null;
1239
+ clearStateIfUnlicensed: boolean;
1240
+ baseUrl?: string | null;
1241
+ signingMethod: EncompassCredentialsRequestSigningMethodEnum;
1242
+ subscriptionId?: string | null;
1243
+ environment?: string | null;
1244
+ clientID?: string | null;
1245
+ clientSecret?: string | null;
1246
+ signingKeyId?: string | null;
1247
+ signingKey?: string | null;
1248
+ }
1185
1249
  export interface EncompassError {
1186
1250
  errorCode: string;
1187
1251
  message: string;
@@ -1232,8 +1296,8 @@ export interface EncompassRequestLog {
1232
1296
  losId?: string | null;
1233
1297
  /** @format uuid */
1234
1298
  accountId: string;
1235
- operationType: "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
1236
- outcome: "Success" | "Failure" | "PartialSuccess";
1299
+ operationType: EncompassRequestLogOperationTypeEnum;
1300
+ outcome: EncompassRequestLogOutcomeEnum;
1237
1301
  message: string;
1238
1302
  endpoint?: string | null;
1239
1303
  httpMethod?: string | null;
@@ -1284,7 +1348,7 @@ export interface FileSearchCriteria {
1284
1348
  export interface FileWithBytes {
1285
1349
  name: string;
1286
1350
  /** @format byte */
1287
- data: string;
1351
+ data: Blob;
1288
1352
  fileName: string;
1289
1353
  mimeType?: string | null;
1290
1354
  extension?: string | null;
@@ -1450,7 +1514,7 @@ export interface FusionFieldDisplay {
1450
1514
  fieldValue: string;
1451
1515
  }
1452
1516
  export interface FusionReportFilter {
1453
- filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1517
+ filterType: FusionReportFilterFilterTypeEnum;
1454
1518
  targetField: string;
1455
1519
  targetValue: string;
1456
1520
  }
@@ -1564,7 +1628,7 @@ export interface GuidPatchOperation {
1564
1628
  from?: string | null;
1565
1629
  }
1566
1630
  export interface IPAddress {
1567
- 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";
1631
+ addressFamily: IpAddressAddressFamilyEnum;
1568
1632
  /** @format int64 */
1569
1633
  scopeId: number;
1570
1634
  isIPv6Multicast: boolean;
@@ -1817,6 +1881,7 @@ export interface Loan {
1817
1881
  nonOwningBorrowers: LoanNonOwningBorrower[];
1818
1882
  userLoans: UserLoan[];
1819
1883
  contacts: LoanContact[];
1884
+ signingMethod: LoanSigningMethodEnum;
1820
1885
  }
1821
1886
  export interface LoanApplication {
1822
1887
  /** @format uuid */
@@ -1871,7 +1936,7 @@ export interface LoanBorrower {
1871
1936
  citizenship?: LoanCitizenship | null;
1872
1937
  maritalStatus?: LoanMaritalStatus | null;
1873
1938
  languagePreference?: LoanLanguagePreference | null;
1874
- applicationStatus: "Draft" | "Complete";
1939
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
1875
1940
  /** @format int32 */
1876
1941
  numberOfDependents?: number | null;
1877
1942
  isPrimaryBorrower: boolean;
@@ -2728,7 +2793,7 @@ export interface LoanContact {
2728
2793
  email?: string | null;
2729
2794
  phone?: string | null;
2730
2795
  companyName?: string | null;
2731
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
2796
+ role: LoanContactRoleEnum;
2732
2797
  }
2733
2798
  export interface LoanContactList {
2734
2799
  email: string;
@@ -2839,6 +2904,7 @@ export interface LoanIdentifier {
2839
2904
  /** @format uuid */
2840
2905
  id: string;
2841
2906
  losLoanID: string;
2907
+ number?: string | null;
2842
2908
  }
2843
2909
  export interface LoanImport {
2844
2910
  /** @format uuid */
@@ -2853,13 +2919,13 @@ export interface LoanImport {
2853
2919
  /** @format int32 */
2854
2920
  importedCount: number;
2855
2921
  statusMessage?: string | null;
2856
- status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
2857
- importMode: "All" | "NewOnly" | "UpdateOnly";
2922
+ status: LoanImportStatusEnum;
2923
+ importMode: LoanImportImportModeEnum;
2858
2924
  /** @format date-time */
2859
2925
  createdAt?: string | null;
2860
2926
  }
2861
2927
  export interface LoanImportLog {
2862
- level: "None" | "Info" | "Warning" | "Error";
2928
+ level: LoanImportLogLevelEnum;
2863
2929
  message: string;
2864
2930
  /** @format date-time */
2865
2931
  createdAt: string;
@@ -2914,8 +2980,8 @@ export interface LoanListPaginated {
2914
2980
  export interface LoanLog {
2915
2981
  /** @format uuid */
2916
2982
  id: string;
2917
- level: "None" | "Info" | "Warning" | "Error";
2918
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2983
+ level: LoanLogLevelEnum;
2984
+ type: LoanLogTypeEnum;
2919
2985
  message: string;
2920
2986
  /** @format date-time */
2921
2987
  createdAt: string;
@@ -2923,8 +2989,8 @@ export interface LoanLog {
2923
2989
  export interface LoanLogDetail {
2924
2990
  /** @format uuid */
2925
2991
  id: string;
2926
- level: "None" | "Info" | "Warning" | "Error";
2927
- type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
2992
+ level: LoanLogDetailLevelEnum;
2993
+ type: LoanLogDetailTypeEnum;
2928
2994
  message: string;
2929
2995
  /** @format date-time */
2930
2996
  createdAt: string;
@@ -3179,6 +3245,16 @@ export interface LoanSearchCriteria {
3179
3245
  export interface LoanSettings {
3180
3246
  excludeFromAutoTaskReminders: boolean;
3181
3247
  }
3248
+ export interface LoanTaskSearchRequest {
3249
+ searchText?: string | null;
3250
+ statuses?: TaskStatus[] | null;
3251
+ loanNumber?: string | null;
3252
+ /** @format uuid */
3253
+ borrowerId?: string | null;
3254
+ /** @format uuid */
3255
+ loanId?: string | null;
3256
+ loanStatus?: LoanTaskActivityFilter | null;
3257
+ }
3182
3258
  export interface LoanUser {
3183
3259
  /** @format uuid */
3184
3260
  id: string;
@@ -3187,11 +3263,18 @@ export interface LoanUser {
3187
3263
  email: string;
3188
3264
  phone?: string | null;
3189
3265
  role: string;
3190
- loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3266
+ loanRole: LoanUserLoanRoleEnum;
3191
3267
  isUser: boolean;
3192
3268
  /** @format date-time */
3193
3269
  createdAt: string;
3194
3270
  }
3271
+ export interface LosCredentials {
3272
+ /** @format uuid */
3273
+ id: string;
3274
+ /** @format uuid */
3275
+ accountID: string;
3276
+ instanceID: string;
3277
+ }
3195
3278
  export interface LosLoanCreationRequest {
3196
3279
  loanOfficerUserName?: string | null;
3197
3280
  loanTemplate?: string | null;
@@ -3203,6 +3286,14 @@ export interface LosLoanCreationRequest {
3203
3286
  siteID?: string | null;
3204
3287
  existingLoanID?: string | null;
3205
3288
  }
3289
+ export interface LosWebhook {
3290
+ /** @format uuid */
3291
+ id: string;
3292
+ endpoint: string;
3293
+ resource: string;
3294
+ events: string[];
3295
+ enableSubscription: boolean;
3296
+ }
3206
3297
  export interface MdmUser {
3207
3298
  user_email?: string | null;
3208
3299
  user_id?: string | null;
@@ -3810,7 +3901,7 @@ export interface SSOTokenRequest {
3810
3901
  redirectUri: string;
3811
3902
  }
3812
3903
  export interface SamlMetadataRequest {
3813
- ssoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF";
3904
+ ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
3814
3905
  }
3815
3906
  export interface SendForgotPasswordRequest {
3816
3907
  /**
@@ -3845,7 +3936,7 @@ export interface SiteConfiguration {
3845
3936
  deletedAt?: string | null;
3846
3937
  /** @format uuid */
3847
3938
  id: string;
3848
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3939
+ type: SiteConfigurationTypeEnum;
3849
3940
  /** @format uuid */
3850
3941
  entityID: string;
3851
3942
  /** @format int32 */
@@ -4039,7 +4130,7 @@ export interface SiteConfigurationByUrl {
4039
4130
  deletedAt?: string | null;
4040
4131
  /** @format uuid */
4041
4132
  id: string;
4042
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4133
+ type: SiteConfigurationByUrlTypeEnum;
4043
4134
  /** @format uuid */
4044
4135
  entityID: string;
4045
4136
  /** @format int32 */
@@ -4250,7 +4341,7 @@ export interface SiteConfigurationForm {
4250
4341
  export interface SiteConfigurationReduced {
4251
4342
  /** @format uuid */
4252
4343
  id: string;
4253
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4344
+ type: SiteConfigurationReducedTypeEnum;
4254
4345
  url?: string | null;
4255
4346
  name: string;
4256
4347
  /** @format int64 */
@@ -4267,7 +4358,7 @@ export interface SiteConfigurationRequest {
4267
4358
  entityID: string;
4268
4359
  /** @format int32 */
4269
4360
  entityType: number;
4270
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4361
+ type: SiteConfigurationRequestTypeEnum;
4271
4362
  url: string;
4272
4363
  name: string;
4273
4364
  introduction?: string | null;
@@ -4442,7 +4533,7 @@ export interface SiteConfigurationSearchCriteria {
4442
4533
  export interface SiteConfigurationSummary {
4443
4534
  /** @format uuid */
4444
4535
  id: string;
4445
- type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
4536
+ type: SiteConfigurationSummaryTypeEnum;
4446
4537
  url?: string | null;
4447
4538
  name: string;
4448
4539
  /** @format int64 */
@@ -5021,7 +5112,7 @@ export interface UserDevice {
5021
5112
  export interface UserDraft {
5022
5113
  /** @format uuid */
5023
5114
  draftID: string;
5024
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5115
+ role: UserDraftRoleEnum;
5025
5116
  user: User;
5026
5117
  }
5027
5118
  export interface UserDraftPaginated {
@@ -5045,7 +5136,7 @@ export interface UserGroupAccessScope {
5045
5136
  id: string;
5046
5137
  /** @format uuid */
5047
5138
  groupId: string;
5048
- scopeType: "User" | "Branch";
5139
+ scopeType: UserGroupAccessScopeScopeTypeEnum;
5049
5140
  /** @format uuid */
5050
5141
  userId?: string | null;
5051
5142
  /** @format uuid */
@@ -5078,7 +5169,7 @@ export interface UserLoan {
5078
5169
  deletedAt?: string | null;
5079
5170
  loanID: string;
5080
5171
  user: User;
5081
- role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5172
+ role: UserLoanRoleEnum;
5082
5173
  /** @format int32 */
5083
5174
  borrowerPair?: number | null;
5084
5175
  /** @format int32 */
@@ -5090,10 +5181,10 @@ export interface UserLoanConsent {
5090
5181
  id: string;
5091
5182
  /** @format uuid */
5092
5183
  userLoanID: string;
5093
- type: "Econsent" | "CreditAuthorization" | "Tcpa";
5184
+ type: UserLoanConsentTypeEnum;
5094
5185
  providedConsent: boolean;
5095
5186
  ipAddress?: string | null;
5096
- losSyncStatus: "NotStarted" | "Failed" | "Success";
5187
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
5097
5188
  /** @format date-time */
5098
5189
  createdAt: string;
5099
5190
  }
@@ -5108,7 +5199,6 @@ export interface UserLoanTask {
5108
5199
  value?: string | null;
5109
5200
  documents: LoanDocument[];
5110
5201
  loan: LoanIdentifier;
5111
- /** @deprecated */
5112
5202
  loanID: string;
5113
5203
  /** @format date-time */
5114
5204
  completedDate?: string | null;
@@ -5120,6 +5210,12 @@ export interface UserLoanTask {
5120
5210
  /** @format int32 */
5121
5211
  commentsCount: number;
5122
5212
  }
5213
+ export interface UserLoanTaskPaginated {
5214
+ rows: UserLoanTask[];
5215
+ pagination: Pagination;
5216
+ /** @format int64 */
5217
+ count: number;
5218
+ }
5123
5219
  export interface UserLoanTaskRequest {
5124
5220
  value?: string | null;
5125
5221
  /**
@@ -5225,7 +5321,7 @@ export interface UserSummary {
5225
5321
  id: string;
5226
5322
  name?: string | null;
5227
5323
  email?: string | null;
5228
- role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5324
+ role: UserSummaryRoleEnum;
5229
5325
  }
5230
5326
  export interface VerifyPasswordRequest {
5231
5327
  /**
@@ -5258,6 +5354,53 @@ export interface Workflow {
5258
5354
  tileSubtitle: string;
5259
5355
  icon: string;
5260
5356
  }
5357
+ export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
5358
+ export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored";
5359
+ export type ConsumerConnectStatusRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5360
+ export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
5361
+ export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
5362
+ export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5363
+ /** @deprecated */
5364
+ export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
5365
+ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5366
+ export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5367
+ export type DraftTypeEnum = "NewLoan" | "EditLoan";
5368
+ export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5369
+ export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
5370
+ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
5371
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5372
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5373
+ export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5374
+ 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";
5375
+ export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
5376
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5377
+ export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5378
+ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5379
+ export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5380
+ export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5381
+ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5382
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
5383
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5384
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation";
5385
+ export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5386
+ export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5387
+ export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5388
+ export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5389
+ export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5390
+ export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5391
+ export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
5392
+ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5393
+ export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5394
+ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5395
+ export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5396
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5397
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5398
+ /** @default "Realtor" */
5399
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5400
+ export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5401
+ export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5402
+ export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5403
+ export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5261
5404
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
5262
5405
  export type QueryParamsType = Record<string | number, any>;
5263
5406
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -5303,7 +5446,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
5303
5446
  }
5304
5447
  /**
5305
5448
  * @title The Big POS API
5306
- * @version v2.38.0
5449
+ * @version v2.38.1
5307
5450
  * @termsOfService https://www.thebigpos.com/terms-of-use/
5308
5451
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
5309
5452
  */
@@ -5459,6 +5602,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5459
5602
  sortBy?: string;
5460
5603
  sortDirection?: string;
5461
5604
  }, params?: RequestParams) => Promise<AxiosResponse<AuditLogEntryPaginated, any>>;
5605
+ /**
5606
+ * No description
5607
+ *
5608
+ * @tags AuditLog
5609
+ * @name GetAuditLogEntityTypes
5610
+ * @summary Get entity types
5611
+ * @request GET:/api/audit-logs/entity-types
5612
+ * @secure
5613
+ * @response `200` `(AuditEntityType)[]` Success
5614
+ */
5615
+ getAuditLogEntityTypes: (params?: RequestParams) => Promise<AxiosResponse<AuditEntityType[], any>>;
5462
5616
  /**
5463
5617
  * No description
5464
5618
  *
@@ -5768,6 +5922,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5768
5922
  * @response `200` `ClosedLoansReport` Success
5769
5923
  */
5770
5924
  getClosedLoansReport: (data: ClosedLoansReportRequest, params?: RequestParams) => Promise<AxiosResponse<ClosedLoansReport, any>>;
5925
+ /**
5926
+ * No description
5927
+ *
5928
+ * @tags ConsumerConnect
5929
+ * @name GetConsumerConnectStatus
5930
+ * @summary Get Consumer Connect association status for all borrowers on a loan
5931
+ * @request GET:/api/loans/{loanId}/consumer-connect/status
5932
+ * @secure
5933
+ * @response `200` `(ConsumerConnectStatus)[]` Success
5934
+ */
5935
+ getConsumerConnectStatus: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<ConsumerConnectStatus[], any>>;
5936
+ /**
5937
+ * No description
5938
+ *
5939
+ * @tags ConsumerConnect
5940
+ * @name RetryConsumerConnectAssociation
5941
+ * @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
5942
+ * @request POST:/api/loans/{loanId}/consumer-connect/retry
5943
+ * @secure
5944
+ * @response `200` `(ConsumerConnectRetry)[]` Success
5945
+ */
5946
+ retryConsumerConnectAssociation: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<ConsumerConnectRetry[], any>>;
5771
5947
  /**
5772
5948
  * No description
5773
5949
  *
@@ -7084,10 +7260,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7084
7260
  * @summary Download By ID
7085
7261
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
7086
7262
  * @secure
7087
- * @response `200` `string` Success
7263
+ * @response `200` `Blob` Success
7088
7264
  * @response `404` `ProblemDetails` Not Found
7089
7265
  */
7090
- downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any>>;
7266
+ downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any>>;
7091
7267
  /**
7092
7268
  * No description
7093
7269
  *
@@ -7745,9 +7921,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7745
7921
  */
7746
7922
  sendOutstandingLoanTaskNotification: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
7747
7923
  /**
7748
- * No description
7924
+ * @description Search tasks across all loans
7749
7925
  *
7750
7926
  * @tags LoanTasks
7927
+ * @name SearchLoanTasks
7928
+ * @summary Search
7929
+ * @request POST:/api/loans/tasks/search
7930
+ * @secure
7931
+ * @response `200` `UserLoanTaskPaginated` Success
7932
+ */
7933
+ searchLoanTasks: (data: LoanTaskSearchRequest, query?: {
7934
+ /** @format int32 */
7935
+ pageSize?: number;
7936
+ /** @format int32 */
7937
+ pageNumber?: number;
7938
+ sortBy?: string;
7939
+ sortDirection?: string;
7940
+ }, params?: RequestParams) => Promise<AxiosResponse<UserLoanTaskPaginated, any>>;
7941
+ /**
7942
+ * No description
7943
+ *
7944
+ * @tags LoanTasksForSingleLoan
7751
7945
  * @name GetLoanTasks
7752
7946
  * @summary Get All
7753
7947
  * @request GET:/api/loans/{loanID}/tasks
@@ -7759,7 +7953,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7759
7953
  /**
7760
7954
  * No description
7761
7955
  *
7762
- * @tags LoanTasks
7956
+ * @tags LoanTasksForSingleLoan
7763
7957
  * @name GetLoanTask
7764
7958
  * @summary Get by ID
7765
7959
  * @request GET:/api/loans/{loanID}/tasks/{id}
@@ -7771,7 +7965,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7771
7965
  /**
7772
7966
  * @description Get the difference between the current loan tasks and the tasks generated by business rules
7773
7967
  *
7774
- * @tags LoanTasks
7968
+ * @tags LoanTasksForSingleLoan
7775
7969
  * @name GetLoanTaskDifference
7776
7970
  * @summary Get Difference
7777
7971
  * @request GET:/api/loans/{loanID}/tasks/diff
@@ -7783,7 +7977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7783
7977
  /**
7784
7978
  * No description
7785
7979
  *
7786
- * @tags LoanTasks
7980
+ * @tags LoanTasksForSingleLoan
7787
7981
  * @name CreateLoanTask
7788
7982
  * @summary Create
7789
7983
  * @request POST:/api/loans/{loanID}/tasks/{taskID}
@@ -7795,7 +7989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7795
7989
  /**
7796
7990
  * No description
7797
7991
  *
7798
- * @tags LoanTasks
7992
+ * @tags LoanTasksForSingleLoan
7799
7993
  * @name ImportLoanTask
7800
7994
  * @summary Import
7801
7995
  * @request POST:/api/loans/{loanID}/tasks/import
@@ -7807,7 +8001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7807
8001
  /**
7808
8002
  * No description
7809
8003
  *
7810
- * @tags LoanTasks
8004
+ * @tags LoanTasksForSingleLoan
7811
8005
  * @name ReplaceLoanTask
7812
8006
  * @summary Replace
7813
8007
  * @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
@@ -7819,7 +8013,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7819
8013
  /**
7820
8014
  * No description
7821
8015
  *
7822
- * @tags LoanTasks
8016
+ * @tags LoanTasksForSingleLoan
7823
8017
  * @name DeleteLoanTask
7824
8018
  * @summary Delete
7825
8019
  * @request DELETE:/api/loans/{loanID}/tasks/{userLoanTaskID}
@@ -8184,7 +8378,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8184
8378
  getPartners: (query?: {
8185
8379
  showAll?: boolean;
8186
8380
  /** @default "Realtor" */
8187
- role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
8381
+ role?: GetPartnersParamsRoleEnum;
8188
8382
  /** @format int32 */
8189
8383
  pageSize?: number;
8190
8384
  /** @format int32 */
@@ -8362,7 +8556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8362
8556
  * @response `200` `File` Success
8363
8557
  * @response `404` `ProblemDetails` Not Found
8364
8558
  */
8365
- getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
8559
+ getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
8366
8560
  /**
8367
8561
  * No description
8368
8562
  *
@@ -8373,7 +8567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8373
8567
  * @secure
8374
8568
  * @response `200` `File` Success
8375
8569
  */
8376
- createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS" | "POSF", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
8570
+ createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
8377
8571
  /**
8378
8572
  * No description
8379
8573
  *
@@ -8569,6 +8763,67 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8569
8763
  sortBy?: string;
8570
8764
  sortDirection?: string;
8571
8765
  }, data: EncompassLogSearchCriteria, params?: RequestParams) => Promise<AxiosResponse<EncompassRequestLogPaginated, any>>;
8766
+ /**
8767
+ * No description
8768
+ *
8769
+ * @tags TheBigPOS
8770
+ * @name GetEncompassCredentials
8771
+ * @request GET:/api/los/encompass/credentials
8772
+ * @secure
8773
+ * @response `200` `EncompassCredentialsDetail` Success
8774
+ * @response `204` `void` No Content
8775
+ */
8776
+ getEncompassCredentials: (params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any>>;
8777
+ /**
8778
+ * No description
8779
+ *
8780
+ * @tags TheBigPOS
8781
+ * @name CreateEncompassCredentials
8782
+ * @request POST:/api/los/encompass/credentials
8783
+ * @secure
8784
+ * @response `201` `LosCredentials` Created
8785
+ */
8786
+ createEncompassCredentials: (data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<LosCredentials, any>>;
8787
+ /**
8788
+ * No description
8789
+ *
8790
+ * @tags TheBigPOS
8791
+ * @name UpdateEncompassCredentials
8792
+ * @request PUT:/api/los/encompass/credentials
8793
+ * @secure
8794
+ * @response `200` `EncompassCredentialsDetail` Success
8795
+ */
8796
+ updateEncompassCredentials: (data: EncompassCredentialsRequest, params?: RequestParams) => Promise<AxiosResponse<EncompassCredentialsDetail, any>>;
8797
+ /**
8798
+ * No description
8799
+ *
8800
+ * @tags TheBigPOS
8801
+ * @name GetEncompassWebhooks
8802
+ * @request GET:/api/los/encompass/webhooks
8803
+ * @secure
8804
+ * @response `200` `(LosWebhook)[]` Success
8805
+ */
8806
+ getEncompassWebhooks: (params?: RequestParams) => Promise<AxiosResponse<LosWebhook[], any>>;
8807
+ /**
8808
+ * No description
8809
+ *
8810
+ * @tags TheBigPOS
8811
+ * @name CreateEncompassWebhook
8812
+ * @request POST:/api/los/encompass/webhooks
8813
+ * @secure
8814
+ * @response `201` `LosWebhook` Created
8815
+ */
8816
+ createEncompassWebhook: (data: CreateWebhookRequest, params?: RequestParams) => Promise<AxiosResponse<LosWebhook, any>>;
8817
+ /**
8818
+ * No description
8819
+ *
8820
+ * @tags TheBigPOS
8821
+ * @name DeleteEncompassWebhook
8822
+ * @request DELETE:/api/los/encompass/webhooks/{webhookId}
8823
+ * @secure
8824
+ * @response `204` `void` No Content
8825
+ */
8826
+ deleteEncompassWebhook: (webhookId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
8572
8827
  /**
8573
8828
  * No description
8574
8829
  *