@matech/thebigpos-sdk 3.11.0 → 3.12.0-pr-5444-4828

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -101,7 +101,7 @@ export class HttpClient {
101
101
  }
102
102
  /**
103
103
  * @title The Big POS API
104
- * @version v3.11.0
104
+ * @version v3.12.0
105
105
  * @termsOfService https://www.thebigpos.com/terms-of-use/
106
106
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
107
107
  */
@@ -1413,6 +1413,46 @@ export class Api extends HttpClient {
1413
1413
  * @response `200` `BusinessRule` OK
1414
1414
  */
1415
1415
  restoreBusinessRule: (id, params = {}) => this.request(Object.assign({ path: `/api/business-rules/${id}/restore`, method: "POST", secure: true, format: "json" }, params)),
1416
+ /**
1417
+ * No description
1418
+ *
1419
+ * @tags Canvases
1420
+ * @name GetCanvas
1421
+ * @summary Get a site's canvas for one surface, as the signed-in user sees it
1422
+ * @request GET:/api/canvases/{surface}
1423
+ * @secure
1424
+ * @response `200` `CanvasView` OK
1425
+ * @response `400` `ProblemDetails` Bad Request
1426
+ * @response `404` `ProblemDetails` Not Found
1427
+ * @response `422` `ProblemDetails` Unprocessable Content
1428
+ */
1429
+ getCanvas: (surface, query, params = {}) => this.request(Object.assign({ path: `/api/canvases/${surface}`, method: "GET", query: query, secure: true, format: "json" }, params)),
1430
+ /**
1431
+ * No description
1432
+ *
1433
+ * @tags CanvasFields
1434
+ * @name GetCanvasFields
1435
+ * @summary Get the fields a canvas can show
1436
+ * @request GET:/api/canvas/fields
1437
+ * @secure
1438
+ * @response `200` `CanvasFieldCatalog` OK
1439
+ * @response `403` `ProblemDetails` Forbidden
1440
+ * @response `404` `ProblemDetails` Not Found
1441
+ */
1442
+ getCanvasFields: (params = {}) => this.request(Object.assign({ path: `/api/canvas/fields`, method: "GET", secure: true, format: "json" }, params)),
1443
+ /**
1444
+ * No description
1445
+ *
1446
+ * @tags CanvasWidgetTypes
1447
+ * @name GetCanvasWidgetTypes
1448
+ * @summary Get canvas widget types
1449
+ * @request GET:/api/canvas/widget-types
1450
+ * @secure
1451
+ * @response `200` `(CanvasWidgetTypeDescriptor)[]` OK
1452
+ * @response `403` `ProblemDetails` Forbidden
1453
+ * @response `404` `ProblemDetails` Not Found
1454
+ */
1455
+ getCanvasWidgetTypes: (params = {}) => this.request(Object.assign({ path: `/api/canvas/widget-types`, method: "GET", secure: true, format: "json" }, params)),
1416
1456
  /**
1417
1457
  * @description Returns closed loan counts per account within the specified date range, including POS vs non-POS breakdown and utilization ratios.
1418
1458
  *
@@ -3059,6 +3099,21 @@ export class Api extends HttpClient {
3059
3099
  * @response `423` `UnprocessableEntity` Locked
3060
3100
  */
3061
3101
  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)),
3102
+ /**
3103
+ * No description
3104
+ *
3105
+ * @tags LoanCanvasFieldValues
3106
+ * @name GetLoanCanvasFieldValues
3107
+ * @summary Get a loan's values for canvas fields
3108
+ * @request POST:/api/loans/{loanId}/canvas/field-values
3109
+ * @secure
3110
+ * @response `200` `CanvasFieldValues` OK
3111
+ * @response `400` `ProblemDetails` Bad Request
3112
+ * @response `403` `ProblemDetails` Forbidden
3113
+ * @response `404` `ProblemDetails` Not Found
3114
+ * @response `422` `ProblemDetails` Unprocessable Content
3115
+ */
3116
+ 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)),
3062
3117
  /**
3063
3118
  * No description
3064
3119
  *
@@ -4809,6 +4864,98 @@ export class Api extends HttpClient {
4809
4864
  * @response `422` `UnprocessableEntity` Unprocessable Content
4810
4865
  */
4811
4866
  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)),
4867
+ /**
4868
+ * No description
4869
+ *
4870
+ * @tags SiteConfigurationCanvases
4871
+ * @name GetSiteConfigurationCanvases
4872
+ * @summary Get a site's canvases: own, inherited and effective per surface
4873
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases
4874
+ * @secure
4875
+ * @response `200` `SiteConfigurationCanvases` OK
4876
+ * @response `403` `ProblemDetails` Forbidden
4877
+ * @response `404` `ProblemDetails` Not Found
4878
+ */
4879
+ getSiteConfigurationCanvases: (siteConfigurationId, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases`, method: "GET", secure: true, format: "json" }, params)),
4880
+ /**
4881
+ * No description
4882
+ *
4883
+ * @tags SiteConfigurationCanvases
4884
+ * @name SaveSiteConfigurationCanvas
4885
+ * @summary Save a site's canvas for one surface
4886
+ * @request PUT:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
4887
+ * @secure
4888
+ * @response `200` `CanvasSurfaceState` OK
4889
+ * @response `400` `ProblemDetails` Bad Request
4890
+ * @response `403` `ProblemDetails` Forbidden
4891
+ * @response `404` `ProblemDetails` Not Found
4892
+ * @response `409` `ProblemDetails` Conflict
4893
+ * @response `422` `ProblemDetails` Unprocessable Content
4894
+ * @response `423` `ProblemDetails` Locked
4895
+ */
4896
+ 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)),
4897
+ /**
4898
+ * No description
4899
+ *
4900
+ * @tags SiteConfigurationCanvases
4901
+ * @name DeleteSiteConfigurationCanvas
4902
+ * @summary Delete a site's own Home or Loan summary canvas so it inherits again
4903
+ * @request DELETE:/api/site-configurations/{siteConfigurationId}/canvases/{surface}
4904
+ * @secure
4905
+ * @response `204` `void` No Content
4906
+ * @response `400` `ProblemDetails` Bad Request
4907
+ * @response `403` `ProblemDetails` Forbidden
4908
+ * @response `404` `ProblemDetails` Not Found
4909
+ * @response `409` `ProblemDetails` Conflict
4910
+ * @response `422` `ProblemDetails` Unprocessable Content
4911
+ */
4912
+ deleteSiteConfigurationCanvas: (siteConfigurationId, surface, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}`, method: "DELETE", secure: true }, params)),
4913
+ /**
4914
+ * No description
4915
+ *
4916
+ * @tags SiteConfigurationCanvases
4917
+ * @name PreviewSiteConfigurationCanvas
4918
+ * @summary Preview an unsaved canvas for one surface as a role would see it
4919
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/preview
4920
+ * @secure
4921
+ * @response `200` `CanvasView` OK
4922
+ * @response `400` `ProblemDetails` Bad Request
4923
+ * @response `403` `ProblemDetails` Forbidden
4924
+ * @response `404` `ProblemDetails` Not Found
4925
+ * @response `422` `ProblemDetails` Unprocessable Content
4926
+ */
4927
+ 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)),
4928
+ /**
4929
+ * No description
4930
+ *
4931
+ * @tags SiteConfigurationCanvases
4932
+ * @name GetSiteConfigurationCanvasVersions
4933
+ * @summary Get the saved versions of a site's layout for a surface, newest first, including those from before a delete
4934
+ * @request GET:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions
4935
+ * @secure
4936
+ * @response `200` `(CanvasVersion)[]` OK
4937
+ * @response `403` `ProblemDetails` Forbidden
4938
+ * @response `404` `ProblemDetails` Not Found
4939
+ * @response `422` `ProblemDetails` Unprocessable Content
4940
+ */
4941
+ getSiteConfigurationCanvasVersions: (siteConfigurationId, surface, params = {}) => this.request(Object.assign({ path: `/api/site-configurations/${siteConfigurationId}/canvases/${surface}/versions`, method: "GET", secure: true, format: "json" }, params)),
4942
+ /**
4943
+ * No description
4944
+ *
4945
+ * @tags SiteConfigurationCanvases
4946
+ * @name RestoreSiteConfigurationCanvasVersion
4947
+ * @summary Restore a saved version of a site's canvas as a new version
4948
+ * @request POST:/api/site-configurations/{siteConfigurationId}/canvases/{surface}/versions/{version}/restore
4949
+ * @secure
4950
+ * @response `200` `CanvasSurfaceState` OK
4951
+ * @response `400` `ProblemDetails` Bad Request
4952
+ * @response `403` `ProblemDetails` Forbidden
4953
+ * @response `404` `ProblemDetails` Not Found
4954
+ * @response `409` `ProblemDetails` Conflict
4955
+ * @response `422` `ProblemDetails` Unprocessable Content
4956
+ * @response `423` `ProblemDetails` Locked
4957
+ */
4958
+ 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)),
4812
4959
  /**
4813
4960
  * No description
4814
4961
  *