Add readable endpoint to fetch a resource by ID

src/Client/Client.php

@@ -57,6 +57,8 @@
 
     private ?MapperBuilder $mapperBuilder = null;
 
+    private bool $debug = false;
+
     public function __construct(private readonly string $username, private readonly string $apiKey)
     {
         $this->logger = new NullLogger();
@@ -79,14 +81,14 @@
             sprintf('Basic %s', base64_encode($this->username . ':' . $this->apiKey)),
         )->withHeader('Accept', 'application/json');
 
         if (in_array($request->getMethod(), ['POST', 'PUT', 'PATCH'])) {
             $request = $request->withHeader('Content-Type', 'application/json');
         }
 
         $this->lastRequest = $request;
         $this->lastResponse = $this->getHttpClient()->sendRequest($this->lastRequest);
 
         self::assertStatusCode($this->lastResponse);
 
         return $this->lastResponse;
     }
@@ -135,7 +137,7 @@
     {
         if (null === $this->paymentGatewaysEndpoint) {
             $this->paymentGatewaysEndpoint = new PaymentGatewaysEndpoint($this, $this->getMapperBuilder(), 'payment_gateways');
             $this->paymentGatewaysEndpoint->setLogger($this->logger);
         }
 
         return $this->paymentGatewaysEndpoint;
@@ -165,7 +167,7 @@
     {
         if (null === $this->shipmentTemplatesEndpoint) {
             $this->shipmentTemplatesEndpoint = new ShipmentTemplatesEndpoint($this, $this->getMapperBuilder(), 'shipment_templates');
             $this->shipmentTemplatesEndpoint->setLogger($this->logger);
         }
 
         return $this->shipmentTemplatesEndpoint;
@@ -175,7 +177,7 @@
     {
         if (null === $this->webhooksEndpoint) {
             $this->webhooksEndpoint = new WebhooksEndpoint($this, $this->getMapperBuilder(), 'webhooks');
             $this->webhooksEndpoint->setLogger($this->logger);
         }
 
         return $this->webhooksEndpoint;
@@ -212,9 +214,17 @@
         $this->logger = $logger;
     }
 
+    public function setDebug(bool $debug): void
+    {
+        $this->debug = $debug;
+    }
+
     private function getBaseUri(): string
     {
-        return 'https://app.shipmondo.com/api/public/v3';
+        return sprintf(
+            'https://%s.shipmondo.com/api/public/v3',
+            $this->debug ? 'sandbox' : 'app',
+        );
     }
 
     private function getHttpClient(): HttpClientInterface
@@ -248,7 +258,7 @@
     {
         $statusCode = $response->getStatusCode();
 
         if ($statusCode >= 200 && $statusCode < 300) {
             return;
         }
 

src/Client/Endpoint/Endpoint.php

@@ -19,7 +19,6 @@
 
 /**
  * @template TResponse of Response
- *
  * @implements EndpointInterface<TResponse>
  */
 abstract class Endpoint implements EndpointInterface, LoggerAwareInterface

src/Client/Endpoint/ReadableEndpointInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\Shipmondo\Client\Endpoint;
+
+use Setono\Shipmondo\Response\Response;
+
+/**
+ * @template TResponse of Response
+ */
+interface ReadableEndpointInterface
+{
+    /**
+     * @return TResponse
+     */
+    public function getById(int $id): Response;
+}

src/Client/Endpoint/ReadableEndpointTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\Shipmondo\Client\Endpoint;
+
+use Setono\Shipmondo\Response\Response;
+
+/**
+ * @mixin Endpoint
+ *
+ * @template TResponse of Response
+ */
+trait ReadableEndpointTrait
+{
+    /**
+     * @return TResponse
+     */
+    public function getById(int $id): Response
+    {
+        return $this
+            ->mapperBuilder
+            ->mapper()
+            ->map(
+                self::getResponseClass(),
+                $this->createSource(
+                    $this->client->get(sprintf('%s/%d', $this->endpoint, $id)),
+                ),
+            );
+    }
+}

src/Client/Endpoint/SalesOrdersEndpoint.php

@@ -16,6 +16,11 @@ final class SalesOrdersEndpoint extends Endpoint implements SalesOrdersEndpointI
      */
     use CreatableEndpointTrait;
 
+    /**
+     * @use ReadableEndpointTrait<SalesOrderResponse>
+     */
+    use ReadableEndpointTrait;
+
     protected static function getResponseClass(): string
     {
         return SalesOrderResponse::class;

src/Client/Endpoint/SalesOrdersEndpointInterface.php

@@ -9,7 +9,8 @@
 /**
  * @extends EndpointInterface<SalesOrderResponse>
  * @extends CreatableEndpointInterface<SalesOrderResponse>
+ * @extends ReadableEndpointInterface<SalesOrderResponse>
  */
-interface SalesOrdersEndpointInterface extends EndpointInterface, CreatableEndpointInterface
+interface SalesOrdersEndpointInterface extends EndpointInterface, CreatableEndpointInterface, ReadableEndpointInterface
 {
 }

src/Response/Collection.php

@@ -6,7 +6,6 @@
 
 /**
  * @template T
- *
  * @implements \IteratorAggregate<int, T>
  */
 final class Collection implements \Countable, \IteratorAggregate