@matech/thebigpos-sdk 2.49.0-rc0 → 2.49.3-rc1

package/dist/index.js

@@ -95,7 +95,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v2.49.0
+ * @version v2.49.3
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -171,29 +171,6 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             updateSiteConfigurationForAccount: (data, params = {}) => this.request(Object.assign({ path: `/api/account/site-configurations`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags AccountReactivation
-             * @name RequestAccountReactivation
-             * @summary Request account reactivation
-             * @request POST:/api/account/reactivation/request
-             * @secure
-             * @response `204` `void` No Content
-             */
-            requestAccountReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/account/reactivation/request`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
-            /**
-             * No description
-             *
-             * @tags AccountReactivation
-             * @name CompleteAccountReactivation
-             * @summary Complete account reactivation with new password
-             * @request POST:/api/account/reactivation/complete
-             * @secure
-             * @response `204` `void` No Content
-             * @response `400` `ProblemDetails` Bad Request
-             */
-            completeAccountReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/account/reactivation/complete`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *
@@ -1059,7 +1036,7 @@ export class Api extends HttpClient {
              * @summary Get Token
              * @request POST:/api/token
              * @secure
-             * @response `200` `AccountDeactivated` OK
+             * @response `200` `UserDeactivated` OK
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             getToken: (data, params = {}) => this.request(Object.assign({ path: `/api/token`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
@@ -1071,7 +1048,7 @@ export class Api extends HttpClient {
              * @summary Get Token From Challenge Code
              * @request POST:/api/token/code
              * @secure
-             * @response `200` `AccountDeactivated` OK
+             * @response `200` `UserDeactivated` OK
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             getTokenFromChallengeCode: (data, params = {}) => this.request(Object.assign({ path: `/api/token/code`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
@@ -1403,7 +1380,7 @@ export class Api extends HttpClient {
              * @response `200` `CompanyDocument` OK
              * @response `404` `ProblemDetails` Not Found
              */
-            getCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "GET", secure: true, format: "json" }, params)),
+            getCompanyDocument: (id, query, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -1430,6 +1407,18 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             deleteCompanyDocument: (id, params = {}) => this.request(Object.assign({ path: `/api/company-documents/${id}`, method: "DELETE", secure: true }, params)),
+            /**
+             * No description
+             *
+             * @tags CompanyDocuments
+             * @name GetCompanyDocumentPreviews
+             * @summary Get company document previews in batch
+             * @request POST:/api/company-documents/previews
+             * @secure
+             * @response `200` `Record<string,string>` OK
+             * @response `400` `ProblemDetails` Bad Request
+             */
+            getCompanyDocumentPreviews: (data, params = {}) => this.request(Object.assign({ path: `/api/company-documents/previews`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2068,6 +2057,143 @@ export class Api extends HttpClient {
              * @response `500` `EncompassError` Internal Server Error
              */
             createEncompassSession: (data, params = {}) => this.request(Object.assign({ path: `/api/los/encompass/eclose/sessions`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name SearchEncompassIntegrations
+             * @summary Search registered Encompass integrations across accounts (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/search
+             * @secure
+             * @response `200` `LosIntegrationPaginated` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            searchEncompassIntegrations: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name GetEncompassIntegrationsSummary
+             * @summary Summarize registered Encompass integration health across accounts (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/summary
+             * @secure
+             * @response `200` `LosIntegrationsSummary` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            getEncompassIntegrationsSummary: (data, query, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/summary`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name GetEncompassIntegrationsHealth
+             * @summary Get Encompass login health for a set of accounts (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/health
+             * @secure
+             * @response `200` `(LosCredentialHealth)[]` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            getEncompassIntegrationsHealth: (data, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/health`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name RecheckEncompassIntegrationHealth
+             * @summary Force a fresh Encompass login health check for one account (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/{accountId}/health/recheck
+             * @secure
+             * @response `200` `LosCredentialHealth` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            recheckEncompassIntegrationHealth: (accountId, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/health/recheck`, method: "POST", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name GetEncompassIntegrationsWebhooks
+             * @summary Get registered-versus-expected Encompass webhooks for a set of accounts (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/webhooks
+             * @secure
+             * @response `200` `(LosWebhookInventory)[]` OK
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            getEncompassIntegrationsWebhooks: (data, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/webhooks`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name RecheckEncompassIntegrationWebhooks
+             * @summary Force a fresh Encompass webhook inventory read for one account (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/recheck
+             * @secure
+             * @response `200` `LosWebhookInventory` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            recheckEncompassIntegrationWebhooks: (accountId, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/recheck`, method: "POST", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name GetEncompassIntegrationCredentials
+             * @summary Get Encompass credentials including secrets for a specific account (SuperAdmin)
+             * @request GET:/api/monitoring/encompass-integrations/{accountId}/credentials
+             * @secure
+             * @response `200` `LosIntegrationCredentials` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            getEncompassIntegrationCredentials: (accountId, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/credentials`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name UpdateEncompassIntegrationCredentials
+             * @summary Update Encompass credentials for a specific account (SuperAdmin)
+             * @request PUT:/api/monitoring/encompass-integrations/{accountId}/credentials
+             * @secure
+             * @response `200` `EncompassCredentialsDetail` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            updateEncompassIntegrationCredentials: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/credentials`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name RegisterEncompassIntegrationWebhook
+             * @summary Register an expected Encompass webhook for a specific account (SuperAdmin)
+             * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks
+             * @secure
+             * @response `201` `LosWebhook` Created
+             * @response `400` `ProblemDetails` Bad Request
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             */
+            registerEncompassIntegrationWebhook: (accountId, data, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags EncompassIntegrations
+             * @name DeleteEncompassIntegrationWebhook
+             * @summary Delete an Encompass webhook for a specific account (SuperAdmin)
+             * @request DELETE:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookId}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `401` `ProblemDetails` Unauthorized
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `404` `ProblemDetails` Not Found
+             */
+            deleteEncompassIntegrationWebhook: (accountId, webhookId, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/${webhookId}`, method: "DELETE", secure: true }, params)),
             /**
              * No description
              *
@@ -3263,6 +3389,18 @@ export class Api extends HttpClient {
              * @response `404` `ProblemDetails` Not Found
              */
             inviteLoanContacts: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags LoanInvites
+             * @name DeleteLoanInvite
+             * @summary Delete Invite
+             * @request DELETE:/api/loans/{loanId}/invites/{id}
+             * @secure
+             * @response `204` `void` No Content
+             * @response `404` `ProblemDetails` Not Found
+             */
+            deleteLoanInvite: (loanId, id, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/invites/${id}`, method: "DELETE", secure: true }, params)),
             /**
              * No description
              *
@@ -5022,6 +5160,7 @@ export class Api extends HttpClient {
              * @request PUT:/api/users/invites/{id}/resend
              * @secure
              * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
              * @response `401` `UnprocessableEntity` Unauthorized
              * @response `404` `UnprocessableEntity` Not Found
              */
@@ -5035,9 +5174,33 @@ export class Api extends HttpClient {
              * @request GET:/api/users/invites/{token}/verify
              * @secure
              * @response `200` `Invite` OK
+             * @response `400` `ProblemDetails` Bad Request
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             verifyUserInvite: (token, params = {}) => this.request(Object.assign({ path: `/api/users/invites/${token}/verify`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserReactivation
+             * @name RequestUserReactivation
+             * @summary Request user reactivation
+             * @request POST:/api/users/reactivation/request
+             * @secure
+             * @response `204` `void` No Content
+             */
+            requestUserReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/reactivation/request`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UserReactivation
+             * @name CompleteUserReactivation
+             * @summary Complete user reactivation with new password
+             * @request POST:/api/users/reactivation/complete
+             * @secure
+             * @response `204` `void` No Content
+             * @response `400` `ProblemDetails` Bad Request
+             */
+            completeUserReactivation: (data, params = {}) => this.request(Object.assign({ path: `/api/users/reactivation/complete`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
             /**
              * No description
              *
@@ -5102,6 +5265,7 @@ export class Api extends HttpClient {
              * @request POST:/api/users
              * @secure
              * @response `200` `DetailedUser` OK
+             * @response `409` `ProblemDetails` Conflict
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             createUser: (data, params = {}) => this.request(Object.assign({ path: `/api/users`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
@@ -5268,6 +5432,8 @@ export class Api extends HttpClient {
              * @request PUT:/api/users/me
              * @secure
              * @response `200` `DetailedUser` OK
+             * @response `403` `ProblemDetails` Forbidden
+             * @response `409` `ProblemDetails` Conflict
              */
             replaceMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**