Releases: supportpal/api-client-php
Releases · supportpal/api-client-php
v2.5.0
What's Changed
- Remove composer.lock by @bytestream in #302
- Add propaganistas/laravel-phone 6 support by @bytestream in #303
- Fix deprecation notice by @bytestream in #304
- chore(deps-dev): update phpstan/phpstan requirement from 2.1.31 to 2.2.1 by @dependabot[bot] in #306
- Add Symfony 8 support by @Copilot in #307
New Contributors
- @Copilot made their first contribution in #307
Full Changelog: v2.4.0...v2.5.0
v2.4.0
What's Changed
- chore(deps): bump symfony/http-foundation from 6.4.18 to 6.4.29 by @dependabot[bot] in #282
- chore(deps-dev): bump phpunit/phpunit from 9.6.29 to 9.6.33 by @dependabot[bot] in #292
- chore(deps): bump actions/checkout from 5 to 6 by @dependabot[bot] in #284
- Replace jenssegers/model with supportpal/model by @bytestream in #299
- Add PHP 8.5 to CI workflow matrix by @bytestream in #300
Full Changelog: v2.3.0...v2.4.0
v2.3.0
What's Changed
- Use PhpFileLoader instead of YamlFileLoader by @bytestream in #275
- chore(deps-dev): bump supportpal/coding-standard from 0.4.4 to 0.4.5 by @dependabot[bot] in #279
- chore(deps-dev): bump jangregor/phpstan-prophecy from 2.1.1 to 2.2.0 by @dependabot[bot] in #278
- chore(deps-dev): bump phpspec/prophecy-phpunit from 2.3.0 to 2.4.0 by @dependabot[bot] in #277
- chore(deps): bump kevinrob/guzzle-cache-middleware from 6.0.0 to 7.0.0 by @dependabot[bot] in #276
- chore: add docblocks for autocompletion by @ju5t in #280
Full Changelog: v2.2.0...v2.3.0
v2.2.0
What's Changed
- chore(deps): bump actions/checkout from 4 to 5 by @dependabot[bot] in #257
- chore(deps): bump phpdocumentor/reflection-docblock from 5.6.1 to 5.6.3 by @dependabot[bot] in #258
- chore(deps): bump guzzlehttp/guzzle from 7.9.2 to 7.10.0 by @dependabot[bot] in #259
- refactor(tests): update namespaces for unit test files by @bytestream in #274
- chore(deps-dev): bump phpstan/phpstan from 2.1.11 to 2.1.31 by @dependabot[bot] in #272
- fix(deps): replace supportpal/eloquent-model with jenssegers/model by @bytestream in #273
Full Changelog: v2.1.0...v2.2.0
v2.1.0
What's Changed
- Test on PHP 8.4 by @bytestream in #207
- chore(deps-dev): bump phpstan/phpstan from 2.0.0 to 2.0.2 by @dependabot in #209
- chore(deps-dev): bump phpstan/phpstan from 2.0.2 to 2.1.6 by @dependabot in #222
- chore(deps-dev): bump squizlabs/php_codesniffer from 3.11.1 to 3.11.3 by @dependabot in #218
- chore(deps): bump nesbot/carbon from 2.72.5 to 2.73.0 by @dependabot in #225
- chore(deps): bump phpdocumentor/reflection-docblock from 5.6.0 to 5.6.1 by @dependabot in #212
- chore: add purified_description to custom field models by @jshah4517 in #223
- chore(deps): bump kevinrob/guzzle-cache-middleware from 5.1.0 to 6.0.0 by @dependabot in #210
- chore(deps-dev): bump squizlabs/php_codesniffer from 3.11.3 to 3.12.1 by @dependabot in #226
- chore(deps): bump propaganistas/laravel-phone from 5.3.2 to 5.3.6 by @dependabot in #228
- chore(deps-dev): bump jangregor/phpstan-prophecy from 2.0.0 to 2.1.1 by @dependabot in #227
- chore(deps-dev): bump phpstan/phpstan from 2.1.6 to 2.1.11 by @dependabot in #229
- chore(deps): switch from doctrine/cache to symfony/cache by @bytestream in #230
Full Changelog: v2.0.1...v2.1.0
v1.7.2
What's Changed
- [1.x] chore: add purified_description to custom field models by @jshah4517 in #224
Full Changelog: v1.7.1...v1.7.2
v2.0.1
What's Changed
- chore: bump psr/http-message requirement by @jshah4517 in #206
Full Changelog: v2.0.0...v2.0.1
v2.0.0
What's Changed
- There have been large updates to the library to improve the flexibility of using the client with different SupportPal versions and also allow changes to the API on the SupportPal software side in the future without needing to update the client as regularly.
- The library now adopts a Laravel Eloquent model approach for the data returned.
- For responses with more than one model, a collection is returned and this can now utilise the Laravel Collection available methods.
- The dependencies have been bumped so it can be used with Symfony 7.x.
- There are a large number of breaking changes which have been documented below.
- A number of new API endpoints are now supported, the wiki contains the full list of endpoints supported.
Full Changelog: v1.7.1...v2.0.0
Breaking Changes
- Minimum PHP version has been bumped to 8.1.
- Minimum SupportPal version has been bumped to 5.0.0.
- Previously the object returned would have its data accessed with 'getters' such as
$ticket->getId(), this is now$ticket->id. This applies to all models returned by the client. - The collection
getCount()method is nowcount(), which counts the number of models in the current collection. - The collection
getModelsCount()method is nowtotalCount(), which counts the total number of records that were found for this endpoint but not the (limited) data that was returned. - For unsupported endpoints,
$api->getRequestFactory()has become$api->getRequest(). - For all settings endpoints, the
getSetting()method has been removed and the data can be accessed directly from the model by the setting name key. For example,$api->getCoreApi()->getSettings()->admin_folder. - Self-Service API:
postComment()is nowcreateComment()and requires aCreateCommentmodel as its parameter - see wiki for example. - Tickets API:
postTicket()is nowcreateTicket()and requires aCreateTicketmodel as its parameter - see wiki for example. - Tickets API:
downloadAttachment()now takes an ID as its parameter. - Users API:
postUser()is nowcreateUser()and requires aCreateUsermodel as its parameter - see wiki for example. - Users API:
updateUser()now requires a user ID for the first parameter and aUpdateUsermodel as its parameter - see wiki for example. - Users API:
getCustomFields()is nowgetUserCustomFields(). - Users API:
getCustomField()is nowgetUserCustomField(). - Users API:
getGroups()is nowgetUserGroups(). - Users API:
getGroup()is nowgetUserGroup().
v1.7.1
What's Changed
- chore(deps): bump actions/checkout from 3 to 4 by @dependabot in #176
- test: php 8.3 by @bytestream in #177
- ci: only run test coverage on PHP 8.3 by @bytestream in #181
- Fix Symfony 6.3/6.4 deprecation notice by @Gaitholabi in #179
Full Changelog: v1.7.0...v1.7.1
v1.7.0
What's Changed
- chore(deps): lock phpstan/phpstan to 1.10.25 by @bytestream in #174
- chore(deps): bump StephaneBour/actions-php-cpd from 8.1 to 8.2 by @dependabot in #173
- SupportPal v5 support by @bytestream in #175
Full Changelog: v1.6.0...v1.7.0