@matech/thebigpos-sdk 2.49.0-rc0 → 2.49.3-rc1

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
@@ -44,6 +44,18 @@ export type SigningMethod = "ConsumerConnect" | "POSF";
44
44
 
45
45
  export type SSOIntegrationType = "ConsumerConnect" | "TheBigPOS" | "POSF";
46
46
 
47
+ export type LosWebhookInventoryStatus =
48
+ | "Unknown"
49
+ | "Healthy"
50
+ | "Disabled"
51
+ | "Missing";
52
+
53
+ export type LosWebhookEntryStatus =
54
+ | "Registered"
55
+ | "Disabled"
56
+ | "Missing"
57
+ | "Extra";
58
+
47
59
  export type LosSyncStepSeverity = "Success" | "Info" | "Warning" | "Error";
48
60
 
49
61
  export type LosOperationStatus =
@@ -54,6 +66,14 @@ export type LosOperationStatus =
54
66
  | "PermanentFailure"
55
67
  | "Locked";
56
68
 
69
+ export type LosCredentialHealthStatus =
70
+ | "Unknown"
71
+ | "Healthy"
72
+ | "InvalidCredentials"
73
+ | "Forbidden"
74
+ | "TransportError"
75
+ | "NotConfigured";
76
+
57
77
  export type LogLevel = "None" | "Info" | "Warning" | "Error";
58
78
 
59
79
  export type LoanType = "Fha" | "Conventional" | "UsdaRd" | "Va" | "Other";
@@ -82,7 +102,19 @@ export type LoanRole =
82
102
  | "SettlementAgent"
83
103
  | "Admin";
84
104
 
85
- export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell";
105
+ export type LoanRealEstateStatus = "Keep" | "Rent" | "Sell" | "PendingSale";
106
+
107
+ export type LoanRealEstateOccupancyType =
108
+ | "PrimaryHome"
109
+ | "SecondHome"
110
+ | "InvestmentProperty"
111
+ | "FHASecondaryResidence";
112
+
113
+ export type LoanRealEstateIntendedUsageType =
114
+ | "PrimaryResidence"
115
+ | "SecondHome"
116
+ | "Investment"
117
+ | "Other";
86
118
 
87
119
  export type LoanQueueType =
88
120
  | "Unknown"
@@ -249,7 +281,13 @@ export type LoanHousingType = "NoExpense" | "Own" | "Rent";
249
281
 
250
282
  export type LoanHomeOwnershipType = "Counseling" | "Education" | "Other";
251
283
 
252
- export type LoanHomeOwnershipFormat = "InPerson" | "Online" | "Telephone";
284
+ export type LoanHomeOwnershipFormat =
285
+ | "InPerson"
286
+ | "Online"
287
+ | "Telephone"
288
+ | "FaceToFace"
289
+ | "Hybrid"
290
+ | "Internet";
253
291
 
254
292
  export type LoanHispanicEthnicity =
255
293
  | "Mexican"
@@ -271,7 +309,7 @@ export type LoanGiftSource =
271
309
  | "Institutional"
272
310
  | "Borrower";
273
311
 
274
- export type LoanGiftAssetType = "Cash" | "Asset" | "Equity";
312
+ export type LoanGiftAssetType = "Cash" | "Asset" | "Equity" | "Grant";
275
313
 
276
314
  export type LoanGenderType = "Male" | "Female";
277
315
 
@@ -333,7 +371,13 @@ export type LoanDocumentType =
333
371
  | "VaCertificateOfEligibility"
334
372
  | "Appraisal"
335
373
  | "CreditReport"
336
- | "CondoMasterPolicy";
374
+ | "CondoMasterPolicy"
375
+ | "EConsent"
376
+ | "CreditAuthorization"
377
+ | "TextOptIn"
378
+ | "LoanComparison"
379
+ | "AiGeneratedDocument"
380
+ | "Unidentified";
337
381
 
338
382
  export type LoanDocumentFolderPermissionLevel =
339
383
  | "None"
@@ -376,7 +420,8 @@ export type LoanAccountAssetType =
376
420
  | "IndividualDevelopmentAccount"
377
421
  | "TrustAccount"
378
422
  | "CashValueOfLifeInsurance"
379
- | "Other";
423
+ | "Other"
424
+ | "StockOptions";
380
425
 
381
426
  export type LoanAccessScopeType = "User" | "Branch";
382
427
 
@@ -480,7 +525,8 @@ export type AuditChangeType =
480
525
  | "HardDeleted"
481
526
  | "Restored"
482
527
  | "Deactivated"
483
- | "Reactivated";
528
+ | "Reactivated"
529
+ | "Accessed";
484
530
 
485
531
  export type AiUrlSourceScope = "FullDomain" | "SpecificPath";
486
532
 
@@ -697,11 +743,6 @@ export interface AccountBillingRequest {
697
743
  contractedRate: number;
698
744
  }
699
745
 
700
- export interface AccountDeactivated {
701
- accountDeactivated: boolean;
702
- email: string;
703
- }
704
-
705
746
  export interface AccountFailureCount {
706
747
  /** @format uuid */
707
748
  accountId: string;
@@ -709,23 +750,6 @@ export interface AccountFailureCount {
709
750
  count: number;
710
751
  }
711
752
 
712
- export interface AccountReactivationCompleteRequest {
713
- /** @format uuid */
714
- token: string;
715
- /** @minLength 8 */
716
- newPassword: string;
717
- }
718
-
719
- export interface AccountReactivationRequest {
720
- /**
721
- * @format email
722
- * @minLength 1
723
- */
724
- email: string;
725
- /** @format uuid */
726
- siteConfigurationId: string;
727
- }
728
-
729
753
  export interface AccountSettings {
730
754
  isSmsEnabled: boolean;
731
755
  isLoanEditEnabled: boolean;
@@ -1695,6 +1719,7 @@ export interface CompanyDocument {
1695
1719
  /** @format int64 */
1696
1720
  fileSizeBytes: number;
1697
1721
  inlineContent?: string | null;
1722
+ previewImage?: string | null;
1698
1723
  indexStatus: CompanyDocumentIndexStatusEnum;
1699
1724
  indexError?: string | null;
1700
1725
  /** @format date-time */
@@ -1728,6 +1753,10 @@ export interface CompanyDocumentPaginated {
1728
1753
  count: number;
1729
1754
  }
1730
1755
 
1756
+ export interface CompanyDocumentPreviewsRequest {
1757
+ documentIds: string[];
1758
+ }
1759
+
1731
1760
  export interface CompanyDocumentSearchCriteria {
1732
1761
  searchText?: string | null;
1733
1762
  /** @format uuid */
@@ -3062,6 +3091,9 @@ export interface Invite {
3062
3091
  oneTimeToken: string;
3063
3092
  /** @format date-time */
3064
3093
  createdAt: string;
3094
+ /** @format date-time */
3095
+ expiresAt?: string | null;
3096
+ status: string;
3065
3097
  invitedBy?: User | null;
3066
3098
  loan: LoanIdentifier;
3067
3099
  url: string;
@@ -3713,11 +3745,17 @@ export interface LoanBorrowerGiftRequest {
3713
3745
  isDeposited?: boolean | null;
3714
3746
  source?: LoanGiftSource | null;
3715
3747
  assetType?: LoanGiftAssetType | null;
3748
+ grantorDonorName?: string | null;
3749
+ /** @format double */
3750
+ amountAppliedToDownPayment?: number | null;
3751
+ /** @format double */
3752
+ amountAppliedToClosingCosts?: number | null;
3716
3753
  }
3717
3754
 
3718
3755
  export interface LoanBorrowerHomeOwnership {
3719
3756
  /** @format uuid */
3720
3757
  id?: string | null;
3758
+ isCompleted?: boolean | null;
3721
3759
  /** @format date */
3722
3760
  dateCompleted?: string | null;
3723
3761
  type?: LoanHomeOwnershipType | null;
@@ -3730,16 +3768,19 @@ export interface LoanBorrowerHomeOwnershipProvider {
3730
3768
  id?: string | null;
3731
3769
  name?: string | null;
3732
3770
  phoneNumber?: string | null;
3771
+ hudAgencyId?: string | null;
3733
3772
  address?: AddressV3 | null;
3734
3773
  }
3735
3774
 
3736
3775
  export interface LoanBorrowerHomeOwnershipProviderRequest {
3737
3776
  name?: string | null;
3738
3777
  phoneNumber?: string | null;
3778
+ hudAgencyId?: string | null;
3739
3779
  address?: AddressRequest | null;
3740
3780
  }
3741
3781
 
3742
3782
  export interface LoanBorrowerHomeOwnershipRequest {
3783
+ isCompleted?: boolean | null;
3743
3784
  /** @format date */
3744
3785
  dateCompleted?: string | null;
3745
3786
  type?: LoanHomeOwnershipType | null;
@@ -3889,7 +3930,9 @@ export interface LoanBorrowerRealEstateAsset {
3889
3930
  /** @format uuid */
3890
3931
  id?: string | null;
3891
3932
  status?: LoanRealEstateStatus | null;
3892
- occupancy?: LoanOccupancyType | null;
3933
+ occupancy?: LoanRealEstateOccupancyType | null;
3934
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3935
+ intendedUsageOtherDescription?: string | null;
3893
3936
  /** @format double */
3894
3937
  marketValue?: number | null;
3895
3938
  /** @format double */
@@ -3947,7 +3990,9 @@ export interface LoanBorrowerRealEstateAssetMortgageRequest {
3947
3990
 
3948
3991
  export interface LoanBorrowerRealEstateAssetRequest {
3949
3992
  status?: LoanRealEstateStatus | null;
3950
- occupancy?: LoanOccupancyType | null;
3993
+ occupancy?: LoanRealEstateOccupancyType | null;
3994
+ intendedUsage?: LoanRealEstateIntendedUsageType | null;
3995
+ intendedUsageOtherDescription?: string | null;
3951
3996
  /** @format double */
3952
3997
  marketValue?: number | null;
3953
3998
  /** @format double */
@@ -4805,6 +4850,15 @@ export interface LoanUser {
4805
4850
  createdAt: string;
4806
4851
  }
4807
4852
 
4853
+ export interface LosCredentialHealth {
4854
+ /** @format uuid */
4855
+ accountId: string;
4856
+ status: LosCredentialHealthStatusEnum;
4857
+ /** @format date-time */
4858
+ checkedAtUtc: string;
4859
+ message: string;
4860
+ }
4861
+
4808
4862
  export interface LosCredentials {
4809
4863
  /** @format uuid */
4810
4864
  id: string;
@@ -4813,6 +4867,77 @@ export interface LosCredentials {
4813
4867
  instanceID: string;
4814
4868
  }
4815
4869
 
4870
+ export interface LosIntegration {
4871
+ /** @format uuid */
4872
+ accountId: string;
4873
+ accountName?: string | null;
4874
+ instanceID: string;
4875
+ encompassEnvironment: LosIntegrationEncompassEnvironmentEnum;
4876
+ signingMethod: LosIntegrationSigningMethodEnum;
4877
+ consumerConnectWidgetHost?: string | null;
4878
+ defaultLoanOfficerUserName?: string | null;
4879
+ loanTemplate?: string | null;
4880
+ loanAssignmentRole?: string | null;
4881
+ clearStateIfUnlicensed: boolean;
4882
+ subscriptionId?: string | null;
4883
+ environment?: string | null;
4884
+ hasSigningKey: boolean;
4885
+ health?: LosCredentialHealth | null;
4886
+ webhooks?: LosWebhookInventory | null;
4887
+ }
4888
+
4889
+ export interface LosIntegrationCredentials {
4890
+ /** @format uuid */
4891
+ id: string;
4892
+ /** @format uuid */
4893
+ accountID: string;
4894
+ instanceID: string;
4895
+ encompassEnvironment: LosIntegrationCredentialsEncompassEnvironmentEnum;
4896
+ signingMethod: LosIntegrationCredentialsSigningMethodEnum;
4897
+ consumerConnectWidgetHost?: string | null;
4898
+ defaultLoanOfficerUserName?: string | null;
4899
+ loanTemplate?: string | null;
4900
+ loanAssignmentRole?: string | null;
4901
+ clearStateIfUnlicensed: boolean;
4902
+ subscriptionId?: string | null;
4903
+ environment?: string | null;
4904
+ clientID?: string | null;
4905
+ clientSecret?: string | null;
4906
+ signingKeyId?: string | null;
4907
+ signingKey?: string | null;
4908
+ secretsDecrypted: boolean;
4909
+ }
4910
+
4911
+ export interface LosIntegrationPaginated {
4912
+ rows: LosIntegration[];
4913
+ pagination: Pagination;
4914
+ /** @format int64 */
4915
+ count: number;
4916
+ }
4917
+
4918
+ export interface LosIntegrationsBatchRequest {
4919
+ accountIds: string[];
4920
+ }
4921
+
4922
+ export interface LosIntegrationsSearchCriteria {
4923
+ searchText?: string | null;
4924
+ }
4925
+
4926
+ export interface LosIntegrationsSummary {
4927
+ /** @format int32 */
4928
+ totalIntegrations: number;
4929
+ /** @format int32 */
4930
+ healthyCount: number;
4931
+ /** @format int32 */
4932
+ failingCount: number;
4933
+ /** @format int32 */
4934
+ unknownCount: number;
4935
+ /** @format int32 */
4936
+ accountsMissingExpectedWebhook: number;
4937
+ /** @format int32 */
4938
+ webhookUnknownCount: number;
4939
+ }
4940
+
4816
4941
  export interface LosLoanCreationRequest {
4817
4942
  loanOfficerUserName?: string | null;
4818
4943
  loanTemplate?: string | null;
@@ -4945,6 +5070,29 @@ export interface LosWebhook {
4945
5070
  enableSubscription: boolean;
4946
5071
  }
4947
5072
 
5073
+ export interface LosWebhookEntry {
5074
+ path: string;
5075
+ endpoint: string;
5076
+ resource: string;
5077
+ events: string[];
5078
+ /** @format uuid */
5079
+ subscriptionId?: string | null;
5080
+ enableSubscription?: boolean | null;
5081
+ status: LosWebhookEntryStatusEnum;
5082
+ }
5083
+
5084
+ export interface LosWebhookInventory {
5085
+ /** @format uuid */
5086
+ accountId: string;
5087
+ overallStatus: LosWebhookInventoryOverallStatusEnum;
5088
+ entries: LosWebhookEntry[];
5089
+ /** @format int32 */
5090
+ missingCount: number;
5091
+ /** @format date-time */
5092
+ checkedAtUtc: string;
5093
+ message: string;
5094
+ }
5095
+
4948
5096
  export interface ManualDocumentClassificationRequest {
4949
5097
  documentType: ManualDocumentClassificationRequestDocumentTypeEnum;
4950
5098
  }
@@ -6931,6 +7079,11 @@ export interface UserBase {
6931
7079
  email: string;
6932
7080
  }
6933
7081
 
7082
+ export interface UserDeactivated {
7083
+ accountDeactivated: boolean;
7084
+ email: string;
7085
+ }
7086
+
6934
7087
  export interface UserDevice {
6935
7088
  /** @format uuid */
6936
7089
  id: string;
@@ -7120,6 +7273,23 @@ export interface UserPublic {
7120
7273
  title?: string | null;
7121
7274
  }
7122
7275
 
7276
+ export interface UserReactivationCompleteRequest {
7277
+ /** @format uuid */
7278
+ token: string;
7279
+ /** @minLength 8 */
7280
+ newPassword: string;
7281
+ }
7282
+
7283
+ export interface UserReactivationRequest {
7284
+ /**
7285
+ * @format email
7286
+ * @minLength 1
7287
+ */
7288
+ email: string;
7289
+ /** @format uuid */
7290
+ siteConfigurationId: string;
7291
+ }
7292
+
7123
7293
  export interface UserRelation {
7124
7294
  /** @format uuid */
7125
7295
  userId1: string;
@@ -7286,7 +7456,8 @@ export type AuditLogEntryChangeTypeEnum =
7286
7456
  | "HardDeleted"
7287
7457
  | "Restored"
7288
7458
  | "Deactivated"
7289
- | "Reactivated";
7459
+ | "Reactivated"
7460
+ | "Accessed";
7290
7461
 
7291
7462
  export type BorrowerCountRoleEnum =
7292
7463
  | "Borrower"
@@ -7694,6 +7865,26 @@ export type LoanUserLoanRoleEnum =
7694
7865
  | "SettlementAgent"
7695
7866
  | "Admin";
7696
7867
 
7868
+ export type LosCredentialHealthStatusEnum =
7869
+ | "Unknown"
7870
+ | "Healthy"
7871
+ | "InvalidCredentials"
7872
+ | "Forbidden"
7873
+ | "TransportError"
7874
+ | "NotConfigured";
7875
+
7876
+ export type LosIntegrationEncompassEnvironmentEnum = "Production" | "UAT";
7877
+
7878
+ export type LosIntegrationSigningMethodEnum = "ConsumerConnect" | "POSF";
7879
+
7880
+ export type LosIntegrationCredentialsEncompassEnvironmentEnum =
7881
+ | "Production"
7882
+ | "UAT";
7883
+
7884
+ export type LosIntegrationCredentialsSigningMethodEnum =
7885
+ | "ConsumerConnect"
7886
+ | "POSF";
7887
+
7697
7888
  export type LosOperationTrackingStatusEnum =
7698
7889
  | "Pending"
7699
7890
  | "Success"
@@ -7704,6 +7895,18 @@ export type LosOperationTrackingStatusEnum =
7704
7895
 
7705
7896
  export type LosSyncStepSeverityEnum = "Success" | "Info" | "Warning" | "Error";
7706
7897
 
7898
+ export type LosWebhookEntryStatusEnum =
7899
+ | "Registered"
7900
+ | "Disabled"
7901
+ | "Missing"
7902
+ | "Extra";
7903
+
7904
+ export type LosWebhookInventoryOverallStatusEnum =
7905
+ | "Unknown"
7906
+ | "Healthy"
7907
+ | "Disabled"
7908
+ | "Missing";
7909
+
7707
7910
  export type ManualDocumentClassificationRequestDocumentTypeEnum =
7708
7911
  | "W2"
7709
7912
  | "Paystub"
@@ -7762,7 +7965,13 @@ export type ManualDocumentClassificationRequestDocumentTypeEnum =
7762
7965
  | "VaCertificateOfEligibility"
7763
7966
  | "Appraisal"
7764
7967
  | "CreditReport"
7765
- | "CondoMasterPolicy";
7968
+ | "CondoMasterPolicy"
7969
+ | "EConsent"
7970
+ | "CreditAuthorization"
7971
+ | "TextOptIn"
7972
+ | "LoanComparison"
7973
+ | "AiGeneratedDocument"
7974
+ | "Unidentified";
7766
7975
 
7767
7976
  export type SiteConfigurationTypeEnum =
7768
7977
  | "None"
@@ -8112,7 +8321,7 @@ export class HttpClient<SecurityDataType = unknown> {
8112
8321
 
8113
8322
  /**
8114
8323
  * @title The Big POS API
8115
- * @version v2.49.0
8324
+ * @version v2.49.3
8116
8325
  * @termsOfService https://www.thebigpos.com/terms-of-use/
8117
8326
  * @contact Mortgage Automation Technologies <support@thebigpos.com> (https://www.thebigpos.com/terms-of-use/)
8118
8327
  */
@@ -8244,53 +8453,6 @@ export class Api<
8244
8453
  ...params,
8245
8454
  }),
8246
8455
 
8247
- /**
8248
- * No description
8249
- *
8250
- * @tags AccountReactivation
8251
- * @name RequestAccountReactivation
8252
- * @summary Request account reactivation
8253
- * @request POST:/api/account/reactivation/request
8254
- * @secure
8255
- * @response `204` `void` No Content
8256
- */
8257
- requestAccountReactivation: (
8258
- data: AccountReactivationRequest,
8259
- params: RequestParams = {},
8260
- ) =>
8261
- this.request<void, any>({
8262
- path: `/api/account/reactivation/request`,
8263
- method: "POST",
8264
- body: data,
8265
- secure: true,
8266
- type: "application/json",
8267
- ...params,
8268
- }),
8269
-
8270
- /**
8271
- * No description
8272
- *
8273
- * @tags AccountReactivation
8274
- * @name CompleteAccountReactivation
8275
- * @summary Complete account reactivation with new password
8276
- * @request POST:/api/account/reactivation/complete
8277
- * @secure
8278
- * @response `204` `void` No Content
8279
- * @response `400` `ProblemDetails` Bad Request
8280
- */
8281
- completeAccountReactivation: (
8282
- data: AccountReactivationCompleteRequest,
8283
- params: RequestParams = {},
8284
- ) =>
8285
- this.request<void, ProblemDetails>({
8286
- path: `/api/account/reactivation/complete`,
8287
- method: "POST",
8288
- body: data,
8289
- secure: true,
8290
- type: "application/json",
8291
- ...params,
8292
- }),
8293
-
8294
8456
  /**
8295
8457
  * No description
8296
8458
  *
@@ -10033,11 +10195,11 @@ export class Api<
10033
10195
  * @summary Get Token
10034
10196
  * @request POST:/api/token
10035
10197
  * @secure
10036
- * @response `200` `AccountDeactivated` OK
10198
+ * @response `200` `UserDeactivated` OK
10037
10199
  * @response `422` `UnprocessableEntity` Unprocessable Content
10038
10200
  */
10039
10201
  getToken: (data: TokenRequest, params: RequestParams = {}) =>
10040
- this.request<AccountDeactivated, UnprocessableEntity>({
10202
+ this.request<UserDeactivated, UnprocessableEntity>({
10041
10203
  path: `/api/token`,
10042
10204
  method: "POST",
10043
10205
  body: data,
@@ -10055,14 +10217,14 @@ export class Api<
10055
10217
  * @summary Get Token From Challenge Code
10056
10218
  * @request POST:/api/token/code
10057
10219
  * @secure
10058
- * @response `200` `AccountDeactivated` OK
10220
+ * @response `200` `UserDeactivated` OK
10059
10221
  * @response `422` `UnprocessableEntity` Unprocessable Content
10060
10222
  */
10061
10223
  getTokenFromChallengeCode: (
10062
10224
  data: TokenChallengeRequest,
10063
10225
  params: RequestParams = {},
10064
10226
  ) =>
10065
- this.request<AccountDeactivated, UnprocessableEntity>({
10227
+ this.request<UserDeactivated, UnprocessableEntity>({
10066
10228
  path: `/api/token/code`,
10067
10229
  method: "POST",
10068
10230
  body: data,
@@ -10718,10 +10880,18 @@ export class Api<
10718
10880
  * @response `200` `CompanyDocument` OK
10719
10881
  * @response `404` `ProblemDetails` Not Found
10720
10882
  */
10721
- getCompanyDocument: (id: string, params: RequestParams = {}) =>
10883
+ getCompanyDocument: (
10884
+ id: string,
10885
+ query?: {
10886
+ /** @default false */
10887
+ preview?: boolean;
10888
+ },
10889
+ params: RequestParams = {},
10890
+ ) =>
10722
10891
  this.request<CompanyDocument, ProblemDetails>({
10723
10892
  path: `/api/company-documents/${id}`,
10724
10893
  method: "GET",
10894
+ query: query,
10725
10895
  secure: true,
10726
10896
  format: "json",
10727
10897
  ...params,
@@ -10774,6 +10944,31 @@ export class Api<
10774
10944
  ...params,
10775
10945
  }),
10776
10946
 
10947
+ /**
10948
+ * No description
10949
+ *
10950
+ * @tags CompanyDocuments
10951
+ * @name GetCompanyDocumentPreviews
10952
+ * @summary Get company document previews in batch
10953
+ * @request POST:/api/company-documents/previews
10954
+ * @secure
10955
+ * @response `200` `Record<string,string>` OK
10956
+ * @response `400` `ProblemDetails` Bad Request
10957
+ */
10958
+ getCompanyDocumentPreviews: (
10959
+ data: CompanyDocumentPreviewsRequest,
10960
+ params: RequestParams = {},
10961
+ ) =>
10962
+ this.request<Record<string, string>, ProblemDetails>({
10963
+ path: `/api/company-documents/previews`,
10964
+ method: "POST",
10965
+ body: data,
10966
+ secure: true,
10967
+ type: "application/json",
10968
+ format: "json",
10969
+ ...params,
10970
+ }),
10971
+
10777
10972
  /**
10778
10973
  * No description
10779
10974
  *
@@ -12064,6 +12259,283 @@ export class Api<
12064
12259
  ...params,
12065
12260
  }),
12066
12261
 
12262
+ /**
12263
+ * No description
12264
+ *
12265
+ * @tags EncompassIntegrations
12266
+ * @name SearchEncompassIntegrations
12267
+ * @summary Search registered Encompass integrations across accounts (SuperAdmin)
12268
+ * @request POST:/api/monitoring/encompass-integrations/search
12269
+ * @secure
12270
+ * @response `200` `LosIntegrationPaginated` OK
12271
+ * @response `400` `ProblemDetails` Bad Request
12272
+ * @response `401` `ProblemDetails` Unauthorized
12273
+ * @response `403` `ProblemDetails` Forbidden
12274
+ */
12275
+ searchEncompassIntegrations: (
12276
+ data: LosIntegrationsSearchCriteria,
12277
+ query?: {
12278
+ /** @format int32 */
12279
+ pageSize?: number;
12280
+ /** @format int32 */
12281
+ pageNumber?: number;
12282
+ sortBy?: string;
12283
+ sortDirection?: string;
12284
+ /** @format uuid */
12285
+ accountId?: string;
12286
+ },
12287
+ params: RequestParams = {},
12288
+ ) =>
12289
+ this.request<LosIntegrationPaginated, ProblemDetails>({
12290
+ path: `/api/monitoring/encompass-integrations/search`,
12291
+ method: "POST",
12292
+ query: query,
12293
+ body: data,
12294
+ secure: true,
12295
+ type: "application/json",
12296
+ format: "json",
12297
+ ...params,
12298
+ }),
12299
+
12300
+ /**
12301
+ * No description
12302
+ *
12303
+ * @tags EncompassIntegrations
12304
+ * @name GetEncompassIntegrationsSummary
12305
+ * @summary Summarize registered Encompass integration health across accounts (SuperAdmin)
12306
+ * @request POST:/api/monitoring/encompass-integrations/summary
12307
+ * @secure
12308
+ * @response `200` `LosIntegrationsSummary` OK
12309
+ * @response `401` `ProblemDetails` Unauthorized
12310
+ * @response `403` `ProblemDetails` Forbidden
12311
+ */
12312
+ getEncompassIntegrationsSummary: (
12313
+ data: LosIntegrationsSearchCriteria,
12314
+ query?: {
12315
+ /** @format uuid */
12316
+ accountId?: string;
12317
+ },
12318
+ params: RequestParams = {},
12319
+ ) =>
12320
+ this.request<LosIntegrationsSummary, ProblemDetails>({
12321
+ path: `/api/monitoring/encompass-integrations/summary`,
12322
+ method: "POST",
12323
+ query: query,
12324
+ body: data,
12325
+ secure: true,
12326
+ type: "application/json",
12327
+ format: "json",
12328
+ ...params,
12329
+ }),
12330
+
12331
+ /**
12332
+ * No description
12333
+ *
12334
+ * @tags EncompassIntegrations
12335
+ * @name GetEncompassIntegrationsHealth
12336
+ * @summary Get Encompass login health for a set of accounts (SuperAdmin)
12337
+ * @request POST:/api/monitoring/encompass-integrations/health
12338
+ * @secure
12339
+ * @response `200` `(LosCredentialHealth)[]` OK
12340
+ * @response `400` `ProblemDetails` Bad Request
12341
+ * @response `401` `ProblemDetails` Unauthorized
12342
+ * @response `403` `ProblemDetails` Forbidden
12343
+ */
12344
+ getEncompassIntegrationsHealth: (
12345
+ data: LosIntegrationsBatchRequest,
12346
+ params: RequestParams = {},
12347
+ ) =>
12348
+ this.request<LosCredentialHealth[], ProblemDetails>({
12349
+ path: `/api/monitoring/encompass-integrations/health`,
12350
+ method: "POST",
12351
+ body: data,
12352
+ secure: true,
12353
+ type: "application/json",
12354
+ format: "json",
12355
+ ...params,
12356
+ }),
12357
+
12358
+ /**
12359
+ * No description
12360
+ *
12361
+ * @tags EncompassIntegrations
12362
+ * @name RecheckEncompassIntegrationHealth
12363
+ * @summary Force a fresh Encompass login health check for one account (SuperAdmin)
12364
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/health/recheck
12365
+ * @secure
12366
+ * @response `200` `LosCredentialHealth` OK
12367
+ * @response `401` `ProblemDetails` Unauthorized
12368
+ * @response `403` `ProblemDetails` Forbidden
12369
+ */
12370
+ recheckEncompassIntegrationHealth: (
12371
+ accountId: string,
12372
+ params: RequestParams = {},
12373
+ ) =>
12374
+ this.request<LosCredentialHealth, ProblemDetails>({
12375
+ path: `/api/monitoring/encompass-integrations/${accountId}/health/recheck`,
12376
+ method: "POST",
12377
+ secure: true,
12378
+ format: "json",
12379
+ ...params,
12380
+ }),
12381
+
12382
+ /**
12383
+ * No description
12384
+ *
12385
+ * @tags EncompassIntegrations
12386
+ * @name GetEncompassIntegrationsWebhooks
12387
+ * @summary Get registered-versus-expected Encompass webhooks for a set of accounts (SuperAdmin)
12388
+ * @request POST:/api/monitoring/encompass-integrations/webhooks
12389
+ * @secure
12390
+ * @response `200` `(LosWebhookInventory)[]` OK
12391
+ * @response `400` `ProblemDetails` Bad Request
12392
+ * @response `401` `ProblemDetails` Unauthorized
12393
+ * @response `403` `ProblemDetails` Forbidden
12394
+ */
12395
+ getEncompassIntegrationsWebhooks: (
12396
+ data: LosIntegrationsBatchRequest,
12397
+ params: RequestParams = {},
12398
+ ) =>
12399
+ this.request<LosWebhookInventory[], ProblemDetails>({
12400
+ path: `/api/monitoring/encompass-integrations/webhooks`,
12401
+ method: "POST",
12402
+ body: data,
12403
+ secure: true,
12404
+ type: "application/json",
12405
+ format: "json",
12406
+ ...params,
12407
+ }),
12408
+
12409
+ /**
12410
+ * No description
12411
+ *
12412
+ * @tags EncompassIntegrations
12413
+ * @name RecheckEncompassIntegrationWebhooks
12414
+ * @summary Force a fresh Encompass webhook inventory read for one account (SuperAdmin)
12415
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks/recheck
12416
+ * @secure
12417
+ * @response `200` `LosWebhookInventory` OK
12418
+ * @response `401` `ProblemDetails` Unauthorized
12419
+ * @response `403` `ProblemDetails` Forbidden
12420
+ */
12421
+ recheckEncompassIntegrationWebhooks: (
12422
+ accountId: string,
12423
+ params: RequestParams = {},
12424
+ ) =>
12425
+ this.request<LosWebhookInventory, ProblemDetails>({
12426
+ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/recheck`,
12427
+ method: "POST",
12428
+ secure: true,
12429
+ format: "json",
12430
+ ...params,
12431
+ }),
12432
+
12433
+ /**
12434
+ * No description
12435
+ *
12436
+ * @tags EncompassIntegrations
12437
+ * @name GetEncompassIntegrationCredentials
12438
+ * @summary Get Encompass credentials including secrets for a specific account (SuperAdmin)
12439
+ * @request GET:/api/monitoring/encompass-integrations/{accountId}/credentials
12440
+ * @secure
12441
+ * @response `200` `LosIntegrationCredentials` OK
12442
+ * @response `401` `ProblemDetails` Unauthorized
12443
+ * @response `403` `ProblemDetails` Forbidden
12444
+ * @response `404` `ProblemDetails` Not Found
12445
+ */
12446
+ getEncompassIntegrationCredentials: (
12447
+ accountId: string,
12448
+ params: RequestParams = {},
12449
+ ) =>
12450
+ this.request<LosIntegrationCredentials, ProblemDetails>({
12451
+ path: `/api/monitoring/encompass-integrations/${accountId}/credentials`,
12452
+ method: "GET",
12453
+ secure: true,
12454
+ format: "json",
12455
+ ...params,
12456
+ }),
12457
+
12458
+ /**
12459
+ * No description
12460
+ *
12461
+ * @tags EncompassIntegrations
12462
+ * @name UpdateEncompassIntegrationCredentials
12463
+ * @summary Update Encompass credentials for a specific account (SuperAdmin)
12464
+ * @request PUT:/api/monitoring/encompass-integrations/{accountId}/credentials
12465
+ * @secure
12466
+ * @response `200` `EncompassCredentialsDetail` OK
12467
+ * @response `401` `ProblemDetails` Unauthorized
12468
+ * @response `403` `ProblemDetails` Forbidden
12469
+ * @response `404` `ProblemDetails` Not Found
12470
+ */
12471
+ updateEncompassIntegrationCredentials: (
12472
+ accountId: string,
12473
+ data: EncompassCredentialsRequest,
12474
+ params: RequestParams = {},
12475
+ ) =>
12476
+ this.request<EncompassCredentialsDetail, ProblemDetails>({
12477
+ path: `/api/monitoring/encompass-integrations/${accountId}/credentials`,
12478
+ method: "PUT",
12479
+ body: data,
12480
+ secure: true,
12481
+ type: "application/json",
12482
+ format: "json",
12483
+ ...params,
12484
+ }),
12485
+
12486
+ /**
12487
+ * No description
12488
+ *
12489
+ * @tags EncompassIntegrations
12490
+ * @name RegisterEncompassIntegrationWebhook
12491
+ * @summary Register an expected Encompass webhook for a specific account (SuperAdmin)
12492
+ * @request POST:/api/monitoring/encompass-integrations/{accountId}/webhooks
12493
+ * @secure
12494
+ * @response `201` `LosWebhook` Created
12495
+ * @response `400` `ProblemDetails` Bad Request
12496
+ * @response `401` `ProblemDetails` Unauthorized
12497
+ * @response `403` `ProblemDetails` Forbidden
12498
+ */
12499
+ registerEncompassIntegrationWebhook: (
12500
+ accountId: string,
12501
+ data: CreateWebhookRequest,
12502
+ params: RequestParams = {},
12503
+ ) =>
12504
+ this.request<LosWebhook, ProblemDetails>({
12505
+ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks`,
12506
+ method: "POST",
12507
+ body: data,
12508
+ secure: true,
12509
+ type: "application/json",
12510
+ format: "json",
12511
+ ...params,
12512
+ }),
12513
+
12514
+ /**
12515
+ * No description
12516
+ *
12517
+ * @tags EncompassIntegrations
12518
+ * @name DeleteEncompassIntegrationWebhook
12519
+ * @summary Delete an Encompass webhook for a specific account (SuperAdmin)
12520
+ * @request DELETE:/api/monitoring/encompass-integrations/{accountId}/webhooks/{webhookId}
12521
+ * @secure
12522
+ * @response `204` `void` No Content
12523
+ * @response `401` `ProblemDetails` Unauthorized
12524
+ * @response `403` `ProblemDetails` Forbidden
12525
+ * @response `404` `ProblemDetails` Not Found
12526
+ */
12527
+ deleteEncompassIntegrationWebhook: (
12528
+ accountId: string,
12529
+ webhookId: string,
12530
+ params: RequestParams = {},
12531
+ ) =>
12532
+ this.request<void, ProblemDetails>({
12533
+ path: `/api/monitoring/encompass-integrations/${accountId}/webhooks/${webhookId}`,
12534
+ method: "DELETE",
12535
+ secure: true,
12536
+ ...params,
12537
+ }),
12538
+
12067
12539
  /**
12068
12540
  * No description
12069
12541
  *
@@ -14562,6 +15034,29 @@ export class Api<
14562
15034
  ...params,
14563
15035
  }),
14564
15036
 
15037
+ /**
15038
+ * No description
15039
+ *
15040
+ * @tags LoanInvites
15041
+ * @name DeleteLoanInvite
15042
+ * @summary Delete Invite
15043
+ * @request DELETE:/api/loans/{loanId}/invites/{id}
15044
+ * @secure
15045
+ * @response `204` `void` No Content
15046
+ * @response `404` `ProblemDetails` Not Found
15047
+ */
15048
+ deleteLoanInvite: (
15049
+ loanId: string,
15050
+ id: string,
15051
+ params: RequestParams = {},
15052
+ ) =>
15053
+ this.request<void, ProblemDetails>({
15054
+ path: `/api/loans/${loanId}/invites/${id}`,
15055
+ method: "DELETE",
15056
+ secure: true,
15057
+ ...params,
15058
+ }),
15059
+
14565
15060
  /**
14566
15061
  * No description
14567
15062
  *
@@ -18234,11 +18729,12 @@ export class Api<
18234
18729
  * @request PUT:/api/users/invites/{id}/resend
18235
18730
  * @secure
18236
18731
  * @response `204` `void` No Content
18732
+ * @response `400` `ProblemDetails` Bad Request
18237
18733
  * @response `401` `UnprocessableEntity` Unauthorized
18238
18734
  * @response `404` `UnprocessableEntity` Not Found
18239
18735
  */
18240
18736
  resendInviteNotification: (id: string, params: RequestParams = {}) =>
18241
- this.request<void, UnprocessableEntity>({
18737
+ this.request<void, ProblemDetails | UnprocessableEntity>({
18242
18738
  path: `/api/users/invites/${id}/resend`,
18243
18739
  method: "PUT",
18244
18740
  secure: true,
@@ -18254,10 +18750,11 @@ export class Api<
18254
18750
  * @request GET:/api/users/invites/{token}/verify
18255
18751
  * @secure
18256
18752
  * @response `200` `Invite` OK
18753
+ * @response `400` `ProblemDetails` Bad Request
18257
18754
  * @response `422` `UnprocessableEntity` Unprocessable Content
18258
18755
  */
18259
18756
  verifyUserInvite: (token: string, params: RequestParams = {}) =>
18260
- this.request<Invite, UnprocessableEntity>({
18757
+ this.request<Invite, ProblemDetails | UnprocessableEntity>({
18261
18758
  path: `/api/users/invites/${token}/verify`,
18262
18759
  method: "GET",
18263
18760
  secure: true,
@@ -18265,6 +18762,53 @@ export class Api<
18265
18762
  ...params,
18266
18763
  }),
18267
18764
 
18765
+ /**
18766
+ * No description
18767
+ *
18768
+ * @tags UserReactivation
18769
+ * @name RequestUserReactivation
18770
+ * @summary Request user reactivation
18771
+ * @request POST:/api/users/reactivation/request
18772
+ * @secure
18773
+ * @response `204` `void` No Content
18774
+ */
18775
+ requestUserReactivation: (
18776
+ data: UserReactivationRequest,
18777
+ params: RequestParams = {},
18778
+ ) =>
18779
+ this.request<void, any>({
18780
+ path: `/api/users/reactivation/request`,
18781
+ method: "POST",
18782
+ body: data,
18783
+ secure: true,
18784
+ type: "application/json",
18785
+ ...params,
18786
+ }),
18787
+
18788
+ /**
18789
+ * No description
18790
+ *
18791
+ * @tags UserReactivation
18792
+ * @name CompleteUserReactivation
18793
+ * @summary Complete user reactivation with new password
18794
+ * @request POST:/api/users/reactivation/complete
18795
+ * @secure
18796
+ * @response `204` `void` No Content
18797
+ * @response `400` `ProblemDetails` Bad Request
18798
+ */
18799
+ completeUserReactivation: (
18800
+ data: UserReactivationCompleteRequest,
18801
+ params: RequestParams = {},
18802
+ ) =>
18803
+ this.request<void, ProblemDetails>({
18804
+ path: `/api/users/reactivation/complete`,
18805
+ method: "POST",
18806
+ body: data,
18807
+ secure: true,
18808
+ type: "application/json",
18809
+ ...params,
18810
+ }),
18811
+
18268
18812
  /**
18269
18813
  * No description
18270
18814
  *
@@ -18388,10 +18932,11 @@ export class Api<
18388
18932
  * @request POST:/api/users
18389
18933
  * @secure
18390
18934
  * @response `200` `DetailedUser` OK
18935
+ * @response `409` `ProblemDetails` Conflict
18391
18936
  * @response `422` `UnprocessableEntity` Unprocessable Content
18392
18937
  */
18393
18938
  createUser: (data: CreateUserRequest, params: RequestParams = {}) =>
18394
- this.request<DetailedUser, UnprocessableEntity>({
18939
+ this.request<DetailedUser, ProblemDetails | UnprocessableEntity>({
18395
18940
  path: `/api/users`,
18396
18941
  method: "POST",
18397
18942
  body: data,
@@ -18712,9 +19257,11 @@ export class Api<
18712
19257
  * @request PUT:/api/users/me
18713
19258
  * @secure
18714
19259
  * @response `200` `DetailedUser` OK
19260
+ * @response `403` `ProblemDetails` Forbidden
19261
+ * @response `409` `ProblemDetails` Conflict
18715
19262
  */
18716
19263
  replaceMe: (data: UpdateMeRequest, params: RequestParams = {}) =>
18717
- this.request<DetailedUser, any>({
19264
+ this.request<DetailedUser, ProblemDetails>({
18718
19265
  path: `/api/users/me`,
18719
19266
  method: "PUT",
18720
19267
  body: data,