helpscout / helpscout-api-php

PHP Wrapper for the Help Scout API
MIT License
99 stars 62 forks source link

Update README.md #210

Closed jonathanbull closed 4 years ago

jonathanbull commented 4 years ago

It looks like the documentation is incorrect/outdated. When running $customer->addEmail('my-customer@company.com'); on v2.0.0, I get the error:

Argument 1 passed to HelpScout\Api\Customers\Customer::addEmail() must be an instance of HelpScout\Api\Customers\Entry\Email, string given

This PR updates the documentation to pass addEmail an Email object.

bkuhl commented 4 years ago

Hey Jonathan,

$customer->addEmail() began accepting a string in https://github.com/helpscout/helpscout-api-php/releases/tag/2.3.4. If you're on v2.0.0, you'll want to check out the README/examples on https://github.com/helpscout/helpscout-api-php/tree/a86f1bc078dcfdd2230a70b46491fad423ce9076 to ensure you're looking at docs compatible with your version.

I'll close this out since we support this in the latest versions.

jonathanbull commented 4 years ago

Oops! Thanks @bkuhl.