@matech/thebigpos-sdk 2.18.3-rc.0 → 2.18.4-rc.0

package/package.json

@@ -1,40 +1,40 @@
-{
-  "name": "@matech/thebigpos-sdk",
-  "version": "2.18.3-rc.0",
-  "description": "The Big POS Typescript SDK",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "rimraf dist && tsc",
-    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
-    "browserify": "tsc && browserify -p tinyify dist/index.js -s thebigpos > dist/thebigpos.min.js",
-    "prepare": "husky"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript.git"
-  },
-  "keywords": [
-    "pos",
-    "loans",
-    "mortgage",
-    "automation"
-  ],
-  "author": "Mortgage Automation Technologies",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
-  },
-  "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
-  "dependencies": {
-    "axios": "^1.7.7",
-    "browserify": "^17.0.0",
-    "tinyify": "^4.0.0"
-  },
-  "devDependencies": {
-    "husky": "^9.1.5",
-    "rimraf": "^6.0.1",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.5.4"
-  }
-}
+{
+  "name": "@matech/thebigpos-sdk",
+  "version": "2.18.4-rc.0",
+  "description": "The Big POS Typescript SDK",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "test": "mocha -r ts-node/register 'src/api_test.spec.ts' --exit",
+    "browserify": "tsc && browserify -p tinyify dist/index.js -s thebigpos > dist/thebigpos.min.js",
+    "prepare": "husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript.git"
+  },
+  "keywords": [
+    "pos",
+    "loans",
+    "mortgage",
+    "automation"
+  ],
+  "author": "Mortgage Automation Technologies",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript/issues"
+  },
+  "homepage": "https://github.com/MortgageAutomationTechnologies/thebigpos-sdk-typescript#readme",
+  "dependencies": {
+    "axios": "^1.7.7",
+    "browserify": "^17.0.0",
+    "tinyify": "^4.0.0"
+  },
+  "devDependencies": {
+    "husky": "^9.1.5",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.4"
+  }
+}

package/src/index.ts

@@ -10,143 +10,103 @@
  * ---------------------------------------------------------------
  */
 
-export enum UserRole {
-  Borrower = "Borrower",
-  LoanOfficer = "LoanOfficer",
-  Admin = "Admin",
-  SuperAdmin = "SuperAdmin",
-  Realtor = "Realtor",
-  SettlementAgent = "SettlementAgent",
-  LoanProcessor = "LoanProcessor",
-  LoanOfficerAssistant = "LoanOfficerAssistant",
-  BranchManager = "BranchManager",
-  SystemAdmin = "SystemAdmin",
-}
-
-export enum SiteConfigurationType {
-  None = "None",
-  Account = "Account",
-  Corporate = "Corporate",
-  Branch = "Branch",
-  LoanOfficer = "LoanOfficer",
-  Partner = "Partner",
-}
-
-export enum SSOIntegrationType {
-  ConsumerConnect = "ConsumerConnect",
-  TheBigPOS = "TheBigPOS",
-}
-
-export enum LogLevel {
-  None = "None",
-  Info = "Info",
-  Warning = "Warning",
-  Error = "Error",
-}
-
-export enum LoanRole {
-  Borrower = "Borrower",
-  CoBorrower = "CoBorrower",
-  NonBorrower = "NonBorrower",
-  LoanOfficer = "LoanOfficer",
-  LoanProcessor = "LoanProcessor",
-  LoanOfficerAssistant = "LoanOfficerAssistant",
-  SupportingLoanOfficer = "SupportingLoanOfficer",
-  BuyerAgent = "BuyerAgent",
-  SellerAgent = "SellerAgent",
-  TitleInsuranceAgent = "TitleInsuranceAgent",
-  EscrowAgent = "EscrowAgent",
-  SettlementAgent = "SettlementAgent",
-}
-
-export enum LoanQueueType {
-  Unknown = "Unknown",
-  New = "New",
-  Append = "Append",
-  Update = "Update",
-  FieldUpdates = "FieldUpdates",
-  Document = "Document",
-  Buckets = "Buckets",
-}
-
-export enum LoanQueueReason {
-  Unknown = "Unknown",
-  Locked = "Locked",
-  LOSError = "LOSError",
-  Exception = "Exception",
-}
-
-export enum LoanLogType {
-  Loan = "Loan",
-  Queue = "Queue",
-  POSFlagChanged = "POSFlagChanged",
-  Verification = "Verification",
-}
-
-export enum LoanImportStatus {
-  WaitingProcess = "WaitingProcess",
-  InProgress = "InProgress",
-  Completed = "Completed",
-  Failed = "Failed",
-  Cancelled = "Cancelled",
-}
-
-export enum LOSStatus {
-  Unknown = "Unknown",
-  Pending = "Pending",
-  Retrying = "Retrying",
-  Successful = "Successful",
-  Failed = "Failed",
-  FailedPermanently = "FailedPermanently",
-}
-
-export enum FilterType {
-  DateGreaterThanOrEqualTo = "DateGreaterThanOrEqualTo",
-  DateGreaterThan = "DateGreaterThan",
-  DateLessThan = "DateLessThan",
-  DateLessThanOrEqualTo = "DateLessThanOrEqualTo",
-  DateEquals = "DateEquals",
-  DateDoesntEqual = "DateDoesntEqual",
-  DateNonEmpty = "DateNonEmpty",
-  DateEmpty = "DateEmpty",
-  StringContains = "StringContains",
-  StringEquals = "StringEquals",
-  StringNotEmpty = "StringNotEmpty",
-  StringNotEquals = "StringNotEquals",
-  StringNotContains = "StringNotContains",
-}
-
-export enum Environment {
-  Development = "Development",
-  Staging = "Staging",
-  UAT = "UAT",
-  Production = "Production",
-}
-
-export enum EntityType {
-  Account = "Account",
-  Corporate = "Corporate",
-  Branch = "Branch",
-  LoanOfficer = "LoanOfficer",
-  Realtor = "Realtor",
-}
-
-export enum BranchType {
-  Mortgage = "Mortgage",
-  RealEstate = "RealEstate",
-}
-
-export enum BorrowerType {
-  Borrower = "Borrower",
-  CoBorrower = "CoBorrower",
-  Unknown = "Unknown",
-}
-
-export enum BorrowerRelationship {
-  NotApplicable = "NotApplicable",
-  Spouse = "Spouse",
-  NonSpouse = "NonSpouse",
-}
+export type UserRole =
+  | "Borrower"
+  | "LoanOfficer"
+  | "Admin"
+  | "SuperAdmin"
+  | "Realtor"
+  | "SettlementAgent"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "BranchManager"
+  | "SystemAdmin";
+
+export type SiteConfigurationType =
+  | "None"
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Partner";
+
+export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS";
+
+export type OperationType =
+  | "Add"
+  | "Remove"
+  | "Replace"
+  | "Move"
+  | "Copy"
+  | "Test"
+  | "Invalid";
+
+export type LogLevel = "None" | "Info" | "Warning" | "Error";
+
+export type LoanRole =
+  | "Borrower"
+  | "CoBorrower"
+  | "NonBorrower"
+  | "LoanOfficer"
+  | "LoanProcessor"
+  | "LoanOfficerAssistant"
+  | "SupportingLoanOfficer"
+  | "BuyerAgent"
+  | "SellerAgent"
+  | "TitleInsuranceAgent"
+  | "EscrowAgent"
+  | "SettlementAgent";
+
+export type LoanQueueType =
+  | "Unknown"
+  | "New"
+  | "Append"
+  | "Update"
+  | "FieldUpdates"
+  | "Document"
+  | "Buckets";
+
+export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception";
+
+export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
+
+export type LOSStatus =
+  | "Unknown"
+  | "Pending"
+  | "Retrying"
+  | "Successful"
+  | "Failed"
+  | "FailedPermanently";
+
+export type FilterType =
+  | "DateGreaterThanOrEqualTo"
+  | "DateGreaterThan"
+  | "DateLessThan"
+  | "DateLessThanOrEqualTo"
+  | "DateEquals"
+  | "DateDoesntEqual"
+  | "DateNonEmpty"
+  | "DateEmpty"
+  | "StringContains"
+  | "StringEquals"
+  | "StringNotEmpty"
+  | "StringNotEquals"
+  | "StringNotContains";
+
+export type Environment = "Development" | "Staging" | "UAT" | "Production";
+
+export type EntityType =
+  | "Account"
+  | "Corporate"
+  | "Branch"
+  | "LoanOfficer"
+  | "Realtor";
+
+export type BranchType = "Mortgage" | "RealEstate";
+
+export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
+
+export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
 
 export interface ASOSettings {
   enabled: boolean;
@@ -651,16 +611,6 @@ export interface CreateInviteRequest {
   loanRole?: LoanRole | null;
 }
 
-export interface CreateLoanImportRequest {
-  /** @format date-time */
-  endDate: string;
-  /**
-   * @format date-time
-   * @minLength 1
-   */
-  startDate: string;
-}
-
 export interface CreateUserRelationRequest {
   /**
    * @format uuid
@@ -990,6 +940,7 @@ export interface EnabledServices {
   borrowerTasks?: boolean | null;
   docusign?: boolean | null;
   emailNotifications?: boolean | null;
+  autoTaskReminders?: boolean | null;
   voc?: boolean | null;
   spanishPrequal?: boolean | null;
   spanishFullApp?: boolean | null;
@@ -1058,6 +1009,7 @@ export interface ExtendedLoan {
   isInSync: boolean;
   /** @format date-time */
   syncDate?: string | null;
+  excludeFromAutoTaskReminders?: boolean | null;
   fileStarter?: string | null;
   isPOSLoan?: boolean | null;
   referenceID: string;
@@ -1068,6 +1020,7 @@ export interface ExtendedLoan {
   status?: string | null;
   loanOfficer?: LoanOfficer | null;
   propertyAddress?: Address | null;
+  loanSettings?: LoanSettings | null;
   loanLogs: LoanLog[];
   isLocked: boolean;
   source?: string | null;
@@ -1430,6 +1383,8 @@ export interface GetWorkflowRequest {
   language?: string | null;
 }
 
+export type IContractResolver = object;
+
 export interface ImportUserLoanTaskRequest {
   /**
    * @format uuid
@@ -1614,6 +1569,7 @@ export interface Loan {
   isInSync: boolean;
   /** @format date-time */
   syncDate?: string | null;
+  excludeFromAutoTaskReminders?: boolean | null;
   fileStarter?: string | null;
   isPOSLoan?: boolean | null;
   referenceID: string;
@@ -1624,6 +1580,7 @@ export interface Loan {
   status?: string | null;
   loanOfficer?: LoanOfficer | null;
   propertyAddress?: Address | null;
+  loanSettings?: LoanSettings | null;
   loanLogs: LoanLog[];
   isLocked: boolean;
   source?: string | null;
@@ -1669,6 +1626,15 @@ export interface LoanComparisonScenario {
   fundingFee?: string | null;
 }
 
+export interface LoanConsentRequest {
+  /** @format email */
+  borrowerEmail?: string | null;
+  borrowerEConsent?: boolean | null;
+  borrowerCreditAuth?: boolean | null;
+  borrowerTCPAOptIn?: boolean | null;
+  additionalFields?: Record<string, string>;
+}
+
 export interface LoanContact {
   /** @format date-time */
   createdAt: string;
@@ -1728,37 +1694,6 @@ export interface LoanDraftSearchCriteria {
   isUnassigned?: boolean | null;
 }
 
-export interface LoanImport {
-  /** @format uuid */
-  id: string;
-  /** @format uuid */
-  accountID: string;
-  /** @format date-time */
-  endDate: string;
-  /** @format date-time */
-  startDate: string;
-  /** @format int32 */
-  attemptCount: number;
-  /** @format int32 */
-  importedCount: number;
-  statusMessage?: string | null;
-  status:
-    | "WaitingProcess"
-    | "InProgress"
-    | "Completed"
-    | "Failed"
-    | "Cancelled";
-  /** @format date-time */
-  createdAt?: string | null;
-}
-
-export interface LoanImportPaginated {
-  rows: LoanImport[];
-  pagination: Pagination;
-  /** @format int64 */
-  count: number;
-}
-
 export interface LoanLog {
   /** @format uuid */
   id: string;
@@ -1873,13 +1808,28 @@ export interface LoanSearchCriteria {
   siteConfigurationId?: string | null;
 }
 
-export interface LoanUpdateRequest {
-  /** @format email */
-  borrowerEmail?: string | null;
-  borrowerEConsent?: boolean | null;
-  borrowerCreditAuth?: boolean | null;
-  borrowerTCPAOptIn?: boolean | null;
-  additionalFields?: Record<string, string>;
+export interface LoanSettings {
+  excludeFromAutoTaskReminders: boolean;
+}
+
+export interface LoanUpdateRequestJsonPatchDocument {
+  operations?: LoanUpdateRequestOperation[] | null;
+  contractResolver?: IContractResolver | null;
+}
+
+export interface LoanUpdateRequestOperation {
+  operationType:
+    | "Add"
+    | "Remove"
+    | "Replace"
+    | "Move"
+    | "Copy"
+    | "Test"
+    | "Invalid";
+  path?: string | null;
+  op?: string | null;
+  from?: string | null;
+  value?: any;
 }
 
 export interface LoanUser {
@@ -2086,7 +2036,7 @@ export interface NotificationTemplateVersionUpdateRequest {
 
 export interface Operation {
   op?: string;
-  value?: object | null;
+  value?: any | null;
   path?: string;
 }
 
@@ -2536,6 +2486,7 @@ export interface SiteConfiguration {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  autoTaskReminderIntervalsInDays: number[];
 }
 
 export interface SiteConfigurationByUrl {
@@ -2727,6 +2678,7 @@ export interface SiteConfigurationByUrl {
   user?: UserPublic | null;
   asoSettings?: ASOSettings | null;
   accountSettings: AccountSettings;
+  autoTaskReminderIntervalsInDays: number[];
   workflows: Workflow[];
 }
 
@@ -2931,6 +2883,7 @@ export interface SiteConfigurationRequest {
   modules?: Module[] | null;
   /** @format uuid */
   userID?: string | null;
+  autoTaskReminderIntervalsInDays: number[];
 }
 
 export interface SiteConfigurationSearchCriteria {
@@ -3582,6 +3535,7 @@ export interface ApiConfig<SecurityDataType = unknown>
 }
 
 export enum ContentType {
+  JsonPatch = "application/json-patch+json",
   Json = "application/json",
   JsonApi = "application/vnd.api+json",
   FormData = "multipart/form-data",
@@ -3717,7 +3671,7 @@ export class HttpClient<SecurityDataType = unknown> {
 
 /**
  * @title The Big POS API
- * @version v2.18.3
+ * @version v2.18.4
  * @termsOfService https://www.thebigpos.com/terms-of-use/
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
  */
@@ -5863,14 +5817,14 @@ export class Api<
      * No description
      *
      * @tags LegacyLoan
-     * @name UpdateLoan
-     * @summary Update Loan
+     * @name UpdateLoanConsent
+     * @summary Update Loan Consent
      * @request PATCH:/api/los/loan/application/{loanID}
      * @secure
      * @response `200` `string` Success
      * @response `422` `UnprocessableEntity` Client Error
      */
-    updateLoan: (
+    updateLoanConsent: (
       loanId: string,
       data: JsonPatchDocument,
       params: RequestParams = {},
@@ -5880,7 +5834,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -6162,7 +6116,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -6242,7 +6196,7 @@ export class Api<
         method: "PATCH",
         body: data,
         secure: true,
-        type: ContentType.Json,
+        type: ContentType.JsonPatch,
         format: "json",
         ...params,
       }),
@@ -6977,81 +6931,6 @@ export class Api<
         ...params,
       }),
 
-    /**
-     * No description
-     *
-     * @tags LoanImport
-     * @name GetLoanImports
-     * @summary Get Loan Imports
-     * @request GET:/api/loan-imports
-     * @secure
-     * @response `200` `LoanImportPaginated` Success
-     */
-    getLoanImports: (
-      query?: {
-        status?: LoanImportStatus;
-        searchText?: string;
-        /** @format int32 */
-        pageSize?: number;
-        /** @format int32 */
-        pageNumber?: number;
-        sortBy?: string;
-        sortDirection?: string;
-      },
-      params: RequestParams = {},
-    ) =>
-      this.request<LoanImportPaginated, any>({
-        path: `/api/loan-imports`,
-        method: "GET",
-        query: query,
-        secure: true,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * No description
-     *
-     * @tags LoanImport
-     * @name CreateLoanImport
-     * @summary Create Loan Import
-     * @request POST:/api/loan-imports
-     * @secure
-     * @response `201` `LoanImport` Created
-     */
-    createLoanImport: (
-      data: CreateLoanImportRequest,
-      params: RequestParams = {},
-    ) =>
-      this.request<LoanImport, any>({
-        path: `/api/loan-imports`,
-        method: "POST",
-        body: data,
-        secure: true,
-        type: ContentType.Json,
-        format: "json",
-        ...params,
-      }),
-
-    /**
-     * No description
-     *
-     * @tags LoanImport
-     * @name GetLoanImport
-     * @summary Get Loan Import
-     * @request GET:/api/loan-imports/{id}
-     * @secure
-     * @response `200` `LoanImport` Success
-     */
-    getLoanImport: (id: string, params: RequestParams = {}) =>
-      this.request<LoanImport, any>({
-        path: `/api/loan-imports/${id}`,
-        method: "GET",
-        secure: true,
-        format: "json",
-        ...params,
-      }),
-
     /**
      * No description
      *
@@ -7508,19 +7387,44 @@ export class Api<
      * @tags Loans
      * @name ImportLoanFromLos
      * @summary Import from LOS
-     * @request POST:/api/loans/{loanId}/import-from-los
+     * @request POST:/api/loans/import-from-los/{loanId}
      * @secure
      * @response `200` `Loan` Success
      */
     importLoanFromLos: (loanId: string, params: RequestParams = {}) =>
       this.request<Loan, any>({
-        path: `/api/loans/${loanId}/import-from-los`,
+        path: `/api/loans/import-from-los/${loanId}`,
         method: "POST",
         secure: true,
         format: "json",
         ...params,
       }),
 
+    /**
+     * No description
+     *
+     * @tags Loans
+     * @name UpdateLoan
+     * @summary Update loan fields
+     * @request PATCH:/api/loans/{loanId}
+     * @secure
+     * @response `200` `Loan` Success
+     */
+    updateLoan: (
+      loanId: string,
+      data: JsonPatchDocument,
+      params: RequestParams = {},
+    ) =>
+      this.request<Loan, any>({
+        path: `/api/loans/${loanId}`,
+        method: "PATCH",
+        body: data,
+        secure: true,
+        type: ContentType.JsonPatch,
+        format: "json",
+        ...params,
+      }),
+
     /**
      * No description
      *