@matech/thebigpos-sdk 3.14.0-pr-5571-5943 → 3.15.0-dev-6023

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
 export type VersionStatusType = "Draft" | "Published";
 export type UserRole = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
 export type TaskType = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
@@ -25,7 +26,6 @@ export type LoanRoleTaskSource = "Rule" | "Manual";
 export type LoanRole = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LoanRefinancePurpose = "CashOutDebtConsolidation" | "CashOutHomeImprovement" | "CashOutOther" | "NoCashOut" | "LimitedCashOut";
 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" | "InvestmentProperty" | "FHASecondaryResidence";
 export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
 export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
@@ -87,6 +87,15 @@ export type ConsentLosSyncStatus = "NotStarted" | "Failed" | "Success";
 export type CompanyDocumentSourceType = "File" | "FreeText";
 export type CompanyDocumentIndexStatus = "Uploaded" | "Indexing" | "Indexed" | "Failed";
 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";
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
@@ -105,6 +114,7 @@ export type AiGuardrailCategory = "ContentSafety" | "PromptInjection" | "Privacy
 export type AiDisplayHint = "Table" | "SummaryCards" | "RankedList" | "Comparison" | "ExecutiveBrief";
 export type AiAuditEventType = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
 export type AddressFamily = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "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;
@@ -423,7 +433,7 @@ export interface AiAuditLog {
     guardrailCategory?: string | null;
     rawRequest?: string | null;
     rawResponse?: string | null;
-    details: any;
+    details?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -895,6 +905,9 @@ export interface AmortizationSchedule {
     /** @format double */
     pmi: number;
 }
+export type AmortizationWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    type: AmortizationWidgetConfigTypeEnum;
+};
 export interface ApplicationRowData {
     borrowerEmail?: string | null;
     borrowerFirstName?: string | null;
@@ -967,7 +980,7 @@ export interface AuditLogEntry {
     rootEntityType?: string | null;
     /** @format uuid */
     rootEntityId?: string | null;
-    changes: any;
+    changes?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -1145,6 +1158,173 @@ export interface BusinessRuleRequest {
     filter: BusinessRuleCondition[];
     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;
@@ -1175,6 +1355,13 @@ export interface ClosedLoansReportRequest {
     /** @format date */
     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;
@@ -1770,6 +1957,12 @@ export interface DocumentTemplateVersionUpdateRequest {
     isActive: boolean;
     htmlBody: string;
 }
+export type DocumentsWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    /** @format int32 */
+    maxItems: number;
+    onlyOutstanding: boolean;
+    type: DocumentsWidgetConfigTypeEnum;
+};
 export interface Draft {
     /** @format date-time */
     createdAt: string;
@@ -1819,7 +2012,7 @@ export interface DraftLoanOfficerReassignRequest {
 }
 export interface DraftRequest {
     applicationPayload: any;
-    customData: any;
+    customData?: any | null;
     isCoBorrower: boolean;
 }
 export interface EconsentPendingSummary {
@@ -2044,7 +2237,7 @@ export interface EncompassRequestLog {
     httpStatusCode?: number | null;
     /** @format int64 */
     durationMs?: number | null;
-    context: any;
+    context?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -2068,6 +2261,9 @@ export interface EncompassWebhookSubscription {
 export interface Error {
     message: string;
 }
+export type EsignStatusWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    type: EsignStatusWidgetConfigTypeEnum;
+};
 export interface FailureBucket {
     /** @format date-time */
     startUtc: string;
@@ -2173,7 +2369,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;
@@ -2215,7 +2411,7 @@ export interface FormSubmissionRequest {
     subjectPropertyAddressCounty?: string | null;
     subjectPropertyAddressState?: string | null;
     subjectPropertyAddressZip?: string | null;
-    data: any;
+    data?: any | null;
     /** @format uuid */
     listingID?: string | null;
 }
@@ -2347,7 +2543,7 @@ export interface GetWorkflowRequest {
 export interface GuidPatchOperation {
     op: string;
     path: string;
-    value: any;
+    value?: any | null;
     from?: string | null;
 }
 export interface HttpError {
@@ -2482,6 +2678,15 @@ export interface IncompleteLoanSiteConfiguration {
     id: string;
     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;
 }
@@ -2516,6 +2721,16 @@ 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;
 }
@@ -2767,8 +2982,6 @@ export interface LoanBorrower {
     numberOfDependents?: number | null;
     /** @format int32 */
     creditDecisionScore?: number | null;
-    /** @format int32 */
-    estimatedCreditScore?: number | null;
     isPrimaryBorrower: boolean;
     isFirstTimeHomeBuyer?: boolean | null;
     hasJointAssetsAndLiabilities?: boolean | null;
@@ -3119,12 +3332,6 @@ 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;
 }
 export interface LoanBorrowerEmploymentPreviousRequest {
@@ -3138,12 +3345,6 @@ 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;
 }
 export interface LoanBorrowerGift {
@@ -3333,7 +3534,6 @@ export interface LoanBorrowerRealEstateAsset {
     occupancy?: LoanRealEstateOccupancyType | null;
     intendedUsage?: LoanRealEstateIntendedUsageType | null;
     intendedUsageOtherDescription?: string | null;
-    propertyType?: LoanRealEstatePropertyType | null;
     /** @format double */
     marketValue?: number | null;
     /** @format double */
@@ -3391,7 +3591,6 @@ export interface LoanBorrowerRealEstateAssetRequest {
     occupancy?: LoanRealEstateOccupancyType | null;
     intendedUsage?: LoanRealEstateIntendedUsageType | null;
     intendedUsageOtherDescription?: string | null;
-    propertyType?: LoanRealEstatePropertyType | null;
     /** @format double */
     marketValue?: number | null;
     /** @format double */
@@ -3426,8 +3625,6 @@ 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;
@@ -4030,6 +4227,9 @@ export interface LoanOutstandingItems {
 export interface LoanPatchRequestGuidPatchDocument {
     operations: GuidPatchOperation[];
 }
+export type LoanProgressWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    type: LoanProgressWidgetConfigTypeEnum;
+};
 export interface LoanProperty {
     /** @format uuid */
     id?: string | null;
@@ -4158,7 +4358,7 @@ export interface LoanQueueWithData {
     user: UserPublic;
     loanOfficer: LoanOfficerPublic;
     siteConfiguration: SiteConfigurationReduced;
-    data: any;
+    data?: any | null;
 }
 export interface LoanRecommendation {
     /** @format uuid */
@@ -4167,7 +4367,7 @@ export interface LoanRecommendation {
     displayName: string;
     extractedValue: string;
     mintable: boolean;
-    currentLoanValue: any;
+    currentLoanValue?: any | null;
     /** @format uuid */
     sourceDocumentId: string;
     sourceDocumentName?: string | null;
@@ -4333,6 +4533,9 @@ export interface LoanTaskStatusSummary {
     /** @format int32 */
     count: number;
 }
+export type LoanTeamWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    type: LoanTeamWidgetConfigTypeEnum;
+};
 export interface LoanUser {
     /** @format uuid */
     id: string;
@@ -4696,7 +4899,7 @@ export interface ModuleParameterValue {
     parameterID: string;
     parameterName: string;
     parameterType: string;
-    value: any;
+    value?: any | null;
     isInherited: boolean;
 }
 export interface MonthlyPaymentCalculator {
@@ -4730,6 +4933,16 @@ export interface MonthlyPaymentCalculatorRequest {
     /** @format int32 */
     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;
@@ -4867,6 +5080,11 @@ export interface NotificationTemplateVersionUpdateRequest {
     textBody?: string | null;
     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;
@@ -5002,6 +5220,13 @@ export interface PreliminaryCondition {
     rerequestedDate?: string | null;
     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;
@@ -5011,6 +5236,11 @@ export interface ProblemDetails {
     instance?: string | null;
     [key: string]: any;
 }
+export type RecentLoansWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    /** @format int32 */
+    maxItems: number;
+    type: RecentLoansWidgetConfigTypeEnum;
+};
 export interface RefinanceCalculator {
     currentLoan: RefinanceLoan;
     refinanceLoan: RefinanceLoan;
@@ -5118,6 +5348,15 @@ export interface ResetPasswordRequest {
     token: string;
     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;
@@ -5194,9 +5433,22 @@ export interface SSOTokenRequest {
     email: string;
     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;
@@ -5625,6 +5877,11 @@ export interface SiteConfigurationByUrl {
     losSettings?: LOSSettings | null;
     workflows: Workflow[];
 }
+export interface SiteConfigurationCanvases {
+    /** @format uuid */
+    siteConfigurationID: string;
+    surfaces: CanvasSurfaceState[];
+}
 export interface SiteConfigurationForm {
     /** @format date-time */
     createdAt: string;
@@ -6100,6 +6357,10 @@ export interface TemplateTokenRoot {
     displayName: string;
     fields: TemplateToken[];
 }
+export type TextBlockWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
+    text: string;
+    type: TextBlockWidgetConfigTypeEnum;
+};
 export interface Theme {
     logoURL: string;
     primaryColor: string;
@@ -6195,6 +6456,8 @@ export interface UnprocessableEntity {
 export interface UnprocessableEntityError {
     error: string;
     property: string;
+    code?: string | null;
+    params?: Record<string, any> | null;
 }
 export interface UnregisteredBorrower {
     /** @format uuid */
@@ -6854,6 +7117,12 @@ export interface Workflow {
     tileSubtitle: string;
     icon: string;
 }
+interface BaseCanvasWidgetConfig {
+    type: string;
+}
+type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
+    type: Key;
+} & Type;
 export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
 export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
 export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
@@ -6862,9 +7131,26 @@ export type AiGuardrailCategoryEnum = "ContentSafety" | "PromptInjection" | "Pri
 export type AiUrlSourceCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
 export type AiUrlSourceScopeEnum = "FullDomain" | "SpecificPath";
 export type AiUrlSourceApprovalStatusEnum = "Pending" | "Approved" | "Rejected";
+export type AmortizationWidgetConfigTypeEnum = "Amortization";
 export type AuditLogEntryChangeTypeEnum = "Created" | "Modified" | "SoftDeleted" | "HardDeleted" | "Restored" | "Deactivated" | "Reactivated" | "Accessed";
 export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "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 = "Uploaded" | "Indexing" | "Indexed" | "Failed";
 export type CompanyDocumentFolderFileSourceTypeEnum = "File" | "FreeText";
@@ -6891,6 +7177,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
 export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
 export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
 export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
+export type DocumentsWidgetConfigTypeEnum = "Documents";
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
 export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
@@ -6900,10 +7187,15 @@ export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "
 export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader" | "Read";
 export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
 export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" | "WebDocuments" | "PosfCreatePackage";
+export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
 export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
 export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
 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";
 export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
@@ -6921,11 +7213,13 @@ export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
 export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
 export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
 export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited";
+export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
 export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LoanRoleTaskTypeEnum = "Document" | "Field" | "Signature" | "EDisclosure" | "EConsent" | "VerificationOfAssets" | "VerificationOfIncome" | "VerificationOfEmployment" | "VerificationOfCredit" | "Payment" | "VerificationOfIncomeAndEmployment" | "VerificationOfTaxes";
 export type LoanRoleTaskSourceEnum = "Rule" | "Manual";
 export type LoanTaskStatusSummaryStatusEnum = "Outstanding" | "Pending" | "Completed" | "Rejected" | "Unknown";
+export type LoanTeamWidgetConfigTypeEnum = "LoanTeam";
 export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type LosCredentialHealthStatusEnum = "Unknown" | "Healthy" | "InvalidCredentials" | "Forbidden" | "TransportError" | "NotConfigured";
 export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
@@ -6939,8 +7233,14 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
 export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
 export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
 export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
+export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
+export type MyTasksWidgetConfigTypeEnum = "MyTasks";
+export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
 export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
 export type PendingInviteRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
+export type PrimaryBorrowerWidgetConfigTypeEnum = "PrimaryBorrower";
+export type RecentLoansWidgetConfigTypeEnum = "RecentLoans";
+export type SectionDividerWidgetConfigTypeEnum = "SectionDivider";
 export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
 export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
@@ -6951,6 +7251,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
 export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
 export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
 export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
+export type TextBlockWidgetConfigTypeEnum = "TextBlock";
 export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
 export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
 export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
@@ -6962,9 +7263,21 @@ export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "Loan
 export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
 export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
 export type UserTableSettingsTableKeyEnum = "Pipeline";
+export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
+export type GetCanvasParamsEnum = "Home" | "LoanSummary" | "LoanDetails";
 export type GetCustomFieldDefinitionsParamsEntityTypeEnum = "Loan";
 /** @default "Realtor" */
 export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "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" | "POSF";
 export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
 export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS" | "POSF";
@@ -7012,7 +7325,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v3.14.0
+ * @version v3.15.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -8522,6 +8835,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `BusinessRule` OK
          */
         restoreBusinessRule: (id: string, params?: RequestParams) => Promise<AxiosResponse<BusinessRule, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasView, any, {}>>;
+        /**
+         * @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) => Promise<AxiosResponse<CanvasFieldCatalog, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasWidgetTypeDescriptor[], any, {}>>;
         /**
          * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
          *
@@ -10343,6 +10699,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `423` `UnprocessableEntity` Locked
          */
         runLoanCalculator: (loanId: string, data: RunLOCalculationRequest, params?: RequestParams) => Promise<AxiosResponse<RunLOCalculation, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasFieldValues, any, {}>>;
         /**
          * No description
          *
@@ -12309,6 +12680,104 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         replacePartnerSiteConfiguration: (realtorId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
             applyToChildren?: boolean;
         }, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<SiteConfigurationCanvases, any, {}>>;
+        /**
+         * @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) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<void, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasView, any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasVersion[], any, {}>>;
+        /**
+         * 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) => Promise<AxiosResponse<CanvasSurfaceState, any, {}>>;
         /**
          * No description
          *
@@ -13651,3 +14120,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         logoutList: (params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
     };
 }
+export {};