@matech/thebigpos-sdk 3.15.0-dev-6028 → 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 =
@@ -563,55 +561,6 @@ export type CompanyDocumentIndexStatus =
563
561
 
564
562
  export type ClassificationSource = "Textract" | "Llm" | "Manual";
565
563
 
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
-
615
564
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
616
565
 
617
566
  export type BranchType = "Mortgage" | "RealEstate";
@@ -752,41 +701,6 @@ export type AddressFamily =
752
701
  | "ControllerAreaNetwork"
753
702
  | "Unknown";
754
703
 
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
-
790
704
  export interface ASOSettings {
791
705
  enabled: boolean;
792
706
  softPull: boolean;
@@ -1129,7 +1043,7 @@ export interface AiAuditLog {
1129
1043
  guardrailCategory?: string | null;
1130
1044
  rawRequest?: string | null;
1131
1045
  rawResponse?: string | null;
1132
- details?: any | null;
1046
+ details: any;
1133
1047
  /** @format date-time */
1134
1048
  createdAt: string;
1135
1049
  }
@@ -1641,13 +1555,6 @@ export interface AmortizationSchedule {
1641
1555
  pmi: number;
1642
1556
  }
1643
1557
 
1644
- export type AmortizationWidgetConfig = UtilRequiredKeys<
1645
- BaseCanvasWidgetConfig,
1646
- "type"
1647
- > & {
1648
- type: AmortizationWidgetConfigTypeEnum;
1649
- };
1650
-
1651
1558
  export interface ApplicationRowData {
1652
1559
  borrowerEmail?: string | null;
1653
1560
  borrowerFirstName?: string | null;
@@ -1723,7 +1630,7 @@ export interface AuditLogEntry {
1723
1630
  rootEntityType?: string | null;
1724
1631
  /** @format uuid */
1725
1632
  rootEntityId?: string | null;
1726
- changes?: any | null;
1633
+ changes: any;
1727
1634
  /** @format date-time */
1728
1635
  createdAt: string;
1729
1636
  }
@@ -1921,227 +1828,6 @@ export interface BusinessRuleRequest {
1921
1828
  applyToAllBorrowerPairs: boolean;
1922
1829
  }
1923
1830
 
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
-
2145
1831
  export interface ChangePasswordRequest {
2146
1832
  oldPassword: string;
2147
1833
  newPassword: string;
@@ -2176,17 +1862,6 @@ export interface ClosedLoansReportRequest {
2176
1862
  endDate: string;
2177
1863
  }
2178
1864
 
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
-
2190
1865
  export interface CommentUserInformation {
2191
1866
  entityId: string;
2192
1867
  entityType: string;
@@ -2846,16 +2521,6 @@ export interface DocumentTemplateVersionUpdateRequest {
2846
2521
  htmlBody: string;
2847
2522
  }
2848
2523
 
2849
- export type DocumentsWidgetConfig = UtilRequiredKeys<
2850
- BaseCanvasWidgetConfig,
2851
- "type"
2852
- > & {
2853
- /** @format int32 */
2854
- maxItems: number;
2855
- onlyOutstanding: boolean;
2856
- type: DocumentsWidgetConfigTypeEnum;
2857
- };
2858
-
2859
2524
  export interface Draft {
2860
2525
  /** @format date-time */
2861
2526
  createdAt: string;
@@ -2909,7 +2574,7 @@ export interface DraftLoanOfficerReassignRequest {
2909
2574
 
2910
2575
  export interface DraftRequest {
2911
2576
  applicationPayload: any;
2912
- customData?: any | null;
2577
+ customData: any;
2913
2578
  isCoBorrower: boolean;
2914
2579
  }
2915
2580
 
@@ -3153,7 +2818,7 @@ export interface EncompassRequestLog {
3153
2818
  httpStatusCode?: number | null;
3154
2819
  /** @format int64 */
3155
2820
  durationMs?: number | null;
3156
- context?: any | null;
2821
+ context: any;
3157
2822
  /** @format date-time */
3158
2823
  createdAt: string;
3159
2824
  }
@@ -3181,13 +2846,6 @@ export interface Error {
3181
2846
  message: string;
3182
2847
  }
3183
2848
 
3184
- export type EsignStatusWidgetConfig = UtilRequiredKeys<
3185
- BaseCanvasWidgetConfig,
3186
- "type"
3187
- > & {
3188
- type: EsignStatusWidgetConfigTypeEnum;
3189
- };
3190
-
3191
2849
  export interface FailureBucket {
3192
2850
  /** @format date-time */
3193
2851
  startUtc: string;
@@ -3301,7 +2959,7 @@ export interface FormSubmission {
3301
2959
  subjectPropertyAddressCounty?: string | null;
3302
2960
  subjectPropertyAddressState?: string | null;
3303
2961
  subjectPropertyAddressZip?: string | null;
3304
- data?: any | null;
2962
+ data: any;
3305
2963
  /** @format uuid */
3306
2964
  listingID?: string | null;
3307
2965
  listing?: Listing | null;
@@ -3347,7 +3005,7 @@ export interface FormSubmissionRequest {
3347
3005
  subjectPropertyAddressCounty?: string | null;
3348
3006
  subjectPropertyAddressState?: string | null;
3349
3007
  subjectPropertyAddressZip?: string | null;
3350
- data?: any | null;
3008
+ data: any;
3351
3009
  /** @format uuid */
3352
3010
  listingID?: string | null;
3353
3011
  }
@@ -3496,7 +3154,7 @@ export interface GetWorkflowRequest {
3496
3154
  export interface GuidPatchOperation {
3497
3155
  op: string;
3498
3156
  path: string;
3499
- value?: any | null;
3157
+ value: any;
3500
3158
  from?: string | null;
3501
3159
  }
3502
3160
 
@@ -3574,7 +3232,6 @@ export interface InProgressLoan {
3574
3232
  siteConfigurationId?: string | null;
3575
3233
  /** @format date-time */
3576
3234
  updatedAt?: string | null;
3577
- applicationSession?: LoanApplicationSessionRoute | null;
3578
3235
  }
3579
3236
 
3580
3237
  export interface IncompleteApplicationSummary {
@@ -3611,7 +3268,6 @@ export interface IncompleteLoanBorrower {
3611
3268
  applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
3612
3269
  /** @format date-time */
3613
3270
  deletedAt?: string | null;
3614
- applicationSession?: LoanApplicationSessionRoute | null;
3615
3271
  }
3616
3272
 
3617
3273
  export interface IncompleteLoanDraft {
@@ -3646,19 +3302,6 @@ export interface IncompleteLoanSiteConfiguration {
3646
3302
  name: string;
3647
3303
  }
3648
3304
 
3649
- export type InformationWidgetConfig = UtilRequiredKeys<
3650
- BaseCanvasWidgetConfig,
3651
- "type"
3652
- > & {
3653
- /** @format int32 */
3654
- columns: number;
3655
- labelPosition: InformationWidgetConfigLabelPositionEnum;
3656
- hideWhenEmpty: boolean;
3657
- emptyText?: string | null;
3658
- items: CanvasInformationItem[];
3659
- type: InformationWidgetConfigTypeEnum;
3660
- };
3661
-
3662
3305
  export interface IntegrationSettings {
3663
3306
  encompass?: EncompassIntegrationSettings | null;
3664
3307
  }
@@ -3696,24 +3339,6 @@ export interface Invite {
3696
3339
  /** Array of operations to perform */
3697
3340
  export type JsonPatchDocument = Operation[];
3698
3341
 
3699
- export type KeyDatesWidgetConfig = UtilRequiredKeys<
3700
- BaseCanvasWidgetConfig,
3701
- "type"
3702
- > & {
3703
- dates: string[];
3704
- type: KeyDatesWidgetConfigTypeEnum;
3705
- };
3706
-
3707
- export type KpiWidgetConfig = UtilRequiredKeys<
3708
- BaseCanvasWidgetConfig,
3709
- "type"
3710
- > & {
3711
- field: CanvasFieldRef;
3712
- label?: string | null;
3713
- format?: CanvasFieldFormat | null;
3714
- type: KpiWidgetConfigTypeEnum;
3715
- };
3716
-
3717
3342
  export interface LOSIntegration {
3718
3343
  instanceID: string;
3719
3344
  }
@@ -3959,10 +3584,6 @@ export interface LoanApplicationSessionRequest {
3959
3584
  questionHistory: string[];
3960
3585
  }
3961
3586
 
3962
- export interface LoanApplicationSessionRoute {
3963
- routeName: string;
3964
- }
3965
-
3966
3587
  export interface LoanBorrower {
3967
3588
  /** @format uuid */
3968
3589
  id: string;
@@ -5343,13 +4964,6 @@ export interface LoanPatchRequestGuidPatchDocument {
5343
4964
  operations: GuidPatchOperation[];
5344
4965
  }
5345
4966
 
5346
- export type LoanProgressWidgetConfig = UtilRequiredKeys<
5347
- BaseCanvasWidgetConfig,
5348
- "type"
5349
- > & {
5350
- type: LoanProgressWidgetConfigTypeEnum;
5351
- };
5352
-
5353
4967
  export interface LoanProperty {
5354
4968
  /** @format uuid */
5355
4969
  id?: string | null;
@@ -5485,7 +5099,7 @@ export interface LoanQueueWithData {
5485
5099
  user: UserPublic;
5486
5100
  loanOfficer: LoanOfficerPublic;
5487
5101
  siteConfiguration: SiteConfigurationReduced;
5488
- data?: any | null;
5102
+ data: any;
5489
5103
  }
5490
5104
 
5491
5105
  export interface LoanRecommendation {
@@ -5495,7 +5109,7 @@ export interface LoanRecommendation {
5495
5109
  displayName: string;
5496
5110
  extractedValue: string;
5497
5111
  mintable: boolean;
5498
- currentLoanValue?: any | null;
5112
+ currentLoanValue: any;
5499
5113
  /** @format uuid */
5500
5114
  sourceDocumentId: string;
5501
5115
  sourceDocumentName?: string | null;
@@ -5673,13 +5287,6 @@ export interface LoanTaskStatusSummary {
5673
5287
  count: number;
5674
5288
  }
5675
5289
 
5676
- export type LoanTeamWidgetConfig = UtilRequiredKeys<
5677
- BaseCanvasWidgetConfig,
5678
- "type"
5679
- > & {
5680
- type: LoanTeamWidgetConfigTypeEnum;
5681
- };
5682
-
5683
5290
  export interface LoanUser {
5684
5291
  /** @format uuid */
5685
5292
  id: string;
@@ -6077,7 +5684,7 @@ export interface ModuleParameterValue {
6077
5684
  parameterID: string;
6078
5685
  parameterName: string;
6079
5686
  parameterType: string;
6080
- value?: any | null;
5687
+ value: any;
6081
5688
  isInherited: boolean;
6082
5689
  }
6083
5690
 
@@ -6114,24 +5721,6 @@ export interface MonthlyPaymentCalculatorRequest {
6114
5721
  term: number;
6115
5722
  }
6116
5723
 
6117
- export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
6118
- BaseCanvasWidgetConfig,
6119
- "type"
6120
- > & {
6121
- type: MonthlyPaymentWidgetConfigTypeEnum;
6122
- };
6123
-
6124
- export type MyTasksWidgetConfig = UtilRequiredKeys<
6125
- BaseCanvasWidgetConfig,
6126
- "type"
6127
- > & {
6128
- /** @format int32 */
6129
- dueWithinDays: number;
6130
- /** @format int32 */
6131
- maxItems: number;
6132
- type: MyTasksWidgetConfigTypeEnum;
6133
- };
6134
-
6135
5724
  export interface NoContentResult {
6136
5725
  /** @format int32 */
6137
5726
  statusCode: number;
@@ -6279,15 +5868,6 @@ export interface NotificationTemplateVersionUpdateRequest {
6279
5868
  pushNotificationBody?: string | null;
6280
5869
  }
6281
5870
 
6282
- export type OpenTasksWidgetConfig = UtilRequiredKeys<
6283
- BaseCanvasWidgetConfig,
6284
- "type"
6285
- > & {
6286
- /** @format int32 */
6287
- maxItems: number;
6288
- type: OpenTasksWidgetConfigTypeEnum;
6289
- };
6290
-
6291
5871
  export interface Operation {
6292
5872
  op?: string;
6293
5873
  value?: string | number | boolean | null | object;
@@ -6437,18 +6017,6 @@ export interface PreliminaryCondition {
6437
6017
  rerequestedBy?: CommentUserInformation | null;
6438
6018
  }
6439
6019
 
6440
- export interface PreviewSiteConfigurationCanvasRequest {
6441
- document: CanvasDocument;
6442
- role?: UserRole | null;
6443
- }
6444
-
6445
- export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
6446
- BaseCanvasWidgetConfig,
6447
- "type"
6448
- > & {
6449
- type: PrimaryBorrowerWidgetConfigTypeEnum;
6450
- };
6451
-
6452
6020
  export interface ProblemDetails {
6453
6021
  type?: string | null;
6454
6022
  title?: string | null;
@@ -6459,15 +6027,6 @@ export interface ProblemDetails {
6459
6027
  [key: string]: any;
6460
6028
  }
6461
6029
 
6462
- export type RecentLoansWidgetConfig = UtilRequiredKeys<
6463
- BaseCanvasWidgetConfig,
6464
- "type"
6465
- > & {
6466
- /** @format int32 */
6467
- maxItems: number;
6468
- type: RecentLoansWidgetConfigTypeEnum;
6469
- };
6470
-
6471
6030
  export interface RefinanceCalculator {
6472
6031
  currentLoan: RefinanceLoan;
6473
6032
  refinanceLoan: RefinanceLoan;
@@ -6588,17 +6147,6 @@ export interface ResetPasswordRequest {
6588
6147
  password: string;
6589
6148
  }
6590
6149
 
6591
- export interface ResolvedCanvasTab {
6592
- tab: CanvasTab;
6593
- source: CanvasSourceSite;
6594
- isInherited: boolean;
6595
- }
6596
-
6597
- export interface RestoreSiteConfigurationCanvasVersionRequest {
6598
- /** @format int32 */
6599
- expectedVersion: number;
6600
- }
6601
-
6602
6150
  export interface RunLOCalculation {
6603
6151
  loanID: string;
6604
6152
  loanAmount?: string | null;
@@ -6679,28 +6227,10 @@ export interface SSOTokenRequest {
6679
6227
  redirectUri?: string | null;
6680
6228
  }
6681
6229
 
6682
- export interface SaveSiteConfigurationCanvasRequest {
6683
- document: CanvasDocument;
6684
- /** @format int32 */
6685
- expectedVersion?: number | null;
6686
- /** @format uuid */
6687
- forkedFromSiteConfigurationID?: string | null;
6688
- /** @format int32 */
6689
- forkedFromVersion?: number | null;
6690
- }
6691
-
6692
6230
  export interface SearchCriteria {
6693
6231
  searchText?: string | null;
6694
6232
  }
6695
6233
 
6696
- export type SectionDividerWidgetConfig = UtilRequiredKeys<
6697
- BaseCanvasWidgetConfig,
6698
- "type"
6699
- > & {
6700
- label?: string | null;
6701
- type: SectionDividerWidgetConfigTypeEnum;
6702
- };
6703
-
6704
6234
  export interface SendESignatureReminderRequest {
6705
6235
  /** @format uuid */
6706
6236
  userId: string;
@@ -7141,12 +6671,6 @@ export interface SiteConfigurationByUrl {
7141
6671
  workflows: Workflow[];
7142
6672
  }
7143
6673
 
7144
- export interface SiteConfigurationCanvases {
7145
- /** @format uuid */
7146
- siteConfigurationID: string;
7147
- surfaces: CanvasSurfaceState[];
7148
- }
7149
-
7150
6674
  export interface SiteConfigurationForm {
7151
6675
  /** @format date-time */
7152
6676
  createdAt: string;
@@ -7653,14 +7177,6 @@ export interface TemplateTokenRoot {
7653
7177
  fields: TemplateToken[];
7654
7178
  }
7655
7179
 
7656
- export type TextBlockWidgetConfig = UtilRequiredKeys<
7657
- BaseCanvasWidgetConfig,
7658
- "type"
7659
- > & {
7660
- text: string;
7661
- type: TextBlockWidgetConfigTypeEnum;
7662
- };
7663
-
7664
7180
  export interface Theme {
7665
7181
  logoURL: string;
7666
7182
  primaryColor: string;
@@ -7765,8 +7281,6 @@ export interface UnprocessableEntity {
7765
7281
  export interface UnprocessableEntityError {
7766
7282
  error: string;
7767
7283
  property: string;
7768
- code?: string | null;
7769
- params?: Record<string, any> | null;
7770
7284
  }
7771
7285
 
7772
7286
  export interface UnregisteredBorrower {
@@ -8493,14 +8007,6 @@ export interface Workflow {
8493
8007
  icon: string;
8494
8008
  }
8495
8009
 
8496
- interface BaseCanvasWidgetConfig {
8497
- type: string;
8498
- }
8499
-
8500
- type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
8501
- type: Key;
8502
- } & Type;
8503
-
8504
8010
  export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
8505
8011
 
8506
8012
  export type AiAuditLogEventTypeEnum =
@@ -8571,8 +8077,6 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
8571
8077
 
8572
8078
  export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
8573
8079
 
8574
- export type AmortizationWidgetConfigTypeEnum = "Amortization";
8575
-
8576
8080
  export type AuditLogEntryChangeTypeEnum =
8577
8081
  | "Created"
8578
8082
  | "Modified"
@@ -8613,133 +8117,6 @@ export type BorrowerIdentityRoleEnum =
8613
8117
  | "SettlementAgent"
8614
8118
  | "Admin";
8615
8119
 
8616
- export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
8617
-
8618
- export type CanvasFieldDescriptorDataTypeEnum =
8619
- | "Text"
8620
- | "Number"
8621
- | "Decimal"
8622
- | "Boolean"
8623
- | "Date"
8624
- | "DateTime"
8625
- | "SingleSelect"
8626
- | "MultiSelect";
8627
-
8628
- export type CanvasFieldDescriptorFormatEnum =
8629
- | "Text"
8630
- | "Number"
8631
- | "Currency"
8632
- | "Percent"
8633
- | "DateShort"
8634
- | "DateLong"
8635
- | "YesNo";
8636
-
8637
- export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
8638
-
8639
- export type CanvasFieldValueDataTypeEnum =
8640
- | "Text"
8641
- | "Number"
8642
- | "Decimal"
8643
- | "Boolean"
8644
- | "Date"
8645
- | "DateTime"
8646
- | "SingleSelect"
8647
- | "MultiSelect";
8648
-
8649
- export type CanvasFieldViewDataTypeEnum =
8650
- | "Text"
8651
- | "Number"
8652
- | "Decimal"
8653
- | "Boolean"
8654
- | "Date"
8655
- | "DateTime"
8656
- | "SingleSelect"
8657
- | "MultiSelect";
8658
-
8659
- export type CanvasFieldViewFormatEnum =
8660
- | "Text"
8661
- | "Number"
8662
- | "Currency"
8663
- | "Percent"
8664
- | "DateShort"
8665
- | "DateLong"
8666
- | "YesNo";
8667
-
8668
- export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
8669
-
8670
- export type CanvasSourceSiteTypeEnum =
8671
- | "None"
8672
- | "Account"
8673
- | "Corporate"
8674
- | "Branch"
8675
- | "LoanOfficer"
8676
- | "Partner";
8677
-
8678
- export type CanvasSurfaceStateSurfaceEnum =
8679
- | "Home"
8680
- | "LoanSummary"
8681
- | "LoanDetails";
8682
-
8683
- export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
8684
-
8685
- export type CanvasWidgetTypeEnum =
8686
- | "Information"
8687
- | "Kpi"
8688
- | "KeyDates"
8689
- | "LoanProgress"
8690
- | "MonthlyPayment"
8691
- | "Amortization"
8692
- | "PrimaryBorrower"
8693
- | "OpenTasks"
8694
- | "Documents"
8695
- | "EsignStatus"
8696
- | "LoanTeam"
8697
- | "TextBlock"
8698
- | "SectionDivider"
8699
- | "MyTasks"
8700
- | "RecentLoans"
8701
- | "ClosingSoon";
8702
-
8703
- export type CanvasWidgetTypeDescriptorTypeEnum =
8704
- | "Information"
8705
- | "Kpi"
8706
- | "KeyDates"
8707
- | "LoanProgress"
8708
- | "MonthlyPayment"
8709
- | "Amortization"
8710
- | "PrimaryBorrower"
8711
- | "OpenTasks"
8712
- | "Documents"
8713
- | "EsignStatus"
8714
- | "LoanTeam"
8715
- | "TextBlock"
8716
- | "SectionDivider"
8717
- | "MyTasks"
8718
- | "RecentLoans"
8719
- | "ClosingSoon";
8720
-
8721
- export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
8722
-
8723
- export type CanvasWidgetViewTypeEnum =
8724
- | "Information"
8725
- | "Kpi"
8726
- | "KeyDates"
8727
- | "LoanProgress"
8728
- | "MonthlyPayment"
8729
- | "Amortization"
8730
- | "PrimaryBorrower"
8731
- | "OpenTasks"
8732
- | "Documents"
8733
- | "EsignStatus"
8734
- | "LoanTeam"
8735
- | "TextBlock"
8736
- | "SectionDivider"
8737
- | "MyTasks"
8738
- | "RecentLoans"
8739
- | "ClosingSoon";
8740
-
8741
- export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
8742
-
8743
8120
  export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
8744
8121
 
8745
8122
  export type CompanyDocumentIndexStatusEnum =
@@ -8912,8 +8289,6 @@ export type CustomFieldValueDataTypeEnum =
8912
8289
  | "SingleSelect"
8913
8290
  | "MultiSelect";
8914
8291
 
8915
- export type DocumentsWidgetConfigTypeEnum = "Documents";
8916
-
8917
8292
  export type DraftTypeEnum = "NewLoan" | "EditLoan";
8918
8293
 
8919
8294
  export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -8955,8 +8330,6 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
8955
8330
  | "WebDocuments"
8956
8331
  | "PosfCreatePackage";
8957
8332
 
8958
- export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
8959
-
8960
8333
  export type GenerateSystemPromptRequestCategoryEnum =
8961
8334
  | "DocumentAnalysis"
8962
8335
  | "DataQuery"
@@ -9002,14 +8375,6 @@ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
9002
8375
 
9003
8376
  export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
9004
8377
 
9005
- export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
9006
-
9007
- export type InformationWidgetConfigTypeEnum = "Information";
9008
-
9009
- export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
9010
-
9011
- export type KpiWidgetConfigTypeEnum = "Kpi";
9012
-
9013
8378
  export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
9014
8379
 
9015
8380
  export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -9142,8 +8507,6 @@ export type LoanLogDetailTypeEnum =
9142
8507
  | "ReferrerChangeDiscarded"
9143
8508
  | "TaskEdited";
9144
8509
 
9145
- export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
9146
-
9147
8510
  export type LoanRoleSlotTasksRoleEnum =
9148
8511
  | "Borrower"
9149
8512
  | "CoBorrower"
@@ -9197,8 +8560,6 @@ export type LoanTaskStatusSummaryStatusEnum =
9197
8560
  | "Rejected"
9198
8561
  | "Unknown";
9199
8562
 
9200
- export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
9201
-
9202
8563
  export type LoanUserLoanRoleEnum =
9203
8564
  | "Borrower"
9204
8565
  | "CoBorrower"
@@ -9330,12 +8691,6 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
9330
8691
  | "AiGeneratedDocument"
9331
8692
  | "Unidentified";
9332
8693
 
9333
- export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
9334
-
9335
- export type MyTasksWidgetConfigTypeEnum = "MyTasks";
9336
-
9337
- export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
9338
-
9339
8694
  export type PendingInviteStatusEnum =
9340
8695
  | "InvitePending"
9341
8696
  | "InviteExpired"
@@ -9356,12 +8711,6 @@ export type PendingInviteRoleEnum =
9356
8711
  | "SettlementAgent"
9357
8712
  | "Admin";
9358
8713
 
9359
- export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
9360
-
9361
- export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
9362
-
9363
- export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
9364
-
9365
8714
  export type SiteConfigurationTypeEnum =
9366
8715
  | "None"
9367
8716
  | "Account"
@@ -9414,8 +8763,6 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
9414
8763
 
9415
8764
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
9416
8765
 
9417
- export type TextBlockWidgetConfigTypeEnum = "TextBlock";
9418
-
9419
8766
  export type UnregisteredBorrowerRoleEnum =
9420
8767
  | "Borrower"
9421
8768
  | "CoBorrower"
@@ -9500,10 +8847,6 @@ export type UserLoanConsentLosSyncStatusEnum =
9500
8847
 
9501
8848
  export type UserTableSettingsTableKeyEnum = "Pipeline";
9502
8849
 
9503
- export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
9504
-
9505
- export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
9506
-
9507
8850
  export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
9508
8851
 
9509
8852
  /** @default "Realtor" */
@@ -9518,56 +8861,6 @@ export type GetPartnersParamsRoleEnum =
9518
8861
  | "LoanOfficerAssistant"
9519
8862
  | "SystemAdmin";
9520
8863
 
9521
- export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
9522
- | "Home"
9523
- | "LoanSummary"
9524
- | "LoanDetails";
9525
-
9526
- export type SaveSiteConfigurationCanvasParamsEnum =
9527
- | "Home"
9528
- | "LoanSummary"
9529
- | "LoanDetails";
9530
-
9531
- export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
9532
- | "Home"
9533
- | "LoanSummary"
9534
- | "LoanDetails";
9535
-
9536
- export type DeleteSiteConfigurationCanvasParamsEnum =
9537
- | "Home"
9538
- | "LoanSummary"
9539
- | "LoanDetails";
9540
-
9541
- export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
9542
- | "Home"
9543
- | "LoanSummary"
9544
- | "LoanDetails";
9545
-
9546
- export type PreviewSiteConfigurationCanvasParamsEnum =
9547
- | "Home"
9548
- | "LoanSummary"
9549
- | "LoanDetails";
9550
-
9551
- export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
9552
- | "Home"
9553
- | "LoanSummary"
9554
- | "LoanDetails";
9555
-
9556
- export type GetSiteConfigurationCanvasVersionsParamsEnum =
9557
- | "Home"
9558
- | "LoanSummary"
9559
- | "LoanDetails";
9560
-
9561
- export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
9562
- | "Home"
9563
- | "LoanSummary"
9564
- | "LoanDetails";
9565
-
9566
- export type RestoreSiteConfigurationCanvasVersionParamsEnum =
9567
- | "Home"
9568
- | "LoanSummary"
9569
- | "LoanDetails";
9570
-
9571
8864
  export type GetSamlMetadataParamsSSoIntegrationEnum =
9572
8865
  | "ConsumerConnect"
9573
8866
  | "TheBigPOS"
@@ -12465,78 +11758,6 @@ export class Api<
12465
11758
  ...params,
12466
11759
  }),
12467
11760
 
12468
- /**
12469
- * No description
12470
- *
12471
- * @tags Canvases
12472
- * @name GetCanvas
12473
- * @summary Get a site's canvas for one surface, as the signed-in user sees it
12474
- * @request GET:/api/canvases/{surface}
12475
- * @secure
12476
- * @response `200` `CanvasView` OK
12477
- * @response `400` `ProblemDetails` Bad Request
12478
- * @response `404` `ProblemDetails` Not Found
12479
- * @response `422` `ProblemDetails` Unprocessable Content
12480
- */
12481
- getCanvas: (
12482
- surface: GetCanvasParamsEnum,
12483
- query: {
12484
- /** @format uuid */
12485
- siteConfigurationId: string;
12486
- },
12487
- params: RequestParams = {},
12488
- ) =>
12489
- this.request<CanvasView, ProblemDetails>({
12490
- path: `/api/canvases/${surface}`,
12491
- method: "GET",
12492
- query: query,
12493
- secure: true,
12494
- format: "json",
12495
- ...params,
12496
- }),
12497
-
12498
- /**
12499
- * @description A standard field's key and every categoryKey never change: saved layouts refer to fields by key, and a client can translate labels and categories by these keys.
12500
- *
12501
- * @tags CanvasFields
12502
- * @name GetCanvasFields
12503
- * @summary Get the fields a canvas can show
12504
- * @request GET:/api/canvas/fields
12505
- * @secure
12506
- * @response `200` `CanvasFieldCatalog` OK
12507
- * @response `403` `ProblemDetails` Forbidden
12508
- * @response `404` `ProblemDetails` Not Found
12509
- */
12510
- getCanvasFields: (params: RequestParams = {}) =>
12511
- this.request<CanvasFieldCatalog, ProblemDetails>({
12512
- path: `/api/canvas/fields`,
12513
- method: "GET",
12514
- secure: true,
12515
- format: "json",
12516
- ...params,
12517
- }),
12518
-
12519
- /**
12520
- * No description
12521
- *
12522
- * @tags CanvasWidgetTypes
12523
- * @name GetCanvasWidgetTypes
12524
- * @summary Get canvas widget types
12525
- * @request GET:/api/canvas/widget-types
12526
- * @secure
12527
- * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
12528
- * @response `403` `ProblemDetails` Forbidden
12529
- * @response `404` `ProblemDetails` Not Found
12530
- */
12531
- getCanvasWidgetTypes: (params: RequestParams = {}) =>
12532
- this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
12533
- path: `/api/canvas/widget-types`,
12534
- method: "GET",
12535
- secure: true,
12536
- format: "json",
12537
- ...params,
12538
- }),
12539
-
12540
11761
  /**
12541
11762
  * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
12542
11763
  *
@@ -15881,35 +15102,6 @@ export class Api<
15881
15102
  ...params,
15882
15103
  }),
15883
15104
 
15884
- /**
15885
- * No description
15886
- *
15887
- * @tags LoanCanvasFieldValues
15888
- * @name GetLoanCanvasFieldValues
15889
- * @summary Get a loan's values for canvas fields
15890
- * @request POST:/api/loans/{loanId}/canvas/field-values
15891
- * @secure
15892
- * @response `200` `CanvasFieldValues` OK
15893
- * @response `400` `ProblemDetails` Bad Request
15894
- * @response `403` `ProblemDetails` Forbidden
15895
- * @response `404` `ProblemDetails` Not Found
15896
- * @response `422` `ProblemDetails` Unprocessable Content
15897
- */
15898
- getLoanCanvasFieldValues: (
15899
- loanId: string,
15900
- data: CanvasFieldValuesRequest,
15901
- params: RequestParams = {},
15902
- ) =>
15903
- this.request<CanvasFieldValues, ProblemDetails>({
15904
- path: `/api/loans/${loanId}/canvas/field-values`,
15905
- method: "POST",
15906
- body: data,
15907
- secure: true,
15908
- type: "application/json",
15909
- format: "json",
15910
- ...params,
15911
- }),
15912
-
15913
15105
  /**
15914
15106
  * No description
15915
15107
  *
@@ -19601,186 +18793,6 @@ export class Api<
19601
18793
  ...params,
19602
18794
  }),
19603
18795
 
19604
- /**
19605
- * No description
19606
- *
19607
- * @tags SiteConfigurationCanvases
19608
- * @name GetSiteConfigurationCanvases
19609
- * @summary Get a site's canvases: own, inherited and effective per surface
19610
- * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
19611
- * @secure
19612
- * @response `200` `SiteConfigurationCanvases` OK
19613
- * @response `403` `ProblemDetails` Forbidden
19614
- * @response `404` `ProblemDetails` Not Found
19615
- */
19616
- getSiteConfigurationCanvases: (
19617
- siteConfigurationId: string,
19618
- params: RequestParams = {},
19619
- ) =>
19620
- this.request<SiteConfigurationCanvases, ProblemDetails>({
19621
- path: `/api/site-configurations/${siteConfigurationId}/canvases`,
19622
- method: "GET",
19623
- secure: true,
19624
- format: "json",
19625
- ...params,
19626
- }),
19627
-
19628
- /**
19629
- * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
19630
- *
19631
- * @tags SiteConfigurationCanvases
19632
- * @name SaveSiteConfigurationCanvas
19633
- * @summary Save a site's canvas for one surface
19634
- * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19635
- * @secure
19636
- * @response `200` `CanvasSurfaceState` OK
19637
- * @response `400` `ProblemDetails` Bad Request
19638
- * @response `403` `ProblemDetails` Forbidden
19639
- * @response `404` `ProblemDetails` Not Found
19640
- * @response `409` `ProblemDetails` Conflict
19641
- * @response `422` `ProblemDetails` Unprocessable Content
19642
- * @response `423` `ProblemDetails` Locked
19643
- */
19644
- saveSiteConfigurationCanvas: (
19645
- siteConfigurationId: string,
19646
- surface: SaveSiteConfigurationCanvasParamsEnum,
19647
- data: SaveSiteConfigurationCanvasRequest,
19648
- params: RequestParams = {},
19649
- ) =>
19650
- this.request<CanvasSurfaceState, ProblemDetails>({
19651
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19652
- method: "PUT",
19653
- body: data,
19654
- secure: true,
19655
- type: "application/json",
19656
- format: "json",
19657
- ...params,
19658
- }),
19659
-
19660
- /**
19661
- * No description
19662
- *
19663
- * @tags SiteConfigurationCanvases
19664
- * @name DeleteSiteConfigurationCanvas
19665
- * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
19666
- * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
19667
- * @secure
19668
- * @response `204` `void` No Content
19669
- * @response `400` `ProblemDetails` Bad Request
19670
- * @response `403` `ProblemDetails` Forbidden
19671
- * @response `404` `ProblemDetails` Not Found
19672
- * @response `409` `ProblemDetails` Conflict
19673
- * @response `422` `ProblemDetails` Unprocessable Content
19674
- */
19675
- deleteSiteConfigurationCanvas: (
19676
- siteConfigurationId: string,
19677
- surface: DeleteSiteConfigurationCanvasParamsEnum,
19678
- query: {
19679
- /**
19680
- * The canvas Version the caller last read. A delete over a newer save is refused as stale.
19681
- * @format int32
19682
- */
19683
- expectedVersion: number;
19684
- },
19685
- params: RequestParams = {},
19686
- ) =>
19687
- this.request<void, ProblemDetails>({
19688
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
19689
- method: "DELETE",
19690
- query: query,
19691
- secure: true,
19692
- ...params,
19693
- }),
19694
-
19695
- /**
19696
- * No description
19697
- *
19698
- * @tags SiteConfigurationCanvases
19699
- * @name PreviewSiteConfigurationCanvas
19700
- * @summary Preview an unsaved canvas for one surface as a role would see it
19701
- * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
19702
- * @secure
19703
- * @response `200` `CanvasView` OK
19704
- * @response `400` `ProblemDetails` Bad Request
19705
- * @response `403` `ProblemDetails` Forbidden
19706
- * @response `404` `ProblemDetails` Not Found
19707
- * @response `422` `ProblemDetails` Unprocessable Content
19708
- */
19709
- previewSiteConfigurationCanvas: (
19710
- siteConfigurationId: string,
19711
- surface: PreviewSiteConfigurationCanvasParamsEnum,
19712
- data: PreviewSiteConfigurationCanvasRequest,
19713
- params: RequestParams = {},
19714
- ) =>
19715
- this.request<CanvasView, ProblemDetails>({
19716
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
19717
- method: "POST",
19718
- body: data,
19719
- secure: true,
19720
- type: "application/json",
19721
- format: "json",
19722
- ...params,
19723
- }),
19724
-
19725
- /**
19726
- * No description
19727
- *
19728
- * @tags SiteConfigurationCanvases
19729
- * @name GetSiteConfigurationCanvasVersions
19730
- * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
19731
- * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
19732
- * @secure
19733
- * @response `200` `(CanvasVersion)[]` OK
19734
- * @response `403` `ProblemDetails` Forbidden
19735
- * @response `404` `ProblemDetails` Not Found
19736
- * @response `422` `ProblemDetails` Unprocessable Content
19737
- */
19738
- getSiteConfigurationCanvasVersions: (
19739
- siteConfigurationId: string,
19740
- surface: GetSiteConfigurationCanvasVersionsParamsEnum,
19741
- params: RequestParams = {},
19742
- ) =>
19743
- this.request<CanvasVersion[], ProblemDetails>({
19744
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
19745
- method: "GET",
19746
- secure: true,
19747
- format: "json",
19748
- ...params,
19749
- }),
19750
-
19751
- /**
19752
- * No description
19753
- *
19754
- * @tags SiteConfigurationCanvases
19755
- * @name RestoreSiteConfigurationCanvasVersion
19756
- * @summary Restore a saved version of a site's canvas as a new version
19757
- * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
19758
- * @secure
19759
- * @response `200` `CanvasSurfaceState` OK
19760
- * @response `400` `ProblemDetails` Bad Request
19761
- * @response `403` `ProblemDetails` Forbidden
19762
- * @response `404` `ProblemDetails` Not Found
19763
- * @response `409` `ProblemDetails` Conflict
19764
- * @response `422` `ProblemDetails` Unprocessable Content
19765
- * @response `423` `ProblemDetails` Locked
19766
- */
19767
- restoreSiteConfigurationCanvasVersion: (
19768
- siteConfigurationId: string,
19769
- surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
19770
- version: number,
19771
- data: RestoreSiteConfigurationCanvasVersionRequest,
19772
- params: RequestParams = {},
19773
- ) =>
19774
- this.request<CanvasSurfaceState, ProblemDetails>({
19775
- path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
19776
- method: "POST",
19777
- body: data,
19778
- secure: true,
19779
- type: "application/json",
19780
- format: "json",
19781
- ...params,
19782
- }),
19783
-
19784
18796
  /**
19785
18797
  * No description
19786
18798
  *