Skip to content

Conversation

@lucassus
Copy link
Contributor

@lucassus lucassus commented Jul 17, 2025

This pull request updates the documentation and SDK references for the Maxio Advanced Billing API, focusing on improving clarity, upgrading SDK versions, and standardizing response types. Key changes include updating links and examples to reflect the latest SDK version, enhancing the descriptions of API responses, and restructuring the documentation for better usability.

Documentation Updates:

  • Updated SDK version references in README.md and related documentation from 6.1.0 to 7.0.0, including links to new SDK documentation and examples. [1] [2]
  • Improved descriptions of API response types to clarify the usage of the ApiResponse interface and its result property. This change applies to multiple API methods across the documentation. [1] [2] [3] [4]
  • Added a usage example for the ApiResponse interface in doc/api-response.md to demonstrate handling API responses and errors.

SDK Configuration and Parameters:

  • Standardized the presentation of configurable parameters for the API client, linking to detailed documentation for HttpClientOptions and RetryConfiguration.
  • Enhanced descriptions of pagination parameters (perPage, page) in API methods for better readability and understanding.

Miscellaneous Improvements:

  • Updated terminology and formatting in README.md for consistency, such as renaming sections and refining example commands.
  • Replaced inline type definitions with links to their respective documentation for better maintainability and clarity. [1] [2]

@lucassus lucassus self-assigned this Jul 17, 2025
@lucassus lucassus changed the title Release 7.0.0 [FND-3] Release 7.0.0 Jul 24, 2025
@lucassus lucassus marked this pull request as ready for review July 24, 2025 09:33
@lucassus lucassus merged commit a59ccfc into main Jul 24, 2025
1 check passed
@lucassus lucassus deleted the publish branch July 24, 2025 13:16
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.

3 participants