@matech/thebigpos-sdk 3.18.0-dev-6756 → 3.18.0-main-6759
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 +517 -791
- package/dist/index.js +1 -181
- package/dist/index.js.map +1 -1
- package/package.json +9 -4
- package/src/index.ts +17 -455
package/src/index.ts
CHANGED
|
@@ -69,8 +69,6 @@ export type PendingInviteStatus =
|
|
|
69
69
|
| "InviteExpired"
|
|
70
70
|
| "NotInvited";
|
|
71
71
|
|
|
72
|
-
export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
|
|
73
|
-
|
|
74
72
|
export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
|
|
75
73
|
|
|
76
74
|
export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
|
|
@@ -382,15 +380,6 @@ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
|
|
|
382
380
|
|
|
383
381
|
export type LoanGenderType = "Male" | "Female";
|
|
384
382
|
|
|
385
|
-
export type LoanFieldDataType =
|
|
386
|
-
| "Text"
|
|
387
|
-
| "Number"
|
|
388
|
-
| "Boolean"
|
|
389
|
-
| "Date"
|
|
390
|
-
| "Enum"
|
|
391
|
-
| "Identifier"
|
|
392
|
-
| "Object";
|
|
393
|
-
|
|
394
383
|
export type LoanDocumentType =
|
|
395
384
|
| "W2"
|
|
396
385
|
| "Paystub"
|
|
@@ -660,11 +649,6 @@ export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
|
660
649
|
|
|
661
650
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
662
651
|
|
|
663
|
-
export type BulkLoanFieldOperationType =
|
|
664
|
-
| "SetAccess"
|
|
665
|
-
| "SetAiEnabled"
|
|
666
|
-
| "ResetToDefaults";
|
|
667
|
-
|
|
668
652
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
669
653
|
|
|
670
654
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -898,7 +882,6 @@ export interface Account {
|
|
|
898
882
|
updatedAt?: string | null;
|
|
899
883
|
/** @format int32 */
|
|
900
884
|
allowedLoginsWithoutMFA: number;
|
|
901
|
-
isPartnerPortalEnabled: boolean;
|
|
902
885
|
losSettings: LOSSettings;
|
|
903
886
|
asoSettings?: ASOSettings | null;
|
|
904
887
|
settings: AccountSettings;
|
|
@@ -929,14 +912,12 @@ export interface AccountSettings {
|
|
|
929
912
|
smsNumber?: string | null;
|
|
930
913
|
ssoHostOverride?: string | null;
|
|
931
914
|
isEarlyAdopter: boolean;
|
|
932
|
-
allowLoanOfficerPartnerInvites: boolean;
|
|
933
915
|
}
|
|
934
916
|
|
|
935
917
|
export interface AccountSettingsRequest {
|
|
936
918
|
isSmsEnabled: boolean;
|
|
937
919
|
smsNumber?: string | null;
|
|
938
920
|
isEarlyAdopter: boolean;
|
|
939
|
-
allowLoanOfficerPartnerInvites?: boolean | null;
|
|
940
921
|
}
|
|
941
922
|
|
|
942
923
|
export interface Address {
|
|
@@ -1958,24 +1939,6 @@ export interface BranchUserPaginated {
|
|
|
1958
1939
|
count: number;
|
|
1959
1940
|
}
|
|
1960
1941
|
|
|
1961
|
-
export interface BulkLoanFieldOperation {
|
|
1962
|
-
applied: string[];
|
|
1963
|
-
skipped: BulkLoanFieldSkip[];
|
|
1964
|
-
}
|
|
1965
|
-
|
|
1966
|
-
export interface BulkLoanFieldOperationRequest {
|
|
1967
|
-
fieldKeys: string[];
|
|
1968
|
-
operation?: BulkLoanFieldOperationType | null;
|
|
1969
|
-
role?: UserRole | null;
|
|
1970
|
-
accessLevel?: CustomFieldAccessLevel | null;
|
|
1971
|
-
enabled?: boolean | null;
|
|
1972
|
-
}
|
|
1973
|
-
|
|
1974
|
-
export interface BulkLoanFieldSkip {
|
|
1975
|
-
fieldKey: string;
|
|
1976
|
-
reason: string;
|
|
1977
|
-
}
|
|
1978
|
-
|
|
1979
1942
|
export interface BulkLoanTaskFailure {
|
|
1980
1943
|
/** @format uuid */
|
|
1981
1944
|
userLoanTaskID: string;
|
|
@@ -2485,7 +2448,6 @@ export interface CreateAccountRequest {
|
|
|
2485
2448
|
domain: string;
|
|
2486
2449
|
eConsentBucket?: string | null;
|
|
2487
2450
|
ignoreCoBorrowerRelationship: boolean;
|
|
2488
|
-
isPartnerPortalEnabled: boolean;
|
|
2489
2451
|
user: AdminUser;
|
|
2490
2452
|
companyAddress: CompanyAddress;
|
|
2491
2453
|
contactInfo: ContactInfo;
|
|
@@ -3019,7 +2981,6 @@ export interface DraftRequest {
|
|
|
3019
2981
|
applicationPayload: any;
|
|
3020
2982
|
customData?: any | null;
|
|
3021
2983
|
isCoBorrower: boolean;
|
|
3022
|
-
partnerId?: string | null;
|
|
3023
2984
|
}
|
|
3024
2985
|
|
|
3025
2986
|
export interface EconsentPendingSummary {
|
|
@@ -4049,7 +4010,6 @@ export interface LoanApplicationRequest {
|
|
|
4049
4010
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
4050
4011
|
/** @format uuid */
|
|
4051
4012
|
draftId?: string | null;
|
|
4052
|
-
partnerId?: string | null;
|
|
4053
4013
|
additionalFields?: Record<string, any> | null;
|
|
4054
4014
|
/** @format uuid */
|
|
4055
4015
|
existingLoanId?: string | null;
|
|
@@ -5053,8 +5013,6 @@ export interface LoanDocumentFolderPermissionRequest {
|
|
|
5053
5013
|
export interface LoanDocumentFolderSearchCriteria {
|
|
5054
5014
|
searchText?: string | null;
|
|
5055
5015
|
isActive?: boolean | null;
|
|
5056
|
-
isSystemDefault?: boolean | null;
|
|
5057
|
-
role?: LoanRole | null;
|
|
5058
5016
|
}
|
|
5059
5017
|
|
|
5060
5018
|
export interface LoanDocumentFolderSummary {
|
|
@@ -5155,20 +5113,6 @@ export interface LoanFieldAccess {
|
|
|
5155
5113
|
export interface LoanFieldAccessItem {
|
|
5156
5114
|
fieldKey: string;
|
|
5157
5115
|
access: LoanFieldAccessItemAccessEnum;
|
|
5158
|
-
patchPath?: string | null;
|
|
5159
|
-
}
|
|
5160
|
-
|
|
5161
|
-
export interface LoanFieldMappings {
|
|
5162
|
-
encompassFieldIds: string[];
|
|
5163
|
-
templateToken: string;
|
|
5164
|
-
}
|
|
5165
|
-
|
|
5166
|
-
export interface LoanFieldPermissionsRequest {
|
|
5167
|
-
permissions: CustomFieldPermissionRequest[];
|
|
5168
|
-
}
|
|
5169
|
-
|
|
5170
|
-
export interface LoanFieldSettingsRequest {
|
|
5171
|
-
isAiEnabled?: boolean | null;
|
|
5172
5116
|
}
|
|
5173
5117
|
|
|
5174
5118
|
export interface LoanFinancial {
|
|
@@ -5311,7 +5255,6 @@ export interface LoanList {
|
|
|
5311
5255
|
buyerAgentContact?: LoanContactList | null;
|
|
5312
5256
|
sellerAgentContact?: LoanContactList | null;
|
|
5313
5257
|
userLoans: UserLoan[];
|
|
5314
|
-
myLoanRoles: LoanRole[];
|
|
5315
5258
|
contacts: LoanContact[];
|
|
5316
5259
|
borrowers: LoanListBorrower[];
|
|
5317
5260
|
taskCounts: LoanTaskCounts;
|
|
@@ -6276,20 +6219,6 @@ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
|
|
|
6276
6219
|
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
6277
6220
|
};
|
|
6278
6221
|
|
|
6279
|
-
export interface MyPartner {
|
|
6280
|
-
/** @format uuid */
|
|
6281
|
-
partnerID?: string | null;
|
|
6282
|
-
/** @format uuid */
|
|
6283
|
-
inviteID?: string | null;
|
|
6284
|
-
firstName: string;
|
|
6285
|
-
lastName: string;
|
|
6286
|
-
email: string;
|
|
6287
|
-
phone?: string | null;
|
|
6288
|
-
tier: MyPartnerTierEnum;
|
|
6289
|
-
/** @format date-time */
|
|
6290
|
-
createdAt: string;
|
|
6291
|
-
}
|
|
6292
|
-
|
|
6293
6222
|
export type MyTasksWidgetConfig = UtilRequiredKeys<
|
|
6294
6223
|
BaseCanvasWidgetConfig,
|
|
6295
6224
|
"type"
|
|
@@ -6488,26 +6417,6 @@ export interface Pagination {
|
|
|
6488
6417
|
pageSize: number;
|
|
6489
6418
|
}
|
|
6490
6419
|
|
|
6491
|
-
export interface PartnerFormLink {
|
|
6492
|
-
/** @format int32 */
|
|
6493
|
-
formType: number;
|
|
6494
|
-
name: string;
|
|
6495
|
-
url: string;
|
|
6496
|
-
}
|
|
6497
|
-
|
|
6498
|
-
export interface PartnerLinks {
|
|
6499
|
-
slug: string;
|
|
6500
|
-
loanOfficers: PartnerLoanOfficerLinks[];
|
|
6501
|
-
}
|
|
6502
|
-
|
|
6503
|
-
export interface PartnerLoanOfficerLinks {
|
|
6504
|
-
/** @format uuid */
|
|
6505
|
-
loanOfficerId: string;
|
|
6506
|
-
name: string;
|
|
6507
|
-
siteUrl: string;
|
|
6508
|
-
links: PartnerFormLink[];
|
|
6509
|
-
}
|
|
6510
|
-
|
|
6511
6420
|
export interface PartnerSearchCriteria {
|
|
6512
6421
|
searchText?: string | null;
|
|
6513
6422
|
isActive?: boolean | null;
|
|
@@ -6515,10 +6424,6 @@ export interface PartnerSearchCriteria {
|
|
|
6515
6424
|
roles?: UserRole[] | null;
|
|
6516
6425
|
}
|
|
6517
6426
|
|
|
6518
|
-
export interface PartnerSlug {
|
|
6519
|
-
slug: string;
|
|
6520
|
-
}
|
|
6521
|
-
|
|
6522
6427
|
export interface PendingInvite {
|
|
6523
6428
|
status: PendingInviteStatusEnum;
|
|
6524
6429
|
/** @format uuid */
|
|
@@ -7141,7 +7046,6 @@ export interface SiteConfiguration {
|
|
|
7141
7046
|
user?: UserPublic | null;
|
|
7142
7047
|
asoSettings?: ASOSettings | null;
|
|
7143
7048
|
accountSettings: AccountSettings;
|
|
7144
|
-
isPartnerPortalEnabled: boolean;
|
|
7145
7049
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
7146
7050
|
mobileSettings?: MobileSettings | null;
|
|
7147
7051
|
losSettings?: LOSSettings | null;
|
|
@@ -7337,7 +7241,6 @@ export interface SiteConfigurationByUrl {
|
|
|
7337
7241
|
user?: UserPublic | null;
|
|
7338
7242
|
asoSettings?: ASOSettings | null;
|
|
7339
7243
|
accountSettings: AccountSettings;
|
|
7340
|
-
isPartnerPortalEnabled: boolean;
|
|
7341
7244
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
7342
7245
|
mobileSettings?: MobileSettings | null;
|
|
7343
7246
|
losSettings?: LOSSettings | null;
|
|
@@ -7706,20 +7609,6 @@ export interface SocialSurveyRecord {
|
|
|
7706
7609
|
reviewCompletedTimeStamp?: string | null;
|
|
7707
7610
|
}
|
|
7708
7611
|
|
|
7709
|
-
export interface StandardLoanField {
|
|
7710
|
-
fieldKey: string;
|
|
7711
|
-
displayName: string;
|
|
7712
|
-
category: string;
|
|
7713
|
-
dataType: StandardLoanFieldDataTypeEnum;
|
|
7714
|
-
isPii: boolean;
|
|
7715
|
-
isWritable: boolean;
|
|
7716
|
-
patchPath?: string | null;
|
|
7717
|
-
mappings: LoanFieldMappings;
|
|
7718
|
-
access: Record<string, CustomFieldAccessLevel>;
|
|
7719
|
-
isCustomized: boolean;
|
|
7720
|
-
isAiEnabled?: boolean | null;
|
|
7721
|
-
}
|
|
7722
|
-
|
|
7723
7612
|
export interface SupportedModel {
|
|
7724
7613
|
modelId: string;
|
|
7725
7614
|
displayName: string;
|
|
@@ -8158,14 +8047,6 @@ export interface UpdateMobilePhoneRequest {
|
|
|
8158
8047
|
phone: string;
|
|
8159
8048
|
}
|
|
8160
8049
|
|
|
8161
|
-
export interface UpdatePartnerPortalRequest {
|
|
8162
|
-
isEnabled?: boolean | null;
|
|
8163
|
-
}
|
|
8164
|
-
|
|
8165
|
-
export interface UpdatePartnerSlugRequest {
|
|
8166
|
-
slug: string;
|
|
8167
|
-
}
|
|
8168
|
-
|
|
8169
8050
|
export interface UpdateUserGroupRequest {
|
|
8170
8051
|
name: string;
|
|
8171
8052
|
description?: string | null;
|
|
@@ -9619,8 +9500,6 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
|
|
|
9619
9500
|
|
|
9620
9501
|
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
9621
9502
|
|
|
9622
|
-
export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
|
|
9623
|
-
|
|
9624
9503
|
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
9625
9504
|
|
|
9626
9505
|
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
@@ -9703,15 +9582,6 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
|
9703
9582
|
|
|
9704
9583
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
9705
9584
|
|
|
9706
|
-
export type StandardLoanFieldDataTypeEnum =
|
|
9707
|
-
| "Text"
|
|
9708
|
-
| "Number"
|
|
9709
|
-
| "Boolean"
|
|
9710
|
-
| "Date"
|
|
9711
|
-
| "Enum"
|
|
9712
|
-
| "Identifier"
|
|
9713
|
-
| "Object";
|
|
9714
|
-
|
|
9715
9585
|
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
9716
9586
|
|
|
9717
9587
|
export type UnregisteredBorrowerRoleEnum =
|
|
@@ -10353,33 +10223,6 @@ export class Api<
|
|
|
10353
10223
|
...params,
|
|
10354
10224
|
}),
|
|
10355
10225
|
|
|
10356
|
-
/**
|
|
10357
|
-
* @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.
|
|
10358
|
-
*
|
|
10359
|
-
* @tags Accounts
|
|
10360
|
-
* @name UpdateAccountPartnerPortal
|
|
10361
|
-
* @summary Update partner portal switch
|
|
10362
|
-
* @request PUT:/api/accounts/{id}/partner-portal
|
|
10363
|
-
* @secure
|
|
10364
|
-
* @response `200` `Account` OK
|
|
10365
|
-
* @response `404` `ProblemDetails` Not Found
|
|
10366
|
-
* @response `422` `ProblemDetails` Unprocessable Content
|
|
10367
|
-
*/
|
|
10368
|
-
updateAccountPartnerPortal: (
|
|
10369
|
-
id: string,
|
|
10370
|
-
data: UpdatePartnerPortalRequest,
|
|
10371
|
-
params: RequestParams = {},
|
|
10372
|
-
) =>
|
|
10373
|
-
this.request<Account, ProblemDetails>({
|
|
10374
|
-
path: `/api/accounts/${id}/partner-portal`,
|
|
10375
|
-
method: "PUT",
|
|
10376
|
-
body: data,
|
|
10377
|
-
secure: true,
|
|
10378
|
-
type: "application/json",
|
|
10379
|
-
format: "json",
|
|
10380
|
-
...params,
|
|
10381
|
-
}),
|
|
10382
|
-
|
|
10383
10226
|
/**
|
|
10384
10227
|
* No description
|
|
10385
10228
|
*
|
|
@@ -15139,14 +14982,13 @@ export class Api<
|
|
|
15139
14982
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
15140
14983
|
* @secure
|
|
15141
14984
|
* @response `204` `void` No Content
|
|
15142
|
-
* @response `403` `HttpError` Forbidden
|
|
15143
14985
|
*/
|
|
15144
14986
|
deleteFormSubmissionFile: (
|
|
15145
14987
|
formSubmissionFileId: string,
|
|
15146
14988
|
formSubmissionId: string,
|
|
15147
14989
|
params: RequestParams = {},
|
|
15148
14990
|
) =>
|
|
15149
|
-
this.request<void,
|
|
14991
|
+
this.request<void, any>({
|
|
15150
14992
|
path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`,
|
|
15151
14993
|
method: "DELETE",
|
|
15152
14994
|
secure: true,
|
|
@@ -15162,7 +15004,6 @@ export class Api<
|
|
|
15162
15004
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
15163
15005
|
* @secure
|
|
15164
15006
|
* @response `200` `FileWithBytes` OK
|
|
15165
|
-
* @response `403` `HttpError` Forbidden
|
|
15166
15007
|
*/
|
|
15167
15008
|
downloadFormSubmissionFile: (
|
|
15168
15009
|
formSubmissionFileId: string,
|
|
@@ -15173,7 +15014,7 @@ export class Api<
|
|
|
15173
15014
|
},
|
|
15174
15015
|
params: RequestParams = {},
|
|
15175
15016
|
) =>
|
|
15176
|
-
this.request<FileWithBytes,
|
|
15017
|
+
this.request<FileWithBytes, any>({
|
|
15177
15018
|
path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`,
|
|
15178
15019
|
method: "GET",
|
|
15179
15020
|
query: query,
|
|
@@ -15191,7 +15032,6 @@ export class Api<
|
|
|
15191
15032
|
* @request GET:/api/form-submissions
|
|
15192
15033
|
* @secure
|
|
15193
15034
|
* @response `200` `FormSubmissionPaginated` OK
|
|
15194
|
-
* @response `403` `HttpError` Forbidden
|
|
15195
15035
|
*/
|
|
15196
15036
|
getFormSubmissions: (
|
|
15197
15037
|
query?: {
|
|
@@ -15204,7 +15044,7 @@ export class Api<
|
|
|
15204
15044
|
},
|
|
15205
15045
|
params: RequestParams = {},
|
|
15206
15046
|
) =>
|
|
15207
|
-
this.request<FormSubmissionPaginated,
|
|
15047
|
+
this.request<FormSubmissionPaginated, any>({
|
|
15208
15048
|
path: `/api/form-submissions`,
|
|
15209
15049
|
method: "GET",
|
|
15210
15050
|
query: query,
|
|
@@ -15250,10 +15090,9 @@ export class Api<
|
|
|
15250
15090
|
* @request GET:/api/form-submissions/{id}
|
|
15251
15091
|
* @secure
|
|
15252
15092
|
* @response `200` `FormSubmission` OK
|
|
15253
|
-
* @response `403` `HttpError` Forbidden
|
|
15254
15093
|
*/
|
|
15255
15094
|
getFormSubmission: (id: string, params: RequestParams = {}) =>
|
|
15256
|
-
this.request<FormSubmission,
|
|
15095
|
+
this.request<FormSubmission, any>({
|
|
15257
15096
|
path: `/api/form-submissions/${id}`,
|
|
15258
15097
|
method: "GET",
|
|
15259
15098
|
secure: true,
|
|
@@ -15270,14 +15109,13 @@ export class Api<
|
|
|
15270
15109
|
* @request PUT:/api/form-submissions/{id}
|
|
15271
15110
|
* @secure
|
|
15272
15111
|
* @response `200` `FormSubmission` OK
|
|
15273
|
-
* @response `403` `HttpError` Forbidden
|
|
15274
15112
|
*/
|
|
15275
15113
|
replaceFormSubmission: (
|
|
15276
15114
|
id: string,
|
|
15277
15115
|
data: FormSubmissionRequest,
|
|
15278
15116
|
params: RequestParams = {},
|
|
15279
15117
|
) =>
|
|
15280
|
-
this.request<FormSubmission,
|
|
15118
|
+
this.request<FormSubmission, any>({
|
|
15281
15119
|
path: `/api/form-submissions/${id}`,
|
|
15282
15120
|
method: "PUT",
|
|
15283
15121
|
body: data,
|
|
@@ -15296,10 +15134,9 @@ export class Api<
|
|
|
15296
15134
|
* @request DELETE:/api/form-submissions/{id}
|
|
15297
15135
|
* @secure
|
|
15298
15136
|
* @response `204` `void` No Content
|
|
15299
|
-
* @response `403` `HttpError` Forbidden
|
|
15300
15137
|
*/
|
|
15301
15138
|
deleteFormSubmission: (id: string, params: RequestParams = {}) =>
|
|
15302
|
-
this.request<void,
|
|
15139
|
+
this.request<void, any>({
|
|
15303
15140
|
path: `/api/form-submissions/${id}`,
|
|
15304
15141
|
method: "DELETE",
|
|
15305
15142
|
secure: true,
|
|
@@ -15315,7 +15152,6 @@ export class Api<
|
|
|
15315
15152
|
* @request POST:/api/form-submissions/search
|
|
15316
15153
|
* @secure
|
|
15317
15154
|
* @response `200` `FormSubmissionPaginated` OK
|
|
15318
|
-
* @response `403` `HttpError` Forbidden
|
|
15319
15155
|
*/
|
|
15320
15156
|
searchFormSubmissions: (
|
|
15321
15157
|
data: FormSubmissionSearchCriteria,
|
|
@@ -15329,7 +15165,7 @@ export class Api<
|
|
|
15329
15165
|
},
|
|
15330
15166
|
params: RequestParams = {},
|
|
15331
15167
|
) =>
|
|
15332
|
-
this.request<FormSubmissionPaginated,
|
|
15168
|
+
this.request<FormSubmissionPaginated, any>({
|
|
15333
15169
|
path: `/api/form-submissions/search`,
|
|
15334
15170
|
method: "POST",
|
|
15335
15171
|
query: query,
|
|
@@ -15821,7 +15657,6 @@ export class Api<
|
|
|
15821
15657
|
* @request POST:/api/listings/{listingId}/files
|
|
15822
15658
|
* @secure
|
|
15823
15659
|
* @response `200` `ListingFile` OK
|
|
15824
|
-
* @response `403` `HttpError` Forbidden
|
|
15825
15660
|
*/
|
|
15826
15661
|
addListingFile: (
|
|
15827
15662
|
listingId: string,
|
|
@@ -15833,7 +15668,7 @@ export class Api<
|
|
|
15833
15668
|
},
|
|
15834
15669
|
params: RequestParams = {},
|
|
15835
15670
|
) =>
|
|
15836
|
-
this.request<ListingFile,
|
|
15671
|
+
this.request<ListingFile, any>({
|
|
15837
15672
|
path: `/api/listings/${listingId}/files`,
|
|
15838
15673
|
method: "POST",
|
|
15839
15674
|
body: data,
|
|
@@ -15852,14 +15687,13 @@ export class Api<
|
|
|
15852
15687
|
* @request PATCH:/api/listings/{listingId}/files
|
|
15853
15688
|
* @secure
|
|
15854
15689
|
* @response `200` `ListingFile` OK
|
|
15855
|
-
* @response `403` `HttpError` Forbidden
|
|
15856
15690
|
*/
|
|
15857
15691
|
updateListingFiles: (
|
|
15858
15692
|
listingId: string,
|
|
15859
15693
|
data: JsonPatchDocument,
|
|
15860
15694
|
params: RequestParams = {},
|
|
15861
15695
|
) =>
|
|
15862
|
-
this.request<ListingFile,
|
|
15696
|
+
this.request<ListingFile, any>({
|
|
15863
15697
|
path: `/api/listings/${listingId}/files`,
|
|
15864
15698
|
method: "PATCH",
|
|
15865
15699
|
body: data,
|
|
@@ -15878,14 +15712,13 @@ export class Api<
|
|
|
15878
15712
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
15879
15713
|
* @secure
|
|
15880
15714
|
* @response `204` `Listing` No Content
|
|
15881
|
-
* @response `403` `HttpError` Forbidden
|
|
15882
15715
|
*/
|
|
15883
15716
|
removeListingFile: (
|
|
15884
15717
|
listingId: string,
|
|
15885
15718
|
id: string,
|
|
15886
15719
|
params: RequestParams = {},
|
|
15887
15720
|
) =>
|
|
15888
|
-
this.request<Listing,
|
|
15721
|
+
this.request<Listing, any>({
|
|
15889
15722
|
path: `/api/listings/${listingId}/files/${id}`,
|
|
15890
15723
|
method: "DELETE",
|
|
15891
15724
|
secure: true,
|
|
@@ -15902,7 +15735,6 @@ export class Api<
|
|
|
15902
15735
|
* @request POST:/api/listings/{listingId}/photos
|
|
15903
15736
|
* @secure
|
|
15904
15737
|
* @response `200` `ListingPhoto` OK
|
|
15905
|
-
* @response `403` `HttpError` Forbidden
|
|
15906
15738
|
*/
|
|
15907
15739
|
addListingPhoto: (
|
|
15908
15740
|
listingId: string,
|
|
@@ -15916,7 +15748,7 @@ export class Api<
|
|
|
15916
15748
|
},
|
|
15917
15749
|
params: RequestParams = {},
|
|
15918
15750
|
) =>
|
|
15919
|
-
this.request<ListingPhoto,
|
|
15751
|
+
this.request<ListingPhoto, any>({
|
|
15920
15752
|
path: `/api/listings/${listingId}/photos`,
|
|
15921
15753
|
method: "POST",
|
|
15922
15754
|
body: data,
|
|
@@ -15935,14 +15767,13 @@ export class Api<
|
|
|
15935
15767
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
15936
15768
|
* @secure
|
|
15937
15769
|
* @response `200` `(ListingPhoto)[]` OK
|
|
15938
|
-
* @response `403` `HttpError` Forbidden
|
|
15939
15770
|
*/
|
|
15940
15771
|
updateListingPhotos: (
|
|
15941
15772
|
listingId: string,
|
|
15942
15773
|
data: JsonPatchDocument,
|
|
15943
15774
|
params: RequestParams = {},
|
|
15944
15775
|
) =>
|
|
15945
|
-
this.request<ListingPhoto[],
|
|
15776
|
+
this.request<ListingPhoto[], any>({
|
|
15946
15777
|
path: `/api/listings/${listingId}/photos`,
|
|
15947
15778
|
method: "PATCH",
|
|
15948
15779
|
body: data,
|
|
@@ -15961,14 +15792,13 @@ export class Api<
|
|
|
15961
15792
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
15962
15793
|
* @secure
|
|
15963
15794
|
* @response `204` `Listing` No Content
|
|
15964
|
-
* @response `403` `HttpError` Forbidden
|
|
15965
15795
|
*/
|
|
15966
15796
|
removeListingPhoto: (
|
|
15967
15797
|
listingId: string,
|
|
15968
15798
|
id: string,
|
|
15969
15799
|
params: RequestParams = {},
|
|
15970
15800
|
) =>
|
|
15971
|
-
this.request<Listing,
|
|
15801
|
+
this.request<Listing, any>({
|
|
15972
15802
|
path: `/api/listings/${listingId}/photos/${id}`,
|
|
15973
15803
|
method: "DELETE",
|
|
15974
15804
|
secure: true,
|
|
@@ -16103,10 +15933,9 @@ export class Api<
|
|
|
16103
15933
|
* @request DELETE:/api/listings/{id}
|
|
16104
15934
|
* @secure
|
|
16105
15935
|
* @response `204` `void` No Content
|
|
16106
|
-
* @response `403` `HttpError` Forbidden
|
|
16107
15936
|
*/
|
|
16108
15937
|
deleteListing: (id: string, params: RequestParams = {}) =>
|
|
16109
|
-
this.request<void,
|
|
15938
|
+
this.request<void, any>({
|
|
16110
15939
|
path: `/api/listings/${id}`,
|
|
16111
15940
|
method: "DELETE",
|
|
16112
15941
|
secure: true,
|
|
@@ -16155,7 +15984,6 @@ export class Api<
|
|
|
16155
15984
|
* @request PUT:/api/listings/{id}/background-image
|
|
16156
15985
|
* @secure
|
|
16157
15986
|
* @response `200` `File` OK
|
|
16158
|
-
* @response `403` `HttpError` Forbidden
|
|
16159
15987
|
*/
|
|
16160
15988
|
updateListingBackgroundImage: (
|
|
16161
15989
|
id: string,
|
|
@@ -16165,7 +15993,7 @@ export class Api<
|
|
|
16165
15993
|
},
|
|
16166
15994
|
params: RequestParams = {},
|
|
16167
15995
|
) =>
|
|
16168
|
-
this.request<File,
|
|
15996
|
+
this.request<File, any>({
|
|
16169
15997
|
path: `/api/listings/${id}/background-image`,
|
|
16170
15998
|
method: "PUT",
|
|
16171
15999
|
body: data,
|
|
@@ -16184,10 +16012,9 @@ export class Api<
|
|
|
16184
16012
|
* @request DELETE:/api/listings/{id}/background-image
|
|
16185
16013
|
* @secure
|
|
16186
16014
|
* @response `204` `void` No Content
|
|
16187
|
-
* @response `403` `HttpError` Forbidden
|
|
16188
16015
|
*/
|
|
16189
16016
|
deleteListingBackgroundImage: (id: string, params: RequestParams = {}) =>
|
|
16190
|
-
this.request<void,
|
|
16017
|
+
this.request<void, any>({
|
|
16191
16018
|
path: `/api/listings/${id}/background-image`,
|
|
16192
16019
|
method: "DELETE",
|
|
16193
16020
|
secure: true,
|
|
@@ -16781,7 +16608,7 @@ export class Api<
|
|
|
16781
16608
|
}),
|
|
16782
16609
|
|
|
16783
16610
|
/**
|
|
16784
|
-
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty
|
|
16611
|
+
* @description Returns the folders the caller can access that are relevant to this loan — every active system-default folder, plus any folder holding a document the caller can read or bound to one of the loan's tasks, even when empty — with the caller's effective accessLevel and the count of documents they can read in each. Upload destinations are the active entries with accessLevel at least Write. Documents that are not assigned to a folder are returned as a synthetic 'Unassigned' folder (ID = empty GUID, isUnassigned = true); filter to its documents with searchLoanDocuments folderScope 'Unassigned' rather than by echoing that ID.
|
|
16785
16612
|
*
|
|
16786
16613
|
* @tags LoanDocumentFoldersForSingleLoan
|
|
16787
16614
|
* @name ListLoanDocumentFolders
|
|
@@ -17330,133 +17157,6 @@ export class Api<
|
|
|
17330
17157
|
...params,
|
|
17331
17158
|
}),
|
|
17332
17159
|
|
|
17333
|
-
/**
|
|
17334
|
-
* No description
|
|
17335
|
-
*
|
|
17336
|
-
* @tags LoanFields
|
|
17337
|
-
* @name GetStandardLoanFields
|
|
17338
|
-
* @summary List standard loan fields with effective access and settings
|
|
17339
|
-
* @request GET:/api/loan-fields/standard
|
|
17340
|
-
* @secure
|
|
17341
|
-
* @response `200` `(StandardLoanField)[]` OK
|
|
17342
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
17343
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
17344
|
-
*/
|
|
17345
|
-
getStandardLoanFields: (params: RequestParams = {}) =>
|
|
17346
|
-
this.request<StandardLoanField[], ProblemDetails>({
|
|
17347
|
-
path: `/api/loan-fields/standard`,
|
|
17348
|
-
method: "GET",
|
|
17349
|
-
secure: true,
|
|
17350
|
-
format: "json",
|
|
17351
|
-
...params,
|
|
17352
|
-
}),
|
|
17353
|
-
|
|
17354
|
-
/**
|
|
17355
|
-
* No description
|
|
17356
|
-
*
|
|
17357
|
-
* @tags LoanFields
|
|
17358
|
-
* @name SetLoanFieldPermissions
|
|
17359
|
-
* @summary Set role access levels on one loan field
|
|
17360
|
-
* @request PUT:/api/loan-fields/{fieldKey}/permissions
|
|
17361
|
-
* @secure
|
|
17362
|
-
* @response `204` `void` No Content
|
|
17363
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
17364
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
17365
|
-
* @response `404` `ProblemDetails` Not Found
|
|
17366
|
-
*/
|
|
17367
|
-
setLoanFieldPermissions: (
|
|
17368
|
-
fieldKey: string,
|
|
17369
|
-
data: LoanFieldPermissionsRequest,
|
|
17370
|
-
params: RequestParams = {},
|
|
17371
|
-
) =>
|
|
17372
|
-
this.request<void, ProblemDetails>({
|
|
17373
|
-
path: `/api/loan-fields/${fieldKey}/permissions`,
|
|
17374
|
-
method: "PUT",
|
|
17375
|
-
body: data,
|
|
17376
|
-
secure: true,
|
|
17377
|
-
type: "application/json",
|
|
17378
|
-
...params,
|
|
17379
|
-
}),
|
|
17380
|
-
|
|
17381
|
-
/**
|
|
17382
|
-
* No description
|
|
17383
|
-
*
|
|
17384
|
-
* @tags LoanFields
|
|
17385
|
-
* @name SetLoanFieldSettings
|
|
17386
|
-
* @summary Set the AI setting on one loan field
|
|
17387
|
-
* @request PUT:/api/loan-fields/{fieldKey}/settings
|
|
17388
|
-
* @secure
|
|
17389
|
-
* @response `204` `void` No Content
|
|
17390
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
17391
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
17392
|
-
* @response `404` `ProblemDetails` Not Found
|
|
17393
|
-
*/
|
|
17394
|
-
setLoanFieldSettings: (
|
|
17395
|
-
fieldKey: string,
|
|
17396
|
-
data: LoanFieldSettingsRequest,
|
|
17397
|
-
params: RequestParams = {},
|
|
17398
|
-
) =>
|
|
17399
|
-
this.request<void, ProblemDetails>({
|
|
17400
|
-
path: `/api/loan-fields/${fieldKey}/settings`,
|
|
17401
|
-
method: "PUT",
|
|
17402
|
-
body: data,
|
|
17403
|
-
secure: true,
|
|
17404
|
-
type: "application/json",
|
|
17405
|
-
...params,
|
|
17406
|
-
}),
|
|
17407
|
-
|
|
17408
|
-
/**
|
|
17409
|
-
* No description
|
|
17410
|
-
*
|
|
17411
|
-
* @tags LoanFields
|
|
17412
|
-
* @name ResetLoanFieldOverrides
|
|
17413
|
-
* @summary Reset one standard loan field to its seeded defaults
|
|
17414
|
-
* @request DELETE:/api/loan-fields/{fieldKey}/overrides
|
|
17415
|
-
* @secure
|
|
17416
|
-
* @response `204` `void` No Content
|
|
17417
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
17418
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
17419
|
-
* @response `404` `ProblemDetails` Not Found
|
|
17420
|
-
*/
|
|
17421
|
-
resetLoanFieldOverrides: (fieldKey: string, params: RequestParams = {}) =>
|
|
17422
|
-
this.request<void, ProblemDetails>({
|
|
17423
|
-
path: `/api/loan-fields/${fieldKey}/overrides`,
|
|
17424
|
-
method: "DELETE",
|
|
17425
|
-
secure: true,
|
|
17426
|
-
...params,
|
|
17427
|
-
}),
|
|
17428
|
-
|
|
17429
|
-
/**
|
|
17430
|
-
* No description
|
|
17431
|
-
*
|
|
17432
|
-
* @tags LoanFields
|
|
17433
|
-
* @name BulkLoanFieldOperation
|
|
17434
|
-
* @summary Apply one operation to many loan fields
|
|
17435
|
-
* @request POST:/api/loan-fields/bulk
|
|
17436
|
-
* @secure
|
|
17437
|
-
* @response `200` `BulkLoanFieldOperation` OK
|
|
17438
|
-
* @response `401` `ProblemDetails` Unauthorized
|
|
17439
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
17440
|
-
* @response `404` `ProblemDetails` Not Found
|
|
17441
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
17442
|
-
*/
|
|
17443
|
-
bulkLoanFieldOperation: (
|
|
17444
|
-
data: BulkLoanFieldOperationRequest,
|
|
17445
|
-
params: RequestParams = {},
|
|
17446
|
-
) =>
|
|
17447
|
-
this.request<
|
|
17448
|
-
BulkLoanFieldOperation,
|
|
17449
|
-
ProblemDetails | UnprocessableEntity
|
|
17450
|
-
>({
|
|
17451
|
-
path: `/api/loan-fields/bulk`,
|
|
17452
|
-
method: "POST",
|
|
17453
|
-
body: data,
|
|
17454
|
-
secure: true,
|
|
17455
|
-
type: "application/json",
|
|
17456
|
-
format: "json",
|
|
17457
|
-
...params,
|
|
17458
|
-
}),
|
|
17459
|
-
|
|
17460
17160
|
/**
|
|
17461
17161
|
* No description
|
|
17462
17162
|
*
|
|
@@ -20067,35 +19767,6 @@ export class Api<
|
|
|
20067
19767
|
...params,
|
|
20068
19768
|
}),
|
|
20069
19769
|
|
|
20070
|
-
/**
|
|
20071
|
-
* @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
|
|
20072
|
-
*
|
|
20073
|
-
* @tags Partners
|
|
20074
|
-
* @name UpdatePartnerLinkSlug
|
|
20075
|
-
* @summary Update Partner Link Slug
|
|
20076
|
-
* @request PUT:/api/partners/{realtorId}/link-slug
|
|
20077
|
-
* @secure
|
|
20078
|
-
* @response `200` `PartnerSlug` OK
|
|
20079
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
20080
|
-
* @response `404` `ProblemDetails` Not Found
|
|
20081
|
-
* @response `409` `ProblemDetails` Conflict
|
|
20082
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
20083
|
-
*/
|
|
20084
|
-
updatePartnerLinkSlug: (
|
|
20085
|
-
realtorId: string,
|
|
20086
|
-
data: UpdatePartnerSlugRequest,
|
|
20087
|
-
params: RequestParams = {},
|
|
20088
|
-
) =>
|
|
20089
|
-
this.request<PartnerSlug, ProblemDetails | UnprocessableEntity>({
|
|
20090
|
-
path: `/api/partners/${realtorId}/link-slug`,
|
|
20091
|
-
method: "PUT",
|
|
20092
|
-
body: data,
|
|
20093
|
-
secure: true,
|
|
20094
|
-
type: "application/json",
|
|
20095
|
-
format: "json",
|
|
20096
|
-
...params,
|
|
20097
|
-
}),
|
|
20098
|
-
|
|
20099
19770
|
/**
|
|
20100
19771
|
* No description
|
|
20101
19772
|
*
|
|
@@ -22993,115 +22664,6 @@ export class Api<
|
|
|
22993
22664
|
...params,
|
|
22994
22665
|
}),
|
|
22995
22666
|
|
|
22996
|
-
/**
|
|
22997
|
-
* @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
|
|
22998
|
-
*
|
|
22999
|
-
* @tags UsersMe
|
|
23000
|
-
* @name GetMyPartners
|
|
23001
|
-
* @summary Get My Partners
|
|
23002
|
-
* @request GET:/api/users/me/partners
|
|
23003
|
-
* @secure
|
|
23004
|
-
* @response `200` `(MyPartner)[]` OK
|
|
23005
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
23006
|
-
*/
|
|
23007
|
-
getMyPartners: (params: RequestParams = {}) =>
|
|
23008
|
-
this.request<MyPartner[], ProblemDetails>({
|
|
23009
|
-
path: `/api/users/me/partners`,
|
|
23010
|
-
method: "GET",
|
|
23011
|
-
secure: true,
|
|
23012
|
-
format: "json",
|
|
23013
|
-
...params,
|
|
23014
|
-
}),
|
|
23015
|
-
|
|
23016
|
-
/**
|
|
23017
|
-
* No description
|
|
23018
|
-
*
|
|
23019
|
-
* @tags UsersMe
|
|
23020
|
-
* @name AddMyPartner
|
|
23021
|
-
* @summary Add My Partner
|
|
23022
|
-
* @request POST:/api/users/me/partners/{partnerId}
|
|
23023
|
-
* @secure
|
|
23024
|
-
* @response `204` `void` No Content
|
|
23025
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
23026
|
-
* @response `404` `ProblemDetails` Not Found
|
|
23027
|
-
*/
|
|
23028
|
-
addMyPartner: (partnerId: string, params: RequestParams = {}) =>
|
|
23029
|
-
this.request<void, ProblemDetails>({
|
|
23030
|
-
path: `/api/users/me/partners/${partnerId}`,
|
|
23031
|
-
method: "POST",
|
|
23032
|
-
secure: true,
|
|
23033
|
-
...params,
|
|
23034
|
-
}),
|
|
23035
|
-
|
|
23036
|
-
/**
|
|
23037
|
-
* No description
|
|
23038
|
-
*
|
|
23039
|
-
* @tags UsersMe
|
|
23040
|
-
* @name RemoveMyPartner
|
|
23041
|
-
* @summary Remove My Partner
|
|
23042
|
-
* @request DELETE:/api/users/me/partners/{partnerId}
|
|
23043
|
-
* @secure
|
|
23044
|
-
* @response `204` `void` No Content
|
|
23045
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
23046
|
-
* @response `404` `ProblemDetails` Not Found
|
|
23047
|
-
*/
|
|
23048
|
-
removeMyPartner: (partnerId: string, params: RequestParams = {}) =>
|
|
23049
|
-
this.request<void, ProblemDetails>({
|
|
23050
|
-
path: `/api/users/me/partners/${partnerId}`,
|
|
23051
|
-
method: "DELETE",
|
|
23052
|
-
secure: true,
|
|
23053
|
-
...params,
|
|
23054
|
-
}),
|
|
23055
|
-
|
|
23056
|
-
/**
|
|
23057
|
-
* @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
|
|
23058
|
-
*
|
|
23059
|
-
* @tags UsersMe
|
|
23060
|
-
* @name GetMyPartnerLinks
|
|
23061
|
-
* @summary Get My Partner Links
|
|
23062
|
-
* @request GET:/api/users/me/partner-links
|
|
23063
|
-
* @secure
|
|
23064
|
-
* @response `200` `PartnerLinks` OK
|
|
23065
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
23066
|
-
* @response `404` `ProblemDetails` Not Found
|
|
23067
|
-
*/
|
|
23068
|
-
getMyPartnerLinks: (params: RequestParams = {}) =>
|
|
23069
|
-
this.request<PartnerLinks, ProblemDetails>({
|
|
23070
|
-
path: `/api/users/me/partner-links`,
|
|
23071
|
-
method: "GET",
|
|
23072
|
-
secure: true,
|
|
23073
|
-
format: "json",
|
|
23074
|
-
...params,
|
|
23075
|
-
}),
|
|
23076
|
-
|
|
23077
|
-
/**
|
|
23078
|
-
* @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.
|
|
23079
|
-
*
|
|
23080
|
-
* @tags UsersMe
|
|
23081
|
-
* @name UpdateMyPartnerLinkSlug
|
|
23082
|
-
* @summary Update My Partner Link Slug
|
|
23083
|
-
* @request PUT:/api/users/me/partner-links/slug
|
|
23084
|
-
* @secure
|
|
23085
|
-
* @response `200` `PartnerLinks` OK
|
|
23086
|
-
* @response `403` `ProblemDetails` Forbidden
|
|
23087
|
-
* @response `404` `ProblemDetails` Not Found
|
|
23088
|
-
* @response `409` `ProblemDetails` Conflict
|
|
23089
|
-
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
23090
|
-
*/
|
|
23091
|
-
updateMyPartnerLinkSlug: (
|
|
23092
|
-
data: UpdatePartnerSlugRequest,
|
|
23093
|
-
params: RequestParams = {},
|
|
23094
|
-
) =>
|
|
23095
|
-
this.request<PartnerLinks, ProblemDetails | UnprocessableEntity>({
|
|
23096
|
-
path: `/api/users/me/partner-links/slug`,
|
|
23097
|
-
method: "PUT",
|
|
23098
|
-
body: data,
|
|
23099
|
-
secure: true,
|
|
23100
|
-
type: "application/json",
|
|
23101
|
-
format: "json",
|
|
23102
|
-
...params,
|
|
23103
|
-
}),
|
|
23104
|
-
|
|
23105
22667
|
/**
|
|
23106
22668
|
* No description
|
|
23107
22669
|
*
|