Skip to content

Cloud device API doc#1909

Open
gcatanese wants to merge 8 commits intomainfrom
cloud-device-api-docs
Open

Cloud device API doc#1909
gcatanese wants to merge 8 commits intomainfrom
cloud-device-api-docs

Conversation

@gcatanese
Copy link
Copy Markdown
Contributor

@gcatanese gcatanese commented Apr 13, 2026

Update README to add new Cloud Device API
Created doc folder to separate Terminal API and Cloud device API doc
Added a section Helper classes in the README (not the helper doesn't yet exist, it will included in a different PR)
Added Migration Guide to be published with the Release

Note: Terminal API is not marked as deprecated, at this stage the approach is to promote the new Cloud device API for new integrations, making sure customers know that the existing integrations are not affected

@gcatanese gcatanese requested review from a team as code owners April 13, 2026 11:07
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the project documentation to introduce the Cloud Device API and deprecate older Terminal API integrations. Key changes include a reorganized README, updated prerequisites, and the addition of dedicated documentation files for the Cloud Device and Terminal APIs. The review feedback identifies several issues within the new documentation's code snippets, such as incorrect package imports, mismatches between documented method names and their actual implementations, and the use of uninitialized variables in examples.

Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/TerminalApi.md Outdated
Comment thread doc/TerminalApi.md Outdated
@gcatanese
Copy link
Copy Markdown
Contributor Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the CloudDeviceApi as a modern, OpenAPI-generated replacement for the legacy TerminalCloudAPI for in-person payments. The changes include updated documentation in the README.md, a new migration guide, and dedicated documentation files for both the new and legacy APIs. Feedback focuses on correcting a typo in the migration guide, resolving an inconsistency in example links within the README.md, and including missing standard library imports in the code snippets provided in the new documentation.

Comment thread README.md
Comment thread doc/MigratingToCloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md
Comment thread doc/TerminalApi.md
@gcatanese gcatanese force-pushed the cloud-device-api-docs branch from 6f94229 to 67b4176 Compare April 13, 2026 12:32
@gcatanese gcatanese force-pushed the cloud-device-api-docs branch from 67b4176 to 3f71855 Compare April 13, 2026 12:36
Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md
Comment thread doc/CloudDeviceApi.md Outdated
Comment thread doc/CloudDeviceApi.md
.adyenCryptoVersion(0)
.keyIdentifier("CryptoKeyIdentifier12345")
.keyVersion(0)
.passphrase("p@ssw0rd123456");
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we suggest here loading these via an environment variable? some merchants may think this means it's ok to hardcode the passphrase

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair point, but all README files in the libraries use the same convention. I suggest to create a new issue if we want to include best practices in the snippets across all libraries.

Comment thread doc/MigratingToCloudDeviceApi.md
Comment thread doc/MigratingToCloudDeviceApi.md
Comment thread doc/MigratingToCloudDeviceApi.md

#### Numeric fields

- `BigInteger` fields are `Integer` in the Cloud device API
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, is there a risk this creates issues? this is a narrowing conversion

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there is always a risk "narrowing" the conversion, but practically Integer is big enough for the type of data we handle. It is most likely that former SDK code didn't really need to use BigInteger

@gcatanese gcatanese force-pushed the cloud-device-api-docs branch from 3caa65f to f7d71bd Compare April 16, 2026 15:40
@gcatanese gcatanese force-pushed the cloud-device-api-docs branch from f7d71bd to 967585f Compare April 16, 2026 15:41
@gcatanese gcatanese requested a review from thomasc-adyen April 16, 2026 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants