Skip to content

3.0.0
Compare
Choose a tag to compare
@anthonyterrell anthonyterrell released this 07 Jan 19:42
· 118 commits to master since this release
3.0.0
e2eaa8c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

With this release we're targeting improving the developer experience to make the SDK easier to work with. There's no new API interaction being added.

  • [Breaking Change] PHP 7.1 has reached end of life and 7.2 is receiving security updates only, so v3 now requires PHP 7.3 (see #216). PHPDoc tags have been removed in favor of strongly typed parameters. Any classes that extend the SDK may require updating.
  • [Breaking Change] All filter method names have changed and will need to be updated (see PRs #224, #225 and #226). Filter object's method names were causing some confusion. The code snippet (new ConversationFilter())->withMailbox(40323) can give the impression that we're eager loading mailbox 40323 alongside the conversations, but it'll actually list the conversations in that mailbox. To make this more clear, we've eliminated the with*() verbiage for filters in favor of more specific verbiage like inMailbox(2), modifiedSince(Carbon::now()->subDay()) and hasTag('trial-customer').
    Refactored filter objects to use more clear terminology.
  • [Breaking Change] An HelpScout\Api\Exception\AuthenticationException is now thrown when the API responds with a 401. Previously this threw a GuzzleHttp\Exception\RequestException, so if you are catching that exception to refresh your token, you'll need to update your code base. (see #212)
  • [Breaking Change] HelpScout\Api\Customers\Entry\Chat has been removed completely in place of HelpScout\Api\Customers\Entry\ChatHandle. This was previously deprecated in v2. (see #229, #100, #102)
  • New isAssigned method has been added to HelpScout\Api\Conversations\Threads\Thread.php to help reduct additional logic when determining if a given Thread is assigned.(See #230)
Assets 2
Loading