@experian-ecs/connected-api-sdk 1.5.0 → 1.6.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 +26 -1
- package/dist/esm/index.mjs +277 -258
- package/dist/esm/index.mjs.map +1 -1
- package/dist/index.d.ts +74 -1
- 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
|
@@ -15,7 +15,8 @@
|
|
|
15
15
|
9. [Customers](#customers)
|
|
16
16
|
10. [Entitlements](#entitlements)
|
|
17
17
|
11. [Product Configs](#product-configs)
|
|
18
|
-
12. [
|
|
18
|
+
12. [Offers](#offers)
|
|
19
|
+
13. [Registrations](#registrations)
|
|
19
20
|
3. [Utilities](#utilities)
|
|
20
21
|
1. [Type Guards](#type-guards)
|
|
21
22
|
|
|
@@ -704,6 +705,30 @@ The Credit Attributes API supports both v1 and v2 endpoints with different respo
|
|
|
704
705
|
});
|
|
705
706
|
```
|
|
706
707
|
|
|
708
|
+
### Offers
|
|
709
|
+
|
|
710
|
+
* #### Retrieve available credit card offers
|
|
711
|
+
|
|
712
|
+
```tsx
|
|
713
|
+
await sdk.offers.getOffers({
|
|
714
|
+
product_config_id: 'procfg_01'
|
|
715
|
+
});
|
|
716
|
+
```
|
|
717
|
+
|
|
718
|
+
* #### Handle a successful empty offers response
|
|
719
|
+
|
|
720
|
+
```tsx
|
|
721
|
+
const { data, error } = await sdk.offers.getOffers({
|
|
722
|
+
product_config_id: 'procfg_01'
|
|
723
|
+
});
|
|
724
|
+
|
|
725
|
+
if (data && data.offer_summary.total_count === 0) {
|
|
726
|
+
console.log('No offers available');
|
|
727
|
+
} else if (error) {
|
|
728
|
+
console.error(error);
|
|
729
|
+
}
|
|
730
|
+
```
|
|
731
|
+
|
|
707
732
|
### Registrations
|
|
708
733
|
|
|
709
734
|
* #### Create a customer, create an entitlement, and activate product(s) in a single request
|