@matech/thebigpos-sdk 3.2.2 → 3.3.0-dev-1625

package/dist/index.js

@@ -95,7 +95,7 @@ export class HttpClient {
 }
 /**
  * @title The Big POS API
- * @version v3.2.2
+ * @version v3.3.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -799,12 +799,25 @@ export class Api extends HttpClient {
              *
              * @tags AiPrompt
              * @name GetAiAvailablePrompts
-             * @summary Get available prompts for current user
+             * @summary Get available prompts for current user, optionally for one trigger surface
              * @request GET:/api/ai/prompts/available
              * @secure
              * @response `200` `(AiPromptSummary)[]` OK
+             * @response `400` `ProblemDetails` Bad Request
              */
             getAiAvailablePrompts: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompts/available`, method: "GET", query: query, secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags AiPromptRun
+             * @name GetAiPromptRuns
+             * @summary Get triggered prompt runs for a subject entity
+             * @request GET:/api/ai/prompt-runs
+             * @secure
+             * @response `200` `(AiPromptRun)[]` OK
+             * @response `400` `ProblemDetails` Bad Request
+             */
+            getAiPromptRuns: (query, params = {}) => this.request(Object.assign({ path: `/api/ai/prompt-runs`, method: "GET", query: query, secure: true, format: "json" }, params)),
             /**
              * No description
              *
@@ -2309,21 +2322,6 @@ export class Api extends HttpClient {
              * @response `403` `ProblemDetails` Forbidden
              */
             getEncompassIntegrationWebhookSubscriptions: (accountId, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/subscriptions`, method: "GET", secure: true, format: "json" }, params)),
-            /**
-             * No description
-             *
-             * @tags EncompassIntegrations
-             * @name SetEncompassIntegrationWebhookSignatureValidation
-             * @summary Turn inbound signature validation on or off for one Encompass webhook subscription (SuperAdmin)
-             * @request PUT:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookType}/signature-validation
-             * @secure
-             * @response `200` `EncompassWebhookSubscription` OK
-             * @response `400` `ProblemDetails` Bad Request
-             * @response `401` `ProblemDetails` Unauthorized
-             * @response `403` `ProblemDetails` Forbidden
-             * @response `404` `ProblemDetails` Not Found
-             */
-            setEncompassIntegrationWebhookSignatureValidation: (accountId, webhookType, data, params = {}) => this.request(Object.assign({ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/${webhookType}/signature-validation`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -2923,6 +2921,7 @@ export class Api extends HttpClient {
              * @request POST:/api/listings
              * @secure
              * @response `201` `Listing` Created
+             * @response `403` `ProblemDetails` Forbidden
              */
             createListing: (data, params = {}) => this.request(Object.assign({ path: `/api/listings`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -2956,6 +2955,7 @@ export class Api extends HttpClient {
              * @request PUT:/api/listings/{id}
              * @secure
              * @response `200` `Listing` OK
+             * @response `403` `ProblemDetails` Forbidden
              */
             replaceListing: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3825,6 +3825,7 @@ export class Api extends HttpClient {
              * @response `403` `ProblemDetails` Forbidden
              * @response `404` `ProblemDetails` Not Found
              * @response `409` `any` Conflict
+             * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             updateLoan: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
@@ -3902,12 +3903,13 @@ export class Api extends HttpClient {
              */
             triggerAso: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/aso`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
-             * No description
+             * @description Deprecated - use POST api/loans/tasks/bulk, which reaches every status and accepts tasks from more than one loan.
              *
              * @tags LoanTaskBulkCompletions
              * @name BulkCompleteLoanTasks
-             * @summary Bulk complete loan tasks
+             * @summary [Deprecated] Bulk complete loan tasks
              * @request POST:/api/loans/{loanID}/tasks/bulk-complete
+             * @deprecated
              * @secure
              * @response `200` `BulkCompleteLoanTasks` OK
              * @response `404` `ProblemDetails` Not Found
@@ -4037,6 +4039,18 @@ export class Api extends HttpClient {
              * @response `422` `UnprocessableEntity` Unprocessable Content
              */
             searchLoanTasksSummary: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/tasks/search/summary`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
+            /**
+             * @description Applies one operation to tasks that may span several loans, grouping them by loan server-side and returning flat per-task buckets
+             *
+             * @tags LoanTasks
+             * @name BulkLoanTaskOperation
+             * @summary Bulk task operation
+             * @request POST:/api/loans/tasks/bulk
+             * @secure
+             * @response `200` `BulkLoanTaskOperation` OK
+             * @response `422` `UnprocessableEntity` Unprocessable Content
+             */
+            bulkLoanTaskOperation: (data, params = {}) => this.request(Object.assign({ path: `/api/loans/tasks/bulk`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * No description
              *
@@ -4982,7 +4996,7 @@ export class Api extends HttpClient {
              *
              * @tags TheBigPOS
              * @name GetEncompassCredentials
-             * @summary Get Encompass Credentials for the current account
+             * @summary Get Encompass Credentials for the active site's account
              * @request GET:/api/los/encompass/credentials
              * @secure
              * @response `200` `EncompassCredentialsDetail` OK
@@ -4994,7 +5008,7 @@ export class Api extends HttpClient {
              *
              * @tags TheBigPOS
              * @name CreateEncompassCredentials
-             * @summary Create Encompass Credentials for the current account
+             * @summary Create Encompass Credentials for the active site's account
              * @request POST:/api/los/encompass/credentials
              * @secure
              * @response `201` `LosCredentials` Created
@@ -5005,7 +5019,7 @@ export class Api extends HttpClient {
              *
              * @tags TheBigPOS
              * @name UpdateEncompassCredentials
-             * @summary Update Encompass Credentials for the current account
+             * @summary Update Encompass Credentials for the active site's account
              * @request PUT:/api/los/encompass/credentials
              * @secure
              * @response `200` `EncompassCredentialsDetail` OK
@@ -5714,6 +5728,30 @@ export class Api extends HttpClient {
              * @response `401` `ProblemDetails` Unauthorized
              */
             getMyFeatureFlags: (params = {}) => this.request(Object.assign({ path: `/api/users/me/feature-flags`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UsersMe
+             * @name GetMyTableSettings
+             * @summary Get Table Settings
+             * @request GET:/api/users/me/table-settings/{tableKey}
+             * @secure
+             * @response `200` `UserTableSettings` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             */
+            getMyTableSettings: (tableKey, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}`, method: "GET", secure: true, format: "json" }, params)),
+            /**
+             * No description
+             *
+             * @tags UsersMe
+             * @name UpdateMyTableSettings
+             * @summary Update Table Settings
+             * @request PUT:/api/users/me/table-settings/{tableKey}
+             * @secure
+             * @response `200` `UserTableSettings` OK
+             * @response `401` `ProblemDetails` Unauthorized
+             */
+            updateMyTableSettings: (tableKey, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/table-settings/${tableKey}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
             /**
              * @description Update the phone number If changed will send a verification code to the new number
              *