@matech/thebigpos-sdk 2.40.6-rc1 → 2.42.1

package/dist/index.d.ts

@@ -53,6 +53,7 @@ export type Environment = "Development" | "Staging" | "UAT" | "Production";
 export type EntityType = "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Realtor";
 export type EncompassLogOutcome = "Success" | "Failure" | "PartialSuccess";
 export type EncompassLogOperationType = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
+export type EncompassEnvironment = "Production" | "UAT";
 export type DraftType = "NewLoan" | "EditLoan";
 export type CustomFieldEntityType = "Loan";
 export type CustomFieldDataType = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
@@ -162,7 +163,7 @@ export interface Action {
     comments?: string | null;
     /** @format uuid */
     siteConfigurationID: string;
-    applicationSettings?: any;
+    applicationSettings?: any | null;
     surveysToken?: string | null;
 }
 export interface Address {
@@ -462,7 +463,7 @@ export interface AuditLogEntry {
     rootEntityType?: string | null;
     /** @format uuid */
     rootEntityId?: string | null;
-    changes?: any;
+    changes?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -1282,7 +1283,7 @@ export interface DraftLoanOfficerReassignRequest {
 }
 export interface DraftRequest {
     applicationPayload: any;
-    customData?: any;
+    customData?: any | null;
     isCoBorrower: boolean;
 }
 export interface EnabledServices {
@@ -1349,7 +1350,10 @@ export interface EncompassCredentialsDetail {
     loanTemplate?: string | null;
     defaultLoanOfficerUserName?: string | null;
     clearStateIfUnlicensed: boolean;
+    /** @deprecated */
     baseUrl?: string | null;
+    encompassEnvironment: EncompassCredentialsDetailEncompassEnvironmentEnum;
+    consumerConnectWidgetHost?: string | null;
     signingMethod: EncompassCredentialsDetailSigningMethodEnum;
     subscriptionId?: string | null;
     environment?: string | null;
@@ -1364,7 +1368,10 @@ export interface EncompassCredentialsRequest {
     loanTemplate?: string | null;
     defaultLoanOfficerUserName?: string | null;
     clearStateIfUnlicensed: boolean;
+    /** @deprecated */
     baseUrl?: string | null;
+    encompassEnvironment: EncompassCredentialsRequestEncompassEnvironmentEnum;
+    consumerConnectWidgetHost?: string | null;
     signingMethod: EncompassCredentialsRequestSigningMethodEnum;
     subscriptionId?: string | null;
     environment?: string | null;
@@ -1399,6 +1406,9 @@ export interface EncompassFieldListItem {
     fieldType: string;
     inUse: boolean;
 }
+export interface EncompassIntegrationSettings {
+    consumerConnectWidgetHost?: string | null;
+}
 export interface EncompassLogSearchCriteria {
     searchText?: string | null;
     operationTypes?: EncompassLogOperationType[] | null;
@@ -1480,7 +1490,7 @@ export interface EncompassRequestLog {
     httpStatusCode?: number | null;
     /** @format int64 */
     durationMs?: number | null;
-    context?: any;
+    context?: any | null;
     /** @format date-time */
     createdAt: string;
 }
@@ -1523,7 +1533,7 @@ export interface FileSearchCriteria {
 export interface FileWithBytes {
     name: string;
     /** @format byte */
-    data: string;
+    data: Blob;
     fileName: string;
     mimeType?: string | null;
     extension?: string | null;
@@ -1599,7 +1609,7 @@ export interface FormSubmission {
     subjectPropertyAddressCounty?: string | null;
     subjectPropertyAddressState?: string | null;
     subjectPropertyAddressZip?: string | null;
-    data?: any;
+    data?: any | null;
     /** @format uuid */
     listingID?: string | null;
     listing?: Listing | null;
@@ -1634,7 +1644,7 @@ export interface FormSubmissionRequest {
     subjectPropertyAddressCounty?: string | null;
     subjectPropertyAddressState?: string | null;
     subjectPropertyAddressZip?: string | null;
-    data?: any;
+    data?: any | null;
     /** @format uuid */
     listingID?: string | null;
 }
@@ -1795,7 +1805,7 @@ export interface GetWorkflowRequest {
 export interface GuidPatchOperation {
     op: string;
     path: string;
-    value?: any;
+    value?: any | null;
     from?: string | null;
 }
 export interface IPAddress {
@@ -1856,6 +1866,9 @@ export interface ImportUserLoanTaskRequest {
      */
     userID: string;
 }
+export interface IntegrationSettings {
+    encompass?: EncompassIntegrationSettings | null;
+}
 export interface Invite {
     /** @format uuid */
     id: string;
@@ -2090,7 +2103,7 @@ export interface LoanApplicationRequest {
     nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
     /** @format uuid */
     draftId?: string | null;
-    additionalFields?: Record<string, any>;
+    additionalFields?: Record<string, any> | null;
     /** @format uuid */
     existingLoanId?: string | null;
 }
@@ -2949,7 +2962,7 @@ export interface LoanConsentRequest {
     borrowerEConsent?: boolean | null;
     borrowerCreditAuth?: boolean | null;
     borrowerTCPAOptIn?: boolean | null;
-    additionalFields?: Record<string, string>;
+    additionalFields?: Record<string, string> | null;
 }
 export interface LoanContact {
     /** @format date-time */
@@ -2973,7 +2986,7 @@ export interface LoanContactList {
     email: string;
 }
 export interface LoanCustomFieldsRequest {
-    additionalFields?: Record<string, string>;
+    additionalFields?: Record<string, string> | null;
 }
 export interface LoanDocument {
     /** @format date-time */
@@ -3439,7 +3452,7 @@ export interface LoanQueueWithData {
     user: UserPublic;
     loanOfficer: LoanOfficerPublic;
     siteConfiguration: SiteConfigurationReduced;
-    data?: any;
+    data?: any | null;
 }
 export interface LoanRecord {
     loanGuid: string;
@@ -3676,7 +3689,7 @@ export interface ModuleParameterValue {
     parameterID: string;
     parameterName: string;
     parameterType: string;
-    value?: any;
+    value?: any | null;
     isInherited: boolean;
 }
 export interface MonthlyPaymentCalculator {
@@ -5755,7 +5768,9 @@ export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly
 export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
 export type DraftTypeEnum = "NewLoan" | "EditLoan";
 export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
+export type EncompassCredentialsDetailEncompassEnvironmentEnum = "Production" | "UAT";
 export type EncompassCredentialsDetailSigningMethodEnum = "ConsumerConnect" | "POSF";
+export type EncompassCredentialsRequestEncompassEnvironmentEnum = "Production" | "UAT";
 export type EncompassCredentialsRequestSigningMethodEnum = "ConsumerConnect" | "POSF";
 export type EncompassRequestLogOperationTypeEnum = "FieldUpdate" | "ConsentUpdate" | "DocumentSync" | "MilestoneUpdate" | "DocumentAttachment" | "General" | "FieldReader";
 export type EncompassRequestLogOutcomeEnum = "Success" | "Failure" | "PartialSuccess";
@@ -5820,13 +5835,7 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
     secure?: boolean;
     format?: ResponseType;
 }
-export declare enum ContentType {
-    Json = "application/json",
-    JsonApi = "application/vnd.api+json",
-    FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded",
-    Text = "text/plain"
-}
+export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
 export declare class HttpClient<SecurityDataType = unknown> {
     instance: AxiosInstance;
     private securityData;
@@ -5842,7 +5851,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
 }
 /**
  * @title The Big POS API
- * @version v2.40.5
+ * @version v2.42.0
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -7296,6 +7305,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `FormVersion` Success
          */
         deleteFormVersion: (formId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<FormVersion, any, {}>>;
+        /**
+         * No description
+         *
+         * @tags IntegrationSettings
+         * @name GetIntegrationSettings
+         * @summary Get Integration Settings
+         * @request GET:/api/integrations/settings
+         * @secure
+         * @response `200` `IntegrationSettings` Success
+         */
+        getIntegrationSettings: (params?: RequestParams) => Promise<AxiosResponse<IntegrationSettings, any, {}>>;
         /**
          * No description
          *
@@ -8017,10 +8037,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @summary Download By ID
          * @request GET:/api/loans/{loanId}/documents/{documentId}/download
          * @secure
-         * @response `200` `string` Success
+         * @response `200` `Blob` Success
          * @response `404` `ProblemDetails` Not Found
          */
-        downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<string, any, {}>>;
+        downloadLoanDocument: (loanId: string, documentId: string, params?: RequestParams) => Promise<AxiosResponse<Blob, any, {}>>;
         /**
          * No description
          *