@matech/thebigpos-sdk 2.26.2 → 2.27.0-eclose

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/.husky/pre-commit CHANGED
@@ -1,3 +1 @@
1
- [ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
2
- yarn build
3
- git add .
1
+ yarn build
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2024 Mortgage Automation Technologies
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Mortgage Automation Technologies
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,44 +1,44 @@
1
- # The BIG POS Typescript SDK
2
-
3
- ## Installation
4
- Using npm:
5
-
6
- ```bash
7
- $ npm install @matech/thebigpos-sdk
8
- ```
9
-
10
- Using yarn:
11
-
12
- ```bash
13
- $ yarn add @matech/thebigpos-sdk
14
- ```
15
-
16
- ## Quick Start
17
- ```js
18
- import { Api } from "@matech/thebigpos-sdk";
19
-
20
- const securityWorker = (data: any) => {
21
- return { headers: data }
22
- }
23
-
24
- const setBearerSecurityWorker = (accessToken:string) => {
25
- const data = {
26
- Authorization: `Bearer ${accessToken}`
27
- };
28
-
29
- apiClient.setSecurityData(data);
30
- };
31
-
32
- const apiClient = new Api({
33
- baseURL:
34
- process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
35
- securityWorker,
36
- })
37
-
38
- apiClient.api.getSiteConfiguration().then((response) => {
39
- console.log(response.data);
40
- });
41
- ```
42
-
43
- ____
44
- © 2024 Mortgage Automation Technologies. All rights reserved
1
+ # The BIG POS Typescript SDK
2
+
3
+ ## Installation
4
+ Using npm:
5
+
6
+ ```bash
7
+ $ npm install @matech/thebigpos-sdk
8
+ ```
9
+
10
+ Using yarn:
11
+
12
+ ```bash
13
+ $ yarn add @matech/thebigpos-sdk
14
+ ```
15
+
16
+ ## Quick Start
17
+ ```js
18
+ import { Api } from "@matech/thebigpos-sdk";
19
+
20
+ const securityWorker = (data: any) => {
21
+ return { headers: data }
22
+ }
23
+
24
+ const setBearerSecurityWorker = (accessToken:string) => {
25
+ const data = {
26
+ Authorization: `Bearer ${accessToken}`
27
+ };
28
+
29
+ apiClient.setSecurityData(data);
30
+ };
31
+
32
+ const apiClient = new Api({
33
+ baseURL:
34
+ process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
35
+ securityWorker,
36
+ })
37
+
38
+ apiClient.api.getSiteConfiguration().then((response) => {
39
+ console.log(response.data);
40
+ });
41
+ ```
42
+
43
+ ____
44
+ © 2024 Mortgage Automation Technologies. All rights reserved
package/dist/index.d.ts CHANGED
@@ -6,7 +6,7 @@ export type LogLevel = "None" | "Info" | "Warning" | "Error";
6
6
  export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
7
7
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
8
8
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
9
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
9
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded";
10
10
  export type LoanImportStatus = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
11
11
  export type LoanImportMode = "All" | "NewOnly" | "UpdateOnly";
12
12
  export type LoanAccessScopeType = "User" | "Branch";
@@ -525,7 +525,7 @@ export interface CorporateSearchCriteria {
525
525
  isActive?: boolean | null;
526
526
  }
527
527
  export interface CreateAccessScopeRequest {
528
- scopeType: CreateAccessScopeRequestScopeTypeEnum;
528
+ scopeType: "User" | "Branch";
529
529
  /** @format uuid */
530
530
  userId?: string | null;
531
531
  /** @format uuid */
@@ -548,7 +548,7 @@ export interface CreateAccountRequest {
548
548
  */
549
549
  nlmsid: number;
550
550
  settings: AccountSettingsRequest;
551
- environment: CreateAccountRequestEnvironmentEnum;
551
+ environment: "Development" | "Staging" | "UAT" | "Production";
552
552
  losIntegration: LOSIntegration;
553
553
  }
554
554
  export interface CreateBranchRequest {
@@ -577,7 +577,7 @@ export interface CreateDocumentTemplateRequest {
577
577
  export interface CreateGroupMemberRequest {
578
578
  /** @format uuid */
579
579
  userId: string;
580
- loanRole: CreateGroupMemberRequestLoanRoleEnum;
580
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
581
581
  }
582
582
  export interface CreateInviteRequest {
583
583
  /** @minLength 1 */
@@ -588,7 +588,7 @@ export interface CreateInviteRequest {
588
588
  emailAddress: string;
589
589
  phoneNumber?: string | null;
590
590
  /** @deprecated */
591
- relationship: CreateInviteRequestRelationshipEnum;
591
+ relationship: "NotApplicable" | "Spouse" | "NonSpouse";
592
592
  loanID: string;
593
593
  route?: string | null;
594
594
  /** @format uuid */
@@ -610,13 +610,25 @@ export interface CreateLoanImportRequest {
610
610
  * @minLength 1
611
611
  */
612
612
  startDate: string;
613
- importMode: CreateLoanImportRequestImportModeEnum;
613
+ importMode: "All" | "NewOnly" | "UpdateOnly";
614
+ }
615
+ export interface CreateSession {
616
+ sessionId: string;
617
+ sessionUrl: string;
618
+ /** @format date-time */
619
+ createdAt: string;
620
+ /** @format date-time */
621
+ expiresAt?: string | null;
622
+ }
623
+ export interface CreateSessionRequest {
624
+ packageId: string;
625
+ recipientId: string;
614
626
  }
615
627
  export interface CreateUserDeviceRequest {
616
628
  token: string;
617
629
  }
618
630
  export interface CreateUserDraft {
619
- loanRole: CreateUserDraftLoanRoleEnum;
631
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
620
632
  }
621
633
  export interface CreateUserGroupRequest {
622
634
  /**
@@ -976,6 +988,37 @@ export interface EncompassContact {
976
988
  phone?: string | null;
977
989
  company?: string | null;
978
990
  }
991
+ export interface EncompassError {
992
+ errorCode: string;
993
+ message: string;
994
+ details?: string[] | null;
995
+ }
996
+ export interface EncompassPackageItem {
997
+ packageId: string;
998
+ status: string;
999
+ title?: string | null;
1000
+ /** @format date-time */
1001
+ createdAt: string;
1002
+ /** @format date-time */
1003
+ dueDate?: string | null;
1004
+ /** @format date-time */
1005
+ completedAt?: string | null;
1006
+ canSign: boolean;
1007
+ recipientId: string;
1008
+ propertyAddress?: string | null;
1009
+ loanNumber?: string | null;
1010
+ }
1011
+ export interface EncompassPackageList {
1012
+ packages: EncompassPackageItem[];
1013
+ /** @format int32 */
1014
+ totalCount: number;
1015
+ /** @format int32 */
1016
+ page: number;
1017
+ /** @format int32 */
1018
+ pageSize: number;
1019
+ /** @format int32 */
1020
+ totalPages: number;
1021
+ }
979
1022
  export interface Error {
980
1023
  message: string;
981
1024
  }
@@ -1171,7 +1214,7 @@ export interface FusionFieldDisplay {
1171
1214
  fieldValue: string;
1172
1215
  }
1173
1216
  export interface FusionReportFilter {
1174
- filterType: FusionReportFilterFilterTypeEnum;
1217
+ filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
1175
1218
  targetField: string;
1176
1219
  targetValue: string;
1177
1220
  }
@@ -1630,7 +1673,7 @@ export interface LoanContact {
1630
1673
  email?: string | null;
1631
1674
  phone?: string | null;
1632
1675
  companyName?: string | null;
1633
- role: LoanContactRoleEnum;
1676
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
1634
1677
  }
1635
1678
  export interface LoanContactList {
1636
1679
  email: string;
@@ -1717,13 +1760,13 @@ export interface LoanImport {
1717
1760
  /** @format int32 */
1718
1761
  importedCount: number;
1719
1762
  statusMessage?: string | null;
1720
- status: LoanImportStatusEnum;
1721
- importMode: LoanImportImportModeEnum;
1763
+ status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
1764
+ importMode: "All" | "NewOnly" | "UpdateOnly";
1722
1765
  /** @format date-time */
1723
1766
  createdAt?: string | null;
1724
1767
  }
1725
1768
  export interface LoanImportLog {
1726
- level: LoanImportLogLevelEnum;
1769
+ level: "None" | "Info" | "Warning" | "Error";
1727
1770
  message: string;
1728
1771
  /** @format date-time */
1729
1772
  createdAt: string;
@@ -1767,8 +1810,8 @@ export interface LoanListPaginated {
1767
1810
  export interface LoanLog {
1768
1811
  /** @format uuid */
1769
1812
  id: string;
1770
- level: LoanLogLevelEnum;
1771
- type: LoanLogTypeEnum;
1813
+ level: "None" | "Info" | "Warning" | "Error";
1814
+ type: "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded";
1772
1815
  message: string;
1773
1816
  /** @format date-time */
1774
1817
  createdAt: string;
@@ -1890,7 +1933,7 @@ export interface LoanUpdateRequestJsonPatchDocument {
1890
1933
  contractResolver?: IContractResolver | null;
1891
1934
  }
1892
1935
  export interface LoanUpdateRequestOperation {
1893
- operationType: LoanUpdateRequestOperationOperationTypeEnum;
1936
+ operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
1894
1937
  path?: string | null;
1895
1938
  op?: string | null;
1896
1939
  from?: string | null;
@@ -1904,7 +1947,7 @@ export interface LoanUser {
1904
1947
  email: string;
1905
1948
  phone?: string | null;
1906
1949
  role: string;
1907
- loanRole: LoanUserLoanRoleEnum;
1950
+ loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
1908
1951
  isUser: boolean;
1909
1952
  /** @format date-time */
1910
1953
  createdAt: string;
@@ -2171,7 +2214,7 @@ export interface NotificationTemplateVersionUpdateRequest {
2171
2214
  }
2172
2215
  export interface Operation {
2173
2216
  op?: string;
2174
- value?: string | number | boolean | null | object;
2217
+ value?: object | null;
2175
2218
  path?: string;
2176
2219
  }
2177
2220
  export interface OverridePasswordRequest {
@@ -2247,6 +2290,22 @@ export interface ProblemDetails {
2247
2290
  instance?: string | null;
2248
2291
  [key: string]: any;
2249
2292
  }
2293
+ export interface ProcessCompletion {
2294
+ success: boolean;
2295
+ sessionId: string;
2296
+ status: string;
2297
+ message: string;
2298
+ packageId?: string | null;
2299
+ recipientId: string;
2300
+ internalUserId: string;
2301
+ /** @format date-time */
2302
+ completedAt: string;
2303
+ wasAlreadyProcessed: boolean;
2304
+ }
2305
+ export interface ProcessCompletionRequest {
2306
+ /** @minLength 1 */
2307
+ sessionId: string;
2308
+ }
2250
2309
  export interface RefinanceCalculator {
2251
2310
  currentLoan: RefinanceLoan;
2252
2311
  refinanceLoan: RefinanceLoan;
@@ -2499,7 +2558,7 @@ export interface SSOTokenRequest {
2499
2558
  redirectUri: string;
2500
2559
  }
2501
2560
  export interface SamlMetadataRequest {
2502
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
2561
+ ssoIntegration: "ConsumerConnect" | "TheBigPOS";
2503
2562
  }
2504
2563
  export interface SendForgotPasswordRequest {
2505
2564
  /**
@@ -2534,7 +2593,7 @@ export interface SiteConfiguration {
2534
2593
  deletedAt?: string | null;
2535
2594
  /** @format uuid */
2536
2595
  id: string;
2537
- type: SiteConfigurationTypeEnum;
2596
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
2538
2597
  /** @format uuid */
2539
2598
  entityID: string;
2540
2599
  /** @format int32 */
@@ -2728,7 +2787,7 @@ export interface SiteConfigurationByUrl {
2728
2787
  deletedAt?: string | null;
2729
2788
  /** @format uuid */
2730
2789
  id: string;
2731
- type: SiteConfigurationByUrlTypeEnum;
2790
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
2732
2791
  /** @format uuid */
2733
2792
  entityID: string;
2734
2793
  /** @format int32 */
@@ -2939,7 +2998,7 @@ export interface SiteConfigurationForm {
2939
2998
  export interface SiteConfigurationReduced {
2940
2999
  /** @format uuid */
2941
3000
  id: string;
2942
- type: SiteConfigurationReducedTypeEnum;
3001
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
2943
3002
  url?: string | null;
2944
3003
  name: string;
2945
3004
  /** @format int64 */
@@ -2956,7 +3015,7 @@ export interface SiteConfigurationRequest {
2956
3015
  entityID: string;
2957
3016
  /** @format int32 */
2958
3017
  entityType: number;
2959
- type: SiteConfigurationRequestTypeEnum;
3018
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
2960
3019
  url: string;
2961
3020
  name: string;
2962
3021
  introduction?: string | null;
@@ -3131,7 +3190,7 @@ export interface SiteConfigurationSearchCriteria {
3131
3190
  export interface SiteConfigurationSummary {
3132
3191
  /** @format uuid */
3133
3192
  id: string;
3134
- type: SiteConfigurationSummaryTypeEnum;
3193
+ type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3135
3194
  url?: string | null;
3136
3195
  name: string;
3137
3196
  /** @format int64 */
@@ -3533,7 +3592,7 @@ export interface UserDevice {
3533
3592
  export interface UserDraft {
3534
3593
  /** @format uuid */
3535
3594
  draftID: string;
3536
- role: UserDraftRoleEnum;
3595
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3537
3596
  user: User;
3538
3597
  }
3539
3598
  export interface UserDraftPaginated {
@@ -3557,7 +3616,7 @@ export interface UserGroupAccessScope {
3557
3616
  id: string;
3558
3617
  /** @format uuid */
3559
3618
  groupId: string;
3560
- scopeType: UserGroupAccessScopeScopeTypeEnum;
3619
+ scopeType: "User" | "Branch";
3561
3620
  /** @format uuid */
3562
3621
  userId?: string | null;
3563
3622
  /** @format uuid */
@@ -3590,7 +3649,7 @@ export interface UserLoan {
3590
3649
  deletedAt?: string | null;
3591
3650
  loanID: string;
3592
3651
  user: User;
3593
- role: UserLoanRoleEnum;
3652
+ role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3594
3653
  /** @format int32 */
3595
3654
  borrowerPair?: number | null;
3596
3655
  /** @format int32 */
@@ -3723,7 +3782,7 @@ export interface UserSummary {
3723
3782
  id: string;
3724
3783
  name?: string | null;
3725
3784
  email?: string | null;
3726
- role: UserSummaryRoleEnum;
3785
+ role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
3727
3786
  }
3728
3787
  export interface VerifyPasswordRequest {
3729
3788
  /**
@@ -3756,38 +3815,6 @@ export interface Workflow {
3756
3815
  tileSubtitle: string;
3757
3816
  icon: string;
3758
3817
  }
3759
- export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
3760
- export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
3761
- export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3762
- /** @deprecated */
3763
- export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
3764
- export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
3765
- export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3766
- export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
3767
- export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3768
- export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
3769
- export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
3770
- export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
3771
- export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
3772
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
3773
- export type LoanUpdateRequestOperationOperationTypeEnum = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
3774
- export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3775
- export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
3776
- export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3777
- export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3778
- export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3779
- export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3780
- export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3781
- export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3782
- export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
3783
- export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
3784
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
3785
- /** @default "Realtor" */
3786
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
3787
- export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
3788
- export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
3789
- export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
3790
- export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
3791
3818
  import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
3792
3819
  export type QueryParamsType = Record<string | number, any>;
3793
3820
  export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -3811,7 +3838,6 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
3811
3838
  format?: ResponseType;
3812
3839
  }
3813
3840
  export declare enum ContentType {
3814
- JsonPatch = "application/json-patch+json",
3815
3841
  Json = "application/json",
3816
3842
  JsonApi = "application/vnd.api+json",
3817
3843
  FormData = "multipart/form-data",
@@ -3833,7 +3859,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
3833
3859
  }
3834
3860
  /**
3835
3861
  * @title The Big POS API
3836
- * @version v2.26.1
3862
+ * @version v2.27.0
3837
3863
  * @termsOfService https://www.thebigpos.com/terms-of-use/
3838
3864
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
3839
3865
  */
@@ -4636,6 +4662,73 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4636
4662
  * @response `200` `DocumentTemplateVersion` Success
4637
4663
  */
4638
4664
  deleteDocumentTemplateVersion: (documentId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<DocumentTemplateVersion, any>>;
4665
+ /**
4666
+ * No description
4667
+ *
4668
+ * @tags Encompass Cancellation
4669
+ * @name CancelEncompassSession
4670
+ * @request POST:/api/los/encompass/eclose/sessions/cancel
4671
+ * @secure
4672
+ * @response `200` `ProcessCompletion` Success
4673
+ * @response `400` `EncompassError` Bad Request
4674
+ * @response `404` `EncompassError` Not Found
4675
+ * @response `500` `EncompassError` Server Error
4676
+ */
4677
+ cancelEncompassSession: (data: ProcessCompletionRequest, params?: RequestParams) => Promise<AxiosResponse<ProcessCompletion, any>>;
4678
+ /**
4679
+ * No description
4680
+ *
4681
+ * @tags Encompass Completion
4682
+ * @name CompleteEncompassSession
4683
+ * @request POST:/api/los/encompass/eclose/sessions/complete
4684
+ * @secure
4685
+ * @response `200` `ProcessCompletion` Success
4686
+ * @response `400` `EncompassError` Bad Request
4687
+ * @response `404` `EncompassError` Not Found
4688
+ * @response `500` `EncompassError` Server Error
4689
+ */
4690
+ completeEncompassSession: (data: ProcessCompletionRequest, params?: RequestParams) => Promise<AxiosResponse<ProcessCompletion, any>>;
4691
+ /**
4692
+ * No description
4693
+ *
4694
+ * @tags Encompass Packages
4695
+ * @name GetUserPackages
4696
+ * @request GET:/api/los/encompass/eclose/packages
4697
+ * @secure
4698
+ * @response `200` `EncompassPackageList` Success
4699
+ * @response `400` `EncompassError` Bad Request
4700
+ * @response `401` `EncompassError` Unauthorized
4701
+ * @response `500` `EncompassError` Server Error
4702
+ */
4703
+ getUserPackages: (query?: {
4704
+ /** @default "all" */
4705
+ status?: string;
4706
+ /**
4707
+ * @format int32
4708
+ * @default 1
4709
+ */
4710
+ page?: number;
4711
+ /**
4712
+ * @format int32
4713
+ * @default 20
4714
+ */
4715
+ pageSize?: number;
4716
+ }, params?: RequestParams) => Promise<AxiosResponse<EncompassPackageList, any>>;
4717
+ /**
4718
+ * No description
4719
+ *
4720
+ * @tags Encompass Sessions
4721
+ * @name CreateEncompassSession
4722
+ * @request POST:/api/los/encompass/eclose/sessions
4723
+ * @secure
4724
+ * @response `200` `CreateSession` Success
4725
+ * @response `400` `EncompassError` Bad Request
4726
+ * @response `401` `EncompassError` Unauthorized
4727
+ * @response `403` `EncompassError` Forbidden
4728
+ * @response `404` `EncompassError` Not Found
4729
+ * @response `500` `EncompassError` Server Error
4730
+ */
4731
+ createEncompassSession: (data: CreateSessionRequest, params?: RequestParams) => Promise<AxiosResponse<CreateSession, any>>;
4639
4732
  /**
4640
4733
  * No description
4641
4734
  *
@@ -6485,7 +6578,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6485
6578
  getPartners: (query?: {
6486
6579
  showAll?: boolean;
6487
6580
  /** @default "Realtor" */
6488
- role?: GetPartnersParamsRoleEnum;
6581
+ role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
6489
6582
  /** @format int32 */
6490
6583
  pageSize?: number;
6491
6584
  /** @format int32 */
@@ -6663,7 +6756,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6663
6756
  * @response `200` `File` Success
6664
6757
  * @response `404` `ProblemDetails` Not Found
6665
6758
  */
6666
- getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
6759
+ getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
6667
6760
  /**
6668
6761
  * No description
6669
6762
  *
@@ -6674,7 +6767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6674
6767
  * @secure
6675
6768
  * @response `200` `File` Success
6676
6769
  */
6677
- createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
6770
+ createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
6678
6771
  /**
6679
6772
  * No description
6680
6773
  *