Skip to content

updated readme with disclaimer on Enum values #1070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 8, 2024
Merged

updated readme with disclaimer on Enum values #1070

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2b20ef4
updated readme with disclaimer on Enum values
DjoykeAbyah Oct 8, 2024
6a10fff
added exclamation mark for visibility
DjoykeAbyah Oct 8, 2024
30ef878
adjusted text readme
DjoykeAbyah Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
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
Loading