Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump mittwald/api-client from 2.1.87 to 2.1.97 #228

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jan 24, 2025

Bumps mittwald/api-client from 2.1.87 to 2.1.97.

Release notes

Sourced from mittwald/api-client's releases.

v2.1.97

Deprecation of Parameters

Several parameters across various classes have been deprecated. Most notably, the targetDay parameter in the InvoiceUpdateInvoiceSettingsRequest has been marked as deprecated and will be ignored in future versions. This change indicates a move towards streamlining API request bodies and improving overall API usability.

Deprecated Parameters

  • targetDay:
    • Description: This parameter is deprecated and will be ignored.

Clean-up of Comments

Multiple instances of parameter descriptions that indicate types such as int|float have been removed from comments throughout the codebase. This enhances readability and focuses the documentation on the high-level purpose rather than redundant type indications.

Example Changes

  • Removed comment lines specifying parameter types for various functions across classes including:
    • withPaymentSettings
    • withTimeout
    • withPrice

Code Refactoring for Clarity

Fragments of business logic were rationalized, and the structure of various classes has been simplified, improving code clarity and maintainability.

Refactored Classes

  • InvoiceUpdateInvoiceSettingsRequest & Related Classes:

    • Simplified handling of deprecated parameters.
  • OrderCreation Related Classes:

    • Removed multiple unnecessary comments related to parameter types, enhancing readability.

Overall, the updates reflect a continual effort to improve the API client, embracing a cleaner and more intuitive approach for developers integrating with the system, alongside reinforcing guidelines for proper parameter usage.

v2.1.96

Summary of Changes

This release includes substantial adjustments to the validation processes throughout the application, reinforcing the use of self::$schema instead of static::$schema in several classes. The modifications enhance consistency and maintainability in API client responses across various components.

Changes

Validation Changes

  • Updated the following classes to replace static::$schema with self::$schema for validation schemas:
    • DeprecatedAppLinkDatabaseDefaultResponse
    • DeprecatedAppLinkDatabaseNotFoundResponse
    • DeprecatedAppLinkDatabaseRequest
    • DeprecatedAppLinkDatabaseRequestBody
    • DeprecatedAppLinkDatabaseTooManyRequestsResponse
    • ExecuteActionDefaultResponse
    • ExecuteActionNotFoundResponse
    • ExecuteActionRequest
    • ExecuteActionRequestBody
    • ExecuteActionTooManyRequestsResponse

... (truncated)

Commits
  • 34a9795 fix: mark targetDay parameter as deprecated and ignored in InvoiceUpdateInvoi...
  • 8ff2f57 Bump cs-fixer and force it to run on PHP 8.4
  • 6c13620 Merge pull request #15 from mittwald/ci/php-8.4
  • 7996a3c Declare $previous param as explicitly nullable
  • 2e649db Fix text+typecheck commands in actions
  • ac461a1 Ignore match.unhandled errors until they can be fixes in client generation
  • e282c12 Account for incorrect 3rd-party doccomment in Validator class
  • a662058 Remove ignored PHPStan errors
  • 2488800 Update rector, switch to phpstan
  • af1f527 Test against PHP 8.4 in pipeline
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [mittwald/api-client](https://github.com/mittwald/api-client-php) from 2.1.87 to 2.1.97.
- [Release notes](https://github.com/mittwald/api-client-php/releases)
- [Commits](mittwald/api-client-php@v2.1.87...v2.1.97)

---
updated-dependencies:
- dependency-name: mittwald/api-client
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file php Pull requests that update Php code labels Jan 24, 2025
@github-actions github-actions bot enabled auto-merge January 24, 2025 18:24
Copy link
Contributor Author

dependabot bot commented on behalf of github Jan 28, 2025

Superseded by #229.

@dependabot dependabot bot closed this Jan 28, 2025
auto-merge was automatically disabled January 28, 2025 18:18

Pull request was closed

@dependabot dependabot bot deleted the dependabot/composer/mittwald/api-client-2.1.97 branch January 28, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file php Pull requests that update Php code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants