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

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;
@@ -3215,6 +3582,81 @@ export interface IncompleteApplicationSummary {
3215
3582
  borrowers: BorrowerIdentity[];
3216
3583
  }
3217
3584
 
3585
+ export interface IncompleteLoan {
3586
+ source: IncompleteLoanSourceEnum;
3587
+ /** @format uuid */
3588
+ loanId?: string | null;
3589
+ /** @format uuid */
3590
+ borrowerId?: string | null;
3591
+ /** @format uuid */
3592
+ draftId?: string | null;
3593
+ /** @format date-time */
3594
+ createdAt: string;
3595
+ /** @format date-time */
3596
+ updatedAt?: string | null;
3597
+ loanOfficer?: UserSummary | null;
3598
+ siteConfiguration?: IncompleteLoanSiteConfiguration | null;
3599
+ draft?: IncompleteLoanDraft | null;
3600
+ borrowers: IncompleteLoanBorrower[];
3601
+ }
3602
+
3603
+ export interface IncompleteLoanBorrower {
3604
+ /** @format uuid */
3605
+ id: string;
3606
+ firstName?: string | null;
3607
+ lastName?: string | null;
3608
+ email?: string | null;
3609
+ isPrimaryBorrower: boolean;
3610
+ applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
3611
+ /** @format date-time */
3612
+ deletedAt?: string | null;
3613
+ }
3614
+
3615
+ export interface IncompleteLoanDraft {
3616
+ /** @format uuid */
3617
+ loanID?: string | null;
3618
+ /** @format date-time */
3619
+ deletedAt?: string | null;
3620
+ routeName?: string | null;
3621
+ user: UserBase;
3622
+ }
3623
+
3624
+ export interface IncompleteLoanPaginated {
3625
+ rows: IncompleteLoan[];
3626
+ pagination: Pagination;
3627
+ /** @format int64 */
3628
+ count: number;
3629
+ }
3630
+
3631
+ export interface IncompleteLoanSearchCriteria {
3632
+ searchText?: string | null;
3633
+ /** @format uuid */
3634
+ loanOfficerId?: string | null;
3635
+ /** @format uuid */
3636
+ siteConfigurationId?: string | null;
3637
+ isUnassigned?: boolean | null;
3638
+ includeRemovedApplications?: boolean | null;
3639
+ }
3640
+
3641
+ export interface IncompleteLoanSiteConfiguration {
3642
+ /** @format uuid */
3643
+ id: string;
3644
+ name: string;
3645
+ }
3646
+
3647
+ export type InformationWidgetConfig = UtilRequiredKeys<
3648
+ BaseCanvasWidgetConfig,
3649
+ "type"
3650
+ > & {
3651
+ /** @format int32 */
3652
+ columns: number;
3653
+ labelPosition: InformationWidgetConfigLabelPositionEnum;
3654
+ hideWhenEmpty: boolean;
3655
+ emptyText?: string | null;
3656
+ items: CanvasInformationItem[];
3657
+ type: InformationWidgetConfigTypeEnum;
3658
+ };
3659
+
3218
3660
  export interface IntegrationSettings {
3219
3661
  encompass?: EncompassIntegrationSettings | null;
3220
3662
  }
@@ -3246,11 +3688,30 @@ export interface Invite {
3246
3688
  status: string;
3247
3689
  loan: LoanIdentifier;
3248
3690
  url: string;
3691
+ linksBorrowerApplication?: boolean | null;
3249
3692
  }
3250
3693
 
3251
3694
  /** Array of operations to perform */
3252
3695
  export type JsonPatchDocument = Operation[];
3253
3696
 
3697
+ export type KeyDatesWidgetConfig = UtilRequiredKeys<
3698
+ BaseCanvasWidgetConfig,
3699
+ "type"
3700
+ > & {
3701
+ dates: string[];
3702
+ type: KeyDatesWidgetConfigTypeEnum;
3703
+ };
3704
+
3705
+ export type KpiWidgetConfig = UtilRequiredKeys<
3706
+ BaseCanvasWidgetConfig,
3707
+ "type"
3708
+ > & {
3709
+ field: CanvasFieldRef;
3710
+ label?: string | null;
3711
+ format?: CanvasFieldFormat | null;
3712
+ type: KpiWidgetConfigTypeEnum;
3713
+ };
3714
+
3254
3715
  export interface LOSIntegration {
3255
3716
  instanceID: string;
3256
3717
  }
@@ -3453,6 +3914,7 @@ export interface LoanApplication {
3453
3914
  refinance?: LoanRefinance | null;
3454
3915
  borrowers: LoanBorrower[];
3455
3916
  nonOwningBorrowers: LoanNonOwningBorrower[];
3917
+ customFieldWarnings?: CustomFieldAnswerWarning[] | null;
3456
3918
  }
3457
3919
 
3458
3920
  export interface LoanApplicationRequest {
@@ -4875,6 +5337,13 @@ export interface LoanPatchRequestGuidPatchDocument {
4875
5337
  operations: GuidPatchOperation[];
4876
5338
  }
4877
5339
 
5340
+ export type LoanProgressWidgetConfig = UtilRequiredKeys<
5341
+ BaseCanvasWidgetConfig,
5342
+ "type"
5343
+ > & {
5344
+ type: LoanProgressWidgetConfigTypeEnum;
5345
+ };
5346
+
4878
5347
  export interface LoanProperty {
4879
5348
  /** @format uuid */
4880
5349
  id?: string | null;
@@ -5198,6 +5667,13 @@ export interface LoanTaskStatusSummary {
5198
5667
  count: number;
5199
5668
  }
5200
5669
 
5670
+ export type LoanTeamWidgetConfig = UtilRequiredKeys<
5671
+ BaseCanvasWidgetConfig,
5672
+ "type"
5673
+ > & {
5674
+ type: LoanTeamWidgetConfigTypeEnum;
5675
+ };
5676
+
5201
5677
  export interface LoanUser {
5202
5678
  /** @format uuid */
5203
5679
  id: string;
@@ -5632,6 +6108,24 @@ export interface MonthlyPaymentCalculatorRequest {
5632
6108
  term: number;
5633
6109
  }
5634
6110
 
6111
+ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
6112
+ BaseCanvasWidgetConfig,
6113
+ "type"
6114
+ > & {
6115
+ type: MonthlyPaymentWidgetConfigTypeEnum;
6116
+ };
6117
+
6118
+ export type MyTasksWidgetConfig = UtilRequiredKeys<
6119
+ BaseCanvasWidgetConfig,
6120
+ "type"
6121
+ > & {
6122
+ /** @format int32 */
6123
+ dueWithinDays: number;
6124
+ /** @format int32 */
6125
+ maxItems: number;
6126
+ type: MyTasksWidgetConfigTypeEnum;
6127
+ };
6128
+
5635
6129
  export interface NoContentResult {
5636
6130
  /** @format int32 */
5637
6131
  statusCode: number;
@@ -5779,6 +6273,15 @@ export interface NotificationTemplateVersionUpdateRequest {
5779
6273
  pushNotificationBody?: string | null;
5780
6274
  }
5781
6275
 
6276
+ export type OpenTasksWidgetConfig = UtilRequiredKeys<
6277
+ BaseCanvasWidgetConfig,
6278
+ "type"
6279
+ > & {
6280
+ /** @format int32 */
6281
+ maxItems: number;
6282
+ type: OpenTasksWidgetConfigTypeEnum;
6283
+ };
6284
+
5782
6285
  export interface Operation {
5783
6286
  op?: string;
5784
6287
  value?: string | number | boolean | null | object;
@@ -5796,6 +6299,7 @@ export interface OutboundFailureBucket {
5796
6299
 
5797
6300
  export interface OverridePasswordRequest {
5798
6301
  password: string;
6302
+ passwordConfirmation?: string | null;
5799
6303
  }
5800
6304
 
5801
6305
  export interface Pagination {
@@ -5927,6 +6431,18 @@ export interface PreliminaryCondition {
5927
6431
  rerequestedBy?: CommentUserInformation | null;
5928
6432
  }
5929
6433
 
6434
+ export interface PreviewSiteConfigurationCanvasRequest {
6435
+ document: CanvasDocument;
6436
+ role?: UserRole | null;
6437
+ }
6438
+
6439
+ export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
6440
+ BaseCanvasWidgetConfig,
6441
+ "type"
6442
+ > & {
6443
+ type: PrimaryBorrowerWidgetConfigTypeEnum;
6444
+ };
6445
+
5930
6446
  export interface ProblemDetails {
5931
6447
  type?: string | null;
5932
6448
  title?: string | null;
@@ -5937,6 +6453,15 @@ export interface ProblemDetails {
5937
6453
  [key: string]: any;
5938
6454
  }
5939
6455
 
6456
+ export type RecentLoansWidgetConfig = UtilRequiredKeys<
6457
+ BaseCanvasWidgetConfig,
6458
+ "type"
6459
+ > & {
6460
+ /** @format int32 */
6461
+ maxItems: number;
6462
+ type: RecentLoansWidgetConfigTypeEnum;
6463
+ };
6464
+
5940
6465
  export interface RefinanceCalculator {
5941
6466
  currentLoan: RefinanceLoan;
5942
6467
  refinanceLoan: RefinanceLoan;
@@ -6057,6 +6582,17 @@ export interface ResetPasswordRequest {
6057
6582
  password: string;
6058
6583
  }
6059
6584
 
6585
+ export interface ResolvedCanvasTab {
6586
+ tab: CanvasTab;
6587
+ source: CanvasSourceSite;
6588
+ isInherited: boolean;
6589
+ }
6590
+
6591
+ export interface RestoreSiteConfigurationCanvasVersionRequest {
6592
+ /** @format int32 */
6593
+ expectedVersion: number;
6594
+ }
6595
+
6060
6596
  export interface RunLOCalculation {
6061
6597
  loanID: string;
6062
6598
  loanAmount?: string | null;
@@ -6137,10 +6673,28 @@ export interface SSOTokenRequest {
6137
6673
  redirectUri?: string | null;
6138
6674
  }
6139
6675
 
6676
+ export interface SaveSiteConfigurationCanvasRequest {
6677
+ document: CanvasDocument;
6678
+ /** @format int32 */
6679
+ expectedVersion?: number | null;
6680
+ /** @format uuid */
6681
+ forkedFromSiteConfigurationID?: string | null;
6682
+ /** @format int32 */
6683
+ forkedFromVersion?: number | null;
6684
+ }
6685
+
6140
6686
  export interface SearchCriteria {
6141
6687
  searchText?: string | null;
6142
6688
  }
6143
6689
 
6690
+ export type SectionDividerWidgetConfig = UtilRequiredKeys<
6691
+ BaseCanvasWidgetConfig,
6692
+ "type"
6693
+ > & {
6694
+ label?: string | null;
6695
+ type: SectionDividerWidgetConfigTypeEnum;
6696
+ };
6697
+
6144
6698
  export interface SendESignatureReminderRequest {
6145
6699
  /** @format uuid */
6146
6700
  userId: string;
@@ -6581,6 +7135,12 @@ export interface SiteConfigurationByUrl {
6581
7135
  workflows: Workflow[];
6582
7136
  }
6583
7137
 
7138
+ export interface SiteConfigurationCanvases {
7139
+ /** @format uuid */
7140
+ siteConfigurationID: string;
7141
+ surfaces: CanvasSurfaceState[];
7142
+ }
7143
+
6584
7144
  export interface SiteConfigurationForm {
6585
7145
  /** @format date-time */
6586
7146
  createdAt: string;
@@ -7087,6 +7647,14 @@ export interface TemplateTokenRoot {
7087
7647
  fields: TemplateToken[];
7088
7648
  }
7089
7649
 
7650
+ export type TextBlockWidgetConfig = UtilRequiredKeys<
7651
+ BaseCanvasWidgetConfig,
7652
+ "type"
7653
+ > & {
7654
+ text: string;
7655
+ type: TextBlockWidgetConfigTypeEnum;
7656
+ };
7657
+
7090
7658
  export interface Theme {
7091
7659
  logoURL: string;
7092
7660
  primaryColor: string;
@@ -7191,6 +7759,8 @@ export interface UnprocessableEntity {
7191
7759
  export interface UnprocessableEntityError {
7192
7760
  error: string;
7193
7761
  property: string;
7762
+ code?: string | null;
7763
+ params?: Record<string, any> | null;
7194
7764
  }
7195
7765
 
7196
7766
  export interface UnregisteredBorrower {
@@ -7917,6 +8487,14 @@ export interface Workflow {
7917
8487
  icon: string;
7918
8488
  }
7919
8489
 
8490
+ interface BaseCanvasWidgetConfig {
8491
+ type: string;
8492
+ }
8493
+
8494
+ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
8495
+ type: Key;
8496
+ } & Type;
8497
+
7920
8498
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
7921
8499
 
7922
8500
  export type AiAuditLogEventTypeEnum =
@@ -7987,6 +8565,8 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
7987
8565
 
7988
8566
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
7989
8567
 
8568
+ export type AmortizationWidgetConfigTypeEnum = "Amortization";
8569
+
7990
8570
  export type AuditLogEntryChangeTypeEnum =
7991
8571
  | "Created"
7992
8572
  | "Modified"
@@ -8027,6 +8607,133 @@ export type BorrowerIdentityRoleEnum =
8027
8607
  | "SettlementAgent"
8028
8608
  | "Admin";
8029
8609
 
8610
+ export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
8611
+
8612
+ export type CanvasFieldDescriptorDataTypeEnum =
8613
+ | "Text"
8614
+ | "Number"
8615
+ | "Decimal"
8616
+ | "Boolean"
8617
+ | "Date"
8618
+ | "DateTime"
8619
+ | "SingleSelect"
8620
+ | "MultiSelect";
8621
+
8622
+ export type CanvasFieldDescriptorFormatEnum =
8623
+ | "Text"
8624
+ | "Number"
8625
+ | "Currency"
8626
+ | "Percent"
8627
+ | "DateShort"
8628
+ | "DateLong"
8629
+ | "YesNo";
8630
+
8631
+ export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
8632
+
8633
+ export type CanvasFieldValueDataTypeEnum =
8634
+ | "Text"
8635
+ | "Number"
8636
+ | "Decimal"
8637
+ | "Boolean"
8638
+ | "Date"
8639
+ | "DateTime"
8640
+ | "SingleSelect"
8641
+ | "MultiSelect";
8642
+
8643
+ export type CanvasFieldViewDataTypeEnum =
8644
+ | "Text"
8645
+ | "Number"
8646
+ | "Decimal"
8647
+ | "Boolean"
8648
+ | "Date"
8649
+ | "DateTime"
8650
+ | "SingleSelect"
8651
+ | "MultiSelect";
8652
+
8653
+ export type CanvasFieldViewFormatEnum =
8654
+ | "Text"
8655
+ | "Number"
8656
+ | "Currency"
8657
+ | "Percent"
8658
+ | "DateShort"
8659
+ | "DateLong"
8660
+ | "YesNo";
8661
+
8662
+ export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
8663
+
8664
+ export type CanvasSourceSiteTypeEnum =
8665
+ | "None"
8666
+ | "Account"
8667
+ | "Corporate"
8668
+ | "Branch"
8669
+ | "LoanOfficer"
8670
+ | "Partner";
8671
+
8672
+ export type CanvasSurfaceStateSurfaceEnum =
8673
+ | "Home"
8674
+ | "LoanSummary"
8675
+ | "LoanDetails";
8676
+
8677
+ export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
8678
+
8679
+ export type CanvasWidgetTypeEnum =
8680
+ | "Information"
8681
+ | "Kpi"
8682
+ | "KeyDates"
8683
+ | "LoanProgress"
8684
+ | "MonthlyPayment"
8685
+ | "Amortization"
8686
+ | "PrimaryBorrower"
8687
+ | "OpenTasks"
8688
+ | "Documents"
8689
+ | "EsignStatus"
8690
+ | "LoanTeam"
8691
+ | "TextBlock"
8692
+ | "SectionDivider"
8693
+ | "MyTasks"
8694
+ | "RecentLoans"
8695
+ | "ClosingSoon";
8696
+
8697
+ export type CanvasWidgetTypeDescriptorTypeEnum =
8698
+ | "Information"
8699
+ | "Kpi"
8700
+ | "KeyDates"
8701
+ | "LoanProgress"
8702
+ | "MonthlyPayment"
8703
+ | "Amortization"
8704
+ | "PrimaryBorrower"
8705
+ | "OpenTasks"
8706
+ | "Documents"
8707
+ | "EsignStatus"
8708
+ | "LoanTeam"
8709
+ | "TextBlock"
8710
+ | "SectionDivider"
8711
+ | "MyTasks"
8712
+ | "RecentLoans"
8713
+ | "ClosingSoon";
8714
+
8715
+ export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
8716
+
8717
+ export type CanvasWidgetViewTypeEnum =
8718
+ | "Information"
8719
+ | "Kpi"
8720
+ | "KeyDates"
8721
+ | "LoanProgress"
8722
+ | "MonthlyPayment"
8723
+ | "Amortization"
8724
+ | "PrimaryBorrower"
8725
+ | "OpenTasks"
8726
+ | "Documents"
8727
+ | "EsignStatus"
8728
+ | "LoanTeam"
8729
+ | "TextBlock"
8730
+ | "SectionDivider"
8731
+ | "MyTasks"
8732
+ | "RecentLoans"
8733
+ | "ClosingSoon";
8734
+
8735
+ export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
8736
+
8030
8737
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
8031
8738
 
8032
8739
  export type CompanyDocumentIndexStatusEnum =
@@ -8132,6 +8839,12 @@ export type CreateUserDraftLoanRoleEnum =
8132
8839
  | "SettlementAgent"
8133
8840
  | "Admin";
8134
8841
 
8842
+ export type CustomFieldAnswerWarningReasonEnum =
8843
+ | "Unresolved"
8844
+ | "Inactive"
8845
+ | "ReadOnly"
8846
+ | "DuplicateDefinition";
8847
+
8135
8848
  export type CustomFieldDefinitionDataTypeEnum =
8136
8849
  | "String"
8137
8850
  | "Number"
@@ -8193,6 +8906,8 @@ export type CustomFieldValueDataTypeEnum =
8193
8906
  | "SingleSelect"
8194
8907
  | "MultiSelect";
8195
8908
 
8909
+ export type DocumentsWidgetConfigTypeEnum = "Documents";
8910
+
8196
8911
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
8197
8912
 
8198
8913
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -8234,6 +8949,8 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
8234
8949
  | "WebDocuments"
8235
8950
  | "PosfCreatePackage";
8236
8951
 
8952
+ export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
8953
+
8237
8954
  export type GenerateSystemPromptRequestCategoryEnum =
8238
8955
  | "DocumentAnalysis"
8239
8956
  | "DataQuery"
@@ -8275,6 +8992,18 @@ export type IpAddressAddressFamilyEnum =
8275
8992
  | "ControllerAreaNetwork"
8276
8993
  | "Unknown";
8277
8994
 
8995
+ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
8996
+
8997
+ export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
8998
+
8999
+ export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
9000
+
9001
+ export type InformationWidgetConfigTypeEnum = "Information";
9002
+
9003
+ export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
9004
+
9005
+ export type KpiWidgetConfigTypeEnum = "Kpi";
9006
+
8278
9007
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
8279
9008
 
8280
9009
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -8407,6 +9136,8 @@ export type LoanLogDetailTypeEnum =
8407
9136
  | "ReferrerChangeDiscarded"
8408
9137
  | "TaskEdited";
8409
9138
 
9139
+ export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
9140
+
8410
9141
  export type LoanRoleSlotTasksRoleEnum =
8411
9142
  | "Borrower"
8412
9143
  | "CoBorrower"
@@ -8460,6 +9191,8 @@ export type LoanTaskStatusSummaryStatusEnum =
8460
9191
  | "Rejected"
8461
9192
  | "Unknown";
8462
9193
 
9194
+ export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
9195
+
8463
9196
  export type LoanUserLoanRoleEnum =
8464
9197
  | "Borrower"
8465
9198
  | "CoBorrower"
@@ -8591,6 +9324,12 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
8591
9324
  | "AiGeneratedDocument"
8592
9325
  | "Unidentified";
8593
9326
 
9327
+ export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
9328
+
9329
+ export type MyTasksWidgetConfigTypeEnum = "MyTasks";
9330
+
9331
+ export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
9332
+
8594
9333
  export type PendingInviteStatusEnum =
8595
9334
  | "InvitePending"
8596
9335
  | "InviteExpired"
@@ -8611,6 +9350,12 @@ export type PendingInviteRoleEnum =
8611
9350
  | "SettlementAgent"
8612
9351
  | "Admin";
8613
9352
 
9353
+ export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
9354
+
9355
+ export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
9356
+
9357
+ export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
9358
+
8614
9359
  export type SiteConfigurationTypeEnum =
8615
9360
  | "None"
8616
9361
  | "Account"
@@ -8663,6 +9408,8 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
8663
9408
 
8664
9409
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
8665
9410
 
9411
+ export type TextBlockWidgetConfigTypeEnum = "TextBlock";
9412
+
8666
9413
  export type UnregisteredBorrowerRoleEnum =
8667
9414
  | "Borrower"
8668
9415
  | "CoBorrower"
@@ -8747,6 +9494,10 @@ export type UserLoanConsentLosSyncStatusEnum =
8747
9494
 
8748
9495
  export type UserTableSettingsTableKeyEnum = "Pipeline";
8749
9496
 
9497
+ export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
9498
+
9499
+ export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
9500
+
8750
9501
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
8751
9502
 
8752
9503
  /** @default "Realtor" */
@@ -8761,6 +9512,56 @@ export type GetPartnersParamsRoleEnum =
8761
9512
  | "LoanOfficerAssistant"
8762
9513
  | "SystemAdmin";
8763
9514
 
9515
+ export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
9516
+ | "Home"
9517
+ | "LoanSummary"
9518
+ | "LoanDetails";
9519
+
9520
+ export type SaveSiteConfigurationCanvasParamsEnum =
9521
+ | "Home"
9522
+ | "LoanSummary"
9523
+ | "LoanDetails";
9524
+
9525
+ export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
9526
+ | "Home"
9527
+ | "LoanSummary"
9528
+ | "LoanDetails";
9529
+
9530
+ export type DeleteSiteConfigurationCanvasParamsEnum =
9531
+ | "Home"
9532
+ | "LoanSummary"
9533
+ | "LoanDetails";
9534
+
9535
+ export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
9536
+ | "Home"
9537
+ | "LoanSummary"
9538
+ | "LoanDetails";
9539
+
9540
+ export type PreviewSiteConfigurationCanvasParamsEnum =
9541
+ | "Home"
9542
+ | "LoanSummary"
9543
+ | "LoanDetails";
9544
+
9545
+ export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
9546
+ | "Home"
9547
+ | "LoanSummary"
9548
+ | "LoanDetails";
9549
+
9550
+ export type GetSiteConfigurationCanvasVersionsParamsEnum =
9551
+ | "Home"
9552
+ | "LoanSummary"
9553
+ | "LoanDetails";
9554
+
9555
+ export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
9556
+ | "Home"
9557
+ | "LoanSummary"
9558
+ | "LoanDetails";
9559
+
9560
+ export type RestoreSiteConfigurationCanvasVersionParamsEnum =
9561
+ | "Home"
9562
+ | "LoanSummary"
9563
+ | "LoanDetails";
9564
+
8764
9565
  export type GetSamlMetadataParamsSSoIntegrationEnum =
8765
9566
  | "ConsumerConnect"
8766
9567
  | "TheBigPOS"
@@ -8907,7 +9708,15 @@ export class HttpClient<SecurityDataType = unknown> {
8907
9708
  property instanceof Array ? property : [property];
8908
9709
 
8909
9710
  for (const formItem of propertyContent) {
8910
- const isFileType = formItem instanceof Blob || formItem instanceof File;
9711
+ // React Native files are plain { uri, name, type } objects, not Blob/File.
9712
+ const isReactNativeFile =
9713
+ !!formItem &&
9714
+ typeof formItem === "object" &&
9715
+ "uri" in formItem &&
9716
+ "name" in formItem &&
9717
+ "type" in formItem;
9718
+ const isFileType =
9719
+ isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
8911
9720
  formData.append(
8912
9721
  key,
8913
9722
  isFileType ? formItem : this.stringifyFormItem(formItem),
@@ -8969,7 +9778,7 @@ export class HttpClient<SecurityDataType = unknown> {
8969
9778
 
8970
9779
  /**
8971
9780
  * @title The Big POS API
8972
- * @version v3.14.0
9781
+ * @version v3.15.0
8973
9782
  * @termsOfService https://www.thebigpos.com/terms-of-use/
8974
9783
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
8975
9784
  */
@@ -11603,48 +12412,120 @@ export class Api<
11603
12412
  data: BusinessRuleRequest,
11604
12413
  params: RequestParams = {},
11605
12414
  ) =>
11606
- this.request<BusinessRule, UnprocessableEntity>({
11607
- path: `/api/business-rules/${id}`,
11608
- method: "PUT",
11609
- body: data,
12415
+ this.request<BusinessRule, UnprocessableEntity>({
12416
+ path: `/api/business-rules/${id}`,
12417
+ method: "PUT",
12418
+ body: data,
12419
+ secure: true,
12420
+ type: "application/json",
12421
+ format: "json",
12422
+ ...params,
12423
+ }),
12424
+
12425
+ /**
12426
+ * No description
12427
+ *
12428
+ * @tags BusinessRules
12429
+ * @name DeleteBusinessRule
12430
+ * @summary Delete
12431
+ * @request DELETE:/api/business-rules/{id}
12432
+ * @secure
12433
+ * @response `204` `void` No Content
12434
+ */
12435
+ deleteBusinessRule: (id: string, params: RequestParams = {}) =>
12436
+ this.request<void, any>({
12437
+ path: `/api/business-rules/${id}`,
12438
+ method: "DELETE",
12439
+ secure: true,
12440
+ ...params,
12441
+ }),
12442
+
12443
+ /**
12444
+ * No description
12445
+ *
12446
+ * @tags BusinessRules
12447
+ * @name RestoreBusinessRule
12448
+ * @summary Restore
12449
+ * @request POST:/api/business-rules/{id}/restore
12450
+ * @secure
12451
+ * @response `200` `BusinessRule` OK
12452
+ */
12453
+ restoreBusinessRule: (id: string, params: RequestParams = {}) =>
12454
+ this.request<BusinessRule, any>({
12455
+ path: `/api/business-rules/${id}/restore`,
12456
+ method: "POST",
12457
+ secure: true,
12458
+ format: "json",
12459
+ ...params,
12460
+ }),
12461
+
12462
+ /**
12463
+ * No description
12464
+ *
12465
+ * @tags Canvases
12466
+ * @name GetCanvas
12467
+ * @summary Get a site's canvas for one surface, as the signed-in user sees it
12468
+ * @request GET:/api/canvases/{surface}
12469
+ * @secure
12470
+ * @response `200` `CanvasView` OK
12471
+ * @response `400` `ProblemDetails` Bad Request
12472
+ * @response `404` `ProblemDetails` Not Found
12473
+ * @response `422` `ProblemDetails` Unprocessable Content
12474
+ */
12475
+ getCanvas: (
12476
+ surface: GetCanvasParamsEnum,
12477
+ query: {
12478
+ /** @format uuid */
12479
+ siteConfigurationId: string;
12480
+ },
12481
+ params: RequestParams = {},
12482
+ ) =>
12483
+ this.request<CanvasView, ProblemDetails>({
12484
+ path: `/api/canvases/${surface}`,
12485
+ method: "GET",
12486
+ query: query,
11610
12487
  secure: true,
11611
- type: "application/json",
11612
12488
  format: "json",
11613
12489
  ...params,
11614
12490
  }),
11615
12491
 
11616
12492
  /**
11617
- * No description
12493
+ * @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
12494
  *
11619
- * @tags BusinessRules
11620
- * @name DeleteBusinessRule
11621
- * @summary Delete
11622
- * @request DELETE:/api/business-rules/{id}
12495
+ * @tags CanvasFields
12496
+ * @name GetCanvasFields
12497
+ * @summary Get the fields a canvas can show
12498
+ * @request GET:/api/canvas/fields
11623
12499
  * @secure
11624
- * @response `204` `void` No Content
12500
+ * @response `200` `CanvasFieldCatalog` OK
12501
+ * @response `403` `ProblemDetails` Forbidden
12502
+ * @response `404` `ProblemDetails` Not Found
11625
12503
  */
11626
- deleteBusinessRule: (id: string, params: RequestParams = {}) =>
11627
- this.request<void, any>({
11628
- path: `/api/business-rules/${id}`,
11629
- method: "DELETE",
12504
+ getCanvasFields: (params: RequestParams = {}) =>
12505
+ this.request<CanvasFieldCatalog, ProblemDetails>({
12506
+ path: `/api/canvas/fields`,
12507
+ method: "GET",
11630
12508
  secure: true,
12509
+ format: "json",
11631
12510
  ...params,
11632
12511
  }),
11633
12512
 
11634
12513
  /**
11635
12514
  * No description
11636
12515
  *
11637
- * @tags BusinessRules
11638
- * @name RestoreBusinessRule
11639
- * @summary Restore
11640
- * @request POST:/api/business-rules/{id}/restore
12516
+ * @tags CanvasWidgetTypes
12517
+ * @name GetCanvasWidgetTypes
12518
+ * @summary Get canvas widget types
12519
+ * @request GET:/api/canvas/widget-types
11641
12520
  * @secure
11642
- * @response `200` `BusinessRule` OK
12521
+ * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
12522
+ * @response `403` `ProblemDetails` Forbidden
12523
+ * @response `404` `ProblemDetails` Not Found
11643
12524
  */
11644
- restoreBusinessRule: (id: string, params: RequestParams = {}) =>
11645
- this.request<BusinessRule, any>({
11646
- path: `/api/business-rules/${id}/restore`,
11647
- method: "POST",
12525
+ getCanvasWidgetTypes: (params: RequestParams = {}) =>
12526
+ this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
12527
+ path: `/api/canvas/widget-types`,
12528
+ method: "GET",
11648
12529
  secure: true,
11649
12530
  format: "json",
11650
12531
  ...params,
@@ -14152,6 +15033,42 @@ export class Api<
14152
15033
  ...params,
14153
15034
  }),
14154
15035
 
15036
+ /**
15037
+ * No description
15038
+ *
15039
+ * @tags IncompleteLoans
15040
+ * @name SearchIncompleteLoans
15041
+ * @summary Search incomplete loans
15042
+ * @request POST:/api/loans/incomplete/search
15043
+ * @secure
15044
+ * @response `200` `IncompleteLoanPaginated` OK
15045
+ * @response `400` `ProblemDetails` Bad Request
15046
+ * @response `403` `ProblemDetails` Forbidden
15047
+ * @response `404` `ProblemDetails` Not Found
15048
+ */
15049
+ searchIncompleteLoans: (
15050
+ data: IncompleteLoanSearchCriteria,
15051
+ query?: {
15052
+ /** @format int32 */
15053
+ pageSize?: number;
15054
+ /** @format int32 */
15055
+ pageNumber?: number;
15056
+ sortBy?: string;
15057
+ sortDirection?: string;
15058
+ },
15059
+ params: RequestParams = {},
15060
+ ) =>
15061
+ this.request<IncompleteLoanPaginated, ProblemDetails>({
15062
+ path: `/api/loans/incomplete/search`,
15063
+ method: "POST",
15064
+ query: query,
15065
+ body: data,
15066
+ secure: true,
15067
+ type: "application/json",
15068
+ format: "json",
15069
+ ...params,
15070
+ }),
15071
+
14155
15072
  /**
14156
15073
  * No description
14157
15074
  *
@@ -14868,6 +15785,50 @@ export class Api<
14868
15785
  ...params,
14869
15786
  }),
14870
15787
 
15788
+ /**
15789
+ * No description
15790
+ *
15791
+ * @tags LoanApplicationRemoval
15792
+ * @name RemoveLoanApplication
15793
+ * @summary Remove a loan application nobody has submitted
15794
+ * @request POST:/api/loans/{loanId}/application/remove
15795
+ * @secure
15796
+ * @response `204` `void` No Content
15797
+ * @response `400` `ProblemDetails` Bad Request
15798
+ * @response `403` `ProblemDetails` Forbidden
15799
+ * @response `404` `ProblemDetails` Not Found
15800
+ * @response `409` `ProblemDetails` Conflict
15801
+ */
15802
+ removeLoanApplication: (loanId: string, params: RequestParams = {}) =>
15803
+ this.request<void, ProblemDetails>({
15804
+ path: `/api/loans/${loanId}/application/remove`,
15805
+ method: "POST",
15806
+ secure: true,
15807
+ ...params,
15808
+ }),
15809
+
15810
+ /**
15811
+ * No description
15812
+ *
15813
+ * @tags LoanApplicationRemoval
15814
+ * @name RestoreLoanApplication
15815
+ * @summary Restore a removed loan application
15816
+ * @request POST:/api/loans/{loanId}/application/restore
15817
+ * @secure
15818
+ * @response `204` `void` No Content
15819
+ * @response `400` `ProblemDetails` Bad Request
15820
+ * @response `403` `ProblemDetails` Forbidden
15821
+ * @response `404` `ProblemDetails` Not Found
15822
+ * @response `409` `ProblemDetails` Conflict
15823
+ */
15824
+ restoreLoanApplication: (loanId: string, params: RequestParams = {}) =>
15825
+ this.request<void, ProblemDetails>({
15826
+ path: `/api/loans/${loanId}/application/restore`,
15827
+ method: "POST",
15828
+ secure: true,
15829
+ ...params,
15830
+ }),
15831
+
14871
15832
  /**
14872
15833
  * No description
14873
15834
  *
@@ -14914,6 +15875,35 @@ export class Api<
14914
15875
  ...params,
14915
15876
  }),
14916
15877
 
15878
+ /**
15879
+ * No description
15880
+ *
15881
+ * @tags LoanCanvasFieldValues
15882
+ * @name GetLoanCanvasFieldValues
15883
+ * @summary Get a loan's values for canvas fields
15884
+ * @request POST:/api/loans/{loanId}/canvas/field-values
15885
+ * @secure
15886
+ * @response `200` `CanvasFieldValues` OK
15887
+ * @response `400` `ProblemDetails` Bad Request
15888
+ * @response `403` `ProblemDetails` Forbidden
15889
+ * @response `404` `ProblemDetails` Not Found
15890
+ * @response `422` `ProblemDetails` Unprocessable Content
15891
+ */
15892
+ getLoanCanvasFieldValues: (
15893
+ loanId: string,
15894
+ data: CanvasFieldValuesRequest,
15895
+ params: RequestParams = {},
15896
+ ) =>
15897
+ this.request<CanvasFieldValues, ProblemDetails>({
15898
+ path: `/api/loans/${loanId}/canvas/field-values`,
15899
+ method: "POST",
15900
+ body: data,
15901
+ secure: true,
15902
+ type: "application/json",
15903
+ format: "json",
15904
+ ...params,
15905
+ }),
15906
+
14917
15907
  /**
14918
15908
  * No description
14919
15909
  *
@@ -16784,6 +17774,7 @@ export class Api<
16784
17774
  * @response `404` `ProblemDetails` Not Found
16785
17775
  * @response `409` `any` Conflict
16786
17776
  * @response `422` `UnprocessableEntity` Unprocessable Content
17777
+ * @response `423` `ProblemDetails` Locked
16787
17778
  */
16788
17779
  updateLoan: (
16789
17780
  loanId: string,
@@ -16938,6 +17929,7 @@ export class Api<
16938
17929
  * @secure
16939
17930
  * @response `202` `void` Accepted
16940
17931
  * @response `404` `ProblemDetails` Not Found
17932
+ * @response `409` `ProblemDetails` Conflict
16941
17933
  */
16942
17934
  syncLoanToLos: (loanId: string, params: RequestParams = {}) =>
16943
17935
  this.request<void, ProblemDetails>({
@@ -18603,6 +19595,186 @@ export class Api<
18603
19595
  ...params,
18604
19596
  }),
18605
19597
 
19598
+ /**
19599
+ * No description
19600
+ *
19601
+ * @tags SiteConfigurationCanvases
19602
+ * @name GetSiteConfigurationCanvases
19603
+ * @summary Get a site's canvases: own, inherited and effective per surface
19604
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
19605
+ * @secure
19606
+ * @response `200` `SiteConfigurationCanvases` OK
19607
+ * @response `403` `ProblemDetails` Forbidden
19608
+ * @response `404` `ProblemDetails` Not Found
19609
+ */
19610
+ getSiteConfigurationCanvases: (
19611
+ siteConfigurationId: string,
19612
+ params: RequestParams = {},
19613
+ ) =>
19614
+ this.request<SiteConfigurationCanvases, ProblemDetails>({
19615
+ path: `/api/site-configurations/${siteConfigurationId}/canvases`,
19616
+ method: "GET",
19617
+ secure: true,
19618
+ format: "json",
19619
+ ...params,
19620
+ }),
19621
+
19622
+ /**
19623
+ * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
19624
+ *
19625
+ * @tags SiteConfigurationCanvases
19626
+ * @name SaveSiteConfigurationCanvas
19627
+ * @summary Save a site's canvas for one surface
19628
+ * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19629
+ * @secure
19630
+ * @response `200` `CanvasSurfaceState` OK
19631
+ * @response `400` `ProblemDetails` Bad Request
19632
+ * @response `403` `ProblemDetails` Forbidden
19633
+ * @response `404` `ProblemDetails` Not Found
19634
+ * @response `409` `ProblemDetails` Conflict
19635
+ * @response `422` `ProblemDetails` Unprocessable Content
19636
+ * @response `423` `ProblemDetails` Locked
19637
+ */
19638
+ saveSiteConfigurationCanvas: (
19639
+ siteConfigurationId: string,
19640
+ surface: SaveSiteConfigurationCanvasParamsEnum,
19641
+ data: SaveSiteConfigurationCanvasRequest,
19642
+ params: RequestParams = {},
19643
+ ) =>
19644
+ this.request<CanvasSurfaceState, ProblemDetails>({
19645
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19646
+ method: "PUT",
19647
+ body: data,
19648
+ secure: true,
19649
+ type: "application/json",
19650
+ format: "json",
19651
+ ...params,
19652
+ }),
19653
+
19654
+ /**
19655
+ * No description
19656
+ *
19657
+ * @tags SiteConfigurationCanvases
19658
+ * @name DeleteSiteConfigurationCanvas
19659
+ * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
19660
+ * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19661
+ * @secure
19662
+ * @response `204` `void` No Content
19663
+ * @response `400` `ProblemDetails` Bad Request
19664
+ * @response `403` `ProblemDetails` Forbidden
19665
+ * @response `404` `ProblemDetails` Not Found
19666
+ * @response `409` `ProblemDetails` Conflict
19667
+ * @response `422` `ProblemDetails` Unprocessable Content
19668
+ */
19669
+ deleteSiteConfigurationCanvas: (
19670
+ siteConfigurationId: string,
19671
+ surface: DeleteSiteConfigurationCanvasParamsEnum,
19672
+ query: {
19673
+ /**
19674
+ * The canvas Version the caller last read. A delete over a newer save is refused as stale.
19675
+ * @format int32
19676
+ */
19677
+ expectedVersion: number;
19678
+ },
19679
+ params: RequestParams = {},
19680
+ ) =>
19681
+ this.request<void, ProblemDetails>({
19682
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19683
+ method: "DELETE",
19684
+ query: query,
19685
+ secure: true,
19686
+ ...params,
19687
+ }),
19688
+
19689
+ /**
19690
+ * No description
19691
+ *
19692
+ * @tags SiteConfigurationCanvases
19693
+ * @name PreviewSiteConfigurationCanvas
19694
+ * @summary Preview an unsaved canvas for one surface as a role would see it
19695
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
19696
+ * @secure
19697
+ * @response `200` `CanvasView` OK
19698
+ * @response `400` `ProblemDetails` Bad Request
19699
+ * @response `403` `ProblemDetails` Forbidden
19700
+ * @response `404` `ProblemDetails` Not Found
19701
+ * @response `422` `ProblemDetails` Unprocessable Content
19702
+ */
19703
+ previewSiteConfigurationCanvas: (
19704
+ siteConfigurationId: string,
19705
+ surface: PreviewSiteConfigurationCanvasParamsEnum,
19706
+ data: PreviewSiteConfigurationCanvasRequest,
19707
+ params: RequestParams = {},
19708
+ ) =>
19709
+ this.request<CanvasView, ProblemDetails>({
19710
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
19711
+ method: "POST",
19712
+ body: data,
19713
+ secure: true,
19714
+ type: "application/json",
19715
+ format: "json",
19716
+ ...params,
19717
+ }),
19718
+
19719
+ /**
19720
+ * No description
19721
+ *
19722
+ * @tags SiteConfigurationCanvases
19723
+ * @name GetSiteConfigurationCanvasVersions
19724
+ * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
19725
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
19726
+ * @secure
19727
+ * @response `200` `(CanvasVersion)[]` OK
19728
+ * @response `403` `ProblemDetails` Forbidden
19729
+ * @response `404` `ProblemDetails` Not Found
19730
+ * @response `422` `ProblemDetails` Unprocessable Content
19731
+ */
19732
+ getSiteConfigurationCanvasVersions: (
19733
+ siteConfigurationId: string,
19734
+ surface: GetSiteConfigurationCanvasVersionsParamsEnum,
19735
+ params: RequestParams = {},
19736
+ ) =>
19737
+ this.request<CanvasVersion[], ProblemDetails>({
19738
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
19739
+ method: "GET",
19740
+ secure: true,
19741
+ format: "json",
19742
+ ...params,
19743
+ }),
19744
+
19745
+ /**
19746
+ * No description
19747
+ *
19748
+ * @tags SiteConfigurationCanvases
19749
+ * @name RestoreSiteConfigurationCanvasVersion
19750
+ * @summary Restore a saved version of a site's canvas as a new version
19751
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
19752
+ * @secure
19753
+ * @response `200` `CanvasSurfaceState` OK
19754
+ * @response `400` `ProblemDetails` Bad Request
19755
+ * @response `403` `ProblemDetails` Forbidden
19756
+ * @response `404` `ProblemDetails` Not Found
19757
+ * @response `409` `ProblemDetails` Conflict
19758
+ * @response `422` `ProblemDetails` Unprocessable Content
19759
+ * @response `423` `ProblemDetails` Locked
19760
+ */
19761
+ restoreSiteConfigurationCanvasVersion: (
19762
+ siteConfigurationId: string,
19763
+ surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
19764
+ version: number,
19765
+ data: RestoreSiteConfigurationCanvasVersionRequest,
19766
+ params: RequestParams = {},
19767
+ ) =>
19768
+ this.request<CanvasSurfaceState, ProblemDetails>({
19769
+ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
19770
+ method: "POST",
19771
+ body: data,
19772
+ secure: true,
19773
+ type: "application/json",
19774
+ format: "json",
19775
+ ...params,
19776
+ }),
19777
+
18606
19778
  /**
18607
19779
  * No description
18608
19780
  *
@@ -20171,12 +21343,13 @@ export class Api<
20171
21343
  * @response `204` `void` No Content
20172
21344
  * @response `404` `Error` Not Found
20173
21345
  * @response `422` `UnprocessableEntity` Unprocessable Content
21346
+ * @response `429` `ProblemDetails` Too Many Requests
20174
21347
  */
20175
21348
  allowImpersonationWithGuid: (
20176
21349
  allowToken: string,
20177
21350
  params: RequestParams = {},
20178
21351
  ) =>
20179
- this.request<void, Error | UnprocessableEntity>({
21352
+ this.request<void, Error | UnprocessableEntity | ProblemDetails>({
20180
21353
  path: `/api/users/impersonation/allow/${allowToken}`,
20181
21354
  method: "POST",
20182
21355
  secure: true,
@@ -20265,6 +21438,33 @@ export class Api<
20265
21438
  ...params,
20266
21439
  }),
20267
21440
 
21441
+ /**
21442
+ * No description
21443
+ *
21444
+ * @tags UserInviteAcceptance
21445
+ * @name AcceptBorrowerInvite
21446
+ * @summary Accept a borrower invite with the signed-in account
21447
+ * @request POST:/api/users/invites/accept
21448
+ * @secure
21449
+ * @response `200` `AcceptedBorrowerInvite` OK
21450
+ * @response `403` `ProblemDetails` Forbidden
21451
+ * @response `404` `ProblemDetails` Not Found
21452
+ * @response `409` `ProblemDetails` Conflict
21453
+ */
21454
+ acceptBorrowerInvite: (
21455
+ data: AcceptBorrowerInviteRequest,
21456
+ params: RequestParams = {},
21457
+ ) =>
21458
+ this.request<AcceptedBorrowerInvite, ProblemDetails>({
21459
+ path: `/api/users/invites/accept`,
21460
+ method: "POST",
21461
+ body: data,
21462
+ secure: true,
21463
+ type: "application/json",
21464
+ format: "json",
21465
+ ...params,
21466
+ }),
21467
+
20268
21468
  /**
20269
21469
  * No description
20270
21470
  *