Version 3.0.0

Author: claudiosanches

README.md

@@ -33,42 +33,41 @@ $woocommerce = new Client(
     'ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 
     'cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
     [
-        'wp_api' => true,
         'version' => 'wc/v3',
     ]
 );
 ```
 
+## Client class
+
+```php
+$woocommerce = new Client($url, $consumer_key, $consumer_secret, $options)
+```
+
 ### Options
 
-|       Option      |   Type   | Required |                Description                 |
-| ----------------- | -------- | -------- | ------------------------------------------ |
+| Option            | Type     | Required | Description                                |
+|-------------------|----------|----------|--------------------------------------------|
 | `url`             | `string` | yes      | Your Store URL, example: http://woo.dev/   |
 | `consumer_key`    | `string` | yes      | Your API consumer key                      |
 | `consumer_secret` | `string` | yes      | Your API consumer secret                   |
 | `options`         | `array`  | no       | Extra arguments (see client options table) |
 
 #### Client options
 
-|        Option       |   Type   | Required |                                                      Description                                                       |
+| Option              | Type     | Required | Description                                                                                                            |
 |---------------------|----------|----------|------------------------------------------------------------------------------------------------------------------------|
-| `wp_api`            | `bool`   | no       | Allow make requests to the new WP REST API integration (WooCommerce 2.6 or later)                                      |
-| `wp_api_prefix`     | `string` | no       | Custom WP REST API URL prefix, used to support custom prefixes created with the `rest_url_prefix` filter               |
-| `version`           | `string` | no       | API version, default is `v3`                                                                                           |
+| `version`           | `string` | no       | API version, default is `wc/v3`                                                                                        |
 | `timeout`           | `int`    | no       | Request timeout, default is `15`                                                                                       |
-| `follow_redirects`  | `bool`   | no       | Allow the API call to follow redirects                                                                                 |
 | `verify_ssl`        | `bool`   | no       | Verify SSL when connect, use this option as `false` when need to test with self-signed certificates, default is `true` |
+| `follow_redirects`  | `bool`   | no       | Allow the API call to follow redirects                                                                                 |
 | `query_string_auth` | `bool`   | no       | Force Basic Authentication as query string when `true` and using under HTTPS, default is `false`                       |
 | `oauth_timestamp`   | `string` | no       | Custom oAuth timestamp, default is `time()`                                                                            |
 | `user_agent`        | `string` | no       | Custom user-agent, default is `WooCommerce API Client-PHP`                                                             |
+| `wp_api_prefix`     | `string` | no       | Custom WP REST API URL prefix, used to support custom prefixes created with the `rest_url_prefix` filter               |
+| `wp_api`            | `bool`   | no       | Set to `false` in order to use the legacy WooCommerce REST API (deprecated and not recommended)                        |
 
-## Methods
-
-|    Params    |   Type   |                         Description                          |
-| ------------ | -------- | ------------------------------------------------------------ |
-| `endpoint`   | `string` | WooCommerce API endpoint, example: `customers` or `order/12` |
-| `data`       | `array`  | Only for POST and PUT, data that will be converted to JSON   |
-| `parameters` | `array`  | Only for GET and DELETE, request query string                |
+## Client methods
 
 ### GET
 
@@ -100,18 +99,26 @@ $woocommerce->delete($endpoint, $parameters = [])
 $woocommerce->options($endpoint)
 ```
 
+#### Arguments
+
+| Params       | Type     | Description                                                  |
+|--------------|----------|--------------------------------------------------------------|
+| `endpoint`   | `string` | WooCommerce API endpoint, example: `customers` or `order/12` |
+| `data`       | `array`  | Only for POST and PUT, data that will be converted to JSON   |
+| `parameters` | `array`  | Only for GET and DELETE, request query string                |
+
 #### Response
 
 All methods will return arrays on success or throwing `HttpClientException` errors on failure.
 
-
 ```php
 use Automattic\WooCommerce\HttpClient\HttpClientException;
 
 try {
     // Array of response results.
     $results = $woocommerce->get('customers');
     // Example: ['customers' => [[ 'id' => 8, 'created_at' => '2015-05-06T17:43:51Z', 'email' => ...
+    echo '<pre><code>' . print_r( $results, true ) . '</code><pre>'; // JSON output.
 
     // Last request data.
     $lastRequest = $woocommerce->http->getRequest();
@@ -136,6 +143,7 @@ try {
 
 ## Release History
 
+- 2019-01-16 - 3.0.0 - Legacy API turned off by default, and improved JSON error handler.
 - 2018-03-29 - 2.0.1 - Fixed fatal errors on `lookForErrors`.
 - 2018-01-12 - 2.0.0 - Responses changes from arrays to `stdClass` objects. Added `follow_redirects` option.
 - 2017-06-06 - 1.3.0 - Remove BOM before decoding and added support for multi-dimensional arrays for oAuth1.0a.

src/WooCommerce/Client.php

@@ -21,7 +21,7 @@ class Client
     /**
      * WooCommerce REST API Client version.
      */
-    const VERSION = '2.0.1';
+    const VERSION = '3.0.0';
 
     /**
      * HttpClient instance.