@matech/thebigpos-sdk 2.14.0-rc3 → 2.14.0-rc6

package/.husky/pre-commit

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

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

@@ -38,6 +38,15 @@ export interface Account {
     allowedLoginsWithoutMFA: number;
     losSettings: LOSSettings;
     asoSettings?: ASOSettings | null;
+    settings: AccountSettings;
+}
+export interface AccountSettings {
+    isSmsEnabled: boolean;
+    smsNumber?: string | null;
+}
+export interface AccountSettingsRequest {
+    isSmsEnabled: boolean;
+    smsNumber?: string | null;
 }
 export interface Action {
     /** @format uuid */
@@ -152,6 +161,7 @@ export interface AdminAccessUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
     /** @format uuid */
     accountID?: string | null;
     loans: UserLoan[];
@@ -227,6 +237,18 @@ export interface Attachment {
 }
 export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
+export interface BranchBase {
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt?: string | null;
+    /** @format date-time */
+    deletedAt?: string | null;
+    /** @format uuid */
+    id: string;
+    name: string;
+    type: string;
+}
 export interface BranchReduced {
     /** @format uuid */
     id: string;
@@ -263,6 +285,7 @@ export interface BranchUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
     /** @format uuid */
     branchID: string;
     branchName: string;
@@ -390,6 +413,17 @@ export interface Corporate {
     branchIDs: string[];
     siteConfigurations: SiteConfigurationReduced[];
 }
+export interface CorporateBase {
+    /** @format date-time */
+    createdAt: string;
+    /** @format date-time */
+    updatedAt?: string | null;
+    /** @format date-time */
+    deletedAt?: string | null;
+    /** @format uuid */
+    id: string;
+    name: string;
+}
 export interface CorporatePaginated {
     rows: Corporate[];
     pagination: Pagination;
@@ -423,6 +457,7 @@ export interface CreateAccountRequest {
      * @min 0
      */
     nlmsid: number;
+    settings: AccountSettingsRequest;
 }
 export interface CreateBranchRequest {
     /**
@@ -527,6 +562,7 @@ export interface DetailedUser {
     canImpersonate: boolean;
     loanIDs: string[];
     drafts: Draft[];
+    notificationSettings?: UserNotificationSettings | null;
 }
 export interface Device {
     /** @format uuid */
@@ -736,11 +772,13 @@ export interface DraftContentPaginated {
     /** @format int64 */
     count: number;
 }
+export interface DraftLoanOfficerReassignRequest {
+    /** @format uuid */
+    loanOfficerID: string;
+}
 export interface DraftRequest {
     applicationPayload: any;
     customData?: any;
-    /** @format uuid */
-    loanOfficerID?: string | null;
 }
 export interface EConsentInformation {
     status: string;
@@ -768,7 +806,6 @@ export interface EnabledServices {
     borrowerTasks?: boolean | null;
     docusign?: boolean | null;
     emailNotifications?: boolean | null;
-    textNotifications?: boolean | null;
     voc?: boolean | null;
     spanishPrequal?: boolean | null;
     spanishFullApp?: boolean | null;
@@ -800,6 +837,8 @@ export interface Error {
     message: string;
 }
 export interface ExtendedLoan {
+    /** @format uuid */
+    id: string;
     loanID: string;
     loanNumber?: string | null;
     /** @format date-time */
@@ -1288,6 +1327,8 @@ export interface ListingSearchCriteria {
     partnerIds?: string[] | null;
 }
 export interface Loan {
+    /** @format uuid */
+    id: string;
     loanID: string;
     loanNumber?: string | null;
     /** @format date-time */
@@ -1442,11 +1483,12 @@ export interface LoanQueue {
     deletedAt?: string | null;
     /** @format uuid */
     id: string;
-    loanID?: string | null;
+    loan?: Loan | null;
     type: string;
     reason: string;
     status: string;
     details?: string | null;
+    jobID?: string | null;
     user: UserPublic;
     loanOfficer: LoanOfficerPublic;
     siteConfiguration: SiteConfigurationReduced;
@@ -1465,7 +1507,7 @@ export interface LoanQueueSearchCriteria {
     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;
@@ -1475,15 +1517,16 @@ export interface LoanQueueWithData {
     deletedAt?: string | null;
     /** @format uuid */
     id: string;
-    loanID?: string | null;
+    loan?: Loan | null;
     type: string;
     reason: string;
     status: string;
     details?: string | null;
+    jobID?: string | null;
     user: UserPublic;
     loanOfficer: LoanOfficerPublic;
     siteConfiguration: SiteConfigurationReduced;
-    data: any;
+    data?: any;
 }
 export interface LoanRecord {
     loanGuid: string;
@@ -1569,30 +1612,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;
@@ -1672,6 +1691,7 @@ export interface NotificationTemplateVersion {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
     notificationTemplate: NotificationTemplate;
 }
 export interface NotificationTemplateVersionBase {
@@ -1689,6 +1709,7 @@ export interface NotificationTemplateVersionBase {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
 }
 export interface NotificationTemplateVersionRequest {
     /** @maxLength 255 */
@@ -1696,6 +1717,7 @@ export interface NotificationTemplateVersionRequest {
     isActive: boolean;
     htmlBody: string;
     plainBody: string;
+    textBody: string;
 }
 export interface NotificationTemplateVersionUpdateRequest {
     /**
@@ -1708,8 +1730,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;
@@ -1890,6 +1913,7 @@ export interface RunLOCalculation {
     canGeneratePreQual: boolean;
     canGeneratePreApproval: boolean;
     preApprovalNotes?: string | null;
+    additionalPreApprovalNotes?: string | null;
     downPaymentAmount?: string | null;
     downPaymentPercent?: string | null;
     lienType?: string | null;
@@ -1925,6 +1949,7 @@ export interface RunLOCalculationRequest {
     /** @minLength 1 */
     lienType: string;
     preApprovalNotes?: string | null;
+    additionalPreApprovalNotes?: string | null;
 }
 export interface SSOToken {
     /** @format uuid */
@@ -1958,6 +1983,7 @@ export interface SendNotificationForLoanRequest {
     siteConfigurationId?: string | null;
     /** @minLength 1 */
     email: string;
+    phone?: string | null;
     attachments: Attachment[];
 }
 export interface SiteConfiguration {
@@ -2151,6 +2177,7 @@ export interface SiteConfiguration {
     modules: Module[];
     user?: UserPublic | null;
     asoSettings?: ASOSettings | null;
+    accountSettings: AccountSettings;
 }
 export interface SiteConfigurationByUrl {
     /** @format date-time */
@@ -2343,6 +2370,7 @@ export interface SiteConfigurationByUrl {
     modules: Module[];
     user?: UserPublic | null;
     asoSettings?: ASOSettings | null;
+    accountSettings: AccountSettings;
     workflows: Workflow[];
 }
 export interface SiteConfigurationForm {
@@ -2366,12 +2394,6 @@ export interface SiteConfigurationForm {
     icon: string;
     entityTypes: string[];
 }
-export interface SiteConfigurationPaginated {
-    rows: SiteConfiguration[];
-    pagination: Pagination;
-    /** @format int64 */
-    count: number;
-}
 export interface SiteConfigurationReduced {
     /** @format uuid */
     id: string;
@@ -2552,6 +2574,37 @@ export interface SiteConfigurationSearchCriteria {
     searchText?: string | null;
     isActive?: boolean | null;
     entityType?: string | null;
+    /** @format uuid */
+    branch?: string | null;
+    /** @format uuid */
+    brand?: string | null;
+    role?: UserRole | null;
+    branchType?: string | null;
+}
+export interface SiteConfigurationWithBranchBrandLOInformation {
+    /** @format uuid */
+    id: string;
+    url?: string | null;
+    name: string;
+    /** @format int64 */
+    nmlsid: number;
+    email?: string | null;
+    companyName?: string | null;
+    /** @format date-time */
+    createdAt?: string | null;
+    /** @format date-time */
+    deletedAt?: string | null;
+    branch?: BranchBase | null;
+    corporate?: CorporateBase | null;
+    loanOfficer?: User | null;
+    realtor?: User | null;
+    branchName?: string | null;
+}
+export interface SiteConfigurationWithBranchBrandLOInformationPaginated {
+    rows: SiteConfigurationWithBranchBrandLOInformation[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
 }
 export interface SiteConfigurationWithInherited {
     siteConfiguration: SiteConfiguration;
@@ -2607,6 +2660,26 @@ export interface Task {
     willAutocompleteAfterResponse: boolean;
     hasAutoPropagationOnAdd: boolean;
 }
+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[];
     pagination: Pagination;
@@ -2658,6 +2731,7 @@ export interface TestSendNotificationForLoanRequest {
     /** @format uuid */
     siteConfigurationId: string;
     toAddress?: string | null;
+    toPhoneNumber?: string | null;
     templateName?: string | null;
     attachments: Attachment[];
 }
@@ -2754,6 +2828,7 @@ export interface UpdateAccountRequest {
     allowedLoginsWithoutMFA: number;
     losSettings: LOSSettingsUpdateRequest;
     asoSettings?: ASOSettings | null;
+    settings: AccountSettingsRequest;
 }
 export interface UpdateDocumentTemplateRequest {
     /** @minLength 1 */
@@ -2809,6 +2884,7 @@ export interface UpdateMeRequest {
     title?: string | null;
     forcePasswordReset: boolean;
     mfaEnabled: boolean;
+    notificationSettings: UserNotificationSettingsUpdateRequest;
 }
 export interface UpdateMobilePhoneRequest {
     phone: string;
@@ -2886,6 +2962,8 @@ export interface UserLoanTask {
     createdBy: User;
     submittedBy?: User | null;
     completedBy?: User | null;
+    /** @format int32 */
+    commentsCount: number;
 }
 export interface UserLoanTaskRequest {
     value?: string | null;
@@ -2903,6 +2981,16 @@ export interface UserMobilePhoneVerificationRequest {
     /** @minLength 1 */
     code: string;
 }
+export interface UserNotificationSettings {
+    emailEnabled: boolean;
+    textEnabled: boolean;
+    textOptIn?: boolean | null;
+}
+export interface UserNotificationSettingsUpdateRequest {
+    emailEnabled: boolean;
+    textEnabled: boolean;
+    textOptIn?: boolean | null;
+}
 export interface UserPaginated {
     rows: User[];
     pagination: Pagination;
@@ -3069,7 +3157,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.13.0
+ * @version v2.14.1
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -4610,6 +4698,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             sortBy?: string;
             sortDirection?: string;
         }, params?: RequestParams) => Promise<AxiosResponse<DraftContentPaginated, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanDrafts
+         * @name ReassignLoanOfficer
+         * @summary Reassign Loan officer
+         * @request PUT:/api/loans/drafts/{draftId}/reassign
+         * @secure
+         */
+        reassignLoanOfficer: (draftId: string, data: DraftLoanOfficerReassignRequest, params?: RequestParams) => Promise<AxiosResponse<Draft, any>>;
         /**
          * No description
          *
@@ -4734,6 +4832,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          */
         replaceLoanQueue: (loanQueueId: string, data: UpdateLoanQueueRequest, params?: RequestParams) => Promise<AxiosResponse<LoanQueueWithData, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanQueue
+         * @name DeleteLoanQueue
+         * @summary Delete Loan Queue Item
+         * @request DELETE:/api/loans/queue/{loanQueueId}
+         * @secure
+         */
+        deleteLoanQueue: (loanQueueId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *
@@ -4808,6 +4916,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/{userLoanTaskId}/comments/search
+         * @secure
+         */
+        searchLoanTaskComments: (loanId: string, userLoanTaskId: 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/{userLoanTaskId}/comments/{id}
+         * @secure
+         */
+        getLoanTaskComment: (id: string, loanId: string, userLoanTaskId: string, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name CreateLoanTaskComment
+         * @summary Create
+         * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments
+         * @secure
+         */
+        createLoanTaskComment: (loanId: string, userLoanTaskId: string, data: TaskCommentRequest, params?: RequestParams) => Promise<AxiosResponse<TaskComment, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanTaskComments
+         * @name ReplaceLoanTaskComment
+         * @summary Replace
+         * @request PUT:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
+         * @secure
+         */
+        replaceLoanTaskComment: (loanId: string, userLoanTaskId: 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/{userLoanTaskId}/comments/{commentId}
+         * @secure
+         */
+        deleteLoanTaskComment: (loanId: string, userLoanTaskId: string, commentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *
@@ -4993,40 +5158,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
          *
@@ -5284,16 +5415,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
          *
@@ -5364,7 +5485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
             pageNumber?: number;
             sortBy?: string;
             sortDirection?: string;
-        }, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationPaginated, any>>;
+        }, params?: RequestParams) => Promise<AxiosResponse<SiteConfigurationWithBranchBrandLOInformationPaginated, any>>;
         /**
          * No description
          *