@matech/thebigpos-sdk 2.12.1 → 2.14.0-rc1

package/dist/index.d.ts

@@ -37,7 +37,7 @@ export interface Account {
     /** @format int32 */
     allowedLoginsWithoutMFA: number;
     losSettings: LOSSettings;
-    asoSettings: ASOSettings;
+    asoSettings?: ASOSettings | null;
 }
 export interface Action {
     /** @format uuid */
@@ -102,7 +102,7 @@ export interface AdminAccessGetForms {
     slug?: string | null;
     status: string;
     language?: string | null;
-    borrowerType: BorrowerType;
+    borrowerType?: BorrowerType | null;
     showProgressBar: boolean;
 }
 export interface AdminAccessUser {
@@ -191,11 +191,11 @@ export interface ApplicationRowData {
     subjectPropertyState?: string | null;
     subjectPropertyZip?: string | null;
     loanPurpose?: string | null;
-    buyerAgent: LoanContact;
-    sellerAgent: LoanContact;
-    settlementAgent: LoanContact;
-    escrowAgent: LoanContact;
-    titleInsuranceAgent: LoanContact;
+    buyerAgent?: LoanContact | null;
+    sellerAgent?: LoanContact | null;
+    settlementAgent?: LoanContact | null;
+    escrowAgent?: LoanContact | null;
+    titleInsuranceAgent?: LoanContact | null;
 }
 export interface Attachment {
     fileName: string;
@@ -255,7 +255,7 @@ export interface BranchUserPaginated {
 }
 export interface BusinessRule {
     /** @format date-time */
-    createdAt?: string | null;
+    createdAt: string;
     /** @format date-time */
     updatedAt?: string | null;
     /** @format date-time */
@@ -431,7 +431,7 @@ export interface CreateInviteRequest {
     /** @format email */
     emailAddress: string;
     phoneNumber: string;
-    relationship: BorrowerRelationship;
+    relationship: "NotApplicable" | "Spouse" | "NonSpouse";
     loanID: string;
     route?: string | null;
     /** @format uuid */
@@ -478,7 +478,7 @@ export interface CreateUserRequest {
     userRole: string;
 }
 export interface CustomLoanData {
-    eConsentInformation: EConsentInformation;
+    eConsentInformation?: EConsentInformation | null;
 }
 export interface DetailedUser {
     /** @format date-time */
@@ -555,7 +555,7 @@ export interface DeviceMDM {
     platform_type_id?: string | null;
     device_capacity?: string | null;
     imei: string[];
-    user: MdmUser;
+    user?: MdmUser | null;
     actions?: DeviceAction[] | null;
 }
 export interface DevicePaginated {
@@ -688,6 +688,8 @@ export interface Draft {
     id: string;
     customData: any;
     user: UserBase;
+    loanOfficer: UserBase;
+    siteConfiguration: SiteConfigurationReduced;
 }
 export interface DraftContent {
     /** @format date-time */
@@ -700,6 +702,8 @@ export interface DraftContent {
     id: string;
     customData: any;
     user: UserBase;
+    loanOfficer: UserBase;
+    siteConfiguration: SiteConfigurationReduced;
     applicationPayload: any;
 }
 export interface DraftContentPaginated {
@@ -711,6 +715,8 @@ export interface DraftContentPaginated {
 export interface DraftRequest {
     applicationPayload: any;
     customData?: any;
+    /** @format uuid */
+    loanOfficerID?: string | null;
 }
 export interface EConsentInformation {
     status: string;
@@ -803,19 +809,19 @@ export interface ExtendedLoan {
     loanProgram?: string | null;
     loanType?: string | null;
     status?: string | null;
-    loanOfficer: LoanOfficer;
-    propertyAddress: Address;
-    borrowerContact: Contact;
-    coBorrowerContact: Contact;
+    loanOfficer?: LoanOfficer | null;
+    propertyAddress?: Address | null;
+    borrowerContact?: Contact | null;
+    coBorrowerContact?: Contact | null;
     loanLogs: LoanLog[];
     isLocked: boolean;
     source?: string | null;
-    buyerAgentContact: Contact;
-    sellerAgentContact: Contact;
-    escrowAgentContact: Contact;
-    titleInsuranceAgentContact: Contact;
-    settlementAgentContact: Contact;
-    loanProcessorContact: Contact;
+    buyerAgentContact?: Contact | null;
+    sellerAgentContact?: Contact | null;
+    escrowAgentContact?: Contact | null;
+    titleInsuranceAgentContact?: Contact | null;
+    settlementAgentContact?: Contact | null;
+    loanProcessorContact?: Contact | null;
 }
 export interface ExtendedLoanPaginated {
     rows: ExtendedLoan[];
@@ -829,8 +835,8 @@ export interface File {
     fileName: string;
     name: string;
     s3FilePath: string;
-    user: User;
-    account: Account;
+    user?: User | null;
+    account?: Account | null;
     url: string;
 }
 export interface FilePaginated {
@@ -871,7 +877,7 @@ export interface FormRequest {
     slug?: string | null;
     status: string;
     language?: string | null;
-    borrowerType: BorrowerType;
+    borrowerType?: BorrowerType | null;
     showProgressBar: boolean;
 }
 export interface FormSubmission {
@@ -896,10 +902,10 @@ export interface FormSubmission {
     loanOfficerEmail?: string | null;
     /** @format uuid */
     loanOfficerID?: string | null;
-    loanOfficer: User;
+    loanOfficer?: User | null;
     /** @format uuid */
     branchID?: string | null;
-    branch: GetBranch;
+    branch?: GetBranch | null;
     status: string;
     subjectPropertyAddressStreet?: string | null;
     subjectPropertyAddressCity?: string | null;
@@ -909,7 +915,7 @@ export interface FormSubmission {
     data?: any;
     /** @format uuid */
     listingID?: string | null;
-    listing: Listing;
+    listing?: Listing | null;
     files: FormSubmissionFile[];
 }
 export interface FormSubmissionFile {
@@ -992,7 +998,7 @@ export interface FusionFieldDisplay {
     fieldValue: string;
 }
 export interface FusionReportFilter {
-    filterType: FilterType;
+    filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
     targetField: string;
     targetValue: string;
 }
@@ -1050,7 +1056,7 @@ export interface GetForm {
     slug?: string | null;
     status: string;
     language?: string | null;
-    borrowerType: BorrowerType;
+    borrowerType?: BorrowerType | null;
     showProgressBar: boolean;
     /** @format uuid */
     id: string;
@@ -1168,6 +1174,7 @@ export interface LOSSettingsUpdateRequest {
     customEConsentBucketTitle?: string | null;
     loanMilestoneNotificationsEnabled: boolean;
 }
+export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently";
 export interface Listing {
     /** @format date-time */
     createdAt: string;
@@ -1179,7 +1186,7 @@ export interface Listing {
     id: string;
     description?: string | null;
     mlsNumber?: string | null;
-    address: Address;
+    address?: Address | null;
     /** @format int32 */
     salePrice?: number | null;
     /** @format date-time */
@@ -1189,7 +1196,7 @@ export interface Listing {
     zillowURL?: string | null;
     photos: ListingPhoto[];
     files: ListingFile[];
-    backgroundImage: File;
+    backgroundImage?: File | null;
     /** @format date-time */
     openHouseDate?: string | null;
     /** @format double */
@@ -1199,7 +1206,7 @@ export interface Listing {
     isActive: boolean;
     slug: string;
     url?: string | null;
-    loanOfficer: LoanOfficer;
+    loanOfficer?: LoanOfficer | null;
     siteConfiguration: SiteConfiguration;
 }
 export interface ListingFile {
@@ -1290,10 +1297,10 @@ export interface Loan {
     loanProgram?: string | null;
     loanType?: string | null;
     status?: string | null;
-    loanOfficer: LoanOfficer;
-    propertyAddress: Address;
-    borrowerContact: Contact;
-    coBorrowerContact: Contact;
+    loanOfficer?: LoanOfficer | null;
+    propertyAddress?: Address | null;
+    borrowerContact?: Contact | null;
+    coBorrowerContact?: Contact | null;
     loanLogs: LoanLog[];
     isLocked: boolean;
     source?: string | null;
@@ -1351,7 +1358,7 @@ export interface LoanDocument {
     id: string;
     name: string;
     loan: Loan;
-    user: User;
+    user?: User | null;
     initialBucket?: string | null;
     losDocumentID?: string | null;
     losStatus: string;
@@ -1362,6 +1369,9 @@ export interface LoanDraftSearchCriteria {
     searchText?: string | null;
     /** @format uuid */
     loanOfficerId?: string | null;
+    /** @format uuid */
+    siteConfigurationId?: string | null;
+    isUnassigned?: boolean | null;
 }
 export interface LoanLog {
     /** @format uuid */
@@ -1382,6 +1392,15 @@ export interface LoanOfficer {
     profilePhotoUrl: string;
     siteConfiguration: SiteConfiguration;
 }
+export interface LoanOfficerPublic {
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string | null;
+    /** @format uuid */
+    corporateID?: string | null;
+    siteConfigurationIDs: string[];
+}
 export interface LoanOfficerSearchCriteria {
     searchText?: string | null;
     isActive?: boolean | null;
@@ -1390,6 +1409,40 @@ export interface LoanOfficerSearchCriteria {
     /** @format uuid */
     brand?: string | null;
 }
+export interface LoanQueue {
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt?: string | null;
+    /** @format date-time */
+    deletedAt?: string | null;
+    /** @format uuid */
+    id: string;
+    loanID?: string | null;
+    type: string;
+    reason: string;
+    status: string;
+    details?: string | null;
+    user: UserPublic;
+    loanOfficer: LoanOfficerPublic;
+    siteConfiguration: SiteConfigurationReduced;
+}
+export interface LoanQueuePaginated {
+    rows: LoanQueue[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
+export interface LoanQueueSearchCriteria {
+    searchText?: string | null;
+    loanID?: string | null;
+    isActive?: boolean | null;
+    type?: LoanQueueType | null;
+    status?: LOSStatus | null;
+    reason?: LoanQueueReason | null;
+}
+export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "Document";
 export interface LoanRecord {
     loanGuid: string;
     loanFields: Record<string, string>;
@@ -1474,30 +1527,6 @@ export interface ModuleParameterValue {
     value?: any;
     isInherited: boolean;
 }
-export interface NotificationLog {
-    /** @format uuid */
-    id: string;
-    type: NotificationType;
-    to: string;
-    cc?: string | null;
-    subject?: string | null;
-    message: string;
-    notificationTemplate: NotificationTemplate;
-    /** @format date-time */
-    createdAt: string;
-}
-export interface NotificationLogPaginated {
-    rows: NotificationLog[];
-    pagination: Pagination;
-    /** @format int64 */
-    count: number;
-}
-export interface NotificationLogSearchCriteria {
-    searchText?: string | null;
-    type: NotificationType;
-    to?: string[] | null;
-    cc?: string[] | null;
-}
 export interface NotificationTemplate {
     /** @format date-time */
     createdAt?: string | null;
@@ -1577,6 +1606,7 @@ export interface NotificationTemplateVersion {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
     notificationTemplate: NotificationTemplate;
 }
 export interface NotificationTemplateVersionBase {
@@ -1594,6 +1624,7 @@ export interface NotificationTemplateVersionBase {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
 }
 export interface NotificationTemplateVersionRequest {
     /** @maxLength 255 */
@@ -1614,7 +1645,6 @@ export interface NotificationTemplateVersionUpdateRequest {
     /** @minLength 1 */
     plainBody: string;
 }
-export type NotificationType = "Email" | "Text" | "PushNotification";
 export interface Operation {
     op?: string;
     value?: object | null;
@@ -1662,27 +1692,27 @@ export interface PreliminaryCondition {
     requestedFrom?: string | null;
     /** @format date-time */
     createdDate?: string | null;
-    createdBy: CommentUserInformation;
+    createdBy?: CommentUserInformation | null;
     isRequested: boolean;
     /** @format date-time */
     requestedDate?: string | null;
-    requestedBy: CommentUserInformation;
+    requestedBy?: CommentUserInformation | null;
     isReceived: boolean;
     /** @format date-time */
     receivedDate?: string | null;
-    receivedBy: CommentUserInformation;
+    receivedBy?: CommentUserInformation | null;
     priorTo?: string | null;
     category?: string | null;
     isFulfilled: boolean;
     /** @format date-time */
     fulfilledDate?: string | null;
-    fulfilledBy: CommentUserInformation;
+    fulfilledBy?: CommentUserInformation | null;
     comments: ConditionComment[];
     uwAccess?: string | null;
     isRerequested: boolean;
     /** @format date-time */
     rerequestedDate?: string | null;
-    rerequestedBy: CommentUserInformation;
+    rerequestedBy?: CommentUserInformation | null;
 }
 export interface PricingRates {
     rate: string;
@@ -1702,15 +1732,6 @@ export interface ProblemDetails {
     instance?: string | null;
     [key: string]: any;
 }
-export interface PublicLoanOfficer {
-    firstName: string;
-    lastName: string;
-    email: string;
-    phone?: string | null;
-    /** @format uuid */
-    corporateID?: string | null;
-    siteConfigurationIDs: string[];
-}
 export interface RefreshTokenRequest {
     /** @minLength 1 */
     refreshToken: string;
@@ -1872,6 +1893,7 @@ export interface SendNotificationForLoanRequest {
     siteConfigurationId?: string | null;
     /** @minLength 1 */
     email: string;
+    phone?: string | null;
     attachments: Attachment[];
 }
 export interface SiteConfiguration {
@@ -2063,8 +2085,8 @@ export interface SiteConfiguration {
     /** @format int32 */
     allowedLoginsWithoutMFA: number;
     modules: Module[];
-    user: UserPublic;
-    asoSettings: ASOSettings;
+    user?: UserPublic | null;
+    asoSettings?: ASOSettings | null;
 }
 export interface SiteConfigurationByUrl {
     /** @format date-time */
@@ -2255,8 +2277,8 @@ export interface SiteConfigurationByUrl {
     /** @format int32 */
     allowedLoginsWithoutMFA: number;
     modules: Module[];
-    user: UserPublic;
-    asoSettings: ASOSettings;
+    user?: UserPublic | null;
+    asoSettings?: ASOSettings | null;
     workflows: Workflow[];
 }
 export interface SiteConfigurationForm {
@@ -2469,7 +2491,7 @@ export interface SiteConfigurationSearchCriteria {
 }
 export interface SiteConfigurationWithInherited {
     siteConfiguration: SiteConfiguration;
-    inheritedSiteConfiguration: SiteConfiguration;
+    inheritedSiteConfiguration?: SiteConfiguration | null;
 }
 export interface SocialSurveyRecord {
     /** @format date-time */
@@ -2515,7 +2537,7 @@ export interface Task {
     isGlobal: boolean;
     /** @format uuid */
     id: string;
-    user: User;
+    user?: User | null;
     isFromLegacySource: boolean;
     usedInBusinessRule: boolean;
     willAutocompleteAfterResponse: boolean;
@@ -2572,6 +2594,7 @@ export interface TestSendNotificationForLoanRequest {
     /** @format uuid */
     siteConfigurationId: string;
     toAddress?: string | null;
+    toPhoneNumber?: string | null;
     templateName?: string | null;
     attachments: Attachment[];
 }
@@ -2633,21 +2656,21 @@ export interface UnderwritingCondition {
     requestedFrom?: string | null;
     /** @format date-time */
     createdDate?: string | null;
-    createdBy: CommentUserInformation;
+    createdBy?: CommentUserInformation | null;
     isRequested: boolean;
     /** @format date-time */
     requestedDate?: string | null;
-    requestedBy: CommentUserInformation;
+    requestedBy?: CommentUserInformation | null;
     isReceived: boolean;
     /** @format date-time */
     receivedDate?: string | null;
-    receivedBy: CommentUserInformation;
+    receivedBy?: CommentUserInformation | null;
     priorTo?: string | null;
     category?: string | null;
     isFulfilled: boolean;
     /** @format date-time */
     fulfilledDate?: string | null;
-    fulfilledBy: CommentUserInformation;
+    fulfilledBy?: CommentUserInformation | null;
     comments: ConditionComment[];
     allowToClear: boolean;
     printExternally: boolean;
@@ -2667,7 +2690,7 @@ export interface UpdateAccountRequest {
     /** @format int32 */
     allowedLoginsWithoutMFA: number;
     losSettings: LOSSettingsUpdateRequest;
-    asoSettings: ASOSettings;
+    asoSettings?: ASOSettings | null;
 }
 export interface UpdateDocumentTemplateRequest {
     /** @minLength 1 */
@@ -2777,7 +2800,7 @@ export interface UserBase {
 }
 export interface UserLoan {
     loanID: string;
-    customLoanData: CustomLoanData;
+    customLoanData?: CustomLoanData | null;
 }
 export interface UserLoanTask {
     /** @format uuid */
@@ -2795,8 +2818,8 @@ export interface UserLoanTask {
     /** @format date-time */
     createdAt: string;
     createdBy: User;
-    submittedBy: User;
-    completedBy: User;
+    submittedBy?: User | null;
+    completedBy?: User | null;
 }
 export interface UserLoanTaskRequest {
     value?: string | null;
@@ -2980,7 +3003,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.12.1
+ * @version v2.13.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -3274,7 +3297,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/branches/{branchId}/loan-officers
          * @secure
          */
-        getLoanOfficersByBranch: (branchId: string, params?: RequestParams) => Promise<AxiosResponse<PublicLoanOfficer, any>>;
+        getLoanOfficersByBranch: (branchId: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic, any>>;
         /**
          * No description
          *
@@ -3473,7 +3496,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/corporates/{id}/loan-officers
          * @secure
          */
-        getLoanOfficersByCorporate: (id: string, params?: RequestParams) => Promise<AxiosResponse<PublicLoanOfficer, any>>;
+        getLoanOfficersByCorporate: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanOfficerPublic, any>>;
         /**
          * No description
          *
@@ -4608,6 +4631,53 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         replaceLoanOfficerSiteConfiguration: (loanOfficerId: string, siteConfigurationId: string, data: SiteConfigurationRequest, query?: {
             applyToChildren?: boolean;
         }, params?: RequestParams) => Promise<AxiosResponse<SiteConfiguration, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanQueue
+         * @name SearchLoanQueue
+         * @summary Search
+         * @request POST:/api/loans/queue/search
+         * @secure
+         */
+        searchLoanQueue: (data: LoanQueueSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<LoanQueuePaginated, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanQueue
+         * @name GetLoanQueueData
+         * @summary Get Data
+         * @request GET:/api/loans/queue/{loanQueueId}/data
+         * @secure
+         */
+        getLoanQueueData: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanQueue
+         * @name UpdateLoanQueueData
+         * @summary Update Data
+         * @request PUT:/api/loans/queue/{loanQueueId}/data
+         * @secure
+         */
+        updateLoanQueueData: (loanQueueId: string, data: any, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanQueue
+         * @name RetryLoanQueue
+         * @summary Retry
+         * @request POST:/api/loans/queue/{loanQueueId}/retry
+         * @secure
+         */
+        retryLoanQueue: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *
@@ -4857,40 +4927,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         deleteMilestone: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags NotificationLogs
-         * @name GetNotificationLogs
-         * @summary Get All
-         * @request GET:/api/notifications/logs
-         * @secure
-         */
-        getNotificationLogs: (query?: {
-            /** @format int32 */
-            pageSize?: number;
-            /** @format int32 */
-            pageNumber?: number;
-            sortBy?: string;
-            sortDirection?: string;
-        }, params?: RequestParams) => Promise<AxiosResponse<NotificationLog[], any>>;
-        /**
-         * No description
-         *
-         * @tags NotificationLogs
-         * @name SearchNotificationLog
-         * @summary Search
-         * @request POST:/api/notifications/logs/search
-         * @secure
-         */
-        searchNotificationLog: (data: NotificationLogSearchCriteria, query?: {
-            /** @format int32 */
-            pageSize?: number;
-            /** @format int32 */
-            pageNumber?: number;
-            sortBy?: string;
-            sortDirection?: string;
-        }, params?: RequestParams) => Promise<AxiosResponse<NotificationLogPaginated, any>>;
         /**
          * No description
          *
@@ -5034,7 +5070,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getPartners: (query?: {
             showAll?: boolean;
-            role?: UserRole;
+            /** @default 4 */
+            role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
             /** @format int32 */
             pageSize?: number;
             /** @format int32 */
@@ -5118,6 +5155,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name GetRequestQueues
          * @summary Get All
          * @request GET:/api/request-queues
+         * @deprecated
          * @secure
          */
         getRequestQueues: (params?: RequestParams) => Promise<AxiosResponse<RequestQueue[], any>>;
@@ -5128,6 +5166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name RunRequestQueue
          * @summary Run
          * @request POST:/api/request-queues/{id}/run
+         * @deprecated
          * @secure
          */
         runRequestQueue: (id: string, query?: {
@@ -5141,6 +5180,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @name DeleteQueueRequest
          * @summary Delete
          * @request DELETE:/api/request-queues/{id}
+         * @deprecated
          * @secure
          */
         deleteQueueRequest: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;