@matech/thebigpos-sdk 3.18.0-dev-6743 → 3.18.0-dev-6750
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 +160 -0
- package/dist/index.js +110 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +256 -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";
|
|
@@ -166,6 +167,7 @@ export interface Account {
|
|
|
166
167
|
updatedAt?: string | null;
|
|
167
168
|
/** @format int32 */
|
|
168
169
|
allowedLoginsWithoutMFA: number;
|
|
170
|
+
isPartnerPortalEnabled: boolean;
|
|
169
171
|
losSettings: LOSSettings;
|
|
170
172
|
asoSettings?: ASOSettings | null;
|
|
171
173
|
settings: AccountSettings;
|
|
@@ -192,11 +194,13 @@ export interface AccountSettings {
|
|
|
192
194
|
smsNumber?: string | null;
|
|
193
195
|
ssoHostOverride?: string | null;
|
|
194
196
|
isEarlyAdopter: boolean;
|
|
197
|
+
allowLoanOfficerPartnerInvites: boolean;
|
|
195
198
|
}
|
|
196
199
|
export interface AccountSettingsRequest {
|
|
197
200
|
isSmsEnabled: boolean;
|
|
198
201
|
smsNumber?: string | null;
|
|
199
202
|
isEarlyAdopter: boolean;
|
|
203
|
+
allowLoanOfficerPartnerInvites?: boolean | null;
|
|
200
204
|
}
|
|
201
205
|
export interface Address {
|
|
202
206
|
/** @format uuid */
|
|
@@ -1559,6 +1563,7 @@ export interface CreateAccountRequest {
|
|
|
1559
1563
|
domain: string;
|
|
1560
1564
|
eConsentBucket?: string | null;
|
|
1561
1565
|
ignoreCoBorrowerRelationship: boolean;
|
|
1566
|
+
isPartnerPortalEnabled: boolean;
|
|
1562
1567
|
user: AdminUser;
|
|
1563
1568
|
companyAddress: CompanyAddress;
|
|
1564
1569
|
contactInfo: ContactInfo;
|
|
@@ -2039,6 +2044,7 @@ export interface DraftRequest {
|
|
|
2039
2044
|
applicationPayload: any;
|
|
2040
2045
|
customData?: any | null;
|
|
2041
2046
|
isCoBorrower: boolean;
|
|
2047
|
+
partnerId?: string | null;
|
|
2042
2048
|
}
|
|
2043
2049
|
export interface EconsentPendingSummary {
|
|
2044
2050
|
/** @format int32 */
|
|
@@ -2973,6 +2979,7 @@ export interface LoanApplicationRequest {
|
|
|
2973
2979
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
2974
2980
|
/** @format uuid */
|
|
2975
2981
|
draftId?: string | null;
|
|
2982
|
+
partnerId?: string | null;
|
|
2976
2983
|
additionalFields?: Record<string, any> | null;
|
|
2977
2984
|
/** @format uuid */
|
|
2978
2985
|
existingLoanId?: string | null;
|
|
@@ -4119,6 +4126,7 @@ export interface LoanList {
|
|
|
4119
4126
|
buyerAgentContact?: LoanContactList | null;
|
|
4120
4127
|
sellerAgentContact?: LoanContactList | null;
|
|
4121
4128
|
userLoans: UserLoan[];
|
|
4129
|
+
myLoanRoles: LoanRole[];
|
|
4122
4130
|
contacts: LoanContact[];
|
|
4123
4131
|
borrowers: LoanListBorrower[];
|
|
4124
4132
|
taskCounts: LoanTaskCounts;
|
|
@@ -4995,6 +5003,19 @@ export interface MonthlyPaymentCalculatorRequest {
|
|
|
4995
5003
|
export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4996
5004
|
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
4997
5005
|
};
|
|
5006
|
+
export interface MyPartner {
|
|
5007
|
+
/** @format uuid */
|
|
5008
|
+
partnerID?: string | null;
|
|
5009
|
+
/** @format uuid */
|
|
5010
|
+
inviteID?: string | null;
|
|
5011
|
+
firstName: string;
|
|
5012
|
+
lastName: string;
|
|
5013
|
+
email: string;
|
|
5014
|
+
phone?: string | null;
|
|
5015
|
+
tier: MyPartnerTierEnum;
|
|
5016
|
+
/** @format date-time */
|
|
5017
|
+
createdAt: string;
|
|
5018
|
+
}
|
|
4998
5019
|
export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
|
|
4999
5020
|
/** @format int32 */
|
|
5000
5021
|
dueWithinDays: number;
|
|
@@ -5170,12 +5191,32 @@ export interface Pagination {
|
|
|
5170
5191
|
/** @format int32 */
|
|
5171
5192
|
pageSize: number;
|
|
5172
5193
|
}
|
|
5194
|
+
export interface PartnerFormLink {
|
|
5195
|
+
/** @format int32 */
|
|
5196
|
+
formType: number;
|
|
5197
|
+
name: string;
|
|
5198
|
+
url: string;
|
|
5199
|
+
}
|
|
5200
|
+
export interface PartnerLinks {
|
|
5201
|
+
slug: string;
|
|
5202
|
+
loanOfficers: PartnerLoanOfficerLinks[];
|
|
5203
|
+
}
|
|
5204
|
+
export interface PartnerLoanOfficerLinks {
|
|
5205
|
+
/** @format uuid */
|
|
5206
|
+
loanOfficerId: string;
|
|
5207
|
+
name: string;
|
|
5208
|
+
siteUrl: string;
|
|
5209
|
+
links: PartnerFormLink[];
|
|
5210
|
+
}
|
|
5173
5211
|
export interface PartnerSearchCriteria {
|
|
5174
5212
|
searchText?: string | null;
|
|
5175
5213
|
isActive?: boolean | null;
|
|
5176
5214
|
brands?: string[] | null;
|
|
5177
5215
|
roles?: UserRole[] | null;
|
|
5178
5216
|
}
|
|
5217
|
+
export interface PartnerSlug {
|
|
5218
|
+
slug: string;
|
|
5219
|
+
}
|
|
5179
5220
|
export interface PendingInvite {
|
|
5180
5221
|
status: PendingInviteStatusEnum;
|
|
5181
5222
|
/** @format uuid */
|
|
@@ -5743,6 +5784,7 @@ export interface SiteConfiguration {
|
|
|
5743
5784
|
user?: UserPublic | null;
|
|
5744
5785
|
asoSettings?: ASOSettings | null;
|
|
5745
5786
|
accountSettings: AccountSettings;
|
|
5787
|
+
isPartnerPortalEnabled: boolean;
|
|
5746
5788
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
5747
5789
|
mobileSettings?: MobileSettings | null;
|
|
5748
5790
|
losSettings?: LOSSettings | null;
|
|
@@ -5937,6 +5979,7 @@ export interface SiteConfigurationByUrl {
|
|
|
5937
5979
|
user?: UserPublic | null;
|
|
5938
5980
|
asoSettings?: ASOSettings | null;
|
|
5939
5981
|
accountSettings: AccountSettings;
|
|
5982
|
+
isPartnerPortalEnabled: boolean;
|
|
5940
5983
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
5941
5984
|
mobileSettings?: MobileSettings | null;
|
|
5942
5985
|
losSettings?: LOSSettings | null;
|
|
@@ -6676,6 +6719,12 @@ export interface UpdateMeRequest {
|
|
|
6676
6719
|
export interface UpdateMobilePhoneRequest {
|
|
6677
6720
|
phone: string;
|
|
6678
6721
|
}
|
|
6722
|
+
export interface UpdatePartnerPortalRequest {
|
|
6723
|
+
isEnabled?: boolean | null;
|
|
6724
|
+
}
|
|
6725
|
+
export interface UpdatePartnerSlugRequest {
|
|
6726
|
+
slug: string;
|
|
6727
|
+
}
|
|
6679
6728
|
export interface UpdateUserGroupRequest {
|
|
6680
6729
|
name: string;
|
|
6681
6730
|
description?: string | null;
|
|
@@ -7333,6 +7382,7 @@ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disa
|
|
|
7333
7382
|
export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
|
|
7334
7383
|
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
7384
|
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
7385
|
+
export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
|
|
7336
7386
|
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
7337
7387
|
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
7338
7388
|
export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
|
|
@@ -7573,6 +7623,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7573
7623
|
* @response `422` `ProblemDetails` Unprocessable Content
|
|
7574
7624
|
*/
|
|
7575
7625
|
updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}, any>>;
|
|
7626
|
+
/**
|
|
7627
|
+
* @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.
|
|
7628
|
+
*
|
|
7629
|
+
* @tags Accounts
|
|
7630
|
+
* @name UpdateAccountPartnerPortal
|
|
7631
|
+
* @summary Update partner portal switch
|
|
7632
|
+
* @request PUT:/api/accounts/{id}/partner-portal
|
|
7633
|
+
* @secure
|
|
7634
|
+
* @response `200` `Account` OK
|
|
7635
|
+
* @response `404` `ProblemDetails` Not Found
|
|
7636
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
7637
|
+
*/
|
|
7638
|
+
updateAccountPartnerPortal: (id: string, data: UpdatePartnerPortalRequest, params?: RequestParams) => Promise<AxiosResponse<Account, any, {}, any>>;
|
|
7576
7639
|
/**
|
|
7577
7640
|
* No description
|
|
7578
7641
|
*
|
|
@@ -10233,6 +10296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10233
10296
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
10234
10297
|
* @secure
|
|
10235
10298
|
* @response `204` `void` No Content
|
|
10299
|
+
* @response `403` `HttpError` Forbidden
|
|
10236
10300
|
*/
|
|
10237
10301
|
deleteFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10238
10302
|
/**
|
|
@@ -10244,6 +10308,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10244
10308
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
10245
10309
|
* @secure
|
|
10246
10310
|
* @response `200` `FileWithBytes` OK
|
|
10311
|
+
* @response `403` `HttpError` Forbidden
|
|
10247
10312
|
*/
|
|
10248
10313
|
downloadFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, query?: {
|
|
10249
10314
|
/** @format uuid */
|
|
@@ -10258,6 +10323,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10258
10323
|
* @request GET:/api/form-submissions
|
|
10259
10324
|
* @secure
|
|
10260
10325
|
* @response `200` `FormSubmissionPaginated` OK
|
|
10326
|
+
* @response `403` `HttpError` Forbidden
|
|
10261
10327
|
*/
|
|
10262
10328
|
getFormSubmissions: (query?: {
|
|
10263
10329
|
/** @format int32 */
|
|
@@ -10289,6 +10355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10289
10355
|
* @request GET:/api/form-submissions/{id}
|
|
10290
10356
|
* @secure
|
|
10291
10357
|
* @response `200` `FormSubmission` OK
|
|
10358
|
+
* @response `403` `HttpError` Forbidden
|
|
10292
10359
|
*/
|
|
10293
10360
|
getFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}, any>>;
|
|
10294
10361
|
/**
|
|
@@ -10300,6 +10367,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10300
10367
|
* @request PUT:/api/form-submissions/{id}
|
|
10301
10368
|
* @secure
|
|
10302
10369
|
* @response `200` `FormSubmission` OK
|
|
10370
|
+
* @response `403` `HttpError` Forbidden
|
|
10303
10371
|
*/
|
|
10304
10372
|
replaceFormSubmission: (id: string, data: FormSubmissionRequest, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}, any>>;
|
|
10305
10373
|
/**
|
|
@@ -10311,6 +10379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10311
10379
|
* @request DELETE:/api/form-submissions/{id}
|
|
10312
10380
|
* @secure
|
|
10313
10381
|
* @response `204` `void` No Content
|
|
10382
|
+
* @response `403` `HttpError` Forbidden
|
|
10314
10383
|
*/
|
|
10315
10384
|
deleteFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10316
10385
|
/**
|
|
@@ -10322,6 +10391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10322
10391
|
* @request POST:/api/form-submissions/search
|
|
10323
10392
|
* @secure
|
|
10324
10393
|
* @response `200` `FormSubmissionPaginated` OK
|
|
10394
|
+
* @response `403` `HttpError` Forbidden
|
|
10325
10395
|
*/
|
|
10326
10396
|
searchFormSubmissions: (data: FormSubmissionSearchCriteria, query?: {
|
|
10327
10397
|
/** @format int32 */
|
|
@@ -10584,6 +10654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10584
10654
|
* @request POST:/api/listings/{listingId}/files
|
|
10585
10655
|
* @secure
|
|
10586
10656
|
* @response `200` `ListingFile` OK
|
|
10657
|
+
* @response `403` `HttpError` Forbidden
|
|
10587
10658
|
*/
|
|
10588
10659
|
addListingFile: (listingId: string, data: {
|
|
10589
10660
|
/** @format binary */
|
|
@@ -10600,6 +10671,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10600
10671
|
* @request PATCH:/api/listings/{listingId}/files
|
|
10601
10672
|
* @secure
|
|
10602
10673
|
* @response `200` `ListingFile` OK
|
|
10674
|
+
* @response `403` `HttpError` Forbidden
|
|
10603
10675
|
*/
|
|
10604
10676
|
updateListingFiles: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingFile, any, {}, any>>;
|
|
10605
10677
|
/**
|
|
@@ -10611,6 +10683,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10611
10683
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
10612
10684
|
* @secure
|
|
10613
10685
|
* @response `204` `Listing` No Content
|
|
10686
|
+
* @response `403` `HttpError` Forbidden
|
|
10614
10687
|
*/
|
|
10615
10688
|
removeListingFile: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}, any>>;
|
|
10616
10689
|
/**
|
|
@@ -10622,6 +10695,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10622
10695
|
* @request POST:/api/listings/{listingId}/photos
|
|
10623
10696
|
* @secure
|
|
10624
10697
|
* @response `200` `ListingPhoto` OK
|
|
10698
|
+
* @response `403` `HttpError` Forbidden
|
|
10625
10699
|
*/
|
|
10626
10700
|
addListingPhoto: (listingId: string, data: {
|
|
10627
10701
|
name?: string;
|
|
@@ -10640,6 +10714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10640
10714
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
10641
10715
|
* @secure
|
|
10642
10716
|
* @response `200` `(ListingPhoto)[]` OK
|
|
10717
|
+
* @response `403` `HttpError` Forbidden
|
|
10643
10718
|
*/
|
|
10644
10719
|
updateListingPhotos: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingPhoto[], any, {}, any>>;
|
|
10645
10720
|
/**
|
|
@@ -10651,6 +10726,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10651
10726
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
10652
10727
|
* @secure
|
|
10653
10728
|
* @response `204` `Listing` No Content
|
|
10729
|
+
* @response `403` `HttpError` Forbidden
|
|
10654
10730
|
*/
|
|
10655
10731
|
removeListingPhoto: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}, any>>;
|
|
10656
10732
|
/**
|
|
@@ -10728,6 +10804,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10728
10804
|
* @request DELETE:/api/listings/{id}
|
|
10729
10805
|
* @secure
|
|
10730
10806
|
* @response `204` `void` No Content
|
|
10807
|
+
* @response `403` `HttpError` Forbidden
|
|
10731
10808
|
*/
|
|
10732
10809
|
deleteListing: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10733
10810
|
/**
|
|
@@ -10757,6 +10834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10757
10834
|
* @request PUT:/api/listings/{id}/background-image
|
|
10758
10835
|
* @secure
|
|
10759
10836
|
* @response `200` `File` OK
|
|
10837
|
+
* @response `403` `HttpError` Forbidden
|
|
10760
10838
|
*/
|
|
10761
10839
|
updateListingBackgroundImage: (id: string, data: {
|
|
10762
10840
|
/** @format binary */
|
|
@@ -10771,6 +10849,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10771
10849
|
* @request DELETE:/api/listings/{id}/background-image
|
|
10772
10850
|
* @secure
|
|
10773
10851
|
* @response `204` `void` No Content
|
|
10852
|
+
* @response `403` `HttpError` Forbidden
|
|
10774
10853
|
*/
|
|
10775
10854
|
deleteListingBackgroundImage: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
10776
10855
|
/**
|
|
@@ -12779,6 +12858,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12779
12858
|
* @response `200` `NotificationTemplateVersion` OK
|
|
12780
12859
|
*/
|
|
12781
12860
|
deleteNotificationTemplateVersion: (notificationId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<NotificationTemplateVersion, any, {}, any>>;
|
|
12861
|
+
/**
|
|
12862
|
+
* @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
|
|
12863
|
+
*
|
|
12864
|
+
* @tags Partners
|
|
12865
|
+
* @name UpdatePartnerLinkSlug
|
|
12866
|
+
* @summary Update Partner Link Slug
|
|
12867
|
+
* @request PUT:/api/partners/{realtorId}/link-slug
|
|
12868
|
+
* @secure
|
|
12869
|
+
* @response `200` `PartnerSlug` OK
|
|
12870
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
12871
|
+
* @response `404` `ProblemDetails` Not Found
|
|
12872
|
+
* @response `409` `ProblemDetails` Conflict
|
|
12873
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
12874
|
+
*/
|
|
12875
|
+
updatePartnerLinkSlug: (realtorId: string, data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerSlug, any, {}, any>>;
|
|
12782
12876
|
/**
|
|
12783
12877
|
* No description
|
|
12784
12878
|
*
|
|
@@ -14343,6 +14437,72 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14343
14437
|
* @response `204` `void` No Content
|
|
14344
14438
|
*/
|
|
14345
14439
|
deleteRelationshipProspect: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14440
|
+
/**
|
|
14441
|
+
* @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
|
|
14442
|
+
*
|
|
14443
|
+
* @tags UsersMe
|
|
14444
|
+
* @name GetMyPartners
|
|
14445
|
+
* @summary Get My Partners
|
|
14446
|
+
* @request GET:/api/users/me/partners
|
|
14447
|
+
* @secure
|
|
14448
|
+
* @response `200` `(MyPartner)[]` OK
|
|
14449
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14450
|
+
*/
|
|
14451
|
+
getMyPartners: (params?: RequestParams) => Promise<AxiosResponse<MyPartner[], any, {}, any>>;
|
|
14452
|
+
/**
|
|
14453
|
+
* No description
|
|
14454
|
+
*
|
|
14455
|
+
* @tags UsersMe
|
|
14456
|
+
* @name AddMyPartner
|
|
14457
|
+
* @summary Add My Partner
|
|
14458
|
+
* @request POST:/api/users/me/partners/{partnerId}
|
|
14459
|
+
* @secure
|
|
14460
|
+
* @response `204` `void` No Content
|
|
14461
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14462
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14463
|
+
*/
|
|
14464
|
+
addMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14465
|
+
/**
|
|
14466
|
+
* No description
|
|
14467
|
+
*
|
|
14468
|
+
* @tags UsersMe
|
|
14469
|
+
* @name RemoveMyPartner
|
|
14470
|
+
* @summary Remove My Partner
|
|
14471
|
+
* @request DELETE:/api/users/me/partners/{partnerId}
|
|
14472
|
+
* @secure
|
|
14473
|
+
* @response `204` `void` No Content
|
|
14474
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14475
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14476
|
+
*/
|
|
14477
|
+
removeMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}, any>>;
|
|
14478
|
+
/**
|
|
14479
|
+
* @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
|
|
14480
|
+
*
|
|
14481
|
+
* @tags UsersMe
|
|
14482
|
+
* @name GetMyPartnerLinks
|
|
14483
|
+
* @summary Get My Partner Links
|
|
14484
|
+
* @request GET:/api/users/me/partner-links
|
|
14485
|
+
* @secure
|
|
14486
|
+
* @response `200` `PartnerLinks` OK
|
|
14487
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14488
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14489
|
+
*/
|
|
14490
|
+
getMyPartnerLinks: (params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
|
|
14491
|
+
/**
|
|
14492
|
+
* @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.
|
|
14493
|
+
*
|
|
14494
|
+
* @tags UsersMe
|
|
14495
|
+
* @name UpdateMyPartnerLinkSlug
|
|
14496
|
+
* @summary Update My Partner Link Slug
|
|
14497
|
+
* @request PUT:/api/users/me/partner-links/slug
|
|
14498
|
+
* @secure
|
|
14499
|
+
* @response `200` `PartnerLinks` OK
|
|
14500
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
14501
|
+
* @response `404` `ProblemDetails` Not Found
|
|
14502
|
+
* @response `409` `ProblemDetails` Conflict
|
|
14503
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
14504
|
+
*/
|
|
14505
|
+
updateMyPartnerLinkSlug: (data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}, any>>;
|
|
14346
14506
|
/**
|
|
14347
14507
|
* No description
|
|
14348
14508
|
*
|
package/dist/index.js
CHANGED
|
@@ -238,6 +238,19 @@ export class Api extends HttpClient {
|
|
|
238
238
|
* @response `422` `ProblemDetails` Unprocessable Content
|
|
239
239
|
*/
|
|
240
240
|
updateAccountBilling: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/billing`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
241
|
+
/**
|
|
242
|
+
* @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.
|
|
243
|
+
*
|
|
244
|
+
* @tags Accounts
|
|
245
|
+
* @name UpdateAccountPartnerPortal
|
|
246
|
+
* @summary Update partner portal switch
|
|
247
|
+
* @request PUT:/api/accounts/{id}/partner-portal
|
|
248
|
+
* @secure
|
|
249
|
+
* @response `200` `Account` OK
|
|
250
|
+
* @response `404` `ProblemDetails` Not Found
|
|
251
|
+
* @response `422` `ProblemDetails` Unprocessable Content
|
|
252
|
+
*/
|
|
253
|
+
updateAccountPartnerPortal: (id, data, params = {}) => this.request(Object.assign({ path: `/api/accounts/${id}/partner-portal`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
241
254
|
/**
|
|
242
255
|
* No description
|
|
243
256
|
*
|
|
@@ -2584,6 +2597,7 @@ export class Api extends HttpClient {
|
|
|
2584
2597
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
2585
2598
|
* @secure
|
|
2586
2599
|
* @response `204` `void` No Content
|
|
2600
|
+
* @response `403` `HttpError` Forbidden
|
|
2587
2601
|
*/
|
|
2588
2602
|
deleteFormSubmissionFile: (formSubmissionFileId, formSubmissionId, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`, method: "DELETE", secure: true }, params)),
|
|
2589
2603
|
/**
|
|
@@ -2595,6 +2609,7 @@ export class Api extends HttpClient {
|
|
|
2595
2609
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
2596
2610
|
* @secure
|
|
2597
2611
|
* @response `200` `FileWithBytes` OK
|
|
2612
|
+
* @response `403` `HttpError` Forbidden
|
|
2598
2613
|
*/
|
|
2599
2614
|
downloadFormSubmissionFile: (formSubmissionFileId, formSubmissionId, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2600
2615
|
/**
|
|
@@ -2606,6 +2621,7 @@ export class Api extends HttpClient {
|
|
|
2606
2621
|
* @request GET:/api/form-submissions
|
|
2607
2622
|
* @secure
|
|
2608
2623
|
* @response `200` `FormSubmissionPaginated` OK
|
|
2624
|
+
* @response `403` `HttpError` Forbidden
|
|
2609
2625
|
*/
|
|
2610
2626
|
getFormSubmissions: (query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions`, method: "GET", query: query, secure: true, format: "json" }, params)),
|
|
2611
2627
|
/**
|
|
@@ -2628,6 +2644,7 @@ export class Api extends HttpClient {
|
|
|
2628
2644
|
* @request GET:/api/form-submissions/{id}
|
|
2629
2645
|
* @secure
|
|
2630
2646
|
* @response `200` `FormSubmission` OK
|
|
2647
|
+
* @response `403` `HttpError` Forbidden
|
|
2631
2648
|
*/
|
|
2632
2649
|
getFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "GET", secure: true, format: "json" }, params)),
|
|
2633
2650
|
/**
|
|
@@ -2639,6 +2656,7 @@ export class Api extends HttpClient {
|
|
|
2639
2656
|
* @request PUT:/api/form-submissions/{id}
|
|
2640
2657
|
* @secure
|
|
2641
2658
|
* @response `200` `FormSubmission` OK
|
|
2659
|
+
* @response `403` `HttpError` Forbidden
|
|
2642
2660
|
*/
|
|
2643
2661
|
replaceFormSubmission: (id, data, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2644
2662
|
/**
|
|
@@ -2650,6 +2668,7 @@ export class Api extends HttpClient {
|
|
|
2650
2668
|
* @request DELETE:/api/form-submissions/{id}
|
|
2651
2669
|
* @secure
|
|
2652
2670
|
* @response `204` `void` No Content
|
|
2671
|
+
* @response `403` `HttpError` Forbidden
|
|
2653
2672
|
*/
|
|
2654
2673
|
deleteFormSubmission: (id, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/${id}`, method: "DELETE", secure: true }, params)),
|
|
2655
2674
|
/**
|
|
@@ -2661,6 +2680,7 @@ export class Api extends HttpClient {
|
|
|
2661
2680
|
* @request POST:/api/form-submissions/search
|
|
2662
2681
|
* @secure
|
|
2663
2682
|
* @response `200` `FormSubmissionPaginated` OK
|
|
2683
|
+
* @response `403` `HttpError` Forbidden
|
|
2664
2684
|
*/
|
|
2665
2685
|
searchFormSubmissions: (data, query, params = {}) => this.request(Object.assign({ path: `/api/form-submissions/search`, method: "POST", query: query, body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2666
2686
|
/**
|
|
@@ -2897,6 +2917,7 @@ export class Api extends HttpClient {
|
|
|
2897
2917
|
* @request POST:/api/listings/{listingId}/files
|
|
2898
2918
|
* @secure
|
|
2899
2919
|
* @response `200` `ListingFile` OK
|
|
2920
|
+
* @response `403` `HttpError` Forbidden
|
|
2900
2921
|
*/
|
|
2901
2922
|
addListingFile: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
2902
2923
|
/**
|
|
@@ -2908,6 +2929,7 @@ export class Api extends HttpClient {
|
|
|
2908
2929
|
* @request PATCH:/api/listings/{listingId}/files
|
|
2909
2930
|
* @secure
|
|
2910
2931
|
* @response `200` `ListingFile` OK
|
|
2932
|
+
* @response `403` `HttpError` Forbidden
|
|
2911
2933
|
*/
|
|
2912
2934
|
updateListingFiles: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2913
2935
|
/**
|
|
@@ -2919,6 +2941,7 @@ export class Api extends HttpClient {
|
|
|
2919
2941
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
2920
2942
|
* @secure
|
|
2921
2943
|
* @response `204` `Listing` No Content
|
|
2944
|
+
* @response `403` `HttpError` Forbidden
|
|
2922
2945
|
*/
|
|
2923
2946
|
removeListingFile: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/files/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2924
2947
|
/**
|
|
@@ -2930,6 +2953,7 @@ export class Api extends HttpClient {
|
|
|
2930
2953
|
* @request POST:/api/listings/{listingId}/photos
|
|
2931
2954
|
* @secure
|
|
2932
2955
|
* @response `200` `ListingPhoto` OK
|
|
2956
|
+
* @response `403` `HttpError` Forbidden
|
|
2933
2957
|
*/
|
|
2934
2958
|
addListingPhoto: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "POST", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
2935
2959
|
/**
|
|
@@ -2941,6 +2965,7 @@ export class Api extends HttpClient {
|
|
|
2941
2965
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
2942
2966
|
* @secure
|
|
2943
2967
|
* @response `200` `(ListingPhoto)[]` OK
|
|
2968
|
+
* @response `403` `HttpError` Forbidden
|
|
2944
2969
|
*/
|
|
2945
2970
|
updateListingPhotos: (listingId, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos`, method: "PATCH", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
2946
2971
|
/**
|
|
@@ -2952,6 +2977,7 @@ export class Api extends HttpClient {
|
|
|
2952
2977
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
2953
2978
|
* @secure
|
|
2954
2979
|
* @response `204` `Listing` No Content
|
|
2980
|
+
* @response `403` `HttpError` Forbidden
|
|
2955
2981
|
*/
|
|
2956
2982
|
removeListingPhoto: (listingId, id, params = {}) => this.request(Object.assign({ path: `/api/listings/${listingId}/photos/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
2957
2983
|
/**
|
|
@@ -3022,6 +3048,7 @@ export class Api extends HttpClient {
|
|
|
3022
3048
|
* @request DELETE:/api/listings/{id}
|
|
3023
3049
|
* @secure
|
|
3024
3050
|
* @response `204` `void` No Content
|
|
3051
|
+
* @response `403` `HttpError` Forbidden
|
|
3025
3052
|
*/
|
|
3026
3053
|
deleteListing: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}`, method: "DELETE", secure: true }, params)),
|
|
3027
3054
|
/**
|
|
@@ -3044,6 +3071,7 @@ export class Api extends HttpClient {
|
|
|
3044
3071
|
* @request PUT:/api/listings/{id}/background-image
|
|
3045
3072
|
* @secure
|
|
3046
3073
|
* @response `200` `File` OK
|
|
3074
|
+
* @response `403` `HttpError` Forbidden
|
|
3047
3075
|
*/
|
|
3048
3076
|
updateListingBackgroundImage: (id, data, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "PUT", body: data, secure: true, type: "multipart/form-data", format: "json" }, params)),
|
|
3049
3077
|
/**
|
|
@@ -3055,6 +3083,7 @@ export class Api extends HttpClient {
|
|
|
3055
3083
|
* @request DELETE:/api/listings/{id}/background-image
|
|
3056
3084
|
* @secure
|
|
3057
3085
|
* @response `204` `void` No Content
|
|
3086
|
+
* @response `403` `HttpError` Forbidden
|
|
3058
3087
|
*/
|
|
3059
3088
|
deleteListingBackgroundImage: (id, params = {}) => this.request(Object.assign({ path: `/api/listings/${id}/background-image`, method: "DELETE", secure: true }, params)),
|
|
3060
3089
|
/**
|
|
@@ -4901,6 +4930,21 @@ export class Api extends HttpClient {
|
|
|
4901
4930
|
* @response `200` `NotificationTemplateVersion` OK
|
|
4902
4931
|
*/
|
|
4903
4932
|
deleteNotificationTemplateVersion: (notificationId, id, params = {}) => this.request(Object.assign({ path: `/api/notification-templates/${notificationId}/versions/${id}`, method: "DELETE", secure: true, format: "json" }, params)),
|
|
4933
|
+
/**
|
|
4934
|
+
* @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
|
|
4935
|
+
*
|
|
4936
|
+
* @tags Partners
|
|
4937
|
+
* @name UpdatePartnerLinkSlug
|
|
4938
|
+
* @summary Update Partner Link Slug
|
|
4939
|
+
* @request PUT:/api/partners/{realtorId}/link-slug
|
|
4940
|
+
* @secure
|
|
4941
|
+
* @response `200` `PartnerSlug` OK
|
|
4942
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
4943
|
+
* @response `404` `ProblemDetails` Not Found
|
|
4944
|
+
* @response `409` `ProblemDetails` Conflict
|
|
4945
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
4946
|
+
*/
|
|
4947
|
+
updatePartnerLinkSlug: (realtorId, data, params = {}) => this.request(Object.assign({ path: `/api/partners/${realtorId}/link-slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
4904
4948
|
/**
|
|
4905
4949
|
* No description
|
|
4906
4950
|
*
|
|
@@ -6334,6 +6378,72 @@ export class Api extends HttpClient {
|
|
|
6334
6378
|
* @response `204` `void` No Content
|
|
6335
6379
|
*/
|
|
6336
6380
|
deleteRelationshipProspect: (id, params = {}) => this.request(Object.assign({ path: `/api/users/me/relationships/prospects/${id}`, method: "DELETE", secure: true }, params)),
|
|
6381
|
+
/**
|
|
6382
|
+
* @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
|
|
6383
|
+
*
|
|
6384
|
+
* @tags UsersMe
|
|
6385
|
+
* @name GetMyPartners
|
|
6386
|
+
* @summary Get My Partners
|
|
6387
|
+
* @request GET:/api/users/me/partners
|
|
6388
|
+
* @secure
|
|
6389
|
+
* @response `200` `(MyPartner)[]` OK
|
|
6390
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6391
|
+
*/
|
|
6392
|
+
getMyPartners: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partners`, method: "GET", secure: true, format: "json" }, params)),
|
|
6393
|
+
/**
|
|
6394
|
+
* No description
|
|
6395
|
+
*
|
|
6396
|
+
* @tags UsersMe
|
|
6397
|
+
* @name AddMyPartner
|
|
6398
|
+
* @summary Add My Partner
|
|
6399
|
+
* @request POST:/api/users/me/partners/{partnerId}
|
|
6400
|
+
* @secure
|
|
6401
|
+
* @response `204` `void` No Content
|
|
6402
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6403
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6404
|
+
*/
|
|
6405
|
+
addMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "POST", secure: true }, params)),
|
|
6406
|
+
/**
|
|
6407
|
+
* No description
|
|
6408
|
+
*
|
|
6409
|
+
* @tags UsersMe
|
|
6410
|
+
* @name RemoveMyPartner
|
|
6411
|
+
* @summary Remove My Partner
|
|
6412
|
+
* @request DELETE:/api/users/me/partners/{partnerId}
|
|
6413
|
+
* @secure
|
|
6414
|
+
* @response `204` `void` No Content
|
|
6415
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6416
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6417
|
+
*/
|
|
6418
|
+
removeMyPartner: (partnerId, params = {}) => this.request(Object.assign({ path: `/api/users/me/partners/${partnerId}`, method: "DELETE", secure: true }, params)),
|
|
6419
|
+
/**
|
|
6420
|
+
* @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
|
|
6421
|
+
*
|
|
6422
|
+
* @tags UsersMe
|
|
6423
|
+
* @name GetMyPartnerLinks
|
|
6424
|
+
* @summary Get My Partner Links
|
|
6425
|
+
* @request GET:/api/users/me/partner-links
|
|
6426
|
+
* @secure
|
|
6427
|
+
* @response `200` `PartnerLinks` OK
|
|
6428
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6429
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6430
|
+
*/
|
|
6431
|
+
getMyPartnerLinks: (params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links`, method: "GET", secure: true, format: "json" }, params)),
|
|
6432
|
+
/**
|
|
6433
|
+
* @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.
|
|
6434
|
+
*
|
|
6435
|
+
* @tags UsersMe
|
|
6436
|
+
* @name UpdateMyPartnerLinkSlug
|
|
6437
|
+
* @summary Update My Partner Link Slug
|
|
6438
|
+
* @request PUT:/api/users/me/partner-links/slug
|
|
6439
|
+
* @secure
|
|
6440
|
+
* @response `200` `PartnerLinks` OK
|
|
6441
|
+
* @response `403` `ProblemDetails` Forbidden
|
|
6442
|
+
* @response `404` `ProblemDetails` Not Found
|
|
6443
|
+
* @response `409` `ProblemDetails` Conflict
|
|
6444
|
+
* @response `422` `UnprocessableEntity` Unprocessable Content
|
|
6445
|
+
*/
|
|
6446
|
+
updateMyPartnerLinkSlug: (data, params = {}) => this.request(Object.assign({ path: `/api/users/me/partner-links/slug`, method: "PUT", body: data, secure: true, type: "application/json", format: "json" }, params)),
|
|
6337
6447
|
/**
|
|
6338
6448
|
* No description
|
|
6339
6449
|
*
|