@matech/thebigpos-sdk 2.42.1 → 2.43.1-rc.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/src/index.ts CHANGED
@@ -486,11 +486,7 @@ export interface AccountBilling {
486
486
 
487
487
  export interface AccountBillingRequest {
488
488
  billingType: AccountBillingRequestBillingTypeEnum;
489
- /**
490
- * @format double
491
- * @min 0
492
- * @exclusiveMin true
493
- */
489
+ /** @format double */
494
490
  contractedRate: number;
495
491
  }
496
492
 
@@ -553,26 +549,13 @@ export interface Address {
553
549
  }
554
550
 
555
551
  export interface AddressRequest {
556
- /**
557
- * @minLength 1
558
- * @maxLength 255
559
- */
560
- street: string;
561
- /** @maxLength 50 */
552
+ street?: string | null;
562
553
  unit?: string | null;
563
- /** @maxLength 50 */
564
554
  unitType?: string | null;
565
- /**
566
- * @minLength 1
567
- * @maxLength 100
568
- */
569
- city: string;
570
- /** @minLength 1 */
571
- state: string;
572
- /** @maxLength 100 */
555
+ city?: string | null;
556
+ state?: string | null;
573
557
  county?: string | null;
574
- /** @minLength 1 */
575
- postalCode: string;
558
+ postalCode?: string | null;
576
559
  }
577
560
 
578
561
  export interface AddressV3 {
@@ -672,72 +655,29 @@ export interface AffordabilityCalculator {
672
655
  }
673
656
 
674
657
  export interface AffordabilityCalculatorRequest {
675
- /**
676
- * @format double
677
- * @min 0
678
- * @max 200000
679
- */
658
+ /** @format double */
680
659
  totalMonthlyIncome: number;
681
- /**
682
- * @format double
683
- * @min 0
684
- */
660
+ /** @format double */
685
661
  totalMonthlyExpenses: number;
686
- /**
687
- * @format double
688
- * @min 0
689
- * @max 95
690
- */
662
+ /** @format double */
691
663
  downPayment: number;
692
- /**
693
- * @format double
694
- * @min 1
695
- * @max 25
696
- */
664
+ /** @format double */
697
665
  interestRate: number;
698
- /**
699
- * @format int32
700
- * @min 1
701
- * @max 40
702
- */
666
+ /** @format int32 */
703
667
  term: number;
704
- /**
705
- * @format double
706
- * @min 0
707
- * @max 10
708
- */
668
+ /** @format double */
709
669
  pmi: number;
710
- /**
711
- * @format double
712
- * @min 5
713
- * @max 60
714
- */
670
+ /** @format double */
715
671
  frontRatio: number;
716
- /**
717
- * @format double
718
- * @min 5
719
- * @max 80
720
- */
672
+ /** @format double */
721
673
  backRatio: number;
722
- /**
723
- * @format double
724
- * @min 0
725
- * @max 200000
726
- */
674
+ /** @format double */
727
675
  annualTaxes: number;
728
- /**
729
- * @format double
730
- * @min 200
731
- * @max 50000
732
- */
676
+ /** @format double */
733
677
  annualInsurance: number;
734
678
  }
735
679
 
736
680
  export interface AllowImpersonationRequest {
737
- /**
738
- * @format email
739
- * @minLength 1
740
- */
741
681
  email: string;
742
682
  }
743
683
 
@@ -891,6 +831,32 @@ export interface AutomatedService {
891
831
  rateLimited: string[];
892
832
  }
893
833
 
834
+ export interface BorrowerCount {
835
+ /** @format uuid */
836
+ userId: string;
837
+ firstName: string;
838
+ lastName: string;
839
+ email: string;
840
+ role: BorrowerCountRoleEnum;
841
+ /** @format int32 */
842
+ count: number;
843
+ }
844
+
845
+ export interface BorrowerIdentity {
846
+ /** @format uuid */
847
+ userId: string;
848
+ firstName: string;
849
+ lastName: string;
850
+ email: string;
851
+ role: BorrowerIdentityRoleEnum;
852
+ }
853
+
854
+ export interface BorrowersNotUsingPosSummary {
855
+ /** @format int32 */
856
+ total: number;
857
+ borrowers: UnregisteredBorrower[];
858
+ }
859
+
894
860
  export interface BranchBase {
895
861
  /** @format date-time */
896
862
  createdAt: string;
@@ -992,10 +958,6 @@ export interface BusinessRuleCondition {
992
958
  }
993
959
 
994
960
  export interface BusinessRuleRequest {
995
- /**
996
- * @minLength 1
997
- * @maxLength 250
998
- */
999
961
  name: string;
1000
962
  description?: string | null;
1001
963
  tasks: TaskUpdateRequest[];
@@ -1004,9 +966,7 @@ export interface BusinessRuleRequest {
1004
966
  }
1005
967
 
1006
968
  export interface ChangePasswordRequest {
1007
- /** @minLength 1 */
1008
969
  oldPassword: string;
1009
- /** @minLength 8 */
1010
970
  newPassword: string;
1011
971
  }
1012
972
 
@@ -1033,15 +993,9 @@ export interface ClosedLoansReportAccount {
1033
993
  }
1034
994
 
1035
995
  export interface ClosedLoansReportRequest {
1036
- /**
1037
- * @format date
1038
- * @minLength 1
1039
- */
996
+ /** @format date */
1040
997
  startDate: string;
1041
- /**
1042
- * @format date
1043
- * @minLength 1
1044
- */
998
+ /** @format date */
1045
999
  endDate: string;
1046
1000
  }
1047
1001
 
@@ -1146,10 +1100,6 @@ export interface CorporatePaginated {
1146
1100
  }
1147
1101
 
1148
1102
  export interface CorporateRequest {
1149
- /**
1150
- * @minLength 1
1151
- * @maxLength 250
1152
- */
1153
1103
  name: string;
1154
1104
  }
1155
1105
 
@@ -1167,9 +1117,7 @@ export interface CreateAccessScopeRequest {
1167
1117
  }
1168
1118
 
1169
1119
  export interface CreateAccountRequest {
1170
- /** @minLength 1 */
1171
1120
  name: string;
1172
- /** @minLength 1 */
1173
1121
  domain: string;
1174
1122
  eConsentBucket?: string | null;
1175
1123
  ignoreCoBorrowerRelationship: boolean;
@@ -1177,10 +1125,7 @@ export interface CreateAccountRequest {
1177
1125
  companyAddress: CompanyAddress;
1178
1126
  contactInfo: ContactInfo;
1179
1127
  theme: Theme;
1180
- /**
1181
- * @format int64
1182
- * @min 0
1183
- */
1128
+ /** @format int64 */
1184
1129
  nlmsid: number;
1185
1130
  settings: AccountSettingsRequest;
1186
1131
  environment: CreateAccountRequestEnvironmentEnum;
@@ -1189,10 +1134,6 @@ export interface CreateAccountRequest {
1189
1134
  }
1190
1135
 
1191
1136
  export interface CreateBranchRequest {
1192
- /**
1193
- * @minLength 1
1194
- * @maxLength 250
1195
- */
1196
1137
  name: string;
1197
1138
  /** @format uuid */
1198
1139
  corporateID: string;
@@ -1201,10 +1142,7 @@ export interface CreateBranchRequest {
1201
1142
 
1202
1143
  export interface CreateCustomFieldDefinitionRequest {
1203
1144
  isRequired: boolean;
1204
- /**
1205
- * @format int32
1206
- * @min 0
1207
- */
1145
+ /** @format int32 */
1208
1146
  displayOrder: number;
1209
1147
  /** @format int32 */
1210
1148
  minLength?: number | null;
@@ -1214,10 +1152,6 @@ export interface CreateCustomFieldDefinitionRequest {
1214
1152
  minValue?: number | null;
1215
1153
  /** @format double */
1216
1154
  maxValue?: number | null;
1217
- /**
1218
- * @minLength 1
1219
- * @maxLength 250
1220
- */
1221
1155
  name: string;
1222
1156
  defaultValue?: string | null;
1223
1157
  regexPattern?: string | null;
@@ -1228,12 +1162,7 @@ export interface CreateCustomFieldDefinitionRequest {
1228
1162
  }
1229
1163
 
1230
1164
  export interface CreateDocumentTemplateRequest {
1231
- /** @minLength 1 */
1232
1165
  htmlBody: string;
1233
- /**
1234
- * @minLength 1
1235
- * @maxLength 255
1236
- */
1237
1166
  name: string;
1238
1167
  type: string;
1239
1168
  description?: string | null;
@@ -1248,11 +1177,8 @@ export interface CreateGroupMemberRequest {
1248
1177
  }
1249
1178
 
1250
1179
  export interface CreateInviteRequest {
1251
- /** @minLength 1 */
1252
1180
  firstName: string;
1253
- /** @minLength 1 */
1254
1181
  lastName: string;
1255
- /** @format email */
1256
1182
  emailAddress: string;
1257
1183
  phoneNumber?: string | null;
1258
1184
  /** @deprecated */
@@ -1267,10 +1193,6 @@ export interface CreateInviteRequest {
1267
1193
  }
1268
1194
 
1269
1195
  export interface CreateLoanDocumentFolderRequest {
1270
- /**
1271
- * @minLength 1
1272
- * @maxLength 250
1273
- */
1274
1196
  name: string;
1275
1197
  permissions: LoanDocumentFolderPermissionRequest[];
1276
1198
  }
@@ -1278,15 +1200,9 @@ export interface CreateLoanDocumentFolderRequest {
1278
1200
  export interface CreateLoanImportRequest {
1279
1201
  /** @format uuid */
1280
1202
  accountID: string;
1281
- /**
1282
- * @format date-time
1283
- * @minLength 1
1284
- */
1203
+ /** @format date-time */
1285
1204
  endDate: string;
1286
- /**
1287
- * @format date-time
1288
- * @minLength 1
1289
- */
1205
+ /** @format date-time */
1290
1206
  startDate: string;
1291
1207
  importMode: CreateLoanImportRequestImportModeEnum;
1292
1208
  }
@@ -1314,12 +1230,7 @@ export interface CreateUserDraft {
1314
1230
  }
1315
1231
 
1316
1232
  export interface CreateUserGroupRequest {
1317
- /**
1318
- * @minLength 1
1319
- * @maxLength 200
1320
- */
1321
1233
  name: string;
1322
- /** @maxLength 1000 */
1323
1234
  description?: string | null;
1324
1235
  }
1325
1236
 
@@ -1328,41 +1239,21 @@ export interface CreateUserLoan {
1328
1239
  }
1329
1240
 
1330
1241
  export interface CreateUserRelationRequest {
1331
- /**
1332
- * @format uuid
1333
- * @minLength 1
1334
- */
1242
+ /** @format uuid */
1335
1243
  userId1: string;
1336
- /**
1337
- * @format uuid
1338
- * @minLength 1
1339
- */
1244
+ /** @format uuid */
1340
1245
  userId2: string;
1341
- /** @minLength 1 */
1342
1246
  relationType: string;
1343
1247
  }
1344
1248
 
1345
1249
  export interface CreateUserRequest {
1346
- /**
1347
- * @format email
1348
- * @minLength 1
1349
- */
1350
1250
  email: string;
1351
1251
  phone?: string | null;
1352
- /**
1353
- * @minLength 1
1354
- * @maxLength 255
1355
- */
1356
1252
  firstName: string;
1357
- /**
1358
- * @minLength 1
1359
- * @maxLength 255
1360
- */
1361
1253
  lastName: string;
1362
1254
  title?: string | null;
1363
1255
  /** @format uuid */
1364
1256
  branchId?: string | null;
1365
- /** @minLength 1 */
1366
1257
  userRole: string;
1367
1258
  isInternal?: boolean | null;
1368
1259
  }
@@ -1371,6 +1262,12 @@ export interface CreateWebhookRequest {
1371
1262
  webhookPath: string;
1372
1263
  }
1373
1264
 
1265
+ export interface CreditAuthPendingSummary {
1266
+ /** @format int32 */
1267
+ total: number;
1268
+ borrowers: BorrowerIdentity[];
1269
+ }
1270
+
1374
1271
  export interface CustomFieldDefinition {
1375
1272
  /** @format date-time */
1376
1273
  createdAt: string;
@@ -1682,17 +1579,14 @@ export interface DocumentTemplateVersionBase {
1682
1579
  }
1683
1580
 
1684
1581
  export interface DocumentTemplateVersionRequest {
1685
- /** @maxLength 255 */
1686
1582
  name?: string | null;
1687
1583
  isActive: boolean;
1688
1584
  htmlBody: string;
1689
1585
  }
1690
1586
 
1691
1587
  export interface DocumentTemplateVersionUpdateRequest {
1692
- /** @maxLength 255 */
1693
- name: string;
1588
+ name?: string | null;
1694
1589
  isActive: boolean;
1695
- /** @minLength 1 */
1696
1590
  htmlBody: string;
1697
1591
  }
1698
1592
 
@@ -1753,6 +1647,12 @@ export interface DraftRequest {
1753
1647
  isCoBorrower: boolean;
1754
1648
  }
1755
1649
 
1650
+ export interface EconsentPendingSummary {
1651
+ /** @format int32 */
1652
+ total: number;
1653
+ borrowers: BorrowerIdentity[];
1654
+ }
1655
+
1756
1656
  export interface EnabledServices {
1757
1657
  /** @format date-time */
1758
1658
  createdAt: string;
@@ -2007,10 +1907,6 @@ export interface FilePaginated {
2007
1907
  }
2008
1908
 
2009
1909
  export interface FileRequest {
2010
- /**
2011
- * @minLength 1
2012
- * @maxLength 250
2013
- */
2014
1910
  name: string;
2015
1911
  }
2016
1912
 
@@ -2176,14 +2072,12 @@ export interface FormVersion {
2176
2072
  }
2177
2073
 
2178
2074
  export interface FormVersionRequest {
2179
- /** @maxLength 255 */
2180
2075
  name?: string | null;
2181
2076
  isActive: boolean;
2182
2077
  formJSON: any;
2183
2078
  }
2184
2079
 
2185
2080
  export interface FormVersionUpdateRequest {
2186
- /** @maxLength 255 */
2187
2081
  name?: string | null;
2188
2082
  isActive: boolean;
2189
2083
  formJSON: any;
@@ -2204,10 +2098,7 @@ export interface FusionReportFilter {
2204
2098
  export interface GenerateDocumentRequest {
2205
2099
  /** @deprecated */
2206
2100
  loanID?: string | null;
2207
- /**
2208
- * @format uuid
2209
- * @minLength 1
2210
- */
2101
+ /** @format uuid */
2211
2102
  templateID: string;
2212
2103
  /**
2213
2104
  * @deprecated
@@ -2290,10 +2181,7 @@ export interface GetSiteConfigurationRequest {
2290
2181
  }
2291
2182
 
2292
2183
  export interface GetSiteFormRequest {
2293
- /**
2294
- * @format uuid
2295
- * @minLength 1
2296
- */
2184
+ /** @format uuid */
2297
2185
  siteConfigurationId: string;
2298
2186
  /** @format int32 */
2299
2187
  formType: number;
@@ -2301,15 +2189,10 @@ export interface GetSiteFormRequest {
2301
2189
  }
2302
2190
 
2303
2191
  export interface GetUserByEmailRequest {
2304
- /**
2305
- * @format email
2306
- * @minLength 1
2307
- */
2308
2192
  email: string;
2309
2193
  }
2310
2194
 
2311
2195
  export interface GetWorkflowRequest {
2312
- /** @minLength 1 */
2313
2196
  formType: string;
2314
2197
  borrowerType?: string | null;
2315
2198
  userRole?: string | null;
@@ -2372,15 +2255,9 @@ export interface ImpersonatedDetailedUser {
2372
2255
  }
2373
2256
 
2374
2257
  export interface ImportUserLoanTaskRequest {
2375
- /**
2376
- * @format uuid
2377
- * @minLength 1
2378
- */
2258
+ /** @format uuid */
2379
2259
  taskID: string;
2380
- /**
2381
- * @format uuid
2382
- * @minLength 1
2383
- */
2260
+ /** @format uuid */
2384
2261
  userID: string;
2385
2262
  }
2386
2263
 
@@ -2507,16 +2384,9 @@ export interface ListingRequest {
2507
2384
  description?: string | null;
2508
2385
  mlsNumber?: string | null;
2509
2386
  address: AddressRequest;
2510
- /**
2511
- * @format int32
2512
- * @min 0
2513
- * @exclusiveMin true
2514
- */
2387
+ /** @format int32 */
2515
2388
  salePrice?: number | null;
2516
- /**
2517
- * @format date-time
2518
- * @minLength 1
2519
- */
2389
+ /** @format date-time */
2520
2390
  activeDate: string;
2521
2391
  /** @format date-time */
2522
2392
  expirationDate?: string | null;
@@ -2630,7 +2500,6 @@ export interface LoanApplicationRequest {
2630
2500
  companyName?: string | null;
2631
2501
  property?: LoanPropertyRequest | null;
2632
2502
  financial?: LoanFinancialRequest | null;
2633
- /** @minItems 1 */
2634
2503
  borrowers: LoanBorrowerRequest[];
2635
2504
  nonOwningBorrowers: LoanNonOwningBorrowerRequest[];
2636
2505
  /** @format uuid */
@@ -2693,12 +2562,8 @@ export interface LoanBorrowerAccountAsset {
2693
2562
  }
2694
2563
 
2695
2564
  export interface LoanBorrowerAccountAssetRequest {
2696
- /** @maxLength 255 */
2697
2565
  financialInstitution?: string | null;
2698
- /**
2699
- * @format double
2700
- * @min 0
2701
- */
2566
+ /** @format double */
2702
2567
  value?: number | null;
2703
2568
  type?: LoanAccountAssetType | null;
2704
2569
  }
@@ -2722,23 +2587,15 @@ export interface LoanBorrowerAddress {
2722
2587
  }
2723
2588
 
2724
2589
  export interface LoanBorrowerAddressRequest {
2725
- /** @maxLength 255 */
2726
2590
  street?: string | null;
2727
- /** @maxLength 50 */
2728
2591
  unit?: string | null;
2729
- /** @maxLength 50 */
2730
2592
  unitType?: string | null;
2731
- /** @maxLength 100 */
2732
2593
  city?: string | null;
2733
2594
  state?: string | null;
2734
- /** @maxLength 100 */
2735
2595
  county?: string | null;
2736
2596
  postalCode?: string | null;
2737
2597
  housing?: LoanHousingType | null;
2738
- /**
2739
- * @format double
2740
- * @min 0
2741
- */
2598
+ /** @format double */
2742
2599
  rentAmount?: number | null;
2743
2600
  isCurrent?: boolean | null;
2744
2601
  isMailingAddress?: boolean | null;
@@ -2755,13 +2612,9 @@ export interface LoanBorrowerAlternateName {
2755
2612
  }
2756
2613
 
2757
2614
  export interface LoanBorrowerAlternateNameRequest {
2758
- /** @maxLength 20 */
2759
2615
  suffix?: string | null;
2760
- /** @maxLength 100 */
2761
2616
  lastName?: string | null;
2762
- /** @maxLength 100 */
2763
2617
  firstName?: string | null;
2764
- /** @maxLength 100 */
2765
2618
  middleName?: string | null;
2766
2619
  }
2767
2620
 
@@ -2782,7 +2635,6 @@ export interface LoanBorrowerBankruptcyDeclaration {
2782
2635
 
2783
2636
  export interface LoanBorrowerBankruptcyDeclarationRequest {
2784
2637
  isAffirmative?: boolean | null;
2785
- /** @maxLength 1000 */
2786
2638
  description?: string | null;
2787
2639
  chapters?: LoanBorrowerBankruptcyChaptersRequest | null;
2788
2640
  types?: LoanBankruptcyType[] | null;
@@ -2859,7 +2711,6 @@ export interface LoanBorrowerDemographicsEthnicity {
2859
2711
  export interface LoanBorrowerDemographicsEthnicityRequest {
2860
2712
  OptOut?: boolean | null;
2861
2713
  Hispanic?: boolean | null;
2862
- /** @maxLength 255 */
2863
2714
  OtherHispanic?: string | null;
2864
2715
  Mexican?: boolean | null;
2865
2716
  PuertoRican?: boolean | null;
@@ -2900,7 +2751,6 @@ export interface LoanBorrowerDemographicsRace {
2900
2751
 
2901
2752
  export interface LoanBorrowerDemographicsRaceRequest {
2902
2753
  AmericanIndian?: boolean | null;
2903
- /** @maxLength 255 */
2904
2754
  TribeName?: string | null;
2905
2755
  Asian?: boolean | null;
2906
2756
  AsianIndian?: boolean | null;
@@ -2909,14 +2759,12 @@ export interface LoanBorrowerDemographicsRaceRequest {
2909
2759
  Japanese?: boolean | null;
2910
2760
  Korean?: boolean | null;
2911
2761
  Vietnamese?: boolean | null;
2912
- /** @maxLength 255 */
2913
2762
  OtherAsian?: string | null;
2914
2763
  Black?: boolean | null;
2915
2764
  NativeIslander?: boolean | null;
2916
2765
  NativeHawaiian?: boolean | null;
2917
2766
  Guamanian?: boolean | null;
2918
2767
  Samoan?: boolean | null;
2919
- /** @maxLength 255 */
2920
2768
  OtherNativeIslander?: string | null;
2921
2769
  White?: boolean | null;
2922
2770
  OptOut?: boolean | null;
@@ -2964,10 +2812,7 @@ export interface LoanBorrowerEmploymentCurrentGrossIncome {
2964
2812
  }
2965
2813
 
2966
2814
  export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
2967
- /**
2968
- * @format double
2969
- * @min 0
2970
- */
2815
+ /** @format double */
2971
2816
  base?: number | null;
2972
2817
  /** @format double */
2973
2818
  hourlyRate?: number | null;
@@ -2975,30 +2820,15 @@ export interface LoanBorrowerEmploymentCurrentGrossIncomeRequest {
2975
2820
  hoursPerWeek?: number | null;
2976
2821
  /** @format double */
2977
2822
  distributions?: number | null;
2978
- /**
2979
- * @format double
2980
- * @min 0
2981
- */
2823
+ /** @format double */
2982
2824
  other?: number | null;
2983
- /**
2984
- * @format double
2985
- * @min 0
2986
- */
2825
+ /** @format double */
2987
2826
  bonus?: number | null;
2988
- /**
2989
- * @format double
2990
- * @min 0
2991
- */
2827
+ /** @format double */
2992
2828
  overtime?: number | null;
2993
- /**
2994
- * @format double
2995
- * @min 0
2996
- */
2829
+ /** @format double */
2997
2830
  commission?: number | null;
2998
- /**
2999
- * @format double
3000
- * @min 0
3001
- */
2831
+ /** @format double */
3002
2832
  militaryEntitlements?: number | null;
3003
2833
  }
3004
2834
 
@@ -3014,17 +2844,12 @@ export interface LoanBorrowerEmploymentCurrentOwnership {
3014
2844
  export interface LoanBorrowerEmploymentCurrentOwnershipRequest {
3015
2845
  isOwner?: boolean | null;
3016
2846
  hasOwnershipOver25Percent?: boolean | null;
3017
- /**
3018
- * @format double
3019
- * @min 0
3020
- */
2847
+ /** @format double */
3021
2848
  monthlyIncome?: number | null;
3022
2849
  }
3023
2850
 
3024
2851
  export interface LoanBorrowerEmploymentCurrentRequest {
3025
- /** @maxLength 255 */
3026
2852
  name?: string | null;
3027
- /** @maxLength 100 */
3028
2853
  title?: string | null;
3029
2854
  phoneNumber?: string | null;
3030
2855
  /** @format date */
@@ -3070,19 +2895,14 @@ export interface LoanBorrowerEmploymentPrevious {
3070
2895
  }
3071
2896
 
3072
2897
  export interface LoanBorrowerEmploymentPreviousRequest {
3073
- /** @maxLength 255 */
3074
2898
  name?: string | null;
3075
- /** @maxLength 100 */
3076
2899
  title?: string | null;
3077
2900
  phoneNumber?: string | null;
3078
2901
  /** @format date */
3079
2902
  startDate?: string | null;
3080
2903
  /** @format date */
3081
2904
  endDate?: string | null;
3082
- /**
3083
- * @format double
3084
- * @min 0
3085
- */
2905
+ /** @format double */
3086
2906
  grossIncome?: number | null;
3087
2907
  isSelfEmployed?: boolean | null;
3088
2908
  address?: AddressRequest | null;
@@ -3099,10 +2919,7 @@ export interface LoanBorrowerGift {
3099
2919
  }
3100
2920
 
3101
2921
  export interface LoanBorrowerGiftRequest {
3102
- /**
3103
- * @format double
3104
- * @min 0
3105
- */
2922
+ /** @format double */
3106
2923
  value?: number | null;
3107
2924
  isDeposited?: boolean | null;
3108
2925
  source?: LoanGiftSource | null;
@@ -3128,7 +2945,6 @@ export interface LoanBorrowerHomeOwnershipProvider {
3128
2945
  }
3129
2946
 
3130
2947
  export interface LoanBorrowerHomeOwnershipProviderRequest {
3131
- /** @maxLength 255 */
3132
2948
  name?: string | null;
3133
2949
  phoneNumber?: string | null;
3134
2950
  address?: AddressRequest | null;
@@ -3160,26 +2976,14 @@ export interface LoanBorrowerLiability {
3160
2976
 
3161
2977
  export interface LoanBorrowerLiabilityRequest {
3162
2978
  type?: LoanLiabilityType | null;
3163
- /** @maxLength 255 */
3164
2979
  name?: string | null;
3165
- /** @maxLength 50 */
3166
2980
  accountNumber?: string | null;
3167
- /** @maxLength 255 */
3168
2981
  financialInstitution?: string | null;
3169
- /**
3170
- * @format double
3171
- * @min 0
3172
- */
2982
+ /** @format double */
3173
2983
  balance?: number | null;
3174
- /**
3175
- * @format double
3176
- * @min 0
3177
- */
2984
+ /** @format double */
3178
2985
  monthlyPayment?: number | null;
3179
- /**
3180
- * @format int32
3181
- * @min 0
3182
- */
2986
+ /** @format int32 */
3183
2987
  monthsLeftToPay?: number | null;
3184
2988
  isPaidOffBeforeClosing?: boolean | null;
3185
2989
  }
@@ -3211,12 +3015,8 @@ export interface LoanBorrowerMoneyDeclaration {
3211
3015
 
3212
3016
  export interface LoanBorrowerMoneyDeclarationRequest {
3213
3017
  isAffirmative?: boolean | null;
3214
- /** @maxLength 1000 */
3215
3018
  description?: string | null;
3216
- /**
3217
- * @format double
3218
- * @min 0
3219
- */
3019
+ /** @format double */
3220
3020
  amount?: number | null;
3221
3021
  }
3222
3022
 
@@ -3231,12 +3031,8 @@ export interface LoanBorrowerOtherAsset {
3231
3031
 
3232
3032
  export interface LoanBorrowerOtherAssetRequest {
3233
3033
  type?: LoanOtherAssetType | null;
3234
- /** @maxLength 255 */
3235
3034
  other?: string | null;
3236
- /**
3237
- * @format double
3238
- * @min 0
3239
- */
3035
+ /** @format double */
3240
3036
  value?: number | null;
3241
3037
  }
3242
3038
 
@@ -3249,10 +3045,7 @@ export interface LoanBorrowerOtherIncome {
3249
3045
  }
3250
3046
 
3251
3047
  export interface LoanBorrowerOtherIncomeRequest {
3252
- /**
3253
- * @format double
3254
- * @min 0
3255
- */
3048
+ /** @format double */
3256
3049
  value?: number | null;
3257
3050
  type?: LoanOtherIncomeType | null;
3258
3051
  }
@@ -3266,10 +3059,7 @@ export interface LoanBorrowerOtherLiability {
3266
3059
  }
3267
3060
 
3268
3061
  export interface LoanBorrowerOtherLiabilityRequest {
3269
- /**
3270
- * @format double
3271
- * @min 0
3272
- */
3062
+ /** @format double */
3273
3063
  monthlyPayment?: number | null;
3274
3064
  type?: LoanOtherLiabilityType | null;
3275
3065
  }
@@ -3283,7 +3073,6 @@ export interface LoanBorrowerPhoneNumber {
3283
3073
  }
3284
3074
 
3285
3075
  export interface LoanBorrowerPhoneNumberRequest {
3286
- /** @maxLength 10 */
3287
3076
  ext?: string | null;
3288
3077
  number?: string | null;
3289
3078
  type?: LoanPhoneNumberType | null;
@@ -3301,7 +3090,6 @@ export interface LoanBorrowerPrimaryResidenceDeclaration {
3301
3090
 
3302
3091
  export interface LoanBorrowerPrimaryResidenceDeclarationRequest {
3303
3092
  isAffirmative?: boolean | null;
3304
- /** @maxLength 1000 */
3305
3093
  description?: string | null;
3306
3094
  hasInterestInLastThreeYears?: boolean | null;
3307
3095
  titleHeld?: LoanTitleHeld | null;
@@ -3339,24 +3127,13 @@ export interface LoanBorrowerRealEstateAssetMortgage {
3339
3127
  }
3340
3128
 
3341
3129
  export interface LoanBorrowerRealEstateAssetMortgageRequest {
3342
- /** @maxLength 255 */
3343
3130
  creditor?: string | null;
3344
- /** @maxLength 50 */
3345
3131
  accountNumber?: string | null;
3346
- /**
3347
- * @format double
3348
- * @min 0
3349
- */
3132
+ /** @format double */
3350
3133
  balance?: number | null;
3351
- /**
3352
- * @format double
3353
- * @min 0
3354
- */
3134
+ /** @format double */
3355
3135
  creditLimit?: number | null;
3356
- /**
3357
- * @format double
3358
- * @min 0
3359
- */
3136
+ /** @format double */
3360
3137
  monthlyMortgagePayment?: number | null;
3361
3138
  isBalancePaidBeforeClosing?: boolean | null;
3362
3139
  loanType?: LoanType | null;
@@ -3365,10 +3142,7 @@ export interface LoanBorrowerRealEstateAssetMortgageRequest {
3365
3142
  export interface LoanBorrowerRealEstateAssetRequest {
3366
3143
  status?: LoanRealEstateStatus | null;
3367
3144
  occupancy?: LoanOccupancyType | null;
3368
- /**
3369
- * @format double
3370
- * @min 0
3371
- */
3145
+ /** @format double */
3372
3146
  marketValue?: number | null;
3373
3147
  /** @format double */
3374
3148
  purchasePrice?: number | null;
@@ -3376,15 +3150,9 @@ export interface LoanBorrowerRealEstateAssetRequest {
3376
3150
  yearBuilt?: number | null;
3377
3151
  /** @format int32 */
3378
3152
  numberOfUnits?: number | null;
3379
- /**
3380
- * @format double
3381
- * @min 0
3382
- */
3153
+ /** @format double */
3383
3154
  monthlyRentalIncome?: number | null;
3384
- /**
3385
- * @format double
3386
- * @min 0
3387
- */
3155
+ /** @format double */
3388
3156
  maintenanceExpense?: number | null;
3389
3157
  address?: AddressRequest | null;
3390
3158
  mortgages?: LoanBorrowerRealEstateAssetMortgageRequest[] | null;
@@ -3393,11 +3161,8 @@ export interface LoanBorrowerRealEstateAssetRequest {
3393
3161
  export interface LoanBorrowerRequest {
3394
3162
  ssn?: string | null;
3395
3163
  email?: string | null;
3396
- /** @maxLength 100 */
3397
3164
  lastName?: string | null;
3398
- /** @maxLength 100 */
3399
3165
  firstName?: string | null;
3400
- /** @maxLength 100 */
3401
3166
  middleName?: string | null;
3402
3167
  prefix?: LoanNamePrefix | null;
3403
3168
  suffix?: LoanNameSuffix | null;
@@ -3440,7 +3205,6 @@ export interface LoanBorrowerSimpleDeclaration {
3440
3205
 
3441
3206
  export interface LoanBorrowerSimpleDeclarationRequest {
3442
3207
  isAffirmative?: boolean | null;
3443
- /** @maxLength 1000 */
3444
3208
  description?: string | null;
3445
3209
  }
3446
3210
 
@@ -3471,63 +3235,31 @@ export interface LoanComparisonCalculatorLoan {
3471
3235
  }
3472
3236
 
3473
3237
  export interface LoanComparisonCalculatorLoanRequest {
3474
- /**
3475
- * @format double
3476
- * @min 1
3477
- * @max 25
3478
- */
3238
+ /** @format double */
3479
3239
  interestRate: number;
3480
- /**
3481
- * @format int32
3482
- * @min 1
3483
- * @max 40
3484
- */
3240
+ /** @format int32 */
3485
3241
  term: number;
3486
- /**
3487
- * @format double
3488
- * @min 0
3489
- * @max 3
3490
- */
3242
+ /** @format double */
3491
3243
  points: number;
3492
- /**
3493
- * @format double
3494
- * @min 0
3495
- * @max 5
3496
- */
3244
+ /** @format double */
3497
3245
  originationFees: number;
3498
- /**
3499
- * @format double
3500
- * @min 500
3501
- * @max 100000
3502
- */
3246
+ /** @format double */
3503
3247
  closingCosts: number;
3504
- /**
3505
- * @format double
3506
- * @min 25000
3507
- * @max 10000000
3508
- */
3248
+ /** @format double */
3509
3249
  homeValue: number;
3510
- /**
3511
- * @format double
3512
- * @min 0
3513
- * @max 10
3514
- */
3250
+ /** @format double */
3515
3251
  pmi: number;
3516
3252
  }
3517
3253
 
3518
3254
  export interface LoanComparisonCalculatorRequest {
3519
- /**
3520
- * @format double
3521
- * @min 30000
3522
- */
3255
+ /** @format double */
3523
3256
  loanAmount: number;
3524
3257
  loans: LoanComparisonCalculatorLoanRequest[];
3525
3258
  }
3526
3259
 
3527
3260
  export interface LoanComparisonScenario {
3528
3261
  loanProgram?: string | null;
3529
- /** @minLength 1 */
3530
- loanType: string;
3262
+ loanType?: string | null;
3531
3263
  propertyValue?: string | null;
3532
3264
  purchasePrice?: string | null;
3533
3265
  downpaymentAmount?: string | null;
@@ -3557,7 +3289,6 @@ export interface LoanComparisonScenario {
3557
3289
  }
3558
3290
 
3559
3291
  export interface LoanConsentRequest {
3560
- /** @format email */
3561
3292
  borrowerEmail?: string | null;
3562
3293
  borrowerEConsent?: boolean | null;
3563
3294
  borrowerCreditAuth?: boolean | null;
@@ -3717,20 +3448,11 @@ export interface LoanFinancial {
3717
3448
 
3718
3449
  export interface LoanFinancialRequest {
3719
3450
  isDebtsAssetsReviewed?: boolean | null;
3720
- /**
3721
- * @format double
3722
- * @min 0
3723
- */
3451
+ /** @format double */
3724
3452
  cashToClose?: number | null;
3725
- /**
3726
- * @format double
3727
- * @min 0
3728
- */
3453
+ /** @format double */
3729
3454
  cashDownPayment?: number | null;
3730
- /**
3731
- * @format double
3732
- * @min 0
3733
- */
3455
+ /** @format double */
3734
3456
  maximumPurchasePrice?: number | null;
3735
3457
  isDownPaymentGift?: boolean | null;
3736
3458
  /** @format double */
@@ -3872,11 +3594,8 @@ export interface LoanNonOwningBorrower {
3872
3594
 
3873
3595
  export interface LoanNonOwningBorrowerRequest {
3874
3596
  email?: string | null;
3875
- /** @maxLength 100 */
3876
3597
  lastName?: string | null;
3877
- /** @maxLength 100 */
3878
3598
  firstName?: string | null;
3879
- /** @maxLength 100 */
3880
3599
  middleName?: string | null;
3881
3600
  prefix?: LoanNamePrefix | null;
3882
3601
  suffix?: LoanNameSuffix | null;
@@ -3920,6 +3639,12 @@ export interface LoanOfficerSearchCriteria {
3920
3639
  export interface LoanOutstandingItems {
3921
3640
  /** @format int32 */
3922
3641
  pendingSignaturePackages: number;
3642
+ pendingTasks: PendingTasksSummary;
3643
+ pendingSignatures: PendingSignaturesSummary;
3644
+ pendingInvites: PendingInvitesSummary;
3645
+ creditAuthPending: CreditAuthPendingSummary;
3646
+ econsentPending: EconsentPendingSummary;
3647
+ borrowersNotUsingPos: BorrowersNotUsingPosSummary;
3923
3648
  }
3924
3649
 
3925
3650
  export interface LoanPatchRequestGuidPatchDocument {
@@ -3970,22 +3695,12 @@ export interface LoanPropertyMortgage {
3970
3695
  }
3971
3696
 
3972
3697
  export interface LoanPropertyMortgageRequest {
3973
- /** @maxLength 255 */
3974
3698
  creditor?: string | null;
3975
- /**
3976
- * @format double
3977
- * @min 0
3978
- */
3699
+ /** @format double */
3979
3700
  loanAmount?: number | null;
3980
- /**
3981
- * @format double
3982
- * @min 0
3983
- */
3701
+ /** @format double */
3984
3702
  creditLimit?: number | null;
3985
- /**
3986
- * @format double
3987
- * @min 0
3988
- */
3703
+ /** @format double */
3989
3704
  monthlyPayment?: number | null;
3990
3705
  lienType?: LoanLienPosition | null;
3991
3706
  }
@@ -3994,46 +3709,22 @@ export interface LoanPropertyRequest {
3994
3709
  trustType?: LoanTrustType | null;
3995
3710
  occupancy?: LoanOccupancyType | null;
3996
3711
  propertyType?: LoanPropertyType | null;
3997
- /** @maxLength 100 */
3998
3712
  referenceId?: string | null;
3999
- /**
4000
- * @format int32
4001
- * @min 1800
4002
- * @max 2036
4003
- */
3713
+ /** @format int32 */
4004
3714
  yearBuilt?: number | null;
4005
- /**
4006
- * @format int32
4007
- * @min 1900
4008
- * @max 2036
4009
- */
3715
+ /** @format int32 */
4010
3716
  yearAcquired?: number | null;
4011
3717
  /** @format int32 */
4012
3718
  numberOfUnits?: number | null;
4013
- /**
4014
- * @format double
4015
- * @min 0
4016
- */
3719
+ /** @format double */
4017
3720
  salePrice?: number | null;
4018
- /**
4019
- * @format double
4020
- * @min 0
4021
- */
3721
+ /** @format double */
4022
3722
  propertyValue?: number | null;
4023
- /**
4024
- * @format double
4025
- * @min 0
4026
- */
3723
+ /** @format double */
4027
3724
  purchasePrice?: number | null;
4028
- /**
4029
- * @format double
4030
- * @min 0
4031
- */
3725
+ /** @format double */
4032
3726
  estimatedValue?: number | null;
4033
- /**
4034
- * @format double
4035
- * @min 0
4036
- */
3727
+ /** @format double */
4037
3728
  monthlyRentalIncome?: number | null;
4038
3729
  isMixedUseProperty?: boolean | null;
4039
3730
  isManufacturedHome?: boolean | null;
@@ -4161,7 +3852,7 @@ export interface LosCredentials {
4161
3852
  export interface LosLoanCreationRequest {
4162
3853
  loanOfficerUserName?: string | null;
4163
3854
  loanTemplate?: string | null;
4164
- additionalFields: Record<string, string | null>;
3855
+ additionalFields: Record<string, string>;
4165
3856
  folder?: string | null;
4166
3857
  /** @format int32 */
4167
3858
  borrowerPair: number;
@@ -4289,18 +3980,11 @@ export interface MilestoneConfiguration {
4289
3980
  }
4290
3981
 
4291
3982
  export interface MilestoneConfigurationRequest {
4292
- /** @minLength 1 */
4293
3983
  name: string;
4294
3984
  description?: string | null;
4295
- /** @minLength 1 */
4296
3985
  fieldID: string;
4297
- /**
4298
- * @format int32
4299
- * @min -1000
4300
- * @max 1000
4301
- */
3986
+ /** @format int32 */
4302
3987
  weight?: number | null;
4303
- /** @minLength 1 */
4304
3988
  loanType: string;
4305
3989
  notificationsEnabled: boolean;
4306
3990
  }
@@ -4319,12 +4003,9 @@ export interface MobileAppReviewSeed {
4319
4003
  borrowerID: string;
4320
4004
  borrowerCompleted: boolean;
4321
4005
  }
4322
-
4323
- export interface MobileAppReviewSeedRequest {
4324
- /**
4325
- * @format uuid
4326
- * @minLength 1
4327
- */
4006
+
4007
+ export interface MobileAppReviewSeedRequest {
4008
+ /** @format uuid */
4328
4009
  accountID: string;
4329
4010
  /** @format uuid */
4330
4011
  branchID?: string | null;
@@ -4377,46 +4058,19 @@ export interface MonthlyPaymentCalculator {
4377
4058
  }
4378
4059
 
4379
4060
  export interface MonthlyPaymentCalculatorRequest {
4380
- /**
4381
- * @format double
4382
- * @min 30000
4383
- */
4061
+ /** @format double */
4384
4062
  loanAmount: number;
4385
- /**
4386
- * @format double
4387
- * @min 25000
4388
- * @max 10000000
4389
- */
4063
+ /** @format double */
4390
4064
  homeValue: number;
4391
- /**
4392
- * @format double
4393
- * @min 0
4394
- * @max 10
4395
- */
4065
+ /** @format double */
4396
4066
  pmi: number;
4397
- /**
4398
- * @format double
4399
- * @min 0
4400
- * @max 200000
4401
- */
4067
+ /** @format double */
4402
4068
  annualTaxes: number;
4403
- /**
4404
- * @format double
4405
- * @min 200
4406
- * @max 50000
4407
- */
4069
+ /** @format double */
4408
4070
  annualInsurance: number;
4409
- /**
4410
- * @format double
4411
- * @min 1
4412
- * @max 25
4413
- */
4071
+ /** @format double */
4414
4072
  interestRate: number;
4415
- /**
4416
- * @format int32
4417
- * @min 1
4418
- * @max 40
4419
- */
4073
+ /** @format int32 */
4420
4074
  term: number;
4421
4075
  }
4422
4076
 
@@ -4488,15 +4142,11 @@ export interface NotificationTemplateBasePaginated {
4488
4142
  }
4489
4143
 
4490
4144
  export interface NotificationTemplateRequest {
4491
- /** @minLength 1 */
4492
4145
  htmlBody: string;
4493
- /** @minLength 1 */
4494
4146
  key: string;
4495
- /** @minLength 1 */
4496
4147
  name: string;
4497
4148
  plainBody: string;
4498
4149
  description?: string | null;
4499
- /** @minLength 1 */
4500
4150
  subject: string;
4501
4151
  textEnabled: boolean;
4502
4152
  pushNotificationEnabled: boolean;
@@ -4554,7 +4204,6 @@ export interface NotificationTemplateVersionBase {
4554
4204
  }
4555
4205
 
4556
4206
  export interface NotificationTemplateVersionRequest {
4557
- /** @maxLength 255 */
4558
4207
  name?: string | null;
4559
4208
  isActive: boolean;
4560
4209
  htmlBody: string;
@@ -4564,15 +4213,9 @@ export interface NotificationTemplateVersionRequest {
4564
4213
  }
4565
4214
 
4566
4215
  export interface NotificationTemplateVersionUpdateRequest {
4567
- /**
4568
- * @minLength 1
4569
- * @maxLength 255
4570
- */
4571
- name: string;
4216
+ name?: string | null;
4572
4217
  isActive: boolean;
4573
- /** @minLength 1 */
4574
4218
  htmlBody: string;
4575
- /** @minLength 1 */
4576
4219
  plainBody: string;
4577
4220
  textBody?: string | null;
4578
4221
  pushNotificationBody?: string | null;
@@ -4585,7 +4228,6 @@ export interface Operation {
4585
4228
  }
4586
4229
 
4587
4230
  export interface OverridePasswordRequest {
4588
- /** @minLength 8 */
4589
4231
  password: string;
4590
4232
  }
4591
4233
 
@@ -4603,11 +4245,39 @@ export interface PartnerSearchCriteria {
4603
4245
  roles?: UserRole[] | null;
4604
4246
  }
4605
4247
 
4248
+ export interface PendingInvite {
4249
+ /** @format uuid */
4250
+ inviteId: string;
4251
+ firstName: string;
4252
+ lastName: string;
4253
+ email: string;
4254
+ phoneNumber?: string | null;
4255
+ role?: LoanRole | null;
4256
+ /** @format date-time */
4257
+ createdAt: string;
4258
+ url: string;
4259
+ }
4260
+
4261
+ export interface PendingInvitesSummary {
4262
+ /** @format int32 */
4263
+ total: number;
4264
+ invites: PendingInvite[];
4265
+ }
4266
+
4267
+ export interface PendingSignaturesSummary {
4268
+ /** @format int32 */
4269
+ total: number;
4270
+ borrowers: BorrowerCount[];
4271
+ }
4272
+
4273
+ export interface PendingTasksSummary {
4274
+ /** @format int32 */
4275
+ total: number;
4276
+ borrowers: BorrowerCount[];
4277
+ }
4278
+
4606
4279
  export interface PostLoanComparisonPdfRequest {
4607
- /**
4608
- * @format uuid
4609
- * @minLength 1
4610
- */
4280
+ /** @format uuid */
4611
4281
  siteConfigurationID: string;
4612
4282
  }
4613
4283
 
@@ -4690,11 +4360,7 @@ export interface RefinanceCalculator {
4690
4360
  }
4691
4361
 
4692
4362
  export interface RefinanceCalculatorRequest {
4693
- /**
4694
- * @format double
4695
- * @min 25000
4696
- * @max 10000000
4697
- */
4363
+ /** @format double */
4698
4364
  homeValue: number;
4699
4365
  currentLoan: RefinanceCurrentLoanRequest;
4700
4366
  refinanceLoan: RefinanceRefinanceLoanRequest;
@@ -4702,34 +4368,15 @@ export interface RefinanceCalculatorRequest {
4702
4368
  }
4703
4369
 
4704
4370
  export interface RefinanceCurrentLoanRequest {
4705
- /**
4706
- * @format double
4707
- * @min 1
4708
- * @max 25
4709
- */
4371
+ /** @format double */
4710
4372
  interestRate: number;
4711
- /**
4712
- * @format int32
4713
- * @min 1
4714
- * @max 40
4715
- */
4373
+ /** @format int32 */
4716
4374
  term: number;
4717
- /**
4718
- * @format double
4719
- * @min 0
4720
- * @max 10
4721
- */
4375
+ /** @format double */
4722
4376
  pmi: number;
4723
- /**
4724
- * @format double
4725
- * @min 30000
4726
- */
4377
+ /** @format double */
4727
4378
  originalLoanAmount: number;
4728
- /**
4729
- * @format int32
4730
- * @min 0
4731
- * @max 480
4732
- */
4379
+ /** @format int32 */
4733
4380
  monthsPaid: number;
4734
4381
  }
4735
4382
 
@@ -4752,52 +4399,23 @@ export interface RefinanceLoan {
4752
4399
  }
4753
4400
 
4754
4401
  export interface RefinanceRefinanceLoanRequest {
4755
- /**
4756
- * @format double
4757
- * @min 1
4758
- * @max 25
4759
- */
4402
+ /** @format double */
4760
4403
  interestRate: number;
4761
- /**
4762
- * @format int32
4763
- * @min 1
4764
- * @max 40
4765
- */
4404
+ /** @format int32 */
4766
4405
  term: number;
4767
- /**
4768
- * @format double
4769
- * @min 0
4770
- * @max 10
4771
- */
4406
+ /** @format double */
4772
4407
  pmi: number;
4773
- /**
4774
- * @format double
4775
- * @min 0
4776
- * @max 3
4777
- */
4408
+ /** @format double */
4778
4409
  points: number;
4779
- /**
4780
- * @format double
4781
- * @min 0
4782
- * @max 5
4783
- */
4410
+ /** @format double */
4784
4411
  originationFees: number;
4785
- /**
4786
- * @format double
4787
- * @min 500
4788
- * @max 100000
4789
- */
4412
+ /** @format double */
4790
4413
  closingCosts: number;
4791
- /**
4792
- * @format int32
4793
- * @min 0
4794
- * @max 30
4795
- */
4414
+ /** @format int32 */
4796
4415
  yearsBeforeSale: number;
4797
4416
  }
4798
4417
 
4799
4418
  export interface RefreshTokenRequest {
4800
- /** @minLength 1 */
4801
4419
  refreshToken: string;
4802
4420
  /**
4803
4421
  * @deprecated
@@ -4807,38 +4425,18 @@ export interface RefreshTokenRequest {
4807
4425
  }
4808
4426
 
4809
4427
  export interface RegisterUserRequest {
4810
- /**
4811
- * @format email
4812
- * @minLength 1
4813
- */
4814
4428
  email: string;
4815
- /** @minLength 8 */
4816
4429
  password: string;
4817
4430
  phone?: string | null;
4818
- /**
4819
- * @minLength 1
4820
- * @maxLength 255
4821
- */
4822
4431
  firstName: string;
4823
- /**
4824
- * @minLength 1
4825
- * @maxLength 255
4826
- */
4827
4432
  lastName: string;
4828
- /**
4829
- * @format uuid
4830
- * @minLength 1
4831
- */
4433
+ /** @format uuid */
4832
4434
  siteConfigurationId: string;
4833
4435
  /** @format uuid */
4834
4436
  inviteCode?: string | null;
4835
4437
  }
4836
4438
 
4837
4439
  export interface RequestImpersonationRequest {
4838
- /**
4839
- * @format email
4840
- * @minLength 1
4841
- */
4842
4440
  email: string;
4843
4441
  }
4844
4442
 
@@ -4886,34 +4484,26 @@ export interface RunLOCalculation {
4886
4484
  }
4887
4485
 
4888
4486
  export interface RunLOCalculationRequest {
4889
- /** @minLength 1 */
4890
4487
  loanID: string;
4891
- /** @minLength 1 */
4892
4488
  loanAmount: string;
4893
- /** @minLength 1 */
4894
4489
  propertyValue: string;
4895
4490
  propertyType?: string | null;
4896
4491
  zipCode?: string | null;
4897
4492
  county?: string | null;
4898
- /** @minLength 1 */
4899
4493
  loanPurpose: string;
4900
4494
  propertyOccupancy?: string | null;
4901
4495
  escrow?: string | null;
4902
- /** @minLength 1 */
4903
4496
  loanTerm1: string;
4904
- /** @minLength 1 */
4905
4497
  loanTerm2: string;
4906
4498
  creditScore?: string | null;
4907
4499
  taxes?: string | null;
4908
4500
  insurance?: string | null;
4909
4501
  rate?: string | null;
4910
- /** @minLength 1 */
4911
4502
  loanType: string;
4912
4503
  flood?: string | null;
4913
4504
  hoa?: string | null;
4914
4505
  miFactor?: string | null;
4915
4506
  downpaymentAmount?: string | null;
4916
- /** @minLength 1 */
4917
4507
  lienType: string;
4918
4508
  preApprovalNotes?: string | null;
4919
4509
  additionalPreApprovalNotes?: string | null;
@@ -4926,24 +4516,11 @@ export interface SSOToken {
4926
4516
  }
4927
4517
 
4928
4518
  export interface SSOTokenRequest {
4929
- /**
4930
- * @format email
4931
- * @minLength 1
4932
- */
4933
4519
  email: string;
4934
- /** @minLength 1 */
4935
- redirectUri: string;
4936
- }
4937
-
4938
- export interface SamlMetadataRequest {
4939
- ssoIntegration: SamlMetadataRequestSsoIntegrationEnum;
4520
+ redirectUri?: string | null;
4940
4521
  }
4941
4522
 
4942
4523
  export interface SendForgotPasswordRequest {
4943
- /**
4944
- * @format email
4945
- * @minLength 1
4946
- */
4947
4524
  email: string;
4948
4525
  }
4949
4526
 
@@ -4954,23 +4531,18 @@ export interface SendLoanDocumentsRequest {
4954
4531
  }
4955
4532
 
4956
4533
  export interface SendLoanTaskReminderRequest {
4957
- /**
4958
- * @format uuid
4959
- * @minLength 1
4960
- */
4534
+ /** @format uuid */
4961
4535
  templateId: string;
4962
4536
  userIds?: string[] | null;
4963
4537
  }
4964
4538
 
4965
4539
  export interface SendNotificationForLoanRequest {
4966
- /** @minLength 1 */
4967
4540
  loanID: string;
4968
4541
  templateKey: string;
4969
4542
  loanOfficerEmail?: string | null;
4970
4543
  /** @format uuid */
4971
4544
  siteConfigurationId?: string | null;
4972
- /** @minLength 1 */
4973
- email: string;
4545
+ email?: string | null;
4974
4546
  phone?: string | null;
4975
4547
  attachments: Attachment[];
4976
4548
  }
@@ -4999,7 +4571,6 @@ export interface SiteConfiguration {
4999
4571
  entityID: string;
5000
4572
  /** @format int32 */
5001
4573
  entityType: number;
5002
- /** @minLength 1 */
5003
4574
  url: string;
5004
4575
  name: string;
5005
4576
  introduction?: string | null;
@@ -5194,7 +4765,6 @@ export interface SiteConfigurationByUrl {
5194
4765
  entityID: string;
5195
4766
  /** @format int32 */
5196
4767
  entityType: number;
5197
- /** @minLength 1 */
5198
4768
  url: string;
5199
4769
  name: string;
5200
4770
  introduction?: string | null;
@@ -5646,14 +5216,11 @@ export interface SocialSurveyRecord {
5646
5216
  }
5647
5217
 
5648
5218
  export interface SurveyEmailRequest {
5649
- /** @minLength 1 */
5650
5219
  loanOfficerEmailAddress: string;
5651
5220
  }
5652
5221
 
5653
5222
  export interface SystemTokenRequest {
5654
- /** @minLength 1 */
5655
5223
  clientId: string;
5656
- /** @minLength 1 */
5657
5224
  clientSecret: string;
5658
5225
  }
5659
5226
 
@@ -5715,16 +5282,12 @@ export interface TaskPaginated {
5715
5282
  }
5716
5283
 
5717
5284
  export interface TaskRequest {
5718
- /** @minLength 1 */
5719
5285
  name: string;
5720
5286
  description?: string | null;
5721
5287
  losTarget?: string | null;
5722
5288
  type: string;
5723
5289
  targetUserRole?: string | null;
5724
- /**
5725
- * @format int32
5726
- * @min 0
5727
- */
5290
+ /** @format int32 */
5728
5291
  daysDueFromApplication?: number | null;
5729
5292
  /** @format int32 */
5730
5293
  weight: number;
@@ -5741,16 +5304,12 @@ export interface TaskSearchCriteria {
5741
5304
  }
5742
5305
 
5743
5306
  export interface TaskUpdateRequest {
5744
- /** @minLength 1 */
5745
5307
  name: string;
5746
5308
  description?: string | null;
5747
5309
  losTarget?: string | null;
5748
5310
  type: string;
5749
5311
  targetUserRole?: string | null;
5750
- /**
5751
- * @format int32
5752
- * @min 0
5753
- */
5312
+ /** @format int32 */
5754
5313
  daysDueFromApplication?: number | null;
5755
5314
  /** @format int32 */
5756
5315
  weight: number;
@@ -5762,17 +5321,9 @@ export interface TaskUpdateRequest {
5762
5321
  }
5763
5322
 
5764
5323
  export interface TaxRatesRequest {
5765
- /**
5766
- * @format double
5767
- * @min 0
5768
- * @max 15
5769
- */
5324
+ /** @format double */
5770
5325
  stateTaxRate: number;
5771
- /**
5772
- * @format double
5773
- * @min 0
5774
- * @max 50
5775
- */
5326
+ /** @format double */
5776
5327
  marginalIncomeTaxRate: number;
5777
5328
  }
5778
5329
 
@@ -5821,24 +5372,16 @@ export interface Token {
5821
5372
  }
5822
5373
 
5823
5374
  export interface TokenChallengeRequest {
5824
- /** @format email */
5825
5375
  username: string;
5826
- /** @minLength 1 */
5827
5376
  sessionId: string;
5828
- /** @minLength 1 */
5829
5377
  code: string;
5830
- /**
5831
- * @format uuid
5832
- * @minLength 1
5833
- */
5378
+ /** @format uuid */
5834
5379
  siteConfigurationId: string;
5835
5380
  isSupport: boolean;
5836
5381
  }
5837
5382
 
5838
5383
  export interface TokenRequest {
5839
- /** @format email */
5840
5384
  username: string;
5841
- /** @minLength 1 */
5842
5385
  password: string;
5843
5386
  /** @format uuid */
5844
5387
  siteConfigurationId?: string | null;
@@ -5900,6 +5443,16 @@ export interface UnprocessableEntityError {
5900
5443
  property: string;
5901
5444
  }
5902
5445
 
5446
+ export interface UnregisteredBorrower {
5447
+ /** @format uuid */
5448
+ contactId: string;
5449
+ firstName?: string | null;
5450
+ lastName?: string | null;
5451
+ fullName?: string | null;
5452
+ email?: string | null;
5453
+ role: UnregisteredBorrowerRoleEnum;
5454
+ }
5455
+
5903
5456
  export interface UpdateAccountRequest {
5904
5457
  name: string;
5905
5458
  mfaPreference: string;
@@ -5912,10 +5465,7 @@ export interface UpdateAccountRequest {
5912
5465
 
5913
5466
  export interface UpdateCustomFieldDefinitionRequest {
5914
5467
  isRequired: boolean;
5915
- /**
5916
- * @format int32
5917
- * @min 0
5918
- */
5468
+ /** @format int32 */
5919
5469
  displayOrder: number;
5920
5470
  /** @format int32 */
5921
5471
  minLength?: number | null;
@@ -5925,10 +5475,6 @@ export interface UpdateCustomFieldDefinitionRequest {
5925
5475
  minValue?: number | null;
5926
5476
  /** @format double */
5927
5477
  maxValue?: number | null;
5928
- /**
5929
- * @minLength 1
5930
- * @maxLength 250
5931
- */
5932
5478
  name: string;
5933
5479
  defaultValue?: string | null;
5934
5480
  regexPattern?: string | null;
@@ -5937,12 +5483,7 @@ export interface UpdateCustomFieldDefinitionRequest {
5937
5483
  }
5938
5484
 
5939
5485
  export interface UpdateDocumentTemplateRequest {
5940
- /** @minLength 1 */
5941
5486
  htmlBody: string;
5942
- /**
5943
- * @minLength 1
5944
- * @maxLength 255
5945
- */
5946
5487
  name: string;
5947
5488
  description?: string | null;
5948
5489
  destinationBucket?: string | null;
@@ -5954,32 +5495,19 @@ export interface UpdateListingFileRequest {
5954
5495
  id: string;
5955
5496
  /** @format int32 */
5956
5497
  weight: number;
5957
- /**
5958
- * @minLength 1
5959
- * @maxLength 250
5960
- */
5961
5498
  name: string;
5962
5499
  }
5963
5500
 
5964
5501
  export interface UpdateListingPhotoRequest {
5965
5502
  /** @format uuid */
5966
5503
  id: string;
5967
- /**
5968
- * @minLength 1
5969
- * @maxLength 250
5970
- */
5971
5504
  name: string;
5972
- /** @maxLength 500 */
5973
5505
  description?: string | null;
5974
5506
  /** @format int32 */
5975
5507
  weight: number;
5976
5508
  }
5977
5509
 
5978
5510
  export interface UpdateLoanDocumentFolderRequest {
5979
- /**
5980
- * @minLength 1
5981
- * @maxLength 250
5982
- */
5983
5511
  name: string;
5984
5512
  permissions: LoanDocumentFolderPermissionRequest[];
5985
5513
  }
@@ -5990,15 +5518,7 @@ export interface UpdateLoanQueueRequest {
5990
5518
 
5991
5519
  export interface UpdateMeRequest {
5992
5520
  phone?: string | null;
5993
- /**
5994
- * @minLength 1
5995
- * @maxLength 255
5996
- */
5997
5521
  firstName: string;
5998
- /**
5999
- * @minLength 1
6000
- * @maxLength 255
6001
- */
6002
5522
  lastName: string;
6003
5523
  email: string;
6004
5524
  title?: string | null;
@@ -6014,26 +5534,13 @@ export interface UpdateMobilePhoneRequest {
6014
5534
  }
6015
5535
 
6016
5536
  export interface UpdateUserGroupRequest {
6017
- /**
6018
- * @minLength 1
6019
- * @maxLength 200
6020
- */
6021
5537
  name: string;
6022
- /** @maxLength 1000 */
6023
5538
  description?: string | null;
6024
5539
  }
6025
5540
 
6026
5541
  export interface UpdateUserRequest {
6027
5542
  phone?: string | null;
6028
- /**
6029
- * @minLength 1
6030
- * @maxLength 255
6031
- */
6032
5543
  firstName: string;
6033
- /**
6034
- * @minLength 1
6035
- * @maxLength 255
6036
- */
6037
5544
  lastName: string;
6038
5545
  email: string;
6039
5546
  title?: string | null;
@@ -6386,10 +5893,7 @@ export interface UserLoanTaskPaginated {
6386
5893
 
6387
5894
  export interface UserLoanTaskRequest {
6388
5895
  value?: string | null;
6389
- /**
6390
- * @format uuid
6391
- * @minLength 1
6392
- */
5896
+ /** @format uuid */
6393
5897
  userID: string;
6394
5898
  }
6395
5899
 
@@ -6399,7 +5903,6 @@ export interface UserLoanTaskUpdateRequest {
6399
5903
  }
6400
5904
 
6401
5905
  export interface UserMobilePhoneVerificationRequest {
6402
- /** @minLength 1 */
6403
5906
  code: string;
6404
5907
  }
6405
5908
 
@@ -6436,17 +5939,10 @@ export interface UserPublic {
6436
5939
  }
6437
5940
 
6438
5941
  export interface UserRelation {
6439
- /**
6440
- * @format uuid
6441
- * @minLength 1
6442
- */
5942
+ /** @format uuid */
6443
5943
  userId1: string;
6444
- /**
6445
- * @format uuid
6446
- * @minLength 1
6447
- */
5944
+ /** @format uuid */
6448
5945
  userId2: string;
6449
- /** @minLength 1 */
6450
5946
  relationType: string;
6451
5947
  /** @format uuid */
6452
5948
  id: string;
@@ -6504,14 +6000,8 @@ export interface UserSummary {
6504
6000
  }
6505
6001
 
6506
6002
  export interface VerifyPasswordRequest {
6507
- /**
6508
- * @format email
6509
- * @minLength 1
6510
- */
6511
6003
  email: string;
6512
- /** @minLength 1 */
6513
6004
  code: string;
6514
- /** @minLength 8 */
6515
6005
  password: string;
6516
6006
  /** @format uuid */
6517
6007
  siteConfigurationId?: string | null;
@@ -6547,6 +6037,36 @@ export type AuditLogEntryChangeTypeEnum =
6547
6037
  | "Deactivated"
6548
6038
  | "Reactivated";
6549
6039
 
6040
+ export type BorrowerCountRoleEnum =
6041
+ | "Borrower"
6042
+ | "CoBorrower"
6043
+ | "NonBorrower"
6044
+ | "LoanOfficer"
6045
+ | "LoanProcessor"
6046
+ | "LoanOfficerAssistant"
6047
+ | "SupportingLoanOfficer"
6048
+ | "BuyerAgent"
6049
+ | "SellerAgent"
6050
+ | "TitleInsuranceAgent"
6051
+ | "EscrowAgent"
6052
+ | "SettlementAgent"
6053
+ | "Admin";
6054
+
6055
+ export type BorrowerIdentityRoleEnum =
6056
+ | "Borrower"
6057
+ | "CoBorrower"
6058
+ | "NonBorrower"
6059
+ | "LoanOfficer"
6060
+ | "LoanProcessor"
6061
+ | "LoanOfficerAssistant"
6062
+ | "SupportingLoanOfficer"
6063
+ | "BuyerAgent"
6064
+ | "SellerAgent"
6065
+ | "TitleInsuranceAgent"
6066
+ | "EscrowAgent"
6067
+ | "SettlementAgent"
6068
+ | "Admin";
6069
+
6550
6070
  export type CreateAccessScopeRequestScopeTypeEnum = "User" | "Branch";
6551
6071
 
6552
6072
  export type CreateAccountRequestEnvironmentEnum =
@@ -6896,11 +6416,6 @@ export type LosOperationTrackingStatusEnum =
6896
6416
 
6897
6417
  export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
6898
6418
 
6899
- export type SamlMetadataRequestSsoIntegrationEnum =
6900
- | "ConsumerConnect"
6901
- | "TheBigPOS"
6902
- | "POSF";
6903
-
6904
6419
  export type SiteConfigurationTypeEnum =
6905
6420
  | "None"
6906
6421
  | "Account"
@@ -6941,6 +6456,21 @@ export type SiteConfigurationSummaryTypeEnum =
6941
6456
  | "LoanOfficer"
6942
6457
  | "Partner";
6943
6458
 
6459
+ export type UnregisteredBorrowerRoleEnum =
6460
+ | "Borrower"
6461
+ | "CoBorrower"
6462
+ | "NonBorrower"
6463
+ | "LoanOfficer"
6464
+ | "LoanProcessor"
6465
+ | "LoanOfficerAssistant"
6466
+ | "SupportingLoanOfficer"
6467
+ | "BuyerAgent"
6468
+ | "SellerAgent"
6469
+ | "TitleInsuranceAgent"
6470
+ | "EscrowAgent"
6471
+ | "SettlementAgent"
6472
+ | "Admin";
6473
+
6944
6474
  export type UserDraftRoleEnum =
6945
6475
  | "Borrower"
6946
6476
  | "CoBorrower"
@@ -7204,7 +6734,7 @@ export class HttpClient<SecurityDataType = unknown> {
7204
6734
 
7205
6735
  /**
7206
6736
  * @title The Big POS API
7207
- * @version v2.42.0
6737
+ * @version v2.43.0
7208
6738
  * @termsOfService https://www.thebigpos.com/terms-of-use/
7209
6739
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
7210
6740
  */
@@ -7218,7 +6748,7 @@ export class Api<
7218
6748
  * @name PostRoot
7219
6749
  * @request POST:/
7220
6750
  * @secure
7221
- * @response `200` `void` Success
6751
+ * @response `200` `void` OK
7222
6752
  */
7223
6753
  postRoot = (params: RequestParams = {}) =>
7224
6754
  this.request<void, any>({
@@ -7235,7 +6765,7 @@ export class Api<
7235
6765
  * @name GetRoot
7236
6766
  * @request GET:/
7237
6767
  * @secure
7238
- * @response `200` `string` Success
6768
+ * @response `200` `string` OK
7239
6769
  */
7240
6770
  getRoot = (params: RequestParams = {}) =>
7241
6771
  this.request<string, any>({
@@ -7254,7 +6784,7 @@ export class Api<
7254
6784
  * @summary Get
7255
6785
  * @request GET:/api/account
7256
6786
  * @secure
7257
- * @response `200` `Account` Success
6787
+ * @response `200` `Account` OK
7258
6788
  * @response `404` `ProblemDetails` Not Found
7259
6789
  */
7260
6790
  getMyAccount: (params: RequestParams = {}) =>
@@ -7274,9 +6804,9 @@ export class Api<
7274
6804
  * @summary Replace
7275
6805
  * @request PUT:/api/account
7276
6806
  * @secure
7277
- * @response `200` `Account` Success
6807
+ * @response `200` `Account` OK
7278
6808
  * @response `404` `ProblemDetails` Not Found
7279
- * @response `422` `ProblemDetails` Client Error
6809
+ * @response `422` `ProblemDetails` Unprocessable Content
7280
6810
  */
7281
6811
  replaceMyAccount: (
7282
6812
  data: UpdateAccountRequest,
@@ -7300,7 +6830,7 @@ export class Api<
7300
6830
  * @summary Get Site Configuration
7301
6831
  * @request GET:/api/account/site-configurations
7302
6832
  * @secure
7303
- * @response `200` `SiteConfiguration` Success
6833
+ * @response `200` `SiteConfiguration` OK
7304
6834
  */
7305
6835
  getSiteConfigurationByAccount: (params: RequestParams = {}) =>
7306
6836
  this.request<SiteConfiguration, any>({
@@ -7319,8 +6849,8 @@ export class Api<
7319
6849
  * @summary Update Site Configuration
7320
6850
  * @request PUT:/api/account/site-configurations
7321
6851
  * @secure
7322
- * @response `200` `SiteConfiguration` Success
7323
- * @response `422` `UnprocessableEntity` Client Error
6852
+ * @response `200` `SiteConfiguration` OK
6853
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7324
6854
  */
7325
6855
  updateSiteConfigurationForAccount: (
7326
6856
  data: SiteConfiguration,
@@ -7391,7 +6921,7 @@ export class Api<
7391
6921
  * @summary Get All
7392
6922
  * @request GET:/api/accounts
7393
6923
  * @secure
7394
- * @response `200` `(Account)[]` Success
6924
+ * @response `200` `(Account)[]` OK
7395
6925
  */
7396
6926
  getAccounts: (params: RequestParams = {}) =>
7397
6927
  this.request<Account[], any>({
@@ -7411,7 +6941,7 @@ export class Api<
7411
6941
  * @request POST:/api/accounts
7412
6942
  * @secure
7413
6943
  * @response `201` `Account` Created
7414
- * @response `422` `ProblemDetails` Client Error
6944
+ * @response `422` `ProblemDetails` Unprocessable Content
7415
6945
  */
7416
6946
  createAccount: (data: CreateAccountRequest, params: RequestParams = {}) =>
7417
6947
  this.request<Account, ProblemDetails>({
@@ -7433,7 +6963,7 @@ export class Api<
7433
6963
  * @request GET:/api/accounts/{id}
7434
6964
  * @secure
7435
6965
  * @response `201` `Account` Created
7436
- * @response `422` `ProblemDetails` Client Error
6966
+ * @response `422` `ProblemDetails` Unprocessable Content
7437
6967
  */
7438
6968
  getAccount: (id: string, params: RequestParams = {}) =>
7439
6969
  this.request<Account, ProblemDetails>({
@@ -7454,7 +6984,7 @@ export class Api<
7454
6984
  * @secure
7455
6985
  * @response `204` `Account` No Content
7456
6986
  * @response `404` `ProblemDetails` Not Found
7457
- * @response `422` `ProblemDetails` Client Error
6987
+ * @response `422` `ProblemDetails` Unprocessable Content
7458
6988
  */
7459
6989
  deleteAccount: (
7460
6990
  id: string,
@@ -7481,9 +7011,9 @@ export class Api<
7481
7011
  * @summary Update billing configuration
7482
7012
  * @request PUT:/api/accounts/{id}/billing
7483
7013
  * @secure
7484
- * @response `200` `AccountBilling` Success
7014
+ * @response `200` `AccountBilling` OK
7485
7015
  * @response `404` `ProblemDetails` Not Found
7486
- * @response `422` `ProblemDetails` Client Error
7016
+ * @response `422` `ProblemDetails` Unprocessable Content
7487
7017
  */
7488
7018
  updateAccountBilling: (
7489
7019
  id: string,
@@ -7508,7 +7038,7 @@ export class Api<
7508
7038
  * @summary Search
7509
7039
  * @request POST:/api/audit-logs/search
7510
7040
  * @secure
7511
- * @response `200` `AuditLogEntryPaginated` Success
7041
+ * @response `200` `AuditLogEntryPaginated` OK
7512
7042
  */
7513
7043
  searchAuditLogs: (
7514
7044
  data: AuditLogSearchCriteria,
@@ -7541,7 +7071,7 @@ export class Api<
7541
7071
  * @summary Get entity types
7542
7072
  * @request GET:/api/audit-logs/entity-types
7543
7073
  * @secure
7544
- * @response `200` `(AuditEntityType)[]` Success
7074
+ * @response `200` `(AuditEntityType)[]` OK
7545
7075
  */
7546
7076
  getAuditLogEntityTypes: (params: RequestParams = {}) =>
7547
7077
  this.request<AuditEntityType[], any>({
@@ -7560,7 +7090,7 @@ export class Api<
7560
7090
  * @summary Get by ID
7561
7091
  * @request GET:/api/audit-logs/{id}
7562
7092
  * @secure
7563
- * @response `200` `AuditLogEntry` Success
7093
+ * @response `200` `AuditLogEntry` OK
7564
7094
  * @response `404` `ProblemDetails` Not Found
7565
7095
  */
7566
7096
  getAuditLogById: (id: string, params: RequestParams = {}) =>
@@ -7580,9 +7110,9 @@ export class Api<
7580
7110
  * @summary Generate Token From Refresh Token
7581
7111
  * @request POST:/api/refresh-token
7582
7112
  * @secure
7583
- * @response `200` `Token` Success
7113
+ * @response `200` `Token` OK
7584
7114
  * @response `401` `ProblemDetails` Unauthorized
7585
- * @response `422` `UnprocessableEntity` Client Error
7115
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7586
7116
  */
7587
7117
  getTokenFromRefreshToken: (
7588
7118
  data: RefreshTokenRequest,
@@ -7606,8 +7136,8 @@ export class Api<
7606
7136
  * @summary Get Token
7607
7137
  * @request POST:/api/token
7608
7138
  * @secure
7609
- * @response `200` `AccountDeactivated` Success
7610
- * @response `422` `UnprocessableEntity` Client Error
7139
+ * @response `200` `AccountDeactivated` OK
7140
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7611
7141
  */
7612
7142
  getToken: (data: TokenRequest, params: RequestParams = {}) =>
7613
7143
  this.request<AccountDeactivated, UnprocessableEntity>({
@@ -7628,8 +7158,8 @@ export class Api<
7628
7158
  * @summary Get Token From Challenge Code
7629
7159
  * @request POST:/api/token/code
7630
7160
  * @secure
7631
- * @response `200` `AccountDeactivated` Success
7632
- * @response `422` `UnprocessableEntity` Client Error
7161
+ * @response `200` `AccountDeactivated` OK
7162
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7633
7163
  */
7634
7164
  getTokenFromChallengeCode: (
7635
7165
  data: TokenChallengeRequest,
@@ -7653,8 +7183,8 @@ export class Api<
7653
7183
  * @summary Get System Token
7654
7184
  * @request POST:/api/oauth2/token
7655
7185
  * @secure
7656
- * @response `200` `Token` Success
7657
- * @response `422` `UnprocessableEntity` Client Error
7186
+ * @response `200` `Token` OK
7187
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7658
7188
  */
7659
7189
  getSystemToken: (data: SystemTokenRequest, params: RequestParams = {}) =>
7660
7190
  this.request<Token, UnprocessableEntity>({
@@ -7675,8 +7205,8 @@ export class Api<
7675
7205
  * @summary Get SSO Guid Token
7676
7206
  * @request POST:/api/token/sso
7677
7207
  * @secure
7678
- * @response `200` `SSOToken` Success
7679
- * @response `422` `UnprocessableEntity` Client Error
7208
+ * @response `200` `SSOToken` OK
7209
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7680
7210
  */
7681
7211
  getSsoToken: (data: SSOTokenRequest, params: RequestParams = {}) =>
7682
7212
  this.request<SSOToken, UnprocessableEntity>({
@@ -7698,7 +7228,7 @@ export class Api<
7698
7228
  * @request POST:/api/logout
7699
7229
  * @secure
7700
7230
  * @response `204` `NoContentResult` No Content
7701
- * @response `422` `UnprocessableEntity` Client Error
7231
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7702
7232
  */
7703
7233
  logOut: (params: RequestParams = {}) =>
7704
7234
  this.request<NoContentResult, UnprocessableEntity>({
@@ -7717,7 +7247,7 @@ export class Api<
7717
7247
  * @summary Get All
7718
7248
  * @request GET:/api/branches
7719
7249
  * @secure
7720
- * @response `200` `GetBranchPaginated` Success
7250
+ * @response `200` `GetBranchPaginated` OK
7721
7251
  */
7722
7252
  getBranches: (
7723
7253
  query?: {
@@ -7748,8 +7278,8 @@ export class Api<
7748
7278
  * @summary Create
7749
7279
  * @request POST:/api/branches
7750
7280
  * @secure
7751
- * @response `200` `GetBranch` Success
7752
- * @response `422` `UnprocessableEntity` Client Error
7281
+ * @response `200` `GetBranch` OK
7282
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7753
7283
  */
7754
7284
  createBranch: (data: CreateBranchRequest, params: RequestParams = {}) =>
7755
7285
  this.request<GetBranch, UnprocessableEntity>({
@@ -7770,7 +7300,7 @@ export class Api<
7770
7300
  * @summary Search
7771
7301
  * @request POST:/api/branches/search
7772
7302
  * @secure
7773
- * @response `200` `GetBranchPaginated` Success
7303
+ * @response `200` `GetBranchPaginated` OK
7774
7304
  */
7775
7305
  searchBranches: (
7776
7306
  data: BranchSearchCriteria,
@@ -7803,7 +7333,7 @@ export class Api<
7803
7333
  * @summary Get by ID
7804
7334
  * @request GET:/api/branches/{branchId}
7805
7335
  * @secure
7806
- * @response `200` `GetBranch` Success
7336
+ * @response `200` `GetBranch` OK
7807
7337
  */
7808
7338
  getBranch: (branchId: string, params: RequestParams = {}) =>
7809
7339
  this.request<GetBranch, any>({
@@ -7822,8 +7352,8 @@ export class Api<
7822
7352
  * @summary Replace
7823
7353
  * @request PUT:/api/branches/{branchId}
7824
7354
  * @secure
7825
- * @response `200` `GetBranch` Success
7826
- * @response `422` `UnprocessableEntity` Client Error
7355
+ * @response `200` `GetBranch` OK
7356
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7827
7357
  */
7828
7358
  replaceBranch: (
7829
7359
  branchId: string,
@@ -7885,8 +7415,8 @@ export class Api<
7885
7415
  * @summary Create Branch Site Configuration
7886
7416
  * @request POST:/api/branches/{branchId}/site-configurations
7887
7417
  * @secure
7888
- * @response `200` `SiteConfiguration` Success
7889
- * @response `422` `UnprocessableEntity` Client Error
7418
+ * @response `200` `SiteConfiguration` OK
7419
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7890
7420
  */
7891
7421
  createBranchSiteConfiguration: (
7892
7422
  branchId: string,
@@ -7911,7 +7441,7 @@ export class Api<
7911
7441
  * @summary Get Branch Site Configuration
7912
7442
  * @request GET:/api/branches/{branchId}/site-configurations/{siteConfigurationId}
7913
7443
  * @secure
7914
- * @response `200` `SiteConfigurationWithInherited` Success
7444
+ * @response `200` `SiteConfigurationWithInherited` OK
7915
7445
  */
7916
7446
  getBranchSiteConfiguration: (
7917
7447
  branchId: string,
@@ -7934,8 +7464,8 @@ export class Api<
7934
7464
  * @summary Replace Branch Site Configuration
7935
7465
  * @request PUT:/api/branches/{branchId}/site-configurations/{siteConfigurationId}
7936
7466
  * @secure
7937
- * @response `200` `SiteConfiguration` Success
7938
- * @response `422` `UnprocessableEntity` Client Error
7467
+ * @response `200` `SiteConfiguration` OK
7468
+ * @response `422` `UnprocessableEntity` Unprocessable Content
7939
7469
  */
7940
7470
  replaceBranchSiteConfiguration: (
7941
7471
  branchId: string,
@@ -7965,7 +7495,7 @@ export class Api<
7965
7495
  * @summary Get Branch Loan Officers
7966
7496
  * @request GET:/api/branches/{branchId}/loan-officers
7967
7497
  * @secure
7968
- * @response `200` `(LoanOfficerPublic)[]` Success
7498
+ * @response `200` `(LoanOfficerPublic)[]` OK
7969
7499
  */
7970
7500
  getLoanOfficersByBranch: (branchId: string, params: RequestParams = {}) =>
7971
7501
  this.request<LoanOfficerPublic[], any>({
@@ -7984,7 +7514,7 @@ export class Api<
7984
7514
  * @summary Get All
7985
7515
  * @request GET:/api/business-rules
7986
7516
  * @secure
7987
- * @response `200` `(BusinessRule)[]` Success
7517
+ * @response `200` `(BusinessRule)[]` OK
7988
7518
  */
7989
7519
  getBusinessRules: (
7990
7520
  query?: {
@@ -8009,8 +7539,8 @@ export class Api<
8009
7539
  * @summary Create
8010
7540
  * @request POST:/api/business-rules
8011
7541
  * @secure
8012
- * @response `200` `BusinessRule` Success
8013
- * @response `422` `UnprocessableEntity` Client Error
7542
+ * @response `200` `BusinessRule` OK
7543
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8014
7544
  */
8015
7545
  createBusinessRule: (
8016
7546
  data: BusinessRuleRequest,
@@ -8034,7 +7564,7 @@ export class Api<
8034
7564
  * @summary Get by ID
8035
7565
  * @request GET:/api/business-rules/{id}
8036
7566
  * @secure
8037
- * @response `200` `BusinessRule` Success
7567
+ * @response `200` `BusinessRule` OK
8038
7568
  */
8039
7569
  getBusinessRule: (id: string, params: RequestParams = {}) =>
8040
7570
  this.request<BusinessRule, any>({
@@ -8053,8 +7583,8 @@ export class Api<
8053
7583
  * @summary Replace
8054
7584
  * @request PUT:/api/business-rules/{id}
8055
7585
  * @secure
8056
- * @response `200` `BusinessRule` Success
8057
- * @response `422` `UnprocessableEntity` Client Error
7586
+ * @response `200` `BusinessRule` OK
7587
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8058
7588
  */
8059
7589
  replaceBusinessRule: (
8060
7590
  id: string,
@@ -8097,7 +7627,7 @@ export class Api<
8097
7627
  * @summary Restore
8098
7628
  * @request POST:/api/business-rules/{id}/restore
8099
7629
  * @secure
8100
- * @response `200` `BusinessRule` Success
7630
+ * @response `200` `BusinessRule` OK
8101
7631
  */
8102
7632
  restoreBusinessRule: (id: string, params: RequestParams = {}) =>
8103
7633
  this.request<BusinessRule, any>({
@@ -8116,7 +7646,7 @@ export class Api<
8116
7646
  * @summary Get Closed Loans Report
8117
7647
  * @request POST:/api/loans/reports/closed-loans
8118
7648
  * @secure
8119
- * @response `200` `ClosedLoansReport` Success
7649
+ * @response `200` `ClosedLoansReport` OK
8120
7650
  */
8121
7651
  getClosedLoansReport: (
8122
7652
  data: ClosedLoansReportRequest,
@@ -8140,7 +7670,7 @@ export class Api<
8140
7670
  * @summary Get Consumer Connect association status for all borrowers on a loan
8141
7671
  * @request GET:/api/loans/{loanId}/consumer-connect/status
8142
7672
  * @secure
8143
- * @response `200` `(ConsumerConnectStatus)[]` Success
7673
+ * @response `200` `(ConsumerConnectStatus)[]` OK
8144
7674
  */
8145
7675
  getConsumerConnectStatus: (loanId: string, params: RequestParams = {}) =>
8146
7676
  this.request<ConsumerConnectStatus[], any>({
@@ -8159,7 +7689,7 @@ export class Api<
8159
7689
  * @summary Manually retry Consumer Connect association for failed borrowers on a loan. Returns per-borrower results; check individual Success fields for partial failures.
8160
7690
  * @request POST:/api/loans/{loanId}/consumer-connect/retry
8161
7691
  * @secure
8162
- * @response `200` `(ConsumerConnectRetry)[]` Success
7692
+ * @response `200` `(ConsumerConnectRetry)[]` OK
8163
7693
  */
8164
7694
  retryConsumerConnectAssociation: (
8165
7695
  loanId: string,
@@ -8181,7 +7711,7 @@ export class Api<
8181
7711
  * @summary Get All
8182
7712
  * @request GET:/api/corporates
8183
7713
  * @secure
8184
- * @response `200` `CorporatePaginated` Success
7714
+ * @response `200` `CorporatePaginated` OK
8185
7715
  */
8186
7716
  getCorporates: (
8187
7717
  query?: {
@@ -8212,8 +7742,8 @@ export class Api<
8212
7742
  * @summary Create
8213
7743
  * @request POST:/api/corporates
8214
7744
  * @secure
8215
- * @response `200` `Corporate` Success
8216
- * @response `422` `UnprocessableEntity` Client Error
7745
+ * @response `200` `Corporate` OK
7746
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8217
7747
  */
8218
7748
  createCorporate: (data: CorporateRequest, params: RequestParams = {}) =>
8219
7749
  this.request<Corporate, UnprocessableEntity>({
@@ -8234,7 +7764,7 @@ export class Api<
8234
7764
  * @summary Search
8235
7765
  * @request POST:/api/corporates/search
8236
7766
  * @secure
8237
- * @response `200` `CorporatePaginated` Success
7767
+ * @response `200` `CorporatePaginated` OK
8238
7768
  */
8239
7769
  searchCorporate: (
8240
7770
  data: CorporateSearchCriteria,
@@ -8267,7 +7797,7 @@ export class Api<
8267
7797
  * @summary Get by ID
8268
7798
  * @request GET:/api/corporates/{id}
8269
7799
  * @secure
8270
- * @response `200` `Corporate` Success
7800
+ * @response `200` `Corporate` OK
8271
7801
  */
8272
7802
  getCorporate: (id: string, params: RequestParams = {}) =>
8273
7803
  this.request<Corporate, any>({
@@ -8286,8 +7816,8 @@ export class Api<
8286
7816
  * @summary Replace
8287
7817
  * @request PUT:/api/corporates/{id}
8288
7818
  * @secure
8289
- * @response `200` `Corporate` Success
8290
- * @response `422` `UnprocessableEntity` Client Error
7819
+ * @response `200` `Corporate` OK
7820
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8291
7821
  */
8292
7822
  replaceCorporate: (
8293
7823
  id: string,
@@ -8348,8 +7878,8 @@ export class Api<
8348
7878
  * @summary Create Site Configuration
8349
7879
  * @request POST:/api/corporates/{corporateId}/site-configurations
8350
7880
  * @secure
8351
- * @response `200` `SiteConfiguration` Success
8352
- * @response `422` `UnprocessableEntity` Client Error
7881
+ * @response `200` `SiteConfiguration` OK
7882
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8353
7883
  */
8354
7884
  createCorporateSiteConfiguration: (
8355
7885
  corporateId: string,
@@ -8374,7 +7904,7 @@ export class Api<
8374
7904
  * @summary Get Site Configuration
8375
7905
  * @request GET:/api/corporates/{corporateId}/site-configurations/{siteConfigurationId}
8376
7906
  * @secure
8377
- * @response `200` `SiteConfigurationWithInherited` Success
7907
+ * @response `200` `SiteConfigurationWithInherited` OK
8378
7908
  */
8379
7909
  getCorporateSiteConfiguration: (
8380
7910
  corporateId: string,
@@ -8397,8 +7927,8 @@ export class Api<
8397
7927
  * @summary Replace Site Configuration
8398
7928
  * @request PUT:/api/corporates/{corporateId}/site-configurations/{siteConfigurationId}
8399
7929
  * @secure
8400
- * @response `200` `SiteConfiguration` Success
8401
- * @response `422` `UnprocessableEntity` Client Error
7930
+ * @response `200` `SiteConfiguration` OK
7931
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8402
7932
  */
8403
7933
  replaceCorporateSiteConfiguration: (
8404
7934
  corporateId: string,
@@ -8428,7 +7958,7 @@ export class Api<
8428
7958
  * @summary Get Branches
8429
7959
  * @request GET:/api/corporates/{id}/branches
8430
7960
  * @secure
8431
- * @response `200` `(BranchReduced)[]` Success
7961
+ * @response `200` `(BranchReduced)[]` OK
8432
7962
  */
8433
7963
  getBranchesByCorporate: (id: string, params: RequestParams = {}) =>
8434
7964
  this.request<BranchReduced[], any>({
@@ -8447,7 +7977,7 @@ export class Api<
8447
7977
  * @summary Get Loan Officers
8448
7978
  * @request GET:/api/corporates/{id}/loan-officers
8449
7979
  * @secure
8450
- * @response `200` `(LoanOfficerPublic)[]` Success
7980
+ * @response `200` `(LoanOfficerPublic)[]` OK
8451
7981
  */
8452
7982
  getLoanOfficersByCorporate: (id: string, params: RequestParams = {}) =>
8453
7983
  this.request<LoanOfficerPublic[], any>({
@@ -8466,7 +7996,7 @@ export class Api<
8466
7996
  * @summary Get all custom field definitions by entity type
8467
7997
  * @request GET:/api/custom-field-definitions
8468
7998
  * @secure
8469
- * @response `200` `(CustomFieldDefinition)[]` Success
7999
+ * @response `200` `(CustomFieldDefinition)[]` OK
8470
8000
  */
8471
8001
  getCustomFieldDefinitions: (
8472
8002
  query?: {
@@ -8493,7 +8023,7 @@ export class Api<
8493
8023
  * @secure
8494
8024
  * @response `201` `CustomFieldDefinition` Created
8495
8025
  * @response `409` `ProblemDetails` Conflict
8496
- * @response `422` `ProblemDetails` Client Error
8026
+ * @response `422` `ProblemDetails` Unprocessable Content
8497
8027
  */
8498
8028
  createCustomFieldDefinition: (
8499
8029
  data: CreateCustomFieldDefinitionRequest,
@@ -8517,7 +8047,7 @@ export class Api<
8517
8047
  * @summary Get a custom field definition by ID
8518
8048
  * @request GET:/api/custom-field-definitions/{id}
8519
8049
  * @secure
8520
- * @response `200` `CustomFieldDefinition` Success
8050
+ * @response `200` `CustomFieldDefinition` OK
8521
8051
  * @response `404` `ProblemDetails` Not Found
8522
8052
  */
8523
8053
  getCustomFieldDefinitionById: (id: string, params: RequestParams = {}) =>
@@ -8537,11 +8067,11 @@ export class Api<
8537
8067
  * @summary Update a custom field definition
8538
8068
  * @request PUT:/api/custom-field-definitions/{id}
8539
8069
  * @secure
8540
- * @response `200` `CustomFieldDefinition` Success
8070
+ * @response `200` `CustomFieldDefinition` OK
8541
8071
  * @response `400` `ProblemDetails` Bad Request
8542
8072
  * @response `404` `ProblemDetails` Not Found
8543
8073
  * @response `409` `ProblemDetails` Conflict
8544
- * @response `422` `ProblemDetails` Client Error
8074
+ * @response `422` `ProblemDetails` Unprocessable Content
8545
8075
  */
8546
8076
  updateCustomFieldDefinition: (
8547
8077
  id: string,
@@ -8624,7 +8154,7 @@ export class Api<
8624
8154
  * @summary Get All
8625
8155
  * @request GET:/api/devices
8626
8156
  * @secure
8627
- * @response `200` `DevicePaginated` Success
8157
+ * @response `200` `DevicePaginated` OK
8628
8158
  */
8629
8159
  getDevices: (
8630
8160
  query?: {
@@ -8656,7 +8186,7 @@ export class Api<
8656
8186
  * @summary Get by ID
8657
8187
  * @request GET:/api/devices/{id}
8658
8188
  * @secure
8659
- * @response `200` `Device` Success
8189
+ * @response `200` `Device` OK
8660
8190
  */
8661
8191
  getDevice: (id: string, params: RequestParams = {}) =>
8662
8192
  this.request<Device, any>({
@@ -8675,7 +8205,7 @@ export class Api<
8675
8205
  * @summary Update
8676
8206
  * @request PUT:/api/devices/{id}
8677
8207
  * @secure
8678
- * @response `200` `Device` Success
8208
+ * @response `200` `Device` OK
8679
8209
  */
8680
8210
  updateDevice: (
8681
8211
  id: string,
@@ -8700,7 +8230,7 @@ export class Api<
8700
8230
  * @summary Get by Serial Number
8701
8231
  * @request GET:/api/devices/{sn}/profile
8702
8232
  * @secure
8703
- * @response `200` `DeviceMDM` Success
8233
+ * @response `200` `DeviceMDM` OK
8704
8234
  */
8705
8235
  getDeviceBySerialNumber: (sn: string, params: RequestParams = {}) =>
8706
8236
  this.request<DeviceMDM, any>({
@@ -8719,7 +8249,7 @@ export class Api<
8719
8249
  * @summary Create Action by Serial Number
8720
8250
  * @request POST:/api/devices/{sn}/actions/{actionName}
8721
8251
  * @secure
8722
- * @response `200` `Action` Success
8252
+ * @response `200` `Action` OK
8723
8253
  */
8724
8254
  createDeviceActionBySerialNumber: (
8725
8255
  sn: string,
@@ -8742,7 +8272,7 @@ export class Api<
8742
8272
  * @summary Get All
8743
8273
  * @request GET:/api/document-buckets
8744
8274
  * @secure
8745
- * @response `200` `(string)[]` Success
8275
+ * @response `200` `(string)[]` OK
8746
8276
  */
8747
8277
  getDocumentBuckets: (
8748
8278
  query?: {
@@ -8768,7 +8298,7 @@ export class Api<
8768
8298
  * @summary Get All
8769
8299
  * @request GET:/api/document-templates
8770
8300
  * @secure
8771
- * @response `200` `(DocumentTemplateBase)[]` Success
8301
+ * @response `200` `(DocumentTemplateBase)[]` OK
8772
8302
  */
8773
8303
  getDocumentTemplates: (
8774
8304
  query?: {
@@ -8795,7 +8325,7 @@ export class Api<
8795
8325
  * @secure
8796
8326
  * @response `201` `DocumentTemplateBase` Created
8797
8327
  * @response `404` `ProblemDetails` Not Found
8798
- * @response `422` `UnprocessableEntity` Client Error
8328
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8799
8329
  */
8800
8330
  createDocumentTemplate: (
8801
8331
  data: CreateDocumentTemplateRequest,
@@ -8819,7 +8349,7 @@ export class Api<
8819
8349
  * @summary Get Custom
8820
8350
  * @request GET:/api/document-templates/{type}
8821
8351
  * @secure
8822
- * @response `200` `(DocumentTemplateBase)[]` Success
8352
+ * @response `200` `(DocumentTemplateBase)[]` OK
8823
8353
  */
8824
8354
  getCustomDocumentTemplates: (
8825
8355
  type: string,
@@ -8848,7 +8378,7 @@ export class Api<
8848
8378
  * @summary Get By ID
8849
8379
  * @request GET:/api/document-templates/{id}
8850
8380
  * @secure
8851
- * @response `200` `DocumentTemplate` Success
8381
+ * @response `200` `DocumentTemplate` OK
8852
8382
  * @response `404` `ProblemDetails` Not Found
8853
8383
  */
8854
8384
  getDocumentTemplate: (id: string, params: RequestParams = {}) =>
@@ -8868,10 +8398,10 @@ export class Api<
8868
8398
  * @summary Replace
8869
8399
  * @request PUT:/api/document-templates/{id}
8870
8400
  * @secure
8871
- * @response `200` `DocumentTemplateBase` Success
8401
+ * @response `200` `DocumentTemplateBase` OK
8872
8402
  * @response `401` `ProblemDetails` Unauthorized
8873
8403
  * @response `404` `ProblemDetails` Not Found
8874
- * @response `422` `UnprocessableEntity` Client Error
8404
+ * @response `422` `UnprocessableEntity` Unprocessable Content
8875
8405
  */
8876
8406
  replaceDocumentTemplate: (
8877
8407
  id: string,
@@ -8936,7 +8466,7 @@ export class Api<
8936
8466
  * @summary Get All
8937
8467
  * @request GET:/api/document-templates/{documentId}/versions
8938
8468
  * @secure
8939
- * @response `200` `(DocumentTemplateVersion)[]` Success
8469
+ * @response `200` `(DocumentTemplateVersion)[]` OK
8940
8470
  */
8941
8471
  getDocumentTemplateVersions: (
8942
8472
  documentId: string,
@@ -8958,7 +8488,7 @@ export class Api<
8958
8488
  * @summary Create
8959
8489
  * @request POST:/api/document-templates/{documentId}/versions
8960
8490
  * @secure
8961
- * @response `200` `DocumentTemplateVersion` Success
8491
+ * @response `200` `DocumentTemplateVersion` OK
8962
8492
  */
8963
8493
  createDocumentTemplateVersion: (
8964
8494
  documentId: string,
@@ -8983,7 +8513,7 @@ export class Api<
8983
8513
  * @summary Get by ID
8984
8514
  * @request GET:/api/document-templates/{documentId}/versions/{id}
8985
8515
  * @secure
8986
- * @response `200` `DocumentTemplateVersion` Success
8516
+ * @response `200` `DocumentTemplateVersion` OK
8987
8517
  */
8988
8518
  getDocumentTemplateVersion: (
8989
8519
  documentId: string,
@@ -9006,7 +8536,7 @@ export class Api<
9006
8536
  * @summary Replace
9007
8537
  * @request PUT:/api/document-templates/{documentId}/versions/{id}
9008
8538
  * @secure
9009
- * @response `200` `DocumentTemplateVersion` Success
8539
+ * @response `200` `DocumentTemplateVersion` OK
9010
8540
  */
9011
8541
  replaceDocumentTemplateVersion: (
9012
8542
  documentId: string,
@@ -9032,7 +8562,7 @@ export class Api<
9032
8562
  * @summary Delete
9033
8563
  * @request DELETE:/api/document-templates/{documentId}/versions/{id}
9034
8564
  * @secure
9035
- * @response `200` `DocumentTemplateVersion` Success
8565
+ * @response `200` `DocumentTemplateVersion` OK
9036
8566
  */
9037
8567
  deleteDocumentTemplateVersion: (
9038
8568
  documentId: string,
@@ -9052,9 +8582,10 @@ export class Api<
9052
8582
  *
9053
8583
  * @tags Encompass Custom Field Mappings
9054
8584
  * @name GetEncompassCustomFieldMapping
8585
+ * @summary Get Encompass field mapping for a custom field definition
9055
8586
  * @request GET:/api/los/encompass/custom-field-mappings/{definitionId}
9056
8587
  * @secure
9057
- * @response `200` `EncompassCustomFieldMapping` Success
8588
+ * @response `200` `EncompassCustomFieldMapping` OK
9058
8589
  * @response `404` `void` Not Found
9059
8590
  */
9060
8591
  getEncompassCustomFieldMapping: (
@@ -9074,13 +8605,14 @@ export class Api<
9074
8605
  *
9075
8606
  * @tags Encompass Custom Field Mappings
9076
8607
  * @name AddEncompassCustomFieldMapping
8608
+ * @summary Add an Encompass field mapping to a custom field definition
9077
8609
  * @request POST:/api/los/encompass/custom-field-mappings/{definitionId}
9078
8610
  * @secure
9079
8611
  * @response `201` `EncompassCustomFieldMapping` Created
9080
8612
  * @response `400` `void` Bad Request
9081
8613
  * @response `404` `void` Not Found
9082
8614
  * @response `409` `void` Conflict
9083
- * @response `422` `ProblemDetails` Client Error
8615
+ * @response `422` `ProblemDetails` Unprocessable Content
9084
8616
  */
9085
8617
  addEncompassCustomFieldMapping: (
9086
8618
  definitionId: string,
@@ -9102,6 +8634,7 @@ export class Api<
9102
8634
  *
9103
8635
  * @tags Encompass Custom Field Mappings
9104
8636
  * @name DeleteEncompassCustomFieldMapping
8637
+ * @summary Delete the Encompass field mapping (only if no values exist)
9105
8638
  * @request DELETE:/api/los/encompass/custom-field-mappings/{definitionId}
9106
8639
  * @secure
9107
8640
  * @response `204` `void` No Content
@@ -9124,6 +8657,7 @@ export class Api<
9124
8657
  *
9125
8658
  * @tags Encompass Custom Field Mappings
9126
8659
  * @name DisableEncompassCustomFieldMapping
8660
+ * @summary Disable the Encompass field mapping (stops sync)
9127
8661
  * @request POST:/api/los/encompass/custom-field-mappings/{definitionId}/disable
9128
8662
  * @secure
9129
8663
  * @response `204` `void` No Content
@@ -9145,6 +8679,7 @@ export class Api<
9145
8679
  *
9146
8680
  * @tags Encompass Custom Field Mappings
9147
8681
  * @name EnableEncompassCustomFieldMapping
8682
+ * @summary Re-enable the Encompass field mapping (resumes sync)
9148
8683
  * @request POST:/api/los/encompass/custom-field-mappings/{definitionId}/enable
9149
8684
  * @secure
9150
8685
  * @response `204` `void` No Content
@@ -9166,10 +8701,11 @@ export class Api<
9166
8701
  *
9167
8702
  * @tags Encompass Custom Fields
9168
8703
  * @name GetEncompassFields
8704
+ * @summary Fetch available Encompass custom fields with type metadata
9169
8705
  * @request GET:/api/los/encompass/custom-fields
9170
8706
  * @secure
9171
- * @response `200` `(EncompassFieldListItem)[]` Success
9172
- * @response `502` `ProblemDetails` Server Error
8707
+ * @response `200` `(EncompassFieldListItem)[]` OK
8708
+ * @response `502` `ProblemDetails` Bad Gateway
9173
8709
  */
9174
8710
  getEncompassFields: (params: RequestParams = {}) =>
9175
8711
  this.request<EncompassFieldListItem[], ProblemDetails>({
@@ -9187,10 +8723,10 @@ export class Api<
9187
8723
  * @name GetUserPackages
9188
8724
  * @request GET:/api/los/encompass/eclose/packages
9189
8725
  * @secure
9190
- * @response `200` `EncompassPackageList` Success
8726
+ * @response `200` `EncompassPackageList` OK
9191
8727
  * @response `400` `EncompassError` Bad Request
9192
8728
  * @response `401` `EncompassError` Unauthorized
9193
- * @response `500` `EncompassError` Server Error
8729
+ * @response `500` `EncompassError` Internal Server Error
9194
8730
  */
9195
8731
  getUserPackages: (
9196
8732
  query?: {
@@ -9228,9 +8764,9 @@ export class Api<
9228
8764
  * @name GetUserRecipients
9229
8765
  * @request GET:/api/los/encompass/eclose/recipients
9230
8766
  * @secure
9231
- * @response `200` `(EncompassRecipientItem)[]` Success
8767
+ * @response `200` `(EncompassRecipientItem)[]` OK
9232
8768
  * @response `401` `EncompassError` Unauthorized
9233
- * @response `500` `EncompassError` Server Error
8769
+ * @response `500` `EncompassError` Internal Server Error
9234
8770
  */
9235
8771
  getUserRecipients: (params: RequestParams = {}) =>
9236
8772
  this.request<EncompassRecipientItem[], EncompassError>({
@@ -9248,12 +8784,12 @@ export class Api<
9248
8784
  * @name CreateEncompassSession
9249
8785
  * @request POST:/api/los/encompass/eclose/sessions
9250
8786
  * @secure
9251
- * @response `200` `CreateSession` Success
8787
+ * @response `200` `CreateSession` OK
9252
8788
  * @response `400` `EncompassError` Bad Request
9253
8789
  * @response `401` `EncompassError` Unauthorized
9254
8790
  * @response `403` `EncompassError` Forbidden
9255
8791
  * @response `404` `EncompassError` Not Found
9256
- * @response `500` `EncompassError` Server Error
8792
+ * @response `500` `EncompassError` Internal Server Error
9257
8793
  */
9258
8794
  createEncompassSession: (
9259
8795
  data: CreateSessionRequest,
@@ -9277,7 +8813,7 @@ export class Api<
9277
8813
  * @summary Get All
9278
8814
  * @request GET:/api/files
9279
8815
  * @secure
9280
- * @response `200` `FilePaginated` Success
8816
+ * @response `200` `FilePaginated` OK
9281
8817
  */
9282
8818
  getAllFiles: (
9283
8819
  query?: {
@@ -9310,7 +8846,7 @@ export class Api<
9310
8846
  * @request POST:/api/files
9311
8847
  * @secure
9312
8848
  * @response `201` `File` Created
9313
- * @response `422` `UnprocessableEntity` Client Error
8849
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9314
8850
  */
9315
8851
  uploadFile: (
9316
8852
  data: {
@@ -9359,8 +8895,8 @@ export class Api<
9359
8895
  * @summary Replace
9360
8896
  * @request PUT:/api/files/{id}
9361
8897
  * @secure
9362
- * @response `200` `string` Success
9363
- * @response `422` `UnprocessableEntity` Client Error
8898
+ * @response `200` `string` OK
8899
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9364
8900
  */
9365
8901
  replaceFile: (id: string, data: FileRequest, params: RequestParams = {}) =>
9366
8902
  this.request<string, UnprocessableEntity>({
@@ -9399,7 +8935,7 @@ export class Api<
9399
8935
  * @summary Search
9400
8936
  * @request POST:/api/files/search
9401
8937
  * @secure
9402
- * @response `200` `FilePaginated` Success
8938
+ * @response `200` `FilePaginated` OK
9403
8939
  */
9404
8940
  searchFiles: (
9405
8941
  data: FileSearchCriteria,
@@ -9432,7 +8968,7 @@ export class Api<
9432
8968
  * @summary Get All
9433
8969
  * @request GET:/api/forms
9434
8970
  * @secure
9435
- * @response `200` `(AdminAccessGetForms)[]` Success
8971
+ * @response `200` `(AdminAccessGetForms)[]` OK
9436
8972
  */
9437
8973
  getForms: (
9438
8974
  query?: {
@@ -9458,7 +8994,7 @@ export class Api<
9458
8994
  * @request POST:/api/forms
9459
8995
  * @secure
9460
8996
  * @response `201` `Form` Created
9461
- * @response `422` `UnprocessableEntity` Client Error
8997
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9462
8998
  */
9463
8999
  createForm: (data: FormRequest, params: RequestParams = {}) =>
9464
9000
  this.request<Form, UnprocessableEntity>({
@@ -9479,7 +9015,7 @@ export class Api<
9479
9015
  * @summary Get By ID
9480
9016
  * @request GET:/api/forms/{id}
9481
9017
  * @secure
9482
- * @response `200` `Form` Success
9018
+ * @response `200` `Form` OK
9483
9019
  */
9484
9020
  getForm: (id: string, params: RequestParams = {}) =>
9485
9021
  this.request<Form, any>({
@@ -9498,8 +9034,8 @@ export class Api<
9498
9034
  * @summary Replace
9499
9035
  * @request PUT:/api/forms/{id}
9500
9036
  * @secure
9501
- * @response `200` `Form` Success
9502
- * @response `422` `UnprocessableEntity` Client Error
9037
+ * @response `200` `Form` OK
9038
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9503
9039
  */
9504
9040
  replaceForm: (id: string, data: FormRequest, params: RequestParams = {}) =>
9505
9041
  this.request<Form, UnprocessableEntity>({
@@ -9538,7 +9074,7 @@ export class Api<
9538
9074
  * @summary Restore
9539
9075
  * @request POST:/api/forms/{id}/restore
9540
9076
  * @secure
9541
- * @response `200` `Form` Success
9077
+ * @response `200` `Form` OK
9542
9078
  */
9543
9079
  restoreForm: (id: string, params: RequestParams = {}) =>
9544
9080
  this.request<Form, any>({
@@ -9557,7 +9093,7 @@ export class Api<
9557
9093
  * @summary Add
9558
9094
  * @request POST:/api/form-submissions/{formSubmissionId}/files
9559
9095
  * @secure
9560
- * @response `200` `FormSubmissionFile` Success
9096
+ * @response `200` `FormSubmissionFile` OK
9561
9097
  */
9562
9098
  addFormSubmissionFile: (
9563
9099
  formSubmissionId: string,
@@ -9608,7 +9144,7 @@ export class Api<
9608
9144
  * @summary Download by Id
9609
9145
  * @request GET:/api/form-submissions/{formSubmissionId}/files/{formSubmissionFileId}/download
9610
9146
  * @secure
9611
- * @response `200` `FileWithBytes` Success
9147
+ * @response `200` `FileWithBytes` OK
9612
9148
  */
9613
9149
  downloadFormSubmissionFile: (
9614
9150
  formSubmissionFileId: string,
@@ -9636,7 +9172,7 @@ export class Api<
9636
9172
  * @summary Get All
9637
9173
  * @request GET:/api/form-submissions
9638
9174
  * @secure
9639
- * @response `200` `FormSubmissionPaginated` Success
9175
+ * @response `200` `FormSubmissionPaginated` OK
9640
9176
  */
9641
9177
  getFormSubmissions: (
9642
9178
  query?: {
@@ -9694,7 +9230,7 @@ export class Api<
9694
9230
  * @summary Get by ID
9695
9231
  * @request GET:/api/form-submissions/{id}
9696
9232
  * @secure
9697
- * @response `200` `FormSubmission` Success
9233
+ * @response `200` `FormSubmission` OK
9698
9234
  */
9699
9235
  getFormSubmission: (id: string, params: RequestParams = {}) =>
9700
9236
  this.request<FormSubmission, any>({
@@ -9713,7 +9249,7 @@ export class Api<
9713
9249
  * @summary Replace
9714
9250
  * @request PUT:/api/form-submissions/{id}
9715
9251
  * @secure
9716
- * @response `200` `FormSubmission` Success
9252
+ * @response `200` `FormSubmission` OK
9717
9253
  */
9718
9254
  replaceFormSubmission: (
9719
9255
  id: string,
@@ -9756,7 +9292,7 @@ export class Api<
9756
9292
  * @summary Search
9757
9293
  * @request POST:/api/form-submissions/search
9758
9294
  * @secure
9759
- * @response `200` `FormSubmissionPaginated` Success
9295
+ * @response `200` `FormSubmissionPaginated` OK
9760
9296
  */
9761
9297
  searchFormSubmissions: (
9762
9298
  data: FormSubmissionSearchCriteria,
@@ -9789,7 +9325,7 @@ export class Api<
9789
9325
  * @summary Get All
9790
9326
  * @request GET:/api/forms/{formId}/versions
9791
9327
  * @secure
9792
- * @response `200` `(FormVersion)[]` Success
9328
+ * @response `200` `(FormVersion)[]` OK
9793
9329
  */
9794
9330
  getFormVersions: (formId: string, params: RequestParams = {}) =>
9795
9331
  this.request<FormVersion[], any>({
@@ -9808,7 +9344,7 @@ export class Api<
9808
9344
  * @summary Create
9809
9345
  * @request POST:/api/forms/{formId}/versions
9810
9346
  * @secure
9811
- * @response `200` `FormVersion` Success
9347
+ * @response `200` `FormVersion` OK
9812
9348
  */
9813
9349
  createFormVersion: (
9814
9350
  formId: string,
@@ -9833,7 +9369,7 @@ export class Api<
9833
9369
  * @summary Get by ID
9834
9370
  * @request GET:/api/forms/{formId}/versions/{id}
9835
9371
  * @secure
9836
- * @response `200` `FormVersion` Success
9372
+ * @response `200` `FormVersion` OK
9837
9373
  */
9838
9374
  getFormVersion: (formId: string, id: string, params: RequestParams = {}) =>
9839
9375
  this.request<FormVersion, any>({
@@ -9852,7 +9388,7 @@ export class Api<
9852
9388
  * @summary Replace
9853
9389
  * @request PUT:/api/forms/{formId}/versions/{id}
9854
9390
  * @secure
9855
- * @response `200` `FormVersion` Success
9391
+ * @response `200` `FormVersion` OK
9856
9392
  */
9857
9393
  replaceFormVersion: (
9858
9394
  formId: string,
@@ -9878,7 +9414,7 @@ export class Api<
9878
9414
  * @summary Delete
9879
9415
  * @request DELETE:/api/forms/{formId}/versions/{id}
9880
9416
  * @secure
9881
- * @response `200` `FormVersion` Success
9417
+ * @response `200` `FormVersion` OK
9882
9418
  */
9883
9419
  deleteFormVersion: (
9884
9420
  formId: string,
@@ -9901,7 +9437,7 @@ export class Api<
9901
9437
  * @summary Get Integration Settings
9902
9438
  * @request GET:/api/integrations/settings
9903
9439
  * @secure
9904
- * @response `200` `IntegrationSettings` Success
9440
+ * @response `200` `IntegrationSettings` OK
9905
9441
  */
9906
9442
  getIntegrationSettings: (params: RequestParams = {}) =>
9907
9443
  this.request<IntegrationSettings, any>({
@@ -9920,7 +9456,7 @@ export class Api<
9920
9456
  * @summary Get By ID
9921
9457
  * @request GET:/api/los/loan/application/{loanID}
9922
9458
  * @secure
9923
- * @response `200` `Record<string,any>` Success
9459
+ * @response `200` `Record<string,any>` OK
9924
9460
  */
9925
9461
  getLoanData: (loanId: string, params: RequestParams = {}) =>
9926
9462
  this.request<Record<string, any>, any>({
@@ -9940,8 +9476,8 @@ export class Api<
9940
9476
  * @request PATCH:/api/los/loan/application/{loanID}
9941
9477
  * @deprecated
9942
9478
  * @secure
9943
- * @response `200` `string` Success
9944
- * @response `422` `UnprocessableEntity` Client Error
9479
+ * @response `200` `string` OK
9480
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9945
9481
  */
9946
9482
  updateLoanConsentAndCustomFieldsObsolete: (
9947
9483
  loanId: string,
@@ -9966,7 +9502,7 @@ export class Api<
9966
9502
  * @summary Get Report
9967
9503
  * @request POST:/api/los/loan/reports
9968
9504
  * @secure
9969
- * @response `200` `GetReport` Success
9505
+ * @response `200` `GetReport` OK
9970
9506
  */
9971
9507
  getLoansReport: (data: GetReportRequest, params: RequestParams = {}) =>
9972
9508
  this.request<GetReport, any>({
@@ -9988,9 +9524,9 @@ export class Api<
9988
9524
  * @request POST:/api/los/loan/application
9989
9525
  * @deprecated
9990
9526
  * @secure
9991
- * @response `200` `string` Success
9992
- * @response `422` `UnprocessableEntity` Client Error
9993
- * @response `423` `UnprocessableEntity` Client Error
9527
+ * @response `200` `string` OK
9528
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9529
+ * @response `423` `UnprocessableEntity` Locked
9994
9530
  */
9995
9531
  createLoan: (
9996
9532
  data: any,
@@ -10019,9 +9555,9 @@ export class Api<
10019
9555
  * @summary Create Loan Returning Internal Loan ID
10020
9556
  * @request POST:/api/los/loan/application/internal
10021
9557
  * @secure
10022
- * @response `200` `string` Success
10023
- * @response `422` `UnprocessableEntity` Client Error
10024
- * @response `423` `UnprocessableEntity` Client Error
9558
+ * @response `200` `string` OK
9559
+ * @response `422` `UnprocessableEntity` Unprocessable Content
9560
+ * @response `423` `UnprocessableEntity` Locked
10025
9561
  */
10026
9562
  createLoanInternal: (
10027
9563
  data: any,
@@ -10050,8 +9586,8 @@ export class Api<
10050
9586
  * @summary Update Loan Custom Fields
10051
9587
  * @request PATCH:/api/los/loan/application/{loanID}/custom-fields
10052
9588
  * @secure
10053
- * @response `200` `string` Success
10054
- * @response `422` `UnprocessableEntity` Client Error
9589
+ * @response `200` `string` OK
9590
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10055
9591
  */
10056
9592
  updateLoanCustomFields: (
10057
9593
  loanId: string,
@@ -10076,9 +9612,9 @@ export class Api<
10076
9612
  * @summary Update Loan Consent and Custom Fields
10077
9613
  * @request PATCH:/api/los/loan/application/{loanID}/consent
10078
9614
  * @secure
10079
- * @response `200` `string` Success
9615
+ * @response `200` `string` OK
10080
9616
  * @response `202` `string` Accepted
10081
- * @response `422` `UnprocessableEntity` Client Error
9617
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10082
9618
  */
10083
9619
  updateLoanConsent: (
10084
9620
  loanId: string,
@@ -10103,7 +9639,7 @@ export class Api<
10103
9639
  * @summary Get Documents
10104
9640
  * @request GET:/api/los/loan/tasks/documents/{loanID}
10105
9641
  * @secure
10106
- * @response `200` `(DocumentData)[]` Success
9642
+ * @response `200` `(DocumentData)[]` OK
10107
9643
  */
10108
9644
  getTaskDocumentsByLoan: (loanId: string, params: RequestParams = {}) =>
10109
9645
  this.request<DocumentData[], any>({
@@ -10122,7 +9658,7 @@ export class Api<
10122
9658
  * @summary Get Document Content
10123
9659
  * @request GET:/api/los/loan/{loanID}/document/{documentId}/content
10124
9660
  * @secure
10125
- * @response `200` `void` Success
9661
+ * @response `200` `void` OK
10126
9662
  */
10127
9663
  getLoanDocumentContent: (
10128
9664
  loanId: string,
@@ -10167,7 +9703,7 @@ export class Api<
10167
9703
  * @summary Get Preliminary Conditions
10168
9704
  * @request GET:/api/los/loan/{loanID}/conditions/preliminary
10169
9705
  * @secure
10170
- * @response `200` `(PreliminaryCondition)[]` Success
9706
+ * @response `200` `(PreliminaryCondition)[]` OK
10171
9707
  */
10172
9708
  getPreliminaryConditionsForLoan: (
10173
9709
  loanId: string,
@@ -10189,7 +9725,7 @@ export class Api<
10189
9725
  * @summary Get Underwriting Conditions
10190
9726
  * @request GET:/api/los/loan/{loanID}/conditions/underwriting
10191
9727
  * @secure
10192
- * @response `200` `(UnderwritingCondition)[]` Success
9728
+ * @response `200` `(UnderwritingCondition)[]` OK
10193
9729
  */
10194
9730
  getUnderwritingConditionsForLoan: (
10195
9731
  loanId: string,
@@ -10211,7 +9747,7 @@ export class Api<
10211
9747
  * @summary Get Embedded Signing Link
10212
9748
  * @request POST:/api/los/loan/embeddedsigning/{envelopeId}/{userName}/{email}
10213
9749
  * @secure
10214
- * @response `200` `string` Success
9750
+ * @response `200` `string` OK
10215
9751
  */
10216
9752
  getLoanEmbeddedSigningLink: (
10217
9753
  envelopeId: string,
@@ -10236,7 +9772,7 @@ export class Api<
10236
9772
  * @request POST:/api/los/loan/generatedocument
10237
9773
  * @deprecated
10238
9774
  * @secure
10239
- * @response `200` `DocumentDataRequest` Success
9775
+ * @response `200` `DocumentDataRequest` OK
10240
9776
  */
10241
9777
  createLegacyLoanDocument: (
10242
9778
  data: GenerateDocumentRequest,
@@ -10260,10 +9796,10 @@ export class Api<
10260
9796
  * @summary Create Edit Draft for Loan
10261
9797
  * @request PUT:/api/los/loan/{loanID}/edit
10262
9798
  * @secure
10263
- * @response `200` `Draft` Success
9799
+ * @response `200` `Draft` OK
10264
9800
  * @response `400` `ProblemDetails` Bad Request
10265
9801
  * @response `404` `ProblemDetails` Not Found
10266
- * @response `423` `ProblemDetails` Client Error
9802
+ * @response `423` `ProblemDetails` Locked
10267
9803
  */
10268
9804
  createEditDraftForLoan: (
10269
9805
  loanId: string,
@@ -10290,7 +9826,7 @@ export class Api<
10290
9826
  * @summary Add
10291
9827
  * @request POST:/api/listings/{listingId}/files
10292
9828
  * @secure
10293
- * @response `200` `ListingFile` Success
9829
+ * @response `200` `ListingFile` OK
10294
9830
  */
10295
9831
  addListingFile: (
10296
9832
  listingId: string,
@@ -10320,7 +9856,7 @@ export class Api<
10320
9856
  * @summary Update
10321
9857
  * @request PATCH:/api/listings/{listingId}/files
10322
9858
  * @secure
10323
- * @response `200` `ListingFile` Success
9859
+ * @response `200` `ListingFile` OK
10324
9860
  */
10325
9861
  updateListingFiles: (
10326
9862
  listingId: string,
@@ -10368,7 +9904,7 @@ export class Api<
10368
9904
  * @summary Add
10369
9905
  * @request POST:/api/listings/{listingId}/photos
10370
9906
  * @secure
10371
- * @response `200` `ListingPhoto` Success
9907
+ * @response `200` `ListingPhoto` OK
10372
9908
  */
10373
9909
  addListingPhoto: (
10374
9910
  listingId: string,
@@ -10400,7 +9936,7 @@ export class Api<
10400
9936
  * @summary Update
10401
9937
  * @request PATCH:/api/listings/{listingId}/photos
10402
9938
  * @secure
10403
- * @response `200` `(ListingPhoto)[]` Success
9939
+ * @response `200` `(ListingPhoto)[]` OK
10404
9940
  */
10405
9941
  updateListingPhotos: (
10406
9942
  listingId: string,
@@ -10448,7 +9984,7 @@ export class Api<
10448
9984
  * @summary Get All
10449
9985
  * @request GET:/api/listings
10450
9986
  * @secure
10451
- * @response `200` `ListingPaginated` Success
9987
+ * @response `200` `ListingPaginated` OK
10452
9988
  */
10453
9989
  getListings: (
10454
9990
  query?: {
@@ -10499,7 +10035,7 @@ export class Api<
10499
10035
  * @summary Get by Slug
10500
10036
  * @request GET:/api/listings/slug/{slug}
10501
10037
  * @secure
10502
- * @response `200` `Listing` Success
10038
+ * @response `200` `Listing` OK
10503
10039
  */
10504
10040
  getListingBySlug: (slug: string, params: RequestParams = {}) =>
10505
10041
  this.request<Listing, any>({
@@ -10518,7 +10054,7 @@ export class Api<
10518
10054
  * @summary Get by ID
10519
10055
  * @request GET:/api/listings/{id}
10520
10056
  * @secure
10521
- * @response `200` `Listing` Success
10057
+ * @response `200` `Listing` OK
10522
10058
  */
10523
10059
  getListing: (id: string, params: RequestParams = {}) =>
10524
10060
  this.request<Listing, any>({
@@ -10537,7 +10073,7 @@ export class Api<
10537
10073
  * @summary Replace
10538
10074
  * @request PUT:/api/listings/{id}
10539
10075
  * @secure
10540
- * @response `200` `Listing` Success
10076
+ * @response `200` `Listing` OK
10541
10077
  */
10542
10078
  replaceListing: (
10543
10079
  id: string,
@@ -10580,7 +10116,7 @@ export class Api<
10580
10116
  * @summary Search
10581
10117
  * @request POST:/api/listings/search
10582
10118
  * @secure
10583
- * @response `200` `ListingPaginated` Success
10119
+ * @response `200` `ListingPaginated` OK
10584
10120
  */
10585
10121
  searchListings: (
10586
10122
  data: ListingSearchCriteria,
@@ -10613,7 +10149,7 @@ export class Api<
10613
10149
  * @summary Update Background Image
10614
10150
  * @request PUT:/api/listings/{id}/background-image
10615
10151
  * @secure
10616
- * @response `200` `File` Success
10152
+ * @response `200` `File` OK
10617
10153
  */
10618
10154
  updateListingBackgroundImage: (
10619
10155
  id: string,
@@ -10659,7 +10195,7 @@ export class Api<
10659
10195
  * @summary Get Open House Flyer
10660
10196
  * @request GET:/api/listings/{id}/open-house-flyer
10661
10197
  * @secure
10662
- * @response `200` `File` Success
10198
+ * @response `200` `File` OK
10663
10199
  */
10664
10200
  getListingOpenHouseFlyer: (id: string, params: RequestParams = {}) =>
10665
10201
  this.request<File, any>({
@@ -10678,7 +10214,7 @@ export class Api<
10678
10214
  * @summary Get
10679
10215
  * @request GET:/api/loans/{loanID}/calculators/loan-calculator
10680
10216
  * @secure
10681
- * @response `200` `RunLOCalculation` Success
10217
+ * @response `200` `RunLOCalculation` OK
10682
10218
  */
10683
10219
  getLoanCalculator: (loanId: string, params: RequestParams = {}) =>
10684
10220
  this.request<RunLOCalculation, any>({
@@ -10697,9 +10233,9 @@ export class Api<
10697
10233
  * @summary Run
10698
10234
  * @request POST:/api/loans/{loanID}/calculators/loan-calculator
10699
10235
  * @secure
10700
- * @response `200` `RunLOCalculation` Success
10701
- * @response `422` `UnprocessableEntity` Client Error
10702
- * @response `423` `UnprocessableEntity` Client Error
10236
+ * @response `200` `RunLOCalculation` OK
10237
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10238
+ * @response `423` `UnprocessableEntity` Locked
10703
10239
  */
10704
10240
  runLoanCalculator: (
10705
10241
  loanId: string,
@@ -10724,7 +10260,7 @@ export class Api<
10724
10260
  * @summary Get All
10725
10261
  * @request GET:/api/loans/{loanID}/loan-comparison
10726
10262
  * @secure
10727
- * @response `200` `LoanComparison` Success
10263
+ * @response `200` `LoanComparison` OK
10728
10264
  */
10729
10265
  getLoanComparisons: (loanId: string, params: RequestParams = {}) =>
10730
10266
  this.request<LoanComparison, any>({
@@ -10744,8 +10280,8 @@ export class Api<
10744
10280
  * @request POST:/api/loans/{loanID}/loan-comparison/{index}
10745
10281
  * @secure
10746
10282
  * @response `201` `LoanComparisonScenario` Created
10747
- * @response `422` `UnprocessableEntity` Client Error
10748
- * @response `423` `UnprocessableEntity` Client Error
10283
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10284
+ * @response `423` `UnprocessableEntity` Locked
10749
10285
  */
10750
10286
  createLoanComparison: (
10751
10287
  loanId: string,
@@ -10794,7 +10330,7 @@ export class Api<
10794
10330
  * @request POST:/api/loans/{loanID}/loan-comparison/pdf
10795
10331
  * @secure
10796
10332
  * @response `204` `void` No Content
10797
- * @response `422` `UnprocessableEntity` Client Error
10333
+ * @response `422` `UnprocessableEntity` Unprocessable Content
10798
10334
  */
10799
10335
  createLoanComparisonPdf: (
10800
10336
  loanId: string,
@@ -10820,7 +10356,7 @@ export class Api<
10820
10356
  * @secure
10821
10357
  * @response `204` `void` No Content
10822
10358
  * @response `404` `ProblemDetails` Not Found
10823
- * @response `422` `ProblemDetails` Client Error
10359
+ * @response `422` `ProblemDetails` Unprocessable Content
10824
10360
  */
10825
10361
  resyncLoanConsents: (loanId: string, params: RequestParams = {}) =>
10826
10362
  this.request<void, ProblemDetails>({
@@ -10838,7 +10374,7 @@ export class Api<
10838
10374
  * @summary Get all custom field values for a loan
10839
10375
  * @request GET:/api/loans/{loanId}/custom-fields
10840
10376
  * @secure
10841
- * @response `200` `(CustomFieldValue)[]` Success
10377
+ * @response `200` `(CustomFieldValue)[]` OK
10842
10378
  */
10843
10379
  getLoanCustomFieldValues: (loanId: string, params: RequestParams = {}) =>
10844
10380
  this.request<CustomFieldValue[], any>({
@@ -10859,7 +10395,7 @@ export class Api<
10859
10395
  * @secure
10860
10396
  * @response `204` `void` No Content
10861
10397
  * @response `400` `ProblemDetails` Bad Request
10862
- * @response `422` `ProblemDetails` Client Error
10398
+ * @response `422` `ProblemDetails` Unprocessable Content
10863
10399
  */
10864
10400
  bulkSetLoanCustomFieldValues: (
10865
10401
  loanId: string,
@@ -10886,7 +10422,7 @@ export class Api<
10886
10422
  * @response `204` `void` No Content
10887
10423
  * @response `400` `ProblemDetails` Bad Request
10888
10424
  * @response `404` `ProblemDetails` Not Found
10889
- * @response `422` `ProblemDetails` Client Error
10425
+ * @response `422` `ProblemDetails` Unprocessable Content
10890
10426
  */
10891
10427
  setLoanCustomFieldValue: (
10892
10428
  loanId: string,
@@ -10934,7 +10470,7 @@ export class Api<
10934
10470
  * @summary Get All
10935
10471
  * @request GET:/api/loans/{loanId}/documents/buckets
10936
10472
  * @secure
10937
- * @response `200` `(string)[]` Success
10473
+ * @response `200` `(string)[]` OK
10938
10474
  */
10939
10475
  getLoanDocumentBuckets: (loanId: string, params: RequestParams = {}) =>
10940
10476
  this.request<string[], any>({
@@ -10978,7 +10514,7 @@ export class Api<
10978
10514
  * @summary Get all loan document folders for the current account
10979
10515
  * @request GET:/api/loan-document-folders
10980
10516
  * @secure
10981
- * @response `200` `(LoanDocumentFolder)[]` Success
10517
+ * @response `200` `(LoanDocumentFolder)[]` OK
10982
10518
  */
10983
10519
  getAllLoanDocumentFolders: (params: RequestParams = {}) =>
10984
10520
  this.request<LoanDocumentFolder[], any>({
@@ -10999,7 +10535,7 @@ export class Api<
10999
10535
  * @secure
11000
10536
  * @response `201` `LoanDocumentFolder` Created
11001
10537
  * @response `409` `ProblemDetails` Conflict
11002
- * @response `422` `ProblemDetails` Client Error
10538
+ * @response `422` `ProblemDetails` Unprocessable Content
11003
10539
  */
11004
10540
  createLoanDocumentFolder: (
11005
10541
  data: CreateLoanDocumentFolderRequest,
@@ -11023,7 +10559,7 @@ export class Api<
11023
10559
  * @summary Get a loan document folder by ID
11024
10560
  * @request GET:/api/loan-document-folders/{id}
11025
10561
  * @secure
11026
- * @response `200` `LoanDocumentFolder` Success
10562
+ * @response `200` `LoanDocumentFolder` OK
11027
10563
  * @response `404` `ProblemDetails` Not Found
11028
10564
  */
11029
10565
  getLoanDocumentFolderById: (id: string, params: RequestParams = {}) =>
@@ -11043,11 +10579,11 @@ export class Api<
11043
10579
  * @summary Update a loan document folder. Blocked when folder has ever been referenced, except for permission edits on the system-default Unassigned folder.
11044
10580
  * @request PUT:/api/loan-document-folders/{id}
11045
10581
  * @secure
11046
- * @response `200` `LoanDocumentFolder` Success
10582
+ * @response `200` `LoanDocumentFolder` OK
11047
10583
  * @response `400` `ProblemDetails` Bad Request
11048
10584
  * @response `404` `ProblemDetails` Not Found
11049
10585
  * @response `409` `ProblemDetails` Conflict
11050
- * @response `422` `ProblemDetails` Client Error
10586
+ * @response `422` `ProblemDetails` Unprocessable Content
11051
10587
  */
11052
10588
  updateLoanDocumentFolder: (
11053
10589
  id: string,
@@ -11132,7 +10668,7 @@ export class Api<
11132
10668
  * @summary Get folder usage. Returns HasEverBeenReferenced including soft-deleted documents and tasks.
11133
10669
  * @request GET:/api/loan-document-folders/{id}/usage
11134
10670
  * @secure
11135
- * @response `200` `LoanDocumentFolderUsage` Success
10671
+ * @response `200` `LoanDocumentFolderUsage` OK
11136
10672
  * @response `404` `ProblemDetails` Not Found
11137
10673
  */
11138
10674
  getLoanDocumentFolderUsage: (id: string, params: RequestParams = {}) =>
@@ -11152,7 +10688,7 @@ export class Api<
11152
10688
  * @summary Get By ID
11153
10689
  * @request GET:/api/loans/{loanId}/documents/{documentId}
11154
10690
  * @secure
11155
- * @response `200` `LoanDocument` Success
10691
+ * @response `200` `LoanDocument` OK
11156
10692
  * @response `404` `ProblemDetails` Not Found
11157
10693
  */
11158
10694
  getLoanDocument: (
@@ -11181,7 +10717,7 @@ export class Api<
11181
10717
  * @summary Get document previews in batch
11182
10718
  * @request POST:/api/loans/{loanId}/documents/previews
11183
10719
  * @secure
11184
- * @response `200` `Record<string,string>` Success
10720
+ * @response `200` `Record<string,string>` OK
11185
10721
  * @response `400` `ProblemDetails` Bad Request
11186
10722
  */
11187
10723
  getLoanDocumentPreviews: (
@@ -11207,7 +10743,7 @@ export class Api<
11207
10743
  * @summary Search loan documents
11208
10744
  * @request POST:/api/loans/{loanId}/documents/search
11209
10745
  * @secure
11210
- * @response `200` `LoanDocumentSearchPaginated` Success
10746
+ * @response `200` `LoanDocumentSearchPaginated` OK
11211
10747
  */
11212
10748
  searchLoanDocuments: (
11213
10749
  loanId: string,
@@ -11241,7 +10777,7 @@ export class Api<
11241
10777
  * @summary Get document folder hierarchy
11242
10778
  * @request POST:/api/loans/{loanId}/documents/folders
11243
10779
  * @secure
11244
- * @response `200` `(DocumentFolder)[]` Success
10780
+ * @response `200` `(DocumentFolder)[]` OK
11245
10781
  */
11246
10782
  getLoanDocumentFolders: (
11247
10783
  loanId: string,
@@ -11271,7 +10807,7 @@ export class Api<
11271
10807
  * @summary Download By ID
11272
10808
  * @request GET:/api/loans/{loanId}/documents/{documentId}/download
11273
10809
  * @secure
11274
- * @response `200` `Blob` Success
10810
+ * @response `200` `Blob` OK
11275
10811
  * @response `404` `ProblemDetails` Not Found
11276
10812
  */
11277
10813
  downloadLoanDocument: (
@@ -11297,7 +10833,7 @@ export class Api<
11297
10833
  * @secure
11298
10834
  * @response `201` `LoanDocument` Created
11299
10835
  * @response `404` `ProblemDetails` Not Found
11300
- * @response `422` `UnprocessableEntity` Client Error
10836
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11301
10837
  */
11302
10838
  createLoanDocument: (
11303
10839
  loanId: string,
@@ -11329,9 +10865,9 @@ export class Api<
11329
10865
  * @summary Retry
11330
10866
  * @request POST:/api/loans/{loanId}/documents/{documentId}/retry
11331
10867
  * @secure
11332
- * @response `200` `LoanDocument` Success
10868
+ * @response `200` `LoanDocument` OK
11333
10869
  * @response `404` `ProblemDetails` Not Found
11334
- * @response `422` `UnprocessableEntity` Client Error
10870
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11335
10871
  */
11336
10872
  retryFailedLoanDocument: (
11337
10873
  loanId: string,
@@ -11354,7 +10890,7 @@ export class Api<
11354
10890
  * @summary Generate PDF Document
11355
10891
  * @request POST:/api/loans/{loanId}/documents/generate
11356
10892
  * @secure
11357
- * @response `200` `DocumentDataRequest` Success
10893
+ * @response `200` `DocumentDataRequest` OK
11358
10894
  */
11359
10895
  generateLoanDocument: (
11360
10896
  loanId: string,
@@ -11379,7 +10915,7 @@ export class Api<
11379
10915
  * @summary Send existing documents to loan users or external emails
11380
10916
  * @request POST:/api/loans/{loanId}/documents/distribute
11381
10917
  * @secure
11382
- * @response `200` `void` Success
10918
+ * @response `200` `void` OK
11383
10919
  * @response `400` `ProblemDetails` Bad Request
11384
10920
  * @response `404` `ProblemDetails` Not Found
11385
10921
  */
@@ -11405,7 +10941,7 @@ export class Api<
11405
10941
  * @summary Sync documents from LOS
11406
10942
  * @request POST:/api/loans/{loanId}/documents/sync
11407
10943
  * @secure
11408
- * @response `200` `DocumentSync` Success
10944
+ * @response `200` `DocumentSync` OK
11409
10945
  * @response `404` `ProblemDetails` Not Found
11410
10946
  */
11411
10947
  syncLoanDocumentsFromLos: (loanId: string, params: RequestParams = {}) =>
@@ -11425,9 +10961,9 @@ export class Api<
11425
10961
  * @summary Retry syncing a document to LOS
11426
10962
  * @request POST:/api/loans/{loanId}/documents/{documentId}/sync/retry
11427
10963
  * @secure
11428
- * @response `200` `void` Success
10964
+ * @response `200` `void` OK
11429
10965
  * @response `404` `ProblemDetails` Not Found
11430
- * @response `423` `ProblemDetails` Client Error
10966
+ * @response `423` `ProblemDetails` Locked
11431
10967
  */
11432
10968
  retrySyncLoanDocumentToLos: (
11433
10969
  loanId: string,
@@ -11470,7 +11006,7 @@ export class Api<
11470
11006
  * @summary Get All
11471
11007
  * @request GET:/api/loans/drafts
11472
11008
  * @secure
11473
- * @response `200` `(DraftContent)[]` Success
11009
+ * @response `200` `(DraftContent)[]` OK
11474
11010
  */
11475
11011
  getLoanDrafts: (params: RequestParams = {}) =>
11476
11012
  this.request<DraftContent[], any>({
@@ -11489,7 +11025,7 @@ export class Api<
11489
11025
  * @summary Get by ID
11490
11026
  * @request GET:/api/loans/drafts/{draftId}
11491
11027
  * @secure
11492
- * @response `200` `DraftContent` Success
11028
+ * @response `200` `DraftContent` OK
11493
11029
  */
11494
11030
  getLoanDraft: (draftId: string, params: RequestParams = {}) =>
11495
11031
  this.request<DraftContent, any>({
@@ -11508,7 +11044,7 @@ export class Api<
11508
11044
  * @summary Replace
11509
11045
  * @request PUT:/api/loans/drafts/{draftId}
11510
11046
  * @secure
11511
- * @response `200` `Draft` Success
11047
+ * @response `200` `Draft` OK
11512
11048
  */
11513
11049
  replaceLoanDraft: (
11514
11050
  draftId: string,
@@ -11584,7 +11120,7 @@ export class Api<
11584
11120
  * @summary Reassign Loan officer
11585
11121
  * @request PUT:/api/loans/drafts/{draftId}/reassign
11586
11122
  * @secure
11587
- * @response `200` `Draft` Success
11123
+ * @response `200` `Draft` OK
11588
11124
  */
11589
11125
  reassignLoanOfficer: (
11590
11126
  draftId: string,
@@ -11609,7 +11145,7 @@ export class Api<
11609
11145
  * @summary Restore deleted draft
11610
11146
  * @request POST:/api/loans/drafts/{draftId}/restore
11611
11147
  * @secure
11612
- * @response `200` `Draft` Success
11148
+ * @response `200` `Draft` OK
11613
11149
  */
11614
11150
  restoreLoanDraft: (draftId: string, params: RequestParams = {}) =>
11615
11151
  this.request<Draft, any>({
@@ -11628,7 +11164,7 @@ export class Api<
11628
11164
  * @summary Get Loan Imports
11629
11165
  * @request GET:/api/loan-imports
11630
11166
  * @secure
11631
- * @response `200` `LoanImportPaginated` Success
11167
+ * @response `200` `LoanImportPaginated` OK
11632
11168
  */
11633
11169
  getLoanImports: (
11634
11170
  query?: {
@@ -11684,7 +11220,7 @@ export class Api<
11684
11220
  * @summary Get Loan Import
11685
11221
  * @request GET:/api/loan-imports/{id}
11686
11222
  * @secure
11687
- * @response `200` `LoanImport` Success
11223
+ * @response `200` `LoanImport` OK
11688
11224
  */
11689
11225
  getLoanImport: (id: string, params: RequestParams = {}) =>
11690
11226
  this.request<LoanImport, any>({
@@ -11703,7 +11239,7 @@ export class Api<
11703
11239
  * @summary Get Loan Import Logs
11704
11240
  * @request GET:/api/loan-imports/{id}/logs
11705
11241
  * @secure
11706
- * @response `200` `LoanImportLogPaginated` Success
11242
+ * @response `200` `LoanImportLogPaginated` OK
11707
11243
  */
11708
11244
  getLoanImportLogs: (
11709
11245
  id: string,
@@ -11734,7 +11270,7 @@ export class Api<
11734
11270
  * @summary Get Invites
11735
11271
  * @request GET:/api/loans/{loanId}/invites
11736
11272
  * @secure
11737
- * @response `200` `(Invite)[]` Success
11273
+ * @response `200` `(Invite)[]` OK
11738
11274
  * @response `404` `ProblemDetails` Not Found
11739
11275
  */
11740
11276
  getLoanInvites: (loanId: string, params: RequestParams = {}) =>
@@ -11754,7 +11290,7 @@ export class Api<
11754
11290
  * @summary Invite Contacts
11755
11291
  * @request POST:/api/loans/{loanId}/invites
11756
11292
  * @secure
11757
- * @response `200` `(Invite)[]` Success
11293
+ * @response `200` `(Invite)[]` OK
11758
11294
  * @response `404` `ProblemDetails` Not Found
11759
11295
  */
11760
11296
  inviteLoanContacts: (
@@ -11780,7 +11316,7 @@ export class Api<
11780
11316
  * @summary Search loan logs
11781
11317
  * @request POST:/api/loans/{loanId}/logs/search
11782
11318
  * @secure
11783
- * @response `200` `LoanLogPaginated` Success
11319
+ * @response `200` `LoanLogPaginated` OK
11784
11320
  */
11785
11321
  searchLoanLogs: (
11786
11322
  loanId: string,
@@ -11814,7 +11350,7 @@ export class Api<
11814
11350
  * @summary Get loan log by ID
11815
11351
  * @request GET:/api/loans/{loanId}/logs/{loanLogId}
11816
11352
  * @secure
11817
- * @response `200` `LoanLogDetail` Success
11353
+ * @response `200` `LoanLogDetail` OK
11818
11354
  * @response `404` `ProblemDetails` Not Found
11819
11355
  */
11820
11356
  getLoanLogById: (
@@ -11838,7 +11374,7 @@ export class Api<
11838
11374
  * @summary Get All
11839
11375
  * @request GET:/api/loan-officers
11840
11376
  * @secure
11841
- * @response `200` `BranchUserPaginated` Success
11377
+ * @response `200` `BranchUserPaginated` OK
11842
11378
  */
11843
11379
  getLoanOfficers: (
11844
11380
  query?: {
@@ -11869,7 +11405,7 @@ export class Api<
11869
11405
  * @summary Search
11870
11406
  * @request POST:/api/loan-officers/search
11871
11407
  * @secure
11872
- * @response `200` `BranchUserPaginated` Success
11408
+ * @response `200` `BranchUserPaginated` OK
11873
11409
  */
11874
11410
  searchLoanOfficers: (
11875
11411
  data: LoanOfficerSearchCriteria,
@@ -11902,7 +11438,7 @@ export class Api<
11902
11438
  * @summary Get by ID
11903
11439
  * @request GET:/api/loan-officers/{id}
11904
11440
  * @secure
11905
- * @response `200` `BranchUser` Success
11441
+ * @response `200` `BranchUser` OK
11906
11442
  */
11907
11443
  getLoanOfficer: (id: string, params: RequestParams = {}) =>
11908
11444
  this.request<BranchUser, any>({
@@ -11921,8 +11457,8 @@ export class Api<
11921
11457
  * @summary Create Site Configuration
11922
11458
  * @request POST:/api/loan-officers/{loanOfficerId}/site-configurations
11923
11459
  * @secure
11924
- * @response `200` `SiteConfiguration` Success
11925
- * @response `422` `UnprocessableEntity` Client Error
11460
+ * @response `200` `SiteConfiguration` OK
11461
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11926
11462
  */
11927
11463
  createLoanOfficerSiteConfiguration: (
11928
11464
  loanOfficerId: string,
@@ -11947,7 +11483,7 @@ export class Api<
11947
11483
  * @summary Get Site Configuration
11948
11484
  * @request GET:/api/loan-officers/{loanOfficerId}/site-configurations/{siteConfigurationId}
11949
11485
  * @secure
11950
- * @response `200` `SiteConfigurationWithInherited` Success
11486
+ * @response `200` `SiteConfigurationWithInherited` OK
11951
11487
  */
11952
11488
  getLoanOfficerSiteConfiguration: (
11953
11489
  loanOfficerId: string,
@@ -11970,8 +11506,8 @@ export class Api<
11970
11506
  * @summary Replace Site Configuration
11971
11507
  * @request PUT:/api/loan-officers/{loanOfficerId}/site-configurations/{siteConfigurationId}
11972
11508
  * @secure
11973
- * @response `200` `SiteConfiguration` Success
11974
- * @response `422` `UnprocessableEntity` Client Error
11509
+ * @response `200` `SiteConfiguration` OK
11510
+ * @response `422` `UnprocessableEntity` Unprocessable Content
11975
11511
  */
11976
11512
  replaceLoanOfficerSiteConfiguration: (
11977
11513
  loanOfficerId: string,
@@ -12001,7 +11537,7 @@ export class Api<
12001
11537
  * @summary Search
12002
11538
  * @request POST:/api/loans/queue/search
12003
11539
  * @secure
12004
- * @response `200` `LoanQueuePaginated` Success
11540
+ * @response `200` `LoanQueuePaginated` OK
12005
11541
  */
12006
11542
  searchLoanQueue: (
12007
11543
  data: LoanQueueSearchCriteria,
@@ -12034,7 +11570,7 @@ export class Api<
12034
11570
  * @summary Get Loan Queue Record
12035
11571
  * @request GET:/api/loans/queue/{loanQueueId}
12036
11572
  * @secure
12037
- * @response `200` `any` Success
11573
+ * @response `200` `any` OK
12038
11574
  * @response `404` `ProblemDetails` Not Found
12039
11575
  */
12040
11576
  getLoanQueue: (loanQueueId: string, params: RequestParams = {}) =>
@@ -12054,7 +11590,7 @@ export class Api<
12054
11590
  * @summary Replace Loan Queue Record
12055
11591
  * @request PUT:/api/loans/queue/{loanQueueId}
12056
11592
  * @secure
12057
- * @response `200` `LoanQueueWithData` Success
11593
+ * @response `200` `LoanQueueWithData` OK
12058
11594
  * @response `404` `ProblemDetails` Not Found
12059
11595
  */
12060
11596
  replaceLoanQueue: (
@@ -12118,7 +11654,7 @@ export class Api<
12118
11654
  * @summary Get By ID
12119
11655
  * @request GET:/api/loans/{loanID}
12120
11656
  * @secure
12121
- * @response `200` `Loan` Success
11657
+ * @response `200` `Loan` OK
12122
11658
  * @response `404` `ProblemDetails` Not Found
12123
11659
  */
12124
11660
  getLoan: (loanId: string, params: RequestParams = {}) =>
@@ -12138,7 +11674,7 @@ export class Api<
12138
11674
  * @summary Get Loans
12139
11675
  * @request GET:/api/loans
12140
11676
  * @secure
12141
- * @response `200` `GetApplications` Success
11677
+ * @response `200` `GetApplications` OK
12142
11678
  */
12143
11679
  getLoans: (params: RequestParams = {}) =>
12144
11680
  this.request<GetApplications, any>({
@@ -12181,7 +11717,7 @@ export class Api<
12181
11717
  * @summary Search
12182
11718
  * @request POST:/api/loans/search
12183
11719
  * @secure
12184
- * @response `200` `LoanListPaginated` Success
11720
+ * @response `200` `LoanListPaginated` OK
12185
11721
  */
12186
11722
  searchLoans: (
12187
11723
  data: LoanSearchCriteria,
@@ -12214,7 +11750,7 @@ export class Api<
12214
11750
  * @summary Update loan fields
12215
11751
  * @request PATCH:/api/loans/{loanId}
12216
11752
  * @secure
12217
- * @response `200` `Loan` Success
11753
+ * @response `200` `Loan` OK
12218
11754
  * @response `400` `any` Bad Request
12219
11755
  * @response `401` `ProblemDetails` Unauthorized
12220
11756
  * @response `403` `ProblemDetails` Forbidden
@@ -12263,7 +11799,7 @@ export class Api<
12263
11799
  * @summary Import from LOS
12264
11800
  * @request POST:/api/loans/import-from-los/{loanId}
12265
11801
  * @secure
12266
- * @response `200` `Loan` Success
11802
+ * @response `200` `Loan` OK
12267
11803
  */
12268
11804
  importLoanFromLos: (loanId: string, params: RequestParams = {}) =>
12269
11805
  this.request<Loan, any>({
@@ -12301,7 +11837,7 @@ export class Api<
12301
11837
  * @summary Get outstanding items
12302
11838
  * @request GET:/api/loans/{loanId}/outstanding-items
12303
11839
  * @secure
12304
- * @response `200` `LoanOutstandingItems` Success
11840
+ * @response `200` `LoanOutstandingItems` OK
12305
11841
  * @response `401` `ProblemDetails` Unauthorized
12306
11842
  * @response `403` `ProblemDetails` Forbidden
12307
11843
  */
@@ -12322,7 +11858,7 @@ export class Api<
12322
11858
  * @summary Trigger ASO services
12323
11859
  * @request POST:/api/loans/{loanId}/aso
12324
11860
  * @secure
12325
- * @response `200` `AutomatedService` Success
11861
+ * @response `200` `AutomatedService` OK
12326
11862
  * @response `400` `ProblemDetails` Bad Request
12327
11863
  * @response `404` `ProblemDetails` Not Found
12328
11864
  */
@@ -12349,7 +11885,7 @@ export class Api<
12349
11885
  * @summary Search
12350
11886
  * @request POST:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/search
12351
11887
  * @secure
12352
- * @response `200` `TaskCommentPaginated` Success
11888
+ * @response `200` `TaskCommentPaginated` OK
12353
11889
  * @response `404` `ProblemDetails` Not Found
12354
11890
  */
12355
11891
  searchLoanTaskComments: (
@@ -12385,7 +11921,7 @@ export class Api<
12385
11921
  * @summary Get by ID
12386
11922
  * @request GET:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{id}
12387
11923
  * @secure
12388
- * @response `200` `TaskComment` Success
11924
+ * @response `200` `TaskComment` OK
12389
11925
  * @response `404` `ProblemDetails` Not Found
12390
11926
  */
12391
11927
  getLoanTaskComment: (
@@ -12437,7 +11973,7 @@ export class Api<
12437
11973
  * @summary Replace
12438
11974
  * @request PUT:/api/loans/{loanId}/tasks/{userLoanTaskId}/comments/{commentId}
12439
11975
  * @secure
12440
- * @response `200` `TaskComment` Success
11976
+ * @response `200` `TaskComment` OK
12441
11977
  * @response `404` `ProblemDetails` Not Found
12442
11978
  */
12443
11979
  replaceLoanTaskComment: (
@@ -12491,7 +12027,7 @@ export class Api<
12491
12027
  * @secure
12492
12028
  * @response `201` `UserLoanTask` Created
12493
12029
  * @response `404` `ProblemDetails` Not Found
12494
- * @response `422` `UnprocessableEntity` Client Error
12030
+ * @response `422` `UnprocessableEntity` Unprocessable Content
12495
12031
  */
12496
12032
  createLoanTaskDocument: (
12497
12033
  loanId: string,
@@ -12525,7 +12061,7 @@ export class Api<
12525
12061
  * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/documents/bucket
12526
12062
  * @secure
12527
12063
  * @response `204` `UserLoanTask` No Content
12528
- * @response `422` `UnprocessableEntity` Client Error
12064
+ * @response `422` `UnprocessableEntity` Unprocessable Content
12529
12065
  */
12530
12066
  createLoanTaskDocumentBucket: (
12531
12067
  loanId: string,
@@ -12596,7 +12132,7 @@ export class Api<
12596
12132
  * @summary Search
12597
12133
  * @request POST:/api/loans/tasks/search
12598
12134
  * @secure
12599
- * @response `200` `UserLoanTaskPaginated` Success
12135
+ * @response `200` `UserLoanTaskPaginated` OK
12600
12136
  */
12601
12137
  searchLoanTasks: (
12602
12138
  data: LoanTaskSearchRequest,
@@ -12629,8 +12165,8 @@ export class Api<
12629
12165
  * @summary Search Summary
12630
12166
  * @request POST:/api/loans/tasks/search/summary
12631
12167
  * @secure
12632
- * @response `200` `(LoanTaskStatusSummary)[]` Success
12633
- * @response `422` `UnprocessableEntity` Client Error
12168
+ * @response `200` `(LoanTaskStatusSummary)[]` OK
12169
+ * @response `422` `UnprocessableEntity` Unprocessable Content
12634
12170
  */
12635
12171
  searchLoanTasksSummary: (
12636
12172
  data: LoanTaskSearchRequest,
@@ -12654,7 +12190,7 @@ export class Api<
12654
12190
  * @summary Get All
12655
12191
  * @request GET:/api/loans/{loanID}/tasks
12656
12192
  * @secure
12657
- * @response `200` `(UserLoanTask)[]` Success
12193
+ * @response `200` `(UserLoanTask)[]` OK
12658
12194
  * @response `404` `ProblemDetails` Not Found
12659
12195
  */
12660
12196
  getLoanTasks: (loanId: string, params: RequestParams = {}) =>
@@ -12674,7 +12210,7 @@ export class Api<
12674
12210
  * @summary Get by ID
12675
12211
  * @request GET:/api/loans/{loanID}/tasks/{id}
12676
12212
  * @secure
12677
- * @response `200` `UserLoanTask` Success
12213
+ * @response `200` `UserLoanTask` OK
12678
12214
  * @response `404` `ProblemDetails` Not Found
12679
12215
  */
12680
12216
  getLoanTask: (id: string, loanId: string, params: RequestParams = {}) =>
@@ -12694,7 +12230,7 @@ export class Api<
12694
12230
  * @summary Get Difference
12695
12231
  * @request GET:/api/loans/{loanID}/tasks/diff
12696
12232
  * @secure
12697
- * @response `200` `(UserLoanTask)[]` Success
12233
+ * @response `200` `(UserLoanTask)[]` OK
12698
12234
  * @response `404` `ProblemDetails` Not Found
12699
12235
  */
12700
12236
  getLoanTaskDifference: (loanId: string, params: RequestParams = {}) =>
@@ -12767,7 +12303,7 @@ export class Api<
12767
12303
  * @summary Replace
12768
12304
  * @request PUT:/api/loans/{loanID}/tasks/{userLoanTaskID}
12769
12305
  * @secure
12770
- * @response `200` `UserLoanTask` Success
12306
+ * @response `200` `UserLoanTask` OK
12771
12307
  * @response `404` `ProblemDetails` Not Found
12772
12308
  */
12773
12309
  replaceLoanTask: (
@@ -12817,9 +12353,9 @@ export class Api<
12817
12353
  * @summary Create
12818
12354
  * @request POST:/api/loans/{loanID}/tasks/{loanTaskId}/verifications
12819
12355
  * @secure
12820
- * @response `200` `UserLoanTask` Success
12356
+ * @response `200` `UserLoanTask` OK
12821
12357
  * @response `404` `ProblemDetails` Not Found
12822
- * @response `422` `UnprocessableEntity` Client Error
12358
+ * @response `422` `UnprocessableEntity` Unprocessable Content
12823
12359
  */
12824
12360
  createLoanTaskVerification: (
12825
12361
  loanId: string,
@@ -12842,7 +12378,7 @@ export class Api<
12842
12378
  * @summary Get User Loan Consents
12843
12379
  * @request GET:/api/loans/{loanId}/users/{userId}/consents
12844
12380
  * @secure
12845
- * @response `200` `(UserLoanConsent)[]` Success
12381
+ * @response `200` `(UserLoanConsent)[]` OK
12846
12382
  * @response `403` `ProblemDetails` Forbidden
12847
12383
  */
12848
12384
  getLoanUserConsents: (
@@ -12866,7 +12402,7 @@ export class Api<
12866
12402
  * @summary Get Loan User
12867
12403
  * @request GET:/api/loans/{loanId}/users/{userId}
12868
12404
  * @secure
12869
- * @response `200` `LoanUser` Success
12405
+ * @response `200` `LoanUser` OK
12870
12406
  */
12871
12407
  getLoanUser: (loanId: string, userId: string, params: RequestParams = {}) =>
12872
12408
  this.request<LoanUser, any>({
@@ -12956,7 +12492,7 @@ export class Api<
12956
12492
  * @summary Search LOS operation tracking
12957
12493
  * @request POST:/api/los-operation-tracking/search
12958
12494
  * @secure
12959
- * @response `200` `LosOperationTrackingPaginated` Success
12495
+ * @response `200` `LosOperationTrackingPaginated` OK
12960
12496
  */
12961
12497
  searchLosOperationTracking: (
12962
12498
  data: LosOperationTrackingSearchCriteria,
@@ -12989,7 +12525,7 @@ export class Api<
12989
12525
  * @summary Get All
12990
12526
  * @request GET:/api/milestones
12991
12527
  * @secure
12992
- * @response `200` `(MilestoneConfiguration)[]` Success
12528
+ * @response `200` `(MilestoneConfiguration)[]` OK
12993
12529
  */
12994
12530
  getMilestones: (params: RequestParams = {}) =>
12995
12531
  this.request<MilestoneConfiguration[], any>({
@@ -13009,7 +12545,7 @@ export class Api<
13009
12545
  * @request POST:/api/milestones
13010
12546
  * @secure
13011
12547
  * @response `201` `MilestoneConfiguration` Created
13012
- * @response `422` `UnprocessableEntity` Client Error
12548
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13013
12549
  */
13014
12550
  createMilestone: (
13015
12551
  data: MilestoneConfigurationRequest,
@@ -13033,7 +12569,7 @@ export class Api<
13033
12569
  * @summary Get By ID
13034
12570
  * @request GET:/api/milestones/{id}
13035
12571
  * @secure
13036
- * @response `200` `MilestoneConfiguration` Success
12572
+ * @response `200` `MilestoneConfiguration` OK
13037
12573
  * @response `404` `Error` Not Found
13038
12574
  */
13039
12575
  getMilestone: (id: string, params: RequestParams = {}) =>
@@ -13053,9 +12589,9 @@ export class Api<
13053
12589
  * @summary Replace
13054
12590
  * @request PUT:/api/milestones/{id}
13055
12591
  * @secure
13056
- * @response `200` `MilestoneConfiguration` Success
12592
+ * @response `200` `MilestoneConfiguration` OK
13057
12593
  * @response `404` `Error` Not Found
13058
- * @response `422` `UnprocessableEntity` Client Error
12594
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13059
12595
  */
13060
12596
  replaceMilestone: (
13061
12597
  id: string,
@@ -13099,10 +12635,10 @@ export class Api<
13099
12635
  * @summary Idempotently seed the test loan officer, site configuration, loan and completed borrower used by mobile app store reviewers.
13100
12636
  * @request POST:/api/mobile-app-review/seed
13101
12637
  * @secure
13102
- * @response `200` `MobileAppReviewSeed` Success
12638
+ * @response `200` `MobileAppReviewSeed` OK
13103
12639
  * @response `400` `ProblemDetails` Bad Request
13104
12640
  * @response `404` `ProblemDetails` Not Found
13105
- * @response `422` `ProblemDetails` Client Error
12641
+ * @response `422` `ProblemDetails` Unprocessable Content
13106
12642
  */
13107
12643
  seedMobileAppReview: (
13108
12644
  data: MobileAppReviewSeedRequest,
@@ -13126,8 +12662,8 @@ export class Api<
13126
12662
  * @summary Calculate Monthly Payment
13127
12663
  * @request POST:/api/mortgage-calculators/monthly-payment
13128
12664
  * @secure
13129
- * @response `200` `MonthlyPaymentCalculator` Success
13130
- * @response `422` `ProblemDetails` Client Error
12665
+ * @response `200` `MonthlyPaymentCalculator` OK
12666
+ * @response `422` `ProblemDetails` Unprocessable Content
13131
12667
  */
13132
12668
  calculateMortgageMonthlyPayment: (
13133
12669
  data: MonthlyPaymentCalculatorRequest,
@@ -13151,8 +12687,8 @@ export class Api<
13151
12687
  * @summary Calculate Affordability
13152
12688
  * @request POST:/api/mortgage-calculators/affordability
13153
12689
  * @secure
13154
- * @response `200` `AffordabilityCalculator` Success
13155
- * @response `422` `ProblemDetails` Client Error
12690
+ * @response `200` `AffordabilityCalculator` OK
12691
+ * @response `422` `ProblemDetails` Unprocessable Content
13156
12692
  */
13157
12693
  calculateMortgageAffordability: (
13158
12694
  data: AffordabilityCalculatorRequest,
@@ -13176,8 +12712,8 @@ export class Api<
13176
12712
  * @summary Calculate Loan Comparison
13177
12713
  * @request POST:/api/mortgage-calculators/loan-comparison
13178
12714
  * @secure
13179
- * @response `200` `LoanComparisonCalculator` Success
13180
- * @response `422` `ProblemDetails` Client Error
12715
+ * @response `200` `LoanComparisonCalculator` OK
12716
+ * @response `422` `ProblemDetails` Unprocessable Content
13181
12717
  */
13182
12718
  calculateMortgageLoanComparison: (
13183
12719
  data: LoanComparisonCalculatorRequest,
@@ -13201,8 +12737,8 @@ export class Api<
13201
12737
  * @summary Calculate Refinance
13202
12738
  * @request POST:/api/mortgage-calculators/refinance
13203
12739
  * @secure
13204
- * @response `200` `RefinanceCalculator` Success
13205
- * @response `422` `ProblemDetails` Client Error
12740
+ * @response `200` `RefinanceCalculator` OK
12741
+ * @response `422` `ProblemDetails` Unprocessable Content
13206
12742
  */
13207
12743
  calculateMortgageRefinance: (
13208
12744
  data: RefinanceCalculatorRequest,
@@ -13226,8 +12762,8 @@ export class Api<
13226
12762
  * @summary Send Notification for Loan
13227
12763
  * @request POST:/api/notifications
13228
12764
  * @secure
13229
- * @response `200` `void` Success
13230
- * @response `422` `UnprocessableEntity` Client Error
12765
+ * @response `200` `void` OK
12766
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13231
12767
  */
13232
12768
  sendNotificationForLoan: (
13233
12769
  data: SendNotificationForLoanRequest,
@@ -13250,8 +12786,8 @@ export class Api<
13250
12786
  * @summary Send Test Notification for Loan
13251
12787
  * @request POST:/api/notifications/test
13252
12788
  * @secure
13253
- * @response `200` `void` Success
13254
- * @response `422` `UnprocessableEntity` Client Error
12789
+ * @response `200` `void` OK
12790
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13255
12791
  */
13256
12792
  sendTestNotificationForLoan: (
13257
12793
  data: TestSendNotificationForLoanRequest,
@@ -13274,7 +12810,7 @@ export class Api<
13274
12810
  * @summary Get All
13275
12811
  * @request GET:/api/notification-templates
13276
12812
  * @secure
13277
- * @response `200` `(NotificationTemplateBase)[]` Success
12813
+ * @response `200` `(NotificationTemplateBase)[]` OK
13278
12814
  */
13279
12815
  getNotificationTemplates: (
13280
12816
  query?: {
@@ -13300,7 +12836,7 @@ export class Api<
13300
12836
  * @request POST:/api/notification-templates
13301
12837
  * @secure
13302
12838
  * @response `201` `NotificationTemplate` Created
13303
- * @response `422` `UnprocessableEntity` Client Error
12839
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13304
12840
  */
13305
12841
  createNotificationTemplate: (
13306
12842
  data: NotificationTemplateRequest,
@@ -13324,7 +12860,7 @@ export class Api<
13324
12860
  * @summary Search
13325
12861
  * @request POST:/api/notification-templates/search
13326
12862
  * @secure
13327
- * @response `200` `NotificationTemplateBasePaginated` Success
12863
+ * @response `200` `NotificationTemplateBasePaginated` OK
13328
12864
  */
13329
12865
  searchNotificationTemplates: (
13330
12866
  data: NotificationTemplateSearchCriteria,
@@ -13357,7 +12893,7 @@ export class Api<
13357
12893
  * @summary Get by ID
13358
12894
  * @request GET:/api/notification-templates/{id}
13359
12895
  * @secure
13360
- * @response `200` `NotificationTemplate` Success
12896
+ * @response `200` `NotificationTemplate` OK
13361
12897
  */
13362
12898
  getNotificationTemplate: (id: string, params: RequestParams = {}) =>
13363
12899
  this.request<NotificationTemplate, any>({
@@ -13376,8 +12912,8 @@ export class Api<
13376
12912
  * @summary Replace
13377
12913
  * @request PUT:/api/notification-templates/{id}
13378
12914
  * @secure
13379
- * @response `200` `NotificationTemplate` Success
13380
- * @response `422` `UnprocessableEntity` Client Error
12915
+ * @response `200` `NotificationTemplate` OK
12916
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13381
12917
  */
13382
12918
  replaceNotificationTemplate: (
13383
12919
  id: string,
@@ -13420,7 +12956,7 @@ export class Api<
13420
12956
  * @summary Restore
13421
12957
  * @request POST:/api/notification-templates/{id}/restore
13422
12958
  * @secure
13423
- * @response `200` `NotificationTemplate` Success
12959
+ * @response `200` `NotificationTemplate` OK
13424
12960
  */
13425
12961
  restoreNotificationTemplate: (id: string, params: RequestParams = {}) =>
13426
12962
  this.request<NotificationTemplate, any>({
@@ -13439,7 +12975,7 @@ export class Api<
13439
12975
  * @summary Get All
13440
12976
  * @request GET:/api/notification-templates/{notificationId}/versions
13441
12977
  * @secure
13442
- * @response `200` `(NotificationTemplateVersion)[]` Success
12978
+ * @response `200` `(NotificationTemplateVersion)[]` OK
13443
12979
  */
13444
12980
  getNotificationTemplateVersions: (
13445
12981
  notificationId: string,
@@ -13461,7 +12997,7 @@ export class Api<
13461
12997
  * @summary Create
13462
12998
  * @request POST:/api/notification-templates/{notificationId}/versions
13463
12999
  * @secure
13464
- * @response `200` `NotificationTemplateVersion` Success
13000
+ * @response `200` `NotificationTemplateVersion` OK
13465
13001
  */
13466
13002
  createNotificationTemplateVersion: (
13467
13003
  notificationId: string,
@@ -13486,7 +13022,7 @@ export class Api<
13486
13022
  * @summary Get by ID
13487
13023
  * @request GET:/api/notification-templates/{notificationId}/versions/{id}
13488
13024
  * @secure
13489
- * @response `200` `NotificationTemplateVersion` Success
13025
+ * @response `200` `NotificationTemplateVersion` OK
13490
13026
  */
13491
13027
  getNotificationTemplateVersion: (
13492
13028
  notificationId: string,
@@ -13509,7 +13045,7 @@ export class Api<
13509
13045
  * @summary Replace
13510
13046
  * @request PUT:/api/notification-templates/{notificationId}/versions/{id}
13511
13047
  * @secure
13512
- * @response `200` `NotificationTemplateVersion` Success
13048
+ * @response `200` `NotificationTemplateVersion` OK
13513
13049
  */
13514
13050
  replaceNotificationTemplateVersion: (
13515
13051
  notificationId: string,
@@ -13535,7 +13071,7 @@ export class Api<
13535
13071
  * @summary Delete
13536
13072
  * @request DELETE:/api/notification-templates/{notificationId}/versions/{id}
13537
13073
  * @secure
13538
- * @response `200` `NotificationTemplateVersion` Success
13074
+ * @response `200` `NotificationTemplateVersion` OK
13539
13075
  */
13540
13076
  deleteNotificationTemplateVersion: (
13541
13077
  notificationId: string,
@@ -13558,7 +13094,7 @@ export class Api<
13558
13094
  * @summary Get All
13559
13095
  * @request GET:/api/partners
13560
13096
  * @secure
13561
- * @response `200` `BranchUserPaginated` Success
13097
+ * @response `200` `BranchUserPaginated` OK
13562
13098
  */
13563
13099
  getPartners: (
13564
13100
  query?: {
@@ -13591,7 +13127,7 @@ export class Api<
13591
13127
  * @summary Search
13592
13128
  * @request POST:/api/partners/search
13593
13129
  * @secure
13594
- * @response `200` `BranchUserPaginated` Success
13130
+ * @response `200` `BranchUserPaginated` OK
13595
13131
  */
13596
13132
  searchPartners: (
13597
13133
  data: PartnerSearchCriteria,
@@ -13624,7 +13160,7 @@ export class Api<
13624
13160
  * @summary Get by ID
13625
13161
  * @request GET:/api/partners/{id}
13626
13162
  * @secure
13627
- * @response `200` `BranchUser` Success
13163
+ * @response `200` `BranchUser` OK
13628
13164
  */
13629
13165
  getPartner: (id: string, params: RequestParams = {}) =>
13630
13166
  this.request<BranchUser, any>({
@@ -13643,8 +13179,8 @@ export class Api<
13643
13179
  * @summary Create Site Configuration
13644
13180
  * @request POST:/api/partners/{realtorId}/site-configurations
13645
13181
  * @secure
13646
- * @response `200` `SiteConfiguration` Success
13647
- * @response `422` `UnprocessableEntity` Client Error
13182
+ * @response `200` `SiteConfiguration` OK
13183
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13648
13184
  */
13649
13185
  createPartnerSiteConfiguration: (
13650
13186
  realtorId: string,
@@ -13669,7 +13205,7 @@ export class Api<
13669
13205
  * @summary Get Site Configuration
13670
13206
  * @request GET:/api/partners/{realtorId}/site-configurations/{siteConfigurationId}
13671
13207
  * @secure
13672
- * @response `200` `SiteConfigurationWithInherited` Success
13208
+ * @response `200` `SiteConfigurationWithInherited` OK
13673
13209
  */
13674
13210
  getPartnerSiteConfiguration: (
13675
13211
  realtorId: string,
@@ -13692,8 +13228,8 @@ export class Api<
13692
13228
  * @summary Replace Site Configuration
13693
13229
  * @request PUT:/api/partners/{realtorId}/site-configurations/{siteConfigurationId}
13694
13230
  * @secure
13695
- * @response `200` `SiteConfiguration` Success
13696
- * @response `422` `UnprocessableEntity` Client Error
13231
+ * @response `200` `SiteConfiguration` OK
13232
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13697
13233
  */
13698
13234
  replacePartnerSiteConfiguration: (
13699
13235
  realtorId: string,
@@ -13723,7 +13259,7 @@ export class Api<
13723
13259
  * @summary Get By ID
13724
13260
  * @request GET:/api/site-configurations/{id}
13725
13261
  * @secure
13726
- * @response `200` `SiteConfiguration` Success
13262
+ * @response `200` `SiteConfiguration` OK
13727
13263
  */
13728
13264
  getSiteConfiguration: (id: string, params: RequestParams = {}) =>
13729
13265
  this.request<SiteConfiguration, any>({
@@ -13743,8 +13279,8 @@ export class Api<
13743
13279
  * @request POST:/api/site-configurations/url
13744
13280
  * @deprecated
13745
13281
  * @secure
13746
- * @response `200` `SiteConfigurationByUrl` Success
13747
- * @response `422` `UnprocessableEntity` Client Error
13282
+ * @response `200` `SiteConfigurationByUrl` OK
13283
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13748
13284
  */
13749
13285
  searchSiteConfigurationByUrl: (
13750
13286
  data: GetSiteConfigurationRequest,
@@ -13768,8 +13304,8 @@ export class Api<
13768
13304
  * @summary Get By URL
13769
13305
  * @request GET:/api/site-configurations
13770
13306
  * @secure
13771
- * @response `200` `SiteConfigurationByUrl` Success
13772
- * @response `422` `UnprocessableEntity` Client Error
13307
+ * @response `200` `SiteConfigurationByUrl` OK
13308
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13773
13309
  */
13774
13310
  getSiteConfigurationByUrl: (
13775
13311
  query?: {
@@ -13795,8 +13331,8 @@ export class Api<
13795
13331
  * @request POST:/api/site-configurations/louser
13796
13332
  * @deprecated
13797
13333
  * @secure
13798
- * @response `200` `SiteConfiguration` Success
13799
- * @response `422` `UnprocessableEntity` Client Error
13334
+ * @response `200` `SiteConfiguration` OK
13335
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13800
13336
  */
13801
13337
  searchSiteConfigurationByLoanOfficerUser: (
13802
13338
  data: GetSiteConfigurationByLOUserIDRequest,
@@ -13820,8 +13356,8 @@ export class Api<
13820
13356
  * @summary Get By Loan Officer User
13821
13357
  * @request GET:/api/site-configurations/louser/{loUserId}
13822
13358
  * @secure
13823
- * @response `200` `SiteConfiguration` Success
13824
- * @response `422` `UnprocessableEntity` Client Error
13359
+ * @response `200` `SiteConfiguration` OK
13360
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13825
13361
  */
13826
13362
  getSiteConfigurationByLoanOfficerUser: (
13827
13363
  loUserId: string,
@@ -13843,8 +13379,8 @@ export class Api<
13843
13379
  * @summary Search
13844
13380
  * @request POST:/api/site-configurations/search
13845
13381
  * @secure
13846
- * @response `200` `SiteConfigurationSummaryPaginated` Success
13847
- * @response `422` `UnprocessableEntity` Client Error
13382
+ * @response `200` `SiteConfigurationSummaryPaginated` OK
13383
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13848
13384
  */
13849
13385
  searchSiteConfigurations: (
13850
13386
  data: SiteConfigurationSearchCriteria,
@@ -13877,7 +13413,7 @@ export class Api<
13877
13413
  * @summary Get Forms by Site Configuration
13878
13414
  * @request GET:/api/site-configurations/{id}/forms
13879
13415
  * @secure
13880
- * @response `200` `(AdminAccessGetForms)[]` Success
13416
+ * @response `200` `(AdminAccessGetForms)[]` OK
13881
13417
  */
13882
13418
  getFormsBySiteConfiguration: (id: string, params: RequestParams = {}) =>
13883
13419
  this.request<AdminAccessGetForms[], any>({
@@ -13896,7 +13432,7 @@ export class Api<
13896
13432
  * @summary Get Saml Metadata
13897
13433
  * @request GET:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
13898
13434
  * @secure
13899
- * @response `200` `File` Success
13435
+ * @response `200` `File` OK
13900
13436
  * @response `404` `ProblemDetails` Not Found
13901
13437
  */
13902
13438
  getSamlMetadata: (
@@ -13919,7 +13455,7 @@ export class Api<
13919
13455
  * @summary Create or Replace Saml Metadata
13920
13456
  * @request POST:/api/site-configurations/sso/saml/{ssoIntegration}/metadata
13921
13457
  * @secure
13922
- * @response `200` `File` Success
13458
+ * @response `200` `File` OK
13923
13459
  */
13924
13460
  createOrReplaceSamlMetadata: (
13925
13461
  sSoIntegration: CreateOrReplaceSamlMetadataParamsEnum,
@@ -13941,7 +13477,7 @@ export class Api<
13941
13477
  * @summary List all site configurations assigned to a workflow
13942
13478
  * @request GET:/api/workflows/{workflowId}/site-configurations
13943
13479
  * @secure
13944
- * @response `200` `(SiteConfigurationForm)[]` Success
13480
+ * @response `200` `(SiteConfigurationForm)[]` OK
13945
13481
  */
13946
13482
  getWorkflowSiteConfigurations: (
13947
13483
  workflowId: string,
@@ -13963,7 +13499,7 @@ export class Api<
13963
13499
  * @summary Get the workflow-site configuration assignment by composite key
13964
13500
  * @request GET:/api/workflows/{workflowId}/site-configurations/{siteConfigurationId}
13965
13501
  * @secure
13966
- * @response `200` `SiteConfigurationForm` Success
13502
+ * @response `200` `SiteConfigurationForm` OK
13967
13503
  * @response `404` `ProblemDetails` Not Found
13968
13504
  */
13969
13505
  getWorkflowSiteConfiguration: (
@@ -13989,7 +13525,7 @@ export class Api<
13989
13525
  * @secure
13990
13526
  * @response `201` `SiteConfigurationForm` Created
13991
13527
  * @response `409` `ProblemDetails` Conflict
13992
- * @response `422` `UnprocessableEntity` Client Error
13528
+ * @response `422` `UnprocessableEntity` Unprocessable Content
13993
13529
  */
13994
13530
  createWorkflowSiteConfiguration: (
13995
13531
  workflowId: string,
@@ -14036,7 +13572,7 @@ export class Api<
14036
13572
  * @summary Get By Site Configuration Slug
14037
13573
  * @request POST:/api/site-forms
14038
13574
  * @secure
14039
- * @response `200` `GetForm` Success
13575
+ * @response `200` `GetForm` OK
14040
13576
  */
14041
13577
  getFormBySiteConfigurationSlug: (
14042
13578
  data: GetSiteFormRequest,
@@ -14060,7 +13596,7 @@ export class Api<
14060
13596
  * @summary Get by Users
14061
13597
  * @request GET:/api/surveys
14062
13598
  * @secure
14063
- * @response `200` `(SocialSurveyRecord)[]` Success
13599
+ * @response `200` `(SocialSurveyRecord)[]` OK
14064
13600
  */
14065
13601
  getSurveysByUsers: (
14066
13602
  query?: {
@@ -14086,8 +13622,8 @@ export class Api<
14086
13622
  * @summary Get by User
14087
13623
  * @request POST:/api/surveys
14088
13624
  * @secure
14089
- * @response `200` `(SocialSurveyRecord)[]` Success
14090
- * @response `422` `UnprocessableEntity` Client Error
13625
+ * @response `200` `(SocialSurveyRecord)[]` OK
13626
+ * @response `422` `UnprocessableEntity` Unprocessable Content
14091
13627
  */
14092
13628
  getSurveysByUser: (data: SurveyEmailRequest, params: RequestParams = {}) =>
14093
13629
  this.request<SocialSurveyRecord[], UnprocessableEntity>({
@@ -14108,7 +13644,7 @@ export class Api<
14108
13644
  * @summary Get All
14109
13645
  * @request GET:/api/tasks
14110
13646
  * @secure
14111
- * @response `200` `Task` Success
13647
+ * @response `200` `Task` OK
14112
13648
  * @response `404` `ProblemDetails` Not Found
14113
13649
  */
14114
13650
  getTasks: (
@@ -14160,7 +13696,7 @@ export class Api<
14160
13696
  * @summary Get By ID
14161
13697
  * @request GET:/api/tasks/{id}
14162
13698
  * @secure
14163
- * @response `200` `Task` Success
13699
+ * @response `200` `Task` OK
14164
13700
  * @response `404` `ProblemDetails` Not Found
14165
13701
  */
14166
13702
  getTask: (id: string, params: RequestParams = {}) =>
@@ -14180,16 +13716,17 @@ export class Api<
14180
13716
  * @summary Replace
14181
13717
  * @request PUT:/api/tasks/{id}
14182
13718
  * @secure
14183
- * @response `200` `void` Success
13719
+ * @response `200` `Task` OK
14184
13720
  * @response `404` `ProblemDetails` Not Found
14185
13721
  */
14186
13722
  replaceTask: (id: string, data: TaskRequest, params: RequestParams = {}) =>
14187
- this.request<void, ProblemDetails>({
13723
+ this.request<Task, ProblemDetails>({
14188
13724
  path: `/api/tasks/${id}`,
14189
13725
  method: "PUT",
14190
13726
  body: data,
14191
13727
  secure: true,
14192
13728
  type: "application/json",
13729
+ format: "json",
14193
13730
  ...params,
14194
13731
  }),
14195
13732
 
@@ -14220,7 +13757,7 @@ export class Api<
14220
13757
  * @summary Search
14221
13758
  * @request POST:/api/tasks/search
14222
13759
  * @secure
14223
- * @response `200` `TaskPaginated` Success
13760
+ * @response `200` `TaskPaginated` OK
14224
13761
  */
14225
13762
  searchTasks: (
14226
13763
  data: TaskSearchCriteria,
@@ -14252,7 +13789,7 @@ export class Api<
14252
13789
  * @name IntegrationsLosLoansCreate
14253
13790
  * @request POST:/api/integrations/los/loans
14254
13791
  * @secure
14255
- * @response `200` `void` Success
13792
+ * @response `200` `void` OK
14256
13793
  */
14257
13794
  integrationsLosLoansCreate: (
14258
13795
  data: LosLoanCreationRequest,
@@ -14272,9 +13809,10 @@ export class Api<
14272
13809
  *
14273
13810
  * @tags TheBigPOS
14274
13811
  * @name SearchEncompassLogs
13812
+ * @summary Search Encompass Logs
14275
13813
  * @request POST:/api/los/encompass/logs/{losId}/search
14276
13814
  * @secure
14277
- * @response `200` `EncompassRequestLogPaginated` Success
13815
+ * @response `200` `EncompassRequestLogPaginated` OK
14278
13816
  */
14279
13817
  searchEncompassLogs: (
14280
13818
  losId: string,
@@ -14305,9 +13843,10 @@ export class Api<
14305
13843
  *
14306
13844
  * @tags TheBigPOS
14307
13845
  * @name GetEncompassCredentials
13846
+ * @summary Get Encompass Credentials for the current account
14308
13847
  * @request GET:/api/los/encompass/credentials
14309
13848
  * @secure
14310
- * @response `200` `EncompassCredentialsDetail` Success
13849
+ * @response `200` `EncompassCredentialsDetail` OK
14311
13850
  * @response `204` `void` No Content
14312
13851
  */
14313
13852
  getEncompassCredentials: (params: RequestParams = {}) =>
@@ -14324,6 +13863,7 @@ export class Api<
14324
13863
  *
14325
13864
  * @tags TheBigPOS
14326
13865
  * @name CreateEncompassCredentials
13866
+ * @summary Create Encompass Credentials for the current account
14327
13867
  * @request POST:/api/los/encompass/credentials
14328
13868
  * @secure
14329
13869
  * @response `201` `LosCredentials` Created
@@ -14347,9 +13887,10 @@ export class Api<
14347
13887
  *
14348
13888
  * @tags TheBigPOS
14349
13889
  * @name UpdateEncompassCredentials
13890
+ * @summary Update Encompass Credentials for the current account
14350
13891
  * @request PUT:/api/los/encompass/credentials
14351
13892
  * @secure
14352
- * @response `200` `EncompassCredentialsDetail` Success
13893
+ * @response `200` `EncompassCredentialsDetail` OK
14353
13894
  */
14354
13895
  updateEncompassCredentials: (
14355
13896
  data: EncompassCredentialsRequest,
@@ -14370,9 +13911,10 @@ export class Api<
14370
13911
  *
14371
13912
  * @tags TheBigPOS
14372
13913
  * @name GetEncompassWebhooks
13914
+ * @summary Get Encompass webhooks filtered by current domain
14373
13915
  * @request GET:/api/los/encompass/webhooks
14374
13916
  * @secure
14375
- * @response `200` `(LosWebhook)[]` Success
13917
+ * @response `200` `(LosWebhook)[]` OK
14376
13918
  */
14377
13919
  getEncompassWebhooks: (params: RequestParams = {}) =>
14378
13920
  this.request<LosWebhook[], any>({
@@ -14388,6 +13930,7 @@ export class Api<
14388
13930
  *
14389
13931
  * @tags TheBigPOS
14390
13932
  * @name CreateEncompassWebhook
13933
+ * @summary Register a webhook in Encompass
14391
13934
  * @request POST:/api/los/encompass/webhooks
14392
13935
  * @secure
14393
13936
  * @response `201` `LosWebhook` Created
@@ -14411,6 +13954,7 @@ export class Api<
14411
13954
  *
14412
13955
  * @tags TheBigPOS
14413
13956
  * @name DeleteEncompassWebhook
13957
+ * @summary Delete a webhook from Encompass
14414
13958
  * @request DELETE:/api/los/encompass/webhooks/{webhookId}
14415
13959
  * @secure
14416
13960
  * @response `204` `void` No Content
@@ -14428,9 +13972,10 @@ export class Api<
14428
13972
  *
14429
13973
  * @tags TheBigPOS
14430
13974
  * @name SearchLosSyncs
13975
+ * @summary Search LOS Sync History
14431
13976
  * @request POST:/api/los/encompass/syncs/{loanId}/search
14432
13977
  * @secure
14433
- * @response `200` `LosSyncPaginated` Success
13978
+ * @response `200` `LosSyncPaginated` OK
14434
13979
  */
14435
13980
  searchLosSyncs: (
14436
13981
  loanId: string,
@@ -14464,7 +14009,7 @@ export class Api<
14464
14009
  * @summary Get usage report by ID
14465
14010
  * @request GET:/api/usage-reports/{id}
14466
14011
  * @secure
14467
- * @response `200` `UsageReport` Success
14012
+ * @response `200` `UsageReport` OK
14468
14013
  * @response `404` `ProblemDetails` Not Found
14469
14014
  */
14470
14015
  getUsageReportById: (id: string, params: RequestParams = {}) =>
@@ -14484,7 +14029,7 @@ export class Api<
14484
14029
  * @summary Get usage reports by month and year
14485
14030
  * @request GET:/api/usage-reports
14486
14031
  * @secure
14487
- * @response `200` `(UsageReport)[]` Success
14032
+ * @response `200` `(UsageReport)[]` OK
14488
14033
  * @response `400` `ProblemDetails` Bad Request
14489
14034
  */
14490
14035
  getUsageReportsByPeriod: (
@@ -14542,7 +14087,7 @@ export class Api<
14542
14087
  * @summary Get usage report execution dashboard with active execution, recent history, and statistics
14543
14088
  * @request GET:/api/usage-reports/dashboard
14544
14089
  * @secure
14545
- * @response `200` `UsageReportDashboard` Success
14090
+ * @response `200` `UsageReportDashboard` OK
14546
14091
  */
14547
14092
  getUsageReportDashboard: (params: RequestParams = {}) =>
14548
14093
  this.request<UsageReportDashboard, any>({
@@ -14561,7 +14106,7 @@ export class Api<
14561
14106
  * @summary Get usage report execution status by correlation ID
14562
14107
  * @request GET:/api/usage-reports/executions/{correlationId}
14563
14108
  * @secure
14564
- * @response `200` `UsageReportExecution` Success
14109
+ * @response `200` `UsageReportExecution` OK
14565
14110
  * @response `404` `ProblemDetails` Not Found
14566
14111
  */
14567
14112
  getUsageReportExecution: (
@@ -14584,7 +14129,7 @@ export class Api<
14584
14129
  * @summary Get usage report executions by month and year
14585
14130
  * @request GET:/api/usage-reports/executions
14586
14131
  * @secure
14587
- * @response `200` `(UsageReportExecution)[]` Success
14132
+ * @response `200` `(UsageReportExecution)[]` OK
14588
14133
  * @response `400` `ProblemDetails` Bad Request
14589
14134
  */
14590
14135
  getUsageReportExecutionsByPeriod: (
@@ -14657,7 +14202,7 @@ export class Api<
14657
14202
  * @summary Get draft users
14658
14203
  * @request GET:/api/loans/drafts/{draftId}/users
14659
14204
  * @secure
14660
- * @response `200` `UserDraftPaginated` Success
14205
+ * @response `200` `UserDraftPaginated` OK
14661
14206
  */
14662
14207
  getDraftUsers: (
14663
14208
  draftId: string,
@@ -14688,7 +14233,7 @@ export class Api<
14688
14233
  * @summary Get draft user
14689
14234
  * @request GET:/api/loans/drafts/{draftId}/users/{userId}
14690
14235
  * @secure
14691
- * @response `200` `UserDraft` Success
14236
+ * @response `200` `UserDraft` OK
14692
14237
  */
14693
14238
  getDraftUser: (
14694
14239
  draftId: string,
@@ -14711,7 +14256,7 @@ export class Api<
14711
14256
  * @summary Add draft user
14712
14257
  * @request POST:/api/loans/drafts/{draftId}/users/{userId}
14713
14258
  * @secure
14714
- * @response `200` `UserDraft` Success
14259
+ * @response `200` `UserDraft` OK
14715
14260
  */
14716
14261
  addDraftUsers: (
14717
14262
  draftId: string,
@@ -14759,7 +14304,7 @@ export class Api<
14759
14304
  * @summary Get All
14760
14305
  * @request GET:/api/user-groups/{groupId}/scopes
14761
14306
  * @secure
14762
- * @response `200` `(UserGroupAccessScope)[]` Success
14307
+ * @response `200` `(UserGroupAccessScope)[]` OK
14763
14308
  */
14764
14309
  getUserGroupAccessScopes: (groupId: string, params: RequestParams = {}) =>
14765
14310
  this.request<UserGroupAccessScope[], any>({
@@ -14778,7 +14323,7 @@ export class Api<
14778
14323
  * @summary Create a new scope
14779
14324
  * @request POST:/api/user-groups/{groupId}/scopes
14780
14325
  * @secure
14781
- * @response `200` `UserGroupAccessScope` Success
14326
+ * @response `200` `UserGroupAccessScope` OK
14782
14327
  */
14783
14328
  createUserGroupAccessScope: (
14784
14329
  groupId: string,
@@ -14825,7 +14370,7 @@ export class Api<
14825
14370
  * @summary Get All
14826
14371
  * @request GET:/api/user-groups/{groupId}/members
14827
14372
  * @secure
14828
- * @response `200` `(UserGroupMember)[]` Success
14373
+ * @response `200` `(UserGroupMember)[]` OK
14829
14374
  */
14830
14375
  getUserGroupMembers: (groupId: string, params: RequestParams = {}) =>
14831
14376
  this.request<UserGroupMember[], any>({
@@ -14844,7 +14389,7 @@ export class Api<
14844
14389
  * @summary Create User Group Member
14845
14390
  * @request POST:/api/user-groups/{groupId}/members
14846
14391
  * @secure
14847
- * @response `200` `UserGroupMember` Success
14392
+ * @response `200` `UserGroupMember` OK
14848
14393
  */
14849
14394
  createUserGroupMember: (
14850
14395
  groupId: string,
@@ -14896,7 +14441,7 @@ export class Api<
14896
14441
  * @summary Get All
14897
14442
  * @request POST:/api/user-groups/search
14898
14443
  * @secure
14899
- * @response `200` `UserGroupPaginated` Success
14444
+ * @response `200` `UserGroupPaginated` OK
14900
14445
  */
14901
14446
  searchUserGroups: (
14902
14447
  query?: {
@@ -14927,7 +14472,7 @@ export class Api<
14927
14472
  * @summary Get User Group by ID
14928
14473
  * @request GET:/api/user-groups/{groupId}
14929
14474
  * @secure
14930
- * @response `200` `UserGroup` Success
14475
+ * @response `200` `UserGroup` OK
14931
14476
  */
14932
14477
  getUserGroup: (groupId: string, params: RequestParams = {}) =>
14933
14478
  this.request<UserGroup, any>({
@@ -14946,7 +14491,7 @@ export class Api<
14946
14491
  * @summary Update User Group
14947
14492
  * @request PUT:/api/user-groups/{groupId}
14948
14493
  * @secure
14949
- * @response `200` `UserGroup` Success
14494
+ * @response `200` `UserGroup` OK
14950
14495
  */
14951
14496
  updateUserGroup: (
14952
14497
  groupId: string,
@@ -15015,7 +14560,7 @@ export class Api<
15015
14560
  * @secure
15016
14561
  * @response `204` `void` No Content
15017
14562
  * @response `404` `Error` Not Found
15018
- * @response `422` `UnprocessableEntity` Client Error
14563
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15019
14564
  */
15020
14565
  requestImpersonation: (
15021
14566
  data: RequestImpersonationRequest,
@@ -15040,7 +14585,7 @@ export class Api<
15040
14585
  * @secure
15041
14586
  * @response `204` `void` No Content
15042
14587
  * @response `404` `Error` Not Found
15043
- * @response `422` `UnprocessableEntity` Client Error
14588
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15044
14589
  */
15045
14590
  allowImpersonation: (
15046
14591
  data: AllowImpersonationRequest,
@@ -15065,7 +14610,7 @@ export class Api<
15065
14610
  * @secure
15066
14611
  * @response `204` `void` No Content
15067
14612
  * @response `404` `Error` Not Found
15068
- * @response `422` `UnprocessableEntity` Client Error
14613
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15069
14614
  */
15070
14615
  allowImpersonationWithGuid: (
15071
14616
  allowToken: string,
@@ -15087,7 +14632,7 @@ export class Api<
15087
14632
  * @request POST:/api/users/impersonation
15088
14633
  * @secure
15089
14634
  * @response `204` `void` No Content
15090
- * @response `422` `UnprocessableEntity` Client Error
14635
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15091
14636
  */
15092
14637
  beginImpersonation: (params: RequestParams = {}) =>
15093
14638
  this.request<void, UnprocessableEntity>({
@@ -15106,7 +14651,7 @@ export class Api<
15106
14651
  * @request DELETE:/api/users/impersonation
15107
14652
  * @secure
15108
14653
  * @response `204` `void` No Content
15109
- * @response `422` `UnprocessableEntity` Client Error
14654
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15110
14655
  */
15111
14656
  stopImpersonation: (params: RequestParams = {}) =>
15112
14657
  this.request<void, UnprocessableEntity>({
@@ -15126,7 +14671,7 @@ export class Api<
15126
14671
  * @secure
15127
14672
  * @response `204` `void` No Content
15128
14673
  * @response `404` `Error` Not Found
15129
- * @response `422` `UnprocessableEntity` Client Error
14674
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15130
14675
  */
15131
14676
  forceImpersonation: (
15132
14677
  data: RequestImpersonationRequest,
@@ -15150,7 +14695,7 @@ export class Api<
15150
14695
  * @request POST:/api/users/impersonation/extend
15151
14696
  * @secure
15152
14697
  * @response `204` `void` No Content
15153
- * @response `422` `UnprocessableEntity` Client Error
14698
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15154
14699
  */
15155
14700
  extendImpersonation: (params: RequestParams = {}) =>
15156
14701
  this.request<void, UnprocessableEntity>({
@@ -15169,7 +14714,7 @@ export class Api<
15169
14714
  * @request POST:/api/users/invites
15170
14715
  * @secure
15171
14716
  * @response `204` `void` No Content
15172
- * @response `422` `UnprocessableEntity` Client Error
14717
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15173
14718
  */
15174
14719
  inviteUser: (data: CreateInviteRequest, params: RequestParams = {}) =>
15175
14720
  this.request<void, UnprocessableEntity>({
@@ -15209,8 +14754,8 @@ export class Api<
15209
14754
  * @summary Verify
15210
14755
  * @request GET:/api/users/invites/{token}/verify
15211
14756
  * @secure
15212
- * @response `200` `Invite` Success
15213
- * @response `422` `UnprocessableEntity` Client Error
14757
+ * @response `200` `Invite` OK
14758
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15214
14759
  */
15215
14760
  verifyUserInvite: (token: string, params: RequestParams = {}) =>
15216
14761
  this.request<Invite, UnprocessableEntity>({
@@ -15229,7 +14774,7 @@ export class Api<
15229
14774
  * @summary Get All
15230
14775
  * @request GET:/api/users/{userID}/relations
15231
14776
  * @secure
15232
- * @response `200` `(UserRelation)[]` Success
14777
+ * @response `200` `(UserRelation)[]` OK
15233
14778
  */
15234
14779
  getUserRelations: (userId: string, params: RequestParams = {}) =>
15235
14780
  this.request<UserRelation[], any>({
@@ -15272,7 +14817,7 @@ export class Api<
15272
14817
  * @summary Get by ID
15273
14818
  * @request GET:/api/users/{userID}/relations/{id}
15274
14819
  * @secure
15275
- * @response `200` `UserRelation` Success
14820
+ * @response `200` `UserRelation` OK
15276
14821
  */
15277
14822
  getUserRelation: (userId: string, id: string, params: RequestParams = {}) =>
15278
14823
  this.request<UserRelation, any>({
@@ -15313,7 +14858,7 @@ export class Api<
15313
14858
  * @summary Get All
15314
14859
  * @request GET:/api/users
15315
14860
  * @secure
15316
- * @response `200` `(User)[]` Success
14861
+ * @response `200` `(User)[]` OK
15317
14862
  */
15318
14863
  getUsers: (
15319
14864
  query?: {
@@ -15343,8 +14888,8 @@ export class Api<
15343
14888
  * @summary Create
15344
14889
  * @request POST:/api/users
15345
14890
  * @secure
15346
- * @response `200` `DetailedUser` Success
15347
- * @response `422` `UnprocessableEntity` Client Error
14891
+ * @response `200` `DetailedUser` OK
14892
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15348
14893
  */
15349
14894
  createUser: (data: CreateUserRequest, params: RequestParams = {}) =>
15350
14895
  this.request<DetailedUser, UnprocessableEntity>({
@@ -15365,7 +14910,7 @@ export class Api<
15365
14910
  * @summary Search
15366
14911
  * @request POST:/api/users/search
15367
14912
  * @secure
15368
- * @response `200` `UserPaginated` Success
14913
+ * @response `200` `UserPaginated` OK
15369
14914
  */
15370
14915
  searchUsers: (
15371
14916
  data: UserSearchCriteria,
@@ -15398,7 +14943,7 @@ export class Api<
15398
14943
  * @summary Get by Email
15399
14944
  * @request POST:/api/users/byemail
15400
14945
  * @secure
15401
- * @response `200` `AdminAccessUser` Success
14946
+ * @response `200` `AdminAccessUser` OK
15402
14947
  */
15403
14948
  getUserByEmail: (data: GetUserByEmailRequest, params: RequestParams = {}) =>
15404
14949
  this.request<AdminAccessUser, any>({
@@ -15419,8 +14964,8 @@ export class Api<
15419
14964
  * @summary Sign Up
15420
14965
  * @request POST:/api/users/register
15421
14966
  * @secure
15422
- * @response `200` `User` Success
15423
- * @response `422` `UnprocessableEntity` Client Error
14967
+ * @response `200` `User` OK
14968
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15424
14969
  */
15425
14970
  signUp: (data: RegisterUserRequest, params: RequestParams = {}) =>
15426
14971
  this.request<User, UnprocessableEntity>({
@@ -15441,8 +14986,8 @@ export class Api<
15441
14986
  * @summary Update
15442
14987
  * @request PUT:/api/users/{id}
15443
14988
  * @secure
15444
- * @response `200` `DetailedUser` Success
15445
- * @response `422` `UnprocessableEntity` Client Error
14989
+ * @response `200` `DetailedUser` OK
14990
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15446
14991
  */
15447
14992
  replaceUser: (
15448
14993
  id: string,
@@ -15512,7 +15057,7 @@ export class Api<
15512
15057
  * @request POST:/api/users/change-password
15513
15058
  * @secure
15514
15059
  * @response `204` `void` No Content
15515
- * @response `422` `UnprocessableEntity` Client Error
15060
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15516
15061
  */
15517
15062
  changePassword: (data: ChangePasswordRequest, params: RequestParams = {}) =>
15518
15063
  this.request<void, UnprocessableEntity>({
@@ -15533,7 +15078,7 @@ export class Api<
15533
15078
  * @request POST:/api/users/verify-password
15534
15079
  * @secure
15535
15080
  * @response `204` `void` No Content
15536
- * @response `422` `UnprocessableEntity` Client Error
15081
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15537
15082
  */
15538
15083
  verifyPassword: (data: VerifyPasswordRequest, params: RequestParams = {}) =>
15539
15084
  this.request<void, UnprocessableEntity>({
@@ -15554,7 +15099,7 @@ export class Api<
15554
15099
  * @request POST:/api/users/{id}/override-password
15555
15100
  * @secure
15556
15101
  * @response `204` `void` No Content
15557
- * @response `422` `UnprocessableEntity` Client Error
15102
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15558
15103
  */
15559
15104
  overridePassword: (
15560
15105
  id: string,
@@ -15579,7 +15124,7 @@ export class Api<
15579
15124
  * @request POST:/api/users/forgot-password
15580
15125
  * @secure
15581
15126
  * @response `204` `void` No Content
15582
- * @response `422` `UnprocessableEntity` Client Error
15127
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15583
15128
  */
15584
15129
  forgotPassword: (
15585
15130
  data: SendForgotPasswordRequest,
@@ -15603,7 +15148,7 @@ export class Api<
15603
15148
  * @request POST:/api/users/mobile-phone/send-code
15604
15149
  * @secure
15605
15150
  * @response `204` `void` No Content
15606
- * @response `422` `UnprocessableEntity` Client Error
15151
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15607
15152
  */
15608
15153
  sendMobilePhoneVerificationCode: (params: RequestParams = {}) =>
15609
15154
  this.request<void, UnprocessableEntity>({
@@ -15622,7 +15167,7 @@ export class Api<
15622
15167
  * @request PUT:/api/users/mobile-phone/verify-code
15623
15168
  * @secure
15624
15169
  * @response `204` `void` No Content
15625
- * @response `422` `UnprocessableEntity` Client Error
15170
+ * @response `422` `UnprocessableEntity` Unprocessable Content
15626
15171
  */
15627
15172
  verifyUserMobilePhone: (
15628
15173
  data: UserMobilePhoneVerificationRequest,
@@ -15645,7 +15190,7 @@ export class Api<
15645
15190
  * @summary Get
15646
15191
  * @request GET:/api/users/me
15647
15192
  * @secure
15648
- * @response `200` `ImpersonatedDetailedUser` Success
15193
+ * @response `200` `ImpersonatedDetailedUser` OK
15649
15194
  * @response `401` `ProblemDetails` Unauthorized
15650
15195
  */
15651
15196
  getMe: (params: RequestParams = {}) =>
@@ -15665,7 +15210,7 @@ export class Api<
15665
15210
  * @summary Replace
15666
15211
  * @request PUT:/api/users/me
15667
15212
  * @secure
15668
- * @response `200` `DetailedUser` Success
15213
+ * @response `200` `DetailedUser` OK
15669
15214
  */
15670
15215
  replaceMe: (data: UpdateMeRequest, params: RequestParams = {}) =>
15671
15216
  this.request<DetailedUser, any>({
@@ -15710,7 +15255,7 @@ export class Api<
15710
15255
  * @summary Get Relationships
15711
15256
  * @request GET:/api/users/me/relationships
15712
15257
  * @secure
15713
- * @response `200` `(UserRelationship)[]` Success
15258
+ * @response `200` `(UserRelationship)[]` OK
15714
15259
  */
15715
15260
  getMyRelationships: (params: RequestParams = {}) =>
15716
15261
  this.request<UserRelationship[], any>({
@@ -15729,7 +15274,7 @@ export class Api<
15729
15274
  * @summary Get Relationship Prospects
15730
15275
  * @request GET:/api/users/me/relationships/prospects
15731
15276
  * @secure
15732
- * @response `200` `(UserRelationshipProspect)[]` Success
15277
+ * @response `200` `(UserRelationshipProspect)[]` OK
15733
15278
  */
15734
15279
  getMyRelationshipProspects: (params: RequestParams = {}) =>
15735
15280
  this.request<UserRelationshipProspect[], any>({
@@ -15786,7 +15331,7 @@ export class Api<
15786
15331
  * @summary Get Workflow
15787
15332
  * @request POST:/api/workflow
15788
15333
  * @secure
15789
- * @response `200` `GetForm` Success
15334
+ * @response `200` `GetForm` OK
15790
15335
  */
15791
15336
  getWorkflow: (data: GetWorkflowRequest, params: RequestParams = {}) =>
15792
15337
  this.request<GetForm, any>({
@@ -15807,7 +15352,7 @@ export class Api<
15807
15352
  * @name LogoutList
15808
15353
  * @request GET:/sso/logout
15809
15354
  * @secure
15810
- * @response `200` `void` Success
15355
+ * @response `200` `void` OK
15811
15356
  */
15812
15357
  logoutList: (params: RequestParams = {}) =>
15813
15358
  this.request<void, any>({