@matech/thebigpos-sdk 3.24.1 → 3.25.0-dev-7825
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +103 -0
- package/dist/index.cjs.map +2 -2
- package/dist/index.d.ts +174 -1
- package/dist/index.js +104 -1
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +275 -1
package/dist/index.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
|
12
12
|
export type PendingInviteStatus = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
13
13
|
export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
|
|
14
14
|
export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
|
|
15
|
+
export type MfaFactor = "None" | "Sms" | "Email";
|
|
15
16
|
export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
|
|
16
17
|
export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
17
18
|
export type LosWebhookEntryStatus = "Registered" | "Disabled" | "Missing" | "Extra";
|
|
@@ -272,6 +273,7 @@ export interface AdminAccessUser {
|
|
|
272
273
|
title?: string | null;
|
|
273
274
|
forcePasswordReset: boolean;
|
|
274
275
|
mfaEnabled: boolean;
|
|
276
|
+
mfaFactor: AdminAccessUserMfaFactorEnum;
|
|
275
277
|
phoneVerified: boolean;
|
|
276
278
|
/** @format int32 */
|
|
277
279
|
loginsWithoutMFACount: number;
|
|
@@ -1081,6 +1083,7 @@ export interface BranchUser {
|
|
|
1081
1083
|
title?: string | null;
|
|
1082
1084
|
forcePasswordReset: boolean;
|
|
1083
1085
|
mfaEnabled: boolean;
|
|
1086
|
+
mfaFactor: BranchUserMfaFactorEnum;
|
|
1084
1087
|
phoneVerified: boolean;
|
|
1085
1088
|
/** @format int32 */
|
|
1086
1089
|
loginsWithoutMFACount: number;
|
|
@@ -1470,6 +1473,9 @@ export interface ConditionComment {
|
|
|
1470
1473
|
createdBy: string;
|
|
1471
1474
|
createdByName: string;
|
|
1472
1475
|
}
|
|
1476
|
+
export interface ConfirmMfaEnrollmentRequest {
|
|
1477
|
+
code: string;
|
|
1478
|
+
}
|
|
1473
1479
|
export interface ConsumerConnectRetry {
|
|
1474
1480
|
correlationKey: string;
|
|
1475
1481
|
email: string;
|
|
@@ -1763,6 +1769,7 @@ export interface CustomFieldDefinition {
|
|
|
1763
1769
|
regexPattern?: string | null;
|
|
1764
1770
|
dataType: CustomFieldDefinitionDataTypeEnum;
|
|
1765
1771
|
entityType: CustomFieldDefinitionEntityTypeEnum;
|
|
1772
|
+
isAiEnabled: boolean;
|
|
1766
1773
|
options: CustomFieldOption[];
|
|
1767
1774
|
permissions: CustomFieldPermission[];
|
|
1768
1775
|
encompassMapping?: EncompassMapping | null;
|
|
@@ -1832,6 +1839,7 @@ export interface DetailedUser {
|
|
|
1832
1839
|
title?: string | null;
|
|
1833
1840
|
forcePasswordReset: boolean;
|
|
1834
1841
|
mfaEnabled: boolean;
|
|
1842
|
+
mfaFactor: DetailedUserMfaFactorEnum;
|
|
1835
1843
|
phoneVerified: boolean;
|
|
1836
1844
|
/** @format int32 */
|
|
1837
1845
|
loginsWithoutMFACount: number;
|
|
@@ -2595,6 +2603,7 @@ export interface ImpersonatedDetailedUser {
|
|
|
2595
2603
|
title?: string | null;
|
|
2596
2604
|
forcePasswordReset: boolean;
|
|
2597
2605
|
mfaEnabled: boolean;
|
|
2606
|
+
mfaFactor: ImpersonatedDetailedUserMfaFactorEnum;
|
|
2598
2607
|
phoneVerified: boolean;
|
|
2599
2608
|
/** @format int32 */
|
|
2600
2609
|
loginsWithoutMFACount: number;
|
|
@@ -2960,6 +2969,8 @@ export interface LoanApplicationRequest {
|
|
|
2960
2969
|
draftId?: string | null;
|
|
2961
2970
|
/** @format uuid */
|
|
2962
2971
|
partnerId?: string | null;
|
|
2972
|
+
/** @format uuid */
|
|
2973
|
+
formId?: string | null;
|
|
2963
2974
|
additionalFields?: Record<string, any> | null;
|
|
2964
2975
|
/** @format uuid */
|
|
2965
2976
|
existingLoanId?: string | null;
|
|
@@ -4877,6 +4888,21 @@ export interface MaterializeLoanRoleTasks {
|
|
|
4877
4888
|
/** @format int32 */
|
|
4878
4889
|
rowsAdded: number;
|
|
4879
4890
|
}
|
|
4891
|
+
export interface MfaEnrollment {
|
|
4892
|
+
enrollmentId: string;
|
|
4893
|
+
factor: MfaEnrollmentFactorEnum;
|
|
4894
|
+
destination?: string | null;
|
|
4895
|
+
/** @format int32 */
|
|
4896
|
+
expiresInSeconds: number;
|
|
4897
|
+
canResend: boolean;
|
|
4898
|
+
}
|
|
4899
|
+
export interface MfaMethod {
|
|
4900
|
+
factor: MfaMethodFactorEnum;
|
|
4901
|
+
available: boolean;
|
|
4902
|
+
current: boolean;
|
|
4903
|
+
destination?: string | null;
|
|
4904
|
+
requiresConfirmation: boolean;
|
|
4905
|
+
}
|
|
4880
4906
|
export interface MilestoneConfiguration {
|
|
4881
4907
|
/** @format date-time */
|
|
4882
4908
|
createdAt: string;
|
|
@@ -5243,6 +5269,21 @@ export interface PendingTasksSummary {
|
|
|
5243
5269
|
export interface PinAiConversationRequest {
|
|
5244
5270
|
isPinned: boolean;
|
|
5245
5271
|
}
|
|
5272
|
+
export interface PipelineLoanOfficer {
|
|
5273
|
+
/** @format uuid */
|
|
5274
|
+
id: string;
|
|
5275
|
+
firstName: string;
|
|
5276
|
+
lastName: string;
|
|
5277
|
+
email: string;
|
|
5278
|
+
branchName?: string | null;
|
|
5279
|
+
isActive: boolean;
|
|
5280
|
+
}
|
|
5281
|
+
export interface PipelineLoanOfficerPaginated {
|
|
5282
|
+
rows: PipelineLoanOfficer[];
|
|
5283
|
+
pagination: Pagination;
|
|
5284
|
+
/** @format int64 */
|
|
5285
|
+
count: number;
|
|
5286
|
+
}
|
|
5246
5287
|
export interface PipelineTableFilters {
|
|
5247
5288
|
activityStatus?: LoanActivityStatus | null;
|
|
5248
5289
|
loanPurpose?: LoanPurpose | null;
|
|
@@ -6336,6 +6377,9 @@ export interface StandardLoanField {
|
|
|
6336
6377
|
isCustomized: boolean;
|
|
6337
6378
|
isAiEnabled: boolean;
|
|
6338
6379
|
}
|
|
6380
|
+
export interface StartMfaEnrollmentRequest {
|
|
6381
|
+
factor?: MfaFactor | null;
|
|
6382
|
+
}
|
|
6339
6383
|
export interface SupportedModel {
|
|
6340
6384
|
modelId: string;
|
|
6341
6385
|
displayName: string;
|
|
@@ -6712,6 +6756,10 @@ export interface UpdateMeRequest {
|
|
|
6712
6756
|
/** @format uuid */
|
|
6713
6757
|
preferredLoanOfficerId?: string | null;
|
|
6714
6758
|
}
|
|
6759
|
+
export interface UpdateMfaFactorRequest {
|
|
6760
|
+
factor?: MfaFactor | null;
|
|
6761
|
+
passwordConfirmation?: string | null;
|
|
6762
|
+
}
|
|
6715
6763
|
export interface UpdateMobilePhoneRequest {
|
|
6716
6764
|
phone: string;
|
|
6717
6765
|
}
|
|
@@ -6909,6 +6957,7 @@ export interface User {
|
|
|
6909
6957
|
title?: string | null;
|
|
6910
6958
|
forcePasswordReset: boolean;
|
|
6911
6959
|
mfaEnabled: boolean;
|
|
6960
|
+
mfaFactor: UserMfaFactorEnum;
|
|
6912
6961
|
phoneVerified: boolean;
|
|
6913
6962
|
/** @format int32 */
|
|
6914
6963
|
loginsWithoutMFACount: number;
|
|
@@ -7079,6 +7128,12 @@ export interface UserLoanTaskUpdateRequest {
|
|
|
7079
7128
|
/** @format uuid */
|
|
7080
7129
|
loanDocumentFolderId?: string | null;
|
|
7081
7130
|
}
|
|
7131
|
+
export interface UserMfaState {
|
|
7132
|
+
enabled: boolean;
|
|
7133
|
+
factor: UserMfaStateFactorEnum;
|
|
7134
|
+
required: boolean;
|
|
7135
|
+
methods: MfaMethod[];
|
|
7136
|
+
}
|
|
7082
7137
|
export interface UserMobilePhoneVerificationRequest {
|
|
7083
7138
|
code: string;
|
|
7084
7139
|
}
|
|
@@ -7261,6 +7316,7 @@ type BaseCanvasWidgetConfigTypeMapping<Key, Type> = {
|
|
|
7261
7316
|
type: Key;
|
|
7262
7317
|
} & Type;
|
|
7263
7318
|
export type AccountBillingRequestBillingTypeEnum = "ClosedLoan" | "LoanOfficer";
|
|
7319
|
+
export type AdminAccessUserMfaFactorEnum = "None" | "Sms" | "Email";
|
|
7264
7320
|
export type AiAuditLogEventTypeEnum = "Error" | "GuardrailBlockedPre" | "GuardrailPassedPre" | "IntentClassified" | "LoanResolvedFromMessage" | "DocumentNotFound" | "GuardrailBlockedPost" | "GuardrailPassedPost" | "DocumentAnalyzed" | "DocumentList" | "DocumentResolutionAmbiguous" | "ResponseGenerated" | "ParametersExtracted" | "QueryExecuted" | "LoanContextNotFound" | "LoanContextLoaded" | "GuardrailBlockedBedrock" | "PromptMatched" | "QueryCondensed" | "IntentParseFailed" | "LoanSearchTermDiscarded" | "CanonicalFieldsSelected" | "LoanAccessDenied" | "AgentModelCall" | "AgentToolCallRequested" | "AgentToolCallCompleted" | "AgentToolCallFailed" | "AgentLoopLimitReached" | "RequestCancelled" | "KnowledgeBaseRetrieved" | "PromptResolutionFailed" | "PromptTriggerPublished" | "PromptTriggerSkipped" | "PromptRunCompleted" | "LoanUpdateProposed" | "LoanUpdateApplied" | "LoanUpdateRefused" | "PromptTriggerCoalesced" | "RecommendationRunCompleted" | "BoundPromptForced";
|
|
7265
7321
|
export type AiChatStructuredDataTypeEnum = "Table" | "DocumentAnalysis" | "DocumentList" | "GeneratedDocument" | "CitedPassages" | "PendingLoanUpdate";
|
|
7266
7322
|
export type AiCitedDocumentSourceTypeEnum = "File" | "FreeText";
|
|
@@ -7274,6 +7330,7 @@ export type BorrowerApplicationApplicationStatusEnum = "Draft" | "Complete";
|
|
|
7274
7330
|
export type BorrowerApplicationWarningCodeEnum = "UnknownKey" | "NotWritable" | "CustomFieldUnresolved" | "CustomFieldInactive" | "CustomFieldReadOnly" | "CustomFieldDuplicateDefinition" | "LoanOfficerUnresolved";
|
|
7275
7331
|
export type BorrowerCountRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7276
7332
|
export type BorrowerIdentityRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7333
|
+
export type BranchUserMfaFactorEnum = "None" | "Sms" | "Email";
|
|
7277
7334
|
export type CanvasFieldDescriptorSourceEnum = "Standard" | "Custom";
|
|
7278
7335
|
export type CanvasFieldDescriptorDataTypeEnum = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
7279
7336
|
export type CanvasFieldDescriptorFormatEnum = "Text" | "Number" | "Currency" | "Percent" | "DateShort" | "DateLong" | "YesNo";
|
|
@@ -7316,6 +7373,7 @@ export type CustomFieldPermissionAccessLevelEnum = "NoAccess" | "ReadOnly" | "Re
|
|
|
7316
7373
|
export type CustomFieldPermissionRequestRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
7317
7374
|
export type CustomFieldPermissionRequestAccessLevelEnum = "NoAccess" | "ReadOnly" | "ReadWrite";
|
|
7318
7375
|
export type CustomFieldValueDataTypeEnum = "String" | "Number" | "Decimal" | "Boolean" | "Date" | "SingleSelect" | "MultiSelect";
|
|
7376
|
+
export type DetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
|
|
7319
7377
|
export type DocumentsWidgetConfigTypeEnum = "Documents";
|
|
7320
7378
|
export type DraftTypeEnum = "NewLoan" | "EditLoan";
|
|
7321
7379
|
export type DraftContentTypeEnum = "NewLoan" | "EditLoan";
|
|
@@ -7329,6 +7387,7 @@ export type EncompassWebhookSubscriptionWebhookTypeEnum = "Legacy" | "LoanV3" |
|
|
|
7329
7387
|
export type EsignStatusWidgetConfigTypeEnum = "EsignStatus";
|
|
7330
7388
|
export type GenerateSystemPromptRequestCategoryEnum = "DocumentAnalysis" | "DataQuery" | "General" | "Action";
|
|
7331
7389
|
export type IpAddressAddressFamilyEnum = "Unspecified" | "Unix" | "InterNetwork" | "ImpLink" | "Pup" | "Chaos" | "NS" | "Ipx" | "Iso" | "Osi" | "Ecma" | "DataKit" | "Ccitt" | "Sna" | "DecNet" | "DataLink" | "Lat" | "HyperChannel" | "AppleTalk" | "NetBios" | "VoiceView" | "FireFox" | "Banyan" | "Atm" | "InterNetworkV6" | "Cluster" | "Ieee12844" | "Irda" | "NetworkDesigners" | "Max" | "Packet" | "ControllerAreaNetwork" | "Unknown";
|
|
7390
|
+
export type ImpersonatedDetailedUserMfaFactorEnum = "None" | "Sms" | "Email";
|
|
7332
7391
|
export type IncompleteLoanSourceEnum = "V3" | "LegacyDraft";
|
|
7333
7392
|
export type IncompleteLoanBorrowerApplicationStatusEnum = "Draft" | "Complete";
|
|
7334
7393
|
export type InformationWidgetConfigLabelPositionEnum = "Left" | "Above";
|
|
@@ -7376,6 +7435,8 @@ export type LosWebhookEntryStatusEnum = "Registered" | "Disabled" | "Missing" |
|
|
|
7376
7435
|
export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
7377
7436
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
7378
7437
|
export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
|
|
7438
|
+
export type MfaEnrollmentFactorEnum = "None" | "Sms" | "Email";
|
|
7439
|
+
export type MfaMethodFactorEnum = "None" | "Sms" | "Email";
|
|
7379
7440
|
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7380
7441
|
export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
|
|
7381
7442
|
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
@@ -7401,12 +7462,14 @@ export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorro
|
|
|
7401
7462
|
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
7402
7463
|
export type UpdateAiUrlSourceRequestCategoryEnum = "Regulatory" | "Guidelines" | "MarketData" | "Custom";
|
|
7403
7464
|
export type UpdateAiUrlSourceRequestScopeEnum = "FullDomain" | "SpecificPath";
|
|
7465
|
+
export type UserMfaFactorEnum = "None" | "Sms" | "Email";
|
|
7404
7466
|
export type UserDraftRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7405
7467
|
export type UserGroupAccessScopeScopeTypeEnum = "User" | "Branch";
|
|
7406
7468
|
export type UserGroupMemberUserSummaryRoleEnum = "Borrower" | "LoanOfficer" | "Admin" | "SuperAdmin" | "Realtor" | "SettlementAgent" | "LoanProcessor" | "LoanOfficerAssistant" | "SystemAdmin";
|
|
7407
7469
|
export type UserLoanRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7408
7470
|
export type UserLoanConsentTypeEnum = "Econsent" | "CreditAuthorization" | "Tcpa";
|
|
7409
7471
|
export type UserLoanConsentLosSyncStatusEnum = "NotStarted" | "Failed" | "Success";
|
|
7472
|
+
export type UserMfaStateFactorEnum = "None" | "Sms" | "Email";
|
|
7410
7473
|
export type UserTableSettingsTableKeyEnum = "Pipeline";
|
|
7411
7474
|
export type UserTableViewTableKeyEnum = "Pipeline";
|
|
7412
7475
|
export type GetCanvasParamsSurfaceEnum = "Home" | "LoanSummary" | "LoanDetails";
|
|
@@ -7481,7 +7544,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
7481
7544
|
}
|
|
7482
7545
|
/**
|
|
7483
7546
|
* @title The Big POS API
|
|
7484
|
-
* @version v3.
|
|
7547
|
+
* @version v3.25.0
|
|
7485
7548
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
7486
7549
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
7487
7550
|
*/
|
|
@@ -11953,6 +12016,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11953
12016
|
sortBy?: string;
|
|
11954
12017
|
sortDirection?: string;
|
|
11955
12018
|
}, params?: RequestParams) => Promise<AxiosResponse<LoanListPaginated, any, {}, any>>;
|
|
12019
|
+
/**
|
|
12020
|
+
* No description
|
|
12021
|
+
*
|
|
12022
|
+
* @tags Loans
|
|
12023
|
+
* @name SearchPipelineLoanOfficers
|
|
12024
|
+
* @summary Search the loan officers of the caller's pipeline
|
|
12025
|
+
* @request POST:/api/loans/loan-officers/search
|
|
12026
|
+
* @secure
|
|
12027
|
+
* @response `200` `PipelineLoanOfficerPaginated` OK
|
|
12028
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
12029
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12030
|
+
*/
|
|
12031
|
+
searchPipelineLoanOfficers: (data: SearchCriteria, query?: {
|
|
12032
|
+
/** @format int32 */
|
|
12033
|
+
pageSize?: number;
|
|
12034
|
+
/** @format int32 */
|
|
12035
|
+
pageNumber?: number;
|
|
12036
|
+
sortBy?: string;
|
|
12037
|
+
sortDirection?: string;
|
|
12038
|
+
}, params?: RequestParams) => Promise<AxiosResponse<PipelineLoanOfficerPaginated, any, {}, any>>;
|
|
11956
12039
|
/**
|
|
11957
12040
|
* No description
|
|
11958
12041
|
*
|
|
@@ -14237,6 +14320,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14237
14320
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14238
14321
|
*/
|
|
14239
14322
|
verifyUserMobilePhone: (data: UserMobilePhoneVerificationRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14323
|
+
/**
|
|
14324
|
+
* No description
|
|
14325
|
+
*
|
|
14326
|
+
* @tags Users
|
|
14327
|
+
* @name ClearUserMfa
|
|
14328
|
+
* @summary Clear MFA
|
|
14329
|
+
* @request PUT:/api/users/{id}/mfa
|
|
14330
|
+
* @secure
|
|
14331
|
+
* @response `200` `UserMfaState` OK
|
|
14332
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
14333
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14334
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14335
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14336
|
+
*/
|
|
14337
|
+
clearUserMfa: (id: string, data: UpdateMfaFactorRequest, params?: RequestParams) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
|
|
14240
14338
|
/**
|
|
14241
14339
|
* No description
|
|
14242
14340
|
*
|
|
@@ -14473,6 +14571,81 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14473
14571
|
* @response `204` `void` No Content
|
|
14474
14572
|
*/
|
|
14475
14573
|
deleteMe: (data: UserAccountDeletionRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14574
|
+
/**
|
|
14575
|
+
* No description
|
|
14576
|
+
*
|
|
14577
|
+
* @tags UsersMeMfa
|
|
14578
|
+
* @name GetMyMfa
|
|
14579
|
+
* @summary Get MFA
|
|
14580
|
+
* @request GET:/api/users/me/mfa
|
|
14581
|
+
* @secure
|
|
14582
|
+
* @response `200` `UserMfaState` OK
|
|
14583
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
14584
|
+
*/
|
|
14585
|
+
getMyMfa: (params?: RequestParams) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
|
|
14586
|
+
/**
|
|
14587
|
+
* No description
|
|
14588
|
+
*
|
|
14589
|
+
* @tags UsersMeMfa
|
|
14590
|
+
* @name UpdateMyMfa
|
|
14591
|
+
* @summary Update MFA
|
|
14592
|
+
* @request PUT:/api/users/me/mfa
|
|
14593
|
+
* @secure
|
|
14594
|
+
* @response `200` `UserMfaState` OK
|
|
14595
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
14596
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
14597
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14598
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14599
|
+
*/
|
|
14600
|
+
updateMyMfa: (data: UpdateMfaFactorRequest, params?: RequestParams) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
|
|
14601
|
+
/**
|
|
14602
|
+
* No description
|
|
14603
|
+
*
|
|
14604
|
+
* @tags UsersMeMfa
|
|
14605
|
+
* @name StartMyMfaEnrollment
|
|
14606
|
+
* @summary Start MFA Enrollment
|
|
14607
|
+
* @request POST:/api/users/me/mfa/enrollments
|
|
14608
|
+
* @secure
|
|
14609
|
+
* @response `200` `MfaEnrollment` OK
|
|
14610
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
14611
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
14612
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14613
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14614
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
14615
|
+
* @response `503` `void` Service Unavailable
|
|
14616
|
+
*/
|
|
14617
|
+
startMyMfaEnrollment: (data: StartMfaEnrollmentRequest, params?: RequestParams) => Promise<AxiosResponse<MfaEnrollment, any, {}, any>>;
|
|
14618
|
+
/**
|
|
14619
|
+
* No description
|
|
14620
|
+
*
|
|
14621
|
+
* @tags UsersMeMfa
|
|
14622
|
+
* @name ConfirmMyMfaEnrollment
|
|
14623
|
+
* @summary Confirm MFA Enrollment
|
|
14624
|
+
* @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/confirm
|
|
14625
|
+
* @secure
|
|
14626
|
+
* @response `200` `UserMfaState` OK
|
|
14627
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
14628
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
14629
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14630
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14631
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
14632
|
+
*/
|
|
14633
|
+
confirmMyMfaEnrollment: (enrollmentId: string, data: ConfirmMfaEnrollmentRequest, params?: RequestParams) => Promise<AxiosResponse<UserMfaState, any, {}, any>>;
|
|
14634
|
+
/**
|
|
14635
|
+
* No description
|
|
14636
|
+
*
|
|
14637
|
+
* @tags UsersMeMfa
|
|
14638
|
+
* @name ResendMyMfaEnrollmentCode
|
|
14639
|
+
* @summary Resend MFA Enrollment Code
|
|
14640
|
+
* @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/resend
|
|
14641
|
+
* @secure
|
|
14642
|
+
* @response `204` `void` No Content
|
|
14643
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
14644
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14645
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
14646
|
+
* @response `503` `void` Service Unavailable
|
|
14647
|
+
*/
|
|
14648
|
+
resendMyMfaEnrollmentCode: (enrollmentId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14476
14649
|
/**
|
|
14477
14650
|
* No description
|
|
14478
14651
|
*
|
package/dist/index.js
CHANGED
|
@@ -101,7 +101,7 @@ export class HttpClient {
|
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
103
|
* @title The Big POS API
|
|
104
|
-
* @version v3.
|
|
104
|
+
* @version v3.25.0
|
|
105
105
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
106
106
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
107
107
|
*/
|
|
@@ -4100,6 +4100,19 @@ export class Api extends HttpClient {
|
|
|
4100
4100
|
* @response `200` `LoanListPaginated` OK
|
|
4101
4101
|
*/
|
|
4102
4102
|
searchLoans: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4103
|
+
/**
|
|
4104
|
+
* No description
|
|
4105
|
+
*
|
|
4106
|
+
* @tags Loans
|
|
4107
|
+
* @name SearchPipelineLoanOfficers
|
|
4108
|
+
* @summary Search the loan officers of the caller's pipeline
|
|
4109
|
+
* @request POST:/api/loans/loan-officers/search
|
|
4110
|
+
* @secure
|
|
4111
|
+
* @response `200` `PipelineLoanOfficerPaginated` OK
|
|
4112
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
4113
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4114
|
+
*/
|
|
4115
|
+
searchPipelineLoanOfficers: (data, query, params = {}) => this.request(Object.assign({ path: `/api/loans/loan-officers/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4103
4116
|
/**
|
|
4104
4117
|
* No description
|
|
4105
4118
|
*
|
|
@@ -6182,6 +6195,21 @@ export class Api extends HttpClient {
|
|
|
6182
6195
|
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6183
6196
|
*/
|
|
6184
6197
|
verifyUserMobilePhone: (data, params = {}) => this.request(Object.assign({ path: `/api/users/mobile-phone/verify-code`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
|
|
6198
|
+
/**
|
|
6199
|
+
* No description
|
|
6200
|
+
*
|
|
6201
|
+
* @tags Users
|
|
6202
|
+
* @name ClearUserMfa
|
|
6203
|
+
* @summary Clear MFA
|
|
6204
|
+
* @request PUT:/api/users/{id}/mfa
|
|
6205
|
+
* @secure
|
|
6206
|
+
* @response `200` `UserMfaState` OK
|
|
6207
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
6208
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6209
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6210
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6211
|
+
*/
|
|
6212
|
+
clearUserMfa: (id, data, params = {}) => this.request(Object.assign({ path: `/api/users/${id}/mfa`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6185
6213
|
/**
|
|
6186
6214
|
* No description
|
|
6187
6215
|
*
|
|
@@ -6418,6 +6446,81 @@ export class Api extends HttpClient {
|
|
|
6418
6446
|
* @response `204` `void` No Content
|
|
6419
6447
|
*/
|
|
6420
6448
|
deleteMe: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/delete`, method: "POST", body: data, secure: true, type: "application/json" }, params)),
|
|
6449
|
+
/**
|
|
6450
|
+
* No description
|
|
6451
|
+
*
|
|
6452
|
+
* @tags UsersMeMfa
|
|
6453
|
+
* @name GetMyMfa
|
|
6454
|
+
* @summary Get MFA
|
|
6455
|
+
* @request GET:/api/users/me/mfa
|
|
6456
|
+
* @secure
|
|
6457
|
+
* @response `200` `UserMfaState` OK
|
|
6458
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
6459
|
+
*/
|
|
6460
|
+
getMyMfa: (params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa`, method: "GET", secure: true, format: "json" }, params)),
|
|
6461
|
+
/**
|
|
6462
|
+
* No description
|
|
6463
|
+
*
|
|
6464
|
+
* @tags UsersMeMfa
|
|
6465
|
+
* @name UpdateMyMfa
|
|
6466
|
+
* @summary Update MFA
|
|
6467
|
+
* @request PUT:/api/users/me/mfa
|
|
6468
|
+
* @secure
|
|
6469
|
+
* @response `200` `UserMfaState` OK
|
|
6470
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
6471
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
6472
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6473
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6474
|
+
*/
|
|
6475
|
+
updateMyMfa: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6476
|
+
/**
|
|
6477
|
+
* No description
|
|
6478
|
+
*
|
|
6479
|
+
* @tags UsersMeMfa
|
|
6480
|
+
* @name StartMyMfaEnrollment
|
|
6481
|
+
* @summary Start MFA Enrollment
|
|
6482
|
+
* @request POST:/api/users/me/mfa/enrollments
|
|
6483
|
+
* @secure
|
|
6484
|
+
* @response `200` `MfaEnrollment` OK
|
|
6485
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
6486
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
6487
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6488
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6489
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
6490
|
+
* @response `503` `void` Service Unavailable
|
|
6491
|
+
*/
|
|
6492
|
+
startMyMfaEnrollment: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa/enrollments`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6493
|
+
/**
|
|
6494
|
+
* No description
|
|
6495
|
+
*
|
|
6496
|
+
* @tags UsersMeMfa
|
|
6497
|
+
* @name ConfirmMyMfaEnrollment
|
|
6498
|
+
* @summary Confirm MFA Enrollment
|
|
6499
|
+
* @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/confirm
|
|
6500
|
+
* @secure
|
|
6501
|
+
* @response `200` `UserMfaState` OK
|
|
6502
|
+
* @response `400` `ProblemDetails` Bad Request
|
|
6503
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
6504
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6505
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6506
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
6507
|
+
*/
|
|
6508
|
+
confirmMyMfaEnrollment: (enrollmentId, data, params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa/enrollments/${enrollmentId}/confirm`, method: "POST", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6509
|
+
/**
|
|
6510
|
+
* No description
|
|
6511
|
+
*
|
|
6512
|
+
* @tags UsersMeMfa
|
|
6513
|
+
* @name ResendMyMfaEnrollmentCode
|
|
6514
|
+
* @summary Resend MFA Enrollment Code
|
|
6515
|
+
* @request POST:/api/users/me/mfa/enrollments/{enrollmentId}/resend
|
|
6516
|
+
* @secure
|
|
6517
|
+
* @response `204` `void` No Content
|
|
6518
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
6519
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6520
|
+
* @response `429` `ProblemDetails` Too Many Requests
|
|
6521
|
+
* @response `503` `void` Service Unavailable
|
|
6522
|
+
*/
|
|
6523
|
+
resendMyMfaEnrollmentCode: (enrollmentId, params = {}) => this.request(Object.assign({ path: `/api/users/me/mfa/enrollments/${enrollmentId}/resend`, method: "POST", secure: true }, params)),
|
|
6421
6524
|
/**
|
|
6422
6525
|
* No description
|
|
6423
6526
|
*
|