@matech/thebigpos-sdk 3.15.0 → 3.16.0-dev-6117
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/README.md +39 -0
- package/dist/index.d.ts +624 -14
- package/dist/index.js +215 -2
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +16 -6
- package/scripts/apply-json-patch-content-type.js +189 -36
- package/src/index.ts +1228 -20
package/src/index.ts
CHANGED
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
* ---------------------------------------------------------------
|
|
11
11
|
*/
|
|
12
12
|
|
|
13
|
+
type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
14
|
+
|
|
13
15
|
export type VersionStatusType = "Draft" | "Published";
|
|
14
16
|
|
|
15
17
|
export type UserRole =
|
|
@@ -141,6 +143,20 @@ export type LoanRefinancePurpose =
|
|
|
141
143
|
|
|
142
144
|
export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
|
|
143
145
|
|
|
146
|
+
export type LoanRealEstatePropertyType =
|
|
147
|
+
| "SingleFamily"
|
|
148
|
+
| "Condominium"
|
|
149
|
+
| "Townhouse"
|
|
150
|
+
| "Cooperative"
|
|
151
|
+
| "TwoToFourUnitProperty"
|
|
152
|
+
| "MultifamilyMoreThanFourUnits"
|
|
153
|
+
| "ManufacturedMobileHome"
|
|
154
|
+
| "CommercialNonResidential"
|
|
155
|
+
| "HomeAndBusinessCombined"
|
|
156
|
+
| "MixedUseResidential"
|
|
157
|
+
| "Farm"
|
|
158
|
+
| "Land";
|
|
159
|
+
|
|
144
160
|
export type LoanRealEstateOccupancyType =
|
|
145
161
|
| "PrimaryHome"
|
|
146
162
|
| "SecondHome"
|
|
@@ -292,7 +308,8 @@ export type LoanLogType =
|
|
|
292
308
|
| "CoBorrowerEmailAutoFixed"
|
|
293
309
|
| "LosFieldWriteBack"
|
|
294
310
|
| "ReferrerChangeDiscarded"
|
|
295
|
-
| "TaskEdited"
|
|
311
|
+
| "TaskEdited"
|
|
312
|
+
| "SigningMethodChanged";
|
|
296
313
|
|
|
297
314
|
export type LoanLienPosition = "First" | "Subordinate";
|
|
298
315
|
|
|
@@ -561,6 +578,55 @@ export type CompanyDocumentIndexStatus =
|
|
|
561
578
|
|
|
562
579
|
export type ClassificationSource = "Textract" | "Llm" | "Manual";
|
|
563
580
|
|
|
581
|
+
export type CanvasWidgetType =
|
|
582
|
+
| "Information"
|
|
583
|
+
| "Kpi"
|
|
584
|
+
| "KeyDates"
|
|
585
|
+
| "LoanProgress"
|
|
586
|
+
| "MonthlyPayment"
|
|
587
|
+
| "Amortization"
|
|
588
|
+
| "PrimaryBorrower"
|
|
589
|
+
| "OpenTasks"
|
|
590
|
+
| "Documents"
|
|
591
|
+
| "EsignStatus"
|
|
592
|
+
| "LoanTeam"
|
|
593
|
+
| "TextBlock"
|
|
594
|
+
| "SectionDivider"
|
|
595
|
+
| "MyTasks"
|
|
596
|
+
| "RecentLoans"
|
|
597
|
+
| "ClosingSoon";
|
|
598
|
+
|
|
599
|
+
export type CanvasWidgetScope = "Loan" | "User" | "Any";
|
|
600
|
+
|
|
601
|
+
export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
|
|
602
|
+
|
|
603
|
+
export type CanvasLabelPosition = "Left" | "Above";
|
|
604
|
+
|
|
605
|
+
export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
|
|
606
|
+
|
|
607
|
+
export type CanvasFieldSource = "Standard" | "Custom";
|
|
608
|
+
|
|
609
|
+
export type CanvasFieldFormat =
|
|
610
|
+
| "Text"
|
|
611
|
+
| "Number"
|
|
612
|
+
| "Currency"
|
|
613
|
+
| "Percent"
|
|
614
|
+
| "DateShort"
|
|
615
|
+
| "DateLong"
|
|
616
|
+
| "YesNo";
|
|
617
|
+
|
|
618
|
+
export type CanvasFieldDataType =
|
|
619
|
+
| "Text"
|
|
620
|
+
| "Number"
|
|
621
|
+
| "Decimal"
|
|
622
|
+
| "Boolean"
|
|
623
|
+
| "Date"
|
|
624
|
+
| "DateTime"
|
|
625
|
+
| "SingleSelect"
|
|
626
|
+
| "MultiSelect";
|
|
627
|
+
|
|
628
|
+
export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
629
|
+
|
|
564
630
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
565
631
|
|
|
566
632
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
@@ -569,6 +635,15 @@ export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
|
569
635
|
|
|
570
636
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
571
637
|
|
|
638
|
+
export type BorrowerApplicationWarningCode =
|
|
639
|
+
| "UnknownKey"
|
|
640
|
+
| "NotWritable"
|
|
641
|
+
| "CustomFieldUnresolved"
|
|
642
|
+
| "CustomFieldInactive"
|
|
643
|
+
| "CustomFieldReadOnly"
|
|
644
|
+
| "CustomFieldDuplicateDefinition"
|
|
645
|
+
| "LoanOfficerUnresolved";
|
|
646
|
+
|
|
572
647
|
export type BorrowerApplicationStatus = "Draft" | "Complete";
|
|
573
648
|
|
|
574
649
|
export type BillingType = "ClosedLoan" | "LoanOfficer";
|
|
@@ -701,6 +776,41 @@ export type AddressFamily =
|
|
|
701
776
|
| "ControllerAreaNetwork"
|
|
702
777
|
| "Unknown";
|
|
703
778
|
|
|
779
|
+
export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
|
|
780
|
+
(
|
|
781
|
+
| BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
|
|
782
|
+
| BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig>
|
|
783
|
+
| BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig>
|
|
784
|
+
| BaseCanvasWidgetConfigTypeMapping<
|
|
785
|
+
"LoanProgress",
|
|
786
|
+
LoanProgressWidgetConfig
|
|
787
|
+
>
|
|
788
|
+
| BaseCanvasWidgetConfigTypeMapping<
|
|
789
|
+
"MonthlyPayment",
|
|
790
|
+
MonthlyPaymentWidgetConfig
|
|
791
|
+
>
|
|
792
|
+
| BaseCanvasWidgetConfigTypeMapping<
|
|
793
|
+
"Amortization",
|
|
794
|
+
AmortizationWidgetConfig
|
|
795
|
+
>
|
|
796
|
+
| BaseCanvasWidgetConfigTypeMapping<
|
|
797
|
+
"PrimaryBorrower",
|
|
798
|
+
PrimaryBorrowerWidgetConfig
|
|
799
|
+
>
|
|
800
|
+
| BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig>
|
|
801
|
+
| BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig>
|
|
802
|
+
| BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig>
|
|
803
|
+
| BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig>
|
|
804
|
+
| BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig>
|
|
805
|
+
| BaseCanvasWidgetConfigTypeMapping<
|
|
806
|
+
"SectionDivider",
|
|
807
|
+
SectionDividerWidgetConfig
|
|
808
|
+
>
|
|
809
|
+
| BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig>
|
|
810
|
+
| BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig>
|
|
811
|
+
| BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>
|
|
812
|
+
);
|
|
813
|
+
|
|
704
814
|
export interface ASOSettings {
|
|
705
815
|
enabled: boolean;
|
|
706
816
|
softPull: boolean;
|
|
@@ -780,6 +890,7 @@ export interface AccountFailureCount {
|
|
|
780
890
|
export interface AccountSettings {
|
|
781
891
|
isSmsEnabled: boolean;
|
|
782
892
|
isLoanEditEnabled: boolean;
|
|
893
|
+
isApplicationEditEnabled?: boolean | null;
|
|
783
894
|
smsNumber?: string | null;
|
|
784
895
|
ssoHostOverride?: string | null;
|
|
785
896
|
isEarlyAdopter: boolean;
|
|
@@ -789,6 +900,7 @@ export interface AccountSettingsRequest {
|
|
|
789
900
|
isSmsEnabled: boolean;
|
|
790
901
|
smsNumber?: string | null;
|
|
791
902
|
isEarlyAdopter: boolean;
|
|
903
|
+
isApplicationEditEnabled?: boolean | null;
|
|
792
904
|
}
|
|
793
905
|
|
|
794
906
|
export interface Address {
|
|
@@ -1043,7 +1155,7 @@ export interface AiAuditLog {
|
|
|
1043
1155
|
guardrailCategory?: string | null;
|
|
1044
1156
|
rawRequest?: string | null;
|
|
1045
1157
|
rawResponse?: string | null;
|
|
1046
|
-
details
|
|
1158
|
+
details?: any | null;
|
|
1047
1159
|
/** @format date-time */
|
|
1048
1160
|
createdAt: string;
|
|
1049
1161
|
}
|
|
@@ -1555,6 +1667,13 @@ export interface AmortizationSchedule {
|
|
|
1555
1667
|
pmi: number;
|
|
1556
1668
|
}
|
|
1557
1669
|
|
|
1670
|
+
export type AmortizationWidgetConfig = UtilRequiredKeys<
|
|
1671
|
+
BaseCanvasWidgetConfig,
|
|
1672
|
+
"type"
|
|
1673
|
+
> & {
|
|
1674
|
+
type: AmortizationWidgetConfigTypeEnum;
|
|
1675
|
+
};
|
|
1676
|
+
|
|
1558
1677
|
export interface ApplicationRowData {
|
|
1559
1678
|
borrowerEmail?: string | null;
|
|
1560
1679
|
borrowerFirstName?: string | null;
|
|
@@ -1630,7 +1749,7 @@ export interface AuditLogEntry {
|
|
|
1630
1749
|
rootEntityType?: string | null;
|
|
1631
1750
|
/** @format uuid */
|
|
1632
1751
|
rootEntityId?: string | null;
|
|
1633
|
-
changes
|
|
1752
|
+
changes?: any | null;
|
|
1634
1753
|
/** @format date-time */
|
|
1635
1754
|
createdAt: string;
|
|
1636
1755
|
}
|
|
@@ -1669,6 +1788,36 @@ export interface AutomatedService {
|
|
|
1669
1788
|
rateLimited: string[];
|
|
1670
1789
|
}
|
|
1671
1790
|
|
|
1791
|
+
export interface BorrowerApplication {
|
|
1792
|
+
/** @format uuid */
|
|
1793
|
+
loanId: string;
|
|
1794
|
+
/** @format uuid */
|
|
1795
|
+
borrowerId: string;
|
|
1796
|
+
/** @format uuid */
|
|
1797
|
+
coBorrowerId?: string | null;
|
|
1798
|
+
applicationStatus: BorrowerApplicationApplicationStatusEnum;
|
|
1799
|
+
answers: Record<string, any>;
|
|
1800
|
+
additionalFields: Record<string, string>;
|
|
1801
|
+
cursor?: LoanApplicationSession | null;
|
|
1802
|
+
}
|
|
1803
|
+
|
|
1804
|
+
export interface BorrowerApplicationUpdate {
|
|
1805
|
+
warnings: BorrowerApplicationWarning[];
|
|
1806
|
+
application: BorrowerApplication;
|
|
1807
|
+
}
|
|
1808
|
+
|
|
1809
|
+
export interface BorrowerApplicationUpdateRequest {
|
|
1810
|
+
answers: Record<string, any>;
|
|
1811
|
+
additionalFields?: Record<string, any> | null;
|
|
1812
|
+
cursor?: LoanApplicationSessionRequest | null;
|
|
1813
|
+
}
|
|
1814
|
+
|
|
1815
|
+
export interface BorrowerApplicationWarning {
|
|
1816
|
+
key: string;
|
|
1817
|
+
code: BorrowerApplicationWarningCodeEnum;
|
|
1818
|
+
message: string;
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1672
1821
|
export interface BorrowerCount {
|
|
1673
1822
|
/** @format uuid */
|
|
1674
1823
|
userId: string;
|
|
@@ -1828,6 +1977,227 @@ export interface BusinessRuleRequest {
|
|
|
1828
1977
|
applyToAllBorrowerPairs: boolean;
|
|
1829
1978
|
}
|
|
1830
1979
|
|
|
1980
|
+
export interface CanvasAuthor {
|
|
1981
|
+
/** @format uuid */
|
|
1982
|
+
id: string;
|
|
1983
|
+
firstName: string;
|
|
1984
|
+
lastName: string;
|
|
1985
|
+
email: string;
|
|
1986
|
+
}
|
|
1987
|
+
|
|
1988
|
+
export interface CanvasBoard {
|
|
1989
|
+
name?: string | null;
|
|
1990
|
+
roles: UserRole[];
|
|
1991
|
+
widgetIds: string[];
|
|
1992
|
+
widgets: Record<string, CanvasWidget>;
|
|
1993
|
+
}
|
|
1994
|
+
|
|
1995
|
+
export interface CanvasBoardView {
|
|
1996
|
+
widgetIds: string[];
|
|
1997
|
+
widgets: Record<string, CanvasWidgetView>;
|
|
1998
|
+
}
|
|
1999
|
+
|
|
2000
|
+
export interface CanvasDocument {
|
|
2001
|
+
/** @format int32 */
|
|
2002
|
+
schemaVersion: number;
|
|
2003
|
+
boards?: CanvasBoard[] | null;
|
|
2004
|
+
tabs?: CanvasTab[] | null;
|
|
2005
|
+
}
|
|
2006
|
+
|
|
2007
|
+
export interface CanvasFieldCatalog {
|
|
2008
|
+
fields: CanvasFieldDescriptor[];
|
|
2009
|
+
}
|
|
2010
|
+
|
|
2011
|
+
export interface CanvasFieldDescriptor {
|
|
2012
|
+
source: CanvasFieldDescriptorSourceEnum;
|
|
2013
|
+
key: string;
|
|
2014
|
+
label: string;
|
|
2015
|
+
category: string;
|
|
2016
|
+
categoryKey: string;
|
|
2017
|
+
dataType: CanvasFieldDescriptorDataTypeEnum;
|
|
2018
|
+
format: CanvasFieldDescriptorFormatEnum;
|
|
2019
|
+
encompassFieldId?: string | null;
|
|
2020
|
+
readableRoles: UserRole[];
|
|
2021
|
+
isActive: boolean;
|
|
2022
|
+
rolesWithoutPermissionRows: UserRole[];
|
|
2023
|
+
options: string[];
|
|
2024
|
+
}
|
|
2025
|
+
|
|
2026
|
+
export interface CanvasFieldRef {
|
|
2027
|
+
source: CanvasFieldRefSourceEnum;
|
|
2028
|
+
key: string;
|
|
2029
|
+
}
|
|
2030
|
+
|
|
2031
|
+
export interface CanvasFieldValue {
|
|
2032
|
+
dataType: CanvasFieldValueDataTypeEnum;
|
|
2033
|
+
value?: any | null;
|
|
2034
|
+
}
|
|
2035
|
+
|
|
2036
|
+
export interface CanvasFieldValues {
|
|
2037
|
+
standard: Record<string, CanvasFieldValue>;
|
|
2038
|
+
custom: Record<string, CanvasFieldValue>;
|
|
2039
|
+
}
|
|
2040
|
+
|
|
2041
|
+
export interface CanvasFieldValuesRequest {
|
|
2042
|
+
standardKeys: string[];
|
|
2043
|
+
customFieldIds: string[];
|
|
2044
|
+
}
|
|
2045
|
+
|
|
2046
|
+
export interface CanvasFieldView {
|
|
2047
|
+
label: string;
|
|
2048
|
+
dataType: CanvasFieldViewDataTypeEnum;
|
|
2049
|
+
format: CanvasFieldViewFormatEnum;
|
|
2050
|
+
options: string[];
|
|
2051
|
+
}
|
|
2052
|
+
|
|
2053
|
+
export interface CanvasInformationItem {
|
|
2054
|
+
kind: CanvasInformationItemKindEnum;
|
|
2055
|
+
field?: CanvasFieldRef | null;
|
|
2056
|
+
text?: string | null;
|
|
2057
|
+
label?: string | null;
|
|
2058
|
+
format?: CanvasFieldFormat | null;
|
|
2059
|
+
emphasis: boolean;
|
|
2060
|
+
hideWhenEmpty: boolean;
|
|
2061
|
+
roles: UserRole[];
|
|
2062
|
+
/** @format int32 */
|
|
2063
|
+
column: number;
|
|
2064
|
+
}
|
|
2065
|
+
|
|
2066
|
+
export interface CanvasSourceSite {
|
|
2067
|
+
/** @format uuid */
|
|
2068
|
+
siteConfigurationID: string;
|
|
2069
|
+
name: string;
|
|
2070
|
+
type: CanvasSourceSiteTypeEnum;
|
|
2071
|
+
}
|
|
2072
|
+
|
|
2073
|
+
export interface CanvasSurfaceState {
|
|
2074
|
+
surface: CanvasSurfaceStateSurfaceEnum;
|
|
2075
|
+
own?: CanvasDocument | null;
|
|
2076
|
+
/** @format int32 */
|
|
2077
|
+
ownVersion?: number | null;
|
|
2078
|
+
isOwnUnreadable: boolean;
|
|
2079
|
+
/** @format date-time */
|
|
2080
|
+
ownUpdatedAt?: string | null;
|
|
2081
|
+
/** @format uuid */
|
|
2082
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
2083
|
+
/** @format int32 */
|
|
2084
|
+
forkedFromVersion?: number | null;
|
|
2085
|
+
inherited?: CanvasDocument | null;
|
|
2086
|
+
/** @format int32 */
|
|
2087
|
+
inheritedVersion?: number | null;
|
|
2088
|
+
inheritedFrom?: CanvasSourceSite | null;
|
|
2089
|
+
isBehindInherited: boolean;
|
|
2090
|
+
effectiveBoards?: CanvasBoard[] | null;
|
|
2091
|
+
effectiveTabs?: ResolvedCanvasTab[] | null;
|
|
2092
|
+
}
|
|
2093
|
+
|
|
2094
|
+
export interface CanvasTab {
|
|
2095
|
+
key: string;
|
|
2096
|
+
/** @format int32 */
|
|
2097
|
+
version: number;
|
|
2098
|
+
title: string;
|
|
2099
|
+
roles: UserRole[];
|
|
2100
|
+
copiedFrom?: CanvasTabOrigin | null;
|
|
2101
|
+
board: CanvasBoard;
|
|
2102
|
+
}
|
|
2103
|
+
|
|
2104
|
+
export interface CanvasTabOrigin {
|
|
2105
|
+
/** @format uuid */
|
|
2106
|
+
siteConfigurationID: string;
|
|
2107
|
+
tabKey: string;
|
|
2108
|
+
/** @format int32 */
|
|
2109
|
+
version: number;
|
|
2110
|
+
}
|
|
2111
|
+
|
|
2112
|
+
export interface CanvasTabView {
|
|
2113
|
+
key: string;
|
|
2114
|
+
title: string;
|
|
2115
|
+
board: CanvasBoardView;
|
|
2116
|
+
}
|
|
2117
|
+
|
|
2118
|
+
export interface CanvasVersion {
|
|
2119
|
+
/** @format int32 */
|
|
2120
|
+
version: number;
|
|
2121
|
+
/** @format date-time */
|
|
2122
|
+
createdAt: string;
|
|
2123
|
+
createdBy?: CanvasAuthor | null;
|
|
2124
|
+
}
|
|
2125
|
+
|
|
2126
|
+
export interface CanvasView {
|
|
2127
|
+
surface: CanvasViewSurfaceEnum;
|
|
2128
|
+
isConfigured: boolean;
|
|
2129
|
+
board?: CanvasBoardView | null;
|
|
2130
|
+
tabs?: CanvasTabView[] | null;
|
|
2131
|
+
standardFields: Record<string, CanvasFieldView>;
|
|
2132
|
+
customFields: Record<string, CanvasFieldView>;
|
|
2133
|
+
}
|
|
2134
|
+
|
|
2135
|
+
export interface CanvasWidget {
|
|
2136
|
+
type: CanvasWidgetTypeEnum;
|
|
2137
|
+
/** @format int32 */
|
|
2138
|
+
configVersion: number;
|
|
2139
|
+
title?: string | null;
|
|
2140
|
+
/** @format int32 */
|
|
2141
|
+
width: number;
|
|
2142
|
+
roles: UserRole[];
|
|
2143
|
+
config:
|
|
2144
|
+
| InformationWidgetConfig
|
|
2145
|
+
| KpiWidgetConfig
|
|
2146
|
+
| KeyDatesWidgetConfig
|
|
2147
|
+
| LoanProgressWidgetConfig
|
|
2148
|
+
| MonthlyPaymentWidgetConfig
|
|
2149
|
+
| AmortizationWidgetConfig
|
|
2150
|
+
| PrimaryBorrowerWidgetConfig
|
|
2151
|
+
| OpenTasksWidgetConfig
|
|
2152
|
+
| DocumentsWidgetConfig
|
|
2153
|
+
| EsignStatusWidgetConfig
|
|
2154
|
+
| LoanTeamWidgetConfig
|
|
2155
|
+
| TextBlockWidgetConfig
|
|
2156
|
+
| SectionDividerWidgetConfig
|
|
2157
|
+
| MyTasksWidgetConfig
|
|
2158
|
+
| RecentLoansWidgetConfig
|
|
2159
|
+
| ClosingSoonWidgetConfig;
|
|
2160
|
+
}
|
|
2161
|
+
|
|
2162
|
+
export interface CanvasWidgetTypeDescriptor {
|
|
2163
|
+
type: CanvasWidgetTypeDescriptorTypeEnum;
|
|
2164
|
+
scope: CanvasWidgetTypeDescriptorScopeEnum;
|
|
2165
|
+
surfaces: CanvasSurface[];
|
|
2166
|
+
audiences: CanvasAudience[];
|
|
2167
|
+
allowedRoles: UserRole[];
|
|
2168
|
+
allowedWidths: number[];
|
|
2169
|
+
/** @format int32 */
|
|
2170
|
+
maxPerBoard: number;
|
|
2171
|
+
/** @format int32 */
|
|
2172
|
+
configVersion: number;
|
|
2173
|
+
}
|
|
2174
|
+
|
|
2175
|
+
export interface CanvasWidgetView {
|
|
2176
|
+
type: CanvasWidgetViewTypeEnum;
|
|
2177
|
+
/** @format int32 */
|
|
2178
|
+
configVersion: number;
|
|
2179
|
+
title?: string | null;
|
|
2180
|
+
/** @format int32 */
|
|
2181
|
+
width: number;
|
|
2182
|
+
config:
|
|
2183
|
+
| InformationWidgetConfig
|
|
2184
|
+
| KpiWidgetConfig
|
|
2185
|
+
| KeyDatesWidgetConfig
|
|
2186
|
+
| LoanProgressWidgetConfig
|
|
2187
|
+
| MonthlyPaymentWidgetConfig
|
|
2188
|
+
| AmortizationWidgetConfig
|
|
2189
|
+
| PrimaryBorrowerWidgetConfig
|
|
2190
|
+
| OpenTasksWidgetConfig
|
|
2191
|
+
| DocumentsWidgetConfig
|
|
2192
|
+
| EsignStatusWidgetConfig
|
|
2193
|
+
| LoanTeamWidgetConfig
|
|
2194
|
+
| TextBlockWidgetConfig
|
|
2195
|
+
| SectionDividerWidgetConfig
|
|
2196
|
+
| MyTasksWidgetConfig
|
|
2197
|
+
| RecentLoansWidgetConfig
|
|
2198
|
+
| ClosingSoonWidgetConfig;
|
|
2199
|
+
}
|
|
2200
|
+
|
|
1831
2201
|
export interface ChangePasswordRequest {
|
|
1832
2202
|
oldPassword: string;
|
|
1833
2203
|
newPassword: string;
|
|
@@ -1862,6 +2232,17 @@ export interface ClosedLoansReportRequest {
|
|
|
1862
2232
|
endDate: string;
|
|
1863
2233
|
}
|
|
1864
2234
|
|
|
2235
|
+
export type ClosingSoonWidgetConfig = UtilRequiredKeys<
|
|
2236
|
+
BaseCanvasWidgetConfig,
|
|
2237
|
+
"type"
|
|
2238
|
+
> & {
|
|
2239
|
+
/** @format int32 */
|
|
2240
|
+
withinDays: number;
|
|
2241
|
+
/** @format int32 */
|
|
2242
|
+
maxItems: number;
|
|
2243
|
+
type: ClosingSoonWidgetConfigTypeEnum;
|
|
2244
|
+
};
|
|
2245
|
+
|
|
1865
2246
|
export interface CommentUserInformation {
|
|
1866
2247
|
entityId: string;
|
|
1867
2248
|
entityType: string;
|
|
@@ -2521,6 +2902,16 @@ export interface DocumentTemplateVersionUpdateRequest {
|
|
|
2521
2902
|
htmlBody: string;
|
|
2522
2903
|
}
|
|
2523
2904
|
|
|
2905
|
+
export type DocumentsWidgetConfig = UtilRequiredKeys<
|
|
2906
|
+
BaseCanvasWidgetConfig,
|
|
2907
|
+
"type"
|
|
2908
|
+
> & {
|
|
2909
|
+
/** @format int32 */
|
|
2910
|
+
maxItems: number;
|
|
2911
|
+
onlyOutstanding: boolean;
|
|
2912
|
+
type: DocumentsWidgetConfigTypeEnum;
|
|
2913
|
+
};
|
|
2914
|
+
|
|
2524
2915
|
export interface Draft {
|
|
2525
2916
|
/** @format date-time */
|
|
2526
2917
|
createdAt: string;
|
|
@@ -2574,7 +2965,7 @@ export interface DraftLoanOfficerReassignRequest {
|
|
|
2574
2965
|
|
|
2575
2966
|
export interface DraftRequest {
|
|
2576
2967
|
applicationPayload: any;
|
|
2577
|
-
customData
|
|
2968
|
+
customData?: any | null;
|
|
2578
2969
|
isCoBorrower: boolean;
|
|
2579
2970
|
}
|
|
2580
2971
|
|
|
@@ -2818,7 +3209,7 @@ export interface EncompassRequestLog {
|
|
|
2818
3209
|
httpStatusCode?: number | null;
|
|
2819
3210
|
/** @format int64 */
|
|
2820
3211
|
durationMs?: number | null;
|
|
2821
|
-
context
|
|
3212
|
+
context?: any | null;
|
|
2822
3213
|
/** @format date-time */
|
|
2823
3214
|
createdAt: string;
|
|
2824
3215
|
}
|
|
@@ -2846,6 +3237,13 @@ export interface Error {
|
|
|
2846
3237
|
message: string;
|
|
2847
3238
|
}
|
|
2848
3239
|
|
|
3240
|
+
export type EsignStatusWidgetConfig = UtilRequiredKeys<
|
|
3241
|
+
BaseCanvasWidgetConfig,
|
|
3242
|
+
"type"
|
|
3243
|
+
> & {
|
|
3244
|
+
type: EsignStatusWidgetConfigTypeEnum;
|
|
3245
|
+
};
|
|
3246
|
+
|
|
2849
3247
|
export interface FailureBucket {
|
|
2850
3248
|
/** @format date-time */
|
|
2851
3249
|
startUtc: string;
|
|
@@ -2959,7 +3357,7 @@ export interface FormSubmission {
|
|
|
2959
3357
|
subjectPropertyAddressCounty?: string | null;
|
|
2960
3358
|
subjectPropertyAddressState?: string | null;
|
|
2961
3359
|
subjectPropertyAddressZip?: string | null;
|
|
2962
|
-
data
|
|
3360
|
+
data?: any | null;
|
|
2963
3361
|
/** @format uuid */
|
|
2964
3362
|
listingID?: string | null;
|
|
2965
3363
|
listing?: Listing | null;
|
|
@@ -3005,7 +3403,7 @@ export interface FormSubmissionRequest {
|
|
|
3005
3403
|
subjectPropertyAddressCounty?: string | null;
|
|
3006
3404
|
subjectPropertyAddressState?: string | null;
|
|
3007
3405
|
subjectPropertyAddressZip?: string | null;
|
|
3008
|
-
data
|
|
3406
|
+
data?: any | null;
|
|
3009
3407
|
/** @format uuid */
|
|
3010
3408
|
listingID?: string | null;
|
|
3011
3409
|
}
|
|
@@ -3154,7 +3552,7 @@ export interface GetWorkflowRequest {
|
|
|
3154
3552
|
export interface GuidPatchOperation {
|
|
3155
3553
|
op: string;
|
|
3156
3554
|
path: string;
|
|
3157
|
-
value
|
|
3555
|
+
value?: any | null;
|
|
3158
3556
|
from?: string | null;
|
|
3159
3557
|
}
|
|
3160
3558
|
|
|
@@ -3232,6 +3630,7 @@ export interface InProgressLoan {
|
|
|
3232
3630
|
siteConfigurationId?: string | null;
|
|
3233
3631
|
/** @format date-time */
|
|
3234
3632
|
updatedAt?: string | null;
|
|
3633
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
3235
3634
|
}
|
|
3236
3635
|
|
|
3237
3636
|
export interface IncompleteApplicationSummary {
|
|
@@ -3268,6 +3667,7 @@ export interface IncompleteLoanBorrower {
|
|
|
3268
3667
|
applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
|
|
3269
3668
|
/** @format date-time */
|
|
3270
3669
|
deletedAt?: string | null;
|
|
3670
|
+
applicationSession?: LoanApplicationSessionRoute | null;
|
|
3271
3671
|
}
|
|
3272
3672
|
|
|
3273
3673
|
export interface IncompleteLoanDraft {
|
|
@@ -3302,6 +3702,19 @@ export interface IncompleteLoanSiteConfiguration {
|
|
|
3302
3702
|
name: string;
|
|
3303
3703
|
}
|
|
3304
3704
|
|
|
3705
|
+
export type InformationWidgetConfig = UtilRequiredKeys<
|
|
3706
|
+
BaseCanvasWidgetConfig,
|
|
3707
|
+
"type"
|
|
3708
|
+
> & {
|
|
3709
|
+
/** @format int32 */
|
|
3710
|
+
columns: number;
|
|
3711
|
+
labelPosition: InformationWidgetConfigLabelPositionEnum;
|
|
3712
|
+
hideWhenEmpty: boolean;
|
|
3713
|
+
emptyText?: string | null;
|
|
3714
|
+
items: CanvasInformationItem[];
|
|
3715
|
+
type: InformationWidgetConfigTypeEnum;
|
|
3716
|
+
};
|
|
3717
|
+
|
|
3305
3718
|
export interface IntegrationSettings {
|
|
3306
3719
|
encompass?: EncompassIntegrationSettings | null;
|
|
3307
3720
|
}
|
|
@@ -3339,6 +3752,24 @@ export interface Invite {
|
|
|
3339
3752
|
/** Array of operations to perform */
|
|
3340
3753
|
export type JsonPatchDocument = Operation[];
|
|
3341
3754
|
|
|
3755
|
+
export type KeyDatesWidgetConfig = UtilRequiredKeys<
|
|
3756
|
+
BaseCanvasWidgetConfig,
|
|
3757
|
+
"type"
|
|
3758
|
+
> & {
|
|
3759
|
+
dates: string[];
|
|
3760
|
+
type: KeyDatesWidgetConfigTypeEnum;
|
|
3761
|
+
};
|
|
3762
|
+
|
|
3763
|
+
export type KpiWidgetConfig = UtilRequiredKeys<
|
|
3764
|
+
BaseCanvasWidgetConfig,
|
|
3765
|
+
"type"
|
|
3766
|
+
> & {
|
|
3767
|
+
field: CanvasFieldRef;
|
|
3768
|
+
label?: string | null;
|
|
3769
|
+
format?: CanvasFieldFormat | null;
|
|
3770
|
+
type: KpiWidgetConfigTypeEnum;
|
|
3771
|
+
};
|
|
3772
|
+
|
|
3342
3773
|
export interface LOSIntegration {
|
|
3343
3774
|
instanceID: string;
|
|
3344
3775
|
}
|
|
@@ -3584,6 +4015,10 @@ export interface LoanApplicationSessionRequest {
|
|
|
3584
4015
|
questionHistory: string[];
|
|
3585
4016
|
}
|
|
3586
4017
|
|
|
4018
|
+
export interface LoanApplicationSessionRoute {
|
|
4019
|
+
routeName: string;
|
|
4020
|
+
}
|
|
4021
|
+
|
|
3587
4022
|
export interface LoanBorrower {
|
|
3588
4023
|
/** @format uuid */
|
|
3589
4024
|
id: string;
|
|
@@ -3604,6 +4039,8 @@ export interface LoanBorrower {
|
|
|
3604
4039
|
numberOfDependents?: number | null;
|
|
3605
4040
|
/** @format int32 */
|
|
3606
4041
|
creditDecisionScore?: number | null;
|
|
4042
|
+
/** @format int32 */
|
|
4043
|
+
estimatedCreditScore?: number | null;
|
|
3607
4044
|
isPrimaryBorrower: boolean;
|
|
3608
4045
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
3609
4046
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
@@ -3984,6 +4421,12 @@ export interface LoanBorrowerEmploymentPrevious {
|
|
|
3984
4421
|
/** @format double */
|
|
3985
4422
|
grossIncome?: number | null;
|
|
3986
4423
|
isSelfEmployed?: boolean | null;
|
|
4424
|
+
/** @format double */
|
|
4425
|
+
bonus?: number | null;
|
|
4426
|
+
/** @format double */
|
|
4427
|
+
overtime?: number | null;
|
|
4428
|
+
/** @format double */
|
|
4429
|
+
commission?: number | null;
|
|
3987
4430
|
address?: AddressV3 | null;
|
|
3988
4431
|
}
|
|
3989
4432
|
|
|
@@ -3998,6 +4441,12 @@ export interface LoanBorrowerEmploymentPreviousRequest {
|
|
|
3998
4441
|
/** @format double */
|
|
3999
4442
|
grossIncome?: number | null;
|
|
4000
4443
|
isSelfEmployed?: boolean | null;
|
|
4444
|
+
/** @format double */
|
|
4445
|
+
bonus?: number | null;
|
|
4446
|
+
/** @format double */
|
|
4447
|
+
overtime?: number | null;
|
|
4448
|
+
/** @format double */
|
|
4449
|
+
commission?: number | null;
|
|
4001
4450
|
address?: AddressRequest | null;
|
|
4002
4451
|
}
|
|
4003
4452
|
|
|
@@ -4210,6 +4659,7 @@ export interface LoanBorrowerRealEstateAsset {
|
|
|
4210
4659
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
4211
4660
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
4212
4661
|
intendedUsageOtherDescription?: string | null;
|
|
4662
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
4213
4663
|
/** @format double */
|
|
4214
4664
|
marketValue?: number | null;
|
|
4215
4665
|
/** @format double */
|
|
@@ -4270,6 +4720,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
|
|
|
4270
4720
|
occupancy?: LoanRealEstateOccupancyType | null;
|
|
4271
4721
|
intendedUsage?: LoanRealEstateIntendedUsageType | null;
|
|
4272
4722
|
intendedUsageOtherDescription?: string | null;
|
|
4723
|
+
propertyType?: LoanRealEstatePropertyType | null;
|
|
4273
4724
|
/** @format double */
|
|
4274
4725
|
marketValue?: number | null;
|
|
4275
4726
|
/** @format double */
|
|
@@ -4305,6 +4756,8 @@ export interface LoanBorrowerRequest {
|
|
|
4305
4756
|
isFirstTimeHomeBuyer?: boolean | null;
|
|
4306
4757
|
hasJointAssetsAndLiabilities?: boolean | null;
|
|
4307
4758
|
dependentAges?: number[] | null;
|
|
4759
|
+
/** @format int32 */
|
|
4760
|
+
estimatedCreditScore?: number | null;
|
|
4308
4761
|
demographics?: LoanBorrowerDemographicsRequest | null;
|
|
4309
4762
|
declarations?: LoanBorrowerDeclarationsRequest | null;
|
|
4310
4763
|
militaryService?: LoanBorrowerMilitaryServiceRequest | null;
|
|
@@ -4964,6 +5417,13 @@ export interface LoanPatchRequestGuidPatchDocument {
|
|
|
4964
5417
|
operations: GuidPatchOperation[];
|
|
4965
5418
|
}
|
|
4966
5419
|
|
|
5420
|
+
export type LoanProgressWidgetConfig = UtilRequiredKeys<
|
|
5421
|
+
BaseCanvasWidgetConfig,
|
|
5422
|
+
"type"
|
|
5423
|
+
> & {
|
|
5424
|
+
type: LoanProgressWidgetConfigTypeEnum;
|
|
5425
|
+
};
|
|
5426
|
+
|
|
4967
5427
|
export interface LoanProperty {
|
|
4968
5428
|
/** @format uuid */
|
|
4969
5429
|
id?: string | null;
|
|
@@ -5099,7 +5559,7 @@ export interface LoanQueueWithData {
|
|
|
5099
5559
|
user: UserPublic;
|
|
5100
5560
|
loanOfficer: LoanOfficerPublic;
|
|
5101
5561
|
siteConfiguration: SiteConfigurationReduced;
|
|
5102
|
-
data
|
|
5562
|
+
data?: any | null;
|
|
5103
5563
|
}
|
|
5104
5564
|
|
|
5105
5565
|
export interface LoanRecommendation {
|
|
@@ -5109,7 +5569,7 @@ export interface LoanRecommendation {
|
|
|
5109
5569
|
displayName: string;
|
|
5110
5570
|
extractedValue: string;
|
|
5111
5571
|
mintable: boolean;
|
|
5112
|
-
currentLoanValue
|
|
5572
|
+
currentLoanValue?: any | null;
|
|
5113
5573
|
/** @format uuid */
|
|
5114
5574
|
sourceDocumentId: string;
|
|
5115
5575
|
sourceDocumentName?: string | null;
|
|
@@ -5287,6 +5747,13 @@ export interface LoanTaskStatusSummary {
|
|
|
5287
5747
|
count: number;
|
|
5288
5748
|
}
|
|
5289
5749
|
|
|
5750
|
+
export type LoanTeamWidgetConfig = UtilRequiredKeys<
|
|
5751
|
+
BaseCanvasWidgetConfig,
|
|
5752
|
+
"type"
|
|
5753
|
+
> & {
|
|
5754
|
+
type: LoanTeamWidgetConfigTypeEnum;
|
|
5755
|
+
};
|
|
5756
|
+
|
|
5290
5757
|
export interface LoanUser {
|
|
5291
5758
|
/** @format uuid */
|
|
5292
5759
|
id: string;
|
|
@@ -5684,7 +6151,7 @@ export interface ModuleParameterValue {
|
|
|
5684
6151
|
parameterID: string;
|
|
5685
6152
|
parameterName: string;
|
|
5686
6153
|
parameterType: string;
|
|
5687
|
-
value
|
|
6154
|
+
value?: any | null;
|
|
5688
6155
|
isInherited: boolean;
|
|
5689
6156
|
}
|
|
5690
6157
|
|
|
@@ -5721,6 +6188,24 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
5721
6188
|
term: number;
|
|
5722
6189
|
}
|
|
5723
6190
|
|
|
6191
|
+
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
|
|
6192
|
+
BaseCanvasWidgetConfig,
|
|
6193
|
+
"type"
|
|
6194
|
+
> & {
|
|
6195
|
+
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
6196
|
+
};
|
|
6197
|
+
|
|
6198
|
+
export type MyTasksWidgetConfig = UtilRequiredKeys<
|
|
6199
|
+
BaseCanvasWidgetConfig,
|
|
6200
|
+
"type"
|
|
6201
|
+
> & {
|
|
6202
|
+
/** @format int32 */
|
|
6203
|
+
dueWithinDays: number;
|
|
6204
|
+
/** @format int32 */
|
|
6205
|
+
maxItems: number;
|
|
6206
|
+
type: MyTasksWidgetConfigTypeEnum;
|
|
6207
|
+
};
|
|
6208
|
+
|
|
5724
6209
|
export interface NoContentResult {
|
|
5725
6210
|
/** @format int32 */
|
|
5726
6211
|
statusCode: number;
|
|
@@ -5868,6 +6353,19 @@ export interface NotificationTemplateVersionUpdateRequest {
|
|
|
5868
6353
|
pushNotificationBody?: string | null;
|
|
5869
6354
|
}
|
|
5870
6355
|
|
|
6356
|
+
export interface OpenBorrowerApplicationEditRequest {
|
|
6357
|
+
isCoBorrower: boolean;
|
|
6358
|
+
}
|
|
6359
|
+
|
|
6360
|
+
export type OpenTasksWidgetConfig = UtilRequiredKeys<
|
|
6361
|
+
BaseCanvasWidgetConfig,
|
|
6362
|
+
"type"
|
|
6363
|
+
> & {
|
|
6364
|
+
/** @format int32 */
|
|
6365
|
+
maxItems: number;
|
|
6366
|
+
type: OpenTasksWidgetConfigTypeEnum;
|
|
6367
|
+
};
|
|
6368
|
+
|
|
5871
6369
|
export interface Operation {
|
|
5872
6370
|
op?: string;
|
|
5873
6371
|
value?: string | number | boolean | null | object;
|
|
@@ -6017,6 +6515,18 @@ export interface PreliminaryCondition {
|
|
|
6017
6515
|
rerequestedBy?: CommentUserInformation | null;
|
|
6018
6516
|
}
|
|
6019
6517
|
|
|
6518
|
+
export interface PreviewSiteConfigurationCanvasRequest {
|
|
6519
|
+
document: CanvasDocument;
|
|
6520
|
+
role?: UserRole | null;
|
|
6521
|
+
}
|
|
6522
|
+
|
|
6523
|
+
export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
|
|
6524
|
+
BaseCanvasWidgetConfig,
|
|
6525
|
+
"type"
|
|
6526
|
+
> & {
|
|
6527
|
+
type: PrimaryBorrowerWidgetConfigTypeEnum;
|
|
6528
|
+
};
|
|
6529
|
+
|
|
6020
6530
|
export interface ProblemDetails {
|
|
6021
6531
|
type?: string | null;
|
|
6022
6532
|
title?: string | null;
|
|
@@ -6027,6 +6537,15 @@ export interface ProblemDetails {
|
|
|
6027
6537
|
[key: string]: any;
|
|
6028
6538
|
}
|
|
6029
6539
|
|
|
6540
|
+
export type RecentLoansWidgetConfig = UtilRequiredKeys<
|
|
6541
|
+
BaseCanvasWidgetConfig,
|
|
6542
|
+
"type"
|
|
6543
|
+
> & {
|
|
6544
|
+
/** @format int32 */
|
|
6545
|
+
maxItems: number;
|
|
6546
|
+
type: RecentLoansWidgetConfigTypeEnum;
|
|
6547
|
+
};
|
|
6548
|
+
|
|
6030
6549
|
export interface RefinanceCalculator {
|
|
6031
6550
|
currentLoan: RefinanceLoan;
|
|
6032
6551
|
refinanceLoan: RefinanceLoan;
|
|
@@ -6147,6 +6666,17 @@ export interface ResetPasswordRequest {
|
|
|
6147
6666
|
password: string;
|
|
6148
6667
|
}
|
|
6149
6668
|
|
|
6669
|
+
export interface ResolvedCanvasTab {
|
|
6670
|
+
tab: CanvasTab;
|
|
6671
|
+
source: CanvasSourceSite;
|
|
6672
|
+
isInherited: boolean;
|
|
6673
|
+
}
|
|
6674
|
+
|
|
6675
|
+
export interface RestoreSiteConfigurationCanvasVersionRequest {
|
|
6676
|
+
/** @format int32 */
|
|
6677
|
+
expectedVersion: number;
|
|
6678
|
+
}
|
|
6679
|
+
|
|
6150
6680
|
export interface RunLOCalculation {
|
|
6151
6681
|
loanID: string;
|
|
6152
6682
|
loanAmount?: string | null;
|
|
@@ -6227,10 +6757,28 @@ export interface SSOTokenRequest {
|
|
|
6227
6757
|
redirectUri?: string | null;
|
|
6228
6758
|
}
|
|
6229
6759
|
|
|
6760
|
+
export interface SaveSiteConfigurationCanvasRequest {
|
|
6761
|
+
document: CanvasDocument;
|
|
6762
|
+
/** @format int32 */
|
|
6763
|
+
expectedVersion?: number | null;
|
|
6764
|
+
/** @format uuid */
|
|
6765
|
+
forkedFromSiteConfigurationID?: string | null;
|
|
6766
|
+
/** @format int32 */
|
|
6767
|
+
forkedFromVersion?: number | null;
|
|
6768
|
+
}
|
|
6769
|
+
|
|
6230
6770
|
export interface SearchCriteria {
|
|
6231
6771
|
searchText?: string | null;
|
|
6232
6772
|
}
|
|
6233
6773
|
|
|
6774
|
+
export type SectionDividerWidgetConfig = UtilRequiredKeys<
|
|
6775
|
+
BaseCanvasWidgetConfig,
|
|
6776
|
+
"type"
|
|
6777
|
+
> & {
|
|
6778
|
+
label?: string | null;
|
|
6779
|
+
type: SectionDividerWidgetConfigTypeEnum;
|
|
6780
|
+
};
|
|
6781
|
+
|
|
6234
6782
|
export interface SendESignatureReminderRequest {
|
|
6235
6783
|
/** @format uuid */
|
|
6236
6784
|
userId: string;
|
|
@@ -6671,6 +7219,12 @@ export interface SiteConfigurationByUrl {
|
|
|
6671
7219
|
workflows: Workflow[];
|
|
6672
7220
|
}
|
|
6673
7221
|
|
|
7222
|
+
export interface SiteConfigurationCanvases {
|
|
7223
|
+
/** @format uuid */
|
|
7224
|
+
siteConfigurationID: string;
|
|
7225
|
+
surfaces: CanvasSurfaceState[];
|
|
7226
|
+
}
|
|
7227
|
+
|
|
6674
7228
|
export interface SiteConfigurationForm {
|
|
6675
7229
|
/** @format date-time */
|
|
6676
7230
|
createdAt: string;
|
|
@@ -7177,6 +7731,14 @@ export interface TemplateTokenRoot {
|
|
|
7177
7731
|
fields: TemplateToken[];
|
|
7178
7732
|
}
|
|
7179
7733
|
|
|
7734
|
+
export type TextBlockWidgetConfig = UtilRequiredKeys<
|
|
7735
|
+
BaseCanvasWidgetConfig,
|
|
7736
|
+
"type"
|
|
7737
|
+
> & {
|
|
7738
|
+
text: string;
|
|
7739
|
+
type: TextBlockWidgetConfigTypeEnum;
|
|
7740
|
+
};
|
|
7741
|
+
|
|
7180
7742
|
export interface Theme {
|
|
7181
7743
|
logoURL: string;
|
|
7182
7744
|
primaryColor: string;
|
|
@@ -7281,6 +7843,8 @@ export interface UnprocessableEntity {
|
|
|
7281
7843
|
export interface UnprocessableEntityError {
|
|
7282
7844
|
error: string;
|
|
7283
7845
|
property: string;
|
|
7846
|
+
code?: string | null;
|
|
7847
|
+
params?: Record<string, any> | null;
|
|
7284
7848
|
}
|
|
7285
7849
|
|
|
7286
7850
|
export interface UnregisteredBorrower {
|
|
@@ -7435,6 +7999,10 @@ export interface UpdateLoanRoleTaskRequest {
|
|
|
7435
7999
|
dueDate?: string | null;
|
|
7436
8000
|
}
|
|
7437
8001
|
|
|
8002
|
+
export interface UpdateLoanSigningMethodRequest {
|
|
8003
|
+
signingMethod?: SigningMethod | null;
|
|
8004
|
+
}
|
|
8005
|
+
|
|
7438
8006
|
export interface UpdateMeRequest {
|
|
7439
8007
|
phone?: string | null;
|
|
7440
8008
|
firstName: string;
|
|
@@ -8007,6 +8575,14 @@ export interface Workflow {
|
|
|
8007
8575
|
icon: string;
|
|
8008
8576
|
}
|
|
8009
8577
|
|
|
8578
|
+
interface BaseCanvasWidgetConfig {
|
|
8579
|
+
type: string;
|
|
8580
|
+
}
|
|
8581
|
+
|
|
8582
|
+
type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
|
|
8583
|
+
type: Key;
|
|
8584
|
+
} & Type;
|
|
8585
|
+
|
|
8010
8586
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
8011
8587
|
|
|
8012
8588
|
export type AiAuditLogEventTypeEnum =
|
|
@@ -8077,6 +8653,8 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
|
|
|
8077
8653
|
|
|
8078
8654
|
export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
|
|
8079
8655
|
|
|
8656
|
+
export type AmortizationWidgetConfigTypeEnum = "Amortization";
|
|
8657
|
+
|
|
8080
8658
|
export type AuditLogEntryChangeTypeEnum =
|
|
8081
8659
|
| "Created"
|
|
8082
8660
|
| "Modified"
|
|
@@ -8087,6 +8665,17 @@ export type AuditLogEntryChangeTypeEnum =
|
|
|
8087
8665
|
| "Reactivated"
|
|
8088
8666
|
| "Accessed";
|
|
8089
8667
|
|
|
8668
|
+
export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
|
|
8669
|
+
|
|
8670
|
+
export type BorrowerApplicationWarningCodeEnum =
|
|
8671
|
+
| "UnknownKey"
|
|
8672
|
+
| "NotWritable"
|
|
8673
|
+
| "CustomFieldUnresolved"
|
|
8674
|
+
| "CustomFieldInactive"
|
|
8675
|
+
| "CustomFieldReadOnly"
|
|
8676
|
+
| "CustomFieldDuplicateDefinition"
|
|
8677
|
+
| "LoanOfficerUnresolved";
|
|
8678
|
+
|
|
8090
8679
|
export type BorrowerCountRoleEnum =
|
|
8091
8680
|
| "Borrower"
|
|
8092
8681
|
| "CoBorrower"
|
|
@@ -8117,6 +8706,133 @@ export type BorrowerIdentityRoleEnum =
|
|
|
8117
8706
|
| "SettlementAgent"
|
|
8118
8707
|
| "Admin";
|
|
8119
8708
|
|
|
8709
|
+
export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
|
|
8710
|
+
|
|
8711
|
+
export type CanvasFieldDescriptorDataTypeEnum =
|
|
8712
|
+
| "Text"
|
|
8713
|
+
| "Number"
|
|
8714
|
+
| "Decimal"
|
|
8715
|
+
| "Boolean"
|
|
8716
|
+
| "Date"
|
|
8717
|
+
| "DateTime"
|
|
8718
|
+
| "SingleSelect"
|
|
8719
|
+
| "MultiSelect";
|
|
8720
|
+
|
|
8721
|
+
export type CanvasFieldDescriptorFormatEnum =
|
|
8722
|
+
| "Text"
|
|
8723
|
+
| "Number"
|
|
8724
|
+
| "Currency"
|
|
8725
|
+
| "Percent"
|
|
8726
|
+
| "DateShort"
|
|
8727
|
+
| "DateLong"
|
|
8728
|
+
| "YesNo";
|
|
8729
|
+
|
|
8730
|
+
export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
|
|
8731
|
+
|
|
8732
|
+
export type CanvasFieldValueDataTypeEnum =
|
|
8733
|
+
| "Text"
|
|
8734
|
+
| "Number"
|
|
8735
|
+
| "Decimal"
|
|
8736
|
+
| "Boolean"
|
|
8737
|
+
| "Date"
|
|
8738
|
+
| "DateTime"
|
|
8739
|
+
| "SingleSelect"
|
|
8740
|
+
| "MultiSelect";
|
|
8741
|
+
|
|
8742
|
+
export type CanvasFieldViewDataTypeEnum =
|
|
8743
|
+
| "Text"
|
|
8744
|
+
| "Number"
|
|
8745
|
+
| "Decimal"
|
|
8746
|
+
| "Boolean"
|
|
8747
|
+
| "Date"
|
|
8748
|
+
| "DateTime"
|
|
8749
|
+
| "SingleSelect"
|
|
8750
|
+
| "MultiSelect";
|
|
8751
|
+
|
|
8752
|
+
export type CanvasFieldViewFormatEnum =
|
|
8753
|
+
| "Text"
|
|
8754
|
+
| "Number"
|
|
8755
|
+
| "Currency"
|
|
8756
|
+
| "Percent"
|
|
8757
|
+
| "DateShort"
|
|
8758
|
+
| "DateLong"
|
|
8759
|
+
| "YesNo";
|
|
8760
|
+
|
|
8761
|
+
export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
|
|
8762
|
+
|
|
8763
|
+
export type CanvasSourceSiteTypeEnum =
|
|
8764
|
+
| "None"
|
|
8765
|
+
| "Account"
|
|
8766
|
+
| "Corporate"
|
|
8767
|
+
| "Branch"
|
|
8768
|
+
| "LoanOfficer"
|
|
8769
|
+
| "Partner";
|
|
8770
|
+
|
|
8771
|
+
export type CanvasSurfaceStateSurfaceEnum =
|
|
8772
|
+
| "Home"
|
|
8773
|
+
| "LoanSummary"
|
|
8774
|
+
| "LoanDetails";
|
|
8775
|
+
|
|
8776
|
+
export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
8777
|
+
|
|
8778
|
+
export type CanvasWidgetTypeEnum =
|
|
8779
|
+
| "Information"
|
|
8780
|
+
| "Kpi"
|
|
8781
|
+
| "KeyDates"
|
|
8782
|
+
| "LoanProgress"
|
|
8783
|
+
| "MonthlyPayment"
|
|
8784
|
+
| "Amortization"
|
|
8785
|
+
| "PrimaryBorrower"
|
|
8786
|
+
| "OpenTasks"
|
|
8787
|
+
| "Documents"
|
|
8788
|
+
| "EsignStatus"
|
|
8789
|
+
| "LoanTeam"
|
|
8790
|
+
| "TextBlock"
|
|
8791
|
+
| "SectionDivider"
|
|
8792
|
+
| "MyTasks"
|
|
8793
|
+
| "RecentLoans"
|
|
8794
|
+
| "ClosingSoon";
|
|
8795
|
+
|
|
8796
|
+
export type CanvasWidgetTypeDescriptorTypeEnum =
|
|
8797
|
+
| "Information"
|
|
8798
|
+
| "Kpi"
|
|
8799
|
+
| "KeyDates"
|
|
8800
|
+
| "LoanProgress"
|
|
8801
|
+
| "MonthlyPayment"
|
|
8802
|
+
| "Amortization"
|
|
8803
|
+
| "PrimaryBorrower"
|
|
8804
|
+
| "OpenTasks"
|
|
8805
|
+
| "Documents"
|
|
8806
|
+
| "EsignStatus"
|
|
8807
|
+
| "LoanTeam"
|
|
8808
|
+
| "TextBlock"
|
|
8809
|
+
| "SectionDivider"
|
|
8810
|
+
| "MyTasks"
|
|
8811
|
+
| "RecentLoans"
|
|
8812
|
+
| "ClosingSoon";
|
|
8813
|
+
|
|
8814
|
+
export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
|
|
8815
|
+
|
|
8816
|
+
export type CanvasWidgetViewTypeEnum =
|
|
8817
|
+
| "Information"
|
|
8818
|
+
| "Kpi"
|
|
8819
|
+
| "KeyDates"
|
|
8820
|
+
| "LoanProgress"
|
|
8821
|
+
| "MonthlyPayment"
|
|
8822
|
+
| "Amortization"
|
|
8823
|
+
| "PrimaryBorrower"
|
|
8824
|
+
| "OpenTasks"
|
|
8825
|
+
| "Documents"
|
|
8826
|
+
| "EsignStatus"
|
|
8827
|
+
| "LoanTeam"
|
|
8828
|
+
| "TextBlock"
|
|
8829
|
+
| "SectionDivider"
|
|
8830
|
+
| "MyTasks"
|
|
8831
|
+
| "RecentLoans"
|
|
8832
|
+
| "ClosingSoon";
|
|
8833
|
+
|
|
8834
|
+
export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
|
|
8835
|
+
|
|
8120
8836
|
export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
|
|
8121
8837
|
|
|
8122
8838
|
export type CompanyDocumentIndexStatusEnum =
|
|
@@ -8289,6 +9005,8 @@ export type CustomFieldValueDataTypeEnum =
|
|
|
8289
9005
|
| "SingleSelect"
|
|
8290
9006
|
| "MultiSelect";
|
|
8291
9007
|
|
|
9008
|
+
export type DocumentsWidgetConfigTypeEnum = "Documents";
|
|
9009
|
+
|
|
8292
9010
|
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
8293
9011
|
|
|
8294
9012
|
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
@@ -8330,6 +9048,8 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
|
|
|
8330
9048
|
| "WebDocuments"
|
|
8331
9049
|
| "PosfCreatePackage";
|
|
8332
9050
|
|
|
9051
|
+
export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
|
|
9052
|
+
|
|
8333
9053
|
export type GenerateSystemPromptRequestCategoryEnum =
|
|
8334
9054
|
| "DocumentAnalysis"
|
|
8335
9055
|
| "DataQuery"
|
|
@@ -8375,6 +9095,14 @@ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
|
8375
9095
|
|
|
8376
9096
|
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
8377
9097
|
|
|
9098
|
+
export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
|
|
9099
|
+
|
|
9100
|
+
export type InformationWidgetConfigTypeEnum = "Information";
|
|
9101
|
+
|
|
9102
|
+
export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
|
|
9103
|
+
|
|
9104
|
+
export type KpiWidgetConfigTypeEnum = "Kpi";
|
|
9105
|
+
|
|
8378
9106
|
export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
|
|
8379
9107
|
|
|
8380
9108
|
export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
@@ -8480,7 +9208,8 @@ export type LoanLogTypeEnum =
|
|
|
8480
9208
|
| "CoBorrowerEmailAutoFixed"
|
|
8481
9209
|
| "LosFieldWriteBack"
|
|
8482
9210
|
| "ReferrerChangeDiscarded"
|
|
8483
|
-
| "TaskEdited"
|
|
9211
|
+
| "TaskEdited"
|
|
9212
|
+
| "SigningMethodChanged";
|
|
8484
9213
|
|
|
8485
9214
|
export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
|
|
8486
9215
|
|
|
@@ -8505,7 +9234,10 @@ export type LoanLogDetailTypeEnum =
|
|
|
8505
9234
|
| "CoBorrowerEmailAutoFixed"
|
|
8506
9235
|
| "LosFieldWriteBack"
|
|
8507
9236
|
| "ReferrerChangeDiscarded"
|
|
8508
|
-
| "TaskEdited"
|
|
9237
|
+
| "TaskEdited"
|
|
9238
|
+
| "SigningMethodChanged";
|
|
9239
|
+
|
|
9240
|
+
export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
|
|
8509
9241
|
|
|
8510
9242
|
export type LoanRoleSlotTasksRoleEnum =
|
|
8511
9243
|
| "Borrower"
|
|
@@ -8560,6 +9292,8 @@ export type LoanTaskStatusSummaryStatusEnum =
|
|
|
8560
9292
|
| "Rejected"
|
|
8561
9293
|
| "Unknown";
|
|
8562
9294
|
|
|
9295
|
+
export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
|
|
9296
|
+
|
|
8563
9297
|
export type LoanUserLoanRoleEnum =
|
|
8564
9298
|
| "Borrower"
|
|
8565
9299
|
| "CoBorrower"
|
|
@@ -8691,6 +9425,12 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
|
|
|
8691
9425
|
| "AiGeneratedDocument"
|
|
8692
9426
|
| "Unidentified";
|
|
8693
9427
|
|
|
9428
|
+
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
9429
|
+
|
|
9430
|
+
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
9431
|
+
|
|
9432
|
+
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
9433
|
+
|
|
8694
9434
|
export type PendingInviteStatusEnum =
|
|
8695
9435
|
| "InvitePending"
|
|
8696
9436
|
| "InviteExpired"
|
|
@@ -8711,6 +9451,12 @@ export type PendingInviteRoleEnum =
|
|
|
8711
9451
|
| "SettlementAgent"
|
|
8712
9452
|
| "Admin";
|
|
8713
9453
|
|
|
9454
|
+
export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
|
|
9455
|
+
|
|
9456
|
+
export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
|
|
9457
|
+
|
|
9458
|
+
export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
|
|
9459
|
+
|
|
8714
9460
|
export type SiteConfigurationTypeEnum =
|
|
8715
9461
|
| "None"
|
|
8716
9462
|
| "Account"
|
|
@@ -8763,6 +9509,8 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
|
8763
9509
|
|
|
8764
9510
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
8765
9511
|
|
|
9512
|
+
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
9513
|
+
|
|
8766
9514
|
export type UnregisteredBorrowerRoleEnum =
|
|
8767
9515
|
| "Borrower"
|
|
8768
9516
|
| "CoBorrower"
|
|
@@ -8847,6 +9595,10 @@ export type UserLoanConsentLosSyncStatusEnum =
|
|
|
8847
9595
|
|
|
8848
9596
|
export type UserTableSettingsTableKeyEnum = "Pipeline";
|
|
8849
9597
|
|
|
9598
|
+
export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
9599
|
+
|
|
9600
|
+
export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
9601
|
+
|
|
8850
9602
|
export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
|
|
8851
9603
|
|
|
8852
9604
|
/** @default "Realtor" */
|
|
@@ -8861,6 +9613,56 @@ export type GetPartnersParamsRoleEnum =
|
|
|
8861
9613
|
| "LoanOfficerAssistant"
|
|
8862
9614
|
| "SystemAdmin";
|
|
8863
9615
|
|
|
9616
|
+
export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
|
|
9617
|
+
| "Home"
|
|
9618
|
+
| "LoanSummary"
|
|
9619
|
+
| "LoanDetails";
|
|
9620
|
+
|
|
9621
|
+
export type SaveSiteConfigurationCanvasParamsEnum =
|
|
9622
|
+
| "Home"
|
|
9623
|
+
| "LoanSummary"
|
|
9624
|
+
| "LoanDetails";
|
|
9625
|
+
|
|
9626
|
+
export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
|
|
9627
|
+
| "Home"
|
|
9628
|
+
| "LoanSummary"
|
|
9629
|
+
| "LoanDetails";
|
|
9630
|
+
|
|
9631
|
+
export type DeleteSiteConfigurationCanvasParamsEnum =
|
|
9632
|
+
| "Home"
|
|
9633
|
+
| "LoanSummary"
|
|
9634
|
+
| "LoanDetails";
|
|
9635
|
+
|
|
9636
|
+
export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
|
|
9637
|
+
| "Home"
|
|
9638
|
+
| "LoanSummary"
|
|
9639
|
+
| "LoanDetails";
|
|
9640
|
+
|
|
9641
|
+
export type PreviewSiteConfigurationCanvasParamsEnum =
|
|
9642
|
+
| "Home"
|
|
9643
|
+
| "LoanSummary"
|
|
9644
|
+
| "LoanDetails";
|
|
9645
|
+
|
|
9646
|
+
export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
|
|
9647
|
+
| "Home"
|
|
9648
|
+
| "LoanSummary"
|
|
9649
|
+
| "LoanDetails";
|
|
9650
|
+
|
|
9651
|
+
export type GetSiteConfigurationCanvasVersionsParamsEnum =
|
|
9652
|
+
| "Home"
|
|
9653
|
+
| "LoanSummary"
|
|
9654
|
+
| "LoanDetails";
|
|
9655
|
+
|
|
9656
|
+
export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
|
|
9657
|
+
| "Home"
|
|
9658
|
+
| "LoanSummary"
|
|
9659
|
+
| "LoanDetails";
|
|
9660
|
+
|
|
9661
|
+
export type RestoreSiteConfigurationCanvasVersionParamsEnum =
|
|
9662
|
+
| "Home"
|
|
9663
|
+
| "LoanSummary"
|
|
9664
|
+
| "LoanDetails";
|
|
9665
|
+
|
|
8864
9666
|
export type GetSamlMetadataParamsSSoIntegrationEnum =
|
|
8865
9667
|
| "ConsumerConnect"
|
|
8866
9668
|
| "TheBigPOS"
|
|
@@ -9007,7 +9809,15 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
9007
9809
|
property instanceof Array ? property : [property];
|
|
9008
9810
|
|
|
9009
9811
|
for (const formItem of propertyContent) {
|
|
9010
|
-
|
|
9812
|
+
// React Native files are plain { uri, name, type } objects, not Blob/File.
|
|
9813
|
+
const isReactNativeFile =
|
|
9814
|
+
!!formItem &&
|
|
9815
|
+
typeof formItem === "object" &&
|
|
9816
|
+
"uri" in formItem &&
|
|
9817
|
+
"name" in formItem &&
|
|
9818
|
+
"type" in formItem;
|
|
9819
|
+
const isFileType =
|
|
9820
|
+
isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
|
|
9011
9821
|
formData.append(
|
|
9012
9822
|
key,
|
|
9013
9823
|
isFileType ? formItem : this.stringifyFormItem(formItem),
|
|
@@ -9069,7 +9879,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
9069
9879
|
|
|
9070
9880
|
/**
|
|
9071
9881
|
* @title The Big POS API
|
|
9072
|
-
* @version v3.
|
|
9882
|
+
* @version v3.16.0
|
|
9073
9883
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
9074
9884
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
9075
9885
|
*/
|
|
@@ -11354,12 +12164,71 @@ export class Api<
|
|
|
11354
12164
|
/**
|
|
11355
12165
|
* No description
|
|
11356
12166
|
*
|
|
11357
|
-
* @tags
|
|
11358
|
-
* @name
|
|
11359
|
-
* @summary Get
|
|
11360
|
-
* @request GET:/api/
|
|
12167
|
+
* @tags BorrowerApplication
|
|
12168
|
+
* @name GetBorrowerApplication
|
|
12169
|
+
* @summary Get a borrower's application as flat answers
|
|
12170
|
+
* @request GET:/api/loans/{loanId}/borrowers/{borrowerId}/application
|
|
11361
12171
|
* @secure
|
|
11362
|
-
* @response `200` `
|
|
12172
|
+
* @response `200` `BorrowerApplication` OK
|
|
12173
|
+
* @response `400` `any` Bad Request
|
|
12174
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12175
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12176
|
+
*/
|
|
12177
|
+
getBorrowerApplication: (
|
|
12178
|
+
loanId: string,
|
|
12179
|
+
borrowerId: string,
|
|
12180
|
+
params: RequestParams = {},
|
|
12181
|
+
) =>
|
|
12182
|
+
this.request<BorrowerApplication, ProblemDetails>({
|
|
12183
|
+
path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`,
|
|
12184
|
+
method: "GET",
|
|
12185
|
+
secure: true,
|
|
12186
|
+
format: "json",
|
|
12187
|
+
...params,
|
|
12188
|
+
}),
|
|
12189
|
+
|
|
12190
|
+
/**
|
|
12191
|
+
* No description
|
|
12192
|
+
*
|
|
12193
|
+
* @tags BorrowerApplication
|
|
12194
|
+
* @name UpdateBorrowerApplication
|
|
12195
|
+
* @summary Save a step of a borrower's application from flat answers
|
|
12196
|
+
* @request PATCH:/api/loans/{loanId}/borrowers/{borrowerId}/application
|
|
12197
|
+
* @secure
|
|
12198
|
+
* @response `200` `BorrowerApplicationUpdate` OK
|
|
12199
|
+
* @response `400` `any` Bad Request
|
|
12200
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12201
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12202
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
12203
|
+
*/
|
|
12204
|
+
updateBorrowerApplication: (
|
|
12205
|
+
loanId: string,
|
|
12206
|
+
borrowerId: string,
|
|
12207
|
+
data: JsonPatchDocument,
|
|
12208
|
+
params: RequestParams = {},
|
|
12209
|
+
) =>
|
|
12210
|
+
this.request<
|
|
12211
|
+
BorrowerApplicationUpdate,
|
|
12212
|
+
ProblemDetails | UnprocessableEntity
|
|
12213
|
+
>({
|
|
12214
|
+
path: `/api/loans/${loanId}/borrowers/${borrowerId}/application`,
|
|
12215
|
+
method: "PATCH",
|
|
12216
|
+
body: data,
|
|
12217
|
+
secure: true,
|
|
12218
|
+
type: "application/json",
|
|
12219
|
+
format: "json",
|
|
12220
|
+
...params,
|
|
12221
|
+
}),
|
|
12222
|
+
|
|
12223
|
+
/**
|
|
12224
|
+
* No description
|
|
12225
|
+
*
|
|
12226
|
+
* @tags Branches
|
|
12227
|
+
* @name GetBranches
|
|
12228
|
+
* @summary Get All
|
|
12229
|
+
* @request GET:/api/branches
|
|
12230
|
+
* @secure
|
|
12231
|
+
* @response `200` `GetBranchPaginated` OK
|
|
11363
12232
|
*/
|
|
11364
12233
|
getBranches: (
|
|
11365
12234
|
query?: {
|
|
@@ -11750,6 +12619,78 @@ export class Api<
|
|
|
11750
12619
|
...params,
|
|
11751
12620
|
}),
|
|
11752
12621
|
|
|
12622
|
+
/**
|
|
12623
|
+
* No description
|
|
12624
|
+
*
|
|
12625
|
+
* @tags Canvases
|
|
12626
|
+
* @name GetCanvas
|
|
12627
|
+
* @summary Get a site's canvas for one surface, as the signed-in user sees it
|
|
12628
|
+
* @request GET:/api/canvases/{surface}
|
|
12629
|
+
* @secure
|
|
12630
|
+
* @response `200` `CanvasView` OK
|
|
12631
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12632
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12633
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
12634
|
+
*/
|
|
12635
|
+
getCanvas: (
|
|
12636
|
+
surface: GetCanvasParamsEnum,
|
|
12637
|
+
query: {
|
|
12638
|
+
/** @format uuid */
|
|
12639
|
+
siteConfigurationId: string;
|
|
12640
|
+
},
|
|
12641
|
+
params: RequestParams = {},
|
|
12642
|
+
) =>
|
|
12643
|
+
this.request<CanvasView, ProblemDetails>({
|
|
12644
|
+
path: `/api/canvases/${surface}`,
|
|
12645
|
+
method: "GET",
|
|
12646
|
+
query: query,
|
|
12647
|
+
secure: true,
|
|
12648
|
+
format: "json",
|
|
12649
|
+
...params,
|
|
12650
|
+
}),
|
|
12651
|
+
|
|
12652
|
+
/**
|
|
12653
|
+
* @description A standard field's key and every categoryKey never change: saved layouts refer to fields by key, and a client can translate labels and categories by these keys.
|
|
12654
|
+
*
|
|
12655
|
+
* @tags CanvasFields
|
|
12656
|
+
* @name GetCanvasFields
|
|
12657
|
+
* @summary Get the fields a canvas can show
|
|
12658
|
+
* @request GET:/api/canvas/fields
|
|
12659
|
+
* @secure
|
|
12660
|
+
* @response `200` `CanvasFieldCatalog` OK
|
|
12661
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12662
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12663
|
+
*/
|
|
12664
|
+
getCanvasFields: (params: RequestParams = {}) =>
|
|
12665
|
+
this.request<CanvasFieldCatalog, ProblemDetails>({
|
|
12666
|
+
path: `/api/canvas/fields`,
|
|
12667
|
+
method: "GET",
|
|
12668
|
+
secure: true,
|
|
12669
|
+
format: "json",
|
|
12670
|
+
...params,
|
|
12671
|
+
}),
|
|
12672
|
+
|
|
12673
|
+
/**
|
|
12674
|
+
* No description
|
|
12675
|
+
*
|
|
12676
|
+
* @tags CanvasWidgetTypes
|
|
12677
|
+
* @name GetCanvasWidgetTypes
|
|
12678
|
+
* @summary Get canvas widget types
|
|
12679
|
+
* @request GET:/api/canvas/widget-types
|
|
12680
|
+
* @secure
|
|
12681
|
+
* @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
|
|
12682
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12683
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12684
|
+
*/
|
|
12685
|
+
getCanvasWidgetTypes: (params: RequestParams = {}) =>
|
|
12686
|
+
this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
|
|
12687
|
+
path: `/api/canvas/widget-types`,
|
|
12688
|
+
method: "GET",
|
|
12689
|
+
secure: true,
|
|
12690
|
+
format: "json",
|
|
12691
|
+
...params,
|
|
12692
|
+
}),
|
|
12693
|
+
|
|
11753
12694
|
/**
|
|
11754
12695
|
* @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
|
|
11755
12696
|
*
|
|
@@ -15004,6 +15945,36 @@ export class Api<
|
|
|
15004
15945
|
...params,
|
|
15005
15946
|
}),
|
|
15006
15947
|
|
|
15948
|
+
/**
|
|
15949
|
+
* No description
|
|
15950
|
+
*
|
|
15951
|
+
* @tags LoanApplicationEdit
|
|
15952
|
+
* @name OpenBorrowerApplicationEdit
|
|
15953
|
+
* @summary Open a borrower's submitted application for editing
|
|
15954
|
+
* @request POST:/api/loans/{loanId}/application/edit
|
|
15955
|
+
* @secure
|
|
15956
|
+
* @response `200` `BorrowerApplication` OK
|
|
15957
|
+
* @response `400` `any` Bad Request
|
|
15958
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
15959
|
+
* @response `404` `ProblemDetails` Not Found
|
|
15960
|
+
* @response `409` `ProblemDetails` Conflict
|
|
15961
|
+
* @response `423` `any` Locked
|
|
15962
|
+
*/
|
|
15963
|
+
openBorrowerApplicationEdit: (
|
|
15964
|
+
loanId: string,
|
|
15965
|
+
data: OpenBorrowerApplicationEditRequest,
|
|
15966
|
+
params: RequestParams = {},
|
|
15967
|
+
) =>
|
|
15968
|
+
this.request<BorrowerApplication, ProblemDetails>({
|
|
15969
|
+
path: `/api/loans/${loanId}/application/edit`,
|
|
15970
|
+
method: "POST",
|
|
15971
|
+
body: data,
|
|
15972
|
+
secure: true,
|
|
15973
|
+
type: "application/json",
|
|
15974
|
+
format: "json",
|
|
15975
|
+
...params,
|
|
15976
|
+
}),
|
|
15977
|
+
|
|
15007
15978
|
/**
|
|
15008
15979
|
* No description
|
|
15009
15980
|
*
|
|
@@ -15094,6 +16065,35 @@ export class Api<
|
|
|
15094
16065
|
...params,
|
|
15095
16066
|
}),
|
|
15096
16067
|
|
|
16068
|
+
/**
|
|
16069
|
+
* No description
|
|
16070
|
+
*
|
|
16071
|
+
* @tags LoanCanvasFieldValues
|
|
16072
|
+
* @name GetLoanCanvasFieldValues
|
|
16073
|
+
* @summary Get a loan's values for canvas fields
|
|
16074
|
+
* @request POST:/api/loans/{loanId}/canvas/field-values
|
|
16075
|
+
* @secure
|
|
16076
|
+
* @response `200` `CanvasFieldValues` OK
|
|
16077
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
16078
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
16079
|
+
* @response `404` `ProblemDetails` Not Found
|
|
16080
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
16081
|
+
*/
|
|
16082
|
+
getLoanCanvasFieldValues: (
|
|
16083
|
+
loanId: string,
|
|
16084
|
+
data: CanvasFieldValuesRequest,
|
|
16085
|
+
params: RequestParams = {},
|
|
16086
|
+
) =>
|
|
16087
|
+
this.request<CanvasFieldValues, ProblemDetails>({
|
|
16088
|
+
path: `/api/loans/${loanId}/canvas/field-values`,
|
|
16089
|
+
method: "POST",
|
|
16090
|
+
body: data,
|
|
16091
|
+
secure: true,
|
|
16092
|
+
type: "application/json",
|
|
16093
|
+
format: "json",
|
|
16094
|
+
...params,
|
|
16095
|
+
}),
|
|
16096
|
+
|
|
15097
16097
|
/**
|
|
15098
16098
|
* No description
|
|
15099
16099
|
*
|
|
@@ -16994,6 +17994,7 @@ export class Api<
|
|
|
16994
17994
|
* @response `404` `ProblemDetails` Not Found
|
|
16995
17995
|
* @response `409` `ProblemDetails` Conflict
|
|
16996
17996
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
17997
|
+
* @response `423` `ProblemDetails` Locked
|
|
16997
17998
|
*/
|
|
16998
17999
|
completeBorrowerApplication: (
|
|
16999
18000
|
loanId: string,
|
|
@@ -17196,6 +18197,33 @@ export class Api<
|
|
|
17196
18197
|
...params,
|
|
17197
18198
|
}),
|
|
17198
18199
|
|
|
18200
|
+
/**
|
|
18201
|
+
* No description
|
|
18202
|
+
*
|
|
18203
|
+
* @tags LoanSigningMethod
|
|
18204
|
+
* @name UpdateLoanSigningMethod
|
|
18205
|
+
* @summary Switch the loan's signing method
|
|
18206
|
+
* @request PUT:/api/loans/{loanId}/signing-method
|
|
18207
|
+
* @secure
|
|
18208
|
+
* @response `204` `void` No Content
|
|
18209
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
18210
|
+
* @response `404` `ProblemDetails` Not Found
|
|
18211
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
18212
|
+
*/
|
|
18213
|
+
updateLoanSigningMethod: (
|
|
18214
|
+
loanId: string,
|
|
18215
|
+
data: UpdateLoanSigningMethodRequest,
|
|
18216
|
+
params: RequestParams = {},
|
|
18217
|
+
) =>
|
|
18218
|
+
this.request<void, ProblemDetails>({
|
|
18219
|
+
path: `/api/loans/${loanId}/signing-method`,
|
|
18220
|
+
method: "PUT",
|
|
18221
|
+
body: data,
|
|
18222
|
+
secure: true,
|
|
18223
|
+
type: "application/json",
|
|
18224
|
+
...params,
|
|
18225
|
+
}),
|
|
18226
|
+
|
|
17199
18227
|
/**
|
|
17200
18228
|
* No description
|
|
17201
18229
|
*
|
|
@@ -18785,6 +19813,186 @@ export class Api<
|
|
|
18785
19813
|
...params,
|
|
18786
19814
|
}),
|
|
18787
19815
|
|
|
19816
|
+
/**
|
|
19817
|
+
* No description
|
|
19818
|
+
*
|
|
19819
|
+
* @tags SiteConfigurationCanvases
|
|
19820
|
+
* @name GetSiteConfigurationCanvases
|
|
19821
|
+
* @summary Get a site's canvases: own, inherited and effective per surface
|
|
19822
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases
|
|
19823
|
+
* @secure
|
|
19824
|
+
* @response `200` `SiteConfigurationCanvases` OK
|
|
19825
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19826
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19827
|
+
*/
|
|
19828
|
+
getSiteConfigurationCanvases: (
|
|
19829
|
+
siteConfigurationId: string,
|
|
19830
|
+
params: RequestParams = {},
|
|
19831
|
+
) =>
|
|
19832
|
+
this.request<SiteConfigurationCanvases, ProblemDetails>({
|
|
19833
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases`,
|
|
19834
|
+
method: "GET",
|
|
19835
|
+
secure: true,
|
|
19836
|
+
format: "json",
|
|
19837
|
+
...params,
|
|
19838
|
+
}),
|
|
19839
|
+
|
|
19840
|
+
/**
|
|
19841
|
+
* @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
|
|
19842
|
+
*
|
|
19843
|
+
* @tags SiteConfigurationCanvases
|
|
19844
|
+
* @name SaveSiteConfigurationCanvas
|
|
19845
|
+
* @summary Save a site's canvas for one surface
|
|
19846
|
+
* @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
19847
|
+
* @secure
|
|
19848
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
19849
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
19850
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19851
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19852
|
+
* @response `409` `ProblemDetails` Conflict
|
|
19853
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
19854
|
+
* @response `423` `ProblemDetails` Locked
|
|
19855
|
+
*/
|
|
19856
|
+
saveSiteConfigurationCanvas: (
|
|
19857
|
+
siteConfigurationId: string,
|
|
19858
|
+
surface: SaveSiteConfigurationCanvasParamsEnum,
|
|
19859
|
+
data: SaveSiteConfigurationCanvasRequest,
|
|
19860
|
+
params: RequestParams = {},
|
|
19861
|
+
) =>
|
|
19862
|
+
this.request<CanvasSurfaceState, ProblemDetails>({
|
|
19863
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
|
|
19864
|
+
method: "PUT",
|
|
19865
|
+
body: data,
|
|
19866
|
+
secure: true,
|
|
19867
|
+
type: "application/json",
|
|
19868
|
+
format: "json",
|
|
19869
|
+
...params,
|
|
19870
|
+
}),
|
|
19871
|
+
|
|
19872
|
+
/**
|
|
19873
|
+
* No description
|
|
19874
|
+
*
|
|
19875
|
+
* @tags SiteConfigurationCanvases
|
|
19876
|
+
* @name DeleteSiteConfigurationCanvas
|
|
19877
|
+
* @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
|
|
19878
|
+
* @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
|
|
19879
|
+
* @secure
|
|
19880
|
+
* @response `204` `void` No Content
|
|
19881
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
19882
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19883
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19884
|
+
* @response `409` `ProblemDetails` Conflict
|
|
19885
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
19886
|
+
*/
|
|
19887
|
+
deleteSiteConfigurationCanvas: (
|
|
19888
|
+
siteConfigurationId: string,
|
|
19889
|
+
surface: DeleteSiteConfigurationCanvasParamsEnum,
|
|
19890
|
+
query: {
|
|
19891
|
+
/**
|
|
19892
|
+
* The canvas Version the caller last read. A delete over a newer save is refused as stale.
|
|
19893
|
+
* @format int32
|
|
19894
|
+
*/
|
|
19895
|
+
expectedVersion: number;
|
|
19896
|
+
},
|
|
19897
|
+
params: RequestParams = {},
|
|
19898
|
+
) =>
|
|
19899
|
+
this.request<void, ProblemDetails>({
|
|
19900
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
|
|
19901
|
+
method: "DELETE",
|
|
19902
|
+
query: query,
|
|
19903
|
+
secure: true,
|
|
19904
|
+
...params,
|
|
19905
|
+
}),
|
|
19906
|
+
|
|
19907
|
+
/**
|
|
19908
|
+
* No description
|
|
19909
|
+
*
|
|
19910
|
+
* @tags SiteConfigurationCanvases
|
|
19911
|
+
* @name PreviewSiteConfigurationCanvas
|
|
19912
|
+
* @summary Preview an unsaved canvas for one surface as a role would see it
|
|
19913
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
|
|
19914
|
+
* @secure
|
|
19915
|
+
* @response `200` `CanvasView` OK
|
|
19916
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
19917
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19918
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19919
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
19920
|
+
*/
|
|
19921
|
+
previewSiteConfigurationCanvas: (
|
|
19922
|
+
siteConfigurationId: string,
|
|
19923
|
+
surface: PreviewSiteConfigurationCanvasParamsEnum,
|
|
19924
|
+
data: PreviewSiteConfigurationCanvasRequest,
|
|
19925
|
+
params: RequestParams = {},
|
|
19926
|
+
) =>
|
|
19927
|
+
this.request<CanvasView, ProblemDetails>({
|
|
19928
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
|
|
19929
|
+
method: "POST",
|
|
19930
|
+
body: data,
|
|
19931
|
+
secure: true,
|
|
19932
|
+
type: "application/json",
|
|
19933
|
+
format: "json",
|
|
19934
|
+
...params,
|
|
19935
|
+
}),
|
|
19936
|
+
|
|
19937
|
+
/**
|
|
19938
|
+
* No description
|
|
19939
|
+
*
|
|
19940
|
+
* @tags SiteConfigurationCanvases
|
|
19941
|
+
* @name GetSiteConfigurationCanvasVersions
|
|
19942
|
+
* @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
|
|
19943
|
+
* @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
|
|
19944
|
+
* @secure
|
|
19945
|
+
* @response `200` `(CanvasVersion)[]` OK
|
|
19946
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19947
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19948
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
19949
|
+
*/
|
|
19950
|
+
getSiteConfigurationCanvasVersions: (
|
|
19951
|
+
siteConfigurationId: string,
|
|
19952
|
+
surface: GetSiteConfigurationCanvasVersionsParamsEnum,
|
|
19953
|
+
params: RequestParams = {},
|
|
19954
|
+
) =>
|
|
19955
|
+
this.request<CanvasVersion[], ProblemDetails>({
|
|
19956
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
|
|
19957
|
+
method: "GET",
|
|
19958
|
+
secure: true,
|
|
19959
|
+
format: "json",
|
|
19960
|
+
...params,
|
|
19961
|
+
}),
|
|
19962
|
+
|
|
19963
|
+
/**
|
|
19964
|
+
* No description
|
|
19965
|
+
*
|
|
19966
|
+
* @tags SiteConfigurationCanvases
|
|
19967
|
+
* @name RestoreSiteConfigurationCanvasVersion
|
|
19968
|
+
* @summary Restore a saved version of a site's canvas as a new version
|
|
19969
|
+
* @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
|
|
19970
|
+
* @secure
|
|
19971
|
+
* @response `200` `CanvasSurfaceState` OK
|
|
19972
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
19973
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
19974
|
+
* @response `404` `ProblemDetails` Not Found
|
|
19975
|
+
* @response `409` `ProblemDetails` Conflict
|
|
19976
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
19977
|
+
* @response `423` `ProblemDetails` Locked
|
|
19978
|
+
*/
|
|
19979
|
+
restoreSiteConfigurationCanvasVersion: (
|
|
19980
|
+
siteConfigurationId: string,
|
|
19981
|
+
surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
|
|
19982
|
+
version: number,
|
|
19983
|
+
data: RestoreSiteConfigurationCanvasVersionRequest,
|
|
19984
|
+
params: RequestParams = {},
|
|
19985
|
+
) =>
|
|
19986
|
+
this.request<CanvasSurfaceState, ProblemDetails>({
|
|
19987
|
+
path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
|
|
19988
|
+
method: "POST",
|
|
19989
|
+
body: data,
|
|
19990
|
+
secure: true,
|
|
19991
|
+
type: "application/json",
|
|
19992
|
+
format: "json",
|
|
19993
|
+
...params,
|
|
19994
|
+
}),
|
|
19995
|
+
|
|
18788
19996
|
/**
|
|
18789
19997
|
* No description
|
|
18790
19998
|
*
|