@matech/thebigpos-sdk 3.18.0 → 3.19.0-dev-6779
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/README.md +39 -0
- package/dist/index.d.ts +793 -519
- package/dist/index.js +189 -3
- package/dist/index.js.map +1 -1
- package/docs/sdk_generation.md +149 -0
- package/package.json +13 -8
- package/scripts/apply-json-patch-content-type.js +189 -36
- package/src/index.ts +466 -20
package/src/index.ts
CHANGED
|
@@ -69,6 +69,8 @@ export type PendingInviteStatus =
|
|
|
69
69
|
| "InviteExpired"
|
|
70
70
|
| "NotInvited";
|
|
71
71
|
|
|
72
|
+
export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
|
|
73
|
+
|
|
72
74
|
export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
|
|
73
75
|
|
|
74
76
|
export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
|
|
@@ -380,6 +382,15 @@ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
|
|
|
380
382
|
|
|
381
383
|
export type LoanGenderType = "Male" | "Female";
|
|
382
384
|
|
|
385
|
+
export type LoanFieldDataType =
|
|
386
|
+
| "Text"
|
|
387
|
+
| "Number"
|
|
388
|
+
| "Boolean"
|
|
389
|
+
| "Date"
|
|
390
|
+
| "Enum"
|
|
391
|
+
| "Identifier"
|
|
392
|
+
| "Object";
|
|
393
|
+
|
|
383
394
|
export type LoanDocumentType =
|
|
384
395
|
| "W2"
|
|
385
396
|
| "Paystub"
|
|
@@ -649,6 +660,11 @@ export type CanvasAudience = "Staff" | "Borrower" | "Partner";
|
|
|
649
660
|
|
|
650
661
|
export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
|
|
651
662
|
|
|
663
|
+
export type BulkLoanFieldOperationType =
|
|
664
|
+
| "SetAccess"
|
|
665
|
+
| "SetAiEnabled"
|
|
666
|
+
| "ResetToDefaults";
|
|
667
|
+
|
|
652
668
|
export type BranchType = "Mortgage" | "RealEstate";
|
|
653
669
|
|
|
654
670
|
export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
|
|
@@ -882,6 +898,7 @@ export interface Account {
|
|
|
882
898
|
updatedAt?: string | null;
|
|
883
899
|
/** @format int32 */
|
|
884
900
|
allowedLoginsWithoutMFA: number;
|
|
901
|
+
isPartnerPortalEnabled: boolean;
|
|
885
902
|
losSettings: LOSSettings;
|
|
886
903
|
asoSettings?: ASOSettings | null;
|
|
887
904
|
settings: AccountSettings;
|
|
@@ -912,12 +929,14 @@ export interface AccountSettings {
|
|
|
912
929
|
smsNumber?: string | null;
|
|
913
930
|
ssoHostOverride?: string | null;
|
|
914
931
|
isEarlyAdopter: boolean;
|
|
932
|
+
allowLoanOfficerPartnerInvites: boolean;
|
|
915
933
|
}
|
|
916
934
|
|
|
917
935
|
export interface AccountSettingsRequest {
|
|
918
936
|
isSmsEnabled: boolean;
|
|
919
937
|
smsNumber?: string | null;
|
|
920
938
|
isEarlyAdopter: boolean;
|
|
939
|
+
allowLoanOfficerPartnerInvites?: boolean | null;
|
|
921
940
|
}
|
|
922
941
|
|
|
923
942
|
export interface Address {
|
|
@@ -1939,6 +1958,24 @@ export interface BranchUserPaginated {
|
|
|
1939
1958
|
count: number;
|
|
1940
1959
|
}
|
|
1941
1960
|
|
|
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
|
+
|
|
1942
1979
|
export interface BulkLoanTaskFailure {
|
|
1943
1980
|
/** @format uuid */
|
|
1944
1981
|
userLoanTaskID: string;
|
|
@@ -2448,6 +2485,7 @@ export interface CreateAccountRequest {
|
|
|
2448
2485
|
domain: string;
|
|
2449
2486
|
eConsentBucket?: string | null;
|
|
2450
2487
|
ignoreCoBorrowerRelationship: boolean;
|
|
2488
|
+
isPartnerPortalEnabled: boolean;
|
|
2451
2489
|
user: AdminUser;
|
|
2452
2490
|
companyAddress: CompanyAddress;
|
|
2453
2491
|
contactInfo: ContactInfo;
|
|
@@ -2569,7 +2607,7 @@ export interface CreateInviteRequest {
|
|
|
2569
2607
|
phoneNumber?: string | null;
|
|
2570
2608
|
/** @deprecated */
|
|
2571
2609
|
relationship: CreateInviteRequestRelationshipEnum;
|
|
2572
|
-
loanID
|
|
2610
|
+
loanID?: string | null;
|
|
2573
2611
|
route?: string | null;
|
|
2574
2612
|
/** @format uuid */
|
|
2575
2613
|
siteConfigurationID: string;
|
|
@@ -2981,6 +3019,7 @@ export interface DraftRequest {
|
|
|
2981
3019
|
applicationPayload: any;
|
|
2982
3020
|
customData?: any | null;
|
|
2983
3021
|
isCoBorrower: boolean;
|
|
3022
|
+
partnerId?: string | null;
|
|
2984
3023
|
}
|
|
2985
3024
|
|
|
2986
3025
|
export interface EconsentPendingSummary {
|
|
@@ -4010,6 +4049,7 @@ export interface LoanApplicationRequest {
|
|
|
4010
4049
|
nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
|
|
4011
4050
|
/** @format uuid */
|
|
4012
4051
|
draftId?: string | null;
|
|
4052
|
+
partnerId?: string | null;
|
|
4013
4053
|
additionalFields?: Record<string, any> | null;
|
|
4014
4054
|
/** @format uuid */
|
|
4015
4055
|
existingLoanId?: string | null;
|
|
@@ -5013,6 +5053,8 @@ export interface LoanDocumentFolderPermissionRequest {
|
|
|
5013
5053
|
export interface LoanDocumentFolderSearchCriteria {
|
|
5014
5054
|
searchText?: string | null;
|
|
5015
5055
|
isActive?: boolean | null;
|
|
5056
|
+
isSystemDefault?: boolean | null;
|
|
5057
|
+
role?: LoanRole | null;
|
|
5016
5058
|
}
|
|
5017
5059
|
|
|
5018
5060
|
export interface LoanDocumentFolderSummary {
|
|
@@ -5113,6 +5155,20 @@ export interface LoanFieldAccess {
|
|
|
5113
5155
|
export interface LoanFieldAccessItem {
|
|
5114
5156
|
fieldKey: string;
|
|
5115
5157
|
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;
|
|
5116
5172
|
}
|
|
5117
5173
|
|
|
5118
5174
|
export interface LoanFinancial {
|
|
@@ -5255,6 +5311,7 @@ export interface LoanList {
|
|
|
5255
5311
|
buyerAgentContact?: LoanContactList | null;
|
|
5256
5312
|
sellerAgentContact?: LoanContactList | null;
|
|
5257
5313
|
userLoans: UserLoan[];
|
|
5314
|
+
myLoanRoles: LoanRole[];
|
|
5258
5315
|
contacts: LoanContact[];
|
|
5259
5316
|
borrowers: LoanListBorrower[];
|
|
5260
5317
|
taskCounts: LoanTaskCounts;
|
|
@@ -6219,6 +6276,20 @@ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
|
|
|
6219
6276
|
type: MonthlyPaymentWidgetConfigTypeEnum;
|
|
6220
6277
|
};
|
|
6221
6278
|
|
|
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
|
+
|
|
6222
6293
|
export type MyTasksWidgetConfig = UtilRequiredKeys<
|
|
6223
6294
|
BaseCanvasWidgetConfig,
|
|
6224
6295
|
"type"
|
|
@@ -6417,6 +6488,26 @@ export interface Pagination {
|
|
|
6417
6488
|
pageSize: number;
|
|
6418
6489
|
}
|
|
6419
6490
|
|
|
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
|
+
|
|
6420
6511
|
export interface PartnerSearchCriteria {
|
|
6421
6512
|
searchText?: string | null;
|
|
6422
6513
|
isActive?: boolean | null;
|
|
@@ -6424,6 +6515,10 @@ export interface PartnerSearchCriteria {
|
|
|
6424
6515
|
roles?: UserRole[] | null;
|
|
6425
6516
|
}
|
|
6426
6517
|
|
|
6518
|
+
export interface PartnerSlug {
|
|
6519
|
+
slug: string;
|
|
6520
|
+
}
|
|
6521
|
+
|
|
6427
6522
|
export interface PendingInvite {
|
|
6428
6523
|
status: PendingInviteStatusEnum;
|
|
6429
6524
|
/** @format uuid */
|
|
@@ -7046,6 +7141,7 @@ export interface SiteConfiguration {
|
|
|
7046
7141
|
user?: UserPublic | null;
|
|
7047
7142
|
asoSettings?: ASOSettings | null;
|
|
7048
7143
|
accountSettings: AccountSettings;
|
|
7144
|
+
isPartnerPortalEnabled: boolean;
|
|
7049
7145
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
7050
7146
|
mobileSettings?: MobileSettings | null;
|
|
7051
7147
|
losSettings?: LOSSettings | null;
|
|
@@ -7241,6 +7337,7 @@ export interface SiteConfigurationByUrl {
|
|
|
7241
7337
|
user?: UserPublic | null;
|
|
7242
7338
|
asoSettings?: ASOSettings | null;
|
|
7243
7339
|
accountSettings: AccountSettings;
|
|
7340
|
+
isPartnerPortalEnabled: boolean;
|
|
7244
7341
|
autoTaskReminderIntervalsInDays?: number[] | null;
|
|
7245
7342
|
mobileSettings?: MobileSettings | null;
|
|
7246
7343
|
losSettings?: LOSSettings | null;
|
|
@@ -7609,6 +7706,20 @@ export interface SocialSurveyRecord {
|
|
|
7609
7706
|
reviewCompletedTimeStamp?: string | null;
|
|
7610
7707
|
}
|
|
7611
7708
|
|
|
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
|
+
|
|
7612
7723
|
export interface SupportedModel {
|
|
7613
7724
|
modelId: string;
|
|
7614
7725
|
displayName: string;
|
|
@@ -8047,6 +8158,14 @@ export interface UpdateMobilePhoneRequest {
|
|
|
8047
8158
|
phone: string;
|
|
8048
8159
|
}
|
|
8049
8160
|
|
|
8161
|
+
export interface UpdatePartnerPortalRequest {
|
|
8162
|
+
isEnabled?: boolean | null;
|
|
8163
|
+
}
|
|
8164
|
+
|
|
8165
|
+
export interface UpdatePartnerSlugRequest {
|
|
8166
|
+
slug: string;
|
|
8167
|
+
}
|
|
8168
|
+
|
|
8050
8169
|
export interface UpdateUserGroupRequest {
|
|
8051
8170
|
name: string;
|
|
8052
8171
|
description?: string | null;
|
|
@@ -9500,6 +9619,8 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
|
|
|
9500
9619
|
|
|
9501
9620
|
export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
|
|
9502
9621
|
|
|
9622
|
+
export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
|
|
9623
|
+
|
|
9503
9624
|
export type MyTasksWidgetConfigTypeEnum = "MyTasks";
|
|
9504
9625
|
|
|
9505
9626
|
export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
|
|
@@ -9582,6 +9703,15 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
|
|
|
9582
9703
|
|
|
9583
9704
|
export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
|
|
9584
9705
|
|
|
9706
|
+
export type StandardLoanFieldDataTypeEnum =
|
|
9707
|
+
| "Text"
|
|
9708
|
+
| "Number"
|
|
9709
|
+
| "Boolean"
|
|
9710
|
+
| "Date"
|
|
9711
|
+
| "Enum"
|
|
9712
|
+
| "Identifier"
|
|
9713
|
+
| "Object";
|
|
9714
|
+
|
|
9585
9715
|
export type TextBlockWidgetConfigTypeEnum = "TextBlock";
|
|
9586
9716
|
|
|
9587
9717
|
export type UnregisteredBorrowerRoleEnum =
|
|
@@ -9904,7 +10034,15 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
9904
10034
|
property instanceof Array ? property : [property];
|
|
9905
10035
|
|
|
9906
10036
|
for (const formItem of propertyContent) {
|
|
9907
|
-
|
|
10037
|
+
// React Native files are plain { uri, name, type } objects, not Blob/File.
|
|
10038
|
+
const isReactNativeFile =
|
|
10039
|
+
!!formItem &&
|
|
10040
|
+
typeof formItem === "object" &&
|
|
10041
|
+
"uri" in formItem &&
|
|
10042
|
+
"name" in formItem &&
|
|
10043
|
+
"type" in formItem;
|
|
10044
|
+
const isFileType =
|
|
10045
|
+
isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
|
|
9908
10046
|
formData.append(
|
|
9909
10047
|
key,
|
|
9910
10048
|
isFileType ? formItem : this.stringifyFormItem(formItem),
|
|
@@ -9966,7 +10104,7 @@ export class HttpClient<SecurityDataType = unknown> {
|
|
|
9966
10104
|
|
|
9967
10105
|
/**
|
|
9968
10106
|
* @title The Big POS API
|
|
9969
|
-
* @version v3.
|
|
10107
|
+
* @version v3.19.0
|
|
9970
10108
|
* @termsOfService https://www.thebigpos.com/terms-of-use/
|
|
9971
10109
|
* @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
|
|
9972
10110
|
*/
|
|
@@ -10215,6 +10353,33 @@ export class Api<
|
|
|
10215
10353
|
...params,
|
|
10216
10354
|
}),
|
|
10217
10355
|
|
|
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
|
+
|
|
10218
10383
|
/**
|
|
10219
10384
|
* No description
|
|
10220
10385
|
*
|
|
@@ -14974,13 +15139,14 @@ export class Api<
|
|
|
14974
15139
|
* @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
|
|
14975
15140
|
* @secure
|
|
14976
15141
|
* @response `204` `void` No Content
|
|
15142
|
+
* @response `403` `HttpError` Forbidden
|
|
14977
15143
|
*/
|
|
14978
15144
|
deleteFormSubmissionFile: (
|
|
14979
15145
|
formSubmissionFileId: string,
|
|
14980
15146
|
formSubmissionId: string,
|
|
14981
15147
|
params: RequestParams = {},
|
|
14982
15148
|
) =>
|
|
14983
|
-
this.request<void,
|
|
15149
|
+
this.request<void, HttpError>({
|
|
14984
15150
|
path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`,
|
|
14985
15151
|
method: "DELETE",
|
|
14986
15152
|
secure: true,
|
|
@@ -14996,6 +15162,7 @@ export class Api<
|
|
|
14996
15162
|
* @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
|
|
14997
15163
|
* @secure
|
|
14998
15164
|
* @response `200` `FileWithBytes` OK
|
|
15165
|
+
* @response `403` `HttpError` Forbidden
|
|
14999
15166
|
*/
|
|
15000
15167
|
downloadFormSubmissionFile: (
|
|
15001
15168
|
formSubmissionFileId: string,
|
|
@@ -15006,7 +15173,7 @@ export class Api<
|
|
|
15006
15173
|
},
|
|
15007
15174
|
params: RequestParams = {},
|
|
15008
15175
|
) =>
|
|
15009
|
-
this.request<FileWithBytes,
|
|
15176
|
+
this.request<FileWithBytes, HttpError>({
|
|
15010
15177
|
path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`,
|
|
15011
15178
|
method: "GET",
|
|
15012
15179
|
query: query,
|
|
@@ -15024,6 +15191,7 @@ export class Api<
|
|
|
15024
15191
|
* @request GET:/api/form-submissions
|
|
15025
15192
|
* @secure
|
|
15026
15193
|
* @response `200` `FormSubmissionPaginated` OK
|
|
15194
|
+
* @response `403` `HttpError` Forbidden
|
|
15027
15195
|
*/
|
|
15028
15196
|
getFormSubmissions: (
|
|
15029
15197
|
query?: {
|
|
@@ -15036,7 +15204,7 @@ export class Api<
|
|
|
15036
15204
|
},
|
|
15037
15205
|
params: RequestParams = {},
|
|
15038
15206
|
) =>
|
|
15039
|
-
this.request<FormSubmissionPaginated,
|
|
15207
|
+
this.request<FormSubmissionPaginated, HttpError>({
|
|
15040
15208
|
path: `/api/form-submissions`,
|
|
15041
15209
|
method: "GET",
|
|
15042
15210
|
query: query,
|
|
@@ -15082,9 +15250,10 @@ export class Api<
|
|
|
15082
15250
|
* @request GET:/api/form-submissions/{id}
|
|
15083
15251
|
* @secure
|
|
15084
15252
|
* @response `200` `FormSubmission` OK
|
|
15253
|
+
* @response `403` `HttpError` Forbidden
|
|
15085
15254
|
*/
|
|
15086
15255
|
getFormSubmission: (id: string, params: RequestParams = {}) =>
|
|
15087
|
-
this.request<FormSubmission,
|
|
15256
|
+
this.request<FormSubmission, HttpError>({
|
|
15088
15257
|
path: `/api/form-submissions/${id}`,
|
|
15089
15258
|
method: "GET",
|
|
15090
15259
|
secure: true,
|
|
@@ -15101,13 +15270,14 @@ export class Api<
|
|
|
15101
15270
|
* @request PUT:/api/form-submissions/{id}
|
|
15102
15271
|
* @secure
|
|
15103
15272
|
* @response `200` `FormSubmission` OK
|
|
15273
|
+
* @response `403` `HttpError` Forbidden
|
|
15104
15274
|
*/
|
|
15105
15275
|
replaceFormSubmission: (
|
|
15106
15276
|
id: string,
|
|
15107
15277
|
data: FormSubmissionRequest,
|
|
15108
15278
|
params: RequestParams = {},
|
|
15109
15279
|
) =>
|
|
15110
|
-
this.request<FormSubmission,
|
|
15280
|
+
this.request<FormSubmission, HttpError>({
|
|
15111
15281
|
path: `/api/form-submissions/${id}`,
|
|
15112
15282
|
method: "PUT",
|
|
15113
15283
|
body: data,
|
|
@@ -15126,9 +15296,10 @@ export class Api<
|
|
|
15126
15296
|
* @request DELETE:/api/form-submissions/{id}
|
|
15127
15297
|
* @secure
|
|
15128
15298
|
* @response `204` `void` No Content
|
|
15299
|
+
* @response `403` `HttpError` Forbidden
|
|
15129
15300
|
*/
|
|
15130
15301
|
deleteFormSubmission: (id: string, params: RequestParams = {}) =>
|
|
15131
|
-
this.request<void,
|
|
15302
|
+
this.request<void, HttpError>({
|
|
15132
15303
|
path: `/api/form-submissions/${id}`,
|
|
15133
15304
|
method: "DELETE",
|
|
15134
15305
|
secure: true,
|
|
@@ -15144,6 +15315,7 @@ export class Api<
|
|
|
15144
15315
|
* @request POST:/api/form-submissions/search
|
|
15145
15316
|
* @secure
|
|
15146
15317
|
* @response `200` `FormSubmissionPaginated` OK
|
|
15318
|
+
* @response `403` `HttpError` Forbidden
|
|
15147
15319
|
*/
|
|
15148
15320
|
searchFormSubmissions: (
|
|
15149
15321
|
data: FormSubmissionSearchCriteria,
|
|
@@ -15157,7 +15329,7 @@ export class Api<
|
|
|
15157
15329
|
},
|
|
15158
15330
|
params: RequestParams = {},
|
|
15159
15331
|
) =>
|
|
15160
|
-
this.request<FormSubmissionPaginated,
|
|
15332
|
+
this.request<FormSubmissionPaginated, HttpError>({
|
|
15161
15333
|
path: `/api/form-submissions/search`,
|
|
15162
15334
|
method: "POST",
|
|
15163
15335
|
query: query,
|
|
@@ -15649,6 +15821,7 @@ export class Api<
|
|
|
15649
15821
|
* @request POST:/api/listings/{listingId}/files
|
|
15650
15822
|
* @secure
|
|
15651
15823
|
* @response `200` `ListingFile` OK
|
|
15824
|
+
* @response `403` `HttpError` Forbidden
|
|
15652
15825
|
*/
|
|
15653
15826
|
addListingFile: (
|
|
15654
15827
|
listingId: string,
|
|
@@ -15660,7 +15833,7 @@ export class Api<
|
|
|
15660
15833
|
},
|
|
15661
15834
|
params: RequestParams = {},
|
|
15662
15835
|
) =>
|
|
15663
|
-
this.request<ListingFile,
|
|
15836
|
+
this.request<ListingFile, HttpError>({
|
|
15664
15837
|
path: `/api/listings/${listingId}/files`,
|
|
15665
15838
|
method: "POST",
|
|
15666
15839
|
body: data,
|
|
@@ -15679,13 +15852,14 @@ export class Api<
|
|
|
15679
15852
|
* @request PATCH:/api/listings/{listingId}/files
|
|
15680
15853
|
* @secure
|
|
15681
15854
|
* @response `200` `ListingFile` OK
|
|
15855
|
+
* @response `403` `HttpError` Forbidden
|
|
15682
15856
|
*/
|
|
15683
15857
|
updateListingFiles: (
|
|
15684
15858
|
listingId: string,
|
|
15685
15859
|
data: JsonPatchDocument,
|
|
15686
15860
|
params: RequestParams = {},
|
|
15687
15861
|
) =>
|
|
15688
|
-
this.request<ListingFile,
|
|
15862
|
+
this.request<ListingFile, HttpError>({
|
|
15689
15863
|
path: `/api/listings/${listingId}/files`,
|
|
15690
15864
|
method: "PATCH",
|
|
15691
15865
|
body: data,
|
|
@@ -15704,13 +15878,14 @@ export class Api<
|
|
|
15704
15878
|
* @request DELETE:/api/listings/{listingId}/files/{id}
|
|
15705
15879
|
* @secure
|
|
15706
15880
|
* @response `204` `Listing` No Content
|
|
15881
|
+
* @response `403` `HttpError` Forbidden
|
|
15707
15882
|
*/
|
|
15708
15883
|
removeListingFile: (
|
|
15709
15884
|
listingId: string,
|
|
15710
15885
|
id: string,
|
|
15711
15886
|
params: RequestParams = {},
|
|
15712
15887
|
) =>
|
|
15713
|
-
this.request<Listing,
|
|
15888
|
+
this.request<Listing, HttpError>({
|
|
15714
15889
|
path: `/api/listings/${listingId}/files/${id}`,
|
|
15715
15890
|
method: "DELETE",
|
|
15716
15891
|
secure: true,
|
|
@@ -15727,6 +15902,7 @@ export class Api<
|
|
|
15727
15902
|
* @request POST:/api/listings/{listingId}/photos
|
|
15728
15903
|
* @secure
|
|
15729
15904
|
* @response `200` `ListingPhoto` OK
|
|
15905
|
+
* @response `403` `HttpError` Forbidden
|
|
15730
15906
|
*/
|
|
15731
15907
|
addListingPhoto: (
|
|
15732
15908
|
listingId: string,
|
|
@@ -15740,7 +15916,7 @@ export class Api<
|
|
|
15740
15916
|
},
|
|
15741
15917
|
params: RequestParams = {},
|
|
15742
15918
|
) =>
|
|
15743
|
-
this.request<ListingPhoto,
|
|
15919
|
+
this.request<ListingPhoto, HttpError>({
|
|
15744
15920
|
path: `/api/listings/${listingId}/photos`,
|
|
15745
15921
|
method: "POST",
|
|
15746
15922
|
body: data,
|
|
@@ -15759,13 +15935,14 @@ export class Api<
|
|
|
15759
15935
|
* @request PATCH:/api/listings/{listingId}/photos
|
|
15760
15936
|
* @secure
|
|
15761
15937
|
* @response `200` `(ListingPhoto)[]` OK
|
|
15938
|
+
* @response `403` `HttpError` Forbidden
|
|
15762
15939
|
*/
|
|
15763
15940
|
updateListingPhotos: (
|
|
15764
15941
|
listingId: string,
|
|
15765
15942
|
data: JsonPatchDocument,
|
|
15766
15943
|
params: RequestParams = {},
|
|
15767
15944
|
) =>
|
|
15768
|
-
this.request<ListingPhoto[],
|
|
15945
|
+
this.request<ListingPhoto[], HttpError>({
|
|
15769
15946
|
path: `/api/listings/${listingId}/photos`,
|
|
15770
15947
|
method: "PATCH",
|
|
15771
15948
|
body: data,
|
|
@@ -15784,13 +15961,14 @@ export class Api<
|
|
|
15784
15961
|
* @request DELETE:/api/listings/{listingId}/photos/{id}
|
|
15785
15962
|
* @secure
|
|
15786
15963
|
* @response `204` `Listing` No Content
|
|
15964
|
+
* @response `403` `HttpError` Forbidden
|
|
15787
15965
|
*/
|
|
15788
15966
|
removeListingPhoto: (
|
|
15789
15967
|
listingId: string,
|
|
15790
15968
|
id: string,
|
|
15791
15969
|
params: RequestParams = {},
|
|
15792
15970
|
) =>
|
|
15793
|
-
this.request<Listing,
|
|
15971
|
+
this.request<Listing, HttpError>({
|
|
15794
15972
|
path: `/api/listings/${listingId}/photos/${id}`,
|
|
15795
15973
|
method: "DELETE",
|
|
15796
15974
|
secure: true,
|
|
@@ -15925,9 +16103,10 @@ export class Api<
|
|
|
15925
16103
|
* @request DELETE:/api/listings/{id}
|
|
15926
16104
|
* @secure
|
|
15927
16105
|
* @response `204` `void` No Content
|
|
16106
|
+
* @response `403` `HttpError` Forbidden
|
|
15928
16107
|
*/
|
|
15929
16108
|
deleteListing: (id: string, params: RequestParams = {}) =>
|
|
15930
|
-
this.request<void,
|
|
16109
|
+
this.request<void, HttpError>({
|
|
15931
16110
|
path: `/api/listings/${id}`,
|
|
15932
16111
|
method: "DELETE",
|
|
15933
16112
|
secure: true,
|
|
@@ -15976,6 +16155,7 @@ export class Api<
|
|
|
15976
16155
|
* @request PUT:/api/listings/{id}/background-image
|
|
15977
16156
|
* @secure
|
|
15978
16157
|
* @response `200` `File` OK
|
|
16158
|
+
* @response `403` `HttpError` Forbidden
|
|
15979
16159
|
*/
|
|
15980
16160
|
updateListingBackgroundImage: (
|
|
15981
16161
|
id: string,
|
|
@@ -15985,7 +16165,7 @@ export class Api<
|
|
|
15985
16165
|
},
|
|
15986
16166
|
params: RequestParams = {},
|
|
15987
16167
|
) =>
|
|
15988
|
-
this.request<File,
|
|
16168
|
+
this.request<File, HttpError>({
|
|
15989
16169
|
path: `/api/listings/${id}/background-image`,
|
|
15990
16170
|
method: "PUT",
|
|
15991
16171
|
body: data,
|
|
@@ -16004,9 +16184,10 @@ export class Api<
|
|
|
16004
16184
|
* @request DELETE:/api/listings/{id}/background-image
|
|
16005
16185
|
* @secure
|
|
16006
16186
|
* @response `204` `void` No Content
|
|
16187
|
+
* @response `403` `HttpError` Forbidden
|
|
16007
16188
|
*/
|
|
16008
16189
|
deleteListingBackgroundImage: (id: string, params: RequestParams = {}) =>
|
|
16009
|
-
this.request<void,
|
|
16190
|
+
this.request<void, HttpError>({
|
|
16010
16191
|
path: `/api/listings/${id}/background-image`,
|
|
16011
16192
|
method: "DELETE",
|
|
16012
16193
|
secure: true,
|
|
@@ -16600,7 +16781,7 @@ export class Api<
|
|
|
16600
16781
|
}),
|
|
16601
16782
|
|
|
16602
16783
|
/**
|
|
16603
|
-
* @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.
|
|
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 as long as it is active — 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.
|
|
16604
16785
|
*
|
|
16605
16786
|
* @tags LoanDocumentFoldersForSingleLoan
|
|
16606
16787
|
* @name ListLoanDocumentFolders
|
|
@@ -17149,6 +17330,133 @@ export class Api<
|
|
|
17149
17330
|
...params,
|
|
17150
17331
|
}),
|
|
17151
17332
|
|
|
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
|
+
|
|
17152
17460
|
/**
|
|
17153
17461
|
* No description
|
|
17154
17462
|
*
|
|
@@ -19759,6 +20067,35 @@ export class Api<
|
|
|
19759
20067
|
...params,
|
|
19760
20068
|
}),
|
|
19761
20069
|
|
|
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
|
+
|
|
19762
20099
|
/**
|
|
19763
20100
|
* No description
|
|
19764
20101
|
*
|
|
@@ -22656,6 +22993,115 @@ export class Api<
|
|
|
22656
22993
|
...params,
|
|
22657
22994
|
}),
|
|
22658
22995
|
|
|
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
|
+
|
|
22659
23105
|
/**
|
|
22660
23106
|
* No description
|
|
22661
23107
|
*
|