@matech/thebigpos-sdk 3.18.0-dev-6750 → 3.18.0-main-6759
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.d.ts +517 -680
- package/dist/index.js +1 -111
- package/dist/index.js.map +1 -1
- package/package.json +9 -4
- package/src/index.ts +17 -260
package/dist/index.js
CHANGED
|
@@ -238,19 +238,6 @@ export class Api extends HttpClient {
|
|
|
238
238
|
* @response `422` `ProblemDetails` Unprocessable Content
|
|
239
239
|
*/
|
|
240
240
|
updateAccountBilling: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/billing`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
241
|
-
/**
|
|
242
|
-
* @description Turns the account's partner portal on or off. While Partner-lite is on for the account, off refuses its realtors' leads and listings and the creation of partner sites.
|
|
243
|
-
*
|
|
244
|
-
* @tags Accounts
|
|
245
|
-
* @name UpdateAccountPartnerPortal
|
|
246
|
-
* @summary Update partner portal switch
|
|
247
|
-
* @request PUT:/api/accounts/{id}/partner-portal
|
|
248
|
-
* @secure
|
|
249
|
-
* @response `200` `Account` OK
|
|
250
|
-
* @response `404` `ProblemDetails` Not Found
|
|
251
|
-
* @response `422` `ProblemDetails` Unprocessable Content
|
|
252
|
-
*/
|
|
253
|
-
updateAccountPartnerPortal: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/partner-portal`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
254
241
|
/**
|
|
255
242
|
* No description
|
|
256
243
|
*
|
|
@@ -2597,7 +2584,6 @@ export class Api extends HttpClient {
|
|
|
2597
2584
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
2598
2585
|
* @secure
|
|
2599
2586
|
* @response `204` `void` No Content
|
|
2600
|
-
* @response `403` `HttpError` Forbidden
|
|
2601
2587
|
*/
|
|
2602
2588
|
deleteFormSubmissionFile: (formSubmissionFileId, formSubmissionId, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`, method: "DELETE", secure: true }, params)),
|
|
2603
2589
|
/**
|
|
@@ -2609,7 +2595,6 @@ export class Api extends HttpClient {
|
|
|
2609
2595
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
2610
2596
|
* @secure
|
|
2611
2597
|
* @response `200` `FileWithBytes` OK
|
|
2612
|
-
* @response `403` `HttpError` Forbidden
|
|
2613
2598
|
*/
|
|
2614
2599
|
downloadFormSubmissionFile: (formSubmissionFileId, formSubmissionId, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2615
2600
|
/**
|
|
@@ -2621,7 +2606,6 @@ export class Api extends HttpClient {
|
|
|
2621
2606
|
* @request GET:/api/form-submissions
|
|
2622
2607
|
* @secure
|
|
2623
2608
|
* @response `200` `FormSubmissionPaginated` OK
|
|
2624
|
-
* @response `403` `HttpError` Forbidden
|
|
2625
2609
|
*/
|
|
2626
2610
|
getFormSubmissions: (query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2627
2611
|
/**
|
|
@@ -2644,7 +2628,6 @@ export class Api extends HttpClient {
|
|
|
2644
2628
|
* @request GET:/api/form-submissions/{id}
|
|
2645
2629
|
* @secure
|
|
2646
2630
|
* @response `200` `FormSubmission` OK
|
|
2647
|
-
* @response `403` `HttpError` Forbidden
|
|
2648
2631
|
*/
|
|
2649
2632
|
getFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2650
2633
|
/**
|
|
@@ -2656,7 +2639,6 @@ export class Api extends HttpClient {
|
|
|
2656
2639
|
* @request PUT:/api/form-submissions/{id}
|
|
2657
2640
|
* @secure
|
|
2658
2641
|
* @response `200` `FormSubmission` OK
|
|
2659
|
-
* @response `403` `HttpError` Forbidden
|
|
2660
2642
|
*/
|
|
2661
2643
|
replaceFormSubmission: (id, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2662
2644
|
/**
|
|
@@ -2668,7 +2650,6 @@ export class Api extends HttpClient {
|
|
|
2668
2650
|
* @request DELETE:/api/form-submissions/{id}
|
|
2669
2651
|
* @secure
|
|
2670
2652
|
* @response `204` `void` No Content
|
|
2671
|
-
* @response `403` `HttpError` Forbidden
|
|
2672
2653
|
*/
|
|
2673
2654
|
deleteFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "DELETE", secure: true }, params)),
|
|
2674
2655
|
/**
|
|
@@ -2680,7 +2661,6 @@ export class Api extends HttpClient {
|
|
|
2680
2661
|
* @request POST:/api/form-submissions/search
|
|
2681
2662
|
* @secure
|
|
2682
2663
|
* @response `200` `FormSubmissionPaginated` OK
|
|
2683
|
-
* @response `403` `HttpError` Forbidden
|
|
2684
2664
|
*/
|
|
2685
2665
|
searchFormSubmissions: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2686
2666
|
/**
|
|
@@ -2917,7 +2897,6 @@ export class Api extends HttpClient {
|
|
|
2917
2897
|
* @request POST:/api/listings/{listingId}/files
|
|
2918
2898
|
* @secure
|
|
2919
2899
|
* @response `200` `ListingFile` OK
|
|
2920
|
-
* @response `403` `HttpError` Forbidden
|
|
2921
2900
|
*/
|
|
2922
2901
|
addListingFile: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
2923
2902
|
/**
|
|
@@ -2929,7 +2908,6 @@ export class Api extends HttpClient {
|
|
|
2929
2908
|
* @request PATCH:/api/listings/{listingId}/files
|
|
2930
2909
|
* @secure
|
|
2931
2910
|
* @response `200` `ListingFile` OK
|
|
2932
|
-
* @response `403` `HttpError` Forbidden
|
|
2933
2911
|
*/
|
|
2934
2912
|
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2935
2913
|
/**
|
|
@@ -2941,7 +2919,6 @@ export class Api extends HttpClient {
|
|
|
2941
2919
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
2942
2920
|
* @secure
|
|
2943
2921
|
* @response `204` `Listing` No Content
|
|
2944
|
-
* @response `403` `HttpError` Forbidden
|
|
2945
2922
|
*/
|
|
2946
2923
|
removeListingFile: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2947
2924
|
/**
|
|
@@ -2953,7 +2930,6 @@ export class Api extends HttpClient {
|
|
|
2953
2930
|
* @request POST:/api/listings/{listingId}/photos
|
|
2954
2931
|
* @secure
|
|
2955
2932
|
* @response `200` `ListingPhoto` OK
|
|
2956
|
-
* @response `403` `HttpError` Forbidden
|
|
2957
2933
|
*/
|
|
2958
2934
|
addListingPhoto: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
2959
2935
|
/**
|
|
@@ -2965,7 +2941,6 @@ export class Api extends HttpClient {
|
|
|
2965
2941
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
2966
2942
|
* @secure
|
|
2967
2943
|
* @response `200` `(ListingPhoto)[]` OK
|
|
2968
|
-
* @response `403` `HttpError` Forbidden
|
|
2969
2944
|
*/
|
|
2970
2945
|
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2971
2946
|
/**
|
|
@@ -2977,7 +2952,6 @@ export class Api extends HttpClient {
|
|
|
2977
2952
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
2978
2953
|
* @secure
|
|
2979
2954
|
* @response `204` `Listing` No Content
|
|
2980
|
-
* @response `403` `HttpError` Forbidden
|
|
2981
2955
|
*/
|
|
2982
2956
|
removeListingPhoto: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2983
2957
|
/**
|
|
@@ -3048,7 +3022,6 @@ export class Api extends HttpClient {
|
|
|
3048
3022
|
* @request DELETE:/api/listings/{id}
|
|
3049
3023
|
* @secure
|
|
3050
3024
|
* @response `204` `void` No Content
|
|
3051
|
-
* @response `403` `HttpError` Forbidden
|
|
3052
3025
|
*/
|
|
3053
3026
|
deleteListing: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "DELETE", secure: true }, params)),
|
|
3054
3027
|
/**
|
|
@@ -3071,7 +3044,6 @@ export class Api extends HttpClient {
|
|
|
3071
3044
|
* @request PUT:/api/listings/{id}/background-image
|
|
3072
3045
|
* @secure
|
|
3073
3046
|
* @response `200` `File` OK
|
|
3074
|
-
* @response `403` `HttpError` Forbidden
|
|
3075
3047
|
*/
|
|
3076
3048
|
updateListingBackgroundImage: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "PUT", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
3077
3049
|
/**
|
|
@@ -3083,7 +3055,6 @@ export class Api extends HttpClient {
|
|
|
3083
3055
|
* @request DELETE:/api/listings/{id}/background-image
|
|
3084
3056
|
* @secure
|
|
3085
3057
|
* @response `204` `void` No Content
|
|
3086
|
-
* @response `403` `HttpError` Forbidden
|
|
3087
3058
|
*/
|
|
3088
3059
|
deleteListingBackgroundImage: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "DELETE", secure: true }, params)),
|
|
3089
3060
|
/**
|
|
@@ -3407,7 +3378,7 @@ export class Api extends HttpClient {
|
|
|
3407
3378
|
*/
|
|
3408
3379
|
getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
|
|
3409
3380
|
/**
|
|
3410
|
-
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty
|
|
3381
|
+
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
|
|
3411
3382
|
*
|
|
3412
3383
|
* @tags LoanDocumentFoldersForSingleLoan
|
|
3413
3384
|
* @name ListLoanDocumentFolders
|
|
@@ -4930,21 +4901,6 @@ export class Api extends HttpClient {
|
|
|
4930
4901
|
* @response `200` `NotificationTemplateVersion` OK
|
|
4931
4902
|
*/
|
|
4932
4903
|
deleteNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
4933
|
-
/**
|
|
4934
|
-
* @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
|
|
4935
|
-
*
|
|
4936
|
-
* @tags Partners
|
|
4937
|
-
* @name UpdatePartnerLinkSlug
|
|
4938
|
-
* @summary Update Partner Link Slug
|
|
4939
|
-
* @request PUT:/api/partners/{realtorId}/link-slug
|
|
4940
|
-
* @secure
|
|
4941
|
-
* @response `200` `PartnerSlug` OK
|
|
4942
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
4943
|
-
* @response `404` `ProblemDetails` Not Found
|
|
4944
|
-
* @response `409` `ProblemDetails` Conflict
|
|
4945
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
4946
|
-
*/
|
|
4947
|
-
updatePartnerLinkSlug: (realtorId, data, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/link-slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4948
4904
|
/**
|
|
4949
4905
|
* No description
|
|
4950
4906
|
*
|
|
@@ -6378,72 +6334,6 @@ export class Api extends HttpClient {
|
|
|
6378
6334
|
* @response `204` `void` No Content
|
|
6379
6335
|
*/
|
|
6380
6336
|
deleteRelationshipProspect: (id, params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships/prospects/${id}`, method: "DELETE", secure: true }, params)),
|
|
6381
|
-
/**
|
|
6382
|
-
* @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
|
|
6383
|
-
*
|
|
6384
|
-
* @tags UsersMe
|
|
6385
|
-
* @name GetMyPartners
|
|
6386
|
-
* @summary Get My Partners
|
|
6387
|
-
* @request GET:/api/users/me/partners
|
|
6388
|
-
* @secure
|
|
6389
|
-
* @response `200` `(MyPartner)[]` OK
|
|
6390
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6391
|
-
*/
|
|
6392
|
-
getMyPartners: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partners`, method: "GET", secure: true, format: "json" }, params)),
|
|
6393
|
-
/**
|
|
6394
|
-
* No description
|
|
6395
|
-
*
|
|
6396
|
-
* @tags UsersMe
|
|
6397
|
-
* @name AddMyPartner
|
|
6398
|
-
* @summary Add My Partner
|
|
6399
|
-
* @request POST:/api/users/me/partners/{partnerId}
|
|
6400
|
-
* @secure
|
|
6401
|
-
* @response `204` `void` No Content
|
|
6402
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6403
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6404
|
-
*/
|
|
6405
|
-
addMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "POST", secure: true }, params)),
|
|
6406
|
-
/**
|
|
6407
|
-
* No description
|
|
6408
|
-
*
|
|
6409
|
-
* @tags UsersMe
|
|
6410
|
-
* @name RemoveMyPartner
|
|
6411
|
-
* @summary Remove My Partner
|
|
6412
|
-
* @request DELETE:/api/users/me/partners/{partnerId}
|
|
6413
|
-
* @secure
|
|
6414
|
-
* @response `204` `void` No Content
|
|
6415
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6416
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6417
|
-
*/
|
|
6418
|
-
removeMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "DELETE", secure: true }, params)),
|
|
6419
|
-
/**
|
|
6420
|
-
* @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
|
|
6421
|
-
*
|
|
6422
|
-
* @tags UsersMe
|
|
6423
|
-
* @name GetMyPartnerLinks
|
|
6424
|
-
* @summary Get My Partner Links
|
|
6425
|
-
* @request GET:/api/users/me/partner-links
|
|
6426
|
-
* @secure
|
|
6427
|
-
* @response `200` `PartnerLinks` OK
|
|
6428
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6429
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6430
|
-
*/
|
|
6431
|
-
getMyPartnerLinks: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links`, method: "GET", secure: true, format: "json" }, params)),
|
|
6432
|
-
/**
|
|
6433
|
-
* @description Changes the short name the partner's links carry and returns the links rebuilt with it. Links shared with the previous name stop working.
|
|
6434
|
-
*
|
|
6435
|
-
* @tags UsersMe
|
|
6436
|
-
* @name UpdateMyPartnerLinkSlug
|
|
6437
|
-
* @summary Update My Partner Link Slug
|
|
6438
|
-
* @request PUT:/api/users/me/partner-links/slug
|
|
6439
|
-
* @secure
|
|
6440
|
-
* @response `200` `PartnerLinks` OK
|
|
6441
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
6442
|
-
* @response `404` `ProblemDetails` Not Found
|
|
6443
|
-
* @response `409` `ProblemDetails` Conflict
|
|
6444
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6445
|
-
*/
|
|
6446
|
-
updateMyPartnerLinkSlug: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links/slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6447
6337
|
/**
|
|
6448
6338
|
* No description
|
|
6449
6339
|
*
|