@matech/thebigpos-sdk 2.12.1-rc1 → 2.14.0-rc1

package/src/index.ts

@@ -49,7 +49,7 @@ export interface Account {
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
   losSettings: LOSSettings;
-  asoSettings: ASOSettings;
+  asoSettings?: ASOSettings | null;
 }
 
 export interface Action {
@@ -119,7 +119,7 @@ export interface AdminAccessGetForms {
   slug?: string | null;
   status: string;
   language?: string | null;
-  borrowerType: BorrowerType;
+  borrowerType?: BorrowerType | null;
   showProgressBar: boolean;
 }
 
@@ -212,11 +212,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 {
@@ -284,7 +284,7 @@ export interface BranchUserPaginated {
 
 export interface BusinessRule {
   /** @format date-time */
-  createdAt?: string | null;
+  createdAt: string;
   /** @format date-time */
   updatedAt?: string | null;
   /** @format date-time */
@@ -478,7 +478,7 @@ export interface CreateInviteRequest {
   /** @format email */
   emailAddress: string;
   phoneNumber: string;
-  relationship: BorrowerRelationship;
+  relationship: "NotApplicable" | "Spouse" | "NonSpouse";
   loanID: string;
   route?: string | null;
   /** @format uuid */
@@ -528,7 +528,7 @@ export interface CreateUserRequest {
 }
 
 export interface CustomLoanData {
-  eConsentInformation: EConsentInformation;
+  eConsentInformation?: EConsentInformation | null;
 }
 
 export interface DetailedUser {
@@ -609,7 +609,7 @@ export interface DeviceMDM {
   platform_type_id?: string | null;
   device_capacity?: string | null;
   imei: string[];
-  user: MdmUser;
+  user?: MdmUser | null;
   actions?: DeviceAction[] | null;
 }
 
@@ -753,6 +753,8 @@ export interface Draft {
   id: string;
   customData: any;
   user: UserBase;
+  loanOfficer: UserBase;
+  siteConfiguration: SiteConfigurationReduced;
 }
 
 export interface DraftContent {
@@ -766,6 +768,8 @@ export interface DraftContent {
   id: string;
   customData: any;
   user: UserBase;
+  loanOfficer: UserBase;
+  siteConfiguration: SiteConfigurationReduced;
   applicationPayload: any;
 }
 
@@ -779,6 +783,8 @@ export interface DraftContentPaginated {
 export interface DraftRequest {
   applicationPayload: any;
   customData?: any;
+  /** @format uuid */
+  loanOfficerID?: string | null;
 }
 
 export interface EConsentInformation {
@@ -875,19 +881,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 {
@@ -903,8 +909,8 @@ export interface File {
   fileName: string;
   name: string;
   s3FilePath: string;
-  user: User;
-  account: Account;
+  user?: User | null;
+  account?: Account | null;
   url: string;
 }
 
@@ -964,7 +970,7 @@ export interface FormRequest {
   slug?: string | null;
   status: string;
   language?: string | null;
-  borrowerType: BorrowerType;
+  borrowerType?: BorrowerType | null;
   showProgressBar: boolean;
 }
 
@@ -990,10 +996,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;
@@ -1003,7 +1009,7 @@ export interface FormSubmission {
   data?: any;
   /** @format uuid */
   listingID?: string | null;
-  listing: Listing;
+  listing?: Listing | null;
   files: FormSubmissionFile[];
 }
 
@@ -1095,7 +1101,20 @@ export interface FusionFieldDisplay {
 }
 
 export interface FusionReportFilter {
-  filterType: FilterType;
+  filterType:
+    | "DateGreaterThanOrEqualTo"
+    | "DateGreaterThan"
+    | "DateLessThan"
+    | "DateLessThanOrEqualTo"
+    | "DateEquals"
+    | "DateDoesntEqual"
+    | "DateNonEmpty"
+    | "DateEmpty"
+    | "StringContains"
+    | "StringEquals"
+    | "StringNotEmpty"
+    | "StringNotEquals"
+    | "StringNotContains";
   targetField: string;
   targetValue: string;
 }
@@ -1158,7 +1177,7 @@ export interface GetForm {
   slug?: string | null;
   status: string;
   language?: string | null;
-  borrowerType: BorrowerType;
+  borrowerType?: BorrowerType | null;
   showProgressBar: boolean;
   /** @format uuid */
   id: string;
@@ -1291,6 +1310,8 @@ export interface LOSSettingsUpdateRequest {
   loanMilestoneNotificationsEnabled: boolean;
 }
 
+export type LOSStatus = "Unknown" | "Pending" | "Retrying" | "Successful" | "Failed" | "FailedPermanently";
+
 export interface Listing {
   /** @format date-time */
   createdAt: string;
@@ -1302,7 +1323,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 */
@@ -1312,7 +1333,7 @@ export interface Listing {
   zillowURL?: string | null;
   photos: ListingPhoto[];
   files: ListingFile[];
-  backgroundImage: File;
+  backgroundImage?: File | null;
   /** @format date-time */
   openHouseDate?: string | null;
   /** @format double */
@@ -1322,7 +1343,7 @@ export interface Listing {
   isActive: boolean;
   slug: string;
   url?: string | null;
-  loanOfficer: LoanOfficer;
+  loanOfficer?: LoanOfficer | null;
   siteConfiguration: SiteConfiguration;
 }
 
@@ -1419,10 +1440,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;
@@ -1484,7 +1505,7 @@ export interface LoanDocument {
   id: string;
   name: string;
   loan: Loan;
-  user: User;
+  user?: User | null;
   initialBucket?: string | null;
   losDocumentID?: string | null;
   losStatus: string;
@@ -1496,6 +1517,9 @@ export interface LoanDraftSearchCriteria {
   searchText?: string | null;
   /** @format uuid */
   loanOfficerId?: string | null;
+  /** @format uuid */
+  siteConfigurationId?: string | null;
+  isUnassigned?: boolean | null;
 }
 
 export interface LoanLog {
@@ -1519,6 +1543,16 @@ export interface LoanOfficer {
   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;
@@ -1528,6 +1562,45 @@ export interface LoanOfficerSearchCriteria {
   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>;
@@ -1620,33 +1693,6 @@ export interface ModuleParameterValue {
   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;
@@ -1729,6 +1775,7 @@ export interface NotificationTemplateVersion {
   isActive: boolean;
   htmlBody: string;
   plainBody: string;
+  textBody: string;
   notificationTemplate: NotificationTemplate;
 }
 
@@ -1747,6 +1794,7 @@ export interface NotificationTemplateVersionBase {
   isActive: boolean;
   htmlBody: string;
   plainBody: string;
+  textBody: string;
 }
 
 export interface NotificationTemplateVersionRequest {
@@ -1770,8 +1818,6 @@ export interface NotificationTemplateVersionUpdateRequest {
   plainBody: string;
 }
 
-export type NotificationType = "Email" | "Text" | "PushNotification";
-
 export interface Operation {
   op?: string;
   value?: object | null;
@@ -1824,27 +1870,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 {
@@ -1867,16 +1913,6 @@ export interface ProblemDetails {
   [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;
@@ -2047,6 +2083,7 @@ export interface SendNotificationForLoanRequest {
   siteConfigurationId?: string | null;
   /** @minLength 1 */
   email: string;
+  phone?: string | null;
   attachments: Attachment[];
 }
 
@@ -2239,8 +2276,8 @@ export interface SiteConfiguration {
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
   modules: Module[];
-  user: UserPublic;
-  asoSettings: ASOSettings;
+  user?: UserPublic | null;
+  asoSettings?: ASOSettings | null;
 }
 
 export interface SiteConfigurationByUrl {
@@ -2432,8 +2469,8 @@ export interface SiteConfigurationByUrl {
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
   modules: Module[];
-  user: UserPublic;
-  asoSettings: ASOSettings;
+  user?: UserPublic | null;
+  asoSettings?: ASOSettings | null;
   workflows: Workflow[];
 }
 
@@ -2652,7 +2689,7 @@ export interface SiteConfigurationSearchCriteria {
 
 export interface SiteConfigurationWithInherited {
   siteConfiguration: SiteConfiguration;
-  inheritedSiteConfiguration: SiteConfiguration;
+  inheritedSiteConfiguration?: SiteConfiguration | null;
 }
 
 export interface SocialSurveyRecord {
@@ -2702,7 +2739,7 @@ export interface Task {
   isGlobal: boolean;
   /** @format uuid */
   id: string;
-  user: User;
+  user?: User | null;
   isFromLegacySource: boolean;
   usedInBusinessRule: boolean;
   willAutocompleteAfterResponse: boolean;
@@ -2764,6 +2801,7 @@ export interface TestSendNotificationForLoanRequest {
   /** @format uuid */
   siteConfigurationId: string;
   toAddress?: string | null;
+  toPhoneNumber?: string | null;
   templateName?: string | null;
   attachments: Attachment[];
 }
@@ -2830,21 +2868,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;
@@ -2867,7 +2905,7 @@ export interface UpdateAccountRequest {
   /** @format int32 */
   allowedLoginsWithoutMFA: number;
   losSettings: LOSSettingsUpdateRequest;
-  asoSettings: ASOSettings;
+  asoSettings?: ASOSettings | null;
 }
 
 export interface UpdateDocumentTemplateRequest {
@@ -2987,7 +3025,7 @@ export interface UserBase {
 
 export interface UserLoan {
   loanID: string;
-  customLoanData: CustomLoanData;
+  customLoanData?: CustomLoanData | null;
 }
 
 export interface UserLoanTask {
@@ -3006,8 +3044,8 @@ export interface UserLoanTask {
   /** @format date-time */
   createdAt: string;
   createdBy: User;
-  submittedBy: User;
-  completedBy: User;
+  submittedBy?: User | null;
+  completedBy?: User | null;
 }
 
 export interface UserLoanTaskRequest {
@@ -3309,7 +3347,7 @@ export 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/)
  */
@@ -3857,7 +3895,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     getLoanOfficersByBranch: (branchId: string, params: RequestParams = {}) =>
-      this.request<PublicLoanOfficer, any>({
+      this.request<LoanOfficerPublic, any>({
         path: `/api/branches/${branchId}/loan-officers`,
         method: "GET",
         secure: true,
@@ -4235,7 +4273,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @secure
      */
     getLoanOfficersByCorporate: (id: string, params: RequestParams = {}) =>
-      this.request<PublicLoanOfficer, any>({
+      this.request<LoanOfficerPublic, any>({
         path: `/api/corporates/${id}/loan-officers`,
         method: "GET",
         secure: true,
@@ -6382,6 +6420,92 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * 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 = {},
+    ) =>
+      this.request<LoanQueuePaginated, any>({
+        path: `/api/loans/queue/search`,
+        method: "POST",
+        query: query,
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanQueue
+     * @name GetLoanQueueData
+     * @summary Get Data
+     * @request GET:/api/loans/queue/{loanQueueId}/data
+     * @secure
+     */
+    getLoanQueueData: (loanQueueId: string, params: RequestParams = {}) =>
+      this.request<any, any>({
+        path: `/api/loans/queue/${loanQueueId}/data`,
+        method: "GET",
+        secure: true,
+        format: "json",
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanQueue
+     * @name UpdateLoanQueueData
+     * @summary Update Data
+     * @request PUT:/api/loans/queue/{loanQueueId}/data
+     * @secure
+     */
+    updateLoanQueueData: (loanQueueId: string, data: any, params: RequestParams = {}) =>
+      this.request<void, any>({
+        path: `/api/loans/queue/${loanQueueId}/data`,
+        method: "PUT",
+        body: data,
+        secure: true,
+        type: ContentType.Json,
+        ...params,
+      }),
+
+    /**
+     * No description
+     *
+     * @tags LoanQueue
+     * @name RetryLoanQueue
+     * @summary Retry
+     * @request POST:/api/loans/queue/{loanQueueId}/retry
+     * @secure
+     */
+    retryLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
+      this.request<void, any>({
+        path: `/api/loans/queue/${loanQueueId}/retry`,
+        method: "POST",
+        secure: true,
+        ...params,
+      }),
+
     /**
      * No description
      *
@@ -6848,67 +6972,6 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
-    /**
-     * 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 = {},
-    ) =>
-      this.request<NotificationLog[], any>({
-        path: `/api/notifications/logs`,
-        method: "GET",
-        query: query,
-        secure: true,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * 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 = {},
-    ) =>
-      this.request<NotificationLogPaginated, any>({
-        path: `/api/notifications/logs/search`,
-        method: "POST",
-        query: query,
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: "json",
-        ...params,
-      }),
-
     /**
      * No description
      *
@@ -7179,7 +7242,18 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
     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 */
@@ -7342,6 +7416,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @name GetRequestQueues
      * @summary Get All
      * @request GET:/api/request-queues
+     * @deprecated
      * @secure
      */
     getRequestQueues: (params: RequestParams = {}) =>
@@ -7360,6 +7435,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @name RunRequestQueue
      * @summary Run
      * @request POST:/api/request-queues/{id}/run
+     * @deprecated
      * @secure
      */
     runRequestQueue: (
@@ -7385,6 +7461,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @name DeleteQueueRequest
      * @summary Delete
      * @request DELETE:/api/request-queues/{id}
+     * @deprecated
      * @secure
      */
     deleteQueueRequest: (id: string, params: RequestParams = {}) =>