@matech/thebigpos-sdk 3.14.0 → 3.15.0-dev-6023

package/dist/index.js

@@ -86,7 +86,13 @@ export class HttpClient {
             const property = input[key];
             const propertyContent = property instanceof Array ? property : [property];
             for (const formItem of propertyContent) {
-                const isFileType = formItem instanceof Blob || formItem instanceof File;
+                // React Native files are plain { uri, name, type } objects, not Blob/File.
+                const isReactNativeFile = !!formItem &&
+                    typeof formItem === "object" &&
+                    "uri" in formItem &&
+                    "name" in formItem &&
+                    "type" in formItem;
+                const isFileType = isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
                 formData.append(key, isFileType ? formItem : this.stringifyFormItem(formItem));
             }
             return formData;
@@ -95,7 +101,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.14.0
+ * @version v3.15.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -1423,6 +1429,46 @@ export class Api extends HttpClient {
              * @response `200` `BusinessRule` OK
              */
             restoreBusinessRule: (id, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}/restore`, method: "POST", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags Canvases
+             * @name GetCanvas
+             * @summary Get a site's canvas for one surface, as the signed-in user sees it
+             * @request GET:/api/canvases/{surface}
+             * @secure
+             * @response `200` `CanvasView` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            getCanvas: (surface, query, params = {}) => this.request(Object.assign({ path: `/api/canvases/${surface}`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * @description A standard field's key and every categoryKey never change: saved layouts refer to fields by key, and a client can translate labels and categories by these keys.
+             *
+             * @tags CanvasFields
+             * @name GetCanvasFields
+             * @summary Get the fields a canvas can show
+             * @request GET:/api/canvas/fields
+             * @secure
+             * @response `200` `CanvasFieldCatalog` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getCanvasFields: (params = {}) => this.request(Object.assign({ path: `/api/canvas/fields`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags CanvasWidgetTypes
+             * @name GetCanvasWidgetTypes
+             * @summary Get canvas widget types
+             * @request GET:/api/canvas/widget-types
+             * @secure
+             * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getCanvasWidgetTypes: (params = {}) => this.request(Object.assign({ path: `/api/canvas/widget-types`, method: "GET", secure: true, format: "json" }, params)),
             /**
              * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
              *
@@ -2643,6 +2689,20 @@ export class Api extends HttpClient {
              * @response `200` `FormVersion` OK
              */
             deleteFormVersion: (formId, id, params = {}) => this.request(Object.assign({ path: `/api/forms/${formId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags IncompleteLoans
+             * @name SearchIncompleteLoans
+             * @summary Search incomplete loans
+             * @request POST:/api/loans/incomplete/search
+             * @secure
+             * @response `200` `IncompleteLoanPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            searchIncompleteLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/incomplete/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2979,6 +3039,36 @@ export class Api extends HttpClient {
              * @response `200` `File` OK
              */
             getListingOpenHouseFlyer: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/open-house-flyer`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanApplicationRemoval
+             * @name RemoveLoanApplication
+             * @summary Remove a loan application nobody has submitted
+             * @request POST:/api/loans/{loanId}/application/remove
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            removeLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/remove`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanApplicationRemoval
+             * @name RestoreLoanApplication
+             * @summary Restore a removed loan application
+             * @request POST:/api/loans/{loanId}/application/restore
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            restoreLoanApplication: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/application/restore`, method: "POST", secure: true }, params)),
             /**
              * No description
              *
@@ -3003,6 +3093,21 @@ export class Api extends HttpClient {
              * @response `423` `UnprocessableEntity` Locked
              */
             runLoanCalculator: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/calculators/loan-calculator`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanCanvasFieldValues
+             * @name GetLoanCanvasFieldValues
+             * @summary Get a loan's values for canvas fields
+             * @request POST:/api/loans/{loanId}/canvas/field-values
+             * @secure
+             * @response `200` `CanvasFieldValues` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            getLoanCanvasFieldValues: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/canvas/field-values`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -3928,6 +4033,7 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `any` Conflict
              * @response `422` `UnprocessableEntity` Unprocessable Content
+             * @response `423` `ProblemDetails` Locked
              */
             updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -4010,6 +4116,7 @@ export class Api extends HttpClient {
              * @secure
              * @response `202` `void` Accepted
              * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
              */
             syncLoanToLos: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/sync-to-los`, method: "POST", secure: true }, params)),
             /**
@@ -4786,6 +4893,98 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             replacePartnerSiteConfiguration: (realtorId, siteConfigurationId, data, query, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/site-configurations/${siteConfigurationId}`, method: "PUT", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags SiteConfigurationCanvases
+             * @name GetSiteConfigurationCanvases
+             * @summary Get a site's canvases: own, inherited and effective per surface
+             * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
+             * @secure
+             * @response `200` `SiteConfigurationCanvases` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getSiteConfigurationCanvases: (siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @description The request is the canvas's whole state: leaving out forkedFromSiteConfigurationID and forkedFromVersion clears them, and isBehindInherited with them.
+             *
+             * @tags SiteConfigurationCanvases
+             * @name SaveSiteConfigurationCanvas
+             * @summary Save a site's canvas for one surface
+             * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
+             * @secure
+             * @response `200` `CanvasSurfaceState` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             * @response `423` `ProblemDetails` Locked
+             */
+            saveSiteConfigurationCanvas: (siteConfigurationId, surface, data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags SiteConfigurationCanvases
+             * @name DeleteSiteConfigurationCanvas
+             * @summary Delete a site's own canvas for a surface, its boards or its Loan Details tabs, so it inherits again
+             * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            deleteSiteConfigurationCanvas: (siteConfigurationId, surface, query, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`, method: "DELETE", query: query, secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags SiteConfigurationCanvases
+             * @name PreviewSiteConfigurationCanvas
+             * @summary Preview an unsaved canvas for one surface as a role would see it
+             * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
+             * @secure
+             * @response `200` `CanvasView` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            previewSiteConfigurationCanvas: (siteConfigurationId, surface, data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/preview`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags SiteConfigurationCanvases
+             * @name GetSiteConfigurationCanvasVersions
+             * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
+             * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
+             * @secure
+             * @response `200` `(CanvasVersion)[]` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            getSiteConfigurationCanvasVersions: (siteConfigurationId, surface, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags SiteConfigurationCanvases
+             * @name RestoreSiteConfigurationCanvasVersion
+             * @summary Restore a saved version of a site's canvas as a new version
+             * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
+             * @secure
+             * @response `200` `CanvasSurfaceState` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `ProblemDetails` Unprocessable Content
+             * @response `423` `ProblemDetails` Locked
+             */
+            restoreSiteConfigurationCanvasVersion: (siteConfigurationId, surface, version, data, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions/${version}/restore`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -5546,6 +5745,7 @@ export class Api extends HttpClient {
              * @response `204` `void` No Content
              * @response `404` `Error` Not Found
              * @response `422` `UnprocessableEntity` Unprocessable Content
+             * @response `429` `ProblemDetails` Too Many Requests
              */
             allowImpersonationWithGuid: (allowToken, params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/allow/${allowToken}`, method: "POST", secure: true }, params)),
             /**
@@ -5597,6 +5797,20 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             extendImpersonation: (params = {}) => this.request(Object.assign({ path: `/api/users/impersonation/extend`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags UserInviteAcceptance
+             * @name AcceptBorrowerInvite
+             * @summary Accept a borrower invite with the signed-in account
+             * @request POST:/api/users/invites/accept
+             * @secure
+             * @response `200` `AcceptedBorrowerInvite` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             */
+            acceptBorrowerInvite: (data, params = {}) => this.request(Object.assign({ path: `/api/users/invites/accept`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *