@matech/thebigpos-sdk 3.15.0 → 3.16.0

package/src/index.ts

@@ -10,6 +10,8 @@
  * ---------------------------------------------------------------
  */
 
+type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
+
 export type VersionStatusType = "Draft" | "Published";
 
 export type UserRole =
@@ -141,6 +143,20 @@ export type LoanRefinancePurpose =
 
 export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
 
+export type LoanRealEstatePropertyType =
+  | "SingleFamily"
+  | "Condominium"
+  | "Townhouse"
+  | "Cooperative"
+  | "TwoToFourUnitProperty"
+  | "MultifamilyMoreThanFourUnits"
+  | "ManufacturedMobileHome"
+  | "CommercialNonResidential"
+  | "HomeAndBusinessCombined"
+  | "MixedUseResidential"
+  | "Farm"
+  | "Land";
+
 export type LoanRealEstateOccupancyType =
   | "PrimaryHome"
   | "SecondHome"
@@ -292,7 +308,8 @@ export type LoanLogType =
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
   | "ReferrerChangeDiscarded"
-  | "TaskEdited";
+  | "TaskEdited"
+  | "SigningMethodChanged";
 
 export type LoanLienPosition = "First" | "Subordinate";
 
@@ -561,6 +578,55 @@ export type CompanyDocumentIndexStatus =
 
 export type ClassificationSource = "Textract" | "Llm" | "Manual";
 
+export type CanvasWidgetType =
+  | "Information"
+  | "Kpi"
+  | "KeyDates"
+  | "LoanProgress"
+  | "MonthlyPayment"
+  | "Amortization"
+  | "PrimaryBorrower"
+  | "OpenTasks"
+  | "Documents"
+  | "EsignStatus"
+  | "LoanTeam"
+  | "TextBlock"
+  | "SectionDivider"
+  | "MyTasks"
+  | "RecentLoans"
+  | "ClosingSoon";
+
+export type CanvasWidgetScope = "Loan" | "User" | "Any";
+
+export type CanvasSurface = "Home" | "LoanSummary" | "LoanDetails";
+
+export type CanvasLabelPosition = "Left" | "Above";
+
+export type CanvasInformationItemKind = "Field" | "Heading" | "Separator";
+
+export type CanvasFieldSource = "Standard" | "Custom";
+
+export type CanvasFieldFormat =
+  | "Text"
+  | "Number"
+  | "Currency"
+  | "Percent"
+  | "DateShort"
+  | "DateLong"
+  | "YesNo";
+
+export type CanvasFieldDataType =
+  | "Text"
+  | "Number"
+  | "Decimal"
+  | "Boolean"
+  | "Date"
+  | "DateTime"
+  | "SingleSelect"
+  | "MultiSelect";
+
+export type CanvasAudience = "Staff" | "Borrower" | "Partner";
+
 export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
 
 export type BranchType = "Mortgage" | "RealEstate";
@@ -701,6 +767,41 @@ export type AddressFamily =
   | "ControllerAreaNetwork"
   | "Unknown";
 
+export type CanvasWidgetConfig = BaseCanvasWidgetConfig &
+  (
+    | BaseCanvasWidgetConfigTypeMapping<"Information", InformationWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"Kpi", KpiWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"KeyDates", KeyDatesWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<
+        "LoanProgress",
+        LoanProgressWidgetConfig
+      >
+    | BaseCanvasWidgetConfigTypeMapping<
+        "MonthlyPayment",
+        MonthlyPaymentWidgetConfig
+      >
+    | BaseCanvasWidgetConfigTypeMapping<
+        "Amortization",
+        AmortizationWidgetConfig
+      >
+    | BaseCanvasWidgetConfigTypeMapping<
+        "PrimaryBorrower",
+        PrimaryBorrowerWidgetConfig
+      >
+    | BaseCanvasWidgetConfigTypeMapping<"OpenTasks", OpenTasksWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"Documents", DocumentsWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"EsignStatus", EsignStatusWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"LoanTeam", LoanTeamWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"TextBlock", TextBlockWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<
+        "SectionDivider",
+        SectionDividerWidgetConfig
+      >
+    | BaseCanvasWidgetConfigTypeMapping<"MyTasks", MyTasksWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"RecentLoans", RecentLoansWidgetConfig>
+    | BaseCanvasWidgetConfigTypeMapping<"ClosingSoon", ClosingSoonWidgetConfig>
+  );
+
 export interface ASOSettings {
   enabled: boolean;
   softPull: boolean;
@@ -1043,7 +1144,7 @@ export interface AiAuditLog {
   guardrailCategory?: string | null;
   rawRequest?: string | null;
   rawResponse?: string | null;
-  details: any;
+  details?: any | null;
   /** @format date-time */
   createdAt: string;
 }
@@ -1555,6 +1656,13 @@ export interface AmortizationSchedule {
   pmi: number;
 }
 
+export type AmortizationWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: AmortizationWidgetConfigTypeEnum;
+};
+
 export interface ApplicationRowData {
   borrowerEmail?: string | null;
   borrowerFirstName?: string | null;
@@ -1630,7 +1738,7 @@ export interface AuditLogEntry {
   rootEntityType?: string | null;
   /** @format uuid */
   rootEntityId?: string | null;
-  changes: any;
+  changes?: any | null;
   /** @format date-time */
   createdAt: string;
 }
@@ -1828,6 +1936,227 @@ export interface BusinessRuleRequest {
   applyToAllBorrowerPairs: boolean;
 }
 
+export interface CanvasAuthor {
+  /** @format uuid */
+  id: string;
+  firstName: string;
+  lastName: string;
+  email: string;
+}
+
+export interface CanvasBoard {
+  name?: string | null;
+  roles: UserRole[];
+  widgetIds: string[];
+  widgets: Record<string, CanvasWidget>;
+}
+
+export interface CanvasBoardView {
+  widgetIds: string[];
+  widgets: Record<string, CanvasWidgetView>;
+}
+
+export interface CanvasDocument {
+  /** @format int32 */
+  schemaVersion: number;
+  boards?: CanvasBoard[] | null;
+  tabs?: CanvasTab[] | null;
+}
+
+export interface CanvasFieldCatalog {
+  fields: CanvasFieldDescriptor[];
+}
+
+export interface CanvasFieldDescriptor {
+  source: CanvasFieldDescriptorSourceEnum;
+  key: string;
+  label: string;
+  category: string;
+  categoryKey: string;
+  dataType: CanvasFieldDescriptorDataTypeEnum;
+  format: CanvasFieldDescriptorFormatEnum;
+  encompassFieldId?: string | null;
+  readableRoles: UserRole[];
+  isActive: boolean;
+  rolesWithoutPermissionRows: UserRole[];
+  options: string[];
+}
+
+export interface CanvasFieldRef {
+  source: CanvasFieldRefSourceEnum;
+  key: string;
+}
+
+export interface CanvasFieldValue {
+  dataType: CanvasFieldValueDataTypeEnum;
+  value?: any | null;
+}
+
+export interface CanvasFieldValues {
+  standard: Record<string, CanvasFieldValue>;
+  custom: Record<string, CanvasFieldValue>;
+}
+
+export interface CanvasFieldValuesRequest {
+  standardKeys: string[];
+  customFieldIds: string[];
+}
+
+export interface CanvasFieldView {
+  label: string;
+  dataType: CanvasFieldViewDataTypeEnum;
+  format: CanvasFieldViewFormatEnum;
+  options: string[];
+}
+
+export interface CanvasInformationItem {
+  kind: CanvasInformationItemKindEnum;
+  field?: CanvasFieldRef | null;
+  text?: string | null;
+  label?: string | null;
+  format?: CanvasFieldFormat | null;
+  emphasis: boolean;
+  hideWhenEmpty: boolean;
+  roles: UserRole[];
+  /** @format int32 */
+  column: number;
+}
+
+export interface CanvasSourceSite {
+  /** @format uuid */
+  siteConfigurationID: string;
+  name: string;
+  type: CanvasSourceSiteTypeEnum;
+}
+
+export interface CanvasSurfaceState {
+  surface: CanvasSurfaceStateSurfaceEnum;
+  own?: CanvasDocument | null;
+  /** @format int32 */
+  ownVersion?: number | null;
+  isOwnUnreadable: boolean;
+  /** @format date-time */
+  ownUpdatedAt?: string | null;
+  /** @format uuid */
+  forkedFromSiteConfigurationID?: string | null;
+  /** @format int32 */
+  forkedFromVersion?: number | null;
+  inherited?: CanvasDocument | null;
+  /** @format int32 */
+  inheritedVersion?: number | null;
+  inheritedFrom?: CanvasSourceSite | null;
+  isBehindInherited: boolean;
+  effectiveBoards?: CanvasBoard[] | null;
+  effectiveTabs?: ResolvedCanvasTab[] | null;
+}
+
+export interface CanvasTab {
+  key: string;
+  /** @format int32 */
+  version: number;
+  title: string;
+  roles: UserRole[];
+  copiedFrom?: CanvasTabOrigin | null;
+  board: CanvasBoard;
+}
+
+export interface CanvasTabOrigin {
+  /** @format uuid */
+  siteConfigurationID: string;
+  tabKey: string;
+  /** @format int32 */
+  version: number;
+}
+
+export interface CanvasTabView {
+  key: string;
+  title: string;
+  board: CanvasBoardView;
+}
+
+export interface CanvasVersion {
+  /** @format int32 */
+  version: number;
+  /** @format date-time */
+  createdAt: string;
+  createdBy?: CanvasAuthor | null;
+}
+
+export interface CanvasView {
+  surface: CanvasViewSurfaceEnum;
+  isConfigured: boolean;
+  board?: CanvasBoardView | null;
+  tabs?: CanvasTabView[] | null;
+  standardFields: Record<string, CanvasFieldView>;
+  customFields: Record<string, CanvasFieldView>;
+}
+
+export interface CanvasWidget {
+  type: CanvasWidgetTypeEnum;
+  /** @format int32 */
+  configVersion: number;
+  title?: string | null;
+  /** @format int32 */
+  width: number;
+  roles: UserRole[];
+  config:
+    | InformationWidgetConfig
+    | KpiWidgetConfig
+    | KeyDatesWidgetConfig
+    | LoanProgressWidgetConfig
+    | MonthlyPaymentWidgetConfig
+    | AmortizationWidgetConfig
+    | PrimaryBorrowerWidgetConfig
+    | OpenTasksWidgetConfig
+    | DocumentsWidgetConfig
+    | EsignStatusWidgetConfig
+    | LoanTeamWidgetConfig
+    | TextBlockWidgetConfig
+    | SectionDividerWidgetConfig
+    | MyTasksWidgetConfig
+    | RecentLoansWidgetConfig
+    | ClosingSoonWidgetConfig;
+}
+
+export interface CanvasWidgetTypeDescriptor {
+  type: CanvasWidgetTypeDescriptorTypeEnum;
+  scope: CanvasWidgetTypeDescriptorScopeEnum;
+  surfaces: CanvasSurface[];
+  audiences: CanvasAudience[];
+  allowedRoles: UserRole[];
+  allowedWidths: number[];
+  /** @format int32 */
+  maxPerBoard: number;
+  /** @format int32 */
+  configVersion: number;
+}
+
+export interface CanvasWidgetView {
+  type: CanvasWidgetViewTypeEnum;
+  /** @format int32 */
+  configVersion: number;
+  title?: string | null;
+  /** @format int32 */
+  width: number;
+  config:
+    | InformationWidgetConfig
+    | KpiWidgetConfig
+    | KeyDatesWidgetConfig
+    | LoanProgressWidgetConfig
+    | MonthlyPaymentWidgetConfig
+    | AmortizationWidgetConfig
+    | PrimaryBorrowerWidgetConfig
+    | OpenTasksWidgetConfig
+    | DocumentsWidgetConfig
+    | EsignStatusWidgetConfig
+    | LoanTeamWidgetConfig
+    | TextBlockWidgetConfig
+    | SectionDividerWidgetConfig
+    | MyTasksWidgetConfig
+    | RecentLoansWidgetConfig
+    | ClosingSoonWidgetConfig;
+}
+
 export interface ChangePasswordRequest {
   oldPassword: string;
   newPassword: string;
@@ -1862,6 +2191,17 @@ export interface ClosedLoansReportRequest {
   endDate: string;
 }
 
+export type ClosingSoonWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  withinDays: number;
+  /** @format int32 */
+  maxItems: number;
+  type: ClosingSoonWidgetConfigTypeEnum;
+};
+
 export interface CommentUserInformation {
   entityId: string;
   entityType: string;
@@ -2521,6 +2861,16 @@ export interface DocumentTemplateVersionUpdateRequest {
   htmlBody: string;
 }
 
+export type DocumentsWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  maxItems: number;
+  onlyOutstanding: boolean;
+  type: DocumentsWidgetConfigTypeEnum;
+};
+
 export interface Draft {
   /** @format date-time */
   createdAt: string;
@@ -2574,7 +2924,7 @@ export interface DraftLoanOfficerReassignRequest {
 
 export interface DraftRequest {
   applicationPayload: any;
-  customData: any;
+  customData?: any | null;
   isCoBorrower: boolean;
 }
 
@@ -2818,7 +3168,7 @@ export interface EncompassRequestLog {
   httpStatusCode?: number | null;
   /** @format int64 */
   durationMs?: number | null;
-  context: any;
+  context?: any | null;
   /** @format date-time */
   createdAt: string;
 }
@@ -2846,6 +3196,13 @@ export interface Error {
   message: string;
 }
 
+export type EsignStatusWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: EsignStatusWidgetConfigTypeEnum;
+};
+
 export interface FailureBucket {
   /** @format date-time */
   startUtc: string;
@@ -2959,7 +3316,7 @@ export interface FormSubmission {
   subjectPropertyAddressCounty?: string | null;
   subjectPropertyAddressState?: string | null;
   subjectPropertyAddressZip?: string | null;
-  data: any;
+  data?: any | null;
   /** @format uuid */
   listingID?: string | null;
   listing?: Listing | null;
@@ -3005,7 +3362,7 @@ export interface FormSubmissionRequest {
   subjectPropertyAddressCounty?: string | null;
   subjectPropertyAddressState?: string | null;
   subjectPropertyAddressZip?: string | null;
-  data: any;
+  data?: any | null;
   /** @format uuid */
   listingID?: string | null;
 }
@@ -3154,7 +3511,7 @@ export interface GetWorkflowRequest {
 export interface GuidPatchOperation {
   op: string;
   path: string;
-  value: any;
+  value?: any | null;
   from?: string | null;
 }
 
@@ -3232,6 +3589,7 @@ export interface InProgressLoan {
   siteConfigurationId?: string | null;
   /** @format date-time */
   updatedAt?: string | null;
+  applicationSession?: LoanApplicationSessionRoute | null;
 }
 
 export interface IncompleteApplicationSummary {
@@ -3268,6 +3626,7 @@ export interface IncompleteLoanBorrower {
   applicationStatus: IncompleteLoanBorrowerApplicationStatusEnum;
   /** @format date-time */
   deletedAt?: string | null;
+  applicationSession?: LoanApplicationSessionRoute | null;
 }
 
 export interface IncompleteLoanDraft {
@@ -3302,6 +3661,19 @@ export interface IncompleteLoanSiteConfiguration {
   name: string;
 }
 
+export type InformationWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  columns: number;
+  labelPosition: InformationWidgetConfigLabelPositionEnum;
+  hideWhenEmpty: boolean;
+  emptyText?: string | null;
+  items: CanvasInformationItem[];
+  type: InformationWidgetConfigTypeEnum;
+};
+
 export interface IntegrationSettings {
   encompass?: EncompassIntegrationSettings | null;
 }
@@ -3339,6 +3711,24 @@ export interface Invite {
 /** Array of operations to perform */
 export type JsonPatchDocument = Operation[];
 
+export type KeyDatesWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  dates: string[];
+  type: KeyDatesWidgetConfigTypeEnum;
+};
+
+export type KpiWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  field: CanvasFieldRef;
+  label?: string | null;
+  format?: CanvasFieldFormat | null;
+  type: KpiWidgetConfigTypeEnum;
+};
+
 export interface LOSIntegration {
   instanceID: string;
 }
@@ -3584,6 +3974,10 @@ export interface LoanApplicationSessionRequest {
   questionHistory: string[];
 }
 
+export interface LoanApplicationSessionRoute {
+  routeName: string;
+}
+
 export interface LoanBorrower {
   /** @format uuid */
   id: string;
@@ -3604,6 +3998,8 @@ export interface LoanBorrower {
   numberOfDependents?: number | null;
   /** @format int32 */
   creditDecisionScore?: number | null;
+  /** @format int32 */
+  estimatedCreditScore?: number | null;
   isPrimaryBorrower: boolean;
   isFirstTimeHomeBuyer?: boolean | null;
   hasJointAssetsAndLiabilities?: boolean | null;
@@ -3984,6 +4380,12 @@ export interface LoanBorrowerEmploymentPrevious {
   /** @format double */
   grossIncome?: number | null;
   isSelfEmployed?: boolean | null;
+  /** @format double */
+  bonus?: number | null;
+  /** @format double */
+  overtime?: number | null;
+  /** @format double */
+  commission?: number | null;
   address?: AddressV3 | null;
 }
 
@@ -3998,6 +4400,12 @@ export interface LoanBorrowerEmploymentPreviousRequest {
   /** @format double */
   grossIncome?: number | null;
   isSelfEmployed?: boolean | null;
+  /** @format double */
+  bonus?: number | null;
+  /** @format double */
+  overtime?: number | null;
+  /** @format double */
+  commission?: number | null;
   address?: AddressRequest | null;
 }
 
@@ -4210,6 +4618,7 @@ export interface LoanBorrowerRealEstateAsset {
   occupancy?: LoanRealEstateOccupancyType | null;
   intendedUsage?: LoanRealEstateIntendedUsageType | null;
   intendedUsageOtherDescription?: string | null;
+  propertyType?: LoanRealEstatePropertyType | null;
   /** @format double */
   marketValue?: number | null;
   /** @format double */
@@ -4270,6 +4679,7 @@ export interface LoanBorrowerRealEstateAssetRequest {
   occupancy?: LoanRealEstateOccupancyType | null;
   intendedUsage?: LoanRealEstateIntendedUsageType | null;
   intendedUsageOtherDescription?: string | null;
+  propertyType?: LoanRealEstatePropertyType | null;
   /** @format double */
   marketValue?: number | null;
   /** @format double */
@@ -4305,6 +4715,8 @@ export interface LoanBorrowerRequest {
   isFirstTimeHomeBuyer?: boolean | null;
   hasJointAssetsAndLiabilities?: boolean | null;
   dependentAges?: number[] | null;
+  /** @format int32 */
+  estimatedCreditScore?: number | null;
   demographics?: LoanBorrowerDemographicsRequest | null;
   declarations?: LoanBorrowerDeclarationsRequest | null;
   militaryService?: LoanBorrowerMilitaryServiceRequest | null;
@@ -4964,6 +5376,13 @@ export interface LoanPatchRequestGuidPatchDocument {
   operations: GuidPatchOperation[];
 }
 
+export type LoanProgressWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: LoanProgressWidgetConfigTypeEnum;
+};
+
 export interface LoanProperty {
   /** @format uuid */
   id?: string | null;
@@ -5099,7 +5518,7 @@ export interface LoanQueueWithData {
   user: UserPublic;
   loanOfficer: LoanOfficerPublic;
   siteConfiguration: SiteConfigurationReduced;
-  data: any;
+  data?: any | null;
 }
 
 export interface LoanRecommendation {
@@ -5109,7 +5528,7 @@ export interface LoanRecommendation {
   displayName: string;
   extractedValue: string;
   mintable: boolean;
-  currentLoanValue: any;
+  currentLoanValue?: any | null;
   /** @format uuid */
   sourceDocumentId: string;
   sourceDocumentName?: string | null;
@@ -5287,6 +5706,13 @@ export interface LoanTaskStatusSummary {
   count: number;
 }
 
+export type LoanTeamWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: LoanTeamWidgetConfigTypeEnum;
+};
+
 export interface LoanUser {
   /** @format uuid */
   id: string;
@@ -5684,7 +6110,7 @@ export interface ModuleParameterValue {
   parameterID: string;
   parameterName: string;
   parameterType: string;
-  value: any;
+  value?: any | null;
   isInherited: boolean;
 }
 
@@ -5721,6 +6147,24 @@ export interface MonthlyPaymentCalculatorRequest {
   term: number;
 }
 
+export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: MonthlyPaymentWidgetConfigTypeEnum;
+};
+
+export type MyTasksWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  dueWithinDays: number;
+  /** @format int32 */
+  maxItems: number;
+  type: MyTasksWidgetConfigTypeEnum;
+};
+
 export interface NoContentResult {
   /** @format int32 */
   statusCode: number;
@@ -5868,6 +6312,15 @@ export interface NotificationTemplateVersionUpdateRequest {
   pushNotificationBody?: string | null;
 }
 
+export type OpenTasksWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  maxItems: number;
+  type: OpenTasksWidgetConfigTypeEnum;
+};
+
 export interface Operation {
   op?: string;
   value?: string | number | boolean | null | object;
@@ -6017,6 +6470,18 @@ export interface PreliminaryCondition {
   rerequestedBy?: CommentUserInformation | null;
 }
 
+export interface PreviewSiteConfigurationCanvasRequest {
+  document: CanvasDocument;
+  role?: UserRole | null;
+}
+
+export type PrimaryBorrowerWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  type: PrimaryBorrowerWidgetConfigTypeEnum;
+};
+
 export interface ProblemDetails {
   type?: string | null;
   title?: string | null;
@@ -6027,6 +6492,15 @@ export interface ProblemDetails {
   [key: string]: any;
 }
 
+export type RecentLoansWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  /** @format int32 */
+  maxItems: number;
+  type: RecentLoansWidgetConfigTypeEnum;
+};
+
 export interface RefinanceCalculator {
   currentLoan: RefinanceLoan;
   refinanceLoan: RefinanceLoan;
@@ -6147,6 +6621,17 @@ export interface ResetPasswordRequest {
   password: string;
 }
 
+export interface ResolvedCanvasTab {
+  tab: CanvasTab;
+  source: CanvasSourceSite;
+  isInherited: boolean;
+}
+
+export interface RestoreSiteConfigurationCanvasVersionRequest {
+  /** @format int32 */
+  expectedVersion: number;
+}
+
 export interface RunLOCalculation {
   loanID: string;
   loanAmount?: string | null;
@@ -6227,10 +6712,28 @@ export interface SSOTokenRequest {
   redirectUri?: string | null;
 }
 
+export interface SaveSiteConfigurationCanvasRequest {
+  document: CanvasDocument;
+  /** @format int32 */
+  expectedVersion?: number | null;
+  /** @format uuid */
+  forkedFromSiteConfigurationID?: string | null;
+  /** @format int32 */
+  forkedFromVersion?: number | null;
+}
+
 export interface SearchCriteria {
   searchText?: string | null;
 }
 
+export type SectionDividerWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  label?: string | null;
+  type: SectionDividerWidgetConfigTypeEnum;
+};
+
 export interface SendESignatureReminderRequest {
   /** @format uuid */
   userId: string;
@@ -6671,6 +7174,12 @@ export interface SiteConfigurationByUrl {
   workflows: Workflow[];
 }
 
+export interface SiteConfigurationCanvases {
+  /** @format uuid */
+  siteConfigurationID: string;
+  surfaces: CanvasSurfaceState[];
+}
+
 export interface SiteConfigurationForm {
   /** @format date-time */
   createdAt: string;
@@ -7177,6 +7686,14 @@ export interface TemplateTokenRoot {
   fields: TemplateToken[];
 }
 
+export type TextBlockWidgetConfig = UtilRequiredKeys<
+  BaseCanvasWidgetConfig,
+  "type"
+> & {
+  text: string;
+  type: TextBlockWidgetConfigTypeEnum;
+};
+
 export interface Theme {
   logoURL: string;
   primaryColor: string;
@@ -7281,6 +7798,8 @@ export interface UnprocessableEntity {
 export interface UnprocessableEntityError {
   error: string;
   property: string;
+  code?: string | null;
+  params?: Record<string, any> | null;
 }
 
 export interface UnregisteredBorrower {
@@ -7435,6 +7954,10 @@ export interface UpdateLoanRoleTaskRequest {
   dueDate?: string | null;
 }
 
+export interface UpdateLoanSigningMethodRequest {
+  signingMethod?: SigningMethod | null;
+}
+
 export interface UpdateMeRequest {
   phone?: string | null;
   firstName: string;
@@ -8007,6 +8530,14 @@ export interface Workflow {
   icon: string;
 }
 
+interface BaseCanvasWidgetConfig {
+  type: string;
+}
+
+type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
+  type: Key;
+} & Type;
+
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 
 export type AiAuditLogEventTypeEnum =
@@ -8077,6 +8608,8 @@ export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
 
 export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
 
+export type AmortizationWidgetConfigTypeEnum = "Amortization";
+
 export type AuditLogEntryChangeTypeEnum =
   | "Created"
   | "Modified"
@@ -8117,6 +8650,133 @@ export type BorrowerIdentityRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
+export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
+
+export type CanvasFieldDescriptorDataTypeEnum =
+  | "Text"
+  | "Number"
+  | "Decimal"
+  | "Boolean"
+  | "Date"
+  | "DateTime"
+  | "SingleSelect"
+  | "MultiSelect";
+
+export type CanvasFieldDescriptorFormatEnum =
+  | "Text"
+  | "Number"
+  | "Currency"
+  | "Percent"
+  | "DateShort"
+  | "DateLong"
+  | "YesNo";
+
+export type CanvasFieldRefSourceEnum = "Standard" | "Custom";
+
+export type CanvasFieldValueDataTypeEnum =
+  | "Text"
+  | "Number"
+  | "Decimal"
+  | "Boolean"
+  | "Date"
+  | "DateTime"
+  | "SingleSelect"
+  | "MultiSelect";
+
+export type CanvasFieldViewDataTypeEnum =
+  | "Text"
+  | "Number"
+  | "Decimal"
+  | "Boolean"
+  | "Date"
+  | "DateTime"
+  | "SingleSelect"
+  | "MultiSelect";
+
+export type CanvasFieldViewFormatEnum =
+  | "Text"
+  | "Number"
+  | "Currency"
+  | "Percent"
+  | "DateShort"
+  | "DateLong"
+  | "YesNo";
+
+export type CanvasInformationItemKindEnum = "Field" | "Heading" | "Separator";
+
+export type CanvasSourceSiteTypeEnum =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type CanvasSurfaceStateSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type CanvasViewSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
+
+export type CanvasWidgetTypeEnum =
+  | "Information"
+  | "Kpi"
+  | "KeyDates"
+  | "LoanProgress"
+  | "MonthlyPayment"
+  | "Amortization"
+  | "PrimaryBorrower"
+  | "OpenTasks"
+  | "Documents"
+  | "EsignStatus"
+  | "LoanTeam"
+  | "TextBlock"
+  | "SectionDivider"
+  | "MyTasks"
+  | "RecentLoans"
+  | "ClosingSoon";
+
+export type CanvasWidgetTypeDescriptorTypeEnum =
+  | "Information"
+  | "Kpi"
+  | "KeyDates"
+  | "LoanProgress"
+  | "MonthlyPayment"
+  | "Amortization"
+  | "PrimaryBorrower"
+  | "OpenTasks"
+  | "Documents"
+  | "EsignStatus"
+  | "LoanTeam"
+  | "TextBlock"
+  | "SectionDivider"
+  | "MyTasks"
+  | "RecentLoans"
+  | "ClosingSoon";
+
+export type CanvasWidgetTypeDescriptorScopeEnum = "Loan" | "User" | "Any";
+
+export type CanvasWidgetViewTypeEnum =
+  | "Information"
+  | "Kpi"
+  | "KeyDates"
+  | "LoanProgress"
+  | "MonthlyPayment"
+  | "Amortization"
+  | "PrimaryBorrower"
+  | "OpenTasks"
+  | "Documents"
+  | "EsignStatus"
+  | "LoanTeam"
+  | "TextBlock"
+  | "SectionDivider"
+  | "MyTasks"
+  | "RecentLoans"
+  | "ClosingSoon";
+
+export type ClosingSoonWidgetConfigTypeEnum = "ClosingSoon";
+
 export type CompanyDocumentSourceTypeEnum = "File" | "FreeText";
 
 export type CompanyDocumentIndexStatusEnum =
@@ -8289,6 +8949,8 @@ export type CustomFieldValueDataTypeEnum =
   | "SingleSelect"
   | "MultiSelect";
 
+export type DocumentsWidgetConfigTypeEnum = "Documents";
+
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
 
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
@@ -8330,6 +8992,8 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum =
   | "WebDocuments"
   | "PosfCreatePackage";
 
+export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
+
 export type GenerateSystemPromptRequestCategoryEnum =
   | "DocumentAnalysis"
   | "DataQuery"
@@ -8375,6 +9039,14 @@ export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
 
 export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
 
+export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
+
+export type InformationWidgetConfigTypeEnum = "Information";
+
+export type KeyDatesWidgetConfigTypeEnum = "KeyDates";
+
+export type KpiWidgetConfigTypeEnum = "Kpi";
+
 export type LoanSigningMethodEnum = "ConsumerConnect" | "POSF";
 
 export type LoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
@@ -8480,7 +9152,8 @@ export type LoanLogTypeEnum =
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
   | "ReferrerChangeDiscarded"
-  | "TaskEdited";
+  | "TaskEdited"
+  | "SigningMethodChanged";
 
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
 
@@ -8505,7 +9178,10 @@ export type LoanLogDetailTypeEnum =
   | "CoBorrowerEmailAutoFixed"
   | "LosFieldWriteBack"
   | "ReferrerChangeDiscarded"
-  | "TaskEdited";
+  | "TaskEdited"
+  | "SigningMethodChanged";
+
+export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
 
 export type LoanRoleSlotTasksRoleEnum =
   | "Borrower"
@@ -8560,6 +9236,8 @@ export type LoanTaskStatusSummaryStatusEnum =
   | "Rejected"
   | "Unknown";
 
+export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
+
 export type LoanUserLoanRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -8691,6 +9369,12 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
   | "AiGeneratedDocument"
   | "Unidentified";
 
+export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
+
+export type MyTasksWidgetConfigTypeEnum = "MyTasks";
+
+export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
+
 export type PendingInviteStatusEnum =
   | "InvitePending"
   | "InviteExpired"
@@ -8711,6 +9395,12 @@ export type PendingInviteRoleEnum =
   | "SettlementAgent"
   | "Admin";
 
+export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
+
+export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
+
+export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
+
 export type SiteConfigurationTypeEnum =
   | "None"
   | "Account"
@@ -8763,6 +9453,8 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
 
 export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
 
+export type TextBlockWidgetConfigTypeEnum = "TextBlock";
+
 export type UnregisteredBorrowerRoleEnum =
   | "Borrower"
   | "CoBorrower"
@@ -8847,6 +9539,10 @@ export type UserLoanConsentLosSyncStatusEnum =
 
 export type UserTableSettingsTableKeyEnum = "Pipeline";
 
+export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
+
+export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
+
 export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
 
 /** @default "Realtor" */
@@ -8861,6 +9557,56 @@ export type GetPartnersParamsRoleEnum =
   | "LoanOfficerAssistant"
   | "SystemAdmin";
 
+export type SaveSiteConfigurationCanvasParamsSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type SaveSiteConfigurationCanvasParamsEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type DeleteSiteConfigurationCanvasParamsSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type DeleteSiteConfigurationCanvasParamsEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type PreviewSiteConfigurationCanvasParamsSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type PreviewSiteConfigurationCanvasParamsEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type GetSiteConfigurationCanvasVersionsParamsSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type GetSiteConfigurationCanvasVersionsParamsEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type RestoreSiteConfigurationCanvasVersionParamsSurfaceEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
+export type RestoreSiteConfigurationCanvasVersionParamsEnum =
+  | "Home"
+  | "LoanSummary"
+  | "LoanDetails";
+
 export type GetSamlMetadataParamsSSoIntegrationEnum =
   | "ConsumerConnect"
   | "TheBigPOS"
@@ -9069,7 +9815,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v3.15.0
+ * @version v3.16.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -11750,6 +12496,78 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Canvases
+     * @name GetCanvas
+     * @summary Get a site's canvas for one surface, as the signed-in user sees it
+     * @request GET:/api/canvases/{surface}
+     * @secure
+     * @response `200` `CanvasView` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    getCanvas: (
+      surface: GetCanvasParamsEnum,
+      query: {
+        /** @format uuid */
+        siteConfigurationId: string;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasView, ProblemDetails>({
+        path: `/api/canvases/${surface}`,
+        method: "GET",
+        query: query,
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @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.
+     *
+     * @tags CanvasFields
+     * @name GetCanvasFields
+     * @summary Get the fields a canvas can show
+     * @request GET:/api/canvas/fields
+     * @secure
+     * @response `200` `CanvasFieldCatalog` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getCanvasFields: (params: RequestParams = {}) =>
+      this.request<CanvasFieldCatalog, ProblemDetails>({
+        path: `/api/canvas/fields`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags CanvasWidgetTypes
+     * @name GetCanvasWidgetTypes
+     * @summary Get canvas widget types
+     * @request GET:/api/canvas/widget-types
+     * @secure
+     * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getCanvasWidgetTypes: (params: RequestParams = {}) =>
+      this.request<CanvasWidgetTypeDescriptor[], ProblemDetails>({
+        path: `/api/canvas/widget-types`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
      *
@@ -15094,6 +15912,35 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanCanvasFieldValues
+     * @name GetLoanCanvasFieldValues
+     * @summary Get a loan's values for canvas fields
+     * @request POST:/api/loans/{loanId}/canvas/field-values
+     * @secure
+     * @response `200` `CanvasFieldValues` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    getLoanCanvasFieldValues: (
+      loanId: string,
+      data: CanvasFieldValuesRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasFieldValues, ProblemDetails>({
+        path: `/api/loans/${loanId}/canvas/field-values`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -17196,6 +18043,33 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags LoanSigningMethod
+     * @name UpdateLoanSigningMethod
+     * @summary Switch the loan's signing method
+     * @request PUT:/api/loans/{loanId}/signing-method
+     * @secure
+     * @response `204` `void` No Content
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    updateLoanSigningMethod: (
+      loanId: string,
+      data: UpdateLoanSigningMethodRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/loans/${loanId}/signing-method`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -18785,6 +19659,186 @@ export class Api<
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags SiteConfigurationCanvases
+     * @name GetSiteConfigurationCanvases
+     * @summary Get a site's canvases: own, inherited and effective per surface
+     * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
+     * @secure
+     * @response `200` `SiteConfigurationCanvases` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     */
+    getSiteConfigurationCanvases: (
+      siteConfigurationId: string,
+      params: RequestParams = {},
+    ) =>
+      this.request<SiteConfigurationCanvases, ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
+     *
+     * @tags SiteConfigurationCanvases
+     * @name SaveSiteConfigurationCanvas
+     * @summary Save a site's canvas for one surface
+     * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
+     * @secure
+     * @response `200` `CanvasSurfaceState` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     * @response `423` `ProblemDetails` Locked
+     */
+    saveSiteConfigurationCanvas: (
+      siteConfigurationId: string,
+      surface: SaveSiteConfigurationCanvasParamsEnum,
+      data: SaveSiteConfigurationCanvasRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasSurfaceState, ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags SiteConfigurationCanvases
+     * @name DeleteSiteConfigurationCanvas
+     * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
+     * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
+     * @secure
+     * @response `204` `void` No Content
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    deleteSiteConfigurationCanvas: (
+      siteConfigurationId: string,
+      surface: DeleteSiteConfigurationCanvasParamsEnum,
+      query: {
+        /**
+         * The canvas Version the caller last read. A delete over a newer save is refused as stale.
+         * @format int32
+         */
+        expectedVersion: number;
+      },
+      params: RequestParams = {},
+    ) =>
+      this.request<void, ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`,
+        method: "DELETE",
+        query: query,
+        secure: true,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags SiteConfigurationCanvases
+     * @name PreviewSiteConfigurationCanvas
+     * @summary Preview an unsaved canvas for one surface as a role would see it
+     * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
+     * @secure
+     * @response `200` `CanvasView` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    previewSiteConfigurationCanvas: (
+      siteConfigurationId: string,
+      surface: PreviewSiteConfigurationCanvasParamsEnum,
+      data: PreviewSiteConfigurationCanvasRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasView, ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags SiteConfigurationCanvases
+     * @name GetSiteConfigurationCanvasVersions
+     * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
+     * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
+     * @secure
+     * @response `200` `(CanvasVersion)[]` OK
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `422` `ProblemDetails` Unprocessable Content
+     */
+    getSiteConfigurationCanvasVersions: (
+      siteConfigurationId: string,
+      surface: GetSiteConfigurationCanvasVersionsParamsEnum,
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasVersion[], ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags SiteConfigurationCanvases
+     * @name RestoreSiteConfigurationCanvasVersion
+     * @summary Restore a saved version of a site's canvas as a new version
+     * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
+     * @secure
+     * @response `200` `CanvasSurfaceState` OK
+     * @response `400` `ProblemDetails` Bad Request
+     * @response `403` `ProblemDetails` Forbidden
+     * @response `404` `ProblemDetails` Not Found
+     * @response `409` `ProblemDetails` Conflict
+     * @response `422` `ProblemDetails` Unprocessable Content
+     * @response `423` `ProblemDetails` Locked
+     */
+    restoreSiteConfigurationCanvasVersion: (
+      siteConfigurationId: string,
+      surface: RestoreSiteConfigurationCanvasVersionParamsEnum,
+      version: number,
+      data: RestoreSiteConfigurationCanvasVersionRequest,
+      params: RequestParams = {},
+    ) =>
+      this.request<CanvasSurfaceState, ProblemDetails>({
+        path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`,
+        method: "POST",
+        body: data,
+        secure: true,
+        type: "application/json",
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *