@matech/thebigpos-sdk 2.13.0-rc1 → 2.14.0-rc.4

package/.husky/pre-commit

@@ -1,2 +1 @@
-yarn build
-git add .
+yarn build

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mortgage Automation Technologies
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mortgage Automation Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,44 +1,44 @@
-# The BIG POS Typescript SDK
-
-## Installation
-Using npm:
-
-```bash
-$ npm install @matech/thebigpos-sdk
-```
-
-Using yarn:
-
-```bash
-$ yarn add @matech/thebigpos-sdk
-```
-
-## Quick Start
-```js
-import { Api } from "@matech/thebigpos-sdk";
-
-const securityWorker = (data: any) => {
-    return { headers: data }
-}
-
-const setBearerSecurityWorker = (accessToken:string) => {
-    const data = {
-        Authorization: `Bearer ${accessToken}`
-    };
-
-    apiClient.setSecurityData(data);
-};
-
-const apiClient = new Api({
-    baseURL:
-        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
-    securityWorker,
-})
-
-apiClient.api.getSiteConfiguration().then((response) => {
-    console.log(response.data);
-});
-```
-
-____
-© 2024 Mortgage Automation Technologies. All rights reserved
+# The BIG POS Typescript SDK
+
+## Installation
+Using npm:
+
+```bash
+$ npm install @matech/thebigpos-sdk
+```
+
+Using yarn:
+
+```bash
+$ yarn add @matech/thebigpos-sdk
+```
+
+## Quick Start
+```js
+import { Api } from "@matech/thebigpos-sdk";
+
+const securityWorker = (data: any) => {
+    return { headers: data }
+}
+
+const setBearerSecurityWorker = (accessToken:string) => {
+    const data = {
+        Authorization: `Bearer ${accessToken}`
+    };
+
+    apiClient.setSecurityData(data);
+};
+
+const apiClient = new Api({
+    baseURL:
+        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
+    securityWorker,
+})
+
+apiClient.api.getSiteConfiguration().then((response) => {
+    console.log(response.data);
+});
+```
+
+____
+© 2024 Mortgage Automation Technologies. All rights reserved

package/dist/index.d.ts

@@ -17,7 +17,7 @@ export interface ASOSettings {
     preApproval: boolean;
     preQualification: boolean;
     mi: boolean;
-    miRadiam: boolean;
+    miRadian: boolean;
     miEssent: boolean;
     miNational: boolean;
     miEnact: boolean;
@@ -84,6 +84,30 @@ export interface AddressRequest {
     /** @minLength 1 */
     postalCode: string;
 }
+export interface AdminAccessGetForm {
+    /** @format date-time */
+    createdAt?: string | null;
+    /** @format date-time */
+    updatedAt?: string | null;
+    /** @format date-time */
+    deletedAt?: string | null;
+    /** @format uuid */
+    id: string;
+    formJSON: any;
+    /** @format int32 */
+    type: number;
+    target: string;
+    authType: string;
+    name: string;
+    isDefault: boolean;
+    description?: string | null;
+    slug?: string | null;
+    status: string;
+    language?: string | null;
+    showProgressBar: boolean;
+    borrowerType?: BorrowerType | null;
+    versions: FormVersion[];
+}
 export interface AdminAccessGetForms {
     /** @format date-time */
     createdAt?: string | null;
@@ -128,6 +152,7 @@ export interface AdminAccessUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
     /** @format uuid */
     accountID?: string | null;
     loans: UserLoan[];
@@ -239,6 +264,7 @@ export interface BranchUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
     /** @format uuid */
     branchID: string;
     branchName: string;
@@ -503,6 +529,7 @@ export interface DetailedUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
 }
 export interface Device {
     /** @format uuid */
@@ -1437,12 +1464,30 @@ 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 type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
+export interface LoanQueueWithData {
+    /** @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;
+    data: any;
+}
 export interface LoanRecord {
     loanGuid: string;
     loanFields: Record<string, string>;
@@ -1527,30 +1572,6 @@ export interface ModuleParameterValue {
     value?: any;
     isInherited: boolean;
 }
-export interface NotificationLog {
-    /** @format uuid */
-    id: string;
-    type: "Email" | "Text" | "PushNotification";
-    to: string;
-    cc?: string | null;
-    subject?: string | null;
-    message: string;
-    notificationTemplate?: NotificationTemplate | null;
-    /** @format date-time */
-    createdAt: string;
-}
-export interface NotificationLogPaginated {
-    rows: NotificationLog[];
-    pagination: Pagination;
-    /** @format int64 */
-    count: number;
-}
-export interface NotificationLogSearchCriteria {
-    searchText?: string | null;
-    type?: NotificationType | null;
-    to?: string[] | null;
-    cc?: string[] | null;
-}
 export interface NotificationTemplate {
     /** @format date-time */
     createdAt?: string | null;
@@ -1630,6 +1651,7 @@ export interface NotificationTemplateVersion {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
     notificationTemplate: NotificationTemplate;
 }
 export interface NotificationTemplateVersionBase {
@@ -1647,6 +1669,7 @@ export interface NotificationTemplateVersionBase {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
 }
 export interface NotificationTemplateVersionRequest {
     /** @maxLength 255 */
@@ -1654,6 +1677,7 @@ export interface NotificationTemplateVersionRequest {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
 }
 export interface NotificationTemplateVersionUpdateRequest {
     /**
@@ -1666,8 +1690,9 @@ export interface NotificationTemplateVersionUpdateRequest {
     htmlBody: string;
     /** @minLength 1 */
     plainBody: string;
+    /** @minLength 1 */
+    textBody: string;
 }
-export type NotificationType = "Email" | "Text" | "PushNotification";
 export interface Operation {
     op?: string;
     value?: object | null;
@@ -1916,6 +1941,7 @@ export interface SendNotificationForLoanRequest {
     siteConfigurationId?: string | null;
     /** @minLength 1 */
     email: string;
+    phone?: string | null;
     attachments: Attachment[];
 }
 export interface SiteConfiguration {
@@ -2564,6 +2590,28 @@ export interface Task {
     usedInBusinessRule: boolean;
     willAutocompleteAfterResponse: boolean;
     hasAutoPropagationOnAdd: boolean;
+    /** @format int32 */
+    commentsCount: number;
+}
+export interface TaskComment {
+    /** @format uuid */
+    id: string;
+    comment: string;
+    createdBy: UserBase;
+    /** @format date-time */
+    createdAt: string;
+}
+export interface TaskCommentPaginated {
+    rows: TaskComment[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export interface TaskCommentRequest {
+    comment: string;
+}
+export interface TaskCommentSearchCriteria {
+    searchText?: string | null;
 }
 export interface TaskPaginated {
     rows: Task[];
@@ -2616,6 +2664,7 @@ export interface TestSendNotificationForLoanRequest {
     /** @format uuid */
     siteConfigurationId: string;
     toAddress?: string | null;
+    toPhoneNumber?: string | null;
     templateName?: string | null;
     attachments: Attachment[];
 }
@@ -2749,6 +2798,9 @@ export interface UpdateListingPhotoRequest {
     /** @format int32 */
     weight: number;
 }
+export interface UpdateLoanQueueRequest {
+    data: any;
+}
 export interface UpdateMeRequest {
     phone?: string | null;
     /**
@@ -2764,6 +2816,7 @@ export interface UpdateMeRequest {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    notificationSettings: UserNotificationSettingsUpdateRequest;
 }
 export interface UpdateMobilePhoneRequest {
     phone: string;
@@ -2841,6 +2894,8 @@ export interface UserLoanTask {
     createdBy: User;
     submittedBy?: User | null;
     completedBy?: User | null;
+    /** @format int32 */
+    commentsCount: number;
 }
 export interface UserLoanTaskRequest {
     value?: string | null;
@@ -2858,6 +2913,14 @@ export interface UserMobilePhoneVerificationRequest {
     /** @minLength 1 */
     code: string;
 }
+export interface UserNotificationSettings {
+    emailEnabled: boolean;
+    textEnabled?: boolean | null;
+}
+export interface UserNotificationSettingsUpdateRequest {
+    emailEnabled: boolean;
+    textEnabled?: boolean | null;
+}
 export interface UserPaginated {
     rows: User[];
     pagination: Pagination;
@@ -3820,7 +3883,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/forms
          * @secure
          */
-        createForm: (data: FormRequest, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForms, any>>;
+        createForm: (data: FormRequest, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForm, any>>;
         /**
          * No description
          *
@@ -3830,7 +3893,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request GET:/api/forms/{id}
          * @secure
          */
-        getForm: (id: string, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForms, any>>;
+        getForm: (id: string, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForm, any>>;
         /**
          * No description
          *
@@ -3840,7 +3903,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request PUT:/api/forms/{id}
          * @secure
          */
-        replaceForm: (id: string, data: FormRequest, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForms, any>>;
+        replaceForm: (id: string, data: FormRequest, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForm, any>>;
         /**
          * No description
          *
@@ -3860,7 +3923,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @request POST:/api/forms/{id}/restore
          * @secure
          */
-        restoreForm: (id: string, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForms, any>>;
+        restoreForm: (id: string, params?: RequestParams) => Promise<AxiosResponse<AdminAccessGetForm, any>>;
         /**
          * No description
          *
@@ -4673,22 +4736,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags LoanQueue
-         * @name GetLoanQueueData
-         * @summary Get Data
-         * @request GET:/api/loans/queue/{loanQueueId}/data
+         * @name GetLoanQueue
+         * @summary Get Loan Queue Record
+         * @request GET:/api/loans/queue/{loanQueueId}
          * @secure
          */
-        getLoanQueueData: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
+        getLoanQueue: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<any, any>>;
         /**
          * No description
          *
          * @tags LoanQueue
-         * @name UpdateLoanQueueData
-         * @summary Update Data
-         * @request PUT:/api/loans/queue/{loanQueueId}/data
+         * @name ReplaceLoanQueue
+         * @summary Replace Loan Queue Record
+         * @request PUT:/api/loans/queue/{loanQueueId}
          * @secure
          */
-        updateLoanQueueData: (loanQueueId: string, data: any, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        replaceLoanQueue: (loanQueueId: string, data: UpdateLoanQueueRequest, params?: RequestParams) => Promise<AxiosResponse<LoanQueueWithData, any>>;
         /**
          * No description
          *
@@ -4763,6 +4826,63 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         importLoanFromLos: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<Loan, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name SearchLoanTaskComments
+         * @summary Search
+         * @request POST:/api/loans/{loanId}/tasks/{taskId}/comments/search
+         * @secure
+         */
+        searchLoanTaskComments: (loanId: string, taskId: string, data: TaskCommentSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<TaskCommentPaginated, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name GetLoanTaskComment
+         * @summary Get by ID
+         * @request GET:/api/loans/{loanId}/tasks/{taskId}/comments/{id}
+         * @secure
+         */
+        getLoanTaskComment: (id: string, loanId: string, taskId: string, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name CreateLoanTaskComment
+         * @summary Create
+         * @request POST:/api/loans/{loanId}/tasks/{taskId}/comments
+         * @secure
+         */
+        createLoanTaskComment: (loanId: string, taskId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name ReplaceLoanTaskComment
+         * @summary Replace
+         * @request PUT:/api/loans/{loanId}/tasks/{taskId}/comments/{commentId}
+         * @secure
+         */
+        replaceLoanTaskComment: (loanId: string, taskId: string, commentId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name DeleteLoanTaskComment
+         * @summary Delete
+         * @request DELETE:/api/loans/{loanId}/tasks/{taskId}/comments/{commentId}
+         * @secure
+         */
+        deleteLoanTaskComment: (loanId: string, taskId: string, commentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *
@@ -4948,40 +5068,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
          *
@@ -5125,7 +5211,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          */
         getPartners: (query?: {
             showAll?: boolean;
-            /** @default 4 */
+            /** @default "Realtor" */
             role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
             /** @format int32 */
             pageSize?: number;
@@ -5239,16 +5325,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         deleteQueueRequest: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
-        /**
-         * No description
-         *
-         * @tags SelfProvisioning
-         * @name CreateSelfProvisioningItem
-         * @summary Create
-         * @request POST:/api/selfprovisioning/newcustomer
-         * @secure
-         */
-        createSelfProvisioningItem: (data: any, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *