Terminal Cloud API async: update return type

[gcatanese]

The signature of the async method is incorrect

public async(terminalApiRequest: TerminalApiRequest): Promise<string> 

The API returns ok (string) unless there is an error. In that case the response is instead an instance of TerminalApiResponse.
This PR updates the signature of the method to

public async(terminalApiRequest: TerminalApiRequest): Promise<string | TerminalApiResponse>

⚠️ Breaking Change

• Changed return type of TerminalCloudAPI.async() from Promise<string> to Promise<string | SaleToPOIRequest>.
• Consumers must now check the type of the response before using it.

If you were assuming a string response, you now need to handle both string and SaleToPOIRequest:

const response = await terminalCloudAPI.async(paymentRequest);
// handle both `string` and `TerminalApiResponse`
if (typeof response === "string") {
  // Your previous logic
  ...
} else {
  // request failed: see details in the EventNotification object
  console.log("EventToNotify:", requestResponse.SaleToPOIRequest?.EventNotification?.EventToNotify);
  console.log("EventDetails:", requestResponse.SaleToPOIRequest?.EventNotification?.EventDetails);
}

Fix #1439

[gemini-code-assist]

Summary of Changes

Hello @gcatanese, 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!

I've updated the TerminalCloudAPI.async() method to correctly reflect its possible return types. Previously, it was typed to always return a Promise<string>, but in cases of an error, it actually returns a TerminalApiResponse. This change ensures type safety and provides consumers with the correct information to handle both successful (string) and error (TerminalApiResponse) responses, which is a breaking change.

Highlights

• API Signature Correction: The async method of TerminalCloudAPI now correctly returns Promise<string | TerminalApiResponse>, accounting for both successful "ok" responses and error objects.
• Breaking Change: Consumers of the TerminalCloudAPI.async() method must now explicitly handle both string and TerminalApiResponse types.
• Documentation Update: The README.md has been updated with a new section and example code demonstrating how to properly handle the updated return type.
• Enhanced Testing: New mock data and a dedicated test case have been added to verify the correct handling of error responses from the asynchronous API.

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

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 a breaking change by updating the return type of TerminalCloudAPI.async() to Promise<string | TerminalApiResponse>, which more accurately reflects the API's behavior. The changes to the service implementation, mocks, and tests are correct and properly cover the new functionality.

My review includes several suggestions to improve the new documentation in README.md by fixing typos and errors in the code examples to prevent confusion for users. I've also identified a type-safety issue in terminalCloudAPI.ts related to how getJsonResponse is called, which should be addressed to ensure long-term maintainability.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud