@matech/thebigpos-sdk 3.14.0 → 3.15.0-dev-6028

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/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 =
@@ -491,6 +493,8 @@ export type LOSStatus =
491
493
  | "Uploaded"
492
494
  | "PendingSync";
493
495
 
496
+ export type IncompleteLoanSource = "V3" | "LegacyDraft";
497
+
494
498
  export type Environment = "Development" | "Staging" | "UAT" | "Production";
495
499
 
496
500
  export type EntityType =
@@ -535,6 +539,12 @@ export type CustomFieldDataType =
535
539
  | "SingleSelect"
536
540
  | "MultiSelect";
537
541
 
542
+ export type CustomFieldAnswerWarningReason =
543
+ | "Unresolved"
544
+ | "Inactive"
545
+ | "ReadOnly"
546
+ | "DuplicateDefinition";
547
+
538
548
  export type CustomFieldAccessLevel = "NoAccess" | "ReadOnly" | "ReadWrite";
539
549
 
540
550
  export type ConsentType = "Econsent" | "CreditAuthorization" | "Tcpa";
@@ -553,6 +563,55 @@ export type CompanyDocumentIndexStatus =
553
563
 
554
564
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
555
565
 
566
+ export type CanvasWidgetType =
567
+ | "Information"
568
+ | "Kpi"
569
+ | "KeyDates"
570
+ | "LoanProgress"
571
+ | "MonthlyPayment"
572
+ | "Amortization"
573
+ | "PrimaryBorrower"
574
+ | "OpenTasks"
575
+ | "Documents"
576
+ | "EsignStatus"
577
+ | "LoanTeam"
578
+ | "TextBlock"
579
+ | "SectionDivider"
580
+ | "MyTasks"
581
+ | "RecentLoans"
582
+ | "ClosingSoon";
583
+
584
+ export type CanvasWidgetScope = "Loan" | "User" | "Any";
585
+
586
+ export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
587
+
588
+ export type CanvasLabelPosition = "Left" | "Above";
589
+
590
+ export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
591
+
592
+ export type CanvasFieldSource = "Standard" | "Custom";
593
+
594
+ export type CanvasFieldFormat =
595
+ | "Text"
596
+ | "Number"
597
+ | "Currency"
598
+ | "Percent"
599
+ | "DateShort"
600
+ | "DateLong"
601
+ | "YesNo";
602
+
603
+ export type CanvasFieldDataType =
604
+ | "Text"
605
+ | "Number"
606
+ | "Decimal"
607
+ | "Boolean"
608
+ | "Date"
609
+ | "DateTime"
610
+ | "SingleSelect"
611
+ | "MultiSelect";
612
+
613
+ export type CanvasAudience = "Staff" | "Borrower" | "Partner";
614
+
556
615
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
557
616
 
558
617
  export type BranchType = "Mortgage" | "RealEstate";
@@ -693,6 +752,41 @@ export type AddressFamily =
693
752
  | "ControllerAreaNetwork"
694
753
  | "Unknown";
695
754
 
755
+ export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
756
+ (
757
+ | BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
758
+ | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig>
759
+ | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig>
760
+ | BaseCanvasWidgetConfigTypeMapping<
761
+ "LoanProgress",
762
+ LoanProgressWidgetConfig
763
+ >
764
+ | BaseCanvasWidgetConfigTypeMapping<
765
+ "MonthlyPayment",
766
+ MonthlyPaymentWidgetConfig
767
+ >
768
+ | BaseCanvasWidgetConfigTypeMapping<
769
+ "Amortization",
770
+ AmortizationWidgetConfig
771
+ >
772
+ | BaseCanvasWidgetConfigTypeMapping<
773
+ "PrimaryBorrower",
774
+ PrimaryBorrowerWidgetConfig
775
+ >
776
+ | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig>
777
+ | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig>
778
+ | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig>
779
+ | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig>
780
+ | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig>
781
+ | BaseCanvasWidgetConfigTypeMapping<
782
+ "SectionDivider",
783
+ SectionDividerWidgetConfig
784
+ >
785
+ | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig>
786
+ | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig>
787
+ | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>
788
+ );
789
+
696
790
  export interface ASOSettings {
697
791
  enabled: boolean;
698
792
  softPull: boolean;
@@ -720,6 +814,18 @@ export interface ASOSettings {
720
814
  miArch: boolean;
721
815
  }
722
816
 
817
+ export interface AcceptBorrowerInviteRequest {
818
+ /** @format uuid */
819
+ inviteCode: string;
820
+ }
821
+
822
+ export interface AcceptedBorrowerInvite {
823
+ /** @format uuid */
824
+ loanId: string;
825
+ /** @format uuid */
826
+ borrowerId: string;
827
+ }
828
+
723
829
  export interface Account {
724
830
  /** @format uuid */
725
831
  id: string;
@@ -1535,6 +1641,13 @@ export interface AmortizationSchedule {
1535
1641
  pmi: number;
1536
1642
  }
1537
1643
 
1644
+ export type AmortizationWidgetConfig = UtilRequiredKeys<
1645
+ BaseCanvasWidgetConfig,
1646
+ "type"
1647
+ > & {
1648
+ type: AmortizationWidgetConfigTypeEnum;
1649
+ };
1650
+
1538
1651
  export interface ApplicationRowData {
1539
1652
  borrowerEmail?: string | null;
1540
1653
  borrowerFirstName?: string | null;
@@ -1808,6 +1921,227 @@ export interface BusinessRuleRequest {
1808
1921
  applyToAllBorrowerPairs: boolean;
1809
1922
  }
1810
1923
 
1924
+ export interface CanvasAuthor {
1925
+ /** @format uuid */
1926
+ id: string;
1927
+ firstName: string;
1928
+ lastName: string;
1929
+ email: string;
1930
+ }
1931
+
1932
+ export interface CanvasBoard {
1933
+ name?: string | null;
1934
+ roles: UserRole[];
1935
+ widgetIds: string[];
1936
+ widgets: Record<string, CanvasWidget>;
1937
+ }
1938
+
1939
+ export interface CanvasBoardView {
1940
+ widgetIds: string[];
1941
+ widgets: Record<string, CanvasWidgetView>;
1942
+ }
1943
+
1944
+ export interface CanvasDocument {
1945
+ /** @format int32 */
1946
+ schemaVersion: number;
1947
+ boards?: CanvasBoard[] | null;
1948
+ tabs?: CanvasTab[] | null;
1949
+ }
1950
+
1951
+ export interface CanvasFieldCatalog {
1952
+ fields: CanvasFieldDescriptor[];
1953
+ }
1954
+
1955
+ export interface CanvasFieldDescriptor {
1956
+ source: CanvasFieldDescriptorSourceEnum;
1957
+ key: string;
1958
+ label: string;
1959
+ category: string;
1960
+ categoryKey: string;
1961
+ dataType: CanvasFieldDescriptorDataTypeEnum;
1962
+ format: CanvasFieldDescriptorFormatEnum;
1963
+ encompassFieldId?: string | null;
1964
+ readableRoles: UserRole[];
1965
+ isActive: boolean;
1966
+ rolesWithoutPermissionRows: UserRole[];
1967
+ options: string[];
1968
+ }
1969
+
1970
+ export interface CanvasFieldRef {
1971
+ source: CanvasFieldRefSourceEnum;
1972
+ key: string;
1973
+ }
1974
+
1975
+ export interface CanvasFieldValue {
1976
+ dataType: CanvasFieldValueDataTypeEnum;
1977
+ value?: any | null;
1978
+ }
1979
+
1980
+ export interface CanvasFieldValues {
1981
+ standard: Record<string, CanvasFieldValue>;
1982
+ custom: Record<string, CanvasFieldValue>;
1983
+ }
1984
+
1985
+ export interface CanvasFieldValuesRequest {
1986
+ standardKeys: string[];
1987
+ customFieldIds: string[];
1988
+ }
1989
+
1990
+ export interface CanvasFieldView {
1991
+ label: string;
1992
+ dataType: CanvasFieldViewDataTypeEnum;
1993
+ format: CanvasFieldViewFormatEnum;
1994
+ options: string[];
1995
+ }
1996
+
1997
+ export interface CanvasInformationItem {
1998
+ kind: CanvasInformationItemKindEnum;
1999
+ field?: CanvasFieldRef | null;
2000
+ text?: string | null;
2001
+ label?: string | null;
2002
+ format?: CanvasFieldFormat | null;
2003
+ emphasis: boolean;
2004
+ hideWhenEmpty: boolean;
2005
+ roles: UserRole[];
2006
+ /** @format int32 */
2007
+ column: number;
2008
+ }
2009
+
2010
+ export interface CanvasSourceSite {
2011
+ /** @format uuid */
2012
+ siteConfigurationID: string;
2013
+ name: string;
2014
+ type: CanvasSourceSiteTypeEnum;
2015
+ }
2016
+
2017
+ export interface CanvasSurfaceState {
2018
+ surface: CanvasSurfaceStateSurfaceEnum;
2019
+ own?: CanvasDocument | null;
2020
+ /** @format int32 */
2021
+ ownVersion?: number | null;
2022
+ isOwnUnreadable: boolean;
2023
+ /** @format date-time */
2024
+ ownUpdatedAt?: string | null;
2025
+ /** @format uuid */
2026
+ forkedFromSiteConfigurationID?: string | null;
2027
+ /** @format int32 */
2028
+ forkedFromVersion?: number | null;
2029
+ inherited?: CanvasDocument | null;
2030
+ /** @format int32 */
2031
+ inheritedVersion?: number | null;
2032
+ inheritedFrom?: CanvasSourceSite | null;
2033
+ isBehindInherited: boolean;
2034
+ effectiveBoards?: CanvasBoard[] | null;
2035
+ effectiveTabs?: ResolvedCanvasTab[] | null;
2036
+ }
2037
+
2038
+ export interface CanvasTab {
2039
+ key: string;
2040
+ /** @format int32 */
2041
+ version: number;
2042
+ title: string;
2043
+ roles: UserRole[];
2044
+ copiedFrom?: CanvasTabOrigin | null;
2045
+ board: CanvasBoard;
2046
+ }
2047
+
2048
+ export interface CanvasTabOrigin {
2049
+ /** @format uuid */
2050
+ siteConfigurationID: string;
2051
+ tabKey: string;
2052
+ /** @format int32 */
2053
+ version: number;
2054
+ }
2055
+
2056
+ export interface CanvasTabView {
2057
+ key: string;
2058
+ title: string;
2059
+ board: CanvasBoardView;
2060
+ }
2061
+
2062
+ export interface CanvasVersion {
2063
+ /** @format int32 */
2064
+ version: number;
2065
+ /** @format date-time */
2066
+ createdAt: string;
2067
+ createdBy?: CanvasAuthor | null;
2068
+ }
2069
+
2070
+ export interface CanvasView {
2071
+ surface: CanvasViewSurfaceEnum;
2072
+ isConfigured: boolean;
2073
+ board?: CanvasBoardView | null;
2074
+ tabs?: CanvasTabView[] | null;
2075
+ standardFields: Record<string, CanvasFieldView>;
2076
+ customFields: Record<string, CanvasFieldView>;
2077
+ }
2078
+
2079
+ export interface CanvasWidget {
2080
+ type: CanvasWidgetTypeEnum;
2081
+ /** @format int32 */
2082
+ configVersion: number;
2083
+ title?: string | null;
2084
+ /** @format int32 */
2085
+ width: number;
2086
+ roles: UserRole[];
2087
+ config:
2088
+ | InformationWidgetConfig
2089
+ | KpiWidgetConfig
2090
+ | KeyDatesWidgetConfig
2091
+ | LoanProgressWidgetConfig
2092
+ | MonthlyPaymentWidgetConfig
2093
+ | AmortizationWidgetConfig
2094
+ | PrimaryBorrowerWidgetConfig
2095
+ | OpenTasksWidgetConfig
2096
+ | DocumentsWidgetConfig
2097
+ | EsignStatusWidgetConfig
2098
+ | LoanTeamWidgetConfig
2099
+ | TextBlockWidgetConfig
2100
+ | SectionDividerWidgetConfig
2101
+ | MyTasksWidgetConfig
2102
+ | RecentLoansWidgetConfig
2103
+ | ClosingSoonWidgetConfig;
2104
+ }
2105
+
2106
+ export interface CanvasWidgetTypeDescriptor {
2107
+ type: CanvasWidgetTypeDescriptorTypeEnum;
2108
+ scope: CanvasWidgetTypeDescriptorScopeEnum;
2109
+ surfaces: CanvasSurface[];
2110
+ audiences: CanvasAudience[];
2111
+ allowedRoles: UserRole[];
2112
+ allowedWidths: number[];
2113
+ /** @format int32 */
2114
+ maxPerBoard: number;
2115
+ /** @format int32 */
2116
+ configVersion: number;
2117
+ }
2118
+
2119
+ export interface CanvasWidgetView {
2120
+ type: CanvasWidgetViewTypeEnum;
2121
+ /** @format int32 */
2122
+ configVersion: number;
2123
+ title?: string | null;
2124
+ /** @format int32 */
2125
+ width: number;
2126
+ config:
2127
+ | InformationWidgetConfig
2128
+ | KpiWidgetConfig
2129
+ | KeyDatesWidgetConfig
2130
+ | LoanProgressWidgetConfig
2131
+ | MonthlyPaymentWidgetConfig
2132
+ | AmortizationWidgetConfig
2133
+ | PrimaryBorrowerWidgetConfig
2134
+ | OpenTasksWidgetConfig
2135
+ | DocumentsWidgetConfig
2136
+ | EsignStatusWidgetConfig
2137
+ | LoanTeamWidgetConfig
2138
+ | TextBlockWidgetConfig
2139
+ | SectionDividerWidgetConfig
2140
+ | MyTasksWidgetConfig
2141
+ | RecentLoansWidgetConfig
2142
+ | ClosingSoonWidgetConfig;
2143
+ }
2144
+
1811
2145
  export interface ChangePasswordRequest {
1812
2146
  oldPassword: string;
1813
2147
  newPassword: string;
@@ -1842,6 +2176,17 @@ export interface ClosedLoansReportRequest {
1842
2176
  endDate: string;
1843
2177
  }
1844
2178
 
2179
+ export type ClosingSoonWidgetConfig = UtilRequiredKeys<
2180
+ BaseCanvasWidgetConfig,
2181
+ "type"
2182
+ > & {
2183
+ /** @format int32 */
2184
+ withinDays: number;
2185
+ /** @format int32 */
2186
+ maxItems: number;
2187
+ type: ClosingSoonWidgetConfigTypeEnum;
2188
+ };
2189
+
1845
2190
  export interface CommentUserInformation {
1846
2191
  entityId: string;
1847
2192
  entityType: string;
@@ -2251,6 +2596,11 @@ export interface CreditAuthPendingSummary {
2251
2596
  borrowers: BorrowerIdentity[];
2252
2597
  }
2253
2598
 
2599
+ export interface CustomFieldAnswerWarning {
2600
+ key: string;
2601
+ reason: CustomFieldAnswerWarningReasonEnum;
2602
+ }
2603
+
2254
2604
  export interface CustomFieldDefinition {
2255
2605
  /** @format date-time */
2256
2606
  createdAt: string;
@@ -2496,6 +2846,16 @@ export interface DocumentTemplateVersionUpdateRequest {
2496
2846
  htmlBody: string;
2497
2847
  }
2498
2848
 
2849
+ export type DocumentsWidgetConfig = UtilRequiredKeys<
2850
+ BaseCanvasWidgetConfig,
2851
+ "type"
2852
+ > & {
2853
+ /** @format int32 */
2854
+ maxItems: number;
2855
+ onlyOutstanding: boolean;
2856
+ type: DocumentsWidgetConfigTypeEnum;
2857
+ };
2858
+
2499
2859
  export interface Draft {
2500
2860
  /** @format date-time */
2501
2861
  createdAt: string;
@@ -2821,6 +3181,13 @@ export interface Error {
2821
3181
  message: string;
2822
3182
  }
2823
3183
 
3184
+ export type EsignStatusWidgetConfig = UtilRequiredKeys<
3185
+ BaseCanvasWidgetConfig,
3186
+ "type"
3187
+ > & {
3188
+ type: EsignStatusWidgetConfigTypeEnum;
3189
+ };
3190
+
2824
3191
  export interface FailureBucket {
2825
3192
  /** @format date-time */
2826
3193
  startUtc: string;
@@ -3207,6 +3574,7 @@ export interface InProgressLoan {
3207
3574
  siteConfigurationId?: string | null;
3208
3575
  /** @format date-time */
3209
3576
  updatedAt?: string | null;
3577
+ applicationSession?: LoanApplicationSessionRoute | null;
3210
3578
  }
3211
3579
 
3212
3580
  export interface IncompleteApplicationSummary {
@@ -3215,6 +3583,82 @@ export interface IncompleteApplicationSummary {
3215
3583
  borrowers: BorrowerIdentity[];
3216
3584
  }
3217
3585
 
3586
+ export interface IncompleteLoan {
3587
+ source: IncompleteLoanSourceEnum;
3588
+ /** @format uuid */
3589
+ loanId?: string | null;
3590
+ /** @format uuid */
3591
+ borrowerId?: string | null;
3592
+ /** @format uuid */
3593
+ draftId?: string | null;
3594
+ /** @format date-time */
3595
+ createdAt: string;
3596
+ /** @format date-time */
3597
+ updatedAt?: string | null;
3598
+ loanOfficer?: UserSummary | null;
3599
+ siteConfiguration?: IncompleteLoanSiteConfiguration | null;
3600
+ draft?: IncompleteLoanDraft | null;
3601
+ borrowers: IncompleteLoanBorrower[];
3602
+ }
3603
+
3604
+ export interface IncompleteLoanBorrower {
3605
+ /** @format uuid */
3606
+ id: string;
3607
+ firstName?: string | null;
3608
+ lastName?: string | null;
3609
+ email?: string | null;
3610
+ isPrimaryBorrower: boolean;
3611
+ applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
3612
+ /** @format date-time */
3613
+ deletedAt?: string | null;
3614
+ applicationSession?: LoanApplicationSessionRoute | null;
3615
+ }
3616
+
3617
+ export interface IncompleteLoanDraft {
3618
+ /** @format uuid */
3619
+ loanID?: string | null;
3620
+ /** @format date-time */
3621
+ deletedAt?: string | null;
3622
+ routeName?: string | null;
3623
+ user: UserBase;
3624
+ }
3625
+
3626
+ export interface IncompleteLoanPaginated {
3627
+ rows: IncompleteLoan[];
3628
+ pagination: Pagination;
3629
+ /** @format int64 */
3630
+ count: number;
3631
+ }
3632
+
3633
+ export interface IncompleteLoanSearchCriteria {
3634
+ searchText?: string | null;
3635
+ /** @format uuid */
3636
+ loanOfficerId?: string | null;
3637
+ /** @format uuid */
3638
+ siteConfigurationId?: string | null;
3639
+ isUnassigned?: boolean | null;
3640
+ includeRemovedApplications?: boolean | null;
3641
+ }
3642
+
3643
+ export interface IncompleteLoanSiteConfiguration {
3644
+ /** @format uuid */
3645
+ id: string;
3646
+ name: string;
3647
+ }
3648
+
3649
+ export type InformationWidgetConfig = UtilRequiredKeys<
3650
+ BaseCanvasWidgetConfig,
3651
+ "type"
3652
+ > & {
3653
+ /** @format int32 */
3654
+ columns: number;
3655
+ labelPosition: InformationWidgetConfigLabelPositionEnum;
3656
+ hideWhenEmpty: boolean;
3657
+ emptyText?: string | null;
3658
+ items: CanvasInformationItem[];
3659
+ type: InformationWidgetConfigTypeEnum;
3660
+ };
3661
+
3218
3662
  export interface IntegrationSettings {
3219
3663
  encompass?: EncompassIntegrationSettings | null;
3220
3664
  }
@@ -3246,11 +3690,30 @@ export interface Invite {
3246
3690
  status: string;
3247
3691
  loan: LoanIdentifier;
3248
3692
  url: string;
3693
+ linksBorrowerApplication?: boolean | null;
3249
3694
  }
3250
3695
 
3251
3696
  /** Array of operations to perform */
3252
3697
  export type JsonPatchDocument = Operation[];
3253
3698
 
3699
+ export type KeyDatesWidgetConfig = UtilRequiredKeys<
3700
+ BaseCanvasWidgetConfig,
3701
+ "type"
3702
+ > & {
3703
+ dates: string[];
3704
+ type: KeyDatesWidgetConfigTypeEnum;
3705
+ };
3706
+
3707
+ export type KpiWidgetConfig = UtilRequiredKeys<
3708
+ BaseCanvasWidgetConfig,
3709
+ "type"
3710
+ > & {
3711
+ field: CanvasFieldRef;
3712
+ label?: string | null;
3713
+ format?: CanvasFieldFormat | null;
3714
+ type: KpiWidgetConfigTypeEnum;
3715
+ };
3716
+
3254
3717
  export interface LOSIntegration {
3255
3718
  instanceID: string;
3256
3719
  }
@@ -3453,6 +3916,7 @@ export interface LoanApplication {
3453
3916
  refinance?: LoanRefinance | null;
3454
3917
  borrowers: LoanBorrower[];
3455
3918
  nonOwningBorrowers: LoanNonOwningBorrower[];
3919
+ customFieldWarnings?: CustomFieldAnswerWarning[] | null;
3456
3920
  }
3457
3921
 
3458
3922
  export interface LoanApplicationRequest {
@@ -3495,6 +3959,10 @@ export interface LoanApplicationSessionRequest {
3495
3959
  questionHistory: string[];
3496
3960
  }
3497
3961
 
3962
+ export interface LoanApplicationSessionRoute {
3963
+ routeName: string;
3964
+ }
3965
+
3498
3966
  export interface LoanBorrower {
3499
3967
  /** @format uuid */
3500
3968
  id: string;
@@ -4875,6 +5343,13 @@ export interface LoanPatchRequestGuidPatchDocument {
4875
5343
  operations: GuidPatchOperation[];
4876
5344
  }
4877
5345
 
5346
+ export type LoanProgressWidgetConfig = UtilRequiredKeys<
5347
+ BaseCanvasWidgetConfig,
5348
+ "type"
5349
+ > & {
5350
+ type: LoanProgressWidgetConfigTypeEnum;
5351
+ };
5352
+
4878
5353
  export interface LoanProperty {
4879
5354
  /** @format uuid */
4880
5355
  id?: string | null;
@@ -5198,6 +5673,13 @@ export interface LoanTaskStatusSummary {
5198
5673
  count: number;
5199
5674
  }
5200
5675
 
5676
+ export type LoanTeamWidgetConfig = UtilRequiredKeys<
5677
+ BaseCanvasWidgetConfig,
5678
+ "type"
5679
+ > & {
5680
+ type: LoanTeamWidgetConfigTypeEnum;
5681
+ };
5682
+
5201
5683
  export interface LoanUser {
5202
5684
  /** @format uuid */
5203
5685
  id: string;
@@ -5632,6 +6114,24 @@ export interface MonthlyPaymentCalculatorRequest {
5632
6114
  term: number;
5633
6115
  }
5634
6116
 
6117
+ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
6118
+ BaseCanvasWidgetConfig,
6119
+ "type"
6120
+ > & {
6121
+ type: MonthlyPaymentWidgetConfigTypeEnum;
6122
+ };
6123
+
6124
+ export type MyTasksWidgetConfig = UtilRequiredKeys<
6125
+ BaseCanvasWidgetConfig,
6126
+ "type"
6127
+ > & {
6128
+ /** @format int32 */
6129
+ dueWithinDays: number;
6130
+ /** @format int32 */
6131
+ maxItems: number;
6132
+ type: MyTasksWidgetConfigTypeEnum;
6133
+ };
6134
+
5635
6135
  export interface NoContentResult {
5636
6136
  /** @format int32 */
5637
6137
  statusCode: number;
@@ -5779,6 +6279,15 @@ export interface NotificationTemplateVersionUpdateRequest {
5779
6279
  pushNotificationBody?: string | null;
5780
6280
  }
5781
6281
 
6282
+ export type OpenTasksWidgetConfig = UtilRequiredKeys<
6283
+ BaseCanvasWidgetConfig,
6284
+ "type"
6285
+ > & {
6286
+ /** @format int32 */
6287
+ maxItems: number;
6288
+ type: OpenTasksWidgetConfigTypeEnum;
6289
+ };
6290
+
5782
6291
  export interface Operation {
5783
6292
  op?: string;
5784
6293
  value?: string | number | boolean | null | object;
@@ -5796,6 +6305,7 @@ export interface OutboundFailureBucket {
5796
6305
 
5797
6306
  export interface OverridePasswordRequest {
5798
6307
  password: string;
6308
+ passwordConfirmation?: string | null;
5799
6309
  }
5800
6310
 
5801
6311
  export interface Pagination {
@@ -5927,6 +6437,18 @@ export interface PreliminaryCondition {
5927
6437
  rerequestedBy?: CommentUserInformation | null;
5928
6438
  }
5929
6439
 
6440
+ export interface PreviewSiteConfigurationCanvasRequest {
6441
+ document: CanvasDocument;
6442
+ role?: UserRole | null;
6443
+ }
6444
+
6445
+ export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
6446
+ BaseCanvasWidgetConfig,
6447
+ "type"
6448
+ > & {
6449
+ type: PrimaryBorrowerWidgetConfigTypeEnum;
6450
+ };
6451
+
5930
6452
  export interface ProblemDetails {
5931
6453
  type?: string | null;
5932
6454
  title?: string | null;
@@ -5937,6 +6459,15 @@ export interface ProblemDetails {
5937
6459
  [key: string]: any;
5938
6460
  }
5939
6461
 
6462
+ export type RecentLoansWidgetConfig = UtilRequiredKeys<
6463
+ BaseCanvasWidgetConfig,
6464
+ "type"
6465
+ > & {
6466
+ /** @format int32 */
6467
+ maxItems: number;
6468
+ type: RecentLoansWidgetConfigTypeEnum;
6469
+ };
6470
+
5940
6471
  export interface RefinanceCalculator {
5941
6472
  currentLoan: RefinanceLoan;
5942
6473
  refinanceLoan: RefinanceLoan;
@@ -6057,6 +6588,17 @@ export interface ResetPasswordRequest {
6057
6588
  password: string;
6058
6589
  }
6059
6590
 
6591
+ export interface ResolvedCanvasTab {
6592
+ tab: CanvasTab;
6593
+ source: CanvasSourceSite;
6594
+ isInherited: boolean;
6595
+ }
6596
+
6597
+ export interface RestoreSiteConfigurationCanvasVersionRequest {
6598
+ /** @format int32 */
6599
+ expectedVersion: number;
6600
+ }
6601
+
6060
6602
  export interface RunLOCalculation {
6061
6603
  loanID: string;
6062
6604
  loanAmount?: string | null;
@@ -6137,10 +6679,28 @@ export interface SSOTokenRequest {
6137
6679
  redirectUri?: string | null;
6138
6680
  }
6139
6681
 
6682
+ export interface SaveSiteConfigurationCanvasRequest {
6683
+ document: CanvasDocument;
6684
+ /** @format int32 */
6685
+ expectedVersion?: number | null;
6686
+ /** @format uuid */
6687
+ forkedFromSiteConfigurationID?: string | null;
6688
+ /** @format int32 */
6689
+ forkedFromVersion?: number | null;
6690
+ }
6691
+
6140
6692
  export interface SearchCriteria {
6141
6693
  searchText?: string | null;
6142
6694
  }
6143
6695
 
6696
+ export type SectionDividerWidgetConfig = UtilRequiredKeys<
6697
+ BaseCanvasWidgetConfig,
6698
+ "type"
6699
+ > & {
6700
+ label?: string | null;
6701
+ type: SectionDividerWidgetConfigTypeEnum;
6702
+ };
6703
+
6144
6704
  export interface SendESignatureReminderRequest {
6145
6705
  /** @format uuid */
6146
6706
  userId: string;
@@ -6581,6 +7141,12 @@ export interface SiteConfigurationByUrl {
6581
7141
  workflows: Workflow[];
6582
7142
  }
6583
7143
 
7144
+ export interface SiteConfigurationCanvases {
7145
+ /** @format uuid */
7146
+ siteConfigurationID: string;
7147
+ surfaces: CanvasSurfaceState[];
7148
+ }
7149
+
6584
7150
  export interface SiteConfigurationForm {
6585
7151
  /** @format date-time */
6586
7152
  createdAt: string;
@@ -7087,6 +7653,14 @@ export interface TemplateTokenRoot {
7087
7653
  fields: TemplateToken[];
7088
7654
  }
7089
7655
 
7656
+ export type TextBlockWidgetConfig = UtilRequiredKeys<
7657
+ BaseCanvasWidgetConfig,
7658
+ "type"
7659
+ > & {
7660
+ text: string;
7661
+ type: TextBlockWidgetConfigTypeEnum;
7662
+ };
7663
+
7090
7664
  export interface Theme {
7091
7665
  logoURL: string;
7092
7666
  primaryColor: string;
@@ -7191,6 +7765,8 @@ export interface UnprocessableEntity {
7191
7765
  export interface UnprocessableEntityError {
7192
7766
  error: string;
7193
7767
  property: string;
7768
+ code?: string | null;
7769
+ params?: Record<string, any> | null;
7194
7770
  }
7195
7771
 
7196
7772
  export interface UnregisteredBorrower {
@@ -7917,6 +8493,14 @@ export interface Workflow {
7917
8493
  icon: string;
7918
8494
  }
7919
8495
 
8496
+ interface BaseCanvasWidgetConfig {
8497
+ type: string;
8498
+ }
8499
+
8500
+ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
8501
+ type: Key;
8502
+ } & Type;
8503
+
7920
8504
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
7921
8505
 
7922
8506
  export type AiAuditLogEventTypeEnum =
@@ -7987,6 +8571,8 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
7987
8571
 
7988
8572
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
7989
8573
 
8574
+ export type AmortizationWidgetConfigTypeEnum = "Amortization";
8575
+
7990
8576
  export type AuditLogEntryChangeTypeEnum =
7991
8577
  | "Created"
7992
8578
  | "Modified"
@@ -8027,6 +8613,133 @@ export type BorrowerIdentityRoleEnum =
8027
8613
  | "SettlementAgent"
8028
8614
  | "Admin";
8029
8615
 
8616
+ export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
8617
+
8618
+ export type CanvasFieldDescriptorDataTypeEnum =
8619
+ | "Text"
8620
+ | "Number"
8621
+ | "Decimal"
8622
+ | "Boolean"
8623
+ | "Date"
8624
+ | "DateTime"
8625
+ | "SingleSelect"
8626
+ | "MultiSelect";
8627
+
8628
+ export type CanvasFieldDescriptorFormatEnum =
8629
+ | "Text"
8630
+ | "Number"
8631
+ | "Currency"
8632
+ | "Percent"
8633
+ | "DateShort"
8634
+ | "DateLong"
8635
+ | "YesNo";
8636
+
8637
+ export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
8638
+
8639
+ export type CanvasFieldValueDataTypeEnum =
8640
+ | "Text"
8641
+ | "Number"
8642
+ | "Decimal"
8643
+ | "Boolean"
8644
+ | "Date"
8645
+ | "DateTime"
8646
+ | "SingleSelect"
8647
+ | "MultiSelect";
8648
+
8649
+ export type CanvasFieldViewDataTypeEnum =
8650
+ | "Text"
8651
+ | "Number"
8652
+ | "Decimal"
8653
+ | "Boolean"
8654
+ | "Date"
8655
+ | "DateTime"
8656
+ | "SingleSelect"
8657
+ | "MultiSelect";
8658
+
8659
+ export type CanvasFieldViewFormatEnum =
8660
+ | "Text"
8661
+ | "Number"
8662
+ | "Currency"
8663
+ | "Percent"
8664
+ | "DateShort"
8665
+ | "DateLong"
8666
+ | "YesNo";
8667
+
8668
+ export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
8669
+
8670
+ export type CanvasSourceSiteTypeEnum =
8671
+ | "None"
8672
+ | "Account"
8673
+ | "Corporate"
8674
+ | "Branch"
8675
+ | "LoanOfficer"
8676
+ | "Partner";
8677
+
8678
+ export type CanvasSurfaceStateSurfaceEnum =
8679
+ | "Home"
8680
+ | "LoanSummary"
8681
+ | "LoanDetails";
8682
+
8683
+ export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
8684
+
8685
+ export type CanvasWidgetTypeEnum =
8686
+ | "Information"
8687
+ | "Kpi"
8688
+ | "KeyDates"
8689
+ | "LoanProgress"
8690
+ | "MonthlyPayment"
8691
+ | "Amortization"
8692
+ | "PrimaryBorrower"
8693
+ | "OpenTasks"
8694
+ | "Documents"
8695
+ | "EsignStatus"
8696
+ | "LoanTeam"
8697
+ | "TextBlock"
8698
+ | "SectionDivider"
8699
+ | "MyTasks"
8700
+ | "RecentLoans"
8701
+ | "ClosingSoon";
8702
+
8703
+ export type CanvasWidgetTypeDescriptorTypeEnum =
8704
+ | "Information"
8705
+ | "Kpi"
8706
+ | "KeyDates"
8707
+ | "LoanProgress"
8708
+ | "MonthlyPayment"
8709
+ | "Amortization"
8710
+ | "PrimaryBorrower"
8711
+ | "OpenTasks"
8712
+ | "Documents"
8713
+ | "EsignStatus"
8714
+ | "LoanTeam"
8715
+ | "TextBlock"
8716
+ | "SectionDivider"
8717
+ | "MyTasks"
8718
+ | "RecentLoans"
8719
+ | "ClosingSoon";
8720
+
8721
+ export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
8722
+
8723
+ export type CanvasWidgetViewTypeEnum =
8724
+ | "Information"
8725
+ | "Kpi"
8726
+ | "KeyDates"
8727
+ | "LoanProgress"
8728
+ | "MonthlyPayment"
8729
+ | "Amortization"
8730
+ | "PrimaryBorrower"
8731
+ | "OpenTasks"
8732
+ | "Documents"
8733
+ | "EsignStatus"
8734
+ | "LoanTeam"
8735
+ | "TextBlock"
8736
+ | "SectionDivider"
8737
+ | "MyTasks"
8738
+ | "RecentLoans"
8739
+ | "ClosingSoon";
8740
+
8741
+ export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
8742
+
8030
8743
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
8031
8744
 
8032
8745
  export type CompanyDocumentIndexStatusEnum =
@@ -8132,6 +8845,12 @@ export type CreateUserDraftLoanRoleEnum =
8132
8845
  | "SettlementAgent"
8133
8846
  | "Admin";
8134
8847
 
8848
+ export type CustomFieldAnswerWarningReasonEnum =
8849
+ | "Unresolved"
8850
+ | "Inactive"
8851
+ | "ReadOnly"
8852
+ | "DuplicateDefinition";
8853
+
8135
8854
  export type CustomFieldDefinitionDataTypeEnum =
8136
8855
  | "String"
8137
8856
  | "Number"
@@ -8193,6 +8912,8 @@ export type CustomFieldValueDataTypeEnum =
8193
8912
  | "SingleSelect"
8194
8913
  | "MultiSelect";
8195
8914
 
8915
+ export type DocumentsWidgetConfigTypeEnum = "Documents";
8916
+
8196
8917
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
8197
8918
 
8198
8919
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -8234,6 +8955,8 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
8234
8955
  | "WebDocuments"
8235
8956
  | "PosfCreatePackage";
8236
8957
 
8958
+ export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
8959
+
8237
8960
  export type GenerateSystemPromptRequestCategoryEnum =
8238
8961
  | "DocumentAnalysis"
8239
8962
  | "DataQuery"
@@ -8275,6 +8998,18 @@ export type IpAddressAddressFamilyEnum =
8275
8998
  | "ControllerAreaNetwork"
8276
8999
  | "Unknown";
8277
9000
 
9001
+ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
9002
+
9003
+ export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
9004
+
9005
+ export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
9006
+
9007
+ export type InformationWidgetConfigTypeEnum = "Information";
9008
+
9009
+ export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
9010
+
9011
+ export type KpiWidgetConfigTypeEnum = "Kpi";
9012
+
8278
9013
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
8279
9014
 
8280
9015
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -8407,6 +9142,8 @@ export type LoanLogDetailTypeEnum =
8407
9142
  | "ReferrerChangeDiscarded"
8408
9143
  | "TaskEdited";
8409
9144
 
9145
+ export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
9146
+
8410
9147
  export type LoanRoleSlotTasksRoleEnum =
8411
9148
  | "Borrower"
8412
9149
  | "CoBorrower"
@@ -8460,6 +9197,8 @@ export type LoanTaskStatusSummaryStatusEnum =
8460
9197
  | "Rejected"
8461
9198
  | "Unknown";
8462
9199
 
9200
+ export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
9201
+
8463
9202
  export type LoanUserLoanRoleEnum =
8464
9203
  | "Borrower"
8465
9204
  | "CoBorrower"
@@ -8591,6 +9330,12 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
8591
9330
  | "AiGeneratedDocument"
8592
9331
  | "Unidentified";
8593
9332
 
9333
+ export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
9334
+
9335
+ export type MyTasksWidgetConfigTypeEnum = "MyTasks";
9336
+
9337
+ export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
9338
+
8594
9339
  export type PendingInviteStatusEnum =
8595
9340
  | "InvitePending"
8596
9341
  | "InviteExpired"
@@ -8611,6 +9356,12 @@ export type PendingInviteRoleEnum =
8611
9356
  | "SettlementAgent"
8612
9357
  | "Admin";
8613
9358
 
9359
+ export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
9360
+
9361
+ export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
9362
+
9363
+ export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
9364
+
8614
9365
  export type SiteConfigurationTypeEnum =
8615
9366
  | "None"
8616
9367
  | "Account"
@@ -8663,6 +9414,8 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
8663
9414
 
8664
9415
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
8665
9416
 
9417
+ export type TextBlockWidgetConfigTypeEnum = "TextBlock";
9418
+
8666
9419
  export type UnregisteredBorrowerRoleEnum =
8667
9420
  | "Borrower"
8668
9421
  | "CoBorrower"
@@ -8747,6 +9500,10 @@ export type UserLoanConsentLosSyncStatusEnum =
8747
9500
 
8748
9501
  export type UserTableSettingsTableKeyEnum = "Pipeline";
8749
9502
 
9503
+ export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
9504
+
9505
+ export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
9506
+
8750
9507
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
8751
9508
 
8752
9509
  /** @default "Realtor" */
@@ -8761,6 +9518,56 @@ export type GetPartnersParamsRoleEnum =
8761
9518
  | "LoanOfficerAssistant"
8762
9519
  | "SystemAdmin";
8763
9520
 
9521
+ export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
9522
+ | "Home"
9523
+ | "LoanSummary"
9524
+ | "LoanDetails";
9525
+
9526
+ export type SaveSiteConfigurationCanvasParamsEnum =
9527
+ | "Home"
9528
+ | "LoanSummary"
9529
+ | "LoanDetails";
9530
+
9531
+ export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
9532
+ | "Home"
9533
+ | "LoanSummary"
9534
+ | "LoanDetails";
9535
+
9536
+ export type DeleteSiteConfigurationCanvasParamsEnum =
9537
+ | "Home"
9538
+ | "LoanSummary"
9539
+ | "LoanDetails";
9540
+
9541
+ export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
9542
+ | "Home"
9543
+ | "LoanSummary"
9544
+ | "LoanDetails";
9545
+
9546
+ export type PreviewSiteConfigurationCanvasParamsEnum =
9547
+ | "Home"
9548
+ | "LoanSummary"
9549
+ | "LoanDetails";
9550
+
9551
+ export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
9552
+ | "Home"
9553
+ | "LoanSummary"
9554
+ | "LoanDetails";
9555
+
9556
+ export type GetSiteConfigurationCanvasVersionsParamsEnum =
9557
+ | "Home"
9558
+ | "LoanSummary"
9559
+ | "LoanDetails";
9560
+
9561
+ export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
9562
+ | "Home"
9563
+ | "LoanSummary"
9564
+ | "LoanDetails";
9565
+
9566
+ export type RestoreSiteConfigurationCanvasVersionParamsEnum =
9567
+ | "Home"
9568
+ | "LoanSummary"
9569
+ | "LoanDetails";
9570
+
8764
9571
  export type GetSamlMetadataParamsSSoIntegrationEnum =
8765
9572
  | "ConsumerConnect"
8766
9573
  | "TheBigPOS"
@@ -8907,7 +9714,15 @@ export class HttpClient<SecurityDataType = unknown> {
8907
9714
  property instanceof Array ? property : [property];
8908
9715
 
8909
9716
  for (const formItem of propertyContent) {
8910
- const isFileType = formItem instanceof Blob || formItem instanceof File;
9717
+ // React Native files are plain { uri, name, type } objects, not Blob/File.
9718
+ const isReactNativeFile =
9719
+ !!formItem &&
9720
+ typeof formItem === "object" &&
9721
+ "uri" in formItem &&
9722
+ "name" in formItem &&
9723
+ "type" in formItem;
9724
+ const isFileType =
9725
+ isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
8911
9726
  formData.append(
8912
9727
  key,
8913
9728
  isFileType ? formItem : this.stringifyFormItem(formItem),
@@ -8969,7 +9784,7 @@ export class HttpClient<SecurityDataType = unknown> {
8969
9784
 
8970
9785
  /**
8971
9786
  * @title The Big POS API
8972
- * @version v3.14.0
9787
+ * @version v3.15.0
8973
9788
  * @termsOfService https://www.thebigpos.com/terms-of-use/
8974
9789
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
8975
9790
  */
@@ -11603,48 +12418,120 @@ export class Api<
11603
12418
  data: BusinessRuleRequest,
11604
12419
  params: RequestParams = {},
11605
12420
  ) =>
11606
- this.request<BusinessRule, UnprocessableEntity>({
11607
- path: `/api/business-rules/${id}`,
11608
- method: "PUT",
11609
- body: data,
12421
+ this.request<BusinessRule, UnprocessableEntity>({
12422
+ path: `/api/business-rules/${id}`,
12423
+ method: "PUT",
12424
+ body: data,
12425
+ secure: true,
12426
+ type: "application/json",
12427
+ format: "json",
12428
+ ...params,
12429
+ }),
12430
+
12431
+ /**
12432
+ * No description
12433
+ *
12434
+ * @tags BusinessRules
12435
+ * @name DeleteBusinessRule
12436
+ * @summary Delete
12437
+ * @request DELETE:/api/business-rules/{id}
12438
+ * @secure
12439
+ * @response `204` `void` No Content
12440
+ */
12441
+ deleteBusinessRule: (id: string, params: RequestParams = {}) =>
12442
+ this.request<void, any>({
12443
+ path: `/api/business-rules/${id}`,
12444
+ method: "DELETE",
12445
+ secure: true,
12446
+ ...params,
12447
+ }),
12448
+
12449
+ /**
12450
+ * No description
12451
+ *
12452
+ * @tags BusinessRules
12453
+ * @name RestoreBusinessRule
12454
+ * @summary Restore
12455
+ * @request POST:/api/business-rules/{id}/restore
12456
+ * @secure
12457
+ * @response `200` `BusinessRule` OK
12458
+ */
12459
+ restoreBusinessRule: (id: string, params: RequestParams = {}) =>
12460
+ this.request<BusinessRule, any>({
12461
+ path: `/api/business-rules/${id}/restore`,
12462
+ method: "POST",
12463
+ secure: true,
12464
+ format: "json",
12465
+ ...params,
12466
+ }),
12467
+
12468
+ /**
12469
+ * No description
12470
+ *
12471
+ * @tags Canvases
12472
+ * @name GetCanvas
12473
+ * @summary Get a site's canvas for one surface, as the signed-in user sees it
12474
+ * @request GET:/api/canvases/{surface}
12475
+ * @secure
12476
+ * @response `200` `CanvasView` OK
12477
+ * @response `400` `ProblemDetails` Bad Request
12478
+ * @response `404` `ProblemDetails` Not Found
12479
+ * @response `422` `ProblemDetails` Unprocessable Content
12480
+ */
12481
+ getCanvas: (
12482
+ surface: GetCanvasParamsEnum,
12483
+ query: {
12484
+ /** @format uuid */
12485
+ siteConfigurationId: string;
12486
+ },
12487
+ params: RequestParams = {},
12488
+ ) =>
12489
+ this.request<CanvasView, ProblemDetails>({
12490
+ path: `/api/canvases/${surface}`,
12491
+ method: "GET",
12492
+ query: query,
11610
12493
  secure: true,
11611
- type: "application/json",
11612
12494
  format: "json",
11613
12495
  ...params,
11614
12496
  }),
11615
12497
 
11616
12498
  /**
11617
- * No description
12499
+ * @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.
11618
12500
  *
11619
- * @tags BusinessRules
11620
- * @name DeleteBusinessRule
11621
- * @summary Delete
11622
- * @request DELETE:/api/business-rules/{id}
12501
+ * @tags CanvasFields
12502
+ * @name GetCanvasFields
12503
+ * @summary Get the fields a canvas can show
12504
+ * @request GET:/api/canvas/fields
11623
12505
  * @secure
11624
- * @response `204` `void` No Content
12506
+ * @response `200` `CanvasFieldCatalog` OK
12507
+ * @response `403` `ProblemDetails` Forbidden
12508
+ * @response `404` `ProblemDetails` Not Found
11625
12509
  */
11626
- deleteBusinessRule: (id: string, params: RequestParams = {}) =>
11627
- this.request<void, any>({
11628
- path: `/api/business-rules/${id}`,
11629
- method: "DELETE",
12510
+ getCanvasFields: (params: RequestParams = {}) =>
12511
+ this.request<CanvasFieldCatalog, ProblemDetails>({
12512
+ path: `/api/canvas/fields`,
12513
+ method: "GET",
11630
12514
  secure: true,
12515
+ format: "json",
11631
12516
  ...params,
11632
12517
  }),
11633
12518
 
11634
12519
  /**
11635
12520
  * No description
11636
12521
  *
11637
- * @tags BusinessRules
11638
- * @name RestoreBusinessRule
11639
- * @summary Restore
11640
- * @request POST:/api/business-rules/{id}/restore
12522
+ * @tags CanvasWidgetTypes
12523
+ * @name GetCanvasWidgetTypes
12524
+ * @summary Get canvas widget types
12525
+ * @request GET:/api/canvas/widget-types
11641
12526
  * @secure
11642
- * @response `200` `BusinessRule` OK
12527
+ * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
12528
+ * @response `403` `ProblemDetails` Forbidden
12529
+ * @response `404` `ProblemDetails` Not Found
11643
12530
  */
11644
- restoreBusinessRule: (id: string, params: RequestParams = {}) =>
11645
- this.request<BusinessRule, any>({
11646
- path: `/api/business-rules/${id}/restore`,
11647
- method: "POST",
12531
+ getCanvasWidgetTypes: (params: RequestParams = {}) =>
12532
+ this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
12533
+ path: `/api/canvas/widget-types`,
12534
+ method: "GET",
11648
12535
  secure: true,
11649
12536
  format: "json",
11650
12537
  ...params,
@@ -14152,6 +15039,42 @@ export class Api<
14152
15039
  ...params,
14153
15040
  }),
14154
15041
 
15042
+ /**
15043
+ * No description
15044
+ *
15045
+ * @tags IncompleteLoans
15046
+ * @name SearchIncompleteLoans
15047
+ * @summary Search incomplete loans
15048
+ * @request POST:/api/loans/incomplete/search
15049
+ * @secure
15050
+ * @response `200` `IncompleteLoanPaginated` OK
15051
+ * @response `400` `ProblemDetails` Bad Request
15052
+ * @response `403` `ProblemDetails` Forbidden
15053
+ * @response `404` `ProblemDetails` Not Found
15054
+ */
15055
+ searchIncompleteLoans: (
15056
+ data: IncompleteLoanSearchCriteria,
15057
+ query?: {
15058
+ /** @format int32 */
15059
+ pageSize?: number;
15060
+ /** @format int32 */
15061
+ pageNumber?: number;
15062
+ sortBy?: string;
15063
+ sortDirection?: string;
15064
+ },
15065
+ params: RequestParams = {},
15066
+ ) =>
15067
+ this.request<IncompleteLoanPaginated, ProblemDetails>({
15068
+ path: `/api/loans/incomplete/search`,
15069
+ method: "POST",
15070
+ query: query,
15071
+ body: data,
15072
+ secure: true,
15073
+ type: "application/json",
15074
+ format: "json",
15075
+ ...params,
15076
+ }),
15077
+
14155
15078
  /**
14156
15079
  * No description
14157
15080
  *
@@ -14868,6 +15791,50 @@ export class Api<
14868
15791
  ...params,
14869
15792
  }),
14870
15793
 
15794
+ /**
15795
+ * No description
15796
+ *
15797
+ * @tags LoanApplicationRemoval
15798
+ * @name RemoveLoanApplication
15799
+ * @summary Remove a loan application nobody has submitted
15800
+ * @request POST:/api/loans/{loanId}/application/remove
15801
+ * @secure
15802
+ * @response `204` `void` No Content
15803
+ * @response `400` `ProblemDetails` Bad Request
15804
+ * @response `403` `ProblemDetails` Forbidden
15805
+ * @response `404` `ProblemDetails` Not Found
15806
+ * @response `409` `ProblemDetails` Conflict
15807
+ */
15808
+ removeLoanApplication: (loanId: string, params: RequestParams = {}) =>
15809
+ this.request<void, ProblemDetails>({
15810
+ path: `/api/loans/${loanId}/application/remove`,
15811
+ method: "POST",
15812
+ secure: true,
15813
+ ...params,
15814
+ }),
15815
+
15816
+ /**
15817
+ * No description
15818
+ *
15819
+ * @tags LoanApplicationRemoval
15820
+ * @name RestoreLoanApplication
15821
+ * @summary Restore a removed loan application
15822
+ * @request POST:/api/loans/{loanId}/application/restore
15823
+ * @secure
15824
+ * @response `204` `void` No Content
15825
+ * @response `400` `ProblemDetails` Bad Request
15826
+ * @response `403` `ProblemDetails` Forbidden
15827
+ * @response `404` `ProblemDetails` Not Found
15828
+ * @response `409` `ProblemDetails` Conflict
15829
+ */
15830
+ restoreLoanApplication: (loanId: string, params: RequestParams = {}) =>
15831
+ this.request<void, ProblemDetails>({
15832
+ path: `/api/loans/${loanId}/application/restore`,
15833
+ method: "POST",
15834
+ secure: true,
15835
+ ...params,
15836
+ }),
15837
+
14871
15838
  /**
14872
15839
  * No description
14873
15840
  *
@@ -14914,6 +15881,35 @@ export class Api<
14914
15881
  ...params,
14915
15882
  }),
14916
15883
 
15884
+ /**
15885
+ * No description
15886
+ *
15887
+ * @tags LoanCanvasFieldValues
15888
+ * @name GetLoanCanvasFieldValues
15889
+ * @summary Get a loan's values for canvas fields
15890
+ * @request POST:/api/loans/{loanId}/canvas/field-values
15891
+ * @secure
15892
+ * @response `200` `CanvasFieldValues` OK
15893
+ * @response `400` `ProblemDetails` Bad Request
15894
+ * @response `403` `ProblemDetails` Forbidden
15895
+ * @response `404` `ProblemDetails` Not Found
15896
+ * @response `422` `ProblemDetails` Unprocessable Content
15897
+ */
15898
+ getLoanCanvasFieldValues: (
15899
+ loanId: string,
15900
+ data: CanvasFieldValuesRequest,
15901
+ params: RequestParams = {},
15902
+ ) =>
15903
+ this.request<CanvasFieldValues, ProblemDetails>({
15904
+ path: `/api/loans/${loanId}/canvas/field-values`,
15905
+ method: "POST",
15906
+ body: data,
15907
+ secure: true,
15908
+ type: "application/json",
15909
+ format: "json",
15910
+ ...params,
15911
+ }),
15912
+
14917
15913
  /**
14918
15914
  * No description
14919
15915
  *
@@ -16784,6 +17780,7 @@ export class Api<
16784
17780
  * @response `404` `ProblemDetails` Not Found
16785
17781
  * @response `409` `any` Conflict
16786
17782
  * @response `422` `UnprocessableEntity` Unprocessable Content
17783
+ * @response `423` `ProblemDetails` Locked
16787
17784
  */
16788
17785
  updateLoan: (
16789
17786
  loanId: string,
@@ -16938,6 +17935,7 @@ export class Api<
16938
17935
  * @secure
16939
17936
  * @response `202` `void` Accepted
16940
17937
  * @response `404` `ProblemDetails` Not Found
17938
+ * @response `409` `ProblemDetails` Conflict
16941
17939
  */
16942
17940
  syncLoanToLos: (loanId: string, params: RequestParams = {}) =>
16943
17941
  this.request<void, ProblemDetails>({
@@ -18603,6 +19601,186 @@ export class Api<
18603
19601
  ...params,
18604
19602
  }),
18605
19603
 
19604
+ /**
19605
+ * No description
19606
+ *
19607
+ * @tags SiteConfigurationCanvases
19608
+ * @name GetSiteConfigurationCanvases
19609
+ * @summary Get a site's canvases: own, inherited and effective per surface
19610
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
19611
+ * @secure
19612
+ * @response `200` `SiteConfigurationCanvases` OK
19613
+ * @response `403` `ProblemDetails` Forbidden
19614
+ * @response `404` `ProblemDetails` Not Found
19615
+ */
19616
+ getSiteConfigurationCanvases: (
19617
+ siteConfigurationId: string,
19618
+ params: RequestParams = {},
19619
+ ) =>
19620
+ this.request<SiteConfigurationCanvases, ProblemDetails>({
19621
+ path: `/api/site-configurations/${siteConfigurationId}/canvases`,
19622
+ method: "GET",
19623
+ secure: true,
19624
+ format: "json",
19625
+ ...params,
19626
+ }),
19627
+
19628
+ /**
19629
+ * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
19630
+ *
19631
+ * @tags SiteConfigurationCanvases
19632
+ * @name SaveSiteConfigurationCanvas
19633
+ * @summary Save a site's canvas for one surface
19634
+ * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19635
+ * @secure
19636
+ * @response `200` `CanvasSurfaceState` OK
19637
+ * @response `400` `ProblemDetails` Bad Request
19638
+ * @response `403` `ProblemDetails` Forbidden
19639
+ * @response `404` `ProblemDetails` Not Found
19640
+ * @response `409` `ProblemDetails` Conflict
19641
+ * @response `422` `ProblemDetails` Unprocessable Content
19642
+ * @response `423` `ProblemDetails` Locked
19643
+ */
19644
+ saveSiteConfigurationCanvas: (
19645
+ siteConfigurationId: string,
19646
+ surface: SaveSiteConfigurationCanvasParamsEnum,
19647
+ data: SaveSiteConfigurationCanvasRequest,
19648
+ params: RequestParams = {},
19649
+ ) =>
19650
+ this.request<CanvasSurfaceState, ProblemDetails>({
19651
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19652
+ method: "PUT",
19653
+ body: data,
19654
+ secure: true,
19655
+ type: "application/json",
19656
+ format: "json",
19657
+ ...params,
19658
+ }),
19659
+
19660
+ /**
19661
+ * No description
19662
+ *
19663
+ * @tags SiteConfigurationCanvases
19664
+ * @name DeleteSiteConfigurationCanvas
19665
+ * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
19666
+ * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19667
+ * @secure
19668
+ * @response `204` `void` No Content
19669
+ * @response `400` `ProblemDetails` Bad Request
19670
+ * @response `403` `ProblemDetails` Forbidden
19671
+ * @response `404` `ProblemDetails` Not Found
19672
+ * @response `409` `ProblemDetails` Conflict
19673
+ * @response `422` `ProblemDetails` Unprocessable Content
19674
+ */
19675
+ deleteSiteConfigurationCanvas: (
19676
+ siteConfigurationId: string,
19677
+ surface: DeleteSiteConfigurationCanvasParamsEnum,
19678
+ query: {
19679
+ /**
19680
+ * The canvas Version the caller last read. A delete over a newer save is refused as stale.
19681
+ * @format int32
19682
+ */
19683
+ expectedVersion: number;
19684
+ },
19685
+ params: RequestParams = {},
19686
+ ) =>
19687
+ this.request<void, ProblemDetails>({
19688
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19689
+ method: "DELETE",
19690
+ query: query,
19691
+ secure: true,
19692
+ ...params,
19693
+ }),
19694
+
19695
+ /**
19696
+ * No description
19697
+ *
19698
+ * @tags SiteConfigurationCanvases
19699
+ * @name PreviewSiteConfigurationCanvas
19700
+ * @summary Preview an unsaved canvas for one surface as a role would see it
19701
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
19702
+ * @secure
19703
+ * @response `200` `CanvasView` OK
19704
+ * @response `400` `ProblemDetails` Bad Request
19705
+ * @response `403` `ProblemDetails` Forbidden
19706
+ * @response `404` `ProblemDetails` Not Found
19707
+ * @response `422` `ProblemDetails` Unprocessable Content
19708
+ */
19709
+ previewSiteConfigurationCanvas: (
19710
+ siteConfigurationId: string,
19711
+ surface: PreviewSiteConfigurationCanvasParamsEnum,
19712
+ data: PreviewSiteConfigurationCanvasRequest,
19713
+ params: RequestParams = {},
19714
+ ) =>
19715
+ this.request<CanvasView, ProblemDetails>({
19716
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
19717
+ method: "POST",
19718
+ body: data,
19719
+ secure: true,
19720
+ type: "application/json",
19721
+ format: "json",
19722
+ ...params,
19723
+ }),
19724
+
19725
+ /**
19726
+ * No description
19727
+ *
19728
+ * @tags SiteConfigurationCanvases
19729
+ * @name GetSiteConfigurationCanvasVersions
19730
+ * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
19731
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
19732
+ * @secure
19733
+ * @response `200` `(CanvasVersion)[]` OK
19734
+ * @response `403` `ProblemDetails` Forbidden
19735
+ * @response `404` `ProblemDetails` Not Found
19736
+ * @response `422` `ProblemDetails` Unprocessable Content
19737
+ */
19738
+ getSiteConfigurationCanvasVersions: (
19739
+ siteConfigurationId: string,
19740
+ surface: GetSiteConfigurationCanvasVersionsParamsEnum,
19741
+ params: RequestParams = {},
19742
+ ) =>
19743
+ this.request<CanvasVersion[], ProblemDetails>({
19744
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
19745
+ method: "GET",
19746
+ secure: true,
19747
+ format: "json",
19748
+ ...params,
19749
+ }),
19750
+
19751
+ /**
19752
+ * No description
19753
+ *
19754
+ * @tags SiteConfigurationCanvases
19755
+ * @name RestoreSiteConfigurationCanvasVersion
19756
+ * @summary Restore a saved version of a site's canvas as a new version
19757
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
19758
+ * @secure
19759
+ * @response `200` `CanvasSurfaceState` OK
19760
+ * @response `400` `ProblemDetails` Bad Request
19761
+ * @response `403` `ProblemDetails` Forbidden
19762
+ * @response `404` `ProblemDetails` Not Found
19763
+ * @response `409` `ProblemDetails` Conflict
19764
+ * @response `422` `ProblemDetails` Unprocessable Content
19765
+ * @response `423` `ProblemDetails` Locked
19766
+ */
19767
+ restoreSiteConfigurationCanvasVersion: (
19768
+ siteConfigurationId: string,
19769
+ surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
19770
+ version: number,
19771
+ data: RestoreSiteConfigurationCanvasVersionRequest,
19772
+ params: RequestParams = {},
19773
+ ) =>
19774
+ this.request<CanvasSurfaceState, ProblemDetails>({
19775
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
19776
+ method: "POST",
19777
+ body: data,
19778
+ secure: true,
19779
+ type: "application/json",
19780
+ format: "json",
19781
+ ...params,
19782
+ }),
19783
+
18606
19784
  /**
18607
19785
  * No description
18608
19786
  *
@@ -20171,12 +21349,13 @@ export class Api<
20171
21349
  * @response `204` `void` No Content
20172
21350
  * @response `404` `Error` Not Found
20173
21351
  * @response `422` `UnprocessableEntity` Unprocessable Content
21352
+ * @response `429` `ProblemDetails` Too Many Requests
20174
21353
  */
20175
21354
  allowImpersonationWithGuid: (
20176
21355
  allowToken: string,
20177
21356
  params: RequestParams = {},
20178
21357
  ) =>
20179
- this.request<void, Error | UnprocessableEntity>({
21358
+ this.request<void, Error | UnprocessableEntity | ProblemDetails>({
20180
21359
  path: `/api/users/impersonation/allow/${allowToken}`,
20181
21360
  method: "POST",
20182
21361
  secure: true,
@@ -20265,6 +21444,33 @@ export class Api<
20265
21444
  ...params,
20266
21445
  }),
20267
21446
 
21447
+ /**
21448
+ * No description
21449
+ *
21450
+ * @tags UserInviteAcceptance
21451
+ * @name AcceptBorrowerInvite
21452
+ * @summary Accept a borrower invite with the signed-in account
21453
+ * @request POST:/api/users/invites/accept
21454
+ * @secure
21455
+ * @response `200` `AcceptedBorrowerInvite` OK
21456
+ * @response `403` `ProblemDetails` Forbidden
21457
+ * @response `404` `ProblemDetails` Not Found
21458
+ * @response `409` `ProblemDetails` Conflict
21459
+ */
21460
+ acceptBorrowerInvite: (
21461
+ data: AcceptBorrowerInviteRequest,
21462
+ params: RequestParams = {},
21463
+ ) =>
21464
+ this.request<AcceptedBorrowerInvite, ProblemDetails>({
21465
+ path: `/api/users/invites/accept`,
21466
+ method: "POST",
21467
+ body: data,
21468
+ secure: true,
21469
+ type: "application/json",
21470
+ format: "json",
21471
+ ...params,
21472
+ }),
21473
+
20268
21474
  /**
20269
21475
  * No description
20270
21476
  *