@matech/thebigpos-sdk 3.15.0-dev-6040 → 3.15.0-main-6054

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,8 +10,6 @@
10
10
  * ---------------------------------------------------------------
11
11
  */
12
12
 
13
- type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
14
-
15
13
  export type VersionStatusType = "Draft" | "Published";
16
14
 
17
15
  export type UserRole =
@@ -143,20 +141,6 @@ export type LoanRefinancePurpose =
143
141
 
144
142
  export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
145
143
 
146
- export type LoanRealEstatePropertyType =
147
- | "SingleFamily"
148
- | "Condominium"
149
- | "Townhouse"
150
- | "Cooperative"
151
- | "TwoToFourUnitProperty"
152
- | "MultifamilyMoreThanFourUnits"
153
- | "ManufacturedMobileHome"
154
- | "CommercialNonResidential"
155
- | "HomeAndBusinessCombined"
156
- | "MixedUseResidential"
157
- | "Farm"
158
- | "Land";
159
-
160
144
  export type LoanRealEstateOccupancyType =
161
145
  | "PrimaryHome"
162
146
  | "SecondHome"
@@ -308,8 +292,7 @@ export type LoanLogType =
308
292
  | "CoBorrowerEmailAutoFixed"
309
293
  | "LosFieldWriteBack"
310
294
  | "ReferrerChangeDiscarded"
311
- | "TaskEdited"
312
- | "SigningMethodChanged";
295
+ | "TaskEdited";
313
296
 
314
297
  export type LoanLienPosition = "First" | "Subordinate";
315
298
 
@@ -578,55 +561,6 @@ export type CompanyDocumentIndexStatus =
578
561
 
579
562
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
580
563
 
581
- export type CanvasWidgetType =
582
- | "Information"
583
- | "Kpi"
584
- | "KeyDates"
585
- | "LoanProgress"
586
- | "MonthlyPayment"
587
- | "Amortization"
588
- | "PrimaryBorrower"
589
- | "OpenTasks"
590
- | "Documents"
591
- | "EsignStatus"
592
- | "LoanTeam"
593
- | "TextBlock"
594
- | "SectionDivider"
595
- | "MyTasks"
596
- | "RecentLoans"
597
- | "ClosingSoon";
598
-
599
- export type CanvasWidgetScope = "Loan" | "User" | "Any";
600
-
601
- export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
602
-
603
- export type CanvasLabelPosition = "Left" | "Above";
604
-
605
- export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
606
-
607
- export type CanvasFieldSource = "Standard" | "Custom";
608
-
609
- export type CanvasFieldFormat =
610
- | "Text"
611
- | "Number"
612
- | "Currency"
613
- | "Percent"
614
- | "DateShort"
615
- | "DateLong"
616
- | "YesNo";
617
-
618
- export type CanvasFieldDataType =
619
- | "Text"
620
- | "Number"
621
- | "Decimal"
622
- | "Boolean"
623
- | "Date"
624
- | "DateTime"
625
- | "SingleSelect"
626
- | "MultiSelect";
627
-
628
- export type CanvasAudience = "Staff" | "Borrower" | "Partner";
629
-
630
564
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
631
565
 
632
566
  export type BranchType = "Mortgage" | "RealEstate";
@@ -767,41 +701,6 @@ export type AddressFamily =
767
701
  | "ControllerAreaNetwork"
768
702
  | "Unknown";
769
703
 
770
- export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
771
- (
772
- | BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
773
- | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig>
774
- | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig>
775
- | BaseCanvasWidgetConfigTypeMapping<
776
- "LoanProgress",
777
- LoanProgressWidgetConfig
778
- >
779
- | BaseCanvasWidgetConfigTypeMapping<
780
- "MonthlyPayment",
781
- MonthlyPaymentWidgetConfig
782
- >
783
- | BaseCanvasWidgetConfigTypeMapping<
784
- "Amortization",
785
- AmortizationWidgetConfig
786
- >
787
- | BaseCanvasWidgetConfigTypeMapping<
788
- "PrimaryBorrower",
789
- PrimaryBorrowerWidgetConfig
790
- >
791
- | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig>
792
- | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig>
793
- | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig>
794
- | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig>
795
- | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig>
796
- | BaseCanvasWidgetConfigTypeMapping<
797
- "SectionDivider",
798
- SectionDividerWidgetConfig
799
- >
800
- | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig>
801
- | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig>
802
- | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>
803
- );
804
-
805
704
  export interface ASOSettings {
806
705
  enabled: boolean;
807
706
  softPull: boolean;
@@ -1144,7 +1043,7 @@ export interface AiAuditLog {
1144
1043
  guardrailCategory?: string | null;
1145
1044
  rawRequest?: string | null;
1146
1045
  rawResponse?: string | null;
1147
- details?: any | null;
1046
+ details: any;
1148
1047
  /** @format date-time */
1149
1048
  createdAt: string;
1150
1049
  }
@@ -1656,13 +1555,6 @@ export interface AmortizationSchedule {
1656
1555
  pmi: number;
1657
1556
  }
1658
1557
 
1659
- export type AmortizationWidgetConfig = UtilRequiredKeys<
1660
- BaseCanvasWidgetConfig,
1661
- "type"
1662
- > & {
1663
- type: AmortizationWidgetConfigTypeEnum;
1664
- };
1665
-
1666
1558
  export interface ApplicationRowData {
1667
1559
  borrowerEmail?: string | null;
1668
1560
  borrowerFirstName?: string | null;
@@ -1738,7 +1630,7 @@ export interface AuditLogEntry {
1738
1630
  rootEntityType?: string | null;
1739
1631
  /** @format uuid */
1740
1632
  rootEntityId?: string | null;
1741
- changes?: any | null;
1633
+ changes: any;
1742
1634
  /** @format date-time */
1743
1635
  createdAt: string;
1744
1636
  }
@@ -1936,227 +1828,6 @@ export interface BusinessRuleRequest {
1936
1828
  applyToAllBorrowerPairs: boolean;
1937
1829
  }
1938
1830
 
1939
- export interface CanvasAuthor {
1940
- /** @format uuid */
1941
- id: string;
1942
- firstName: string;
1943
- lastName: string;
1944
- email: string;
1945
- }
1946
-
1947
- export interface CanvasBoard {
1948
- name?: string | null;
1949
- roles: UserRole[];
1950
- widgetIds: string[];
1951
- widgets: Record<string, CanvasWidget>;
1952
- }
1953
-
1954
- export interface CanvasBoardView {
1955
- widgetIds: string[];
1956
- widgets: Record<string, CanvasWidgetView>;
1957
- }
1958
-
1959
- export interface CanvasDocument {
1960
- /** @format int32 */
1961
- schemaVersion: number;
1962
- boards?: CanvasBoard[] | null;
1963
- tabs?: CanvasTab[] | null;
1964
- }
1965
-
1966
- export interface CanvasFieldCatalog {
1967
- fields: CanvasFieldDescriptor[];
1968
- }
1969
-
1970
- export interface CanvasFieldDescriptor {
1971
- source: CanvasFieldDescriptorSourceEnum;
1972
- key: string;
1973
- label: string;
1974
- category: string;
1975
- categoryKey: string;
1976
- dataType: CanvasFieldDescriptorDataTypeEnum;
1977
- format: CanvasFieldDescriptorFormatEnum;
1978
- encompassFieldId?: string | null;
1979
- readableRoles: UserRole[];
1980
- isActive: boolean;
1981
- rolesWithoutPermissionRows: UserRole[];
1982
- options: string[];
1983
- }
1984
-
1985
- export interface CanvasFieldRef {
1986
- source: CanvasFieldRefSourceEnum;
1987
- key: string;
1988
- }
1989
-
1990
- export interface CanvasFieldValue {
1991
- dataType: CanvasFieldValueDataTypeEnum;
1992
- value?: any | null;
1993
- }
1994
-
1995
- export interface CanvasFieldValues {
1996
- standard: Record<string, CanvasFieldValue>;
1997
- custom: Record<string, CanvasFieldValue>;
1998
- }
1999
-
2000
- export interface CanvasFieldValuesRequest {
2001
- standardKeys: string[];
2002
- customFieldIds: string[];
2003
- }
2004
-
2005
- export interface CanvasFieldView {
2006
- label: string;
2007
- dataType: CanvasFieldViewDataTypeEnum;
2008
- format: CanvasFieldViewFormatEnum;
2009
- options: string[];
2010
- }
2011
-
2012
- export interface CanvasInformationItem {
2013
- kind: CanvasInformationItemKindEnum;
2014
- field?: CanvasFieldRef | null;
2015
- text?: string | null;
2016
- label?: string | null;
2017
- format?: CanvasFieldFormat | null;
2018
- emphasis: boolean;
2019
- hideWhenEmpty: boolean;
2020
- roles: UserRole[];
2021
- /** @format int32 */
2022
- column: number;
2023
- }
2024
-
2025
- export interface CanvasSourceSite {
2026
- /** @format uuid */
2027
- siteConfigurationID: string;
2028
- name: string;
2029
- type: CanvasSourceSiteTypeEnum;
2030
- }
2031
-
2032
- export interface CanvasSurfaceState {
2033
- surface: CanvasSurfaceStateSurfaceEnum;
2034
- own?: CanvasDocument | null;
2035
- /** @format int32 */
2036
- ownVersion?: number | null;
2037
- isOwnUnreadable: boolean;
2038
- /** @format date-time */
2039
- ownUpdatedAt?: string | null;
2040
- /** @format uuid */
2041
- forkedFromSiteConfigurationID?: string | null;
2042
- /** @format int32 */
2043
- forkedFromVersion?: number | null;
2044
- inherited?: CanvasDocument | null;
2045
- /** @format int32 */
2046
- inheritedVersion?: number | null;
2047
- inheritedFrom?: CanvasSourceSite | null;
2048
- isBehindInherited: boolean;
2049
- effectiveBoards?: CanvasBoard[] | null;
2050
- effectiveTabs?: ResolvedCanvasTab[] | null;
2051
- }
2052
-
2053
- export interface CanvasTab {
2054
- key: string;
2055
- /** @format int32 */
2056
- version: number;
2057
- title: string;
2058
- roles: UserRole[];
2059
- copiedFrom?: CanvasTabOrigin | null;
2060
- board: CanvasBoard;
2061
- }
2062
-
2063
- export interface CanvasTabOrigin {
2064
- /** @format uuid */
2065
- siteConfigurationID: string;
2066
- tabKey: string;
2067
- /** @format int32 */
2068
- version: number;
2069
- }
2070
-
2071
- export interface CanvasTabView {
2072
- key: string;
2073
- title: string;
2074
- board: CanvasBoardView;
2075
- }
2076
-
2077
- export interface CanvasVersion {
2078
- /** @format int32 */
2079
- version: number;
2080
- /** @format date-time */
2081
- createdAt: string;
2082
- createdBy?: CanvasAuthor | null;
2083
- }
2084
-
2085
- export interface CanvasView {
2086
- surface: CanvasViewSurfaceEnum;
2087
- isConfigured: boolean;
2088
- board?: CanvasBoardView | null;
2089
- tabs?: CanvasTabView[] | null;
2090
- standardFields: Record<string, CanvasFieldView>;
2091
- customFields: Record<string, CanvasFieldView>;
2092
- }
2093
-
2094
- export interface CanvasWidget {
2095
- type: CanvasWidgetTypeEnum;
2096
- /** @format int32 */
2097
- configVersion: number;
2098
- title?: string | null;
2099
- /** @format int32 */
2100
- width: number;
2101
- roles: UserRole[];
2102
- config:
2103
- | InformationWidgetConfig
2104
- | KpiWidgetConfig
2105
- | KeyDatesWidgetConfig
2106
- | LoanProgressWidgetConfig
2107
- | MonthlyPaymentWidgetConfig
2108
- | AmortizationWidgetConfig
2109
- | PrimaryBorrowerWidgetConfig
2110
- | OpenTasksWidgetConfig
2111
- | DocumentsWidgetConfig
2112
- | EsignStatusWidgetConfig
2113
- | LoanTeamWidgetConfig
2114
- | TextBlockWidgetConfig
2115
- | SectionDividerWidgetConfig
2116
- | MyTasksWidgetConfig
2117
- | RecentLoansWidgetConfig
2118
- | ClosingSoonWidgetConfig;
2119
- }
2120
-
2121
- export interface CanvasWidgetTypeDescriptor {
2122
- type: CanvasWidgetTypeDescriptorTypeEnum;
2123
- scope: CanvasWidgetTypeDescriptorScopeEnum;
2124
- surfaces: CanvasSurface[];
2125
- audiences: CanvasAudience[];
2126
- allowedRoles: UserRole[];
2127
- allowedWidths: number[];
2128
- /** @format int32 */
2129
- maxPerBoard: number;
2130
- /** @format int32 */
2131
- configVersion: number;
2132
- }
2133
-
2134
- export interface CanvasWidgetView {
2135
- type: CanvasWidgetViewTypeEnum;
2136
- /** @format int32 */
2137
- configVersion: number;
2138
- title?: string | null;
2139
- /** @format int32 */
2140
- width: number;
2141
- config:
2142
- | InformationWidgetConfig
2143
- | KpiWidgetConfig
2144
- | KeyDatesWidgetConfig
2145
- | LoanProgressWidgetConfig
2146
- | MonthlyPaymentWidgetConfig
2147
- | AmortizationWidgetConfig
2148
- | PrimaryBorrowerWidgetConfig
2149
- | OpenTasksWidgetConfig
2150
- | DocumentsWidgetConfig
2151
- | EsignStatusWidgetConfig
2152
- | LoanTeamWidgetConfig
2153
- | TextBlockWidgetConfig
2154
- | SectionDividerWidgetConfig
2155
- | MyTasksWidgetConfig
2156
- | RecentLoansWidgetConfig
2157
- | ClosingSoonWidgetConfig;
2158
- }
2159
-
2160
1831
  export interface ChangePasswordRequest {
2161
1832
  oldPassword: string;
2162
1833
  newPassword: string;
@@ -2191,17 +1862,6 @@ export interface ClosedLoansReportRequest {
2191
1862
  endDate: string;
2192
1863
  }
2193
1864
 
2194
- export type ClosingSoonWidgetConfig = UtilRequiredKeys<
2195
- BaseCanvasWidgetConfig,
2196
- "type"
2197
- > & {
2198
- /** @format int32 */
2199
- withinDays: number;
2200
- /** @format int32 */
2201
- maxItems: number;
2202
- type: ClosingSoonWidgetConfigTypeEnum;
2203
- };
2204
-
2205
1865
  export interface CommentUserInformation {
2206
1866
  entityId: string;
2207
1867
  entityType: string;
@@ -2861,16 +2521,6 @@ export interface DocumentTemplateVersionUpdateRequest {
2861
2521
  htmlBody: string;
2862
2522
  }
2863
2523
 
2864
- export type DocumentsWidgetConfig = UtilRequiredKeys<
2865
- BaseCanvasWidgetConfig,
2866
- "type"
2867
- > & {
2868
- /** @format int32 */
2869
- maxItems: number;
2870
- onlyOutstanding: boolean;
2871
- type: DocumentsWidgetConfigTypeEnum;
2872
- };
2873
-
2874
2524
  export interface Draft {
2875
2525
  /** @format date-time */
2876
2526
  createdAt: string;
@@ -2924,7 +2574,7 @@ export interface DraftLoanOfficerReassignRequest {
2924
2574
 
2925
2575
  export interface DraftRequest {
2926
2576
  applicationPayload: any;
2927
- customData?: any | null;
2577
+ customData: any;
2928
2578
  isCoBorrower: boolean;
2929
2579
  }
2930
2580
 
@@ -3168,7 +2818,7 @@ export interface EncompassRequestLog {
3168
2818
  httpStatusCode?: number | null;
3169
2819
  /** @format int64 */
3170
2820
  durationMs?: number | null;
3171
- context?: any | null;
2821
+ context: any;
3172
2822
  /** @format date-time */
3173
2823
  createdAt: string;
3174
2824
  }
@@ -3196,13 +2846,6 @@ export interface Error {
3196
2846
  message: string;
3197
2847
  }
3198
2848
 
3199
- export type EsignStatusWidgetConfig = UtilRequiredKeys<
3200
- BaseCanvasWidgetConfig,
3201
- "type"
3202
- > & {
3203
- type: EsignStatusWidgetConfigTypeEnum;
3204
- };
3205
-
3206
2849
  export interface FailureBucket {
3207
2850
  /** @format date-time */
3208
2851
  startUtc: string;
@@ -3316,7 +2959,7 @@ export interface FormSubmission {
3316
2959
  subjectPropertyAddressCounty?: string | null;
3317
2960
  subjectPropertyAddressState?: string | null;
3318
2961
  subjectPropertyAddressZip?: string | null;
3319
- data?: any | null;
2962
+ data: any;
3320
2963
  /** @format uuid */
3321
2964
  listingID?: string | null;
3322
2965
  listing?: Listing | null;
@@ -3362,7 +3005,7 @@ export interface FormSubmissionRequest {
3362
3005
  subjectPropertyAddressCounty?: string | null;
3363
3006
  subjectPropertyAddressState?: string | null;
3364
3007
  subjectPropertyAddressZip?: string | null;
3365
- data?: any | null;
3008
+ data: any;
3366
3009
  /** @format uuid */
3367
3010
  listingID?: string | null;
3368
3011
  }
@@ -3511,7 +3154,7 @@ export interface GetWorkflowRequest {
3511
3154
  export interface GuidPatchOperation {
3512
3155
  op: string;
3513
3156
  path: string;
3514
- value?: any | null;
3157
+ value: any;
3515
3158
  from?: string | null;
3516
3159
  }
3517
3160
 
@@ -3589,7 +3232,6 @@ export interface InProgressLoan {
3589
3232
  siteConfigurationId?: string | null;
3590
3233
  /** @format date-time */
3591
3234
  updatedAt?: string | null;
3592
- applicationSession?: LoanApplicationSessionRoute | null;
3593
3235
  }
3594
3236
 
3595
3237
  export interface IncompleteApplicationSummary {
@@ -3626,7 +3268,6 @@ export interface IncompleteLoanBorrower {
3626
3268
  applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
3627
3269
  /** @format date-time */
3628
3270
  deletedAt?: string | null;
3629
- applicationSession?: LoanApplicationSessionRoute | null;
3630
3271
  }
3631
3272
 
3632
3273
  export interface IncompleteLoanDraft {
@@ -3661,19 +3302,6 @@ export interface IncompleteLoanSiteConfiguration {
3661
3302
  name: string;
3662
3303
  }
3663
3304
 
3664
- export type InformationWidgetConfig = UtilRequiredKeys<
3665
- BaseCanvasWidgetConfig,
3666
- "type"
3667
- > & {
3668
- /** @format int32 */
3669
- columns: number;
3670
- labelPosition: InformationWidgetConfigLabelPositionEnum;
3671
- hideWhenEmpty: boolean;
3672
- emptyText?: string | null;
3673
- items: CanvasInformationItem[];
3674
- type: InformationWidgetConfigTypeEnum;
3675
- };
3676
-
3677
3305
  export interface IntegrationSettings {
3678
3306
  encompass?: EncompassIntegrationSettings | null;
3679
3307
  }
@@ -3711,24 +3339,6 @@ export interface Invite {
3711
3339
  /** Array of operations to perform */
3712
3340
  export type JsonPatchDocument = Operation[];
3713
3341
 
3714
- export type KeyDatesWidgetConfig = UtilRequiredKeys<
3715
- BaseCanvasWidgetConfig,
3716
- "type"
3717
- > & {
3718
- dates: string[];
3719
- type: KeyDatesWidgetConfigTypeEnum;
3720
- };
3721
-
3722
- export type KpiWidgetConfig = UtilRequiredKeys<
3723
- BaseCanvasWidgetConfig,
3724
- "type"
3725
- > & {
3726
- field: CanvasFieldRef;
3727
- label?: string | null;
3728
- format?: CanvasFieldFormat | null;
3729
- type: KpiWidgetConfigTypeEnum;
3730
- };
3731
-
3732
3342
  export interface LOSIntegration {
3733
3343
  instanceID: string;
3734
3344
  }
@@ -3974,10 +3584,6 @@ export interface LoanApplicationSessionRequest {
3974
3584
  questionHistory: string[];
3975
3585
  }
3976
3586
 
3977
- export interface LoanApplicationSessionRoute {
3978
- routeName: string;
3979
- }
3980
-
3981
3587
  export interface LoanBorrower {
3982
3588
  /** @format uuid */
3983
3589
  id: string;
@@ -3998,8 +3604,6 @@ export interface LoanBorrower {
3998
3604
  numberOfDependents?: number | null;
3999
3605
  /** @format int32 */
4000
3606
  creditDecisionScore?: number | null;
4001
- /** @format int32 */
4002
- estimatedCreditScore?: number | null;
4003
3607
  isPrimaryBorrower: boolean;
4004
3608
  isFirstTimeHomeBuyer?: boolean | null;
4005
3609
  hasJointAssetsAndLiabilities?: boolean | null;
@@ -4380,12 +3984,6 @@ export interface LoanBorrowerEmploymentPrevious {
4380
3984
  /** @format double */
4381
3985
  grossIncome?: number | null;
4382
3986
  isSelfEmployed?: boolean | null;
4383
- /** @format double */
4384
- bonus?: number | null;
4385
- /** @format double */
4386
- overtime?: number | null;
4387
- /** @format double */
4388
- commission?: number | null;
4389
3987
  address?: AddressV3 | null;
4390
3988
  }
4391
3989
 
@@ -4400,12 +3998,6 @@ export interface LoanBorrowerEmploymentPreviousRequest {
4400
3998
  /** @format double */
4401
3999
  grossIncome?: number | null;
4402
4000
  isSelfEmployed?: boolean | null;
4403
- /** @format double */
4404
- bonus?: number | null;
4405
- /** @format double */
4406
- overtime?: number | null;
4407
- /** @format double */
4408
- commission?: number | null;
4409
4001
  address?: AddressRequest | null;
4410
4002
  }
4411
4003
 
@@ -4618,7 +4210,6 @@ export interface LoanBorrowerRealEstateAsset {
4618
4210
  occupancy?: LoanRealEstateOccupancyType | null;
4619
4211
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
4620
4212
  intendedUsageOtherDescription?: string | null;
4621
- propertyType?: LoanRealEstatePropertyType | null;
4622
4213
  /** @format double */
4623
4214
  marketValue?: number | null;
4624
4215
  /** @format double */
@@ -4679,7 +4270,6 @@ export interface LoanBorrowerRealEstateAssetRequest {
4679
4270
  occupancy?: LoanRealEstateOccupancyType | null;
4680
4271
  intendedUsage?: LoanRealEstateIntendedUsageType | null;
4681
4272
  intendedUsageOtherDescription?: string | null;
4682
- propertyType?: LoanRealEstatePropertyType | null;
4683
4273
  /** @format double */
4684
4274
  marketValue?: number | null;
4685
4275
  /** @format double */
@@ -4715,8 +4305,6 @@ export interface LoanBorrowerRequest {
4715
4305
  isFirstTimeHomeBuyer?: boolean | null;
4716
4306
  hasJointAssetsAndLiabilities?: boolean | null;
4717
4307
  dependentAges?: number[] | null;
4718
- /** @format int32 */
4719
- estimatedCreditScore?: number | null;
4720
4308
  demographics?: LoanBorrowerDemographicsRequest | null;
4721
4309
  declarations?: LoanBorrowerDeclarationsRequest | null;
4722
4310
  militaryService?: LoanBorrowerMilitaryServiceRequest | null;
@@ -5376,13 +4964,6 @@ export interface LoanPatchRequestGuidPatchDocument {
5376
4964
  operations: GuidPatchOperation[];
5377
4965
  }
5378
4966
 
5379
- export type LoanProgressWidgetConfig = UtilRequiredKeys<
5380
- BaseCanvasWidgetConfig,
5381
- "type"
5382
- > & {
5383
- type: LoanProgressWidgetConfigTypeEnum;
5384
- };
5385
-
5386
4967
  export interface LoanProperty {
5387
4968
  /** @format uuid */
5388
4969
  id?: string | null;
@@ -5518,7 +5099,7 @@ export interface LoanQueueWithData {
5518
5099
  user: UserPublic;
5519
5100
  loanOfficer: LoanOfficerPublic;
5520
5101
  siteConfiguration: SiteConfigurationReduced;
5521
- data?: any | null;
5102
+ data: any;
5522
5103
  }
5523
5104
 
5524
5105
  export interface LoanRecommendation {
@@ -5528,7 +5109,7 @@ export interface LoanRecommendation {
5528
5109
  displayName: string;
5529
5110
  extractedValue: string;
5530
5111
  mintable: boolean;
5531
- currentLoanValue?: any | null;
5112
+ currentLoanValue: any;
5532
5113
  /** @format uuid */
5533
5114
  sourceDocumentId: string;
5534
5115
  sourceDocumentName?: string | null;
@@ -5706,13 +5287,6 @@ export interface LoanTaskStatusSummary {
5706
5287
  count: number;
5707
5288
  }
5708
5289
 
5709
- export type LoanTeamWidgetConfig = UtilRequiredKeys<
5710
- BaseCanvasWidgetConfig,
5711
- "type"
5712
- > & {
5713
- type: LoanTeamWidgetConfigTypeEnum;
5714
- };
5715
-
5716
5290
  export interface LoanUser {
5717
5291
  /** @format uuid */
5718
5292
  id: string;
@@ -6110,7 +5684,7 @@ export interface ModuleParameterValue {
6110
5684
  parameterID: string;
6111
5685
  parameterName: string;
6112
5686
  parameterType: string;
6113
- value?: any | null;
5687
+ value: any;
6114
5688
  isInherited: boolean;
6115
5689
  }
6116
5690
 
@@ -6147,24 +5721,6 @@ export interface MonthlyPaymentCalculatorRequest {
6147
5721
  term: number;
6148
5722
  }
6149
5723
 
6150
- export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
6151
- BaseCanvasWidgetConfig,
6152
- "type"
6153
- > & {
6154
- type: MonthlyPaymentWidgetConfigTypeEnum;
6155
- };
6156
-
6157
- export type MyTasksWidgetConfig = UtilRequiredKeys<
6158
- BaseCanvasWidgetConfig,
6159
- "type"
6160
- > & {
6161
- /** @format int32 */
6162
- dueWithinDays: number;
6163
- /** @format int32 */
6164
- maxItems: number;
6165
- type: MyTasksWidgetConfigTypeEnum;
6166
- };
6167
-
6168
5724
  export interface NoContentResult {
6169
5725
  /** @format int32 */
6170
5726
  statusCode: number;
@@ -6312,15 +5868,6 @@ export interface NotificationTemplateVersionUpdateRequest {
6312
5868
  pushNotificationBody?: string | null;
6313
5869
  }
6314
5870
 
6315
- export type OpenTasksWidgetConfig = UtilRequiredKeys<
6316
- BaseCanvasWidgetConfig,
6317
- "type"
6318
- > & {
6319
- /** @format int32 */
6320
- maxItems: number;
6321
- type: OpenTasksWidgetConfigTypeEnum;
6322
- };
6323
-
6324
5871
  export interface Operation {
6325
5872
  op?: string;
6326
5873
  value?: string | number | boolean | null | object;
@@ -6470,18 +6017,6 @@ export interface PreliminaryCondition {
6470
6017
  rerequestedBy?: CommentUserInformation | null;
6471
6018
  }
6472
6019
 
6473
- export interface PreviewSiteConfigurationCanvasRequest {
6474
- document: CanvasDocument;
6475
- role?: UserRole | null;
6476
- }
6477
-
6478
- export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
6479
- BaseCanvasWidgetConfig,
6480
- "type"
6481
- > & {
6482
- type: PrimaryBorrowerWidgetConfigTypeEnum;
6483
- };
6484
-
6485
6020
  export interface ProblemDetails {
6486
6021
  type?: string | null;
6487
6022
  title?: string | null;
@@ -6492,15 +6027,6 @@ export interface ProblemDetails {
6492
6027
  [key: string]: any;
6493
6028
  }
6494
6029
 
6495
- export type RecentLoansWidgetConfig = UtilRequiredKeys<
6496
- BaseCanvasWidgetConfig,
6497
- "type"
6498
- > & {
6499
- /** @format int32 */
6500
- maxItems: number;
6501
- type: RecentLoansWidgetConfigTypeEnum;
6502
- };
6503
-
6504
6030
  export interface RefinanceCalculator {
6505
6031
  currentLoan: RefinanceLoan;
6506
6032
  refinanceLoan: RefinanceLoan;
@@ -6621,17 +6147,6 @@ export interface ResetPasswordRequest {
6621
6147
  password: string;
6622
6148
  }
6623
6149
 
6624
- export interface ResolvedCanvasTab {
6625
- tab: CanvasTab;
6626
- source: CanvasSourceSite;
6627
- isInherited: boolean;
6628
- }
6629
-
6630
- export interface RestoreSiteConfigurationCanvasVersionRequest {
6631
- /** @format int32 */
6632
- expectedVersion: number;
6633
- }
6634
-
6635
6150
  export interface RunLOCalculation {
6636
6151
  loanID: string;
6637
6152
  loanAmount?: string | null;
@@ -6712,28 +6227,10 @@ export interface SSOTokenRequest {
6712
6227
  redirectUri?: string | null;
6713
6228
  }
6714
6229
 
6715
- export interface SaveSiteConfigurationCanvasRequest {
6716
- document: CanvasDocument;
6717
- /** @format int32 */
6718
- expectedVersion?: number | null;
6719
- /** @format uuid */
6720
- forkedFromSiteConfigurationID?: string | null;
6721
- /** @format int32 */
6722
- forkedFromVersion?: number | null;
6723
- }
6724
-
6725
6230
  export interface SearchCriteria {
6726
6231
  searchText?: string | null;
6727
6232
  }
6728
6233
 
6729
- export type SectionDividerWidgetConfig = UtilRequiredKeys<
6730
- BaseCanvasWidgetConfig,
6731
- "type"
6732
- > & {
6733
- label?: string | null;
6734
- type: SectionDividerWidgetConfigTypeEnum;
6735
- };
6736
-
6737
6234
  export interface SendESignatureReminderRequest {
6738
6235
  /** @format uuid */
6739
6236
  userId: string;
@@ -7174,12 +6671,6 @@ export interface SiteConfigurationByUrl {
7174
6671
  workflows: Workflow[];
7175
6672
  }
7176
6673
 
7177
- export interface SiteConfigurationCanvases {
7178
- /** @format uuid */
7179
- siteConfigurationID: string;
7180
- surfaces: CanvasSurfaceState[];
7181
- }
7182
-
7183
6674
  export interface SiteConfigurationForm {
7184
6675
  /** @format date-time */
7185
6676
  createdAt: string;
@@ -7686,14 +7177,6 @@ export interface TemplateTokenRoot {
7686
7177
  fields: TemplateToken[];
7687
7178
  }
7688
7179
 
7689
- export type TextBlockWidgetConfig = UtilRequiredKeys<
7690
- BaseCanvasWidgetConfig,
7691
- "type"
7692
- > & {
7693
- text: string;
7694
- type: TextBlockWidgetConfigTypeEnum;
7695
- };
7696
-
7697
7180
  export interface Theme {
7698
7181
  logoURL: string;
7699
7182
  primaryColor: string;
@@ -7798,8 +7281,6 @@ export interface UnprocessableEntity {
7798
7281
  export interface UnprocessableEntityError {
7799
7282
  error: string;
7800
7283
  property: string;
7801
- code?: string | null;
7802
- params?: Record<string, any> | null;
7803
7284
  }
7804
7285
 
7805
7286
  export interface UnregisteredBorrower {
@@ -7954,10 +7435,6 @@ export interface UpdateLoanRoleTaskRequest {
7954
7435
  dueDate?: string | null;
7955
7436
  }
7956
7437
 
7957
- export interface UpdateLoanSigningMethodRequest {
7958
- signingMethod?: SigningMethod | null;
7959
- }
7960
-
7961
7438
  export interface UpdateMeRequest {
7962
7439
  phone?: string | null;
7963
7440
  firstName: string;
@@ -8530,14 +8007,6 @@ export interface Workflow {
8530
8007
  icon: string;
8531
8008
  }
8532
8009
 
8533
- interface BaseCanvasWidgetConfig {
8534
- type: string;
8535
- }
8536
-
8537
- type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
8538
- type: Key;
8539
- } & Type;
8540
-
8541
8010
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
8542
8011
 
8543
8012
  export type AiAuditLogEventTypeEnum =
@@ -8608,8 +8077,6 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
8608
8077
 
8609
8078
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
8610
8079
 
8611
- export type AmortizationWidgetConfigTypeEnum = "Amortization";
8612
-
8613
8080
  export type AuditLogEntryChangeTypeEnum =
8614
8081
  | "Created"
8615
8082
  | "Modified"
@@ -8650,133 +8117,6 @@ export type BorrowerIdentityRoleEnum =
8650
8117
  | "SettlementAgent"
8651
8118
  | "Admin";
8652
8119
 
8653
- export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
8654
-
8655
- export type CanvasFieldDescriptorDataTypeEnum =
8656
- | "Text"
8657
- | "Number"
8658
- | "Decimal"
8659
- | "Boolean"
8660
- | "Date"
8661
- | "DateTime"
8662
- | "SingleSelect"
8663
- | "MultiSelect";
8664
-
8665
- export type CanvasFieldDescriptorFormatEnum =
8666
- | "Text"
8667
- | "Number"
8668
- | "Currency"
8669
- | "Percent"
8670
- | "DateShort"
8671
- | "DateLong"
8672
- | "YesNo";
8673
-
8674
- export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
8675
-
8676
- export type CanvasFieldValueDataTypeEnum =
8677
- | "Text"
8678
- | "Number"
8679
- | "Decimal"
8680
- | "Boolean"
8681
- | "Date"
8682
- | "DateTime"
8683
- | "SingleSelect"
8684
- | "MultiSelect";
8685
-
8686
- export type CanvasFieldViewDataTypeEnum =
8687
- | "Text"
8688
- | "Number"
8689
- | "Decimal"
8690
- | "Boolean"
8691
- | "Date"
8692
- | "DateTime"
8693
- | "SingleSelect"
8694
- | "MultiSelect";
8695
-
8696
- export type CanvasFieldViewFormatEnum =
8697
- | "Text"
8698
- | "Number"
8699
- | "Currency"
8700
- | "Percent"
8701
- | "DateShort"
8702
- | "DateLong"
8703
- | "YesNo";
8704
-
8705
- export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
8706
-
8707
- export type CanvasSourceSiteTypeEnum =
8708
- | "None"
8709
- | "Account"
8710
- | "Corporate"
8711
- | "Branch"
8712
- | "LoanOfficer"
8713
- | "Partner";
8714
-
8715
- export type CanvasSurfaceStateSurfaceEnum =
8716
- | "Home"
8717
- | "LoanSummary"
8718
- | "LoanDetails";
8719
-
8720
- export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
8721
-
8722
- export type CanvasWidgetTypeEnum =
8723
- | "Information"
8724
- | "Kpi"
8725
- | "KeyDates"
8726
- | "LoanProgress"
8727
- | "MonthlyPayment"
8728
- | "Amortization"
8729
- | "PrimaryBorrower"
8730
- | "OpenTasks"
8731
- | "Documents"
8732
- | "EsignStatus"
8733
- | "LoanTeam"
8734
- | "TextBlock"
8735
- | "SectionDivider"
8736
- | "MyTasks"
8737
- | "RecentLoans"
8738
- | "ClosingSoon";
8739
-
8740
- export type CanvasWidgetTypeDescriptorTypeEnum =
8741
- | "Information"
8742
- | "Kpi"
8743
- | "KeyDates"
8744
- | "LoanProgress"
8745
- | "MonthlyPayment"
8746
- | "Amortization"
8747
- | "PrimaryBorrower"
8748
- | "OpenTasks"
8749
- | "Documents"
8750
- | "EsignStatus"
8751
- | "LoanTeam"
8752
- | "TextBlock"
8753
- | "SectionDivider"
8754
- | "MyTasks"
8755
- | "RecentLoans"
8756
- | "ClosingSoon";
8757
-
8758
- export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
8759
-
8760
- export type CanvasWidgetViewTypeEnum =
8761
- | "Information"
8762
- | "Kpi"
8763
- | "KeyDates"
8764
- | "LoanProgress"
8765
- | "MonthlyPayment"
8766
- | "Amortization"
8767
- | "PrimaryBorrower"
8768
- | "OpenTasks"
8769
- | "Documents"
8770
- | "EsignStatus"
8771
- | "LoanTeam"
8772
- | "TextBlock"
8773
- | "SectionDivider"
8774
- | "MyTasks"
8775
- | "RecentLoans"
8776
- | "ClosingSoon";
8777
-
8778
- export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
8779
-
8780
8120
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
8781
8121
 
8782
8122
  export type CompanyDocumentIndexStatusEnum =
@@ -8949,8 +8289,6 @@ export type CustomFieldValueDataTypeEnum =
8949
8289
  | "SingleSelect"
8950
8290
  | "MultiSelect";
8951
8291
 
8952
- export type DocumentsWidgetConfigTypeEnum = "Documents";
8953
-
8954
8292
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
8955
8293
 
8956
8294
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -8992,8 +8330,6 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
8992
8330
  | "WebDocuments"
8993
8331
  | "PosfCreatePackage";
8994
8332
 
8995
- export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
8996
-
8997
8333
  export type GenerateSystemPromptRequestCategoryEnum =
8998
8334
  | "DocumentAnalysis"
8999
8335
  | "DataQuery"
@@ -9039,14 +8375,6 @@ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
9039
8375
 
9040
8376
  export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
9041
8377
 
9042
- export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
9043
-
9044
- export type InformationWidgetConfigTypeEnum = "Information";
9045
-
9046
- export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
9047
-
9048
- export type KpiWidgetConfigTypeEnum = "Kpi";
9049
-
9050
8378
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
9051
8379
 
9052
8380
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -9152,8 +8480,7 @@ export type LoanLogTypeEnum =
9152
8480
  | "CoBorrowerEmailAutoFixed"
9153
8481
  | "LosFieldWriteBack"
9154
8482
  | "ReferrerChangeDiscarded"
9155
- | "TaskEdited"
9156
- | "SigningMethodChanged";
8483
+ | "TaskEdited";
9157
8484
 
9158
8485
  export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
9159
8486
 
@@ -9178,10 +8505,7 @@ export type LoanLogDetailTypeEnum =
9178
8505
  | "CoBorrowerEmailAutoFixed"
9179
8506
  | "LosFieldWriteBack"
9180
8507
  | "ReferrerChangeDiscarded"
9181
- | "TaskEdited"
9182
- | "SigningMethodChanged";
9183
-
9184
- export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
8508
+ | "TaskEdited";
9185
8509
 
9186
8510
  export type LoanRoleSlotTasksRoleEnum =
9187
8511
  | "Borrower"
@@ -9236,8 +8560,6 @@ export type LoanTaskStatusSummaryStatusEnum =
9236
8560
  | "Rejected"
9237
8561
  | "Unknown";
9238
8562
 
9239
- export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
9240
-
9241
8563
  export type LoanUserLoanRoleEnum =
9242
8564
  | "Borrower"
9243
8565
  | "CoBorrower"
@@ -9369,12 +8691,6 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
9369
8691
  | "AiGeneratedDocument"
9370
8692
  | "Unidentified";
9371
8693
 
9372
- export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
9373
-
9374
- export type MyTasksWidgetConfigTypeEnum = "MyTasks";
9375
-
9376
- export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
9377
-
9378
8694
  export type PendingInviteStatusEnum =
9379
8695
  | "InvitePending"
9380
8696
  | "InviteExpired"
@@ -9395,12 +8711,6 @@ export type PendingInviteRoleEnum =
9395
8711
  | "SettlementAgent"
9396
8712
  | "Admin";
9397
8713
 
9398
- export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
9399
-
9400
- export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
9401
-
9402
- export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
9403
-
9404
8714
  export type SiteConfigurationTypeEnum =
9405
8715
  | "None"
9406
8716
  | "Account"
@@ -9453,8 +8763,6 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
9453
8763
 
9454
8764
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
9455
8765
 
9456
- export type TextBlockWidgetConfigTypeEnum = "TextBlock";
9457
-
9458
8766
  export type UnregisteredBorrowerRoleEnum =
9459
8767
  | "Borrower"
9460
8768
  | "CoBorrower"
@@ -9539,10 +8847,6 @@ export type UserLoanConsentLosSyncStatusEnum =
9539
8847
 
9540
8848
  export type UserTableSettingsTableKeyEnum = "Pipeline";
9541
8849
 
9542
- export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
9543
-
9544
- export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
9545
-
9546
8850
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
9547
8851
 
9548
8852
  /** @default "Realtor" */
@@ -9557,56 +8861,6 @@ export type GetPartnersParamsRoleEnum =
9557
8861
  | "LoanOfficerAssistant"
9558
8862
  | "SystemAdmin";
9559
8863
 
9560
- export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
9561
- | "Home"
9562
- | "LoanSummary"
9563
- | "LoanDetails";
9564
-
9565
- export type SaveSiteConfigurationCanvasParamsEnum =
9566
- | "Home"
9567
- | "LoanSummary"
9568
- | "LoanDetails";
9569
-
9570
- export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
9571
- | "Home"
9572
- | "LoanSummary"
9573
- | "LoanDetails";
9574
-
9575
- export type DeleteSiteConfigurationCanvasParamsEnum =
9576
- | "Home"
9577
- | "LoanSummary"
9578
- | "LoanDetails";
9579
-
9580
- export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
9581
- | "Home"
9582
- | "LoanSummary"
9583
- | "LoanDetails";
9584
-
9585
- export type PreviewSiteConfigurationCanvasParamsEnum =
9586
- | "Home"
9587
- | "LoanSummary"
9588
- | "LoanDetails";
9589
-
9590
- export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
9591
- | "Home"
9592
- | "LoanSummary"
9593
- | "LoanDetails";
9594
-
9595
- export type GetSiteConfigurationCanvasVersionsParamsEnum =
9596
- | "Home"
9597
- | "LoanSummary"
9598
- | "LoanDetails";
9599
-
9600
- export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
9601
- | "Home"
9602
- | "LoanSummary"
9603
- | "LoanDetails";
9604
-
9605
- export type RestoreSiteConfigurationCanvasVersionParamsEnum =
9606
- | "Home"
9607
- | "LoanSummary"
9608
- | "LoanDetails";
9609
-
9610
8864
  export type GetSamlMetadataParamsSSoIntegrationEnum =
9611
8865
  | "ConsumerConnect"
9612
8866
  | "TheBigPOS"
@@ -12504,78 +11758,6 @@ export class Api<
12504
11758
  ...params,
12505
11759
  }),
12506
11760
 
12507
- /**
12508
- * No description
12509
- *
12510
- * @tags Canvases
12511
- * @name GetCanvas
12512
- * @summary Get a site's canvas for one surface, as the signed-in user sees it
12513
- * @request GET:/api/canvases/{surface}
12514
- * @secure
12515
- * @response `200` `CanvasView` OK
12516
- * @response `400` `ProblemDetails` Bad Request
12517
- * @response `404` `ProblemDetails` Not Found
12518
- * @response `422` `ProblemDetails` Unprocessable Content
12519
- */
12520
- getCanvas: (
12521
- surface: GetCanvasParamsEnum,
12522
- query: {
12523
- /** @format uuid */
12524
- siteConfigurationId: string;
12525
- },
12526
- params: RequestParams = {},
12527
- ) =>
12528
- this.request<CanvasView, ProblemDetails>({
12529
- path: `/api/canvases/${surface}`,
12530
- method: "GET",
12531
- query: query,
12532
- secure: true,
12533
- format: "json",
12534
- ...params,
12535
- }),
12536
-
12537
- /**
12538
- * @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.
12539
- *
12540
- * @tags CanvasFields
12541
- * @name GetCanvasFields
12542
- * @summary Get the fields a canvas can show
12543
- * @request GET:/api/canvas/fields
12544
- * @secure
12545
- * @response `200` `CanvasFieldCatalog` OK
12546
- * @response `403` `ProblemDetails` Forbidden
12547
- * @response `404` `ProblemDetails` Not Found
12548
- */
12549
- getCanvasFields: (params: RequestParams = {}) =>
12550
- this.request<CanvasFieldCatalog, ProblemDetails>({
12551
- path: `/api/canvas/fields`,
12552
- method: "GET",
12553
- secure: true,
12554
- format: "json",
12555
- ...params,
12556
- }),
12557
-
12558
- /**
12559
- * No description
12560
- *
12561
- * @tags CanvasWidgetTypes
12562
- * @name GetCanvasWidgetTypes
12563
- * @summary Get canvas widget types
12564
- * @request GET:/api/canvas/widget-types
12565
- * @secure
12566
- * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
12567
- * @response `403` `ProblemDetails` Forbidden
12568
- * @response `404` `ProblemDetails` Not Found
12569
- */
12570
- getCanvasWidgetTypes: (params: RequestParams = {}) =>
12571
- this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
12572
- path: `/api/canvas/widget-types`,
12573
- method: "GET",
12574
- secure: true,
12575
- format: "json",
12576
- ...params,
12577
- }),
12578
-
12579
11761
  /**
12580
11762
  * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
12581
11763
  *
@@ -15920,35 +15102,6 @@ export class Api<
15920
15102
  ...params,
15921
15103
  }),
15922
15104
 
15923
- /**
15924
- * No description
15925
- *
15926
- * @tags LoanCanvasFieldValues
15927
- * @name GetLoanCanvasFieldValues
15928
- * @summary Get a loan's values for canvas fields
15929
- * @request POST:/api/loans/{loanId}/canvas/field-values
15930
- * @secure
15931
- * @response `200` `CanvasFieldValues` OK
15932
- * @response `400` `ProblemDetails` Bad Request
15933
- * @response `403` `ProblemDetails` Forbidden
15934
- * @response `404` `ProblemDetails` Not Found
15935
- * @response `422` `ProblemDetails` Unprocessable Content
15936
- */
15937
- getLoanCanvasFieldValues: (
15938
- loanId: string,
15939
- data: CanvasFieldValuesRequest,
15940
- params: RequestParams = {},
15941
- ) =>
15942
- this.request<CanvasFieldValues, ProblemDetails>({
15943
- path: `/api/loans/${loanId}/canvas/field-values`,
15944
- method: "POST",
15945
- body: data,
15946
- secure: true,
15947
- type: "application/json",
15948
- format: "json",
15949
- ...params,
15950
- }),
15951
-
15952
15105
  /**
15953
15106
  * No description
15954
15107
  *
@@ -18051,33 +17204,6 @@ export class Api<
18051
17204
  ...params,
18052
17205
  }),
18053
17206
 
18054
- /**
18055
- * No description
18056
- *
18057
- * @tags LoanSigningMethod
18058
- * @name UpdateLoanSigningMethod
18059
- * @summary Switch the loan's signing method
18060
- * @request PUT:/api/loans/{loanId}/signing-method
18061
- * @secure
18062
- * @response `204` `void` No Content
18063
- * @response `403` `ProblemDetails` Forbidden
18064
- * @response `404` `ProblemDetails` Not Found
18065
- * @response `422` `ProblemDetails` Unprocessable Content
18066
- */
18067
- updateLoanSigningMethod: (
18068
- loanId: string,
18069
- data: UpdateLoanSigningMethodRequest,
18070
- params: RequestParams = {},
18071
- ) =>
18072
- this.request<void, ProblemDetails>({
18073
- path: `/api/loans/${loanId}/signing-method`,
18074
- method: "PUT",
18075
- body: data,
18076
- secure: true,
18077
- type: "application/json",
18078
- ...params,
18079
- }),
18080
-
18081
17207
  /**
18082
17208
  * No description
18083
17209
  *
@@ -19667,186 +18793,6 @@ export class Api<
19667
18793
  ...params,
19668
18794
  }),
19669
18795
 
19670
- /**
19671
- * No description
19672
- *
19673
- * @tags SiteConfigurationCanvases
19674
- * @name GetSiteConfigurationCanvases
19675
- * @summary Get a site's canvases: own, inherited and effective per surface
19676
- * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
19677
- * @secure
19678
- * @response `200` `SiteConfigurationCanvases` OK
19679
- * @response `403` `ProblemDetails` Forbidden
19680
- * @response `404` `ProblemDetails` Not Found
19681
- */
19682
- getSiteConfigurationCanvases: (
19683
- siteConfigurationId: string,
19684
- params: RequestParams = {},
19685
- ) =>
19686
- this.request<SiteConfigurationCanvases, ProblemDetails>({
19687
- path: `/api/site-configurations/${siteConfigurationId}/canvases`,
19688
- method: "GET",
19689
- secure: true,
19690
- format: "json",
19691
- ...params,
19692
- }),
19693
-
19694
- /**
19695
- * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
19696
- *
19697
- * @tags SiteConfigurationCanvases
19698
- * @name SaveSiteConfigurationCanvas
19699
- * @summary Save a site's canvas for one surface
19700
- * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19701
- * @secure
19702
- * @response `200` `CanvasSurfaceState` OK
19703
- * @response `400` `ProblemDetails` Bad Request
19704
- * @response `403` `ProblemDetails` Forbidden
19705
- * @response `404` `ProblemDetails` Not Found
19706
- * @response `409` `ProblemDetails` Conflict
19707
- * @response `422` `ProblemDetails` Unprocessable Content
19708
- * @response `423` `ProblemDetails` Locked
19709
- */
19710
- saveSiteConfigurationCanvas: (
19711
- siteConfigurationId: string,
19712
- surface: SaveSiteConfigurationCanvasParamsEnum,
19713
- data: SaveSiteConfigurationCanvasRequest,
19714
- params: RequestParams = {},
19715
- ) =>
19716
- this.request<CanvasSurfaceState, ProblemDetails>({
19717
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19718
- method: "PUT",
19719
- body: data,
19720
- secure: true,
19721
- type: "application/json",
19722
- format: "json",
19723
- ...params,
19724
- }),
19725
-
19726
- /**
19727
- * No description
19728
- *
19729
- * @tags SiteConfigurationCanvases
19730
- * @name DeleteSiteConfigurationCanvas
19731
- * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
19732
- * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19733
- * @secure
19734
- * @response `204` `void` No Content
19735
- * @response `400` `ProblemDetails` Bad Request
19736
- * @response `403` `ProblemDetails` Forbidden
19737
- * @response `404` `ProblemDetails` Not Found
19738
- * @response `409` `ProblemDetails` Conflict
19739
- * @response `422` `ProblemDetails` Unprocessable Content
19740
- */
19741
- deleteSiteConfigurationCanvas: (
19742
- siteConfigurationId: string,
19743
- surface: DeleteSiteConfigurationCanvasParamsEnum,
19744
- query: {
19745
- /**
19746
- * The canvas Version the caller last read. A delete over a newer save is refused as stale.
19747
- * @format int32
19748
- */
19749
- expectedVersion: number;
19750
- },
19751
- params: RequestParams = {},
19752
- ) =>
19753
- this.request<void, ProblemDetails>({
19754
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19755
- method: "DELETE",
19756
- query: query,
19757
- secure: true,
19758
- ...params,
19759
- }),
19760
-
19761
- /**
19762
- * No description
19763
- *
19764
- * @tags SiteConfigurationCanvases
19765
- * @name PreviewSiteConfigurationCanvas
19766
- * @summary Preview an unsaved canvas for one surface as a role would see it
19767
- * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
19768
- * @secure
19769
- * @response `200` `CanvasView` OK
19770
- * @response `400` `ProblemDetails` Bad Request
19771
- * @response `403` `ProblemDetails` Forbidden
19772
- * @response `404` `ProblemDetails` Not Found
19773
- * @response `422` `ProblemDetails` Unprocessable Content
19774
- */
19775
- previewSiteConfigurationCanvas: (
19776
- siteConfigurationId: string,
19777
- surface: PreviewSiteConfigurationCanvasParamsEnum,
19778
- data: PreviewSiteConfigurationCanvasRequest,
19779
- params: RequestParams = {},
19780
- ) =>
19781
- this.request<CanvasView, ProblemDetails>({
19782
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
19783
- method: "POST",
19784
- body: data,
19785
- secure: true,
19786
- type: "application/json",
19787
- format: "json",
19788
- ...params,
19789
- }),
19790
-
19791
- /**
19792
- * No description
19793
- *
19794
- * @tags SiteConfigurationCanvases
19795
- * @name GetSiteConfigurationCanvasVersions
19796
- * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
19797
- * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
19798
- * @secure
19799
- * @response `200` `(CanvasVersion)[]` OK
19800
- * @response `403` `ProblemDetails` Forbidden
19801
- * @response `404` `ProblemDetails` Not Found
19802
- * @response `422` `ProblemDetails` Unprocessable Content
19803
- */
19804
- getSiteConfigurationCanvasVersions: (
19805
- siteConfigurationId: string,
19806
- surface: GetSiteConfigurationCanvasVersionsParamsEnum,
19807
- params: RequestParams = {},
19808
- ) =>
19809
- this.request<CanvasVersion[], ProblemDetails>({
19810
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
19811
- method: "GET",
19812
- secure: true,
19813
- format: "json",
19814
- ...params,
19815
- }),
19816
-
19817
- /**
19818
- * No description
19819
- *
19820
- * @tags SiteConfigurationCanvases
19821
- * @name RestoreSiteConfigurationCanvasVersion
19822
- * @summary Restore a saved version of a site's canvas as a new version
19823
- * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
19824
- * @secure
19825
- * @response `200` `CanvasSurfaceState` OK
19826
- * @response `400` `ProblemDetails` Bad Request
19827
- * @response `403` `ProblemDetails` Forbidden
19828
- * @response `404` `ProblemDetails` Not Found
19829
- * @response `409` `ProblemDetails` Conflict
19830
- * @response `422` `ProblemDetails` Unprocessable Content
19831
- * @response `423` `ProblemDetails` Locked
19832
- */
19833
- restoreSiteConfigurationCanvasVersion: (
19834
- siteConfigurationId: string,
19835
- surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
19836
- version: number,
19837
- data: RestoreSiteConfigurationCanvasVersionRequest,
19838
- params: RequestParams = {},
19839
- ) =>
19840
- this.request<CanvasSurfaceState, ProblemDetails>({
19841
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
19842
- method: "POST",
19843
- body: data,
19844
- secure: true,
19845
- type: "application/json",
19846
- format: "json",
19847
- ...params,
19848
- }),
19849
-
19850
18796
  /**
19851
18797
  * No description
19852
18798
  *