@matech/thebigpos-sdk 3.18.0 → 3.19.0-dev-6801

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/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: string;
2610
+ loanID?: string | null;
2573
2611
  route?: string | null;
2574
2612
  /** @format uuid */
2575
2613
  siteConfigurationID: string;
@@ -2981,6 +3019,8 @@ export interface DraftRequest {
2981
3019
  applicationPayload: any;
2982
3020
  customData?: any | null;
2983
3021
  isCoBorrower: boolean;
3022
+ /** @format uuid */
3023
+ partnerId?: string | null;
2984
3024
  }
2985
3025
 
2986
3026
  export interface EconsentPendingSummary {
@@ -4010,6 +4050,8 @@ export interface LoanApplicationRequest {
4010
4050
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
4011
4051
  /** @format uuid */
4012
4052
  draftId?: string | null;
4053
+ /** @format uuid */
4054
+ partnerId?: string | null;
4013
4055
  additionalFields?: Record<string, any> | null;
4014
4056
  /** @format uuid */
4015
4057
  existingLoanId?: string | null;
@@ -5013,6 +5055,8 @@ export interface LoanDocumentFolderPermissionRequest {
5013
5055
  export interface LoanDocumentFolderSearchCriteria {
5014
5056
  searchText?: string | null;
5015
5057
  isActive?: boolean | null;
5058
+ isSystemDefault?: boolean | null;
5059
+ role?: LoanRole | null;
5016
5060
  }
5017
5061
 
5018
5062
  export interface LoanDocumentFolderSummary {
@@ -5113,6 +5157,20 @@ export interface LoanFieldAccess {
5113
5157
  export interface LoanFieldAccessItem {
5114
5158
  fieldKey: string;
5115
5159
  access: LoanFieldAccessItemAccessEnum;
5160
+ patchPath?: string | null;
5161
+ }
5162
+
5163
+ export interface LoanFieldMappings {
5164
+ encompassFieldIds: string[];
5165
+ templateToken: string;
5166
+ }
5167
+
5168
+ export interface LoanFieldPermissionsRequest {
5169
+ permissions: CustomFieldPermissionRequest[];
5170
+ }
5171
+
5172
+ export interface LoanFieldSettingsRequest {
5173
+ isAiEnabled?: boolean | null;
5116
5174
  }
5117
5175
 
5118
5176
  export interface LoanFinancial {
@@ -5255,6 +5313,7 @@ export interface LoanList {
5255
5313
  buyerAgentContact?: LoanContactList | null;
5256
5314
  sellerAgentContact?: LoanContactList | null;
5257
5315
  userLoans: UserLoan[];
5316
+ myLoanRoles: LoanRole[];
5258
5317
  contacts: LoanContact[];
5259
5318
  borrowers: LoanListBorrower[];
5260
5319
  taskCounts: LoanTaskCounts;
@@ -6219,6 +6278,20 @@ export type MonthlyPaymentWidgetConfig = UtilRequiredKeys<
6219
6278
  type: MonthlyPaymentWidgetConfigTypeEnum;
6220
6279
  };
6221
6280
 
6281
+ export interface MyPartner {
6282
+ /** @format uuid */
6283
+ partnerID?: string | null;
6284
+ /** @format uuid */
6285
+ inviteID?: string | null;
6286
+ firstName: string;
6287
+ lastName: string;
6288
+ email: string;
6289
+ phone?: string | null;
6290
+ tier: MyPartnerTierEnum;
6291
+ /** @format date-time */
6292
+ createdAt: string;
6293
+ }
6294
+
6222
6295
  export type MyTasksWidgetConfig = UtilRequiredKeys<
6223
6296
  BaseCanvasWidgetConfig,
6224
6297
  "type"
@@ -6417,6 +6490,27 @@ export interface Pagination {
6417
6490
  pageSize: number;
6418
6491
  }
6419
6492
 
6493
+ export interface PartnerFormLink {
6494
+ /** @format int32 */
6495
+ formType: number;
6496
+ name: string;
6497
+ url: string;
6498
+ }
6499
+
6500
+ export interface PartnerLinks {
6501
+ /** @format uuid */
6502
+ partnerId: string;
6503
+ loanOfficers: PartnerLoanOfficerLinks[];
6504
+ }
6505
+
6506
+ export interface PartnerLoanOfficerLinks {
6507
+ /** @format uuid */
6508
+ loanOfficerId: string;
6509
+ name: string;
6510
+ siteUrl: string;
6511
+ links: PartnerFormLink[];
6512
+ }
6513
+
6420
6514
  export interface PartnerSearchCriteria {
6421
6515
  searchText?: string | null;
6422
6516
  isActive?: boolean | null;
@@ -7046,6 +7140,7 @@ export interface SiteConfiguration {
7046
7140
  user?: UserPublic | null;
7047
7141
  asoSettings?: ASOSettings | null;
7048
7142
  accountSettings: AccountSettings;
7143
+ isPartnerPortalEnabled: boolean;
7049
7144
  autoTaskReminderIntervalsInDays?: number[] | null;
7050
7145
  mobileSettings?: MobileSettings | null;
7051
7146
  losSettings?: LOSSettings | null;
@@ -7241,6 +7336,7 @@ export interface SiteConfigurationByUrl {
7241
7336
  user?: UserPublic | null;
7242
7337
  asoSettings?: ASOSettings | null;
7243
7338
  accountSettings: AccountSettings;
7339
+ isPartnerPortalEnabled: boolean;
7244
7340
  autoTaskReminderIntervalsInDays?: number[] | null;
7245
7341
  mobileSettings?: MobileSettings | null;
7246
7342
  losSettings?: LOSSettings | null;
@@ -7609,6 +7705,20 @@ export interface SocialSurveyRecord {
7609
7705
  reviewCompletedTimeStamp?: string | null;
7610
7706
  }
7611
7707
 
7708
+ export interface StandardLoanField {
7709
+ fieldKey: string;
7710
+ displayName: string;
7711
+ category: string;
7712
+ dataType: StandardLoanFieldDataTypeEnum;
7713
+ isPii: boolean;
7714
+ isWritable: boolean;
7715
+ patchPath?: string | null;
7716
+ mappings: LoanFieldMappings;
7717
+ access: Record<string, CustomFieldAccessLevel>;
7718
+ isCustomized: boolean;
7719
+ isAiEnabled?: boolean | null;
7720
+ }
7721
+
7612
7722
  export interface SupportedModel {
7613
7723
  modelId: string;
7614
7724
  displayName: string;
@@ -8047,6 +8157,10 @@ export interface UpdateMobilePhoneRequest {
8047
8157
  phone: string;
8048
8158
  }
8049
8159
 
8160
+ export interface UpdatePartnerPortalRequest {
8161
+ isEnabled?: boolean | null;
8162
+ }
8163
+
8050
8164
  export interface UpdateUserGroupRequest {
8051
8165
  name: string;
8052
8166
  description?: string | null;
@@ -9500,6 +9614,8 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
9500
9614
 
9501
9615
  export type MonthlyPaymentWidgetConfigTypeEnum = "MonthlyPayment";
9502
9616
 
9617
+ export type MyPartnerTierEnum = "Lite" | "LitePlusPortal" | "Pending";
9618
+
9503
9619
  export type MyTasksWidgetConfigTypeEnum = "MyTasks";
9504
9620
 
9505
9621
  export type OpenTasksWidgetConfigTypeEnum = "OpenTasks";
@@ -9582,6 +9698,15 @@ export type SiteTileRequestLinkTargetEnum = "Self" | "Blank";
9582
9698
 
9583
9699
  export type SiteTileViewLinkTargetEnum = "Self" | "Blank";
9584
9700
 
9701
+ export type StandardLoanFieldDataTypeEnum =
9702
+ | "Text"
9703
+ | "Number"
9704
+ | "Boolean"
9705
+ | "Date"
9706
+ | "Enum"
9707
+ | "Identifier"
9708
+ | "Object";
9709
+
9585
9710
  export type TextBlockWidgetConfigTypeEnum = "TextBlock";
9586
9711
 
9587
9712
  export type UnregisteredBorrowerRoleEnum =
@@ -9904,7 +10029,15 @@ export class HttpClient<SecurityDataType = unknown> {
9904
10029
  property instanceof Array ? property : [property];
9905
10030
 
9906
10031
  for (const formItem of propertyContent) {
9907
- const isFileType = formItem instanceof Blob || formItem instanceof File;
10032
+ // React Native files are plain { uri, name, type } objects, not Blob/File.
10033
+ const isReactNativeFile =
10034
+ !!formItem &&
10035
+ typeof formItem === "object" &&
10036
+ "uri" in formItem &&
10037
+ "name" in formItem &&
10038
+ "type" in formItem;
10039
+ const isFileType =
10040
+ isReactNativeFile || formItem instanceof Blob || formItem instanceof File;
9908
10041
  formData.append(
9909
10042
  key,
9910
10043
  isFileType ? formItem : this.stringifyFormItem(formItem),
@@ -9966,7 +10099,7 @@ export class HttpClient<SecurityDataType = unknown> {
9966
10099
 
9967
10100
  /**
9968
10101
  * @title The Big POS API
9969
- * @version v3.18.0
10102
+ * @version v3.19.0
9970
10103
  * @termsOfService https://www.thebigpos.com/terms-of-use/
9971
10104
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
9972
10105
  */
@@ -10215,6 +10348,33 @@ export class Api<
10215
10348
  ...params,
10216
10349
  }),
10217
10350
 
10351
+ /**
10352
+ * @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.
10353
+ *
10354
+ * @tags Accounts
10355
+ * @name UpdateAccountPartnerPortal
10356
+ * @summary Update partner portal switch
10357
+ * @request PUT:/api/accounts/{id}/partner-portal
10358
+ * @secure
10359
+ * @response `200` `Account` OK
10360
+ * @response `404` `ProblemDetails` Not Found
10361
+ * @response `422` `ProblemDetails` Unprocessable Content
10362
+ */
10363
+ updateAccountPartnerPortal: (
10364
+ id: string,
10365
+ data: UpdatePartnerPortalRequest,
10366
+ params: RequestParams = {},
10367
+ ) =>
10368
+ this.request<Account, ProblemDetails>({
10369
+ path: `/api/accounts/${id}/partner-portal`,
10370
+ method: "PUT",
10371
+ body: data,
10372
+ secure: true,
10373
+ type: "application/json",
10374
+ format: "json",
10375
+ ...params,
10376
+ }),
10377
+
10218
10378
  /**
10219
10379
  * No description
10220
10380
  *
@@ -14974,13 +15134,14 @@ export class Api<
14974
15134
  * @request DELETE:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}
14975
15135
  * @secure
14976
15136
  * @response `204` `void` No Content
15137
+ * @response `403` `HttpError` Forbidden
14977
15138
  */
14978
15139
  deleteFormSubmissionFile: (
14979
15140
  formSubmissionFileId: string,
14980
15141
  formSubmissionId: string,
14981
15142
  params: RequestParams = {},
14982
15143
  ) =>
14983
- this.request<void, any>({
15144
+ this.request<void, HttpError>({
14984
15145
  path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}`,
14985
15146
  method: "DELETE",
14986
15147
  secure: true,
@@ -14996,6 +15157,7 @@ export class Api<
14996
15157
  * @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
14997
15158
  * @secure
14998
15159
  * @response `200` `FileWithBytes` OK
15160
+ * @response `403` `HttpError` Forbidden
14999
15161
  */
15000
15162
  downloadFormSubmissionFile: (
15001
15163
  formSubmissionFileId: string,
@@ -15006,7 +15168,7 @@ export class Api<
15006
15168
  },
15007
15169
  params: RequestParams = {},
15008
15170
  ) =>
15009
- this.request<FileWithBytes, any>({
15171
+ this.request<FileWithBytes, HttpError>({
15010
15172
  path: `/api/form-submissions/${formSubmissionId}/files/${formSubmissionFileId}/download`,
15011
15173
  method: "GET",
15012
15174
  query: query,
@@ -15024,6 +15186,7 @@ export class Api<
15024
15186
  * @request GET:/api/form-submissions
15025
15187
  * @secure
15026
15188
  * @response `200` `FormSubmissionPaginated` OK
15189
+ * @response `403` `HttpError` Forbidden
15027
15190
  */
15028
15191
  getFormSubmissions: (
15029
15192
  query?: {
@@ -15036,7 +15199,7 @@ export class Api<
15036
15199
  },
15037
15200
  params: RequestParams = {},
15038
15201
  ) =>
15039
- this.request<FormSubmissionPaginated, any>({
15202
+ this.request<FormSubmissionPaginated, HttpError>({
15040
15203
  path: `/api/form-submissions`,
15041
15204
  method: "GET",
15042
15205
  query: query,
@@ -15082,9 +15245,10 @@ export class Api<
15082
15245
  * @request GET:/api/form-submissions/{id}
15083
15246
  * @secure
15084
15247
  * @response `200` `FormSubmission` OK
15248
+ * @response `403` `HttpError` Forbidden
15085
15249
  */
15086
15250
  getFormSubmission: (id: string, params: RequestParams = {}) =>
15087
- this.request<FormSubmission, any>({
15251
+ this.request<FormSubmission, HttpError>({
15088
15252
  path: `/api/form-submissions/${id}`,
15089
15253
  method: "GET",
15090
15254
  secure: true,
@@ -15101,13 +15265,14 @@ export class Api<
15101
15265
  * @request PUT:/api/form-submissions/{id}
15102
15266
  * @secure
15103
15267
  * @response `200` `FormSubmission` OK
15268
+ * @response `403` `HttpError` Forbidden
15104
15269
  */
15105
15270
  replaceFormSubmission: (
15106
15271
  id: string,
15107
15272
  data: FormSubmissionRequest,
15108
15273
  params: RequestParams = {},
15109
15274
  ) =>
15110
- this.request<FormSubmission, any>({
15275
+ this.request<FormSubmission, HttpError>({
15111
15276
  path: `/api/form-submissions/${id}`,
15112
15277
  method: "PUT",
15113
15278
  body: data,
@@ -15126,9 +15291,10 @@ export class Api<
15126
15291
  * @request DELETE:/api/form-submissions/{id}
15127
15292
  * @secure
15128
15293
  * @response `204` `void` No Content
15294
+ * @response `403` `HttpError` Forbidden
15129
15295
  */
15130
15296
  deleteFormSubmission: (id: string, params: RequestParams = {}) =>
15131
- this.request<void, any>({
15297
+ this.request<void, HttpError>({
15132
15298
  path: `/api/form-submissions/${id}`,
15133
15299
  method: "DELETE",
15134
15300
  secure: true,
@@ -15144,6 +15310,7 @@ export class Api<
15144
15310
  * @request POST:/api/form-submissions/search
15145
15311
  * @secure
15146
15312
  * @response `200` `FormSubmissionPaginated` OK
15313
+ * @response `403` `HttpError` Forbidden
15147
15314
  */
15148
15315
  searchFormSubmissions: (
15149
15316
  data: FormSubmissionSearchCriteria,
@@ -15157,7 +15324,7 @@ export class Api<
15157
15324
  },
15158
15325
  params: RequestParams = {},
15159
15326
  ) =>
15160
- this.request<FormSubmissionPaginated, any>({
15327
+ this.request<FormSubmissionPaginated, HttpError>({
15161
15328
  path: `/api/form-submissions/search`,
15162
15329
  method: "POST",
15163
15330
  query: query,
@@ -15586,30 +15753,6 @@ export class Api<
15586
15753
  ...params,
15587
15754
  }),
15588
15755
 
15589
- /**
15590
- * No description
15591
- *
15592
- * @tags LegacyLoan
15593
- * @name GetLoanEmbeddedSigningLink
15594
- * @summary Get Embedded Signing Link
15595
- * @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
15596
- * @secure
15597
- * @response `200` `string` OK
15598
- */
15599
- getLoanEmbeddedSigningLink: (
15600
- envelopeId: string,
15601
- userName: string,
15602
- email: string,
15603
- params: RequestParams = {},
15604
- ) =>
15605
- this.request<string, any>({
15606
- path: `/api/los/loan/embeddedsigning/${envelopeId}/${userName}/${email}`,
15607
- method: "POST",
15608
- secure: true,
15609
- format: "json",
15610
- ...params,
15611
- }),
15612
-
15613
15756
  /**
15614
15757
  * No description
15615
15758
  *
@@ -15649,6 +15792,7 @@ export class Api<
15649
15792
  * @request POST:/api/listings/{listingId}/files
15650
15793
  * @secure
15651
15794
  * @response `200` `ListingFile` OK
15795
+ * @response `403` `HttpError` Forbidden
15652
15796
  */
15653
15797
  addListingFile: (
15654
15798
  listingId: string,
@@ -15660,7 +15804,7 @@ export class Api<
15660
15804
  },
15661
15805
  params: RequestParams = {},
15662
15806
  ) =>
15663
- this.request<ListingFile, any>({
15807
+ this.request<ListingFile, HttpError>({
15664
15808
  path: `/api/listings/${listingId}/files`,
15665
15809
  method: "POST",
15666
15810
  body: data,
@@ -15679,13 +15823,14 @@ export class Api<
15679
15823
  * @request PATCH:/api/listings/{listingId}/files
15680
15824
  * @secure
15681
15825
  * @response `200` `ListingFile` OK
15826
+ * @response `403` `HttpError` Forbidden
15682
15827
  */
15683
15828
  updateListingFiles: (
15684
15829
  listingId: string,
15685
15830
  data: JsonPatchDocument,
15686
15831
  params: RequestParams = {},
15687
15832
  ) =>
15688
- this.request<ListingFile, any>({
15833
+ this.request<ListingFile, HttpError>({
15689
15834
  path: `/api/listings/${listingId}/files`,
15690
15835
  method: "PATCH",
15691
15836
  body: data,
@@ -15704,13 +15849,14 @@ export class Api<
15704
15849
  * @request DELETE:/api/listings/{listingId}/files/{id}
15705
15850
  * @secure
15706
15851
  * @response `204` `Listing` No Content
15852
+ * @response `403` `HttpError` Forbidden
15707
15853
  */
15708
15854
  removeListingFile: (
15709
15855
  listingId: string,
15710
15856
  id: string,
15711
15857
  params: RequestParams = {},
15712
15858
  ) =>
15713
- this.request<Listing, any>({
15859
+ this.request<Listing, HttpError>({
15714
15860
  path: `/api/listings/${listingId}/files/${id}`,
15715
15861
  method: "DELETE",
15716
15862
  secure: true,
@@ -15727,6 +15873,7 @@ export class Api<
15727
15873
  * @request POST:/api/listings/{listingId}/photos
15728
15874
  * @secure
15729
15875
  * @response `200` `ListingPhoto` OK
15876
+ * @response `403` `HttpError` Forbidden
15730
15877
  */
15731
15878
  addListingPhoto: (
15732
15879
  listingId: string,
@@ -15740,7 +15887,7 @@ export class Api<
15740
15887
  },
15741
15888
  params: RequestParams = {},
15742
15889
  ) =>
15743
- this.request<ListingPhoto, any>({
15890
+ this.request<ListingPhoto, HttpError>({
15744
15891
  path: `/api/listings/${listingId}/photos`,
15745
15892
  method: "POST",
15746
15893
  body: data,
@@ -15759,13 +15906,14 @@ export class Api<
15759
15906
  * @request PATCH:/api/listings/{listingId}/photos
15760
15907
  * @secure
15761
15908
  * @response `200` `(ListingPhoto)[]` OK
15909
+ * @response `403` `HttpError` Forbidden
15762
15910
  */
15763
15911
  updateListingPhotos: (
15764
15912
  listingId: string,
15765
15913
  data: JsonPatchDocument,
15766
15914
  params: RequestParams = {},
15767
15915
  ) =>
15768
- this.request<ListingPhoto[], any>({
15916
+ this.request<ListingPhoto[], HttpError>({
15769
15917
  path: `/api/listings/${listingId}/photos`,
15770
15918
  method: "PATCH",
15771
15919
  body: data,
@@ -15784,13 +15932,14 @@ export class Api<
15784
15932
  * @request DELETE:/api/listings/{listingId}/photos/{id}
15785
15933
  * @secure
15786
15934
  * @response `204` `Listing` No Content
15935
+ * @response `403` `HttpError` Forbidden
15787
15936
  */
15788
15937
  removeListingPhoto: (
15789
15938
  listingId: string,
15790
15939
  id: string,
15791
15940
  params: RequestParams = {},
15792
15941
  ) =>
15793
- this.request<Listing, any>({
15942
+ this.request<Listing, HttpError>({
15794
15943
  path: `/api/listings/${listingId}/photos/${id}`,
15795
15944
  method: "DELETE",
15796
15945
  secure: true,
@@ -15925,9 +16074,10 @@ export class Api<
15925
16074
  * @request DELETE:/api/listings/{id}
15926
16075
  * @secure
15927
16076
  * @response `204` `void` No Content
16077
+ * @response `403` `HttpError` Forbidden
15928
16078
  */
15929
16079
  deleteListing: (id: string, params: RequestParams = {}) =>
15930
- this.request<void, any>({
16080
+ this.request<void, HttpError>({
15931
16081
  path: `/api/listings/${id}`,
15932
16082
  method: "DELETE",
15933
16083
  secure: true,
@@ -15976,6 +16126,7 @@ export class Api<
15976
16126
  * @request PUT:/api/listings/{id}/background-image
15977
16127
  * @secure
15978
16128
  * @response `200` `File` OK
16129
+ * @response `403` `HttpError` Forbidden
15979
16130
  */
15980
16131
  updateListingBackgroundImage: (
15981
16132
  id: string,
@@ -15985,7 +16136,7 @@ export class Api<
15985
16136
  },
15986
16137
  params: RequestParams = {},
15987
16138
  ) =>
15988
- this.request<File, any>({
16139
+ this.request<File, HttpError>({
15989
16140
  path: `/api/listings/${id}/background-image`,
15990
16141
  method: "PUT",
15991
16142
  body: data,
@@ -16004,9 +16155,10 @@ export class Api<
16004
16155
  * @request DELETE:/api/listings/{id}/background-image
16005
16156
  * @secure
16006
16157
  * @response `204` `void` No Content
16158
+ * @response `403` `HttpError` Forbidden
16007
16159
  */
16008
16160
  deleteListingBackgroundImage: (id: string, params: RequestParams = {}) =>
16009
- this.request<void, any>({
16161
+ this.request<void, HttpError>({
16010
16162
  path: `/api/listings/${id}/background-image`,
16011
16163
  method: "DELETE",
16012
16164
  secure: true,
@@ -16600,7 +16752,7 @@ export class Api<
16600
16752
  }),
16601
16753
 
16602
16754
  /**
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.
16755
+ * @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
16756
  *
16605
16757
  * @tags LoanDocumentFoldersForSingleLoan
16606
16758
  * @name ListLoanDocumentFolders
@@ -17149,6 +17301,133 @@ export class Api<
17149
17301
  ...params,
17150
17302
  }),
17151
17303
 
17304
+ /**
17305
+ * No description
17306
+ *
17307
+ * @tags LoanFields
17308
+ * @name GetStandardLoanFields
17309
+ * @summary List standard loan fields with effective access and settings
17310
+ * @request GET:/api/loan-fields/standard
17311
+ * @secure
17312
+ * @response `200` `(StandardLoanField)[]` OK
17313
+ * @response `401` `ProblemDetails` Unauthorized
17314
+ * @response `403` `ProblemDetails` Forbidden
17315
+ */
17316
+ getStandardLoanFields: (params: RequestParams = {}) =>
17317
+ this.request<StandardLoanField[], ProblemDetails>({
17318
+ path: `/api/loan-fields/standard`,
17319
+ method: "GET",
17320
+ secure: true,
17321
+ format: "json",
17322
+ ...params,
17323
+ }),
17324
+
17325
+ /**
17326
+ * No description
17327
+ *
17328
+ * @tags LoanFields
17329
+ * @name SetLoanFieldPermissions
17330
+ * @summary Set role access levels on one loan field
17331
+ * @request PUT:/api/loan-fields/{fieldKey}/permissions
17332
+ * @secure
17333
+ * @response `204` `void` No Content
17334
+ * @response `401` `ProblemDetails` Unauthorized
17335
+ * @response `403` `ProblemDetails` Forbidden
17336
+ * @response `404` `ProblemDetails` Not Found
17337
+ */
17338
+ setLoanFieldPermissions: (
17339
+ fieldKey: string,
17340
+ data: LoanFieldPermissionsRequest,
17341
+ params: RequestParams = {},
17342
+ ) =>
17343
+ this.request<void, ProblemDetails>({
17344
+ path: `/api/loan-fields/${fieldKey}/permissions`,
17345
+ method: "PUT",
17346
+ body: data,
17347
+ secure: true,
17348
+ type: "application/json",
17349
+ ...params,
17350
+ }),
17351
+
17352
+ /**
17353
+ * No description
17354
+ *
17355
+ * @tags LoanFields
17356
+ * @name SetLoanFieldSettings
17357
+ * @summary Set the AI setting on one loan field
17358
+ * @request PUT:/api/loan-fields/{fieldKey}/settings
17359
+ * @secure
17360
+ * @response `204` `void` No Content
17361
+ * @response `401` `ProblemDetails` Unauthorized
17362
+ * @response `403` `ProblemDetails` Forbidden
17363
+ * @response `404` `ProblemDetails` Not Found
17364
+ */
17365
+ setLoanFieldSettings: (
17366
+ fieldKey: string,
17367
+ data: LoanFieldSettingsRequest,
17368
+ params: RequestParams = {},
17369
+ ) =>
17370
+ this.request<void, ProblemDetails>({
17371
+ path: `/api/loan-fields/${fieldKey}/settings`,
17372
+ method: "PUT",
17373
+ body: data,
17374
+ secure: true,
17375
+ type: "application/json",
17376
+ ...params,
17377
+ }),
17378
+
17379
+ /**
17380
+ * No description
17381
+ *
17382
+ * @tags LoanFields
17383
+ * @name ResetLoanFieldOverrides
17384
+ * @summary Reset one standard loan field to its seeded defaults
17385
+ * @request DELETE:/api/loan-fields/{fieldKey}/overrides
17386
+ * @secure
17387
+ * @response `204` `void` No Content
17388
+ * @response `401` `ProblemDetails` Unauthorized
17389
+ * @response `403` `ProblemDetails` Forbidden
17390
+ * @response `404` `ProblemDetails` Not Found
17391
+ */
17392
+ resetLoanFieldOverrides: (fieldKey: string, params: RequestParams = {}) =>
17393
+ this.request<void, ProblemDetails>({
17394
+ path: `/api/loan-fields/${fieldKey}/overrides`,
17395
+ method: "DELETE",
17396
+ secure: true,
17397
+ ...params,
17398
+ }),
17399
+
17400
+ /**
17401
+ * No description
17402
+ *
17403
+ * @tags LoanFields
17404
+ * @name BulkLoanFieldOperation
17405
+ * @summary Apply one operation to many loan fields
17406
+ * @request POST:/api/loan-fields/bulk
17407
+ * @secure
17408
+ * @response `200` `BulkLoanFieldOperation` OK
17409
+ * @response `401` `ProblemDetails` Unauthorized
17410
+ * @response `403` `ProblemDetails` Forbidden
17411
+ * @response `404` `ProblemDetails` Not Found
17412
+ * @response `422` `UnprocessableEntity` Unprocessable Content
17413
+ */
17414
+ bulkLoanFieldOperation: (
17415
+ data: BulkLoanFieldOperationRequest,
17416
+ params: RequestParams = {},
17417
+ ) =>
17418
+ this.request<
17419
+ BulkLoanFieldOperation,
17420
+ ProblemDetails | UnprocessableEntity
17421
+ >({
17422
+ path: `/api/loan-fields/bulk`,
17423
+ method: "POST",
17424
+ body: data,
17425
+ secure: true,
17426
+ type: "application/json",
17427
+ format: "json",
17428
+ ...params,
17429
+ }),
17430
+
17152
17431
  /**
17153
17432
  * No description
17154
17433
  *
@@ -22656,6 +22935,87 @@ export class Api<
22656
22935
  ...params,
22657
22936
  }),
22658
22937
 
22938
+ /**
22939
+ * @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
22940
+ *
22941
+ * @tags UsersMe
22942
+ * @name GetMyPartners
22943
+ * @summary Get My Partners
22944
+ * @request GET:/api/users/me/partners
22945
+ * @secure
22946
+ * @response `200` `(MyPartner)[]` OK
22947
+ * @response `403` `ProblemDetails` Forbidden
22948
+ */
22949
+ getMyPartners: (params: RequestParams = {}) =>
22950
+ this.request<MyPartner[], ProblemDetails>({
22951
+ path: `/api/users/me/partners`,
22952
+ method: "GET",
22953
+ secure: true,
22954
+ format: "json",
22955
+ ...params,
22956
+ }),
22957
+
22958
+ /**
22959
+ * No description
22960
+ *
22961
+ * @tags UsersMe
22962
+ * @name AddMyPartner
22963
+ * @summary Add My Partner
22964
+ * @request POST:/api/users/me/partners/{partnerId}
22965
+ * @secure
22966
+ * @response `204` `void` No Content
22967
+ * @response `403` `ProblemDetails` Forbidden
22968
+ * @response `404` `ProblemDetails` Not Found
22969
+ */
22970
+ addMyPartner: (partnerId: string, params: RequestParams = {}) =>
22971
+ this.request<void, ProblemDetails>({
22972
+ path: `/api/users/me/partners/${partnerId}`,
22973
+ method: "POST",
22974
+ secure: true,
22975
+ ...params,
22976
+ }),
22977
+
22978
+ /**
22979
+ * No description
22980
+ *
22981
+ * @tags UsersMe
22982
+ * @name RemoveMyPartner
22983
+ * @summary Remove My Partner
22984
+ * @request DELETE:/api/users/me/partners/{partnerId}
22985
+ * @secure
22986
+ * @response `204` `void` No Content
22987
+ * @response `403` `ProblemDetails` Forbidden
22988
+ * @response `404` `ProblemDetails` Not Found
22989
+ */
22990
+ removeMyPartner: (partnerId: string, params: RequestParams = {}) =>
22991
+ this.request<void, ProblemDetails>({
22992
+ path: `/api/users/me/partners/${partnerId}`,
22993
+ method: "DELETE",
22994
+ secure: true,
22995
+ ...params,
22996
+ }),
22997
+
22998
+ /**
22999
+ * @description The links that attribute an application to the partner, on the site of each loan officer the partner works with
23000
+ *
23001
+ * @tags UsersMe
23002
+ * @name GetMyPartnerLinks
23003
+ * @summary Get My Partner Links
23004
+ * @request GET:/api/users/me/partner-links
23005
+ * @secure
23006
+ * @response `200` `PartnerLinks` OK
23007
+ * @response `403` `ProblemDetails` Forbidden
23008
+ * @response `404` `ProblemDetails` Not Found
23009
+ */
23010
+ getMyPartnerLinks: (params: RequestParams = {}) =>
23011
+ this.request<PartnerLinks, ProblemDetails>({
23012
+ path: `/api/users/me/partner-links`,
23013
+ method: "GET",
23014
+ secure: true,
23015
+ format: "json",
23016
+ ...params,
23017
+ }),
23018
+
22659
23019
  /**
22660
23020
  * No description
22661
23021
  *