Skip to content

Version 0.5: support for API v2

Latest
Latest
Compare
Choose a tag to compare
@tristanjahier tristanjahier released this 03 Sep 17:22
· 122 commits to master since this release
0.5.0
751e1a3

THIS IS A BREAKING CHANGE RELEASE.

Added

  • Support for version 2 of the API. Components specific to this version are under the Zoho\Crm\V2 namespace. Notably, the client class is Zoho\Crm\V2\Client.
    • The API support is divided into "sub-APIs", which are helpers that regroup multiple related features of the API. They are attached to the client and you can access them as public properties (e.g.: $client->theSubApi). Currently available sub-APIs are records and users. See README.md for further documentation.
    • The client needs an "access token store" object to handle its API access token persistency. There are multiple basic implementations available in namespace Zoho\Crm\V2\AccessTokenStores. It must implement StoreInterface.
  • Compatibility with Guzzle 7.
  • Compatibility with PHP 8.
  • Compatibility with Doctrine Inflector 2.
  • Zoho\Crm\Contracts\ErrorHandlerInterface.
  • createFromString static method to Zoho\Crm\Support\UrlParameters.
  • getRaw method to all queries (v1 and v2), to get the raw contents of the API response.
  • Zoho\Crm\V2\Scopes utility class.
  • Zoho\Crm\Utils\OAuthHelper utility class.
  • Zoho\Crm\PreferencesContainer base class for client preferences. It adds a new isSet method to check if a preference value is not null.

Changed

  • Composer package has been renamed tristanjahier/zoho-crm.
  • Everything specific to version 1 of the API has been moved under the dedicated Zoho\Crm\V1 namespace. Notably, the client class is now Zoho\Crm\V1\Client.
  • Dependency injection in Zoho\Crm\QueryProcessor is now mandatory. Arguments $requestSender and $responseParser are not optional anymore, and $errorHandler has been added.
  • Zoho\Crm\RequestSender constructor does not accept a $preferences argument anymore.
  • Denominations of "HTTP verb" have been changed for "HTTP method" everywhere in the code. Because of that, the getHttpVerb method of Zoho\Crm\Contracts\RequestableInterface has been renamed getHttpMethod, and the Zoho\Crm\Support\HttpVerb class has been renamed Zoho\Crm\Support\HttpMethod.
  • Method setHttpMethod of queries now throws an exception (Zoho\Crm\Exceptions\InvalidHttpMethodException) when an invalid value is provided.
  • Denominations of "URI" have been changed for "URL" everywhere in the code. More information below.
  • In RequestableInterface, method setUri has been removed. Other methods have been renamed: getUri => getUrl, setUriParameter => setUrlParameter. New methods have been added: getUrlParameters, getUrlParameter, hasUrlParameter, removeUrlParameter. Query implementations have been changed accordingly. Notably:
    • Multiple methods of Zoho\Crm\V1\Query have been renamed: setUriParameter => setUrlParameter, getParameters => getUrlParameters, getParameter => getUrlParameter, hasParameter => hasUrlParameter. resetParameters has also been renamed to resetUrlParameters for consistency.
  • In PaginatedQueryInterface, method paginated has been removed, method isPaginated has been renamed mustBePaginatedAutomatically, and 2 other methods were added: mustBePaginatedConcurrently and getConcurrency. Query implementations have been changed accordingly. Furthermore:
    • Method paginated, used to turn on and off the automatic pagination of queries, has been renamed autoPaginated.
    • Method mustFetchPagesAsynchronously, used to determine if pages must be fetched concurrently, has been renamed mustBePaginatedConcurrently.
  • In QueryInterface, method getClient was added.
  • Zoho\Crm\Support\UrlParameters now supports string-casting for all implementations of DateTimeInterface, instead of just instances of DateTime.
  • Zoho\Crm\Exceptions\InvalidQueryException now shows the HTTP method in its message.
  • Zoho\Crm\Support\Collection now implements Zoho\Crm\Support\Arrayable.

Fixed

  • Client ID, client secret and refresh token are now sent to the authorization endpoint in the request body instead of the URL query string. This is considered a fix because it improves security by reducing the risk of exposing these secrets in clear in error messages.

Deprecated

  • Installing from old Composer package name tristanjahier/zoho-crm-php.

Development

  • Upgraded dependencies:
    • phpunit/phpunit: 5 -> 9
    • symfony/var-dumper: 4 -> 5
Assets 2
Loading