@matech/thebigpos-sdk 3.30.0-main-8913 → 3.31.0-dev-8990

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.d.ts CHANGED
@@ -33,8 +33,8 @@ export type LoanRealEstateOccupancyType = "PrimaryHome" | "SecondHome" | "Invest
33
33
  export type LoanRealEstateIntendedUsageType = "PrimaryResidence" | "SecondHome" | "Investment" | "Other";
34
34
  export type LoanQueueType = "Unknown" | "New" | "Append" | "Update" | "FieldUpdates" | "Document" | "Buckets";
35
35
  export type LoanQueueReason = "Unknown" | "Locked" | "LOSError" | "Exception" | "TransientError";
36
- export type LoanPurpose = "Purchase" | "Refinance";
37
- export type LoanPropertyType = "SingleFamily" | "MultiFamily" | "Condominium" | "Townhouse" | "ManufacturedHome" | "PlannedUnitDevelopment" | "ModularHome" | "Other";
36
+ export type LoanPurpose = "Purchase" | "Refinance" | "ConstructionOnly" | "ConstructionToPermanent";
37
+ export type LoanPropertyType = "SingleFamily" | "MultiFamily" | "Condominium" | "Townhouse" | "ManufacturedHome" | "PlannedUnitDevelopment" | "ModularHome" | "Other" | "DetachedCondo" | "HighRiseCondominium" | "Cooperative" | "ManufacturedHomeCondoPudCoOp" | "MHHomeChoice" | "MHSelect" | "MHAdvantage";
38
38
  export type LoanPhoneNumberType = "Home" | "Cell" | "Work" | "Fax" | "Other";
39
39
  export type LoanPacificIslanderRace = "NativeHawaiian" | "GuamanianOrChamorro" | "Samoan" | "Other";
40
40
  export type LoanOwnershipInterestPropertyType = "PrimaryResidence" | "FHASecondaryResidence" | "SecondaryResidence" | "Investment";
@@ -46,7 +46,7 @@ export type LoanNameSuffix = "Jr" | "Sr" | "II" | "III" | "IV" | "V" | "VI" | "V
46
46
  export type LoanNamePrefix = "Mr" | "Mrs" | "Ms";
47
47
  export type LoanMilitaryServiceType = "Current" | "RetiredDischargedSeparated" | "NonActivatedNationalGuard" | "SurvivingSpouse";
48
48
  export type LoanMaritalStatus = "Married" | "Separated" | "Single";
49
- export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
49
+ export type LoanLogType = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged" | "ConsumerConnectUnlinked";
50
50
  export type LoanLienPosition = "First" | "Subordinate";
51
51
  export type LoanLiabilityType = "Revolving" | "Installment" | "Open30Day" | "Lease" | "Other";
52
52
  export type LoanLanguagePreference = "English" | "Chinese" | "Korean" | "Spanish" | "Tagalog" | "Vietnamese" | "Other" | "DoNotWishToRespond";
@@ -4894,6 +4894,11 @@ export interface LosSyncStep {
4894
4894
  /** @format date-time */
4895
4895
  atUtc: string;
4896
4896
  }
4897
+ export interface LosUnlinkedRecipient {
4898
+ email: string;
4899
+ contactType: string;
4900
+ recipientId: string;
4901
+ }
4897
4902
  export interface LosWebhook {
4898
4903
  /** @format uuid */
4899
4904
  id: string;
@@ -7506,9 +7511,9 @@ export type LoanImportStatusEnum = "WaitingProcess" | "InProgress" | "Completed"
7506
7511
  export type LoanImportImportModeEnum = "All" | "NewOnly" | "UpdateOnly";
7507
7512
  export type LoanImportLogLevelEnum = "None" | "Info" | "Warning" | "Error";
7508
7513
  export type LoanLogLevelEnum = "None" | "Info" | "Warning" | "Error";
7509
- export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
7514
+ export type LoanLogTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged" | "ConsumerConnectUnlinked";
7510
7515
  export type LoanLogDetailLevelEnum = "None" | "Info" | "Warning" | "Error";
7511
- export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged";
7516
+ export type LoanLogDetailTypeEnum = "Loan" | "Queue" | "POSFlagChanged" | "Verification" | "DocumentUploaded" | "LoanCreated" | "WorkflowSubmitted" | "UserInvitationSent" | "CoBorrowerAdded" | "TaskCompleted" | "LoanStatusChanged" | "Consent" | "SensitiveDataPurge" | "ClosingDateUpdated" | "ConsumerConnectAssociation" | "TaskReminderSent" | "DocumentClassified" | "CoBorrowerEmailAutoFixed" | "LosFieldWriteBack" | "ReferrerChangeDiscarded" | "TaskEdited" | "SigningMethodChanged" | "ConsumerConnectUnlinked";
7512
7517
  export type LoanProgressWidgetConfigTypeEnum = "LoanProgress";
7513
7518
  export type LoanRoleSlotTasksRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7514
7519
  export type LoanRoleTaskRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
@@ -7638,7 +7643,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
7638
7643
  }
7639
7644
  /**
7640
7645
  * @title The Big POS API
7641
- * @version v3.30.0
7646
+ * @version v3.31.0
7642
7647
  * @termsOfService https://www.thebigpos.com/terms-of-use/
7643
7648
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7644
7649
  */
@@ -11250,6 +11255,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11250
11255
  * @response `204` `void` No Content
11251
11256
  * @response `400` `ProblemDetails` Bad Request
11252
11257
  * @response `422` `ProblemDetails` Unprocessable Content
11258
+ * @response `423` `ProblemDetails` Locked
11253
11259
  */
11254
11260
  bulkSetLoanCustomFieldValues: (loanId: string, data: SetCustomFieldValueRequest[], params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
11255
11261
  /**
@@ -11264,6 +11270,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11264
11270
  * @response `400` `ProblemDetails` Bad Request
11265
11271
  * @response `404` `ProblemDetails` Not Found
11266
11272
  * @response `422` `ProblemDetails` Unprocessable Content
11273
+ * @response `423` `ProblemDetails` Locked
11267
11274
  */
11268
11275
  setLoanCustomFieldValue: (loanId: string, definitionId: string, data: SetSingleCustomFieldValueRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
11269
11276
  /**
@@ -12415,6 +12422,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12415
12422
  * @response `404` `ProblemDetails` Not Found
12416
12423
  */
12417
12424
  triggerAso: (loanId: string, data: TriggerAsoRequest, params?: RequestParams) => Promise<AxiosResponse<AutomatedService, any, {}, any>>;
12425
+ /**
12426
+ * No description
12427
+ *
12428
+ * @tags LoanSigningMethod
12429
+ * @name UnlinkLoanFromConsumerConnect
12430
+ * @summary Unlink the loan's borrowers from Consumer Connect
12431
+ * @request POST:/api/loans/{loanId}/signing-method/unlink
12432
+ * @secure
12433
+ * @response `200` `(LosUnlinkedRecipient)[]` OK
12434
+ * @response `400` `ProblemDetails` Bad Request
12435
+ * @response `403` `ProblemDetails` Forbidden
12436
+ * @response `404` `ProblemDetails` Not Found
12437
+ * @response `422` `ProblemDetails` Unprocessable Content
12438
+ * @response `423` `ProblemDetails` Locked
12439
+ * @response `429` `ProblemDetails` Too Many Requests
12440
+ * @response `504` `void` Gateway Timeout
12441
+ */
12442
+ unlinkLoanFromConsumerConnect: (loanId: string, params?: RequestParams) => Promise<AxiosResponse<LosUnlinkedRecipient[], any, {}, any>>;
12418
12443
  /**
12419
12444
  * No description
12420
12445
  *
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.30.0
104
+ * @version v3.31.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
  */
@@ -3321,6 +3321,7 @@ export class Api extends HttpClient {
3321
3321
  * @response `204` `void` No Content
3322
3322
  * @response `400` `ProblemDetails` Bad Request
3323
3323
  * @response `422` `ProblemDetails` Unprocessable Content
3324
+ * @response `423` `ProblemDetails` Locked
3324
3325
  */
3325
3326
  bulkSetLoanCustomFieldValues: (loanId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
3326
3327
  /**
@@ -3335,6 +3336,7 @@ export class Api extends HttpClient {
3335
3336
  * @response `400` `ProblemDetails` Bad Request
3336
3337
  * @response `404` `ProblemDetails` Not Found
3337
3338
  * @response `422` `ProblemDetails` Unprocessable Content
3339
+ * @response `423` `ProblemDetails` Locked
3338
3340
  */
3339
3341
  setLoanCustomFieldValue: (loanId, definitionId, data, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/custom-fields/${definitionId}`, method: "PUT", body: data, secure: true, type: "application/json" }, params)),
3340
3342
  /**
@@ -4388,6 +4390,24 @@ export class Api extends HttpClient {
4388
4390
  * @response `404` `ProblemDetails` Not Found
4389
4391
  */
4390
4392
  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)),
4393
+ /**
4394
+ * No description
4395
+ *
4396
+ * @tags LoanSigningMethod
4397
+ * @name UnlinkLoanFromConsumerConnect
4398
+ * @summary Unlink the loan's borrowers from Consumer Connect
4399
+ * @request POST:/api/loans/{loanId}/signing-method/unlink
4400
+ * @secure
4401
+ * @response `200` `(LosUnlinkedRecipient)[]` OK
4402
+ * @response `400` `ProblemDetails` Bad Request
4403
+ * @response `403` `ProblemDetails` Forbidden
4404
+ * @response `404` `ProblemDetails` Not Found
4405
+ * @response `422` `ProblemDetails` Unprocessable Content
4406
+ * @response `423` `ProblemDetails` Locked
4407
+ * @response `429` `ProblemDetails` Too Many Requests
4408
+ * @response `504` `void` Gateway Timeout
4409
+ */
4410
+ unlinkLoanFromConsumerConnect: (loanId, params = {}) => this.request(Object.assign({ path: `/api/loans/${loanId}/signing-method/unlink`, method: "POST", secure: true, format: "json" }, params)),
4391
4411
  /**
4392
4412
  * No description
4393
4413
  *