Skip to content

Commit 7050746

Browse files
authored
updated readme with disclaimer on Enum values (#1070)
* updated readme with disclaimer on Enum values
1 parent 03709c3 commit 7050746

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,14 @@ or install it from package manager
6060
```
6161
PM> Install-Package Adyen -Version x.x.x
6262
```
63+
## ❗Disclaimer on Enum Values
64+
65+
Please note that the integer value (index) of the enums used in this library may change in future releases. These values are not guaranteed to remain static, and they may be modified, added, or removed as the library evolves.
66+
67+
⚠️ We advise against hard-coding or relying on specific enum integer values in your implementation, as they may break compatibility with future versions of this library. Use instead the string value of the enums.
68+
69+
Upon upgrade check the Relesase Notes and the associated PRs to understand the changes and any potential impact on your integration.
70+
6371
## Using the library
6472

6573
In order to submit http request to Adyen API you need to initialize the client. The following example makes a checkout payment request:

0 commit comments

Comments
 (0)