Client setup: remove old code and promote best practises

[gcatanese]

This PR improves the setup of the Client object required to perform the API requests. The following changes have been introduced:

• remove several legacy methods, deprecated already for 4-5 years

// removed as this method never worked (see README to follow best practises for Client setup)
public Client(String username, String password, Environment environment, String applicationName)

// deprecated since version 1.6.1 (see README to follow best practises for Client setup)
public Client(String username, String password, Environment environment, int connectionTimeoutMillis) 

// deprecated since version 1.6.1 (see README to follow best practises for Client setup)
public Client(String username, String password, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix)

// deprecated since version 1.6.1 (see README to follow best practises for Client setup)
public Client(String apiKey, Environment environment, int connectionTimeoutMillis) 

// deprecated since version 1.6.1 (see README to follow best practises for Client setup)
public Client(String apiKey, Environment environment, int connectionTimeoutMillis, String liveEndpointUrlPrefix)

// deprecated since version 1.5.4 (see README to follow best practises for Client setup)
public void setEnvironment(Environment environment)

• refactor ClientTest to show case best practises for setting up the Client object

// setup using Config object
Config config = new Config()
    .environment(Environment.LIVE)
    .liveEndpointUrlPrefix("myCompany")
    .apiKey(apiKey);
Client client = new Client(config);

• add Javadoc to Client, Service and Config classes
• update README to show case best practises for setting up the Client object

[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!

This pull request focuses on improving the Client object setup within the library. It streamlines the client initialization process by removing outdated methods and standardizing on a Config object for configuration. Additionally, it significantly enhances the codebase's documentation through Javadoc additions and updates the public-facing README to guide users towards these new best practices, ultimately leading to a more robust and user-friendly client integration.

Highlights

• Code Cleanup and Modernization: Removed several legacy and deprecated Client constructors and the setEnvironment method, simplifying the API surface and promoting current best practices.
• Configuration Standardization: Promoted the use of the Config object for Client setup, allowing for a more structured and flexible way to configure the client, as demonstrated in updated README.md examples and ClientTest.
• Improved Documentation: Added comprehensive Javadoc comments to the Client, Service, and Config classes, enhancing code clarity and maintainability for developers.
• Documentation Updates: Updated the README.md to reflect the new Client setup best practices, including examples for API key and basic authentication, and added a new section on error handling.
• Enhanced Test Coverage: Introduced a new ServiceTest.java file with dedicated unit tests for the Service.createBaseURL method, ensuring correct URL construction across different environments and API types.

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 does a great job of cleaning up the client setup by removing deprecated methods, adding Javadoc, and updating documentation to reflect best practices. The changes significantly improve the library's usability. My review focuses on a few areas: ensuring code examples in the documentation are self-contained, maintaining consistent code formatting across the project, and adopting more modern testing patterns for improved readability.