Updating operations to accept generic request options instead of just query parameters #522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
douglasmiller
force-pushed
the
options-params
branch
from
54ca8df to
4e62633
Compare
douglasmiller
added a commit
that referenced
this pull request
Mar 1, 2021
# Changelog ## [Unreleased](https://github.com/recurly/recurly-client-php/tree/HEAD) [Full Changelog](3.11.0...HEAD) # Major Version Release The 4.x major version of the client pairs with the `v2021-02-25` API version. This version of the client and the API contain breaking changes that should be considered before upgrading your integration. ## Breaking Changes in the API All changes to the core API are documented in the [Developer Portal changelog](https://developers.recurly.com/api/changelog.html#v2021-02-25---current-ga-version) ## Breaking Changes in Client - Require query string parameters to be specified under the `params` key of the `$options` parameter. [[#522](#522)] ### 3.x ```php $options = [ 'limit' => 200 ]; $accounts = $client->listAccounts($options); ``` ### 4.x ```php $options = [ 'params' => [ 'limit' => 200 ], 'headers' => [ 'Accept-Language' => 'fr' ] ]; $accounts = $client->listAccounts($options); ``` **Implemented enhancements:** - Updating operations to accept generic request options instead of just query parameters [\#522](#522) ([douglasmiller](https://github.com/douglasmiller)) **Merged pull requests:** - Updating changelog script and changelog generator config for 4.x release [\#582](#582) ([douglasmiller](https://github.com/douglasmiller)) - Null checking variable before calling property\_exists to prevent Warning [\#526](#526) ([douglasmiller](https://github.com/douglasmiller)) - Mon Jul 6 14:54:15 UTC 2020 Upgrade API version v2019-10-10 [\#515](#515) ([douglasmiller](https://github.com/douglasmiller))
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an update to the
4.xversion of the client.Operations now require that query string parameters be specified under the
paramskey of the$optionsparameter. This will allow for additional options to be specified in requests. Currently, this only includes custom headers, but may be expanded in the future.This pull request also adds the
getRequest()method to the\Recurly\Responseclass for debugging purposes.In the
3.xversion of the client, query string parameters would be specified directly on the$optionsparameter of the operation:With this update, the
paramskey must be added to the$options. Additionally, aheaderskey may be added: