@matech/thebigpos-sdk 2.20.4 → 2.20.6

package/.husky/pre-commit

@@ -1,3 +1,3 @@
-[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
-yarn build
+[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
+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

@@ -474,6 +474,8 @@ export interface CreateInviteRequest {
     loanRole?: LoanRole | null;
 }
 export interface CreateLoanImportRequest {
+    /** @format uuid */
+    accountID: string;
     /**
      * @format date-time
      * @minLength 1
@@ -486,14 +488,11 @@ export interface CreateLoanImportRequest {
     startDate: string;
     importMode: "All" | "NewOnly" | "UpdateOnly";
 }
-export interface CreateLosCredentials {
-    /** @format uuid */
-    accountID: string;
-    instanceID: string;
-    clientID: string;
-    clientSecret: string;
-    encryptionKeyArn: string;
-    encryptionPassword: string;
+export interface CreateUserDraft {
+    loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+}
+export interface CreateUserLoan {
+    loanRole?: LoanRole | null;
 }
 export interface CreateUserRelationRequest {
     /**
@@ -1038,7 +1037,7 @@ export interface FusionReportFilter {
 }
 export interface GenerateDocumentRequest {
     /** @deprecated */
-    loanID: string;
+    loanID?: string | null;
     /**
      * @format uuid
      * @minLength 1
@@ -1048,7 +1047,7 @@ export interface GenerateDocumentRequest {
      * @deprecated
      * @format uuid
      */
-    siteConfigurationID: string;
+    siteConfigurationID?: string | null;
     preview: boolean;
     recipients: string[];
 }
@@ -1215,6 +1214,7 @@ export interface LOSSettings {
     correspondentLoanClosingDateFieldID: string;
     customEConsentBucketTitle?: string | null;
     loanMilestoneNotificationsEnabled: boolean;
+    useLocalPipeline: boolean;
 }
 export interface LOSSettingsUpdateRequest {
     retailLoanClosingDateFieldID: string;
@@ -1556,6 +1556,17 @@ export interface LoanLog {
     /** @format date-time */
     createdAt: string;
 }
+export interface LoanLogPaginated {
+    rows: LoanLog[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
+export interface LoanLogSearchCriteria {
+    searchText?: string | null;
+    types?: LoanLogType[] | null;
+    levels?: LogLevel[] | null;
+}
 export interface LoanOfficer {
     /** @format uuid */
     id: string;
@@ -2160,8 +2171,7 @@ export interface SiteConfiguration {
     twitterUrl?: string | null;
     instagramUrl?: string | null;
     linkedInUrl?: string | null;
-    /** @minLength 1 */
-    youTubeUrl: string;
+    youTubeUrl?: string | null;
     licenses: string[];
     contactUsUrl?: string | null;
     licenseInfoUrl?: string | null;
@@ -2307,6 +2317,7 @@ export interface SiteConfiguration {
     accountSettings: AccountSettings;
     autoTaskReminderIntervalsInDays?: number[] | null;
     mobileSettings: MobileSettings;
+    losSettings?: LOSSettings | null;
 }
 export interface SiteConfigurationByUrl {
     /** @format date-time */
@@ -2354,8 +2365,7 @@ export interface SiteConfigurationByUrl {
     twitterUrl?: string | null;
     instagramUrl?: string | null;
     linkedInUrl?: string | null;
-    /** @minLength 1 */
-    youTubeUrl: string;
+    youTubeUrl?: string | null;
     licenses: string[];
     contactUsUrl?: string | null;
     licenseInfoUrl?: string | null;
@@ -2501,6 +2511,7 @@ export interface SiteConfigurationByUrl {
     accountSettings: AccountSettings;
     autoTaskReminderIntervalsInDays?: number[] | null;
     mobileSettings: MobileSettings;
+    losSettings?: LOSSettings | null;
     workflows: Workflow[];
 }
 export interface SiteConfigurationForm {
@@ -3084,6 +3095,18 @@ export interface UserBase {
     lastName: string;
     email: string;
 }
+export interface UserDraft {
+    /** @format uuid */
+    draftID: string;
+    role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    user: User;
+}
+export interface UserDraftPaginated {
+    rows: UserDraft[];
+    pagination: Pagination;
+    /** @format int64 */
+    count: number;
+}
 export interface UserLoan {
     /** @format date-time */
     createdAt: string;
@@ -3295,7 +3318,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.20.4
+ * @version v2.20.6
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -5140,6 +5163,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `404` `ProblemDetails` Not Found
          */
         inviteLoanContacts: (loanId: string, data: string[], params?: RequestParams) => Promise<AxiosResponse<Invite[], any>>;
+        /**
+         * No description
+         *
+         * @tags LoanLogs
+         * @name SearchLoanLogs
+         * @summary Search loan logs
+         * @request POST:/api/loans/{loanId}/logs/search
+         * @secure
+         * @response `200` `LoanLogPaginated` Success
+         */
+        searchLoanLogs: (loanId: string, data: LoanLogSearchCriteria, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<LoanLogPaginated, any>>;
         /**
          * No description
          *
@@ -5622,7 +5663,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `201` `LoanUser` Created
          */
-        addLoanUser: (loanId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<LoanUser, any>>;
+        addLoanUser: (loanId: string, userId: string, data: CreateUserLoan, params?: RequestParams) => Promise<AxiosResponse<LoanUser, any>>;
+        /**
+         * No description
+         *
+         * @tags LoanUsers
+         * @name RemoveLoanUser
+         * @summary Remove User from Loan
+         * @request DELETE:/api/loans/{loanId}/users/{userId}
+         * @secure
+         * @response `204` `LoanUser` No Content
+         */
+        removeLoanUser: (loanId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<LoanUser, any>>;
         /**
          * No description
          *
@@ -6257,52 +6309,63 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * No description
          *
          * @tags TheBigPOS
-         * @name IntegrationsLosLoansLockedList
-         * @request GET:/api/integrations/los/loans/{loanID}/locked
+         * @name IntegrationsLosLoansUsersAssociateCreate
+         * @request POST:/api/integrations/los/loans/{loanID}/users/{email}/associate
          * @secure
          * @response `200` `void` Success
          */
-        integrationsLosLoansLockedList: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        integrationsLosLoansUsersAssociateCreate: (loanId: string, email: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *
-         * @tags TheBigPOS
-         * @name IntegrationsLosLoansBucketsList
-         * @request GET:/api/integrations/los/loans/{loanID}/buckets
+         * @tags UserDraft
+         * @name GetDraftUsers
+         * @summary Get draft users
+         * @request GET:/api/loans/drafts/{draftId}/users
          * @secure
-         * @response `200` `void` Success
+         * @response `200` `UserDraftPaginated` Success
          */
-        integrationsLosLoansBucketsList: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        getDraftUsers: (draftId: string, query?: {
+            /** @format int32 */
+            pageSize?: number;
+            /** @format int32 */
+            pageNumber?: number;
+            sortBy?: string;
+            sortDirection?: string;
+        }, params?: RequestParams) => Promise<AxiosResponse<UserDraftPaginated, any>>;
         /**
          * No description
          *
-         * @tags TheBigPOS
-         * @name IntegrationsLosCredentialsCreate
-         * @request POST:/api/integrations/los/credentials
+         * @tags UserDraft
+         * @name GetDraftUser
+         * @summary Get draft user
+         * @request GET:/api/loans/drafts/{draftId}/users/{userId}
          * @secure
-         * @response `200` `void` Success
+         * @response `200` `UserDraft` Success
          */
-        integrationsLosCredentialsCreate: (data: CreateLosCredentials, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        getDraftUser: (draftId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<UserDraft, any>>;
         /**
          * No description
          *
-         * @tags TheBigPOS
-         * @name IntegrationsLosLoansDocumentsDetail
-         * @request GET:/api/integrations/los/loans/{loanID}/documents/{documentID}
+         * @tags UserDraft
+         * @name AddDraftUsers
+         * @summary Add draft user
+         * @request POST:/api/loans/drafts/{draftId}/users/{userId}
          * @secure
-         * @response `200` `void` Success
+         * @response `200` `UserDraft` Success
          */
-        integrationsLosLoansDocumentsDetail: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        addDraftUsers: (draftId: string, userId: string, data: CreateUserDraft, params?: RequestParams) => Promise<AxiosResponse<UserDraft, any>>;
         /**
          * No description
          *
-         * @tags TheBigPOS
-         * @name IntegrationsLosLoansDocumentsList
-         * @request GET:/api/integrations/los/loans/{loanID}/documents
+         * @tags UserDraft
+         * @name DeleteDraftUser
+         * @summary Delete draft user
+         * @request DELETE:/api/loans/drafts/{draftId}/users/{userId}
          * @secure
-         * @response `200` `void` Success
+         * @response `204` `void` No Content
          */
-        integrationsLosLoansDocumentsList: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
+        deleteDraftUser: (draftId: string, userId: string, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
         /**
          * No description
          *

package/dist/index.js

@@ -104,7 +104,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.20.4
+ * @version v2.20.6
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1776,6 +1776,17 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             inviteLoanContacts: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanLogs
+             * @name SearchLoanLogs
+             * @summary Search loan logs
+             * @request POST:/api/loans/{loanId}/logs/search
+             * @secure
+             * @response `200` `LoanLogPaginated` Success
+             */
+            searchLoanLogs: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/logs/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -2208,7 +2219,18 @@ export class Api extends HttpClient {
              * @secure
              * @response `201` `LoanUser` Created
              */
-            addLoanUser: (loanId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "POST", secure: true, format: "json" }, params)),
+            addLoanUser: (loanId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanUsers
+             * @name RemoveLoanUser
+             * @summary Remove User from Loan
+             * @request DELETE:/api/loans/{loanId}/users/{userId}
+             * @secure
+             * @response `204` `LoanUser` No Content
+             */
+            removeLoanUser: (loanId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/users/${userId}`, method: "DELETE", secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -2793,52 +2815,56 @@ export class Api extends HttpClient {
              * No description
              *
              * @tags TheBigPOS
-             * @name IntegrationsLosLoansLockedList
-             * @request GET:/api/integrations/los/loans/{loanID}/locked
+             * @name IntegrationsLosLoansUsersAssociateCreate
+             * @request POST:/api/integrations/los/loans/{loanID}/users/{email}/associate
              * @secure
              * @response `200` `void` Success
              */
-            integrationsLosLoansLockedList: (loanId, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans/${loanId}/locked`, method: "GET", secure: true }, params)),
+            integrationsLosLoansUsersAssociateCreate: (loanId, email, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans/${loanId}/users/${email}/associate`, method: "POST", secure: true }, params)),
             /**
              * No description
              *
-             * @tags TheBigPOS
-             * @name IntegrationsLosLoansBucketsList
-             * @request GET:/api/integrations/los/loans/{loanID}/buckets
+             * @tags UserDraft
+             * @name GetDraftUsers
+             * @summary Get draft users
+             * @request GET:/api/loans/drafts/{draftId}/users
              * @secure
-             * @response `200` `void` Success
+             * @response `200` `UserDraftPaginated` Success
              */
-            integrationsLosLoansBucketsList: (loanId, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans/${loanId}/buckets`, method: "GET", secure: true }, params)),
+            getDraftUsers: (draftId, query, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
-             * @tags TheBigPOS
-             * @name IntegrationsLosCredentialsCreate
-             * @request POST:/api/integrations/los/credentials
+             * @tags UserDraft
+             * @name GetDraftUser
+             * @summary Get draft user
+             * @request GET:/api/loans/drafts/{draftId}/users/{userId}
              * @secure
-             * @response `200` `void` Success
+             * @response `200` `UserDraft` Success
              */
-            integrationsLosCredentialsCreate: (data, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/credentials`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
+            getDraftUser: (draftId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "GET", secure: true, format: "json" }, params)),
             /**
              * No description
              *
-             * @tags TheBigPOS
-             * @name IntegrationsLosLoansDocumentsDetail
-             * @request GET:/api/integrations/los/loans/{loanID}/documents/{documentID}
+             * @tags UserDraft
+             * @name AddDraftUsers
+             * @summary Add draft user
+             * @request POST:/api/loans/drafts/{draftId}/users/{userId}
              * @secure
-             * @response `200` `void` Success
+             * @response `200` `UserDraft` Success
              */
-            integrationsLosLoansDocumentsDetail: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans/${loanId}/documents/${documentId}`, method: "GET", secure: true }, params)),
+            addDraftUsers: (draftId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
-             * @tags TheBigPOS
-             * @name IntegrationsLosLoansDocumentsList
-             * @request GET:/api/integrations/los/loans/{loanID}/documents
+             * @tags UserDraft
+             * @name DeleteDraftUser
+             * @summary Delete draft user
+             * @request DELETE:/api/loans/drafts/{draftId}/users/{userId}
              * @secure
-             * @response `200` `void` Success
+             * @response `204` `void` No Content
              */
-            integrationsLosLoansDocumentsList: (loanId, params = {}) => this.request(Object.assign({ path: `/api/integrations/los/loans/${loanId}/documents`, method: "GET", secure: true }, params)),
+            deleteDraftUser: (draftId, userId, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "DELETE", secure: true }, params)),
             /**
              * No description
              *