Feature/add locked currency to platform payment config

[mercury2269]

Description
Per Adyen’s IM, setting lockedCurrency when creating a balance account ensures fees are FX-converted to the specified currency. Since this property isn’t available in the SDK, this PR adds it to PlatformPaymentConfiguration.

Tested scenarios
Support for locked currency property

Fixed issue:
N/A

[gemini-code-assist]

Summary of Changes

Hello @mercury2269, I'm Gemini Code Assist¹! 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 enhances the platform payment configuration by integrating a new capability to specify a 'locked currency' for balance accounts. This change directly addresses a requirement to manage foreign exchange conversions for payment fees, providing more precise control over financial operations within the system. The update ensures that the system aligns with external financial guidelines by allowing explicit currency locking for fee calculations.

Highlights

• New Feature: Locked Currency Configuration: Introduced a new lockedCurrency property within PlatformPaymentConfiguration. This property allows specifying a three-letter ISO currency code to lock a balance account, ensuring that fees are FX-converted to the specified currency, which was previously not available in the SDK.
• Enhanced FX Conversion for Fees: The addition of lockedCurrency enables foreign exchange (FX) conversion for PaymentFee split types, which by default are not subject to FX. This provides greater control over currency handling for payment fees.
• Comprehensive Test Coverage: A new test file src/__tests__/platformPaymentConfiguration.spec.ts has been added to validate the functionality of the lockedCurrency property, including its support, inclusion in attributeTypeMap, and integration with BalanceAccountInfo.

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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request introduces the lockedCurrency property to the PlatformPaymentConfiguration type. This change aligns the SDK with a feature available in the Adyen API for handling foreign exchange fees. The implementation is straightforward, correctly updating the type definition and its metadata. The addition of a new test suite to validate the PlatformPaymentConfiguration is a great practice and ensures the new property is working as expected. I have one suggestion to enhance the new tests for better robustness. Overall, this is a solid contribution.

[gemini-code-assist]

To improve test robustness and conciseness, consider asserting against the entire attribute object using toEqual. This ensures all properties of the attribute (including name and format) are correctly defined, and it simplifies the test by combining multiple assertions into one.

Suggested change

	expect(lockedCurrencyAttr).toBeDefined();
	expect(lockedCurrencyAttr?.baseName).toBe("lockedCurrency");
	expect(lockedCurrencyAttr?.type).toBe("string");
	expect(lockedCurrencyAttr).toEqual({
	name: "lockedCurrency",
	baseName: "lockedCurrency",
	type: "string",
	format: ""
	});

[gcatanese]

Hey @mercury2269, thank you for spotting and fixing this.
Unfortunately we cannot merge the PR as we generate the source code from the OpenAPI spec file.

I will raise the issue with the relevant team so they can update the API contract and we can update all libraries. Feel free to create a GitHub issue if you want to keep track of the progress and when it get resolved. Thank you!

[gcatanese]

Hey @mercury2269, thank you for reporting this. The feature is still being evaluated, hence it is not yet included in our SDKs. Please reach out to the IM if you need more information about if and when this becomes available.
Thank you.