@matech/thebigpos-sdk 2.48.0-rc6 → 2.49.0-rc0

package/dist/index.js

@@ -95,7 +95,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.48.0
+ * @version v2.49.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1316,6 +1316,173 @@ export class Api extends HttpClient {
              * @response `200` `ClosedLoansReport` OK
              */
             getClosedLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/reports/closed-loans`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocumentFolders
+             * @name GetCompanyDocumentFolders
+             * @summary Get all company document folders
+             * @request GET:/api/company-document-folders
+             * @secure
+             * @response `200` `(CompanyDocumentFolder)[]` OK
+             */
+            getCompanyDocumentFolders: (params = {}) => this.request(Object.assign({ path: `/api/company-document-folders`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocumentFolders
+             * @name CreateCompanyDocumentFolder
+             * @summary Create company document folder
+             * @request POST:/api/company-document-folders
+             * @secure
+             * @response `201` `CompanyDocumentFolder` Created
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `409` `ProblemDetails` Conflict
+             */
+            createCompanyDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocumentFolders
+             * @name GetCompanyDocumentFolder
+             * @summary Get company document folder by ID
+             * @request GET:/api/company-document-folders/{id}
+             * @secure
+             * @response `200` `CompanyDocumentFolder` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getCompanyDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocumentFolders
+             * @name UpdateCompanyDocumentFolder
+             * @summary Update company document folder
+             * @request PUT:/api/company-document-folders/{id}
+             * @secure
+             * @response `200` `CompanyDocumentFolder` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            updateCompanyDocumentFolder: (id, data, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocumentFolders
+             * @name DeleteCompanyDocumentFolder
+             * @summary Delete company document folder
+             * @request DELETE:/api/company-document-folders/{id}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            deleteCompanyDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/company-document-folders/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name SearchCompanyDocuments
+             * @summary Search company documents
+             * @request POST:/api/company-documents/search
+             * @secure
+             * @response `200` `CompanyDocumentPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             */
+            searchCompanyDocuments: (data, query, params = {}) => this.request(Object.assign({ path: `/api/company-documents/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name GetCompanyDocument
+             * @summary Get company document by ID
+             * @request GET:/api/company-documents/{id}
+             * @secure
+             * @response `200` `CompanyDocument` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name UpdateCompanyDocument
+             * @summary Update company document
+             * @request PUT:/api/company-documents/{id}
+             * @secure
+             * @response `200` `CompanyDocument` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            updateCompanyDocument: (id, data, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name DeleteCompanyDocument
+             * @summary Delete company document
+             * @request DELETE:/api/company-documents/{id}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            deleteCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name DownloadCompanyDocument
+             * @summary Download company document
+             * @request GET:/api/company-documents/{id}/download
+             * @secure
+             * @response `200` `void` OK
+             * @response `404` `ProblemDetails` Not Found
+             */
+            downloadCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}/download`, method: "GET", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name CreateCompanyDocument
+             * @summary Upload company document
+             * @request POST:/api/company-documents
+             * @secure
+             * @response `201` `CompanyDocument` Created
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            createCompanyDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/company-documents`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name CreateCompanyTextDocument
+             * @summary Create free-form text company document
+             * @request POST:/api/company-documents/text
+             * @secure
+             * @response `201` `CompanyDocument` Created
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            createCompanyTextDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/company-documents/text`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name ReindexCompanyDocument
+             * @summary Re-index a failed company document
+             * @request POST:/api/company-documents/{id}/reindex
+             * @secure
+             * @response `200` `CompanyDocument` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             */
+            reindexCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}/reindex`, method: "POST", secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -1624,6 +1791,7 @@ export class Api extends HttpClient {
              * @name GetDocumentBuckets
              * @summary Get All
              * @request GET:/api/document-buckets
+             * @deprecated
              * @secure
              * @response `200` `(string)[]` OK
              */
@@ -2674,45 +2842,22 @@ export class Api extends HttpClient {
              * @name GetLoanDocumentBuckets
              * @summary Get All
              * @request GET:/api/loans/{loanId}/documents/buckets
+             * @deprecated
              * @secure
              * @response `200` `(string)[]` OK
              */
             getLoanDocumentBuckets: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/buckets`, method: "GET", secure: true, format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags LoanDocumentBuckets
-             * @name CreateLoanDocumentBuckets
-             * @summary Create
-             * @request POST:/api/loans/{loanId}/documents/buckets
-             * @secure
-             * @response `201` `(string)[]` Created
-             */
-            createLoanDocumentBuckets: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/buckets`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
              * @tags LoanDocumentFolders
-             * @name GetAllLoanDocumentFolders
-             * @summary Get all loan document folders for the current account
-             * @request GET:/api/loan-document-folders
+             * @name SearchLoanDocumentFolders
+             * @summary Search loan document folders for the current account
+             * @request POST:/api/loan-document-folders/search
              * @secure
-             * @response `200` `(LoanDocumentFolder)[]` OK
+             * @response `200` `LoanDocumentFolderPaginated` OK
              */
-            getAllLoanDocumentFolders: (params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "GET", secure: true, format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags LoanDocumentFolders
-             * @name CreateLoanDocumentFolder
-             * @summary Create a loan document folder
-             * @request POST:/api/loan-document-folders
-             * @secure
-             * @response `201` `LoanDocumentFolder` Created
-             * @response `409` `ProblemDetails` Conflict
-             * @response `422` `ProblemDetails` Unprocessable Content
-             */
-            createLoanDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            searchLoanDocumentFolders: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2754,6 +2899,19 @@ export class Api extends HttpClient {
              * @response `409` `ProblemDetails` Conflict
              */
             deleteLoanDocumentFolder: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanDocumentFolders
+             * @name CreateLoanDocumentFolder
+             * @summary Create a loan document folder
+             * @request POST:/api/loan-document-folders
+             * @secure
+             * @response `201` `LoanDocumentFolder` Created
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            createLoanDocumentFolder: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2791,6 +2949,29 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description Returns each folder that holds at least one document the caller can read, with the document count per folder. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID).
+             *
+             * @tags LoanDocumentFoldersForSingleLoan
+             * @name ListLoanDocumentFolders
+             * @summary Get the loan's document folders
+             * @request GET:/api/loans/{loanId}/document-folders
+             * @secure
+             * @response `200` `(LoanDocumentFolderWithCount)[]` OK
+             */
+            listLoanDocumentFolders: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/document-folders`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description Deprecated — use GET documents/folders. Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get a simplified response with folder names and counts for mobile (Files array will be empty).
+             *
+             * @tags LoanDocumentFoldersForSingleLoan
+             * @name GetLoanDocumentFolders
+             * @summary [Deprecated] Get document folder hierarchy
+             * @request POST:/api/loans/{loanId}/documents/folders
+             * @deprecated
+             * @secure
+             * @response `200` `(DocumentFolder)[]` OK
+             */
+            getLoanDocumentFolders: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2826,17 +3007,6 @@ export class Api extends HttpClient {
              * @response `200` `LoanDocumentSearchPaginated` OK
              */
             searchLoanDocuments: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * @description Returns all documents grouped by folder for sidebar display. Use folderNamesOnly=true to get simplified response with folder names and counts for mobile (Files array will be empty).
-             *
-             * @tags LoanDocuments
-             * @name GetLoanDocumentFolders
-             * @summary Get document folder hierarchy
-             * @request POST:/api/loans/{loanId}/documents/folders
-             * @secure
-             * @response `200` `(DocumentFolder)[]` OK
-             */
-            getLoanDocumentFolders: (loanId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/folders`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -4607,6 +4777,8 @@ export class Api extends HttpClient {
              * @request POST:/api/loans/drafts/{draftId}/users/{userId}
              * @secure
              * @response `200` `UserDraft` OK
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
              */
             addDraftUsers: (draftId, userId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/drafts/${draftId}/users/${userId}`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**