@experian-ecs/connected-api-sdk 1.3.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 +24 -1
- package/dist/esm/index.mjs +354 -346
- package/dist/esm/index.mjs.map +1 -1
- package/dist/index.d.ts +57 -8
- package/dist/umd/index.umd.js +1 -1
- package/dist/umd/index.umd.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -667,18 +667,41 @@ The Credit Attributes API supports both v1 and v2 endpoints with different respo
|
|
|
667
667
|
|
|
668
668
|
### Product Configs
|
|
669
669
|
|
|
670
|
+
The Product Config API supports both v1 and v2 endpoints with different response formats. Use the `version` parameter to specify which API version to use. Leaving blank defaults to `v1`.
|
|
671
|
+
|
|
672
|
+
|
|
670
673
|
* #### Retrieve product configurations for a tenant
|
|
671
674
|
|
|
672
675
|
```tsx
|
|
676
|
+
// Defaults to V1
|
|
673
677
|
await sdk.productConfigs.getProductConfigs();
|
|
678
|
+
|
|
679
|
+
// V1 API - returns product configurations
|
|
680
|
+
await sdk.productConfigs.getProductConfigs({version: 'v1'});
|
|
681
|
+
|
|
682
|
+
// V2 API - Includes Score Ranges and Disclosures array
|
|
683
|
+
await sdk.productConfigs.getProductConfigs({version: 'v2'});
|
|
674
684
|
```
|
|
675
685
|
|
|
676
686
|
* #### Retrieve a single product configuration for a tenant
|
|
677
687
|
|
|
678
688
|
```tsx
|
|
689
|
+
// Defaults to V1
|
|
679
690
|
await sdk.productConfigs.getProductConfigById({
|
|
680
691
|
product_config_id: 'procfg_01'
|
|
681
692
|
});
|
|
693
|
+
|
|
694
|
+
// V1 API
|
|
695
|
+
await sdk.productConfigs.getProductConfigById({
|
|
696
|
+
product_config_id: 'procfg_01',
|
|
697
|
+
version: 'v1'
|
|
698
|
+
});
|
|
699
|
+
|
|
700
|
+
// V2 API - Includes Score Ranges and Disclosures array
|
|
701
|
+
await sdk.productConfigs.getProductConfigById({
|
|
702
|
+
product_config_id: 'procfg_01',
|
|
703
|
+
version: 'v2'
|
|
704
|
+
});
|
|
682
705
|
```
|
|
683
706
|
|
|
684
707
|
### Registrations
|
|
@@ -790,4 +813,4 @@ For typescript users, helper utility functions are exported in order to aid with
|
|
|
790
813
|
function isCreditAttributeArray(data: unknown): data is CreditAttribute[];
|
|
791
814
|
function isV1GetCreditAttributesResponse(data: unknown): data is GetCreditAttributeResponse<'v1'>;
|
|
792
815
|
function isV2GetCreditAttributesResponse(data: unknown): data is GetCreditAttributeResponse<'v2'>;
|
|
793
|
-
|
|
816
|
+
```
|