@matech/thebigpos-sdk 2.36.16-rc0 → 2.36.16-rc2

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,3 @@
1
- [ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
2
- yarn build
1
+ [ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
2
+ yarn build
3
3
  git add .
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,73 +1,73 @@
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
- ## Generate SDK from Swagger
44
-
45
- To regenerate the SDK from a specific API version, run:
46
-
47
- ```bash
48
- npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
49
- ```
50
-
51
- Replace `{version}` with the target API version (e.g. `v2.34.0`):
52
-
53
- ```bash
54
- npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
55
- ```
56
-
57
- ## Publishing
58
-
59
- 1. Update the `version` field in `package.json` before publishing.
60
- 2. Build the project:
61
-
62
- ```bash
63
- yarn build
64
- ```
65
-
66
- 3. Publish to npm:
67
-
68
- ```bash
69
- yarn publish
70
- ```
71
-
72
- ____
73
- © 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
+ ## Generate SDK from Swagger
44
+
45
+ To regenerate the SDK from a specific API version, run:
46
+
47
+ ```bash
48
+ npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
49
+ ```
50
+
51
+ Replace `{version}` with the target API version (e.g. `v2.34.0`):
52
+
53
+ ```bash
54
+ npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --generate-union-enums
55
+ ```
56
+
57
+ ## Publishing
58
+
59
+ 1. Update the `version` field in `package.json` before publishing.
60
+ 2. Build the project:
61
+
62
+ ```bash
63
+ yarn build
64
+ ```
65
+
66
+ 3. Publish to npm:
67
+
68
+ ```bash
69
+ yarn publish
70
+ ```
71
+
72
+ ____
73
+ © 2024 Mortgage Automation Technologies. All rights reserved
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
1
+ export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
2
2
  export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
3
3
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
4
4
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
@@ -22,7 +22,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
22
22
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
23
23
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
24
24
  export type LoanMaritalStatus = "Married" | "Separated" | "Unmarried";
25
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
25
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
26
26
  export type LoanLienPosition = "First" | "Subordinate";
27
27
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
28
28
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other";
@@ -44,11 +44,15 @@ export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Fai
44
44
  export type FilterType = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
45
45
  export type Environment = "Development" | "Staging" | "UAT" | "Production";
46
46
  export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
47
+ export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
48
+ export type EncompassLogOperationType = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
47
49
  export type DraftType = "NewLoan" | "EditLoan";
48
50
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
51
+ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
49
52
  export type BranchType = "Mortgage" | "RealEstate";
50
53
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
51
54
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
55
+ export type BorrowerApplicationStatus = "Draft" | "Complete";
52
56
  export type BillingType = "ClosedLoan" | "LoanOfficer";
53
57
  export type 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";
54
58
  export interface ASOSettings {
@@ -1133,6 +1137,17 @@ export interface EncompassError {
1133
1137
  message: string;
1134
1138
  details?: string[] | null;
1135
1139
  }
1140
+ export interface EncompassLogSearchCriteria {
1141
+ searchText?: string | null;
1142
+ operationTypes?: EncompassLogOperationType[] | null;
1143
+ outcomes?: EncompassLogOutcome[] | null;
1144
+ /** @format date-time */
1145
+ createdFrom?: string | null;
1146
+ /** @format date-time */
1147
+ createdTo?: string | null;
1148
+ /** @format int32 */
1149
+ httpStatusCode?: number | null;
1150
+ }
1136
1151
  export interface EncompassPackageItem {
1137
1152
  packageId: string;
1138
1153
  status: string;
@@ -1151,6 +1166,31 @@ export interface EncompassPackageList {
1151
1166
  /** @format int32 */
1152
1167
  totalPages: number;
1153
1168
  }
1169
+ export interface EncompassRequestLog {
1170
+ /** @format uuid */
1171
+ id: string;
1172
+ losId?: string | null;
1173
+ /** @format uuid */
1174
+ accountId: string;
1175
+ operationType: EncompassRequestLogOperationTypeEnum;
1176
+ outcome: EncompassRequestLogOutcomeEnum;
1177
+ message: string;
1178
+ endpoint?: string | null;
1179
+ httpMethod?: string | null;
1180
+ /** @format int32 */
1181
+ httpStatusCode?: number | null;
1182
+ /** @format int64 */
1183
+ durationMs?: number | null;
1184
+ context?: any;
1185
+ /** @format date-time */
1186
+ createdAt: string;
1187
+ }
1188
+ export interface EncompassRequestLogPaginated {
1189
+ rows: EncompassRequestLog[];
1190
+ pagination: Pagination;
1191
+ /** @format int64 */
1192
+ count: number;
1193
+ }
1154
1194
  export interface Error {
1155
1195
  message: string;
1156
1196
  }
@@ -1189,6 +1229,10 @@ export interface FileWithBytes {
1189
1229
  mimeType?: string | null;
1190
1230
  extension?: string | null;
1191
1231
  }
1232
+ export interface ForcePasswordReset {
1233
+ forcePasswordReset: boolean;
1234
+ email: string;
1235
+ }
1192
1236
  export interface Form {
1193
1237
  /** @format date-time */
1194
1238
  createdAt?: string | null;
@@ -1680,6 +1724,7 @@ export interface Loan {
1680
1724
  fileStarter?: string | null;
1681
1725
  source?: string | null;
1682
1726
  isPOSLoan?: boolean | null;
1727
+ version?: string | null;
1683
1728
  /** @format date-time */
1684
1729
  startDate?: string | null;
1685
1730
  /** @format date-time */
@@ -1699,6 +1744,8 @@ export interface Loan {
1699
1744
  lastLosDocumentsSyncDate?: string | null;
1700
1745
  isLocked: boolean;
1701
1746
  isLockedFromEditing: boolean;
1747
+ /** @format date-time */
1748
+ sensitiveDataPurgedOn?: string | null;
1702
1749
  excludeFromAutoTaskReminders?: boolean | null;
1703
1750
  loanSettings?: LoanSettings | null;
1704
1751
  loanOfficer?: LoanOfficer | null;
@@ -1751,7 +1798,7 @@ export interface LoanApplicationRequest {
1751
1798
  }
1752
1799
  export interface LoanBorrower {
1753
1800
  /** @format uuid */
1754
- id?: string | null;
1801
+ id: string;
1755
1802
  ssn?: string | null;
1756
1803
  email?: string | null;
1757
1804
  lastName?: string | null;
@@ -1764,6 +1811,7 @@ export interface LoanBorrower {
1764
1811
  citizenship?: LoanCitizenship | null;
1765
1812
  maritalStatus?: LoanMaritalStatus | null;
1766
1813
  languagePreference?: LoanLanguagePreference | null;
1814
+ applicationStatus: LoanBorrowerApplicationStatusEnum;
1767
1815
  /** @format int32 */
1768
1816
  numberOfDependents?: number | null;
1769
1817
  isPrimaryBorrower: boolean;
@@ -2645,6 +2693,8 @@ export interface LoanDocument {
2645
2693
  losStatus: string;
2646
2694
  contents?: string | null;
2647
2695
  failoverDocumentPath?: string | null;
2696
+ /** @format date-time */
2697
+ sensitiveDataPurgedOn?: string | null;
2648
2698
  }
2649
2699
  export interface LoanDocumentSearch {
2650
2700
  /** @format date-time */
@@ -2663,6 +2713,8 @@ export interface LoanDocumentSearch {
2663
2713
  losStatus: string;
2664
2714
  contents?: string | null;
2665
2715
  failoverDocumentPath?: string | null;
2716
+ /** @format date-time */
2717
+ sensitiveDataPurgedOn?: string | null;
2666
2718
  }
2667
2719
  export interface LoanDocumentSearchCriteria {
2668
2720
  searchText?: string | null;
@@ -2808,6 +2860,16 @@ export interface LoanLog {
2808
2860
  /** @format date-time */
2809
2861
  createdAt: string;
2810
2862
  }
2863
+ export interface LoanLogDetail {
2864
+ /** @format uuid */
2865
+ id: string;
2866
+ level: LoanLogDetailLevelEnum;
2867
+ type: LoanLogDetailTypeEnum;
2868
+ message: string;
2869
+ /** @format date-time */
2870
+ createdAt: string;
2871
+ context?: string | null;
2872
+ }
2811
2873
  export interface LoanLogPaginated {
2812
2874
  rows: LoanLog[];
2813
2875
  pagination: Pagination;
@@ -2860,7 +2922,6 @@ export interface LoanOfficerPublic {
2860
2922
  firstName: string;
2861
2923
  lastName: string;
2862
2924
  email: string;
2863
- phone?: string | null;
2864
2925
  /** @format uuid */
2865
2926
  corporateID?: string | null;
2866
2927
  siteConfigurationIDs: string[];
@@ -3124,7 +3185,7 @@ export interface MilestoneConfigurationRequest {
3124
3185
  }
3125
3186
  export interface MobileSettings {
3126
3187
  /** @format uuid */
3127
- id?: string | null;
3188
+ id: string;
3128
3189
  hasMobile: boolean;
3129
3190
  /** @deprecated */
3130
3191
  downloadLink?: string | null;
@@ -3337,7 +3398,7 @@ export interface NotificationTemplateVersionUpdateRequest {
3337
3398
  }
3338
3399
  export interface Operation {
3339
3400
  op?: string;
3340
- value?: object | null;
3401
+ value?: string | number | boolean | null | object;
3341
3402
  path?: string;
3342
3403
  }
3343
3404
  export interface OverridePasswordRequest {
@@ -4954,6 +5015,7 @@ export interface UserLoanConsent {
4954
5015
  type: UserLoanConsentTypeEnum;
4955
5016
  providedConsent: boolean;
4956
5017
  ipAddress?: string | null;
5018
+ losSyncStatus: UserLoanConsentLosSyncStatusEnum;
4957
5019
  /** @format date-time */
4958
5020
  createdAt: string;
4959
5021
  }
@@ -5128,14 +5190,19 @@ export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateO
5128
5190
  export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5129
5191
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
5130
5192
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
5193
+ export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "EConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
5194
+ export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
5131
5195
  export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
5132
5196
  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";
5197
+ export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
5133
5198
  export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5134
5199
  export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
5135
5200
  export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
5136
5201
  export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5137
5202
  export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
5138
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent";
5203
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
5204
+ export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
5205
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "EConsent" | "SensitiveDataPurge" | "ClosingDateUpdated";
5139
5206
  export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5140
5207
  export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5141
5208
  export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -5147,9 +5214,10 @@ export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loa
5147
5214
  export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
5148
5215
  export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
5149
5216
  export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
5150
- export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
5217
+ export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
5218
+ export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5151
5219
  /** @default "Realtor" */
5152
- export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
5220
+ export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
5153
5221
  export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5154
5222
  export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
5155
5223
  export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
@@ -5177,6 +5245,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
5177
5245
  format?: ResponseType;
5178
5246
  }
5179
5247
  export declare enum ContentType {
5248
+ JsonPatch = "application/json-patch+json",
5180
5249
  Json = "application/json",
5181
5250
  JsonApi = "application/vnd.api+json",
5182
5251
  FormData = "multipart/form-data",
@@ -5357,10 +5426,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5357
5426
  * @summary Get Token
5358
5427
  * @request POST:/api/token
5359
5428
  * @secure
5360
- * @response `200` `Token` Success
5429
+ * @response `200` `ForcePasswordReset` Success
5361
5430
  * @response `422` `UnprocessableEntity` Client Error
5362
5431
  */
5363
- getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<Token, any, {}>>;
5432
+ getToken: (data: TokenRequest, params?: RequestParams) => Promise<AxiosResponse<ForcePasswordReset, any, {}>>;
5364
5433
  /**
5365
5434
  * No description
5366
5435
  *
@@ -5369,10 +5438,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5369
5438
  * @summary Get Token From Challenge Code
5370
5439
  * @request POST:/api/token/code
5371
5440
  * @secure
5372
- * @response `200` `Token` Success
5441
+ * @response `200` `ForcePasswordReset` Success
5373
5442
  * @response `422` `UnprocessableEntity` Client Error
5374
5443
  */
5375
- getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<Token, any, {}>>;
5444
+ getTokenFromChallengeCode: (data: TokenChallengeRequest, params?: RequestParams) => Promise<AxiosResponse<ForcePasswordReset, any, {}>>;
5376
5445
  /**
5377
5446
  * No description
5378
5447
  *
@@ -5549,9 +5618,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5549
5618
  * @summary Get Branch Loan Officers
5550
5619
  * @request GET:/api/branches/{branchId}/loan-officers
5551
5620
  * @secure
5552
- * @response `200` `LoanOfficerPublic` Success
5621
+ * @response `200` `(LoanOfficerPublic)[]` Success
5553
5622
  */
5554
- getLoanOfficersByBranch: (branchId: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic, any, {}>>;
5623
+ getLoanOfficersByBranch: (branchId: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic[], any, {}>>;
5555
5624
  /**
5556
5625
  * No description
5557
5626
  *
@@ -5783,9 +5852,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5783
5852
  * @summary Get Loan Officers
5784
5853
  * @request GET:/api/corporates/{id}/loan-officers
5785
5854
  * @secure
5786
- * @response `200` `LoanOfficerPublic` Success
5855
+ * @response `200` `(LoanOfficerPublic)[]` Success
5787
5856
  */
5788
- getLoanOfficersByCorporate: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic, any, {}>>;
5857
+ getLoanOfficersByCorporate: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic[], any, {}>>;
5789
5858
  /**
5790
5859
  * No description
5791
5860
  *
@@ -7216,6 +7285,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7216
7285
  sortBy?: string;
7217
7286
  sortDirection?: string;
7218
7287
  }, params?: RequestParams) => Promise<AxiosResponse<LoanLogPaginated, any, {}>>;
7288
+ /**
7289
+ * No description
7290
+ *
7291
+ * @tags LoanLogs
7292
+ * @name GetLoanLogById
7293
+ * @summary Get loan log by ID
7294
+ * @request GET:/api/loans/{loanId}/logs/{loanLogId}
7295
+ * @secure
7296
+ * @response `200` `LoanLogDetail` Success
7297
+ * @response `404` `ProblemDetails` Not Found
7298
+ */
7299
+ getLoanLogById: (loanId: string, loanLogId: string, params?: RequestParams) => Promise<AxiosResponse<LoanLogDetail, any, {}>>;
7219
7300
  /**
7220
7301
  * No description
7221
7302
  *
@@ -8361,6 +8442,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8361
8442
  * @response `200` `void` Success
8362
8443
  */
8363
8444
  integrationsLosLoansCreate: (data: LosLoanCreationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
8445
+ /**
8446
+ * No description
8447
+ *
8448
+ * @tags TheBigPOS
8449
+ * @name SearchEncompassLogs
8450
+ * @request POST:/api/los/encompass/logs/{losId}/search
8451
+ * @secure
8452
+ * @response `200` `EncompassRequestLogPaginated` Success
8453
+ */
8454
+ searchEncompassLogs: (losId: string, query: {
8455
+ /** @format int32 */
8456
+ pageSize: number;
8457
+ /** @format int32 */
8458
+ pageNumber: number;
8459
+ sortBy?: string;
8460
+ sortDirection?: string;
8461
+ }, data: EncompassLogSearchCriteria, params?: RequestParams) => Promise<AxiosResponse<EncompassRequestLogPaginated, any, {}>>;
8364
8462
  /**
8365
8463
  * No description
8366
8464
  *
package/dist/index.js CHANGED
@@ -32,6 +32,7 @@ var __rest = (this && this.__rest) || function (s, e) {
32
32
  import axios from "axios";
33
33
  export var ContentType;
34
34
  (function (ContentType) {
35
+ ContentType["JsonPatch"] = "application/json-patch+json";
35
36
  ContentType["Json"] = "application/json";
36
37
  ContentType["JsonApi"] = "application/vnd.api+json";
37
38
  ContentType["FormData"] = "multipart/form-data";
@@ -261,7 +262,7 @@ export class Api extends HttpClient {
261
262
  * @summary Get Token
262
263
  * @request POST:/api/token
263
264
  * @secure
264
- * @response `200` `Token` Success
265
+ * @response `200` `ForcePasswordReset` Success
265
266
  * @response `422` `UnprocessableEntity` Client Error
266
267
  */
267
268
  getToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
@@ -273,7 +274,7 @@ export class Api extends HttpClient {
273
274
  * @summary Get Token From Challenge Code
274
275
  * @request POST:/api/token/code
275
276
  * @secure
276
- * @response `200` `Token` Success
277
+ * @response `200` `ForcePasswordReset` Success
277
278
  * @response `422` `UnprocessableEntity` Client Error
278
279
  */
279
280
  getTokenFromChallengeCode: (data, params = {}) => this.request(Object.assign({ path: `/api/token/code`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
@@ -436,7 +437,7 @@ export class Api extends HttpClient {
436
437
  * @summary Get Branch Loan Officers
437
438
  * @request GET:/api/branches/{branchId}/loan-officers
438
439
  * @secure
439
- * @response `200` `LoanOfficerPublic` Success
440
+ * @response `200` `(LoanOfficerPublic)[]` Success
440
441
  */
441
442
  getLoanOfficersByBranch: (branchId, params = {}) => this.request(Object.assign({ path: `/api/branches/${branchId}/loan-officers`, method: "GET", secure: true, format: "json" }, params)),
442
443
  /**
@@ -651,7 +652,7 @@ export class Api extends HttpClient {
651
652
  * @summary Get Loan Officers
652
653
  * @request GET:/api/corporates/{id}/loan-officers
653
654
  * @secure
654
- * @response `200` `LoanOfficerPublic` Success
655
+ * @response `200` `(LoanOfficerPublic)[]` Success
655
656
  */
656
657
  getLoanOfficersByCorporate: (id, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}/loan-officers`, method: "GET", secure: true, format: "json" }, params)),
657
658
  /**
@@ -1203,7 +1204,7 @@ export class Api extends HttpClient {
1203
1204
  * @response `200` `string` Success
1204
1205
  * @response `422` `UnprocessableEntity` Client Error
1205
1206
  */
1206
- updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1207
+ updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
1207
1208
  /**
1208
1209
  * No description
1209
1210
  *
@@ -1253,7 +1254,7 @@ export class Api extends HttpClient {
1253
1254
  * @response `200` `string` Success
1254
1255
  * @response `422` `UnprocessableEntity` Client Error
1255
1256
  */
1256
- updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1257
+ updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
1257
1258
  /**
1258
1259
  * No description
1259
1260
  *
@@ -1266,7 +1267,7 @@ export class Api extends HttpClient {
1266
1267
  * @response `202` `string` Accepted
1267
1268
  * @response `422` `UnprocessableEntity` Client Error
1268
1269
  */
1269
- updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1270
+ updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
1270
1271
  /**
1271
1272
  * No description
1272
1273
  *
@@ -1380,7 +1381,7 @@ export class Api extends HttpClient {
1380
1381
  * @secure
1381
1382
  * @response `200` `ListingFile` Success
1382
1383
  */
1383
- updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1384
+ updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
1384
1385
  /**
1385
1386
  * No description
1386
1387
  *
@@ -1413,7 +1414,7 @@ export class Api extends HttpClient {
1413
1414
  * @secure
1414
1415
  * @response `200` `(ListingPhoto)[]` Success
1415
1416
  */
1416
- updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1417
+ updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
1417
1418
  /**
1418
1419
  * No description
1419
1420
  *
@@ -1916,6 +1917,18 @@ export class Api extends HttpClient {
1916
1917
  * @response `200` `LoanLogPaginated` Success
1917
1918
  */
1918
1919
  searchLoanLogs: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/logs/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
1920
+ /**
1921
+ * No description
1922
+ *
1923
+ * @tags LoanLogs
1924
+ * @name GetLoanLogById
1925
+ * @summary Get loan log by ID
1926
+ * @request GET:/api/loans/{loanId}/logs/{loanLogId}
1927
+ * @secure
1928
+ * @response `200` `LoanLogDetail` Success
1929
+ * @response `404` `ProblemDetails` Not Found
1930
+ */
1931
+ getLoanLogById: (loanId, loanLogId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/logs/${loanLogId}`, method: "GET", secure: true, format: "json" }, params)),
1919
1932
  /**
1920
1933
  * No description
1921
1934
  *
@@ -2142,7 +2155,7 @@ export class Api extends HttpClient {
2142
2155
  * @response `200` `TaskCommentPaginated` Success
2143
2156
  * @response `404` `ProblemDetails` Not Found
2144
2157
  */
2145
- searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
2158
+ searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
2146
2159
  /**
2147
2160
  * No description
2148
2161
  *
@@ -2971,6 +2984,16 @@ export class Api extends HttpClient {
2971
2984
  * @response `200` `void` Success
2972
2985
  */
2973
2986
  integrationsLosLoansCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
2987
+ /**
2988
+ * No description
2989
+ *
2990
+ * @tags TheBigPOS
2991
+ * @name SearchEncompassLogs
2992
+ * @request POST:/api/los/encompass/logs/{losId}/search
2993
+ * @secure
2994
+ * @response `200` `EncompassRequestLogPaginated` Success
2995
+ */
2996
+ searchEncompassLogs: (losId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/logs/${losId}/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
2974
2997
  /**
2975
2998
  * No description
2976
2999
  *