@matech/thebigpos-sdk 2.38.3-rc1 → 2.39.0

package/dist/index.js

@@ -32,6 +32,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import axios from "axios";
 export var ContentType;
 (function (ContentType) {
+    ContentType["JsonPatch"] = "application/json-patch+json";
     ContentType["Json"] = "application/json";
     ContentType["JsonApi"] = "application/vnd.api+json";
     ContentType["FormData"] = "multipart/form-data";
@@ -103,7 +104,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.38.2
+ * @version v2.39.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -710,6 +711,94 @@ export class Api extends HttpClient {
              * @response `200` `(LoanOfficerPublic)[]` Success
              */
             getLoanOfficersByCorporate: (id, params = {}) => this.request(Object.assign({ path: `/api/corporates/${id}/loan-officers`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name GetCustomFieldDefinitions
+             * @summary Get all custom field definitions by entity type
+             * @request GET:/api/custom-field-definitions
+             * @secure
+             * @response `200` `(CustomFieldDefinition)[]` Success
+             */
+            getCustomFieldDefinitions: (query, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name CreateCustomFieldDefinition
+             * @summary Create a custom field definition
+             * @request POST:/api/custom-field-definitions
+             * @secure
+             * @response `201` `CustomFieldDefinition` Created
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Client Error
+             */
+            createCustomFieldDefinition: (data, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name GetCustomFieldDefinitionById
+             * @summary Get a custom field definition by ID
+             * @request GET:/api/custom-field-definitions/{id}
+             * @secure
+             * @response `200` `CustomFieldDefinition` Success
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getCustomFieldDefinitionById: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name UpdateCustomFieldDefinition
+             * @summary Update a custom field definition
+             * @request PUT:/api/custom-field-definitions/{id}
+             * @secure
+             * @response `200` `CustomFieldDefinition` Success
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Client Error
+             */
+            updateCustomFieldDefinition: (id, data, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name DeleteCustomFieldDefinition
+             * @summary Delete a custom field definition
+             * @request DELETE:/api/custom-field-definitions/{id}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            deleteCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name DisableCustomFieldDefinition
+             * @summary Disable a custom field definition
+             * @request POST:/api/custom-field-definitions/{id}/disable
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            disableCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}/disable`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CustomFieldDefinitions
+             * @name EnableCustomFieldDefinition
+             * @summary Enable a custom field definition
+             * @request POST:/api/custom-field-definitions/{id}/enable
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            enableCustomFieldDefinition: (id, params = {}) => this.request(Object.assign({ path: `/api/custom-field-definitions/${id}/enable`, method: "POST", secure: true }, params)),
             /**
              * No description
              *
@@ -1271,7 +1360,7 @@ export class Api extends HttpClient {
              * @response `200` `string` Success
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            updateLoanConsentAndCustomFieldsObsolete: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1282,7 +1371,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `GetReport` Success
              */
-            getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            getLoansReport: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/reports`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1296,7 +1385,7 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Client Error
              * @response `423` `UnprocessableEntity` Client Error
              */
-            createLoan: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            createLoan: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1309,7 +1398,7 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Client Error
              * @response `423` `UnprocessableEntity` Client Error
              */
-            createLoanInternal: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/internal`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            createLoanInternal: (data, query, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/internal`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1321,7 +1410,7 @@ export class Api extends HttpClient {
              * @response `200` `string` Success
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            updateLoanCustomFields: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/custom-fields`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1334,7 +1423,7 @@ export class Api extends HttpClient {
              * @response `202` `string` Accepted
              * @response `422` `UnprocessableEntity` Client Error
              */
-            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            updateLoanConsent: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/application/${loanId}/consent`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1412,7 +1501,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `DocumentDataRequest` Success
              */
-            createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            createLegacyLoanDocument: (data, params = {}) => this.request(Object.assign({ path: `/api/los/loan/generatedocument`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1448,7 +1537,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `ListingFile` Success
              */
-            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1481,7 +1570,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `(ListingPhoto)[]` Success
              */
-            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1514,7 +1603,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `201` `Listing` Created
              */
-            createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1547,7 +1636,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `Listing` Success
              */
-            replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1569,7 +1658,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `200` `ListingPaginated` Success
              */
-            searchListings: (data, query, params = {}) => this.request(Object.assign({ path: `/api/listings/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            searchListings: (data, query, params = {}) => this.request(Object.assign({ path: `/api/listings/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -1674,6 +1763,56 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Client Error
              */
             createLoanComparisonPdf: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/loan-comparison/pdf`, method: "POST", body: data, secure: true, type: ContentType.Json }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanCustomFieldValues
+             * @name GetLoanCustomFieldValues
+             * @summary Get all custom field values for a loan
+             * @request GET:/api/loans/{loanId}/custom-fields
+             * @secure
+             * @response `200` `(CustomFieldValue)[]` Success
+             */
+            getLoanCustomFieldValues: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanCustomFieldValues
+             * @name BulkSetLoanCustomFieldValues
+             * @summary Bulk set custom field values for a loan
+             * @request PUT:/api/loans/{loanId}/custom-fields
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `422` `ProblemDetails` Client Error
+             */
+            bulkSetLoanCustomFieldValues: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields`, method: "PUT", body: data, secure: true, type: ContentType.Json }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanCustomFieldValues
+             * @name SetLoanCustomFieldValue
+             * @summary Set a single custom field value
+             * @request PUT:/api/loans/{loanId}/custom-fields/{definitionId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Client Error
+             */
+            setLoanCustomFieldValue: (loanId, definitionId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields/${definitionId}`, method: "PUT", body: data, secure: true, type: ContentType.Json }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanCustomFieldValues
+             * @name DeleteLoanCustomFieldValue
+             * @summary Remove a custom field value
+             * @request DELETE:/api/loans/{loanId}/custom-fields/{definitionId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            deleteLoanCustomFieldValue: (loanId, definitionId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields/${definitionId}`, method: "DELETE", secure: true }, params)),
             /**
              * No description
              *
@@ -1708,6 +1847,18 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             getLoanDocument: (loanId, documentId, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanDocuments
+             * @name GetLoanDocumentPreviews
+             * @summary Get document previews in batch
+             * @request POST:/api/loans/{loanId}/documents/previews
+             * @secure
+             * @response `200` `Record<string,string>` Success
+             * @response `400` `ProblemDetails` Bad Request
+             */
+            getLoanDocumentPreviews: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/previews`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *
@@ -1738,7 +1889,7 @@ export class Api extends HttpClient {
              * @summary Download By ID
              * @request GET:/api/loans/{loanId}/documents/{documentId}/download
              * @secure
-             * @response `200` `Blob` Success
+             * @response `200` `string` Success
              * @response `404` `ProblemDetails` Not Found
              */
             downloadLoanDocument: (loanId, documentId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/documents/${documentId}/download`, method: "GET", secure: true, format: "json" }, params)),
@@ -2223,6 +2374,19 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags Loans
+             * @name TriggerAso
+             * @summary Trigger ASO services
+             * @request POST:/api/loans/{loanId}/aso
+             * @secure
+             * @response `200` `AutomatedService` Success
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             */
+            triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -2234,7 +2398,7 @@ export class Api extends HttpClient {
              * @response `200` `TaskCommentPaginated` Success
              * @response `404` `ProblemDetails` Not Found
              */
-            searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            searchLoanTaskComments: (loanId, userLoanTaskId, data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -2258,7 +2422,7 @@ export class Api extends HttpClient {
              * @response `201` `TaskComment` Created
              * @response `404` `ProblemDetails` Not Found
              */
-            createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            createLoanTaskComment: (loanId, userLoanTaskId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments`, method: "POST", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -2270,7 +2434,7 @@ export class Api extends HttpClient {
              * @response `200` `TaskComment` Success
              * @response `404` `ProblemDetails` Not Found
              */
-            replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
+            replaceLoanTaskComment: (loanId, userLoanTaskId, commentId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/tasks/${userLoanTaskId}/comments/${commentId}`, method: "PUT", body: data, secure: true, type: ContentType.JsonPatch, format: "json" }, params)),
             /**
              * No description
              *
@@ -3193,6 +3357,16 @@ export class Api extends HttpClient {
              * @response `204` `void` No Content
              */
             deleteEncompassWebhook: (webhookId, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/webhooks/${webhookId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags TheBigPOS
+             * @name SearchLosSyncs
+             * @request POST:/api/los/encompass/syncs/{loanId}/search
+             * @secure
+             * @response `200` `LosSyncPaginated` Success
+             */
+            searchLosSyncs: (loanId, query, data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/syncs/${loanId}/search`, method: "POST", query: query, body: data, secure: true, type: ContentType.Json, format: "json" }, params)),
             /**
              * No description
              *