Skip to content

Releases: supportpal/api-client-php

v2.0.1

09 Jul 12:10
bae45f7
Compare
Choose a tag to compare

What's Changed

Full Changelog: v2.0.0...v2.0.1

v2.0.0

11 Jun 09:44
20b87ae
Compare
Choose a tag to compare

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 now count(), which counts the number of models in the current collection.
  • The collection getModelsCount() method is now totalCount(), 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 now createComment() and requires a CreateComment model as its parameter - see wiki for example.
  • Tickets API: postTicket() is now createTicket() and requires a CreateTicket model as its parameter - see wiki for example.
  • Tickets API: downloadAttachment() now takes an ID as its parameter.
  • Users API: postUser() is now createUser() and requires a CreateUser model as its parameter - see wiki for example.
  • Users API: updateUser() now requires a user ID for the first parameter and a UpdateUser model as its parameter - see wiki for example.
  • Users API: getCustomFields() is now getUserCustomFields().
  • Users API: getCustomField() is now getUserCustomField().
  • Users API: getGroups() is now getUserGroups().
  • Users API: getGroup() is now getUserGroup().

v1.7.1

22 Jan 10:07
bda7b40
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.7.0...v1.7.1

v1.7.0

23 Aug 13:19
7a142d8
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.6.0...v1.7.0

v1.6.0

05 Mar 21:47
d0badcf
Compare
Choose a tag to compare

What's Changed

New Contributors

  • @ju5t made their first contribution in #172

Full Changelog: v1.5.0...v1.6.0

v1.5.0

25 Feb 15:58
5e50302
Compare
Choose a tag to compare

What's Changed

Full Changelog: v1.4.1...v1.5.0

v1.4.1

30 Apr 12:45
ecd5060
Compare
Choose a tag to compare

1.4.1 (2021-04-30)

Bug Fixes

  • type translation slug can also be null (#144) ecd5060

Miscellaneous Chores

  • deps-dev: bump conventional-changelog-conventionalcommits (#145) 82102be

v1.4.0

29 Apr 16:52
97c65ef
Compare
Choose a tag to compare

1.4.0 (2021-04-29)

Features

Miscellaneous Chores

  • deps: bump actions/cache from v2.1.4 to v2.1.5 (#142) 3cd4e86
  • deps-dev: bump @semantic-release/github from 7.2.0 to 7.2.1 (#141) ca1a1db

v1.3.3

25 Mar 16:46
f9a4b76
Compare
Choose a tag to compare

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

Code Refactoring

v1.3.2

17 Feb 13:06
6971041
Compare
Choose a tag to compare

1.3.2 (2021-02-17)

Bug Fixes

Miscellaneous Chores