Generate Checkout models (EnhancedSchemeData) #779
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @gcatanese, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request primarily focuses on generating and updating Checkout API models. The most significant change is the introduction and integration of the EnhancedSchemeData model into several request types. Additionally, new payment method types and properties have been added, and existing API documentation comments have been refined for improved clarity and accuracy, especially regarding 3D Secure 2 authentication flows and data requirements.
Highlights
- New Model Integration: EnhancedSchemeData: The
EnhancedSchemeDatamodel has been introduced and integrated into several key Checkout request models, includingPaymentAmountUpdateRequest,PaymentCancelRequest,PaymentRefundRequest,PaymentReversalRequest, andStandalonePaymentCancelRequest. This allows for the inclusion of enhanced scheme-specific data in these requests. - New Payment Method Types: Two new payment method types,
PAYMEandPAYME_POS, have been added to thePaymentDetailsmodel, expanding the supported payment options. - New Payment Method Properties: The
PaymentMethodmodel now includes apromotedboolean property, and theRivertyDetailsmodel includes asubtypestring property, providing more granular control and information for these payment entities. - API Documentation Enhancements: Numerous parameter descriptions across various Checkout models have been updated for clarity and accuracy, particularly concerning 3D Secure 2 requirements (e.g.,
shopperEmail,shopperIP,telephoneNumber,authenticationOnly,origin,dataOnly,nativeThreeDS) andreturnUrllength recommendations. A typo from 'authorisation' to 'authorization' was also corrected.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces the EnhancedSchemeData model and updates various request models to include it. It also contains several updates to PHPDoc comments for clarification and consistency.
My review focuses on improving the code's maintainability and readability by addressing formatting inconsistencies and improving documentation clarity in the auto-generated code.
| * Sets shopperEmail | ||
| * | ||
| * @param string|null $shopperEmail The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. | ||
| * @param string|null $shopperEmail The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. |
There was a problem hiding this comment.
The documentation lacks clarity regarding the necessity of providing shopperEmail when telephoneNumber is absent. Consider rephrasing to emphasize this requirement more explicitly.
* @param string|null $shopperEmail The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. Providing this value is strongly recommended.| * Sets shopperIP | ||
| * | ||
| * @param string|null $shopperIP The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). | ||
| * @param string|null $shopperIP The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).> Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the closing parenthesis, which affects readability. Please add a space between checks). and > Required.
* @param string|null $shopperIP The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).| * Sets threeDSAuthenticationOnly | ||
| * | ||
| * @param bool|null $threeDSAuthenticationOnly If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. | ||
| * @param bool|null $threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**. |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the period, which affects readability. Please add a space between authorization. and Default:.
* @param bool|null $threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. Default: **false**.| * Sets shopperIP | ||
| * | ||
| * @param string|null $shopperIP The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). | ||
| * @param string|null $shopperIP The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).> Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the closing parenthesis, which affects readability. Please add a space between checks). and > Required.
* @param string|null $shopperIP The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).| * Sets threeDSAuthenticationOnly | ||
| * | ||
| * @param bool|null $threeDSAuthenticationOnly If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. | ||
| * @param bool|null $threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**. |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the period, which affects readability. Please add a space between authorization. and Default:.
* @param bool|null $threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. Default: **false**.| return $this->container['returnUrl']; | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the closing parenthesis, which affects readability. Please add a space between checks). and > Required.
* @param string|null $shopperIP The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).| return $this->container['threeDSAuthenticationOnly']; | ||
| } | ||
|
|
||
| /** |
There was a problem hiding this comment.
There's a minor formatting issue in the PHPDoc. A space is missing after the period, which affects readability. Please add a space between authorization. and Default:.
* @param bool|null $threeDSAuthenticationOnly Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation. Default: **false**.| /** | ||
| * Sets enhancedSchemeData | ||
| * | ||
| * @param \Adyen\Model\Checkout\EnhancedSchemeData|null $enhancedSchemeData enhancedSchemeData |
There was a problem hiding this comment.
The PHPDoc for this parameter is not very descriptive. To improve maintainability, please provide a more detailed explanation of what this parameter is for.
* @param \Adyen\Model\Checkout\EnhancedSchemeData|null $enhancedSchemeData Contains information for enhanced scheme data, such as airline data.| /** | ||
| * Sets enhancedSchemeData | ||
| * | ||
| * @param \Adyen\Model\Checkout\EnhancedSchemeData|null $enhancedSchemeData enhancedSchemeData |
There was a problem hiding this comment.
The PHPDoc for this parameter is not very descriptive. To improve maintainability, please provide a more detailed explanation of what this parameter is for.
* @param \Adyen\Model\Checkout\EnhancedSchemeData|null $enhancedSchemeData Contains information for enhanced scheme data, such as airline data.| * Sets addrMatch | ||
| * | ||
| * @param string|null $addrMatch Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address. | ||
| * @param string|null $addrMatch Indicates whether the cardholder shipping Address and cardholder billing address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address. |
There was a problem hiding this comment.
There's a typo in the PHPDoc. shipping Address should be shipping address for consistency with the rest of the sentence.
* @param string|null $addrMatch Indicates whether the cardholder shipping address and cardholder billing address are the same. Allowed values: * **Y** — Shipping address matches Billing Address. * **N** — Shipping Address does not match Billing Address.
|
Generate Checkout models