Releases: supportpal/api-client-php
Releases · supportpal/api-client-php
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 aCreateComment
model as its parameter - see wiki for example. - Tickets API:
postTicket()
is nowcreateTicket()
and requires aCreateTicket
model as its parameter - see wiki for example. - Tickets API:
downloadAttachment()
now takes an ID as its parameter. - Users API:
postUser()
is nowcreateUser()
and requires aCreateUser
model as its parameter - see wiki for example. - Users API:
updateUser()
now requires a user ID for the first parameter and aUpdateUser
model 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
v1.6.0
What's Changed
- chore(deps): bump actions/checkout from 2 to 3 by @dependabot in #167
- chore: update prophecy usages by @bytestream in #170
- chore(deps): bump StephaneBour/actions-php-cpd from 8.0 to 8.1 by @dependabot in #169
- test: php 8.2 by @bytestream in #171
- chore: update to symfony 6 by @ju5t in #172
New Contributors
Full Changelog: v1.5.0...v1.6.0
v1.5.0
What's Changed
- chore: remove semantic release by @bytestream in #158
- chore(deps): update phpstan/phpstan to v1.4.6 by @bytestream in #162
- fix(deps): update kevinrob/guzzle-cache-middleware to v4 by @bytestream in #164
- feat: php 8.1 support by @bytestream in #165
- chore(deps): update composer.lock by @bytestream in #166
Full Changelog: v1.4.1...v1.5.0
v1.4.1
v1.4.0
v1.3.3
1.3.3 (2021-03-25)
Bug Fixes
Miscellaneous Chores
- deps: bump actions/setup-node from v2.1.4 to v2.1.5 (#128) 7a30bf7
- deps: bump StephaneBour/actions-php-cpd from 7.4 to 8.0 (#137) 03d69d7
- deps-dev: bump @semantic-release/release-notes-generator (#133) 95e27cf
- deps-dev: bump semantic-release from 17.4.0 to 17.4.2 (#135) c898e38
- enable stale bot e6ed477
- deps-dev: bump semantic-release from 17.3.9 to 17.4.0 (#129) 041b5de