@matech/thebigpos-sdk 3.18.0 → 3.19.0

package/dist/index.js

@@ -95,7 +95,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.18.0
+ * @version v3.19.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -232,6 +232,19 @@ export class Api extends HttpClient {
              * @response `422` `ProblemDetails` Unprocessable Content
              */
             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)),
+            /**
+             * @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.
+             *
+             * @tags Accounts
+             * @name UpdateAccountPartnerPortal
+             * @summary Update partner portal switch
+             * @request PUT:/api/accounts/{id}/partner-portal
+             * @secure
+             * @response `200` `Account` OK
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `ProblemDetails` Unprocessable Content
+             */
+            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)),
             /**
              * No description
              *
@@ -2578,6 +2591,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
              * @secure
              * @response `204` `void` No Content
+             * @response `403` `HttpError` Forbidden
              */
             deleteFormSubmissionFile: (formSubmissionFileId, formSubmissionId, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`, method: "DELETE", secure: true }, params)),
             /**
@@ -2589,6 +2603,7 @@ export class Api extends HttpClient {
              * @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
              * @secure
              * @response `200` `FileWithBytes` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2600,6 +2615,7 @@ export class Api extends HttpClient {
              * @request GET:/api/form-submissions
              * @secure
              * @response `200` `FormSubmissionPaginated` OK
+             * @response `403` `HttpError` Forbidden
              */
             getFormSubmissions: (query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
@@ -2622,6 +2638,7 @@ export class Api extends HttpClient {
              * @request GET:/api/form-submissions/{id}
              * @secure
              * @response `200` `FormSubmission` OK
+             * @response `403` `HttpError` Forbidden
              */
             getFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "GET", secure: true, format: "json" }, params)),
             /**
@@ -2633,6 +2650,7 @@ export class Api extends HttpClient {
              * @request PUT:/api/form-submissions/{id}
              * @secure
              * @response `200` `FormSubmission` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2644,6 +2662,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/form-submissions/{id}
              * @secure
              * @response `204` `void` No Content
+             * @response `403` `HttpError` Forbidden
              */
             deleteFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "DELETE", secure: true }, params)),
             /**
@@ -2655,6 +2674,7 @@ export class Api extends HttpClient {
              * @request POST:/api/form-submissions/search
              * @secure
              * @response `200` `FormSubmissionPaginated` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2891,6 +2911,7 @@ export class Api extends HttpClient {
              * @request POST:/api/listings/{listingId}/files
              * @secure
              * @response `200` `ListingFile` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2902,6 +2923,7 @@ export class Api extends HttpClient {
              * @request PATCH:/api/listings/{listingId}/files
              * @secure
              * @response `200` `ListingFile` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2913,6 +2935,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/listings/{listingId}/files/{id}
              * @secure
              * @response `204` `Listing` No Content
+             * @response `403` `HttpError` Forbidden
              */
             removeListingFile: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
             /**
@@ -2924,6 +2947,7 @@ export class Api extends HttpClient {
              * @request POST:/api/listings/{listingId}/photos
              * @secure
              * @response `200` `ListingPhoto` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2935,6 +2959,7 @@ export class Api extends HttpClient {
              * @request PATCH:/api/listings/{listingId}/photos
              * @secure
              * @response `200` `(ListingPhoto)[]` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -2946,6 +2971,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/listings/{listingId}/photos/{id}
              * @secure
              * @response `204` `Listing` No Content
+             * @response `403` `HttpError` Forbidden
              */
             removeListingPhoto: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
             /**
@@ -3016,6 +3042,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/listings/{id}
              * @secure
              * @response `204` `void` No Content
+             * @response `403` `HttpError` Forbidden
              */
             deleteListing: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "DELETE", secure: true }, params)),
             /**
@@ -3038,6 +3065,7 @@ export class Api extends HttpClient {
              * @request PUT:/api/listings/{id}/background-image
              * @secure
              * @response `200` `File` OK
+             * @response `403` `HttpError` Forbidden
              */
             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)),
             /**
@@ -3049,6 +3077,7 @@ export class Api extends HttpClient {
              * @request DELETE:/api/listings/{id}/background-image
              * @secure
              * @response `204` `void` No Content
+             * @response `403` `HttpError` Forbidden
              */
             deleteListingBackgroundImage: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "DELETE", secure: true }, params)),
             /**
@@ -3372,7 +3401,7 @@ export class Api extends HttpClient {
              */
             getLoanDocumentFolderUsage: (id, params = {}) => this.request(Object.assign({ path: `/api/loan-document-folders/${id}/usage`, method: "GET", secure: true, format: "json" }, params)),
             /**
-             * @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.
+             * @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 as long as it is active — 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.
              *
              * @tags LoanDocumentFoldersForSingleLoan
              * @name ListLoanDocumentFolders
@@ -3634,6 +3663,76 @@ export class Api extends HttpClient {
              * @response `403` `ProblemDetails` Forbidden
              */
             getLoanFieldAccess: (params = {}) => this.request(Object.assign({ path: `/api/loan-fields/access`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanFields
+             * @name GetStandardLoanFields
+             * @summary List standard loan fields with effective access and settings
+             * @request GET:/api/loan-fields/standard
+             * @secure
+             * @response `200` `(StandardLoanField)[]` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            getStandardLoanFields: (params = {}) => this.request(Object.assign({ path: `/api/loan-fields/standard`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanFields
+             * @name SetLoanFieldPermissions
+             * @summary Set role access levels on one loan field
+             * @request PUT:/api/loan-fields/{fieldKey}/permissions
+             * @secure
+             * @response `204` `void` No Content
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            setLoanFieldPermissions: (fieldKey, data, params = {}) => this.request(Object.assign({ path: `/api/loan-fields/${fieldKey}/permissions`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanFields
+             * @name SetLoanFieldSettings
+             * @summary Set the AI setting on one loan field
+             * @request PUT:/api/loan-fields/{fieldKey}/settings
+             * @secure
+             * @response `204` `void` No Content
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            setLoanFieldSettings: (fieldKey, data, params = {}) => this.request(Object.assign({ path: `/api/loan-fields/${fieldKey}/settings`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanFields
+             * @name ResetLoanFieldOverrides
+             * @summary Reset one standard loan field to its seeded defaults
+             * @request DELETE:/api/loan-fields/{fieldKey}/overrides
+             * @secure
+             * @response `204` `void` No Content
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            resetLoanFieldOverrides: (fieldKey, params = {}) => this.request(Object.assign({ path: `/api/loan-fields/${fieldKey}/overrides`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanFields
+             * @name BulkLoanFieldOperation
+             * @summary Apply one operation to many loan fields
+             * @request POST:/api/loan-fields/bulk
+             * @secure
+             * @response `200` `BulkLoanFieldOperation` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `422` `UnprocessableEntity` Unprocessable Content
+             */
+            bulkLoanFieldOperation: (data, params = {}) => this.request(Object.assign({ path: `/api/loan-fields/bulk`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -4895,6 +4994,21 @@ export class Api extends HttpClient {
              * @response `200` `NotificationTemplateVersion` OK
              */
             deleteNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
+            /**
+             * @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
+             *
+             * @tags Partners
+             * @name UpdatePartnerLinkSlug
+             * @summary Update Partner Link Slug
+             * @request PUT:/api/partners/{realtorId}/link-slug
+             * @secure
+             * @response `200` `PartnerSlug` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `UnprocessableEntity` Unprocessable Content
+             */
+            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)),
             /**
              * No description
              *
@@ -6328,6 +6442,72 @@ export class Api extends HttpClient {
              * @response `204` `void` No Content
              */
             deleteRelationshipProspect: (id, params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships/prospects/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * @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
+             *
+             * @tags UsersMe
+             * @name GetMyPartners
+             * @summary Get My Partners
+             * @request GET:/api/users/me/partners
+             * @secure
+             * @response `200` `(MyPartner)[]` OK
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            getMyPartners: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partners`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UsersMe
+             * @name AddMyPartner
+             * @summary Add My Partner
+             * @request POST:/api/users/me/partners/{partnerId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            addMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "POST", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags UsersMe
+             * @name RemoveMyPartner
+             * @summary Remove My Partner
+             * @request DELETE:/api/users/me/partners/{partnerId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            removeMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "DELETE", secure: true }, params)),
+            /**
+             * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
+             *
+             * @tags UsersMe
+             * @name GetMyPartnerLinks
+             * @summary Get My Partner Links
+             * @request GET:/api/users/me/partner-links
+             * @secure
+             * @response `200` `PartnerLinks` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getMyPartnerLinks: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * @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.
+             *
+             * @tags UsersMe
+             * @name UpdateMyPartnerLinkSlug
+             * @summary Update My Partner Link Slug
+             * @request PUT:/api/users/me/partner-links/slug
+             * @secure
+             * @response `200` `PartnerLinks` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             * @response `409` `ProblemDetails` Conflict
+             * @response `422` `UnprocessableEntity` Unprocessable Content
+             */
+            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)),
             /**
              * No description
              *