1.9.4

This release adds a notice to the readme file that on April 1, 2019, we will be moving the work targeting Mailbox API v1 to a separate branch and merging the v2 branch into master. At that time, anyone referencing dev-master in their composer.json file needs to either specify the specific tagged version, if still using the v1 Mailbox API, or things will break.

2.0.4

PR #101 brought a few changes:

• CustomerRequest is deprecated. Recent updates to the Mailbox API v2 means customers()->get() and customers()->list() will always provide embedded entities. Any applications that still use this object to eager load will not experience any errors, but it isn't required and can be removed.
• HasOne relationships (e.g. Customer has one Address) are now properly hydrated (resolves #89)

2.0.3

• PR #92 will now return the Resource ID value (or null if none available) when creating a resource via the API. This closes Issue #88

2.0.2

• PR #87 removes validation on Attachment size, height and width values (also closes issue #86)

2.0.1

This release adds a few things

• PR #78 adds missing functionality to filter conversations by custom field ID value (also closes issue #77)
• PR #80 updates the Customer object to use email address when ID value is not available.
• PR #82 adds a bunch of convenience methods as well as updates setters to be fluent

1.9.3

This release contains changes from 2 pull requests:

• Fix Object names for To/CC/BCC as pulled from API (#83) - Thank you to @IanSimpson for submitting this fix. When creating a Thread (or any descendant) the AbstractThread base class was expect "toList", "ccList" and "bccList" items in the objects as pulled from the API. In practice, the "list" is just a construct within the API wrapper, and the fields in the API are called "to", "cc" and "bcc" respectively.
• Upgrade phpunit and fix tests (#68) - PHPUnit has been upgraded to use v6

2.0.0

The API client now uses the Mailbox API v2. This release is not backwards compatible with the v1.x releases.

2.0.0-beta

This is the first beta release of the official PHP client for the Help Scout Mailbox v2 API.

This is NOT backwards-compatible with the pre-2.0 versions. In fact, we started from the ground-up to make this client easier to use, test, mock, and troubleshoot.

Take a look at the README file for more information.

1.9.2

This version adds support for the Conversations: Received Messages endpoint in v1 of the Help Scout API. To use this endpoint,

<?php

use HelpScout\ApiClient;

$hs  = ApiClient::getInstance();
$key = 'your-api-key-goes-here';

$hs->setKey($key);

$dateFormat = 'Y-m-d\TH:i:s\Z';
$startDate  = date_create()->modify('-168 hours');
$mailbox    = 'mailbox-id-goes-here';

$allConvos = $hs->getConversationsReceivedMessagesReport([
    'start'     => date_format($startDate, $dateFormat),
    'end'       => date_format(date_create(), $dateFormat),
    'mailboxes' => $mailbox,
    'viewBy'    => 'day'
]);

1.9.1

This introduces support for new Beacon Chat conversation thread types.