Skip to content

Commit

Permalink
updated readme with disclaimer on Enum values (#1070)
Browse files Browse the repository at this point in the history
* updated readme with disclaimer on Enum values
  • Loading branch information
DjoykeAbyah authored Oct 8, 2024
1 parent 03709c3 commit 7050746
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ or install it from package manager
```
PM> Install-Package Adyen -Version x.x.x
```
## ❗Disclaimer on Enum Values

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.

⚠️ 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.

Upon upgrade check the Relesase Notes and the associated PRs to understand the changes and any potential impact on your integration.

## Using the library

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

0 comments on commit 7050746

Please sign in to comment.