@matech/thebigpos-sdk 3.18.0 → 3.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -10,6 +10,7 @@ export type SiteConfigurationType = "None" | "Account" | "Corporate" | "Branch"
10
10
  export type SigningMethod = "ConsumerConnect" | "POSF";
11
11
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
12
12
  export type PendingInviteStatus = "InvitePending" | "InviteExpired" | "NotInvited";
13
+ export type PartnerTier = "Lite" | "LitePlusPortal" | "Pending";
13
14
  export type OutboundFailureSeverity = "All" | "Failed" | "CompletedWithErrors";
14
15
  export type LosWebhookSigningKeySyncStatus = "Unknown" | "Synced";
15
16
  export type LosWebhookInventoryStatus = "Unknown" | "Healthy" | "Disabled" | "Missing";
@@ -57,6 +58,7 @@ export type LoanHispanicEthnicity = "Mexican" | "PuertoRican" | "Cuban" | "Other
57
58
  export type LoanGiftSource = "CommunityNonProfit" | "Employer" | "FederalAgency" | "LocalAgency" | "Relative" | "ReligiousNonProfit" | "StateAgency" | "UnmarriedPartner" | "Lender" | "Other" | "Institutional" | "Borrower" | "NonOriginatingLender" | "NonParentRelative" | "Parent" | "PropertySeller" | "UnrelatedFriend";
58
59
  export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
59
60
  export type LoanGenderType = "Male" | "Female";
61
+ export type LoanFieldDataType = "Text" | "Number" | "Boolean" | "Date" | "Enum" | "Identifier" | "Object";
60
62
  export type LoanDocumentType = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
61
63
  export type LoanDocumentFolderScope = "Any" | "Assigned" | "Unassigned";
62
64
  export type LoanDocumentFolderPermissionLevel = "None" | "Read" | "Write" | "Manage";
@@ -99,6 +101,7 @@ export type CanvasFieldFormat = "Text" | "Number" | "Currency" | "Percent" | "Da
99
101
  export type CanvasFieldDataType = "Text" | "Number" | "Decimal" | "Boolean" | "Date" | "DateTime" | "SingleSelect" | "MultiSelect";
100
102
  export type CanvasAudience = "Staff" | "Borrower" | "Partner";
101
103
  export type BulkLoanTaskOperationType = "SetStatus" | "Delete" | "SetDueDate";
104
+ export type BulkLoanFieldOperationType = "SetAccess" | "SetAiEnabled" | "ResetToDefaults";
102
105
  export type BranchType = "Mortgage" | "RealEstate";
103
106
  export type BorrowerType = "Borrower" | "CoBorrower" | "Unknown";
104
107
  export type BorrowerRelationship = "NotApplicable" | "Spouse" | "NonSpouse";
@@ -166,6 +169,7 @@ export interface Account {
166
169
  updatedAt?: string | null;
167
170
  /** @format int32 */
168
171
  allowedLoginsWithoutMFA: number;
172
+ isPartnerPortalEnabled: boolean;
169
173
  losSettings: LOSSettings;
170
174
  asoSettings?: ASOSettings | null;
171
175
  settings: AccountSettings;
@@ -192,11 +196,13 @@ export interface AccountSettings {
192
196
  smsNumber?: string | null;
193
197
  ssoHostOverride?: string | null;
194
198
  isEarlyAdopter: boolean;
199
+ allowLoanOfficerPartnerInvites: boolean;
195
200
  }
196
201
  export interface AccountSettingsRequest {
197
202
  isSmsEnabled: boolean;
198
203
  smsNumber?: string | null;
199
204
  isEarlyAdopter: boolean;
205
+ allowLoanOfficerPartnerInvites?: boolean | null;
200
206
  }
201
207
  export interface Address {
202
208
  /** @format uuid */
@@ -1137,6 +1143,21 @@ export interface BranchUserPaginated {
1137
1143
  /** @format int64 */
1138
1144
  count: number;
1139
1145
  }
1146
+ export interface BulkLoanFieldOperation {
1147
+ applied: string[];
1148
+ skipped: BulkLoanFieldSkip[];
1149
+ }
1150
+ export interface BulkLoanFieldOperationRequest {
1151
+ fieldKeys: string[];
1152
+ operation?: BulkLoanFieldOperationType | null;
1153
+ role?: UserRole | null;
1154
+ accessLevel?: CustomFieldAccessLevel | null;
1155
+ enabled?: boolean | null;
1156
+ }
1157
+ export interface BulkLoanFieldSkip {
1158
+ fieldKey: string;
1159
+ reason: string;
1160
+ }
1140
1161
  export interface BulkLoanTaskFailure {
1141
1162
  /** @format uuid */
1142
1163
  userLoanTaskID: string;
@@ -1559,6 +1580,7 @@ export interface CreateAccountRequest {
1559
1580
  domain: string;
1560
1581
  eConsentBucket?: string | null;
1561
1582
  ignoreCoBorrowerRelationship: boolean;
1583
+ isPartnerPortalEnabled: boolean;
1562
1584
  user: AdminUser;
1563
1585
  companyAddress: CompanyAddress;
1564
1586
  contactInfo: ContactInfo;
@@ -2039,6 +2061,7 @@ export interface DraftRequest {
2039
2061
  applicationPayload: any;
2040
2062
  customData?: any | null;
2041
2063
  isCoBorrower: boolean;
2064
+ partnerId?: string | null;
2042
2065
  }
2043
2066
  export interface EconsentPendingSummary {
2044
2067
  /** @format int32 */
@@ -2973,6 +2996,7 @@ export interface LoanApplicationRequest {
2973
2996
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2974
2997
  /** @format uuid */
2975
2998
  draftId?: string | null;
2999
+ partnerId?: string | null;
2976
3000
  additionalFields?: Record<string, any> | null;
2977
3001
  /** @format uuid */
2978
3002
  existingLoanId?: string | null;
@@ -3894,6 +3918,8 @@ export interface LoanDocumentFolderPermissionRequest {
3894
3918
  export interface LoanDocumentFolderSearchCriteria {
3895
3919
  searchText?: string | null;
3896
3920
  isActive?: boolean | null;
3921
+ isSystemDefault?: boolean | null;
3922
+ role?: LoanRole | null;
3897
3923
  }
3898
3924
  export interface LoanDocumentFolderSummary {
3899
3925
  /** @format uuid */
@@ -3984,6 +4010,17 @@ export interface LoanFieldAccess {
3984
4010
  export interface LoanFieldAccessItem {
3985
4011
  fieldKey: string;
3986
4012
  access: LoanFieldAccessItemAccessEnum;
4013
+ patchPath?: string | null;
4014
+ }
4015
+ export interface LoanFieldMappings {
4016
+ encompassFieldIds: string[];
4017
+ templateToken: string;
4018
+ }
4019
+ export interface LoanFieldPermissionsRequest {
4020
+ permissions: CustomFieldPermissionRequest[];
4021
+ }
4022
+ export interface LoanFieldSettingsRequest {
4023
+ isAiEnabled?: boolean | null;
3987
4024
  }
3988
4025
  export interface LoanFinancial {
3989
4026
  /** @format uuid */
@@ -4116,6 +4153,7 @@ export interface LoanList {
4116
4153
  buyerAgentContact?: LoanContactList | null;
4117
4154
  sellerAgentContact?: LoanContactList | null;
4118
4155
  userLoans: UserLoan[];
4156
+ myLoanRoles: LoanRole[];
4119
4157
  contacts: LoanContact[];
4120
4158
  borrowers: LoanListBorrower[];
4121
4159
  taskCounts: LoanTaskCounts;
@@ -4992,6 +5030,19 @@ export interface MonthlyPaymentCalculatorRequest {
4992
5030
  export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4993
5031
  type: MonthlyPaymentWidgetConfigTypeEnum;
4994
5032
  };
5033
+ export interface MyPartner {
5034
+ /** @format uuid */
5035
+ partnerID?: string | null;
5036
+ /** @format uuid */
5037
+ inviteID?: string | null;
5038
+ firstName: string;
5039
+ lastName: string;
5040
+ email: string;
5041
+ phone?: string | null;
5042
+ tier: MyPartnerTierEnum;
5043
+ /** @format date-time */
5044
+ createdAt: string;
5045
+ }
4995
5046
  export type MyTasksWidgetConfig = UtilRequiredKeys<BaseCanvasWidgetConfig, "type"> & {
4996
5047
  /** @format int32 */
4997
5048
  dueWithinDays: number;
@@ -5167,12 +5218,32 @@ export interface Pagination {
5167
5218
  /** @format int32 */
5168
5219
  pageSize: number;
5169
5220
  }
5221
+ export interface PartnerFormLink {
5222
+ /** @format int32 */
5223
+ formType: number;
5224
+ name: string;
5225
+ url: string;
5226
+ }
5227
+ export interface PartnerLinks {
5228
+ slug: string;
5229
+ loanOfficers: PartnerLoanOfficerLinks[];
5230
+ }
5231
+ export interface PartnerLoanOfficerLinks {
5232
+ /** @format uuid */
5233
+ loanOfficerId: string;
5234
+ name: string;
5235
+ siteUrl: string;
5236
+ links: PartnerFormLink[];
5237
+ }
5170
5238
  export interface PartnerSearchCriteria {
5171
5239
  searchText?: string | null;
5172
5240
  isActive?: boolean | null;
5173
5241
  brands?: string[] | null;
5174
5242
  roles?: UserRole[] | null;
5175
5243
  }
5244
+ export interface PartnerSlug {
5245
+ slug: string;
5246
+ }
5176
5247
  export interface PendingInvite {
5177
5248
  status: PendingInviteStatusEnum;
5178
5249
  /** @format uuid */
@@ -5740,6 +5811,7 @@ export interface SiteConfiguration {
5740
5811
  user?: UserPublic | null;
5741
5812
  asoSettings?: ASOSettings | null;
5742
5813
  accountSettings: AccountSettings;
5814
+ isPartnerPortalEnabled: boolean;
5743
5815
  autoTaskReminderIntervalsInDays?: number[] | null;
5744
5816
  mobileSettings?: MobileSettings | null;
5745
5817
  losSettings?: LOSSettings | null;
@@ -5934,6 +6006,7 @@ export interface SiteConfigurationByUrl {
5934
6006
  user?: UserPublic | null;
5935
6007
  asoSettings?: ASOSettings | null;
5936
6008
  accountSettings: AccountSettings;
6009
+ isPartnerPortalEnabled: boolean;
5937
6010
  autoTaskReminderIntervalsInDays?: number[] | null;
5938
6011
  mobileSettings?: MobileSettings | null;
5939
6012
  losSettings?: LOSSettings | null;
@@ -6284,6 +6357,19 @@ export interface SocialSurveyRecord {
6284
6357
  /** @format date-time */
6285
6358
  reviewCompletedTimeStamp?: string | null;
6286
6359
  }
6360
+ export interface StandardLoanField {
6361
+ fieldKey: string;
6362
+ displayName: string;
6363
+ category: string;
6364
+ dataType: StandardLoanFieldDataTypeEnum;
6365
+ isPii: boolean;
6366
+ isWritable: boolean;
6367
+ patchPath?: string | null;
6368
+ mappings: LoanFieldMappings;
6369
+ access: Record<string, CustomFieldAccessLevel>;
6370
+ isCustomized: boolean;
6371
+ isAiEnabled?: boolean | null;
6372
+ }
6287
6373
  export interface SupportedModel {
6288
6374
  modelId: string;
6289
6375
  displayName: string;
@@ -6673,6 +6759,12 @@ export interface UpdateMeRequest {
6673
6759
  export interface UpdateMobilePhoneRequest {
6674
6760
  phone: string;
6675
6761
  }
6762
+ export interface UpdatePartnerPortalRequest {
6763
+ isEnabled?: boolean | null;
6764
+ }
6765
+ export interface UpdatePartnerSlugRequest {
6766
+ slug: string;
6767
+ }
6676
6768
  export interface UpdateUserGroupRequest {
6677
6769
  name: string;
6678
6770
  description?: string | null;
@@ -7330,6 +7422,7 @@ export type LosWebhookInventoryOverallStatusEnum = "Unknown" | "Healthy" | "Disa
7330
7422
  export type LosWebhookSigningKeySyncResultStatusEnum = "Unknown" | "Synced";
7331
7423
  export type ManualDocumentClassificationRequestDocumentTypeEnum = "W2" | "Paystub" | "Form1099" | "Form1099Int" | "Form1099Misc" | "Form1099Nec" | "Form1099R" | "Form1099G" | "Form1099Div" | "Form1099Ssa" | "FederalTaxReturn1040" | "TaxReturnScheduleC" | "TaxReturnScheduleD" | "TaxReturnScheduleE" | "Form1065" | "Form1120" | "Form1120S" | "ProfitAndLossStatement" | "VerificationOfEmployment" | "BankStatement" | "InvestmentStatement" | "CreditCardStatement" | "MortgageStatement" | "PayoffStatement" | "HoaDocuments" | "UtilityBill" | "IdentityDocument" | "DemographicAddendum" | "Ssa89" | "Vba260551" | "Hud92900B" | "Check" | "Invoice" | "Receipt" | "LoanApplication1003" | "UnderwritingTransmittal1008" | "Other" | "SalesContract" | "TitleCommitment" | "DriversLicense" | "VerificationOfIncome" | "VerificationOfAssets" | "FloodCertificate" | "FraudReport" | "AddendumToSalesContract" | "GiftLetter" | "CpaLetter" | "TaxBill" | "CondoQuestionnaire" | "CondoBudget" | "CondoBylaws" | "RentalAgreements" | "Lease" | "HazardInsurance" | "VaCertificateOfEligibility" | "Appraisal" | "CreditReport" | "CondoMasterPolicy" | "EConsent" | "CreditAuthorization" | "TextOptIn" | "LoanComparison" | "AiGeneratedDocument" | "Unidentified";
7332
7424
  export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
7425
+ export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
7333
7426
  export type MyTasksWidgetConfigTypeEnum = "MyTasks";
7334
7427
  export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
7335
7428
  export type PendingInviteStatusEnum = "InvitePending" | "InviteExpired" | "NotInvited";
@@ -7347,6 +7440,7 @@ export type SiteTileLocationAudienceLocationEnum = "HomePage" | "Dashboard";
7347
7440
  export type SiteTileLocationAudienceRequestLocationEnum = "HomePage" | "Dashboard";
7348
7441
  export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
7349
7442
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
7443
+ export type StandardLoanFieldDataTypeEnum = "Text" | "Number" | "Boolean" | "Date" | "Enum" | "Identifier" | "Object";
7350
7444
  export type TextBlockWidgetConfigTypeEnum = "TextBlock";
7351
7445
  export type UnregisteredBorrowerRoleEnum = "Borrower" | "CoBorrower" | "NonBorrower" | "LoanOfficer" | "LoanProcessor" | "LoanOfficerAssistant" | "SupportingLoanOfficer" | "BuyerAgent" | "SellerAgent" | "TitleInsuranceAgent" | "EscrowAgent" | "SettlementAgent" | "Admin";
7352
7446
  export type UpdateAiGuardrailRequestCategoryEnum = "ContentSafety" | "PromptInjection" | "Privacy" | "Legal";
@@ -7432,7 +7526,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
7432
7526
  }
7433
7527
  /**
7434
7528
  * @title The Big POS API
7435
- * @version v3.18.0
7529
+ * @version v3.19.0
7436
7530
  * @termsOfService https://www.thebigpos.com/terms-of-use/
7437
7531
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7438
7532
  */
@@ -7570,6 +7664,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7570
7664
  * @response `422` `ProblemDetails` Unprocessable Content
7571
7665
  */
7572
7666
  updateAccountBilling: (id: string, data: AccountBillingRequest, params?: RequestParams) => Promise<AxiosResponse<AccountBilling, any, {}>>;
7667
+ /**
7668
+ * @description Turns the account's partner portal on or off. While Partner-lite is on for the account, off refuses its realtors' leads and listings and the creation of partner sites.
7669
+ *
7670
+ * @tags Accounts
7671
+ * @name UpdateAccountPartnerPortal
7672
+ * @summary Update partner portal switch
7673
+ * @request PUT:/api/accounts/{id}/partner-portal
7674
+ * @secure
7675
+ * @response `200` `Account` OK
7676
+ * @response `404` `ProblemDetails` Not Found
7677
+ * @response `422` `ProblemDetails` Unprocessable Content
7678
+ */
7679
+ updateAccountPartnerPortal: (id: string, data: UpdatePartnerPortalRequest, params?: RequestParams) => Promise<AxiosResponse<Account, any, {}>>;
7573
7680
  /**
7574
7681
  * No description
7575
7682
  *
@@ -10230,6 +10337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10230
10337
  * @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
10231
10338
  * @secure
10232
10339
  * @response `204` `void` No Content
10340
+ * @response `403` `HttpError` Forbidden
10233
10341
  */
10234
10342
  deleteFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10235
10343
  /**
@@ -10241,6 +10349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10241
10349
  * @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
10242
10350
  * @secure
10243
10351
  * @response `200` `FileWithBytes` OK
10352
+ * @response `403` `HttpError` Forbidden
10244
10353
  */
10245
10354
  downloadFormSubmissionFile: (formSubmissionFileId: string, formSubmissionId: string, query?: {
10246
10355
  /** @format uuid */
@@ -10255,6 +10364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10255
10364
  * @request GET:/api/form-submissions
10256
10365
  * @secure
10257
10366
  * @response `200` `FormSubmissionPaginated` OK
10367
+ * @response `403` `HttpError` Forbidden
10258
10368
  */
10259
10369
  getFormSubmissions: (query?: {
10260
10370
  /** @format int32 */
@@ -10286,6 +10396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10286
10396
  * @request GET:/api/form-submissions/{id}
10287
10397
  * @secure
10288
10398
  * @response `200` `FormSubmission` OK
10399
+ * @response `403` `HttpError` Forbidden
10289
10400
  */
10290
10401
  getFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}>>;
10291
10402
  /**
@@ -10297,6 +10408,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10297
10408
  * @request PUT:/api/form-submissions/{id}
10298
10409
  * @secure
10299
10410
  * @response `200` `FormSubmission` OK
10411
+ * @response `403` `HttpError` Forbidden
10300
10412
  */
10301
10413
  replaceFormSubmission: (id: string, data: FormSubmissionRequest, params?: RequestParams) => Promise<AxiosResponse<FormSubmission, any, {}>>;
10302
10414
  /**
@@ -10308,6 +10420,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10308
10420
  * @request DELETE:/api/form-submissions/{id}
10309
10421
  * @secure
10310
10422
  * @response `204` `void` No Content
10423
+ * @response `403` `HttpError` Forbidden
10311
10424
  */
10312
10425
  deleteFormSubmission: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10313
10426
  /**
@@ -10319,6 +10432,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10319
10432
  * @request POST:/api/form-submissions/search
10320
10433
  * @secure
10321
10434
  * @response `200` `FormSubmissionPaginated` OK
10435
+ * @response `403` `HttpError` Forbidden
10322
10436
  */
10323
10437
  searchFormSubmissions: (data: FormSubmissionSearchCriteria, query?: {
10324
10438
  /** @format int32 */
@@ -10581,6 +10695,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10581
10695
  * @request POST:/api/listings/{listingId}/files
10582
10696
  * @secure
10583
10697
  * @response `200` `ListingFile` OK
10698
+ * @response `403` `HttpError` Forbidden
10584
10699
  */
10585
10700
  addListingFile: (listingId: string, data: {
10586
10701
  /** @format binary */
@@ -10597,6 +10712,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10597
10712
  * @request PATCH:/api/listings/{listingId}/files
10598
10713
  * @secure
10599
10714
  * @response `200` `ListingFile` OK
10715
+ * @response `403` `HttpError` Forbidden
10600
10716
  */
10601
10717
  updateListingFiles: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingFile, any, {}>>;
10602
10718
  /**
@@ -10608,6 +10724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10608
10724
  * @request DELETE:/api/listings/{listingId}/files/{id}
10609
10725
  * @secure
10610
10726
  * @response `204` `Listing` No Content
10727
+ * @response `403` `HttpError` Forbidden
10611
10728
  */
10612
10729
  removeListingFile: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
10613
10730
  /**
@@ -10619,6 +10736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10619
10736
  * @request POST:/api/listings/{listingId}/photos
10620
10737
  * @secure
10621
10738
  * @response `200` `ListingPhoto` OK
10739
+ * @response `403` `HttpError` Forbidden
10622
10740
  */
10623
10741
  addListingPhoto: (listingId: string, data: {
10624
10742
  name?: string;
@@ -10637,6 +10755,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10637
10755
  * @request PATCH:/api/listings/{listingId}/photos
10638
10756
  * @secure
10639
10757
  * @response `200` `(ListingPhoto)[]` OK
10758
+ * @response `403` `HttpError` Forbidden
10640
10759
  */
10641
10760
  updateListingPhotos: (listingId: string, data: JsonPatchDocument, params?: RequestParams) => Promise<AxiosResponse<ListingPhoto[], any, {}>>;
10642
10761
  /**
@@ -10648,6 +10767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10648
10767
  * @request DELETE:/api/listings/{listingId}/photos/{id}
10649
10768
  * @secure
10650
10769
  * @response `204` `Listing` No Content
10770
+ * @response `403` `HttpError` Forbidden
10651
10771
  */
10652
10772
  removeListingPhoto: (listingId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<Listing, any, {}>>;
10653
10773
  /**
@@ -10725,6 +10845,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10725
10845
  * @request DELETE:/api/listings/{id}
10726
10846
  * @secure
10727
10847
  * @response `204` `void` No Content
10848
+ * @response `403` `HttpError` Forbidden
10728
10849
  */
10729
10850
  deleteListing: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10730
10851
  /**
@@ -10754,6 +10875,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10754
10875
  * @request PUT:/api/listings/{id}/background-image
10755
10876
  * @secure
10756
10877
  * @response `200` `File` OK
10878
+ * @response `403` `HttpError` Forbidden
10757
10879
  */
10758
10880
  updateListingBackgroundImage: (id: string, data: {
10759
10881
  /** @format binary */
@@ -10768,6 +10890,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10768
10890
  * @request DELETE:/api/listings/{id}/background-image
10769
10891
  * @secure
10770
10892
  * @response `204` `void` No Content
10893
+ * @response `403` `HttpError` Forbidden
10771
10894
  */
10772
10895
  deleteListingBackgroundImage: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
10773
10896
  /**
@@ -11098,7 +11221,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11098
11221
  */
11099
11222
  getLoanDocumentFolderUsage: (id: string, params?: RequestParams) => Promise<AxiosResponse<LoanDocumentFolderUsage, any, {}>>;
11100
11223
  /**
11101
- * @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.
11224
+ * @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.
11102
11225
  *
11103
11226
  * @tags LoanDocumentFoldersForSingleLoan
11104
11227
  * @name ListLoanDocumentFolders
@@ -11388,6 +11511,76 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11388
11511
  * @response `403` `ProblemDetails` Forbidden
11389
11512
  */
11390
11513
  getLoanFieldAccess: (params?: RequestParams) => Promise<AxiosResponse<LoanFieldAccess, any, {}>>;
11514
+ /**
11515
+ * No description
11516
+ *
11517
+ * @tags LoanFields
11518
+ * @name GetStandardLoanFields
11519
+ * @summary List standard loan fields with effective access and settings
11520
+ * @request GET:/api/loan-fields/standard
11521
+ * @secure
11522
+ * @response `200` `(StandardLoanField)[]` OK
11523
+ * @response `401` `ProblemDetails` Unauthorized
11524
+ * @response `403` `ProblemDetails` Forbidden
11525
+ */
11526
+ getStandardLoanFields: (params?: RequestParams) => Promise<AxiosResponse<StandardLoanField[], any, {}>>;
11527
+ /**
11528
+ * No description
11529
+ *
11530
+ * @tags LoanFields
11531
+ * @name SetLoanFieldPermissions
11532
+ * @summary Set role access levels on one loan field
11533
+ * @request PUT:/api/loan-fields/{fieldKey}/permissions
11534
+ * @secure
11535
+ * @response `204` `void` No Content
11536
+ * @response `401` `ProblemDetails` Unauthorized
11537
+ * @response `403` `ProblemDetails` Forbidden
11538
+ * @response `404` `ProblemDetails` Not Found
11539
+ */
11540
+ setLoanFieldPermissions: (fieldKey: string, data: LoanFieldPermissionsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11541
+ /**
11542
+ * No description
11543
+ *
11544
+ * @tags LoanFields
11545
+ * @name SetLoanFieldSettings
11546
+ * @summary Set the AI setting on one loan field
11547
+ * @request PUT:/api/loan-fields/{fieldKey}/settings
11548
+ * @secure
11549
+ * @response `204` `void` No Content
11550
+ * @response `401` `ProblemDetails` Unauthorized
11551
+ * @response `403` `ProblemDetails` Forbidden
11552
+ * @response `404` `ProblemDetails` Not Found
11553
+ */
11554
+ setLoanFieldSettings: (fieldKey: string, data: LoanFieldSettingsRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11555
+ /**
11556
+ * No description
11557
+ *
11558
+ * @tags LoanFields
11559
+ * @name ResetLoanFieldOverrides
11560
+ * @summary Reset one standard loan field to its seeded defaults
11561
+ * @request DELETE:/api/loan-fields/{fieldKey}/overrides
11562
+ * @secure
11563
+ * @response `204` `void` No Content
11564
+ * @response `401` `ProblemDetails` Unauthorized
11565
+ * @response `403` `ProblemDetails` Forbidden
11566
+ * @response `404` `ProblemDetails` Not Found
11567
+ */
11568
+ resetLoanFieldOverrides: (fieldKey: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
11569
+ /**
11570
+ * No description
11571
+ *
11572
+ * @tags LoanFields
11573
+ * @name BulkLoanFieldOperation
11574
+ * @summary Apply one operation to many loan fields
11575
+ * @request POST:/api/loan-fields/bulk
11576
+ * @secure
11577
+ * @response `200` `BulkLoanFieldOperation` OK
11578
+ * @response `401` `ProblemDetails` Unauthorized
11579
+ * @response `403` `ProblemDetails` Forbidden
11580
+ * @response `404` `ProblemDetails` Not Found
11581
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11582
+ */
11583
+ bulkLoanFieldOperation: (data: BulkLoanFieldOperationRequest, params?: RequestParams) => Promise<AxiosResponse<BulkLoanFieldOperation, any, {}>>;
11391
11584
  /**
11392
11585
  * No description
11393
11586
  *
@@ -12776,6 +12969,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12776
12969
  * @response `200` `NotificationTemplateVersion` OK
12777
12970
  */
12778
12971
  deleteNotificationTemplateVersion: (notificationId: string, id: string, params?: RequestParams) => Promise<AxiosResponse<NotificationTemplateVersion, any, {}>>;
12972
+ /**
12973
+ * @description Changes the short name a realtor's partner links carry. Links shared with the previous name stop working.
12974
+ *
12975
+ * @tags Partners
12976
+ * @name UpdatePartnerLinkSlug
12977
+ * @summary Update Partner Link Slug
12978
+ * @request PUT:/api/partners/{realtorId}/link-slug
12979
+ * @secure
12980
+ * @response `200` `PartnerSlug` OK
12981
+ * @response `403` `ProblemDetails` Forbidden
12982
+ * @response `404` `ProblemDetails` Not Found
12983
+ * @response `409` `ProblemDetails` Conflict
12984
+ * @response `422` `UnprocessableEntity` Unprocessable Content
12985
+ */
12986
+ updatePartnerLinkSlug: (realtorId: string, data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerSlug, any, {}>>;
12779
12987
  /**
12780
12988
  * No description
12781
12989
  *
@@ -14340,6 +14548,72 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14340
14548
  * @response `204` `void` No Content
14341
14549
  */
14342
14550
  deleteRelationshipProspect: (id: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
14551
+ /**
14552
+ * @description The partners on the loan officer's list and the loan officer's portal relations, plus the open partner invites the loan officer sent
14553
+ *
14554
+ * @tags UsersMe
14555
+ * @name GetMyPartners
14556
+ * @summary Get My Partners
14557
+ * @request GET:/api/users/me/partners
14558
+ * @secure
14559
+ * @response `200` `(MyPartner)[]` OK
14560
+ * @response `403` `ProblemDetails` Forbidden
14561
+ */
14562
+ getMyPartners: (params?: RequestParams) => Promise<AxiosResponse<MyPartner[], any, {}>>;
14563
+ /**
14564
+ * No description
14565
+ *
14566
+ * @tags UsersMe
14567
+ * @name AddMyPartner
14568
+ * @summary Add My Partner
14569
+ * @request POST:/api/users/me/partners/{partnerId}
14570
+ * @secure
14571
+ * @response `204` `void` No Content
14572
+ * @response `403` `ProblemDetails` Forbidden
14573
+ * @response `404` `ProblemDetails` Not Found
14574
+ */
14575
+ addMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
14576
+ /**
14577
+ * No description
14578
+ *
14579
+ * @tags UsersMe
14580
+ * @name RemoveMyPartner
14581
+ * @summary Remove My Partner
14582
+ * @request DELETE:/api/users/me/partners/{partnerId}
14583
+ * @secure
14584
+ * @response `204` `void` No Content
14585
+ * @response `403` `ProblemDetails` Forbidden
14586
+ * @response `404` `ProblemDetails` Not Found
14587
+ */
14588
+ removeMyPartner: (partnerId: string, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
14589
+ /**
14590
+ * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
14591
+ *
14592
+ * @tags UsersMe
14593
+ * @name GetMyPartnerLinks
14594
+ * @summary Get My Partner Links
14595
+ * @request GET:/api/users/me/partner-links
14596
+ * @secure
14597
+ * @response `200` `PartnerLinks` OK
14598
+ * @response `403` `ProblemDetails` Forbidden
14599
+ * @response `404` `ProblemDetails` Not Found
14600
+ */
14601
+ getMyPartnerLinks: (params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}>>;
14602
+ /**
14603
+ * @description Changes the short name the partner's links carry and returns the links rebuilt with it. Links shared with the previous name stop working.
14604
+ *
14605
+ * @tags UsersMe
14606
+ * @name UpdateMyPartnerLinkSlug
14607
+ * @summary Update My Partner Link Slug
14608
+ * @request PUT:/api/users/me/partner-links/slug
14609
+ * @secure
14610
+ * @response `200` `PartnerLinks` OK
14611
+ * @response `403` `ProblemDetails` Forbidden
14612
+ * @response `404` `ProblemDetails` Not Found
14613
+ * @response `409` `ProblemDetails` Conflict
14614
+ * @response `422` `UnprocessableEntity` Unprocessable Content
14615
+ */
14616
+ updateMyPartnerLinkSlug: (data: UpdatePartnerSlugRequest, params?: RequestParams) => Promise<AxiosResponse<PartnerLinks, any, {}>>;
14343
14617
  /**
14344
14618
  * No description
14345
14619
  *