@matech/thebigpos-sdk 2.26.1-rc1 → 2.26.2

package/.husky/pre-commit

@@ -1,3 +1,3 @@
-[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
-yarn build
+[ -f ./src/index.ts ] && node scripts/apply-json-patch-content-type.js
+yarn build
 git add .

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Mortgage Automation Technologies
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Mortgage Automation Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,44 +1,44 @@
-# The BIG POS Typescript SDK
-
-## Installation
-Using npm:
-
-```bash
-$ npm install @matech/thebigpos-sdk
-```
-
-Using yarn:
-
-```bash
-$ yarn add @matech/thebigpos-sdk
-```
-
-## Quick Start
-```js
-import { Api } from "@matech/thebigpos-sdk";
-
-const securityWorker = (data: any) => {
-    return { headers: data }
-}
-
-const setBearerSecurityWorker = (accessToken:string) => {
-    const data = {
-        Authorization: `Bearer ${accessToken}`
-    };
-
-    apiClient.setSecurityData(data);
-};
-
-const apiClient = new Api({
-    baseURL:
-        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
-    securityWorker,
-})
-
-apiClient.api.getSiteConfiguration().then((response) => {
-    console.log(response.data);
-});
-```
-
-____
-© 2024 Mortgage Automation Technologies. All rights reserved
+# The BIG POS Typescript SDK
+
+## Installation
+Using npm:
+
+```bash
+$ npm install @matech/thebigpos-sdk
+```
+
+Using yarn:
+
+```bash
+$ yarn add @matech/thebigpos-sdk
+```
+
+## Quick Start
+```js
+import { Api } from "@matech/thebigpos-sdk";
+
+const securityWorker = (data: any) => {
+    return { headers: data }
+}
+
+const setBearerSecurityWorker = (accessToken:string) => {
+    const data = {
+        Authorization: `Bearer ${accessToken}`
+    };
+
+    apiClient.setSecurityData(data);
+};
+
+const apiClient = new Api({
+    baseURL:
+        process.env.REACT_APP_POS_API_HOST || 'https://api.thebigpos.com',
+    securityWorker,
+})
+
+apiClient.api.getSiteConfiguration().then((response) => {
+    console.log(response.data);
+});
+```
+
+____
+© 2024 Mortgage Automation Technologies. All rights reserved

package/dist/index.d.ts

@@ -525,7 +525,7 @@ export interface CorporateSearchCriteria {
     isActive?: boolean | null;
 }
 export interface CreateAccessScopeRequest {
-    scopeType: "User" | "Branch";
+    scopeType: CreateAccessScopeRequestScopeTypeEnum;
     /** @format uuid */
     userId?: string | null;
     /** @format uuid */
@@ -548,7 +548,7 @@ export interface CreateAccountRequest {
      */
     nlmsid: number;
     settings: AccountSettingsRequest;
-    environment: "Development" | "Staging" | "UAT" | "Production";
+    environment: CreateAccountRequestEnvironmentEnum;
     losIntegration: LOSIntegration;
 }
 export interface CreateBranchRequest {
@@ -577,7 +577,7 @@ export interface CreateDocumentTemplateRequest {
 export interface CreateGroupMemberRequest {
     /** @format uuid */
     userId: string;
-    loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    loanRole: CreateGroupMemberRequestLoanRoleEnum;
 }
 export interface CreateInviteRequest {
     /** @minLength 1 */
@@ -588,7 +588,7 @@ export interface CreateInviteRequest {
     emailAddress: string;
     phoneNumber?: string | null;
     /** @deprecated */
-    relationship: "NotApplicable" | "Spouse" | "NonSpouse";
+    relationship: CreateInviteRequestRelationshipEnum;
     loanID: string;
     route?: string | null;
     /** @format uuid */
@@ -610,13 +610,13 @@ export interface CreateLoanImportRequest {
      * @minLength 1
      */
     startDate: string;
-    importMode: "All" | "NewOnly" | "UpdateOnly";
+    importMode: CreateLoanImportRequestImportModeEnum;
 }
 export interface CreateUserDeviceRequest {
     token: string;
 }
 export interface CreateUserDraft {
-    loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    loanRole: CreateUserDraftLoanRoleEnum;
 }
 export interface CreateUserGroupRequest {
     /**
@@ -1171,7 +1171,7 @@ export interface FusionFieldDisplay {
     fieldValue: string;
 }
 export interface FusionReportFilter {
-    filterType: "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
+    filterType: FusionReportFilterFilterTypeEnum;
     targetField: string;
     targetValue: string;
 }
@@ -1630,7 +1630,7 @@ export interface LoanContact {
     email?: string | null;
     phone?: string | null;
     companyName?: string | null;
-    role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    role: LoanContactRoleEnum;
 }
 export interface LoanContactList {
     email: string;
@@ -1717,13 +1717,13 @@ export interface LoanImport {
     /** @format int32 */
     importedCount: number;
     statusMessage?: string | null;
-    status: "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
-    importMode: "All" | "NewOnly" | "UpdateOnly";
+    status: LoanImportStatusEnum;
+    importMode: LoanImportImportModeEnum;
     /** @format date-time */
     createdAt?: string | null;
 }
 export interface LoanImportLog {
-    level: "None" | "Info" | "Warning" | "Error";
+    level: LoanImportLogLevelEnum;
     message: string;
     /** @format date-time */
     createdAt: string;
@@ -1767,8 +1767,8 @@ export interface LoanListPaginated {
 export interface LoanLog {
     /** @format uuid */
     id: string;
-    level: "None" | "Info" | "Warning" | "Error";
-    type: "Loan" | "Queue" | "POSFlagChanged" | "Verification";
+    level: LoanLogLevelEnum;
+    type: LoanLogTypeEnum;
     message: string;
     /** @format date-time */
     createdAt: string;
@@ -1890,7 +1890,7 @@ export interface LoanUpdateRequestJsonPatchDocument {
     contractResolver?: IContractResolver | null;
 }
 export interface LoanUpdateRequestOperation {
-    operationType: "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
+    operationType: LoanUpdateRequestOperationOperationTypeEnum;
     path?: string | null;
     op?: string | null;
     from?: string | null;
@@ -1904,7 +1904,7 @@ export interface LoanUser {
     email: string;
     phone?: string | null;
     role: string;
-    loanRole: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    loanRole: LoanUserLoanRoleEnum;
     isUser: boolean;
     /** @format date-time */
     createdAt: string;
@@ -2499,7 +2499,7 @@ export interface SSOTokenRequest {
     redirectUri: string;
 }
 export interface SamlMetadataRequest {
-    ssoIntegration: "ConsumerConnect" | "TheBigPOS";
+    ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
 }
 export interface SendForgotPasswordRequest {
     /**
@@ -2534,7 +2534,7 @@ export interface SiteConfiguration {
     deletedAt?: string | null;
     /** @format uuid */
     id: string;
-    type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+    type: SiteConfigurationTypeEnum;
     /** @format uuid */
     entityID: string;
     /** @format int32 */
@@ -2728,7 +2728,7 @@ export interface SiteConfigurationByUrl {
     deletedAt?: string | null;
     /** @format uuid */
     id: string;
-    type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+    type: SiteConfigurationByUrlTypeEnum;
     /** @format uuid */
     entityID: string;
     /** @format int32 */
@@ -2939,7 +2939,7 @@ export interface SiteConfigurationForm {
 export interface SiteConfigurationReduced {
     /** @format uuid */
     id: string;
-    type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+    type: SiteConfigurationReducedTypeEnum;
     url?: string | null;
     name: string;
     /** @format int64 */
@@ -2956,7 +2956,7 @@ export interface SiteConfigurationRequest {
     entityID: string;
     /** @format int32 */
     entityType: number;
-    type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+    type: SiteConfigurationRequestTypeEnum;
     url: string;
     name: string;
     introduction?: string | null;
@@ -3131,7 +3131,7 @@ export interface SiteConfigurationSearchCriteria {
 export interface SiteConfigurationSummary {
     /** @format uuid */
     id: string;
-    type: "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+    type: SiteConfigurationSummaryTypeEnum;
     url?: string | null;
     name: string;
     /** @format int64 */
@@ -3533,7 +3533,7 @@ export interface UserDevice {
 export interface UserDraft {
     /** @format uuid */
     draftID: string;
-    role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    role: UserDraftRoleEnum;
     user: User;
 }
 export interface UserDraftPaginated {
@@ -3557,7 +3557,7 @@ export interface UserGroupAccessScope {
     id: string;
     /** @format uuid */
     groupId: string;
-    scopeType: "User" | "Branch";
+    scopeType: UserGroupAccessScopeScopeTypeEnum;
     /** @format uuid */
     userId?: string | null;
     /** @format uuid */
@@ -3590,7 +3590,7 @@ export interface UserLoan {
     deletedAt?: string | null;
     loanID: string;
     user: User;
-    role: "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+    role: UserLoanRoleEnum;
     /** @format int32 */
     borrowerPair?: number | null;
     /** @format int32 */
@@ -3723,7 +3723,7 @@ export interface UserSummary {
     id: string;
     name?: string | null;
     email?: string | null;
-    role: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
+    role: UserSummaryRoleEnum;
 }
 export interface VerifyPasswordRequest {
     /**
@@ -3756,6 +3756,38 @@ export interface Workflow {
     tileSubtitle: string;
     icon: string;
 }
+export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
+export type CreateAccountRequestEnvironmentEnum = "Development" | "Staging" | "UAT" | "Production";
+export type CreateGroupMemberRequestLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+/** @deprecated */
+export type CreateInviteRequestRelationshipEnum = "NotApplicable" | "Spouse" | "NonSpouse";
+export type CreateLoanImportRequestImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
+export type CreateUserDraftLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type FusionReportFilterFilterTypeEnum = "DateGreaterThanOrEqualTo" | "DateGreaterThan" | "DateLessThan" | "DateLessThanOrEqualTo" | "DateEquals" | "DateDoesntEqual" | "DateNonEmpty" | "DateEmpty" | "StringContains" | "StringEquals" | "StringNotEmpty" | "StringNotEquals" | "StringNotContains";
+export type LoanContactRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed" | "Failed" | "Cancelled";
+export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
+export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
+export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
+export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification";
+export type LoanUpdateRequestOperationOperationTypeEnum = "Add" | "Remove" | "Replace" | "Move" | "Copy" | "Test" | "Invalid";
+export type LoanUserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type SamlMetadataRequestSsoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
+export type SiteConfigurationTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type SiteConfigurationByUrlTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type SiteConfigurationReducedTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type SiteConfigurationRequestTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type SiteConfigurationSummaryTypeEnum = "None" | "Account" | "Corporate" | "Branch" | "LoanOfficer" | "Partner";
+export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
+export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent";
+export type UserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
+/** @default "Realtor" */
+export type GetPartnersParamsRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
+export type GetSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
+export type GetSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
+export type CreateOrReplaceSamlMetadataParamsSSoIntegrationEnum = "ConsumerConnect" | "TheBigPOS";
+export type CreateOrReplaceSamlMetadataParamsEnum = "ConsumerConnect" | "TheBigPOS";
 import type { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
 export type QueryParamsType = Record<string | number, any>;
 export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
@@ -6453,7 +6485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
         getPartners: (query?: {
             showAll?: boolean;
             /** @default "Realtor" */
-            role?: "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "BranchManager" | "SystemAdmin";
+            role?: GetPartnersParamsRoleEnum;
             /** @format int32 */
             pageSize?: number;
             /** @format int32 */
@@ -6631,7 +6663,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @response `200` `File` Success
          * @response `404` `ProblemDetails` Not Found
          */
-        getSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
+        getSamlMetadata: (sSoIntegration: GetSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
         /**
          * No description
          *
@@ -6642,7 +6674,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
          * @secure
          * @response `200` `File` Success
          */
-        createOrReplaceSamlMetadata: (sSoIntegration: "ConsumerConnect" | "TheBigPOS", ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
+        createOrReplaceSamlMetadata: (sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum, ssoIntegration: string, params?: RequestParams) => Promise<AxiosResponse<File, any>>;
         /**
          * No description
          *