@matech/thebigpos-sdk 3.18.0-dev-6743 → 3.18.0-dev-6756
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 +271 -0
- package/dist/index.js +180 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +451 -16
package/dist/index.d.ts
CHANGED
|
@@ -10,6 +10,7 @@ export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch"
|
|
|
10
10
|
export type SigningMethod = "ConsumerConnect" | "POSF";
|
|
11
11
|
export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
|
|
12
12
|
export type PendingInviteStatus = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
13
|
+
export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
|
|
13
14
|
export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
|
|
14
15
|
export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
|
|
15
16
|
export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
|
|
@@ -57,6 +58,7 @@ export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other
|
|
|
57
58
|
export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower" | "NonOriginatingLender" | "NonParentRelative" | "Parent" | "PropertySeller" | "UnrelatedFriend";
|
|
58
59
|
export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
|
|
59
60
|
export type LoanGenderType = "Male" | "Female";
|
|
61
|
+
export type LoanFieldDataType = "Text" | "Number" | "Boolean" | "Date" | "Enum" | "Identifier" | "Object";
|
|
60
62
|
export type LoanDocumentType = "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";
|
|
61
63
|
export type LoanDocumentFolderScope = "Any" | "Assigned" | "Unassigned";
|
|
62
64
|
export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
|
|
@@ -99,6 +101,7 @@ export type CanvasFieldFormat = "Text" | "Number" | "Currency" | "Percent" | "Da
|
|
|
99
101
|
export type CanvasFieldDataType = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
|
|
100
102
|
export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
101
103
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
104
|
+
export type BulkLoanFieldOperationType = "SetAccess" | "SetAiEnabled" | "ResetToDefaults";
|
|
102
105
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
103
106
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
104
107
|
export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
|
|
@@ -166,6 +169,7 @@ export interface Account {
|
|
|
166
169
|
updatedAt?: string | null;
|
|
167
170
|
/** @format int32 */
|
|
168
171
|
allowedLoginsWithoutMFA: number;
|
|
172
|
+
isPartnerPortalEnabled: boolean;
|
|
169
173
|
losSettings: LOSSettings;
|
|
170
174
|
asoSettings?: ASOSettings | null;
|
|
171
175
|
settings: AccountSettings;
|
|
@@ -192,11 +196,13 @@ export interface AccountSettings {
|
|
|
192
196
|
smsNumber?: string | null;
|
|
193
197
|
ssoHostOverride?: string | null;
|
|
194
198
|
isEarlyAdopter: boolean;
|
|
199
|
+
allowLoanOfficerPartnerInvites: boolean;
|
|
195
200
|
}
|
|
196
201
|
export interface AccountSettingsRequest {
|
|
197
202
|
isSmsEnabled: boolean;
|
|
198
203
|
smsNumber?: string | null;
|
|
199
204
|
isEarlyAdopter: boolean;
|
|
205
|
+
allowLoanOfficerPartnerInvites?: boolean | null;
|
|
200
206
|
}
|
|
201
207
|
export interface Address {
|
|
202
208
|
/** @format uuid */
|
|
@@ -1137,6 +1143,21 @@ export interface BranchUserPaginated {
|
|
|
1137
1143
|
/** @format int64 */
|
|
1138
1144
|
count: number;
|
|
1139
1145
|
}
|
|
1146
|
+
export interface BulkLoanFieldOperation {
|
|
1147
|
+
applied: string[];
|
|
1148
|
+
skipped: BulkLoanFieldSkip[];
|
|
1149
|
+
}
|
|
1150
|
+
export interface BulkLoanFieldOperationRequest {
|
|
1151
|
+
fieldKeys: string[];
|
|
1152
|
+
operation?: BulkLoanFieldOperationType | null;
|
|
1153
|
+
role?: UserRole | null;
|
|
1154
|
+
accessLevel?: CustomFieldAccessLevel | null;
|
|
1155
|
+
enabled?: boolean | null;
|
|
1156
|
+
}
|
|
1157
|
+
export interface BulkLoanFieldSkip {
|
|
1158
|
+
fieldKey: string;
|
|
1159
|
+
reason: string;
|
|
1160
|
+
}
|
|
1140
1161
|
export interface BulkLoanTaskFailure {
|
|
1141
1162
|
/** @format uuid */
|
|
1142
1163
|
userLoanTaskID: string;
|
|
@@ -1559,6 +1580,7 @@ export interface CreateAccountRequest {
|
|
|
1559
1580
|
domain: string;
|
|
1560
1581
|
eConsentBucket?: string | null;
|
|
1561
1582
|
ignoreCoBorrowerRelationship: boolean;
|
|
1583
|
+
isPartnerPortalEnabled: boolean;
|
|
1562
1584
|
user: AdminUser;
|
|
1563
1585
|
companyAddress: CompanyAddress;
|
|
1564
1586
|
contactInfo: ContactInfo;
|
|
@@ -2039,6 +2061,7 @@ export interface DraftRequest {
|
|
|
2039
2061
|
applicationPayload: any;
|
|
2040
2062
|
customData?: any | null;
|
|
2041
2063
|
isCoBorrower: boolean;
|
|
2064
|
+
partnerId?: string | null;
|
|
2042
2065
|
}
|
|
2043
2066
|
export interface EconsentPendingSummary {
|
|
2044
2067
|
/** @format int32 */
|
|
@@ -2973,6 +2996,7 @@ export interface LoanApplicationRequest {
|
|
|
2973
2996
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2974
2997
|
/** @format uuid */
|
|
2975
2998
|
draftId?: string | null;
|
|
2999
|
+
partnerId?: string | null;
|
|
2976
3000
|
additionalFields?: Record<string, any> | null;
|
|
2977
3001
|
/** @format uuid */
|
|
2978
3002
|
existingLoanId?: string | null;
|
|
@@ -3988,6 +4012,16 @@ export interface LoanFieldAccessItem {
|
|
|
3988
4012
|
access: LoanFieldAccessItemAccessEnum;
|
|
3989
4013
|
patchPath?: string | null;
|
|
3990
4014
|
}
|
|
4015
|
+
export interface LoanFieldMappings {
|
|
4016
|
+
encompassFieldIds: string[];
|
|
4017
|
+
templateToken: string;
|
|
4018
|
+
}
|
|
4019
|
+
export interface LoanFieldPermissionsRequest {
|
|
4020
|
+
permissions: CustomFieldPermissionRequest[];
|
|
4021
|
+
}
|
|
4022
|
+
export interface LoanFieldSettingsRequest {
|
|
4023
|
+
isAiEnabled?: boolean | null;
|
|
4024
|
+
}
|
|
3991
4025
|
export interface LoanFinancial {
|
|
3992
4026
|
/** @format uuid */
|
|
3993
4027
|
id?: string | null;
|
|
@@ -4119,6 +4153,7 @@ export interface LoanList {
|
|
|
4119
4153
|
buyerAgentContact?: LoanContactList | null;
|
|
4120
4154
|
sellerAgentContact?: LoanContactList | null;
|
|
4121
4155
|
userLoans: UserLoan[];
|
|
4156
|
+
myLoanRoles: LoanRole[];
|
|
4122
4157
|
contacts: LoanContact[];
|
|
4123
4158
|
borrowers: LoanListBorrower[];
|
|
4124
4159
|
taskCounts: LoanTaskCounts;
|
|
@@ -4995,6 +5030,19 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
4995
5030
|
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4996
5031
|
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
4997
5032
|
};
|
|
5033
|
+
export interface MyPartner {
|
|
5034
|
+
/** @format uuid */
|
|
5035
|
+
partnerID?: string | null;
|
|
5036
|
+
/** @format uuid */
|
|
5037
|
+
inviteID?: string | null;
|
|
5038
|
+
firstName: string;
|
|
5039
|
+
lastName: string;
|
|
5040
|
+
email: string;
|
|
5041
|
+
phone?: string | null;
|
|
5042
|
+
tier: MyPartnerTierEnum;
|
|
5043
|
+
/** @format date-time */
|
|
5044
|
+
createdAt: string;
|
|
5045
|
+
}
|
|
4998
5046
|
export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4999
5047
|
/** @format int32 */
|
|
5000
5048
|
dueWithinDays: number;
|
|
@@ -5170,12 +5218,32 @@ export interface Pagination {
|
|
|
5170
5218
|
/** @format int32 */
|
|
5171
5219
|
pageSize: number;
|
|
5172
5220
|
}
|
|
5221
|
+
export interface PartnerFormLink {
|
|
5222
|
+
/** @format int32 */
|
|
5223
|
+
formType: number;
|
|
5224
|
+
name: string;
|
|
5225
|
+
url: string;
|
|
5226
|
+
}
|
|
5227
|
+
export interface PartnerLinks {
|
|
5228
|
+
slug: string;
|
|
5229
|
+
loanOfficers: PartnerLoanOfficerLinks[];
|
|
5230
|
+
}
|
|
5231
|
+
export interface PartnerLoanOfficerLinks {
|
|
5232
|
+
/** @format uuid */
|
|
5233
|
+
loanOfficerId: string;
|
|
5234
|
+
name: string;
|
|
5235
|
+
siteUrl: string;
|
|
5236
|
+
links: PartnerFormLink[];
|
|
5237
|
+
}
|
|
5173
5238
|
export interface PartnerSearchCriteria {
|
|
5174
5239
|
searchText?: string | null;
|
|
5175
5240
|
isActive?: boolean | null;
|
|
5176
5241
|
brands?: string[] | null;
|
|
5177
5242
|
roles?: UserRole[] | null;
|
|
5178
5243
|
}
|
|
5244
|
+
export interface PartnerSlug {
|
|
5245
|
+
slug: string;
|
|
5246
|
+
}
|
|
5179
5247
|
export interface PendingInvite {
|
|
5180
5248
|
status: PendingInviteStatusEnum;
|
|
5181
5249
|
/** @format uuid */
|
|
@@ -5743,6 +5811,7 @@ export interface SiteConfiguration {
|
|
|
5743
5811
|
user?: UserPublic | null;
|
|
5744
5812
|
asoSettings?: ASOSettings | null;
|
|
5745
5813
|
accountSettings: AccountSettings;
|
|
5814
|
+
isPartnerPortalEnabled: boolean;
|
|
5746
5815
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
5747
5816
|
mobileSettings?: MobileSettings | null;
|
|
5748
5817
|
losSettings?: LOSSettings | null;
|
|
@@ -5937,6 +6006,7 @@ export interface SiteConfigurationByUrl {
|
|
|
5937
6006
|
user?: UserPublic | null;
|
|
5938
6007
|
asoSettings?: ASOSettings | null;
|
|
5939
6008
|
accountSettings: AccountSettings;
|
|
6009
|
+
isPartnerPortalEnabled: boolean;
|
|
5940
6010
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
5941
6011
|
mobileSettings?: MobileSettings | null;
|
|
5942
6012
|
losSettings?: LOSSettings | null;
|
|
@@ -6287,6 +6357,19 @@ export interface SocialSurveyRecord {
|
|
|
6287
6357
|
/** @format date-time */
|
|
6288
6358
|
reviewCompletedTimeStamp?: string | null;
|
|
6289
6359
|
}
|
|
6360
|
+
export interface StandardLoanField {
|
|
6361
|
+
fieldKey: string;
|
|
6362
|
+
displayName: string;
|
|
6363
|
+
category: string;
|
|
6364
|
+
dataType: StandardLoanFieldDataTypeEnum;
|
|
6365
|
+
isPii: boolean;
|
|
6366
|
+
isWritable: boolean;
|
|
6367
|
+
patchPath?: string | null;
|
|
6368
|
+
mappings: LoanFieldMappings;
|
|
6369
|
+
access: Record<string, CustomFieldAccessLevel>;
|
|
6370
|
+
isCustomized: boolean;
|
|
6371
|
+
isAiEnabled?: boolean | null;
|
|
6372
|
+
}
|
|
6290
6373
|
export interface SupportedModel {
|
|
6291
6374
|
modelId: string;
|
|
6292
6375
|
displayName: string;
|
|
@@ -6676,6 +6759,12 @@ export interface UpdateMeRequest {
|
|
|
6676
6759
|
export interface UpdateMobilePhoneRequest {
|
|
6677
6760
|
phone: string;
|
|
6678
6761
|
}
|
|
6762
|
+
export interface UpdatePartnerPortalRequest {
|
|
6763
|
+
isEnabled?: boolean | null;
|
|
6764
|
+
}
|
|
6765
|
+
export interface UpdatePartnerSlugRequest {
|
|
6766
|
+
slug: string;
|
|
6767
|
+
}
|
|
6679
6768
|
export interface UpdateUserGroupRequest {
|
|
6680
6769
|
name: string;
|
|
6681
6770
|
description?: string | null;
|
|
@@ -7333,6 +7422,7 @@ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disa
|
|
|
7333
7422
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
7334
7423
|
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";
|
|
7335
7424
|
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7425
|
+
export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
|
|
7336
7426
|
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
7337
7427
|
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
7338
7428
|
export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
@@ -7350,6 +7440,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
|
|
|
7350
7440
|
export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
|
|
7351
7441
|
export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
7352
7442
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
7443
|
+
export type StandardLoanFieldDataTypeEnum = "Text" | "Number" | "Boolean" | "Date" | "Enum" | "Identifier" | "Object";
|
|
7353
7444
|
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
7354
7445
|
export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
|
|
7355
7446
|
export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
|
|
@@ -7573,6 +7664,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7573
7664
|
* @response `422` `ProblemDetails` Unprocessable Content
|
|
7574
7665
|
*/
|
|
7575
7666
|
updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}, any>>;
|
|
7667
|
+
/**
|
|
7668
|
+
* @description Turns the account's partner portal on or off. While Partner-lite is on for the account, off refuses its realtors' leads and listings and the creation of partner sites.
|
|
7669
|
+
*
|
|
7670
|
+
* @tags Accounts
|
|
7671
|
+
* @name UpdateAccountPartnerPortal
|
|
7672
|
+
* @summary Update partner portal switch
|
|
7673
|
+
* @request PUT:/api/accounts/{id}/partner-portal
|
|
7674
|
+
* @secure
|
|
7675
|
+
* @response `200` `Account` OK
|
|
7676
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7677
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
7678
|
+
*/
|
|
7679
|
+
updateAccountPartnerPortal: (id: string, data: UpdatePartnerPortalRequest, params?: RequestParams) => Promise<AxiosResponse<Account, any, {}, any>>;
|
|
7576
7680
|
/**
|
|
7577
7681
|
* No description
|
|
7578
7682
|
*
|
|
@@ -10233,6 +10337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10233
10337
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
10234
10338
|
* @secure
|
|
10235
10339
|
* @response `204` `void` No Content
|
|
10340
|
+
* @response `403` `HttpError` Forbidden
|
|
10236
10341
|
*/
|
|
10237
10342
|
deleteFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10238
10343
|
/**
|
|
@@ -10244,6 +10349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10244
10349
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
10245
10350
|
* @secure
|
|
10246
10351
|
* @response `200` `FileWithBytes` OK
|
|
10352
|
+
* @response `403` `HttpError` Forbidden
|
|
10247
10353
|
*/
|
|
10248
10354
|
downloadFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, query?: {
|
|
10249
10355
|
/** @format uuid */
|
|
@@ -10258,6 +10364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10258
10364
|
* @request GET:/api/form-submissions
|
|
10259
10365
|
* @secure
|
|
10260
10366
|
* @response `200` `FormSubmissionPaginated` OK
|
|
10367
|
+
* @response `403` `HttpError` Forbidden
|
|
10261
10368
|
*/
|
|
10262
10369
|
getFormSubmissions: (query?: {
|
|
10263
10370
|
/** @format int32 */
|
|
@@ -10289,6 +10396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10289
10396
|
* @request GET:/api/form-submissions/{id}
|
|
10290
10397
|
* @secure
|
|
10291
10398
|
* @response `200` `FormSubmission` OK
|
|
10399
|
+
* @response `403` `HttpError` Forbidden
|
|
10292
10400
|
*/
|
|
10293
10401
|
getFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}, any>>;
|
|
10294
10402
|
/**
|
|
@@ -10300,6 +10408,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10300
10408
|
* @request PUT:/api/form-submissions/{id}
|
|
10301
10409
|
* @secure
|
|
10302
10410
|
* @response `200` `FormSubmission` OK
|
|
10411
|
+
* @response `403` `HttpError` Forbidden
|
|
10303
10412
|
*/
|
|
10304
10413
|
replaceFormSubmission: (id: string, data: FormSubmissionRequest, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}, any>>;
|
|
10305
10414
|
/**
|
|
@@ -10311,6 +10420,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10311
10420
|
* @request DELETE:/api/form-submissions/{id}
|
|
10312
10421
|
* @secure
|
|
10313
10422
|
* @response `204` `void` No Content
|
|
10423
|
+
* @response `403` `HttpError` Forbidden
|
|
10314
10424
|
*/
|
|
10315
10425
|
deleteFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10316
10426
|
/**
|
|
@@ -10322,6 +10432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10322
10432
|
* @request POST:/api/form-submissions/search
|
|
10323
10433
|
* @secure
|
|
10324
10434
|
* @response `200` `FormSubmissionPaginated` OK
|
|
10435
|
+
* @response `403` `HttpError` Forbidden
|
|
10325
10436
|
*/
|
|
10326
10437
|
searchFormSubmissions: (data: FormSubmissionSearchCriteria, query?: {
|
|
10327
10438
|
/** @format int32 */
|
|
@@ -10584,6 +10695,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10584
10695
|
* @request POST:/api/listings/{listingId}/files
|
|
10585
10696
|
* @secure
|
|
10586
10697
|
* @response `200` `ListingFile` OK
|
|
10698
|
+
* @response `403` `HttpError` Forbidden
|
|
10587
10699
|
*/
|
|
10588
10700
|
addListingFile: (listingId: string, data: {
|
|
10589
10701
|
/** @format binary */
|
|
@@ -10600,6 +10712,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10600
10712
|
* @request PATCH:/api/listings/{listingId}/files
|
|
10601
10713
|
* @secure
|
|
10602
10714
|
* @response `200` `ListingFile` OK
|
|
10715
|
+
* @response `403` `HttpError` Forbidden
|
|
10603
10716
|
*/
|
|
10604
10717
|
updateListingFiles: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingFile, any, {}, any>>;
|
|
10605
10718
|
/**
|
|
@@ -10611,6 +10724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10611
10724
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
10612
10725
|
* @secure
|
|
10613
10726
|
* @response `204` `Listing` No Content
|
|
10727
|
+
* @response `403` `HttpError` Forbidden
|
|
10614
10728
|
*/
|
|
10615
10729
|
removeListingFile: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}, any>>;
|
|
10616
10730
|
/**
|
|
@@ -10622,6 +10736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10622
10736
|
* @request POST:/api/listings/{listingId}/photos
|
|
10623
10737
|
* @secure
|
|
10624
10738
|
* @response `200` `ListingPhoto` OK
|
|
10739
|
+
* @response `403` `HttpError` Forbidden
|
|
10625
10740
|
*/
|
|
10626
10741
|
addListingPhoto: (listingId: string, data: {
|
|
10627
10742
|
name?: string;
|
|
@@ -10640,6 +10755,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10640
10755
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
10641
10756
|
* @secure
|
|
10642
10757
|
* @response `200` `(ListingPhoto)[]` OK
|
|
10758
|
+
* @response `403` `HttpError` Forbidden
|
|
10643
10759
|
*/
|
|
10644
10760
|
updateListingPhotos: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingPhoto[], any, {}, any>>;
|
|
10645
10761
|
/**
|
|
@@ -10651,6 +10767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10651
10767
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
10652
10768
|
* @secure
|
|
10653
10769
|
* @response `204` `Listing` No Content
|
|
10770
|
+
* @response `403` `HttpError` Forbidden
|
|
10654
10771
|
*/
|
|
10655
10772
|
removeListingPhoto: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}, any>>;
|
|
10656
10773
|
/**
|
|
@@ -10728,6 +10845,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10728
10845
|
* @request DELETE:/api/listings/{id}
|
|
10729
10846
|
* @secure
|
|
10730
10847
|
* @response `204` `void` No Content
|
|
10848
|
+
* @response `403` `HttpError` Forbidden
|
|
10731
10849
|
*/
|
|
10732
10850
|
deleteListing: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10733
10851
|
/**
|
|
@@ -10757,6 +10875,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10757
10875
|
* @request PUT:/api/listings/{id}/background-image
|
|
10758
10876
|
* @secure
|
|
10759
10877
|
* @response `200` `File` OK
|
|
10878
|
+
* @response `403` `HttpError` Forbidden
|
|
10760
10879
|
*/
|
|
10761
10880
|
updateListingBackgroundImage: (id: string, data: {
|
|
10762
10881
|
/** @format binary */
|
|
@@ -10771,6 +10890,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10771
10890
|
* @request DELETE:/api/listings/{id}/background-image
|
|
10772
10891
|
* @secure
|
|
10773
10892
|
* @response `204` `void` No Content
|
|
10893
|
+
* @response `403` `HttpError` Forbidden
|
|
10774
10894
|
*/
|
|
10775
10895
|
deleteListingBackgroundImage: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10776
10896
|
/**
|
|
@@ -11391,6 +11511,76 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11391
11511
|
* @response `403` `ProblemDetails` Forbidden
|
|
11392
11512
|
*/
|
|
11393
11513
|
getLoanFieldAccess: (params?: RequestParams) => Promise<AxiosResponse<LoanFieldAccess, any, {}, any>>;
|
|
11514
|
+
/**
|
|
11515
|
+
* No description
|
|
11516
|
+
*
|
|
11517
|
+
* @tags LoanFields
|
|
11518
|
+
* @name GetStandardLoanFields
|
|
11519
|
+
* @summary List standard loan fields with effective access and settings
|
|
11520
|
+
* @request GET:/api/loan-fields/standard
|
|
11521
|
+
* @secure
|
|
11522
|
+
* @response `200` `(StandardLoanField)[]` OK
|
|
11523
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11524
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11525
|
+
*/
|
|
11526
|
+
getStandardLoanFields: (params?: RequestParams) => Promise<AxiosResponse<StandardLoanField[], any, {}, any>>;
|
|
11527
|
+
/**
|
|
11528
|
+
* No description
|
|
11529
|
+
*
|
|
11530
|
+
* @tags LoanFields
|
|
11531
|
+
* @name SetLoanFieldPermissions
|
|
11532
|
+
* @summary Set role access levels on one loan field
|
|
11533
|
+
* @request PUT:/api/loan-fields/{fieldKey}/permissions
|
|
11534
|
+
* @secure
|
|
11535
|
+
* @response `204` `void` No Content
|
|
11536
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11537
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11538
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11539
|
+
*/
|
|
11540
|
+
setLoanFieldPermissions: (fieldKey: string, data: LoanFieldPermissionsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
11541
|
+
/**
|
|
11542
|
+
* No description
|
|
11543
|
+
*
|
|
11544
|
+
* @tags LoanFields
|
|
11545
|
+
* @name SetLoanFieldSettings
|
|
11546
|
+
* @summary Set the AI setting on one loan field
|
|
11547
|
+
* @request PUT:/api/loan-fields/{fieldKey}/settings
|
|
11548
|
+
* @secure
|
|
11549
|
+
* @response `204` `void` No Content
|
|
11550
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11551
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11552
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11553
|
+
*/
|
|
11554
|
+
setLoanFieldSettings: (fieldKey: string, data: LoanFieldSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
11555
|
+
/**
|
|
11556
|
+
* No description
|
|
11557
|
+
*
|
|
11558
|
+
* @tags LoanFields
|
|
11559
|
+
* @name ResetLoanFieldOverrides
|
|
11560
|
+
* @summary Reset one standard loan field to its seeded defaults
|
|
11561
|
+
* @request DELETE:/api/loan-fields/{fieldKey}/overrides
|
|
11562
|
+
* @secure
|
|
11563
|
+
* @response `204` `void` No Content
|
|
11564
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11565
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11566
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11567
|
+
*/
|
|
11568
|
+
resetLoanFieldOverrides: (fieldKey: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
11569
|
+
/**
|
|
11570
|
+
* No description
|
|
11571
|
+
*
|
|
11572
|
+
* @tags LoanFields
|
|
11573
|
+
* @name BulkLoanFieldOperation
|
|
11574
|
+
* @summary Apply one operation to many loan fields
|
|
11575
|
+
* @request POST:/api/loan-fields/bulk
|
|
11576
|
+
* @secure
|
|
11577
|
+
* @response `200` `BulkLoanFieldOperation` OK
|
|
11578
|
+
* @response `401` `ProblemDetails` Unauthorized
|
|
11579
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
11580
|
+
* @response `404` `ProblemDetails` Not Found
|
|
11581
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
11582
|
+
*/
|
|
11583
|
+
bulkLoanFieldOperation: (data: BulkLoanFieldOperationRequest, params?: RequestParams) => Promise<AxiosResponse<BulkLoanFieldOperation, any, {}, any>>;
|
|
11394
11584
|
/**
|
|
11395
11585
|
* No description
|
|
11396
11586
|
*
|
|
@@ -12779,6 +12969,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12779
12969
|
* @response `200` `NotificationTemplateVersion` OK
|
|
12780
12970
|
*/
|
|
12781
12971
|
deleteNotificationTemplateVersion: (notificationId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<NotificationTemplateVersion, any, {}, any>>;
|
|
12972
|
+
/**
|
|
12973
|
+
* @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
|
|
12974
|
+
*
|
|
12975
|
+
* @tags Partners
|
|
12976
|
+
* @name UpdatePartnerLinkSlug
|
|
12977
|
+
* @summary Update Partner Link Slug
|
|
12978
|
+
* @request PUT:/api/partners/{realtorId}/link-slug
|
|
12979
|
+
* @secure
|
|
12980
|
+
* @response `200` `PartnerSlug` OK
|
|
12981
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12982
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12983
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12984
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
12985
|
+
*/
|
|
12986
|
+
updatePartnerLinkSlug: (realtorId: string, data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerSlug, any, {}, any>>;
|
|
12782
12987
|
/**
|
|
12783
12988
|
* No description
|
|
12784
12989
|
*
|
|
@@ -14343,6 +14548,72 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14343
14548
|
* @response `204` `void` No Content
|
|
14344
14549
|
*/
|
|
14345
14550
|
deleteRelationshipProspect: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14551
|
+
/**
|
|
14552
|
+
* @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
|
|
14553
|
+
*
|
|
14554
|
+
* @tags UsersMe
|
|
14555
|
+
* @name GetMyPartners
|
|
14556
|
+
* @summary Get My Partners
|
|
14557
|
+
* @request GET:/api/users/me/partners
|
|
14558
|
+
* @secure
|
|
14559
|
+
* @response `200` `(MyPartner)[]` OK
|
|
14560
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14561
|
+
*/
|
|
14562
|
+
getMyPartners: (params?: RequestParams) => Promise<AxiosResponse<MyPartner[], any, {}, any>>;
|
|
14563
|
+
/**
|
|
14564
|
+
* No description
|
|
14565
|
+
*
|
|
14566
|
+
* @tags UsersMe
|
|
14567
|
+
* @name AddMyPartner
|
|
14568
|
+
* @summary Add My Partner
|
|
14569
|
+
* @request POST:/api/users/me/partners/{partnerId}
|
|
14570
|
+
* @secure
|
|
14571
|
+
* @response `204` `void` No Content
|
|
14572
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14573
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14574
|
+
*/
|
|
14575
|
+
addMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14576
|
+
/**
|
|
14577
|
+
* No description
|
|
14578
|
+
*
|
|
14579
|
+
* @tags UsersMe
|
|
14580
|
+
* @name RemoveMyPartner
|
|
14581
|
+
* @summary Remove My Partner
|
|
14582
|
+
* @request DELETE:/api/users/me/partners/{partnerId}
|
|
14583
|
+
* @secure
|
|
14584
|
+
* @response `204` `void` No Content
|
|
14585
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14586
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14587
|
+
*/
|
|
14588
|
+
removeMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14589
|
+
/**
|
|
14590
|
+
* @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
|
|
14591
|
+
*
|
|
14592
|
+
* @tags UsersMe
|
|
14593
|
+
* @name GetMyPartnerLinks
|
|
14594
|
+
* @summary Get My Partner Links
|
|
14595
|
+
* @request GET:/api/users/me/partner-links
|
|
14596
|
+
* @secure
|
|
14597
|
+
* @response `200` `PartnerLinks` OK
|
|
14598
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14599
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14600
|
+
*/
|
|
14601
|
+
getMyPartnerLinks: (params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
|
|
14602
|
+
/**
|
|
14603
|
+
* @description Changes the short name the partner's links carry and returns the links rebuilt with it. Links shared with the previous name stop working.
|
|
14604
|
+
*
|
|
14605
|
+
* @tags UsersMe
|
|
14606
|
+
* @name UpdateMyPartnerLinkSlug
|
|
14607
|
+
* @summary Update My Partner Link Slug
|
|
14608
|
+
* @request PUT:/api/users/me/partner-links/slug
|
|
14609
|
+
* @secure
|
|
14610
|
+
* @response `200` `PartnerLinks` OK
|
|
14611
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14612
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14613
|
+
* @response `409` `ProblemDetails` Conflict
|
|
14614
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14615
|
+
*/
|
|
14616
|
+
updateMyPartnerLinkSlug: (data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
|
|
14346
14617
|
/**
|
|
14347
14618
|
* No description
|
|
14348
14619
|
*
|