Documentation and renamed adverts endpoint to search.

Author: olsgreen

src/Api/RetailMetrics.php

@@ -4,7 +4,7 @@
 
 use Olsgreen\AutoTrader\Api\Builders\SearchRequestBuilder;
 
-class Adverts extends AbstractApi
+class Search extends AbstractApi
 {
     /**
      * $request = (new SearchRequestBuilder())

src/Api/Adverts.php src/Api/Search.phpsrc/Api/Adverts.php renamed to src/Api/Search.php

@@ -4,13 +4,26 @@
 
 class Taxonomy extends AbstractApi
 {
+    /**
+     * Retrieve available vehicle types.
+     *
+     * @param string $advertiserId
+     * @return array
+     */
     public function types(string $advertiserId): array
     {
         return $this->_get('/service/stock-management/taxonomy/vehicleTypes', [
             'advertiserId' => $advertiserId
         ]);
     }
 
+    /**
+     * Retrieve a vehicles types available makes.
+     *
+     * @param string $advertiserId
+     * @param string $vehicleType
+     * @return array
+     */
     public function makes(string $advertiserId, string $vehicleType): array
     {
         return $this->_get(
@@ -19,6 +32,13 @@ public function makes(string $advertiserId, string $vehicleType): array
         );
     }
 
+    /**
+     * Retrieve a makes available models.
+     *
+     * @param string $advertiserId
+     * @param string $makeId
+     * @return array
+     */
     public function models(string $advertiserId, string $makeId): array
     {
         return $this->_get(
@@ -27,6 +47,13 @@ public function models(string $advertiserId, string $makeId): array
         );
     }
 
+    /**
+     * Retrieve a models available generations.
+     *
+     * @param string $advertiserId
+     * @param string $modelId
+     * @return array
+     */
     public function generations(string $advertiserId, string $modelId): array
     {
         return $this->_get(
@@ -35,6 +62,13 @@ public function generations(string $advertiserId, string $modelId): array
         );
     }
 
+    /**
+     * Retrieve a generations available derivatives.
+     *
+     * @param string $advertiserId
+     * @param string $generationId
+     * @return array
+     */
     public function derivatives(string $advertiserId, string $generationId): array
     {
         return $this->_get(
@@ -43,6 +77,13 @@ public function derivatives(string $advertiserId, string $generationId): array
         );
     }
 
+    /**
+     * Retrieve the technical data for a derivativeId.
+     *
+     * @param string $advertiserId
+     * @param string $derivativeId
+     * @return array
+     */
     public function technicalData(string $advertiserId, string $derivativeId): array
     {
         return $this->_get(
@@ -52,6 +93,14 @@ public function technicalData(string $advertiserId, string $derivativeId): array
         );
     }
 
+    /**
+     * Retrieve the features for a derivativeId.
+     *
+     * @param string $advertiserId
+     * @param string $derivativeId
+     * @param string $effectiveDate
+     * @return array
+     */
     public function features(string $advertiserId, string $derivativeId, string $effectiveDate): array
     {
         return $this->_get(
@@ -60,6 +109,14 @@ public function features(string $advertiserId, string $derivativeId, string $eff
         );
     }
 
+    /**
+     * Retrieve manufacturer pricing data for a derivativeId.
+     *
+     * @param string $advertiserId
+     * @param string $derivativeId
+     * @param string|null $effectiveDate
+     * @return array
+     */
     public function prices(string $advertiserId, string $derivativeId, string $effectiveDate = null)
     {
         $options = ['derivativeId' => $derivativeId, 'advertiserId' => $advertiserId];

src/Api/Taxonomy.php

@@ -6,7 +6,15 @@
 
 class Valuations extends AbstractApi
 {
-    /**     *
+
+    /**
+     * Retrieve a valuation.
+     *
+     * @param string $advertiserId
+     * @param ValuationRequestBuilder $builder
+     * @return array
+     *
+     * @example
      * $request = ValuationRequestBuilder::create();.
      *
      * $request->vehicle()

src/Api/Valuations.php

@@ -6,15 +6,22 @@
 
 class VehicleMetrics extends AbstractApi
 {
-    /**     *
-     * $request = MetricRequestBuilder::create();.
+    /**
+     * Lookup a vehicles metrics.
+     *
+     * @param string $advertiserId
+     * @param MetricRequestBuilder $builder
+     * @return array
+     *
+     * @example
+     * $request = MetricRequestBuilder::create();
      *
      * $request->vehicle()
      *  ->setDerivativeId('ABC123')
      *  ->setFirstRegisteredDate('2020-11-01')
      *  ->setOdometerReadingMiles(8000);
      *
-     * $valuation = $api->vehicleMmetrics()->retrieve($request)
+     * $valuation = $api->vehicleMetrics()->lookup(12345, $request)
      */
     public function lookup(string $advertiserId, MetricRequestBuilder $builder)
     {

src/Api/VehicleMetrics.php

@@ -2,9 +2,8 @@
 
 namespace Olsgreen\AutoTrader;
 
-use Olsgreen\AutoTrader\Api\Adverts;
+use Olsgreen\AutoTrader\Api\Search;
 use Olsgreen\AutoTrader\Api\Authentication;
-use Olsgreen\AutoTrader\Api\RetailMetrics;
 use Olsgreen\AutoTrader\Api\Stock;
 use Olsgreen\AutoTrader\Api\Taxonomy;
 use Olsgreen\AutoTrader\Api\Valuations;
@@ -16,9 +15,10 @@ class Client extends AbstractClient
     use ManagesHttpAccessTokens;
 
     /**
-     * Set this clients options from array.
+     * Set client options from array.
      *
      * @param array $options
+     * @return AbstractClient
      */
     protected function configureFromArray(array $options): AbstractClient
     {
@@ -37,43 +37,80 @@ protected function configureFromArray(array $options): AbstractClient
         return $this;
     }
 
-    public function adverts(): Adverts
-    {
-        return new Adverts($this);
-    }
-
+    /**
+     * Access Token Management.
+     *
+     * @see https://developers.autotrader.co.uk/api#authentication
+     * @return Authentication
+     */
     public function authentication(): Authentication
     {
         return new Authentication($this);
     }
 
+    /**
+     * Stock Endpoint.
+     *
+     * @see https://developers.autotrader.co.uk/api#stock-endpoint
+     * @return Stock
+     */
     public function stock(): Stock
     {
         return new Stock($this);
     }
 
+    /**
+     * Taxonomy Endpoint.
+     *
+     * @see https://developers.autotrader.co.uk/api#taxonomy-endpoint
+     * @return Taxonomy
+     */
     public function taxonomy(): Taxonomy
     {
         return new Taxonomy($this);
     }
 
+    /**
+     * Valuations Endpoint.
+     *
+     * @see https://developers.autotrader.co.uk/api#valuations-endpoint
+     * @return Valuations
+     */
     public function valuations(): Valuations
     {
         return new Valuations($this);
     }
 
+    /**
+     * Vehicles Endpoint
+     *
+     * @see https://developers.autotrader.co.uk/api#vehicles-endpoint
+     * @return Vehicles
+     */
     public function vehicles(): Vehicles
     {
         return new Vehicles($this);
     }
 
+    /**
+     * Vehicle Metrics Endpoint.
+     *
+     * @see https://developers.autotrader.co.uk/api#vehicle-metrics-endpoint
+     * @return VehicleMetrics
+     */
     public function vehicleMetrics(): VehicleMetrics
     {
         return new VehicleMetrics($this);
     }
 
-    public function retailMetrics(): RetailMetrics
+    /**
+     * Search Endpoint
+     *
+     * @see https://developers.autotrader.co.uk/api#search-endpoint
+     * @return Search
+     */
+    public function adverts(): Search
     {
-        return new RetailMetrics($this);
+        return new Search($this);
     }
 }