2.3.0

• PR #148 adds support for recently added reporting endpoints that includes:
  • Conversations -> Volume by Channel Report
  • Email Report
  • Phone Report
  • Chat Report

2.2.5

• Thanks to @JPry for contributing PR #147 which resolves an issue with an invalid date format used when interacting with reports

2.2.4

• PR #145 resolves #143 - PHP and SDK versions are now included in the user agent when making api requests
• PR #144 resolves #142 - Sub-entities (address, websites, etc.) are now correctly created when creating new Customers

2.2.3

• PR #139 resolves #138 - Correct version of the 8601 timestamp format is now used. The SDK will now also gracefully handle UTC conversion when possible.

2.2.2

• PR #131 resolves #129 - Correct query parameter is now used when filtering Conversation by customerFieldIds
• PR #130 resolves #95 - Fixed several issues with a Conversation not being correctly hydrated with all data when using $webhook->getConversation()

2.2.1

• PR #127 - You can now use IncomingWebhook::makeFromGlobals($secret) to build an instance of IncomingWebhook without having to first build a PSR-7 compatible RequestInterface

2.2.0

• PR #122 resolves #121 - Adds support for validating inbound webhook requests, ensuring they're from HelpScout, as well as other convenience methods
• PR #123 - setAssignee() can now be used to specify the assignee when creating a conversation (previously could only use setAssignTo())
• PR #126 - updateTags() and updateCustomFields() now accept Collection and [Tags|CustomFields]Collection in addition to an array. This is a quality of life improvement, making it easier to update these fields for existing conversations.

In other news, the v2 branch is now the new master. You can still track changes to the v1 SDK via the v1 branch.

2.1.1

• PR #120 resolves #118 - All Customer attributes are now properly included when creating a Customer when creating a Thread or Conversation

2.1.0

• PR #110 resolves #108 - A User's first and last name is now properly hydrated when fetching a Conversation the user created
• PR #109 fulfills #98 by adding support for the Authorization Code Flow through $client->swapAuthorizationCodeForReusableTokens() enabling developers to quickly and easily exchange the code for a refresh and access token pair. A shout out goes to @scr4bble for pushing this work forward!
• PR #102 deprecates a Customer's Chat and replaces it with ChatHandle to better reflect what data is being provided and to get in sync with our updated API documentation. Relevant getter and setter methods have also been deprecated in favor of $customer->getChatHandles().
• PR #112 deprecates $client->useLegacyToken() and all relevant legacy credentials configuration. These will be fully removed on June 6, 2019 so you'll need to make sure you've upgraded your authentication to OAuth2. Here's an example of how to upgrade painlessly using the SDK:

Upgrading Legacy tokens to OAuth2

$authenticator = HelpScout\Api\ApiClientFactory::createClient()
    ->useLegacyToken($clientId, $apiKey)
    ->getAuthenticator();

$authenticator->convertLegacyToken():

var_dump($authenticator->getTokens()); // an array containing your new tokens

1.9.5

No changes in this tag. This release marks the point when v1 maintenance was moved off the master branch and into a separate branch.