@experian-ecs/connected-api-sdk 1.2.0 → 1.4.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/README.md +187 -1
- package/dist/esm/index.mjs +840 -498
- package/dist/esm/index.mjs.map +1 -1
- package/dist/index.d.ts +723 -54
- package/dist/umd/index.umd.js +1 -1
- package/dist/umd/index.umd.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -12,19 +12,21 @@
|
|
|
12
12
|
* OTHER LIABILITY ARISING FROM OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS CODE.
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
|
+
type ConnectedSolutionsAPIErrorType = 'CLIENT_SIDE_ERROR' | 'AUTHENTICATION_ERROR' | 'RATE_LIMIT_ERROR' | 'SERVER_SIDE_ERROR';
|
|
15
16
|
type ConnectedSolutionsAPIErrorData = {
|
|
17
|
+
type: ConnectedSolutionsAPIErrorType;
|
|
16
18
|
dev_url: string;
|
|
17
19
|
code: string;
|
|
18
20
|
message: string;
|
|
19
21
|
};
|
|
20
|
-
type ConnectedSolutionsSDKErrorTypes = '
|
|
22
|
+
type ConnectedSolutionsSDKErrorTypes = 'client_side_error' | 'authentication_error' | 'rate_limit_error' | 'sdk_error' | 'server_side_error';
|
|
21
23
|
type ConnectedSolutionsClientRawError = {
|
|
22
24
|
message: string;
|
|
23
25
|
type: ConnectedSolutionsSDKErrorTypes;
|
|
24
26
|
status?: number;
|
|
25
27
|
data?: ConnectedSolutionsAPIErrorData;
|
|
26
28
|
};
|
|
27
|
-
declare function generateError(rawError: ConnectedSolutionsClientRawError):
|
|
29
|
+
declare function generateError(rawError: ConnectedSolutionsClientRawError): ConnectedSolutionsClientSideError | ConnectedSolutionsClientAuthenticationError | ConnectedSolutionsClientServerSideError | ConnectedSolutionsClientRateLimitError | ConnectedSolutionsClientSDKError;
|
|
28
30
|
declare class ConnectedSolutionsClientError extends Error {
|
|
29
31
|
readonly message: string;
|
|
30
32
|
readonly data?: ConnectedSolutionsAPIErrorData;
|
|
@@ -32,18 +34,23 @@ declare class ConnectedSolutionsClientError extends Error {
|
|
|
32
34
|
constructor(raw: ConnectedSolutionsClientRawError);
|
|
33
35
|
static generateError: typeof generateError;
|
|
34
36
|
}
|
|
35
|
-
declare class
|
|
37
|
+
declare class ConnectedSolutionsClientSideError extends ConnectedSolutionsClientError {
|
|
36
38
|
constructor(args: ConnectedSolutionsClientRawError);
|
|
37
39
|
}
|
|
38
|
-
declare class
|
|
40
|
+
declare class ConnectedSolutionsClientAuthenticationError extends ConnectedSolutionsClientError {
|
|
39
41
|
constructor(args: ConnectedSolutionsClientRawError);
|
|
40
42
|
}
|
|
41
|
-
declare class
|
|
43
|
+
declare class ConnectedSolutionsClientServerSideError extends ConnectedSolutionsClientError {
|
|
42
44
|
constructor(args: ConnectedSolutionsClientRawError);
|
|
43
45
|
}
|
|
44
46
|
declare class ConnectedSolutionsClientSDKError extends ConnectedSolutionsClientError {
|
|
45
47
|
constructor(args: ConnectedSolutionsClientRawError);
|
|
46
48
|
}
|
|
49
|
+
declare class ConnectedSolutionsClientRateLimitError extends ConnectedSolutionsClientError {
|
|
50
|
+
constructor(args: ConnectedSolutionsClientRawError);
|
|
51
|
+
}
|
|
52
|
+
declare function mapApiErrorTypeToSDKErrorType(apiErrorType?: ConnectedSolutionsAPIErrorType): ConnectedSolutionsSDKErrorTypes;
|
|
53
|
+
declare function mapHttpStatusToSDKErrorType(status?: number): ConnectedSolutionsSDKErrorTypes;
|
|
47
54
|
|
|
48
55
|
type Entitlements = {
|
|
49
56
|
items: Entitlement[];
|
|
@@ -171,6 +178,9 @@ declare class EntitlementsService extends ApiClient {
|
|
|
171
178
|
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<ProductEligibility>>;
|
|
172
179
|
}
|
|
173
180
|
|
|
181
|
+
type ApiVersion = 'v1' | 'v2';
|
|
182
|
+
type Bureau = 'EXPERIAN' | 'EQUIFAX' | 'TRANSUNION';
|
|
183
|
+
|
|
174
184
|
interface CreditScore {
|
|
175
185
|
score_id: string;
|
|
176
186
|
bureau: Bureau;
|
|
@@ -185,7 +195,15 @@ interface CreditScore {
|
|
|
185
195
|
score_factors?: ScoreFactor[];
|
|
186
196
|
score_ingredients?: ScoreIngredient[];
|
|
187
197
|
}
|
|
188
|
-
|
|
198
|
+
interface CreditScores_V2 {
|
|
199
|
+
items: CreditScore_V2[];
|
|
200
|
+
}
|
|
201
|
+
interface CreditScore_V2 {
|
|
202
|
+
id: string;
|
|
203
|
+
bureau_scores: BureauScore[];
|
|
204
|
+
}
|
|
205
|
+
interface BureauScore extends Omit<CreditScore, 'score_id' | 'frequency' | 'next_score_date'> {
|
|
206
|
+
}
|
|
189
207
|
type ScoreModelVersion = 'FICO8' | 'VANTAGE30' | 'FICO9' | 'FICO3' | 'FICOMORTGAGE2' | 'FICOBANKCARD2' | 'FICOBANKCARD8' | 'FICOBANKCARD9' | 'FICOAUTO2' | 'FICOAUTO8' | 'FICOAUTO9' | 'VANTAGE20';
|
|
190
208
|
interface ScoreModel {
|
|
191
209
|
min: number;
|
|
@@ -249,6 +267,13 @@ type ScoreIngredientAttributeSubValueType = 'months' | 'years' | 'days' | 'amoun
|
|
|
249
267
|
interface CreditScorePostRequest {
|
|
250
268
|
product_config_id: string;
|
|
251
269
|
}
|
|
270
|
+
type BaseCreditScoreRequestOptions<Version extends ApiVersion> = {
|
|
271
|
+
include_factors?: boolean;
|
|
272
|
+
include_ingredients?: boolean;
|
|
273
|
+
version?: Version;
|
|
274
|
+
};
|
|
275
|
+
type GetCreditScoreResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditScores_V2 : CreditScore[];
|
|
276
|
+
type PostCreditScoreResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditScore_V2 : CreditScore;
|
|
252
277
|
|
|
253
278
|
type CreditScoreSimulator = FicoScoreSimulator | VantageScoreSimulator;
|
|
254
279
|
type Scenario = FicoScenario | VantageScenario;
|
|
@@ -442,6 +467,15 @@ interface CreditAttributeCategory {
|
|
|
442
467
|
oldest_open_accounts?: AttributeOldestOpenAccount[];
|
|
443
468
|
recent_hard_inquiries?: AttributeHardInquiry[];
|
|
444
469
|
}
|
|
470
|
+
interface CreditAttributes_V2 {
|
|
471
|
+
items: CreditAttribute_V2[];
|
|
472
|
+
}
|
|
473
|
+
interface CreditAttribute_V2 {
|
|
474
|
+
id: string;
|
|
475
|
+
bureau_attributes: BureauAttribute[];
|
|
476
|
+
}
|
|
477
|
+
interface BureauAttribute extends CreditAttributes {
|
|
478
|
+
}
|
|
445
479
|
type AttributeCategoryName = 'PAYMENT_HISTORY' | 'CREDIT_UTILIZATION' | 'PUBLIC_RECORDS' | 'CREDIT_AGE' | 'CREDIT_MIX' | 'HARD_INQUIRIES';
|
|
446
480
|
interface AttributeCategoryRating {
|
|
447
481
|
value: AttributeCategoryRatingName;
|
|
@@ -486,11 +520,17 @@ interface CreditAttribute {
|
|
|
486
520
|
value: string;
|
|
487
521
|
exception?: string;
|
|
488
522
|
}
|
|
523
|
+
type BaseCreditAttributeRequestOptions<Version extends ApiVersion> = {
|
|
524
|
+
version?: Version;
|
|
525
|
+
};
|
|
526
|
+
type GetCreditAttributeResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditAttributes_V2 : CreditAttributes[];
|
|
489
527
|
|
|
490
528
|
declare class CreditAttributesService extends ApiClient {
|
|
491
529
|
#private;
|
|
492
530
|
constructor(config: ConnectedSolutionsSDKConfig);
|
|
493
|
-
getCreditAttributes(
|
|
531
|
+
getCreditAttributes<Version extends ApiVersion = 'v1'>(options?: BaseCreditAttributeRequestOptions<Version> & {
|
|
532
|
+
product_config_id?: string;
|
|
533
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditAttributeResponse<Version>>>;
|
|
494
534
|
}
|
|
495
535
|
|
|
496
536
|
type BearerToken = {
|
|
@@ -535,10 +575,10 @@ declare class AuthService {
|
|
|
535
575
|
type AlertMetadata = {
|
|
536
576
|
alert_id: string;
|
|
537
577
|
customer_id: string;
|
|
538
|
-
bureau
|
|
578
|
+
bureau?: string;
|
|
539
579
|
event_key: string;
|
|
540
580
|
schema_version: string;
|
|
541
|
-
tenant_id
|
|
581
|
+
tenant_id?: string;
|
|
542
582
|
};
|
|
543
583
|
type AlertDisposition = {
|
|
544
584
|
read_status: 'Y' | 'N';
|
|
@@ -566,6 +606,14 @@ type NewInquiryDetails = {
|
|
|
566
606
|
trigger: string;
|
|
567
607
|
trigger_description: string;
|
|
568
608
|
};
|
|
609
|
+
type EquifaxNewInquiryDetails = {
|
|
610
|
+
company: Omit<Company, 'business_type'>;
|
|
611
|
+
inquiry_date: string;
|
|
612
|
+
};
|
|
613
|
+
type TransUnionNewInquiryDetails = {
|
|
614
|
+
company: Omit<Company, 'business_type'>;
|
|
615
|
+
inquiry_date: string;
|
|
616
|
+
};
|
|
569
617
|
type NewAccountDetails = {
|
|
570
618
|
company: Company;
|
|
571
619
|
balance_amount: string;
|
|
@@ -574,10 +622,33 @@ type NewAccountDetails = {
|
|
|
574
622
|
trigger: string;
|
|
575
623
|
trigger_description: string;
|
|
576
624
|
};
|
|
625
|
+
type EquifaxNewAccountDetails = {
|
|
626
|
+
company: Omit<Company, 'phone' | 'business_type'>;
|
|
627
|
+
balance_amount: string;
|
|
628
|
+
account_type: string;
|
|
629
|
+
open_date: string;
|
|
630
|
+
status_date: string;
|
|
631
|
+
balance_date: string;
|
|
632
|
+
};
|
|
633
|
+
type TransUnionNewAccountDetails = {
|
|
634
|
+
company: Omit<Company, 'phone'>;
|
|
635
|
+
balance_amount: string;
|
|
636
|
+
payment_status: string;
|
|
637
|
+
};
|
|
577
638
|
type NewAddressDetails = {
|
|
578
639
|
current_address: Address;
|
|
579
640
|
previous_address: Address;
|
|
580
641
|
};
|
|
642
|
+
type EquifaxNewAddressDetails = {
|
|
643
|
+
current_address: Address;
|
|
644
|
+
previous_address: Address;
|
|
645
|
+
move_date: string;
|
|
646
|
+
};
|
|
647
|
+
type TransUnionNewAddressDetails = {
|
|
648
|
+
current_address: Address;
|
|
649
|
+
previous_address: Address;
|
|
650
|
+
move_date: string;
|
|
651
|
+
};
|
|
581
652
|
type SpecialCommentsDetails = {
|
|
582
653
|
company: Company;
|
|
583
654
|
balance_amount: string;
|
|
@@ -651,6 +722,11 @@ type AccountInBankruptcyDetails = {
|
|
|
651
722
|
open_date: string;
|
|
652
723
|
status_date: string;
|
|
653
724
|
};
|
|
725
|
+
type TransUnionAccountInBankruptcyDetails = {
|
|
726
|
+
company: Company;
|
|
727
|
+
is_collection: string;
|
|
728
|
+
payment_status: string;
|
|
729
|
+
};
|
|
654
730
|
type PublicRecordBankruptcyDetails = {
|
|
655
731
|
company: Company;
|
|
656
732
|
balance_amount: string;
|
|
@@ -658,6 +734,13 @@ type PublicRecordBankruptcyDetails = {
|
|
|
658
734
|
payment_status: string;
|
|
659
735
|
file_date: string;
|
|
660
736
|
};
|
|
737
|
+
type TransUnionPublicRecordBankruptcyDetails = {
|
|
738
|
+
amount: string;
|
|
739
|
+
court_name: string;
|
|
740
|
+
description: string;
|
|
741
|
+
file_date: string;
|
|
742
|
+
address: Address;
|
|
743
|
+
};
|
|
661
744
|
type CollectionDetails = {
|
|
662
745
|
company: Company;
|
|
663
746
|
balance_amount: string;
|
|
@@ -749,6 +832,11 @@ type AccountImprovedDetails = {
|
|
|
749
832
|
current_status: string;
|
|
750
833
|
previous_status: string;
|
|
751
834
|
};
|
|
835
|
+
type TransUnionAccountImprovedDetails = {
|
|
836
|
+
company: Omit<Company, 'phone'>;
|
|
837
|
+
balance_amount: string;
|
|
838
|
+
payment_status: string;
|
|
839
|
+
};
|
|
752
840
|
type AccountPaidDetails = {
|
|
753
841
|
company: Company;
|
|
754
842
|
balance_amount: string;
|
|
@@ -756,6 +844,40 @@ type AccountPaidDetails = {
|
|
|
756
844
|
current_status: string;
|
|
757
845
|
previous_status: string;
|
|
758
846
|
};
|
|
847
|
+
type EquifaxCollectionChangeDetails = {
|
|
848
|
+
company: Omit<Company, 'business_type'>;
|
|
849
|
+
balance_amount: string;
|
|
850
|
+
is_collection: string;
|
|
851
|
+
payment_status: string;
|
|
852
|
+
open_date: string;
|
|
853
|
+
status_date: string;
|
|
854
|
+
};
|
|
855
|
+
type EquifaxNewCollectionDetails = {
|
|
856
|
+
company: Omit<Company, 'phone' | 'business_type'>;
|
|
857
|
+
balance_amount: string;
|
|
858
|
+
is_collection: string;
|
|
859
|
+
payment_status: string;
|
|
860
|
+
open_date: string;
|
|
861
|
+
status_date: string;
|
|
862
|
+
};
|
|
863
|
+
type EquifaxNewBankruptcyDetails = {
|
|
864
|
+
amount: string;
|
|
865
|
+
court_name: string;
|
|
866
|
+
description: string;
|
|
867
|
+
file_date: string;
|
|
868
|
+
};
|
|
869
|
+
type TransUnionNewPublicRecordDetails = {
|
|
870
|
+
amount: string;
|
|
871
|
+
court_name: string;
|
|
872
|
+
description: string;
|
|
873
|
+
file_date: string;
|
|
874
|
+
address: Address;
|
|
875
|
+
};
|
|
876
|
+
type TransUnionDelinquentDetails = {
|
|
877
|
+
company: Company;
|
|
878
|
+
is_collection: string;
|
|
879
|
+
payment_status: string;
|
|
880
|
+
};
|
|
759
881
|
type CreditScoreTriggerReasons = {
|
|
760
882
|
score_rating_changed: string;
|
|
761
883
|
score_goal_achieved: string;
|
|
@@ -860,7 +982,29 @@ type CreditScoreBelowGoalDetails = {
|
|
|
860
982
|
previous_score_rating: string;
|
|
861
983
|
goal_value: string;
|
|
862
984
|
};
|
|
863
|
-
type
|
|
985
|
+
type AuthorizationCompanyAddress = Address & {
|
|
986
|
+
activity_date: string;
|
|
987
|
+
};
|
|
988
|
+
type AuthorizationCompanyDetail = Omit<Company, 'address'> & {
|
|
989
|
+
address: AuthorizationCompanyAddress;
|
|
990
|
+
};
|
|
991
|
+
type AuthorizationAlertDetails = {
|
|
992
|
+
company: AuthorizationCompanyDetail;
|
|
993
|
+
};
|
|
994
|
+
type AlternativeLoanRecord = {
|
|
995
|
+
loan_date: string;
|
|
996
|
+
loan_amount: string;
|
|
997
|
+
loan_current_balance: string;
|
|
998
|
+
loan_actual_payment: string;
|
|
999
|
+
loan_amount_past_due: string;
|
|
1000
|
+
loan_closed_date?: string;
|
|
1001
|
+
company: string;
|
|
1002
|
+
};
|
|
1003
|
+
type AlternativeLoanMonitoringDetails = {
|
|
1004
|
+
occurrence_count: string;
|
|
1005
|
+
loans: AlternativeLoanRecord[];
|
|
1006
|
+
};
|
|
1007
|
+
type AlertDetails = AuthorizationAlertDetails | DormantAccountDetails | AlternativeLoanMonitoringDetails | NewInquiryDetails | EquifaxNewInquiryDetails | TransUnionNewInquiryDetails | NewAccountDetails | EquifaxNewAccountDetails | TransUnionNewAccountDetails | NewAddressDetails | EquifaxNewAddressDetails | TransUnionNewAddressDetails | SpecialCommentsDetails | SkipCannotLocateDetails | LostOrStolenCardDetails | CardOverLimitDetails | PastDueDetails | DerogatoryDetails | SettlementDetails | ClosedAccountDetails | AccountInBankruptcyDetails | TransUnionAccountInBankruptcyDetails | PublicRecordBankruptcyDetails | TransUnionPublicRecordBankruptcyDetails | CollectionDetails | DeceasedDetails | CreditBalanceIncreaseDetails | CreditBalanceDecreaseDetails | CreditLimitIncreaseDetails | CreditLimitDecreaseDetails | CreditUsageIncreaseDetails | CreditUsageDecreaseDetails | AccountClosedDetails | AccountCurrentDetails | AccountImprovedDetails | TransUnionAccountImprovedDetails | AccountPaidDetails | CreditScoreIncreaseDetails | CreditScoreDecreaseDetails | CreditScoreRatingIncreaseDetails | CreditScoreRatingDecreaseDetails | CreditScoreGoalAchievedDetails | CreditScoreBelowGoalDetails | EquifaxCollectionChangeDetails | EquifaxNewCollectionDetails | EquifaxNewBankruptcyDetails | TransUnionNewPublicRecordDetails | TransUnionDelinquentDetails;
|
|
864
1008
|
type AlertData<AlertDetailsType = AlertDetails> = {
|
|
865
1009
|
alert_date: string;
|
|
866
1010
|
alert_severity?: string;
|
|
@@ -917,7 +1061,7 @@ declare class AlertsService extends ApiClient {
|
|
|
917
1061
|
getAlertCounts(fetchOptions?: RequestInit): Promise<ApiClientResponse<TotalAlertCounts>>;
|
|
918
1062
|
}
|
|
919
1063
|
|
|
920
|
-
type CreditReportType = 'EXPERIAN' | 'EXPERIAN_FICO2' | 'EXPERIAN_FICOMORTGAGE2' | 'EXPERIAN_FICO8' | 'EXPERIAN_FICO9' | 'EXPERIAN_VANTAGE30' | 'TRIBUREAU' | 'TRIBUREAU_EXPERIAN_FICO2' | 'TRIBUREAU_FICOMORTGAGE2' | 'TRIBUREAU_FICO8' | 'TRIBUREAU_VANTAGE30';
|
|
1064
|
+
type CreditReportType = 'EXPERIAN' | 'EXPERIAN_FICO2' | 'EXPERIAN_FICOMORTGAGE2' | 'EXPERIAN_FICO8' | 'EX_TU_EQ_FICO8' | 'EXPERIAN_FICO9' | 'EXPERIAN_VANTAGE30' | 'TRIBUREAU' | 'TRIBUREAU_EXPERIAN_FICO2' | 'TRIBUREAU_FICOMORTGAGE2' | 'TRIBUREAU_FICO8' | 'TRIBUREAU_VANTAGE30';
|
|
921
1065
|
type CreditReportScoreDetail = {
|
|
922
1066
|
bureau: Bureau;
|
|
923
1067
|
score_model: ScoreModelVersion;
|
|
@@ -945,6 +1089,9 @@ type PersonalAddress = {
|
|
|
945
1089
|
city: string;
|
|
946
1090
|
state: string;
|
|
947
1091
|
zip_code: string;
|
|
1092
|
+
residence_type: string;
|
|
1093
|
+
reported_at: string;
|
|
1094
|
+
updated_at: string;
|
|
948
1095
|
};
|
|
949
1096
|
type Name = {
|
|
950
1097
|
first_name: string;
|
|
@@ -956,11 +1103,16 @@ type Statement = {
|
|
|
956
1103
|
statement: string;
|
|
957
1104
|
};
|
|
958
1105
|
type PaymentHistoryCode = '' | 'No Data' | 'OK' | '30' | '60' | '90' | '120' | '150' | '180' | 'ND' | 'CLS' | 'CRD' | 'FS' | 'IC' | 'C' | 'F' | 'VS' | 'CO' | 'R' | 'PBC' | 'G' | 'D' | 'BK';
|
|
1106
|
+
type PaymentHistoryCode_V2 = PaymentHistoryCode | 'Current / Terms met' | 'No data for this period';
|
|
959
1107
|
type Month = 'jan' | 'feb' | 'mar' | 'apr' | 'may' | 'jun' | 'jul' | 'aug' | 'sep' | 'oct' | 'nov' | 'dec';
|
|
960
1108
|
type PaymentSummary = {
|
|
961
1109
|
year: number;
|
|
962
1110
|
summary_per_month: Record<Month, PaymentHistoryCode>;
|
|
963
1111
|
};
|
|
1112
|
+
type PaymentSummary_V2 = {
|
|
1113
|
+
year: number;
|
|
1114
|
+
summary_per_month: Record<Month, PaymentHistoryCode_V2>;
|
|
1115
|
+
};
|
|
964
1116
|
type CreditorAddress = {
|
|
965
1117
|
name: string;
|
|
966
1118
|
address: string;
|
|
@@ -1005,6 +1157,21 @@ type Account = {
|
|
|
1005
1157
|
last_payment_at: string | null;
|
|
1006
1158
|
creditor_comments: string[];
|
|
1007
1159
|
balloon_payment: string;
|
|
1160
|
+
account_status: string;
|
|
1161
|
+
industry_and_account_type: string;
|
|
1162
|
+
is_trade: boolean;
|
|
1163
|
+
historical_derogatory: string;
|
|
1164
|
+
additional_comments: string[];
|
|
1165
|
+
business_type: string;
|
|
1166
|
+
classification: string;
|
|
1167
|
+
delinquent_30_days_count: number;
|
|
1168
|
+
delinquent_60_days_count: number;
|
|
1169
|
+
delinquent_90_days_count: number;
|
|
1170
|
+
payment_status_class: string;
|
|
1171
|
+
custom_attributes: CustomAttributes;
|
|
1172
|
+
};
|
|
1173
|
+
type Account_V2 = Omit<Account, 'payment_summaries'> & {
|
|
1174
|
+
payment_summaries: PaymentSummary_V2[];
|
|
1008
1175
|
};
|
|
1009
1176
|
type CreditInquiry = {
|
|
1010
1177
|
creditor_name: string;
|
|
@@ -1031,12 +1198,24 @@ type CollectionAccount = {
|
|
|
1031
1198
|
your_statements: string[];
|
|
1032
1199
|
contact_info: ContactInfo;
|
|
1033
1200
|
};
|
|
1201
|
+
type CollectionAccount_V2 = Omit<CollectionAccount, 'payment_summaries'> & {
|
|
1202
|
+
payment_summaries: PaymentSummary_V2[];
|
|
1203
|
+
};
|
|
1034
1204
|
type PublicRecord = {
|
|
1035
1205
|
filed_at: string;
|
|
1036
1206
|
type: string;
|
|
1037
1207
|
court: string;
|
|
1038
1208
|
reference_number: string;
|
|
1039
1209
|
amount: string;
|
|
1210
|
+
record_type: string;
|
|
1211
|
+
liability: string;
|
|
1212
|
+
filed_by: string;
|
|
1213
|
+
asset: string;
|
|
1214
|
+
responsibility: string;
|
|
1215
|
+
status_at: string;
|
|
1216
|
+
comments: string[];
|
|
1217
|
+
segment_id: string;
|
|
1218
|
+
sequence_id: string;
|
|
1040
1219
|
};
|
|
1041
1220
|
type ReportDisplay = {
|
|
1042
1221
|
bureau: Bureau;
|
|
@@ -1047,6 +1226,7 @@ type ReportDisplay = {
|
|
|
1047
1226
|
address_updated_at: string;
|
|
1048
1227
|
previous_addresses: PersonalAddress[];
|
|
1049
1228
|
employer_names: string[];
|
|
1229
|
+
employers: Employers[];
|
|
1050
1230
|
statements: Statement[];
|
|
1051
1231
|
};
|
|
1052
1232
|
accounts_info: {
|
|
@@ -1055,6 +1235,7 @@ type ReportDisplay = {
|
|
|
1055
1235
|
credit_limit: number | null;
|
|
1056
1236
|
accounts: Account[];
|
|
1057
1237
|
};
|
|
1238
|
+
custom_features: CustomFeatures;
|
|
1058
1239
|
score_details: ReportDisplayScoreDetails[];
|
|
1059
1240
|
credit_inquiries: CreditInquiry[];
|
|
1060
1241
|
collection_accounts: CollectionAccount[];
|
|
@@ -1068,39 +1249,135 @@ type CreditReport = {
|
|
|
1068
1249
|
report_display: ReportDisplay[];
|
|
1069
1250
|
type: CreditReportType;
|
|
1070
1251
|
};
|
|
1252
|
+
type CreditReports_V2 = {
|
|
1253
|
+
items: CreditReport_V2[];
|
|
1254
|
+
};
|
|
1255
|
+
type CreditReport_V2 = {
|
|
1256
|
+
id: string;
|
|
1257
|
+
next_cursor?: string;
|
|
1258
|
+
disposition: CreditReportDisposition_V2;
|
|
1259
|
+
type: CreditReportType;
|
|
1260
|
+
bureau_reports: BureauReport[];
|
|
1261
|
+
};
|
|
1262
|
+
type ReadStatus = 'READ' | 'UNREAD';
|
|
1263
|
+
type CreditReportDisposition_V2 = {
|
|
1264
|
+
read_status: ReadStatus;
|
|
1265
|
+
};
|
|
1266
|
+
type BureauReport = Omit<ReportDisplay, 'personal_info' | 'accounts_info' | 'collection_accounts'> & {
|
|
1267
|
+
created_at: string;
|
|
1268
|
+
personal_info: {
|
|
1269
|
+
names: Name[];
|
|
1270
|
+
year_of_birth: number;
|
|
1271
|
+
current_address: PersonalAddress_V2;
|
|
1272
|
+
address_updated_at: string;
|
|
1273
|
+
previous_addresses: PersonalAddress_V2[];
|
|
1274
|
+
employer_names: string[];
|
|
1275
|
+
employers: Employers[];
|
|
1276
|
+
statements: Statement_V2[];
|
|
1277
|
+
};
|
|
1278
|
+
accounts_info: {
|
|
1279
|
+
credit_usage: number | null;
|
|
1280
|
+
credit_available: number | null;
|
|
1281
|
+
credit_limit: number | null;
|
|
1282
|
+
accounts: Account_V2[];
|
|
1283
|
+
};
|
|
1284
|
+
collection_accounts: CollectionAccount_V2[];
|
|
1285
|
+
};
|
|
1286
|
+
type PersonalAddress_V2 = PersonalAddress & {
|
|
1287
|
+
pre_directional: string;
|
|
1288
|
+
post_directional: string;
|
|
1289
|
+
};
|
|
1290
|
+
type Employers = {
|
|
1291
|
+
name: string;
|
|
1292
|
+
reported_at: string;
|
|
1293
|
+
updated_at: string;
|
|
1294
|
+
};
|
|
1295
|
+
type Statement_V2 = Statement & {
|
|
1296
|
+
expires_at: string;
|
|
1297
|
+
bureau: Bureau;
|
|
1298
|
+
};
|
|
1299
|
+
type CustomAttributes = {
|
|
1300
|
+
is_late: boolean;
|
|
1301
|
+
is_bnpl: boolean;
|
|
1302
|
+
is_delq_or_derog: boolean;
|
|
1303
|
+
};
|
|
1304
|
+
type CustomFeatures = {
|
|
1305
|
+
has_bnpl_trades: boolean;
|
|
1306
|
+
};
|
|
1307
|
+
type CreditReportsMeta_V2 = {
|
|
1308
|
+
items: CreditReportMeta_V2[];
|
|
1309
|
+
};
|
|
1310
|
+
type CreditReportMeta_V2 = Omit<CreditReport_V2, 'bureau_reports'> & {
|
|
1311
|
+
bureau_reports: BureauReportMeta[];
|
|
1312
|
+
};
|
|
1313
|
+
type BureauReportMeta = {
|
|
1314
|
+
bureau: Bureau;
|
|
1315
|
+
created_at: string;
|
|
1316
|
+
score_details: ReportDisplayScoreDetails[];
|
|
1317
|
+
};
|
|
1318
|
+
type BaseCreditReportRequestOptions<Version extends ApiVersion> = {
|
|
1319
|
+
version?: Version;
|
|
1320
|
+
};
|
|
1321
|
+
type WithId = {
|
|
1322
|
+
id: string;
|
|
1323
|
+
};
|
|
1324
|
+
type GetCreditReportRequestOptions_V1<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1325
|
+
product_config_id?: string;
|
|
1326
|
+
report_date?: string;
|
|
1327
|
+
report_between?: string;
|
|
1328
|
+
include_fields?: string;
|
|
1329
|
+
};
|
|
1330
|
+
type GetCreditReportRequestOptions_V2<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1331
|
+
report_date?: string;
|
|
1332
|
+
product_config_id?: string;
|
|
1333
|
+
};
|
|
1334
|
+
type GetCreditReportRequestOptions<Version extends ApiVersion> = Version extends 'v2' ? GetCreditReportRequestOptions_V2<Version> : GetCreditReportRequestOptions_V1<Version>;
|
|
1335
|
+
type GetCreditReportByIdRequestOptions_V1<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & WithId & {
|
|
1336
|
+
include_fields?: string;
|
|
1337
|
+
};
|
|
1338
|
+
type GetCreditReportByIdRequestOptions_V2<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & WithId;
|
|
1339
|
+
type GetCreditReportByIdRequestOptions<Version extends ApiVersion> = Version extends 'v2' ? GetCreditReportByIdRequestOptions_V2<Version> : GetCreditReportByIdRequestOptions_V1<Version>;
|
|
1340
|
+
type GetCreditReportMetaRequestOptions<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1341
|
+
product_config_id?: string;
|
|
1342
|
+
report_date?: string;
|
|
1343
|
+
report_between?: string;
|
|
1344
|
+
latest_only?: boolean;
|
|
1345
|
+
report_read?: boolean;
|
|
1346
|
+
};
|
|
1347
|
+
type GetCreditReportMetaByIdRequestOptions<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & WithId & {};
|
|
1348
|
+
type PostCreditReportRequestOptions_V1<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1349
|
+
product_config_id: string;
|
|
1350
|
+
include_fields?: string;
|
|
1351
|
+
};
|
|
1352
|
+
type PostCreditReportRequestOptions_V2<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1353
|
+
product_config_id: string;
|
|
1354
|
+
};
|
|
1355
|
+
type PostCreditReportRequestOptions<Version extends ApiVersion> = Version extends 'v2' ? PostCreditReportRequestOptions_V2<Version> : PostCreditReportRequestOptions_V1<Version>;
|
|
1356
|
+
type MarkCreditReportReadRequestOptions_V1<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1357
|
+
id: string;
|
|
1358
|
+
};
|
|
1359
|
+
type MarkCreditReportReadRequestOptions_V2<Version extends ApiVersion> = BaseCreditReportRequestOptions<Version> & {
|
|
1360
|
+
id: string;
|
|
1361
|
+
disposition: {
|
|
1362
|
+
read_status: Omit<ReadStatus, 'UNREAD'>;
|
|
1363
|
+
};
|
|
1364
|
+
};
|
|
1365
|
+
type MarkCreditReportAsRead<Version extends ApiVersion> = Version extends 'v2' ? MarkCreditReportReadRequestOptions_V2<Version> : MarkCreditReportReadRequestOptions_V1<Version>;
|
|
1366
|
+
type GetCreditReportResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditReports_V2 : CreditReport[];
|
|
1367
|
+
type GetCreditReportByIdResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditReport_V2 : CreditReport;
|
|
1368
|
+
type PostCreditReportResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditReport_V2 : CreditReport;
|
|
1369
|
+
type GetCreditReportMetaResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditReportsMeta_V2 : CreditReportMeta[];
|
|
1370
|
+
type GetCreditReportMetaByIdResponse<Version extends ApiVersion> = Version extends 'v2' ? CreditReportMeta_V2 : CreditReportMeta;
|
|
1071
1371
|
|
|
1072
1372
|
declare class CreditReportsService extends ApiClient {
|
|
1073
1373
|
#private;
|
|
1074
1374
|
constructor(config: ConnectedSolutionsSDKConfig);
|
|
1075
|
-
getReports(requestOptions?:
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
|
|
1081
|
-
getReportById(requestOptions: {
|
|
1082
|
-
id: string;
|
|
1083
|
-
include_fields?: string;
|
|
1084
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReport>>;
|
|
1085
|
-
getReportsMeta(requestOptions?: {
|
|
1086
|
-
product_config_id?: string;
|
|
1087
|
-
report_date?: string;
|
|
1088
|
-
report_between?: string;
|
|
1089
|
-
latest_only?: boolean;
|
|
1090
|
-
report_read?: boolean;
|
|
1091
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReportMeta[]>>;
|
|
1092
|
-
getReportMetaById(requestOptions: {
|
|
1093
|
-
id: string;
|
|
1094
|
-
product_config_id?: string;
|
|
1095
|
-
include_fields?: string;
|
|
1096
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReportMeta>>;
|
|
1097
|
-
markReportAsRead(requestOptions: {
|
|
1098
|
-
id: string;
|
|
1099
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
|
|
1100
|
-
orderReport(requestOptions: {
|
|
1101
|
-
product_config_id: string;
|
|
1102
|
-
include_fields?: string;
|
|
1103
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditReport>>;
|
|
1375
|
+
getReports<Version extends ApiVersion = 'v1'>(requestOptions?: GetCreditReportRequestOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditReportResponse<Version>>>;
|
|
1376
|
+
getReportById<Version extends ApiVersion = 'v1'>(requestOptions: GetCreditReportByIdRequestOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditReportMetaByIdResponse<Version>>>;
|
|
1377
|
+
getReportsMeta<Version extends ApiVersion>(requestOptions?: GetCreditReportMetaRequestOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditReportMetaResponse<Version>>>;
|
|
1378
|
+
getReportMetaById<Version extends ApiVersion = 'v1'>(requestOptions: GetCreditReportMetaByIdRequestOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditReportMetaByIdResponse<Version>>>;
|
|
1379
|
+
markReportAsRead<Version extends ApiVersion = 'v1'>(requestOptions: MarkCreditReportAsRead<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse>;
|
|
1380
|
+
orderReport<Version extends ApiVersion = 'v1'>(requestOptions: PostCreditReportRequestOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<PostCreditReportResponse<Version>>>;
|
|
1104
1381
|
}
|
|
1105
1382
|
|
|
1106
1383
|
type Customer = {
|
|
@@ -1262,14 +1539,35 @@ type ProductConfig = {
|
|
|
1262
1539
|
created_at: string;
|
|
1263
1540
|
updated_at: string;
|
|
1264
1541
|
};
|
|
1542
|
+
type ScoreItem = {
|
|
1543
|
+
bureau: Bureau;
|
|
1544
|
+
score_model: Omit<ScoreModel, 'disclosure'>;
|
|
1545
|
+
};
|
|
1546
|
+
type DisclosureItem = {
|
|
1547
|
+
bureau: Bureau;
|
|
1548
|
+
model: ScoreModelVersion;
|
|
1549
|
+
disclosure: {
|
|
1550
|
+
short_form: string;
|
|
1551
|
+
long_form: string;
|
|
1552
|
+
};
|
|
1553
|
+
};
|
|
1554
|
+
type ProductConfig_V2 = Omit<ProductConfig, 'disclosure'> & {
|
|
1555
|
+
scores_items: ScoreItem[];
|
|
1556
|
+
disclosure_items: DisclosureItem[];
|
|
1557
|
+
};
|
|
1265
1558
|
type ProductConfigs = {
|
|
1266
1559
|
previous_cursor: string;
|
|
1267
1560
|
next_cursor: string;
|
|
1268
1561
|
items: ProductConfig[];
|
|
1269
1562
|
};
|
|
1563
|
+
type ProductConfigs_V2 = {
|
|
1564
|
+
next_cursor: string;
|
|
1565
|
+
items: ProductConfig_V2[];
|
|
1566
|
+
};
|
|
1567
|
+
type ProductConfigsResponse<Version extends ApiVersion> = Version extends 'v1' ? ProductConfigs : ProductConfigs_V2;
|
|
1270
1568
|
type ProductConfigDeliveryType = 'ON_DEMAND' | 'ON_SCHEDULE' | 'MONITORING' | 'ON_ACTIVATION' | 'AD_HOC';
|
|
1271
1569
|
type ProductConfigCadenceType = 'DAILY' | 'WEEKLY' | 'BI_WEEKLY' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY';
|
|
1272
|
-
type ProductConfigsSearchOptions = {
|
|
1570
|
+
type ProductConfigsSearchOptions<Version extends ApiVersion> = {
|
|
1273
1571
|
/**
|
|
1274
1572
|
* @description The cursor for the current page.
|
|
1275
1573
|
*/
|
|
@@ -1304,15 +1602,365 @@ type ProductConfigsSearchOptions = {
|
|
|
1304
1602
|
* Pattern: ^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
|
|
1305
1603
|
*/
|
|
1306
1604
|
created_between?: [string, string];
|
|
1605
|
+
/**
|
|
1606
|
+
* @description The API version to use for the request.
|
|
1607
|
+
*/
|
|
1608
|
+
version?: Version;
|
|
1307
1609
|
};
|
|
1610
|
+
type GetProductConfigByIdResponse<Version extends ApiVersion> = Version extends 'v1' ? ProductConfig : ProductConfig_V2;
|
|
1308
1611
|
|
|
1309
1612
|
declare class ProductConfigsService extends ApiClient {
|
|
1310
1613
|
#private;
|
|
1311
1614
|
constructor(config: ConnectedSolutionsSDKConfig);
|
|
1312
|
-
getProductConfigs(searchOptions: ProductConfigsSearchOptions
|
|
1313
|
-
getProductConfigById(requestOptions: {
|
|
1615
|
+
getProductConfigs<Version extends ApiVersion = 'v1'>(searchOptions: ProductConfigsSearchOptions<Version>, fetchOptions?: RequestInit): Promise<ApiClientResponse<ProductConfigsResponse<Version>>>;
|
|
1616
|
+
getProductConfigById<Version extends ApiVersion = 'v1'>(requestOptions: {
|
|
1314
1617
|
product_config_id: string;
|
|
1315
|
-
|
|
1618
|
+
version?: Version;
|
|
1619
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetProductConfigByIdResponse<Version>>>;
|
|
1620
|
+
}
|
|
1621
|
+
|
|
1622
|
+
type IHSSurveyStatus = 'COMPLETED' | 'GENERATING' | 'AVAILABLE' | 'FAILED';
|
|
1623
|
+
type IHSPlanStatus = 'PENDING_SURVEY' | 'GENERATING' | 'AVAILABLE' | 'FAILED';
|
|
1624
|
+
type IHSPlanActionStatus = 'OPEN' | 'COMPLETED';
|
|
1625
|
+
type IHSGetPlanRequestActionStatus = 'OPEN' | 'COMPLETED' | 'ALL';
|
|
1626
|
+
type IHSSurveyPriority = 'HIGH' | 'MEDIUM' | 'LOW';
|
|
1627
|
+
type IHSPlanPriority = 'HIGH' | 'MEDIUM' | 'LOW';
|
|
1628
|
+
type IHSFactorCategory = 'DARK_WEB' | 'ONLINE';
|
|
1629
|
+
type IHSSurveyAnswer = 'YES' | 'NO';
|
|
1630
|
+
type IHSUpsellProduct = 'password-manager' | 'vpn' | 'safe-browser' | 'monitoring';
|
|
1631
|
+
interface IHSScoreFactor {
|
|
1632
|
+
factor: string;
|
|
1633
|
+
category: IHSFactorCategory;
|
|
1634
|
+
description: string;
|
|
1635
|
+
}
|
|
1636
|
+
interface IHSUpsellObject {
|
|
1637
|
+
product: IHSUpsellProduct;
|
|
1638
|
+
message: string;
|
|
1639
|
+
}
|
|
1640
|
+
interface IHSDisplayParameters {
|
|
1641
|
+
bank_account?: string;
|
|
1642
|
+
bank_number?: string;
|
|
1643
|
+
card_type?: string;
|
|
1644
|
+
card_number?: string;
|
|
1645
|
+
driver_license_number?: string;
|
|
1646
|
+
email?: string;
|
|
1647
|
+
iban?: string;
|
|
1648
|
+
medical_id?: string;
|
|
1649
|
+
national_id?: string;
|
|
1650
|
+
passport_number?: string;
|
|
1651
|
+
password?: string;
|
|
1652
|
+
phone_number?: string;
|
|
1653
|
+
retail_card_number?: string;
|
|
1654
|
+
ssn?: string;
|
|
1655
|
+
password_status?: string;
|
|
1656
|
+
is_exposed_bank_password?: boolean;
|
|
1657
|
+
is_exposed_bank_userId?: boolean;
|
|
1658
|
+
is_exposed_card_cvn?: boolean;
|
|
1659
|
+
is_exposed_card_pin?: boolean;
|
|
1660
|
+
is_exposed_password?: boolean;
|
|
1661
|
+
added_at?: string;
|
|
1662
|
+
}
|
|
1663
|
+
interface IHSSurveyQuestionItem {
|
|
1664
|
+
text: string;
|
|
1665
|
+
recommendation: string;
|
|
1666
|
+
title: string;
|
|
1667
|
+
yes_answer: string;
|
|
1668
|
+
no_answer: string;
|
|
1669
|
+
default_answer?: IHSSurveyAnswer;
|
|
1670
|
+
submitted_answer?: IHSSurveyAnswer;
|
|
1671
|
+
reason: string;
|
|
1672
|
+
risk: string;
|
|
1673
|
+
upsell?: IHSUpsellObject;
|
|
1674
|
+
}
|
|
1675
|
+
interface IHSSurveyQuestion {
|
|
1676
|
+
id: string;
|
|
1677
|
+
priority: IHSSurveyPriority;
|
|
1678
|
+
score_factors: IHSScoreFactor[];
|
|
1679
|
+
display_parameters?: IHSDisplayParameters;
|
|
1680
|
+
question_item: IHSSurveyQuestionItem;
|
|
1681
|
+
}
|
|
1682
|
+
interface IHSSurvey {
|
|
1683
|
+
status: IHSSurveyStatus;
|
|
1684
|
+
created_at: string;
|
|
1685
|
+
survey_id: string;
|
|
1686
|
+
questions?: IHSSurveyQuestion[];
|
|
1687
|
+
}
|
|
1688
|
+
interface IHSSurveyAnswerRequest {
|
|
1689
|
+
id: string;
|
|
1690
|
+
response: IHSSurveyAnswer;
|
|
1691
|
+
}
|
|
1692
|
+
interface IHSSubmitSurveyRequest {
|
|
1693
|
+
answers: IHSSurveyAnswerRequest[];
|
|
1694
|
+
}
|
|
1695
|
+
interface IHSSubmitSurveyResponse {
|
|
1696
|
+
survey_id: string;
|
|
1697
|
+
score_id: string;
|
|
1698
|
+
created_at: string;
|
|
1699
|
+
}
|
|
1700
|
+
interface IdentityHealthScore {
|
|
1701
|
+
id: string;
|
|
1702
|
+
value: number;
|
|
1703
|
+
created_at: string;
|
|
1704
|
+
updated_at: string;
|
|
1705
|
+
}
|
|
1706
|
+
interface IHSScoreDetails {
|
|
1707
|
+
score_details: IdentityHealthScore[];
|
|
1708
|
+
}
|
|
1709
|
+
interface IHSActionAnswerOption {
|
|
1710
|
+
text: string;
|
|
1711
|
+
score_impact?: number;
|
|
1712
|
+
}
|
|
1713
|
+
interface IHSPlanActionItem {
|
|
1714
|
+
text: string;
|
|
1715
|
+
recommendation: string;
|
|
1716
|
+
title: string;
|
|
1717
|
+
yes_answer: IHSActionAnswerOption;
|
|
1718
|
+
no_answer: IHSActionAnswerOption;
|
|
1719
|
+
default_answer?: IHSSurveyAnswer;
|
|
1720
|
+
submitted_answer?: IHSSurveyAnswer;
|
|
1721
|
+
reason: string;
|
|
1722
|
+
risk: string;
|
|
1723
|
+
upsell?: IHSUpsellObject;
|
|
1724
|
+
}
|
|
1725
|
+
interface IHSPlanAction {
|
|
1726
|
+
id: string;
|
|
1727
|
+
priority: IHSPlanPriority;
|
|
1728
|
+
added_at: string;
|
|
1729
|
+
status?: IHSPlanActionStatus;
|
|
1730
|
+
score_factors: IHSScoreFactor[];
|
|
1731
|
+
display_parameters?: IHSDisplayParameters;
|
|
1732
|
+
action_item: IHSPlanActionItem;
|
|
1733
|
+
}
|
|
1734
|
+
interface IHSPlan {
|
|
1735
|
+
status: IHSPlanStatus;
|
|
1736
|
+
updated_at: string;
|
|
1737
|
+
plan_id: string;
|
|
1738
|
+
total_action_count: number;
|
|
1739
|
+
next_cursor?: string;
|
|
1740
|
+
actions?: IHSPlanAction[];
|
|
1741
|
+
}
|
|
1742
|
+
interface IHSCreatePlanResponse {
|
|
1743
|
+
plan_id: string;
|
|
1744
|
+
message: string;
|
|
1745
|
+
location: string;
|
|
1746
|
+
created_at: string;
|
|
1747
|
+
updated_at: string;
|
|
1748
|
+
}
|
|
1749
|
+
interface IHSUpdateActionRequest {
|
|
1750
|
+
action_response: IHSSurveyAnswer;
|
|
1751
|
+
}
|
|
1752
|
+
interface IHSUpdateActionResponse {
|
|
1753
|
+
plan_id: string;
|
|
1754
|
+
score_id: string;
|
|
1755
|
+
updated_at: string;
|
|
1756
|
+
}
|
|
1757
|
+
interface IHSGetPlanRequest {
|
|
1758
|
+
cursor?: string;
|
|
1759
|
+
action_status: IHSGetPlanRequestActionStatus;
|
|
1760
|
+
count?: number;
|
|
1761
|
+
}
|
|
1762
|
+
|
|
1763
|
+
declare class IdentityHealthScoreService extends ApiClient {
|
|
1764
|
+
#private;
|
|
1765
|
+
constructor(config: ConnectedSolutionsSDKConfig);
|
|
1766
|
+
getSurvey(fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSSurvey>>;
|
|
1767
|
+
submitSurvey(requestOptions: IHSSubmitSurveyRequest, fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSSubmitSurveyResponse>>;
|
|
1768
|
+
getScore(fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSScoreDetails>>;
|
|
1769
|
+
getPlan(requestOptions: IHSGetPlanRequest, fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSPlan>>;
|
|
1770
|
+
createPlan(fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSCreatePlanResponse>>;
|
|
1771
|
+
updateAction(requestOptions: {
|
|
1772
|
+
action_id: string;
|
|
1773
|
+
} & IHSUpdateActionRequest, fetchOptions?: RequestInit): Promise<ApiClientResponse<IHSUpdateActionResponse>>;
|
|
1774
|
+
}
|
|
1775
|
+
|
|
1776
|
+
type DIMScanStatus = 'COMPLETE' | 'IN-PROGRESS';
|
|
1777
|
+
type DIMScanType = 'DISCOVERY' | 'INITIAL' | 'ONGOING';
|
|
1778
|
+
type DIMBrokerScanStatus = 'CREATED' | 'QUEUED' | 'ACTIVE' | 'RETRYING' | 'FAILED' | 'SUCCESS';
|
|
1779
|
+
type DIMRemovalStatus = 'ACTION_NEEDED' | 'IN-PROGRESS' | 'REMOVED' | 'UNAVAILABLE';
|
|
1780
|
+
type DIMRiskLevel = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
1781
|
+
interface DIMRecordData {
|
|
1782
|
+
id: string;
|
|
1783
|
+
age?: string;
|
|
1784
|
+
full_name?: string;
|
|
1785
|
+
gender?: string;
|
|
1786
|
+
occupation?: string;
|
|
1787
|
+
education?: string;
|
|
1788
|
+
addresses?: string[];
|
|
1789
|
+
relatives?: string[];
|
|
1790
|
+
phone_numbers?: string[];
|
|
1791
|
+
email_addresses?: string[];
|
|
1792
|
+
employments?: string[];
|
|
1793
|
+
properties?: string[];
|
|
1794
|
+
submitted_at?: string;
|
|
1795
|
+
risk_level?: DIMRiskLevel;
|
|
1796
|
+
removal_status?: DIMRemovalStatus;
|
|
1797
|
+
}
|
|
1798
|
+
interface DIMBrokerDetail {
|
|
1799
|
+
id: string;
|
|
1800
|
+
name: string;
|
|
1801
|
+
status: DIMBrokerScanStatus;
|
|
1802
|
+
record_data?: DIMRecordData[];
|
|
1803
|
+
}
|
|
1804
|
+
interface DIMScanDetail {
|
|
1805
|
+
id: string;
|
|
1806
|
+
type: DIMScanType;
|
|
1807
|
+
status: DIMScanStatus;
|
|
1808
|
+
started_at?: string;
|
|
1809
|
+
stopped_at?: string;
|
|
1810
|
+
modified_at?: string;
|
|
1811
|
+
broker_count?: number;
|
|
1812
|
+
broker_details?: DIMBrokerDetail[];
|
|
1813
|
+
}
|
|
1814
|
+
interface DIMGetScansResponse {
|
|
1815
|
+
product_config_id?: ProductConfigId;
|
|
1816
|
+
next_cursor?: string;
|
|
1817
|
+
scan_details: DIMScanDetail[];
|
|
1818
|
+
}
|
|
1819
|
+
interface DIMPostScanResponse {
|
|
1820
|
+
scan_id: string;
|
|
1821
|
+
product_config_id: ProductConfigId;
|
|
1822
|
+
}
|
|
1823
|
+
interface DIMMetaRecordData {
|
|
1824
|
+
id: string;
|
|
1825
|
+
removal_status?: DIMRemovalStatus;
|
|
1826
|
+
}
|
|
1827
|
+
interface DIMMetaBrokers {
|
|
1828
|
+
id: string;
|
|
1829
|
+
name: string;
|
|
1830
|
+
record_data?: DIMMetaRecordData[];
|
|
1831
|
+
}
|
|
1832
|
+
interface DIMScanMetaData {
|
|
1833
|
+
id: string;
|
|
1834
|
+
status: DIMScanStatus;
|
|
1835
|
+
type: DIMScanType;
|
|
1836
|
+
started_at: string;
|
|
1837
|
+
modified_at: string;
|
|
1838
|
+
broker_details?: DIMMetaBrokers[];
|
|
1839
|
+
}
|
|
1840
|
+
interface DIMGetScansMetaResponse {
|
|
1841
|
+
product_config_id?: ProductConfigId;
|
|
1842
|
+
unique_broker_count?: number;
|
|
1843
|
+
broker_removals_in_progress?: number;
|
|
1844
|
+
broker_removals_completed?: number;
|
|
1845
|
+
datapoints_removed?: number;
|
|
1846
|
+
datapoints_exposed?: number;
|
|
1847
|
+
datapoints_in_progress?: number;
|
|
1848
|
+
next_scan_at?: string;
|
|
1849
|
+
scan_details?: DIMScanMetaData[];
|
|
1850
|
+
}
|
|
1851
|
+
interface DIMBroker {
|
|
1852
|
+
id: string;
|
|
1853
|
+
name: string;
|
|
1854
|
+
url?: string;
|
|
1855
|
+
labels?: string[];
|
|
1856
|
+
group_id?: string;
|
|
1857
|
+
estimated_days_to_remove_records?: number;
|
|
1858
|
+
}
|
|
1859
|
+
interface DIMGroupRemovalInstruction {
|
|
1860
|
+
group_id: string;
|
|
1861
|
+
group_name: string;
|
|
1862
|
+
last_modified_at?: string;
|
|
1863
|
+
not_getting_removed_instructions?: string;
|
|
1864
|
+
removal_steps?: string;
|
|
1865
|
+
removal_url?: string;
|
|
1866
|
+
support_email?: string;
|
|
1867
|
+
}
|
|
1868
|
+
interface DIMGetBrokersResponse {
|
|
1869
|
+
group_removal_instructions?: DIMGroupRemovalInstruction[];
|
|
1870
|
+
brokers: DIMBroker[];
|
|
1871
|
+
}
|
|
1872
|
+
interface DIMGetBrokerByIdResponse {
|
|
1873
|
+
group_removal_instructions?: DIMGroupRemovalInstruction;
|
|
1874
|
+
broker: DIMBroker;
|
|
1875
|
+
}
|
|
1876
|
+
interface DIMBrokerGroupDetail {
|
|
1877
|
+
group_id: string;
|
|
1878
|
+
group_name: string;
|
|
1879
|
+
broker_ids?: string[];
|
|
1880
|
+
last_modified_at?: string;
|
|
1881
|
+
not_getting_removed_instructions?: string;
|
|
1882
|
+
removal_steps?: string;
|
|
1883
|
+
removal_url?: string;
|
|
1884
|
+
support_email?: string;
|
|
1885
|
+
}
|
|
1886
|
+
interface DIMBrokerGroupActionResponse {
|
|
1887
|
+
group_id: string;
|
|
1888
|
+
}
|
|
1889
|
+
interface DIMGetScansOptions {
|
|
1890
|
+
product_config_id?: ProductConfigId;
|
|
1891
|
+
scan_between?: string;
|
|
1892
|
+
cursor?: string;
|
|
1893
|
+
count?: number;
|
|
1894
|
+
}
|
|
1895
|
+
interface DIMGetScansMetaOptions {
|
|
1896
|
+
most_recent?: boolean;
|
|
1897
|
+
product_config_id?: ProductConfigId;
|
|
1898
|
+
scan_between?: string;
|
|
1899
|
+
}
|
|
1900
|
+
interface DIMPostScanOptions {
|
|
1901
|
+
product_config_id: ProductConfigId;
|
|
1902
|
+
}
|
|
1903
|
+
|
|
1904
|
+
declare class DigitalIdentityManagerService extends ApiClient {
|
|
1905
|
+
#private;
|
|
1906
|
+
constructor(config: ConnectedSolutionsSDKConfig);
|
|
1907
|
+
/**
|
|
1908
|
+
* Create a new discovery scan
|
|
1909
|
+
* POST /v1/dim/scans
|
|
1910
|
+
*/
|
|
1911
|
+
createScan(options: DIMPostScanOptions, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMPostScanResponse>>;
|
|
1912
|
+
/**
|
|
1913
|
+
* Get scan results
|
|
1914
|
+
* GET /v1/dim/scans
|
|
1915
|
+
*/
|
|
1916
|
+
getScans(options?: DIMGetScansOptions, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMGetScansResponse>>;
|
|
1917
|
+
/**
|
|
1918
|
+
* Get scan by ID
|
|
1919
|
+
* GET /v1/dim/scans/{scan_id}
|
|
1920
|
+
*/
|
|
1921
|
+
getScanById(requestOptions: {
|
|
1922
|
+
scanId: string;
|
|
1923
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMScanDetail>>;
|
|
1924
|
+
/**
|
|
1925
|
+
* Get scan meta data details
|
|
1926
|
+
* GET /v1/dim/scans/meta
|
|
1927
|
+
*/
|
|
1928
|
+
getScansMetadata(options?: DIMGetScansMetaOptions, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMGetScansMetaResponse>>;
|
|
1929
|
+
/**
|
|
1930
|
+
* Get brokers details
|
|
1931
|
+
* GET /v1/dim/brokers
|
|
1932
|
+
*/
|
|
1933
|
+
getBrokers(fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMGetBrokersResponse>>;
|
|
1934
|
+
/**
|
|
1935
|
+
* Get a broker detail
|
|
1936
|
+
* GET /v1/dim/brokers/{broker_id}
|
|
1937
|
+
*/
|
|
1938
|
+
getBrokerById(requestOptions: {
|
|
1939
|
+
brokerId: string;
|
|
1940
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMGetBrokerByIdResponse>>;
|
|
1941
|
+
/**
|
|
1942
|
+
* Get brokers details for a scan
|
|
1943
|
+
* GET /v1/dim/scans/{scan_id}/brokers
|
|
1944
|
+
*/
|
|
1945
|
+
getBrokersByScanId(requestOptions: {
|
|
1946
|
+
scanId: string;
|
|
1947
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMGetBrokersResponse>>;
|
|
1948
|
+
/**
|
|
1949
|
+
* Get brokers group detail
|
|
1950
|
+
* GET /v1/dim/brokers/groups/{group_id}
|
|
1951
|
+
*/
|
|
1952
|
+
getBrokersByGroupId(requestOptions: {
|
|
1953
|
+
groupId: string;
|
|
1954
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMBrokerGroupDetail>>;
|
|
1955
|
+
/**
|
|
1956
|
+
* Update user action for removal (disposition a scan removal)
|
|
1957
|
+
* POST /v1/dim/brokers/groups/{group_id}/action
|
|
1958
|
+
* Returns 202 Accepted with group_id in response body
|
|
1959
|
+
* Note: Per OAS 1.0.29, this endpoint doesn't accept a request body
|
|
1960
|
+
*/
|
|
1961
|
+
updateBrokerGroupAction(requestOptions: {
|
|
1962
|
+
groupId: string;
|
|
1963
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<DIMBrokerGroupActionResponse>>;
|
|
1316
1964
|
}
|
|
1317
1965
|
|
|
1318
1966
|
type ConnectedSolutionsSDKConfigInternal = {
|
|
@@ -1333,13 +1981,15 @@ interface ConnectedSolutionsSDK {
|
|
|
1333
1981
|
entitlements: EntitlementsService;
|
|
1334
1982
|
productConfigs: ProductConfigsService;
|
|
1335
1983
|
registrations: RegistrationsService;
|
|
1984
|
+
identityHealthScore: IdentityHealthScoreService;
|
|
1985
|
+
digitalIdentityManager: DigitalIdentityManagerService;
|
|
1336
1986
|
}
|
|
1337
1987
|
|
|
1338
1988
|
type ConnectedSolutionsClientMeta = {
|
|
1339
1989
|
status: number;
|
|
1340
1990
|
statusText: string;
|
|
1341
1991
|
};
|
|
1342
|
-
type ConnectedSolutionsClientErrors =
|
|
1992
|
+
type ConnectedSolutionsClientErrors = ConnectedSolutionsClientSideError | ConnectedSolutionsClientAuthenticationError | ConnectedSolutionsClientServerSideError | ConnectedSolutionsClientRateLimitError | ConnectedSolutionsClientSDKError;
|
|
1343
1993
|
type ApiClientResponse<DataType = Record<string, unknown>> = {
|
|
1344
1994
|
data: DataType;
|
|
1345
1995
|
error: undefined;
|
|
@@ -1363,16 +2013,12 @@ declare class ApiClient {
|
|
|
1363
2013
|
declare class CreditScoresService extends ApiClient {
|
|
1364
2014
|
#private;
|
|
1365
2015
|
constructor(config: ConnectedSolutionsSDKConfig);
|
|
1366
|
-
getCreditScores(options?: {
|
|
2016
|
+
getCreditScores<Version extends ApiVersion = 'v1'>(options?: BaseCreditScoreRequestOptions<Version> & {
|
|
1367
2017
|
product_config_id?: string;
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScore[]>>;
|
|
1371
|
-
orderCreditScore(requestOptions: {
|
|
2018
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<GetCreditScoreResponse<Version>>>;
|
|
2019
|
+
orderCreditScore<Version extends ApiVersion = 'v1'>(requestOptions: BaseCreditScoreRequestOptions<Version> & {
|
|
1372
2020
|
product_config_id: string;
|
|
1373
|
-
|
|
1374
|
-
include_ingredients?: boolean;
|
|
1375
|
-
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<CreditScore>>;
|
|
2021
|
+
}, fetchOptions?: RequestInit): Promise<ApiClientResponse<PostCreditScoreResponse<Version>>>;
|
|
1376
2022
|
}
|
|
1377
2023
|
|
|
1378
2024
|
declare class SDKClient extends ApiClient implements ConnectedSolutionsSDK {
|
|
@@ -1389,6 +2035,8 @@ declare class SDKClient extends ApiClient implements ConnectedSolutionsSDK {
|
|
|
1389
2035
|
entitlements: EntitlementsService;
|
|
1390
2036
|
productConfigs: ProductConfigsService;
|
|
1391
2037
|
registrations: RegistrationsService;
|
|
2038
|
+
identityHealthScore: IdentityHealthScoreService;
|
|
2039
|
+
digitalIdentityManager: DigitalIdentityManagerService;
|
|
1392
2040
|
static getInstance(config: ConnectedSolutionsSDKConfig): SDKClient;
|
|
1393
2041
|
static clearInstance(): void;
|
|
1394
2042
|
private constructor();
|
|
@@ -1410,4 +2058,25 @@ declare function isFicoScenario(scenario: Scenario): scenario is FicoScenario;
|
|
|
1410
2058
|
declare function isFicoScenarioVariation(variation?: ScenarioVariation): variation is FicoScenarioVariation;
|
|
1411
2059
|
declare function isVantageScenarioVariation(variation?: ScenarioVariation): variation is VantageScenarioVariation;
|
|
1412
2060
|
|
|
1413
|
-
|
|
2061
|
+
declare function isValidApiVersion(version: string): version is ApiVersion;
|
|
2062
|
+
declare function isCreditScore(data: unknown): data is CreditScore;
|
|
2063
|
+
declare function isCreditScoreV2(data: unknown): data is CreditScore_V2;
|
|
2064
|
+
declare function isBureauScore(data: unknown): data is BureauScore;
|
|
2065
|
+
declare function isValidBureau(bureau: unknown): bureau is Bureau;
|
|
2066
|
+
declare function isCreditScoresV2(data: unknown): data is CreditScores_V2;
|
|
2067
|
+
declare function isCreditScoreArray(data: unknown): data is CreditScore[];
|
|
2068
|
+
declare function isV1GetCreditScoresResponse(data: unknown): data is GetCreditScoreResponse<'v1'>;
|
|
2069
|
+
declare function isV2GetCreditScoresResponse(data: unknown): data is GetCreditScoreResponse<'v2'>;
|
|
2070
|
+
declare function isV1PostCreditScoresResponse(data: unknown): data is PostCreditScoreResponse<'v1'>;
|
|
2071
|
+
declare function isV2PostCreditScoresResponse(data: unknown): data is PostCreditScoreResponse<'v2'>;
|
|
2072
|
+
|
|
2073
|
+
declare function isCreditAttribute(data: unknown): data is CreditAttributes;
|
|
2074
|
+
declare function isCreditAttributeV2(data: unknown): data is CreditAttribute_V2;
|
|
2075
|
+
declare function isBureauAttribute(data: unknown): data is BureauAttribute;
|
|
2076
|
+
declare function isValidBureauAttribute(bureau: unknown): bureau is Bureau;
|
|
2077
|
+
declare function isCreditAttributesV2(data: unknown): data is CreditAttribute_V2;
|
|
2078
|
+
declare function isCreditAttributeArray(data: unknown): data is CreditAttribute[];
|
|
2079
|
+
declare function isV1GetCreditAttributesResponse(data: unknown): data is GetCreditAttributeResponse<'v1'>;
|
|
2080
|
+
declare function isV2GetCreditAttributesResponse(data: unknown): data is GetCreditAttributeResponse<'v2'>;
|
|
2081
|
+
|
|
2082
|
+
export { type Account, type AccountClosedDetails, type AccountCurrentDetails, type AccountImprovedDetails, type AccountInBankruptcyDetails, type AccountPaidDetails, type Account_V2, type Action, type ActivationRule, type Address, type Alert, type AlertCount, type AlertData, type AlertDetails, type AlertDisposition, type AlertMetadata, type Alerts, type AlternativeLoanMonitoringDetails, type AlternativeLoanRecord, type ApiClientResponse, type AttributeCategoryImpact, type AttributeCategoryName, type AttributeCategoryRating, type AttributeCategoryRatingName, type AttributeCategoryRatingScale, type AttributeCategoryRatingScaleType, type AttributeCategoryRatingScaleValue, type AttributeCategoryRatingScaleValueName, type AttributeHardInquiry, type AttributeHighCreditUtilizationAccount, type AttributeOldestOpenAccount, type AttributeRelevantScoreFactor, type AuthAnswer, type AuthAnswersRequest, type AuthCredentials, type AuthQuestion, type AuthQuestions, type AuthServiceConfig, type AuthorizationAlertDetails, type AuthorizationCompanyAddress, type AuthorizationCompanyDetail, type BaseCreditAttributeRequestOptions, type BaseCreditScoreRequestOptions, type BearerToken, type BureauAttribute, type BureauReport, type BureauReportMeta, type BureauScore, type CardOverLimitDetails, type ClosedAccountDetails, type CollectionAccount, type CollectionAccount_V2, type CollectionDetails, type Company, type ConnectedSolutionsAPIErrorData, type ConnectedSolutionsAPIErrorType, ConnectedSolutionsClientAuthenticationError, ConnectedSolutionsClientError, type ConnectedSolutionsClientErrors, type ConnectedSolutionsClientMeta, ConnectedSolutionsClientRateLimitError, type ConnectedSolutionsClientRawError, ConnectedSolutionsClientSDKError, ConnectedSolutionsClientServerSideError, ConnectedSolutionsClientSideError, type ConnectedSolutionsSDK, type ConnectedSolutionsSDKConfig, type ConnectedSolutionsSDKConfigInternal, type ConnectedSolutionsSDKErrorTypes, type ContactInfo, type CreateCustomerOptions, type CreateRegistrationsRequest, type CreateRegistrationsResponse, type CreditAttribute, type CreditAttributeCategory, type CreditAttribute_V2, type CreditAttributes, type CreditAttributes_V2, type CreditBalanceDecreaseDetails, type CreditBalanceIncreaseDetails, type CreditInquiry, type CreditLimitDecreaseDetails, type CreditLimitIncreaseDetails, type CreditReport, type CreditReportDisposition_V2, type CreditReportMeta, type CreditReportMeta_V2, type CreditReportScoreDetail, type CreditReportScoreRating, type CreditReportType, type CreditReport_V2, type CreditReportsMeta_V2, type CreditReports_V2, type CreditScore, type CreditScoreBelowGoalDetails, type CreditScoreDecreaseDetails, type CreditScoreFeaturePreferences, type CreditScoreGoalAchievedDetails, type CreditScoreIncreaseDetails, type CreditScoreIngredient, type CreditScorePlan, type CreditScorePostRequest, type CreditScoreRatingDecreaseDetails, type CreditScoreRatingIncreaseDetails, type CreditScoreSimulator, type CreditScoreSimulatorPostRequest, type CreditScoreSimulatorPostResponse, type CreditScoreTriggerReasons, type CreditScore_V2, type CreditScores_V2, type CreditUsageDecreaseDetails, type CreditUsageIncreaseDetails, type CreditorAddress, type CustomAttributes, type CustomFeatures, type Customer, type CustomerAddress, type CustomerDisclosure, type CustomerEmail, type CustomerId, type CustomerPhone, type CustomerSearchOptions, type CustomerSearchResults, type DIMBroker, type DIMBrokerDetail, type DIMBrokerGroupActionResponse, type DIMBrokerGroupDetail, type DIMBrokerScanStatus, type DIMGetBrokerByIdResponse, type DIMGetBrokersResponse, type DIMGetScansMetaOptions, type DIMGetScansMetaResponse, type DIMGetScansOptions, type DIMGetScansResponse, type DIMGroupRemovalInstruction, type DIMMetaBrokers, type DIMMetaRecordData, type DIMPostScanOptions, type DIMPostScanResponse, type DIMRecordData, type DIMRemovalStatus, type DIMRiskLevel, type DIMScanDetail, type DIMScanMetaData, type DIMScanStatus, type DIMScanType, type DeceasedDetails, type DerogatoryDetails, type DisclosureItem, type DormantAccountDetails, type Employers, type EntitleCustomerResponse, type EntitledProduct, type EntitledProductStatus, type Entitlement, type EntitlementId, type EntitlementNextAction, type Entitlements, type EquifaxCollectionChangeDetails, type EquifaxNewAccountDetails, type EquifaxNewAddressDetails, type EquifaxNewBankruptcyDetails, type EquifaxNewCollectionDetails, type EquifaxNewInquiryDetails, type FicoCreditScorePlan, type FicoCreditScorePlanCompleted, type FicoCreditScorePlanNotSet, type FicoCreditScorePlanSet, type FicoScenario, type FicoScenarioVariation, type FicoScoreModelVersion, type FicoScorePlanCompleted, type FicoScorePlanCreateResponse, type FicoScorePlanRevision, type FicoScorePlanRevisionsRequest, type FicoScorePlanSet, type FicoScoreSimulator, type FicoStatement, type GetCreditAttributeResponse, type GetCreditReportByIdRequestOptions, type GetCreditReportByIdResponse, type GetCreditReportMetaByIdRequestOptions, type GetCreditReportMetaByIdResponse, type GetCreditReportMetaRequestOptions, type GetCreditReportMetaResponse, type GetCreditReportRequestOptions, type GetCreditReportResponse, type GetCreditScoreResponse, type GetProductConfigByIdResponse, type GlobalProductId, type IHSActionAnswerOption, type IHSCreatePlanResponse, type IHSDisplayParameters, type IHSFactorCategory, type IHSGetPlanRequest, type IHSGetPlanRequestActionStatus, type IHSPlan, type IHSPlanAction, type IHSPlanActionItem, type IHSPlanActionStatus, type IHSPlanPriority, type IHSPlanStatus, type IHSScoreDetails, type IHSScoreFactor, type IHSSubmitSurveyRequest, type IHSSubmitSurveyResponse, type IHSSurvey, type IHSSurveyAnswer, type IHSSurveyAnswerRequest, type IHSSurveyPriority, type IHSSurveyQuestion, type IHSSurveyQuestionItem, type IHSSurveyStatus, type IHSUpdateActionRequest, type IHSUpdateActionResponse, type IHSUpsellObject, type IHSUpsellProduct, type IdentityHealthScore, type Impact, type ImpactType, type LostOrStolenCardDetails, type MappedScoreModelVersion, type MarkCreditReportAsRead, type MarkCreditReportReadRequestOptions_V1, type MarkCreditReportReadRequestOptions_V2, type Month, type Name, type NewAccountDetails, type NewAddressDetails, type NewInquiryDetails, type OnDemandEligibility, type PastDueDetails, type PaymentHistoryCode, type PaymentHistoryCode_V2, type PaymentSummary, type PaymentSummary_V2, type PersonalAddress, type PersonalAddress_V2, type PlanCompletedProgressStatus, type PlanNotSetProgressStatus, type PlanSetProgressStatus, type PostCreditReportRequestOptions, type PostCreditReportResponse, type PostCreditScoreResponse, type ProductConfig, type ProductConfigCadenceType, type ProductConfigDeliveryType, type ProductConfigId, type ProductConfig_V2, type ProductConfigs, type ProductConfigsResponse, type ProductConfigsSearchOptions, type ProductConfigs_V2, type ProductDeliveryCadence, type ProductEligibility, type PublicRecord, type PublicRecordBankruptcyDetails, type ReadStatus, type ReportDisplay, type ReportDisplayScoreDetails, type Scenario, type ScenarioVariation, type ScoreFactor, type ScoreFactorDataPoint, type ScoreIngredient, type ScoreIngredientAttribute, type ScoreIngredientAttributeSubValueType, type ScoreIngredientAttributeValueType, type ScoreIngredientImpact, type ScoreIngredientType, type ScoreItem, type ScoreModel, type ScoreModelVersion, type ScorePlanCompleted, type ScorePlanCreateResponse, type ScorePlanRevision, type ScorePlanRevisionsRequest, type ScorePlanSet, type ScoreRange, type ScoreRating, type ScoreUpdateFrequency, type SettlementDetails, type SimulationCategoryType, type SkipCannotLocateDetails, type SpecialCommentsDetails, type Statement, type Statement_V2, type Supcontent, type TotalAlertCounts, type TransUnionAccountImprovedDetails, type TransUnionAccountInBankruptcyDetails, type TransUnionDelinquentDetails, type TransUnionNewAccountDetails, type TransUnionNewAddressDetails, type TransUnionNewInquiryDetails, type TransUnionNewPublicRecordDetails, type TransUnionPublicRecordBankruptcyDetails, type VantageCreditScorePlan, type VantageCreditScorePlanCompleted, type VantageCreditScorePlanNotSet, type VantageCreditScorePlanSet, type VantageScenario, type VantageScenarioVariation, type VantageScoreModelVersion, type VantageScorePlanCompleted, type VantageScorePlanCreateResponse, type VantageScorePlanRevision, type VantageScorePlanRevisionsRequest, type VantageScorePlanSet, type VantageScoreSimulator, type VantageStatement, createSDK, createSDK as default, isBureauAttribute, isBureauScore, isCreditAttribute, isCreditAttributeArray, isCreditAttributeV2, isCreditAttributesV2, isCreditScore, isCreditScoreArray, isCreditScoreV2, isCreditScoresV2, isFicoPlan, isFicoRevision, isFicoRevisionsRequest, isFicoScenario, isFicoScenarioVariation, isFicoSimulator, isPlanCompleted, isPlanSet, isV1GetCreditAttributesResponse, isV1GetCreditScoresResponse, isV1PostCreditScoresResponse, isV2GetCreditAttributesResponse, isV2GetCreditScoresResponse, isV2PostCreditScoresResponse, isValidApiVersion, isValidBureau, isValidBureauAttribute, isVantagePlan, isVantageRevision, isVantageRevisionsRequest, isVantageScenario, isVantageScenarioVariation, mapApiErrorTypeToSDKErrorType, mapHttpStatusToSDKErrorType };
|