Merge pull request #1 from rojtjo/upgrade-to-v10

Upgrade to v10
rojtjo · Dec 20, 2023 · 670bffe · 670bffe
2 parents bf7b567 + b217ccc
commit 670bffe
Show file tree

Hide file tree

Showing 13 changed files with 80 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/rojtjo/bol-api-client.svg?style=flat-square)](https://packagist.org/packages/rojtjo/bol-api-client)
 [![Tests](https://github.com/rojtjo/bol-api-client/actions/workflows/tests.yml/badge.svg)](https://github.com/rojtjo/bol-api-client/actions/workflows/tests.yml)
 
-Interact with the Bol.com API v9.
+Interact with the Bol.com API v10.
 
 ## Installation
 

diff --git a/src/Connectors/OfferConnector.php b/src/Connectors/OfferConnector.php
@@ -75,7 +75,7 @@ public function requestOfferExportFile(): ProcessStatus
     public function retrieveOfferExportFile(string $exportId): ExportOfferCollection
     {
         $data = $this->send('GET', "offers/export/$exportId", headers: [
-            'Accept' => 'application/vnd.retailer.v9+csv',
+            'Accept' => 'application/vnd.retailer.v10+csv',
         ]);
 
         return ExportOfferCollection::fromPayload($data);

diff --git a/src/Connectors/SubscriptionConnector.php b/src/Connectors/SubscriptionConnector.php
@@ -10,6 +10,7 @@
 use Rojtjo\Bol\Types\SignatureKeyCollection;
 use Rojtjo\Bol\Types\Subscription;
 use Rojtjo\Bol\Types\SubscriptionCollection;
+use Rojtjo\Bol\Types\SubscriptionType;
 
 final class SubscriptionConnector extends ConnectorAbstract
 {
@@ -39,21 +40,24 @@ public function findSubscription(string $subscriptionId): Subscription
         return Subscription::fromPayload($data);
     }
 
-    public function createSubscription(array $resources, string $url): ProcessStatus
+    public function createSubscription(array $resources, string $url, SubscriptionType $subscriptionType): ProcessStatus
     {
         $data = $this->send('POST', 'subscriptions', body: [
-            'resources' => $resources,
-            'url'       => $url,
+            'resources'        => $resources,
+            'url'              => $url,
+            'subscriptionType' => $subscriptionType->value,
         ]);
 
         return ProcessStatus::fromPayload($data);
     }
 
-    public function updateSubscription(string $subscriptionId, array $resources, string $url): ProcessStatus
+    public function updateSubscription(string $subscriptionId, array $resources, string $url, SubscriptionType $subscriptionType, bool $enabled): ProcessStatus
     {
         $data = $this->send('PUT', "subscriptions/$subscriptionId", body: [
-            'resources' => $resources,
-            'url'       => $url,
+            'resources'        => $resources,
+            'url'              => $url,
+            'subscriptionType' => $subscriptionType->value,
+            'enabled'          => $enabled
         ]);
 
         return ProcessStatus::fromPayload($data);

diff --git a/src/Types/Subscription.php b/src/Types/Subscription.php
@@ -10,6 +10,8 @@ public function __construct(
         public readonly string $id,
         public readonly array $resources,
         public readonly string $url,
+        public readonly SubscriptionType $subscriptionType,
+        public readonly bool $enabled,
     )
     {
     }
@@ -20,6 +22,8 @@ public static function fromPayload(array $subscription): self
             $subscription['id'],
             $subscription['resources'],
             $subscription['url'],
+            SubscriptionType::from($subscription['subscriptionType']),
+            $subscription['enabled'],
         );
     }
 }
diff --git a/src/Types/SubscriptionType.php b/src/Types/SubscriptionType.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rojtjo\Bol\Types;
+
+enum SubscriptionType: string
+{
+    case Webhook = 'WEBHOOK';
+
+    case GCPPubSub = 'GCP_PUBSUB';
+}
diff --git a/src/Util/RequestUtil.php b/src/Util/RequestUtil.php
@@ -8,7 +8,7 @@
 
 final class RequestUtil
 {
-    public const CONTENT_TYPE = 'application/vnd.retailer.v9+json';
+    public const CONTENT_TYPE = 'application/vnd.retailer.v10+json';
 
     public static function createRequest(string $method, string $uri, array $headers = [], array $query = [], mixed $body = null): Request
     {

diff --git a/src/Util/ResponseUtil.php b/src/Util/ResponseUtil.php
@@ -22,7 +22,7 @@ public static function assertOk(ResponseInterface $response): void
     public static function decodeBody(ResponseInterface $response): mixed
     {
         $contentType = $response->getHeaderLine('Content-Type');
-        if (str_contains($contentType, 'application/vnd.retailer.v9+json')) {
+        if (str_contains($contentType, 'application/vnd.retailer.v10+json')) {
             return self::decodeJson($response);
         }
 

diff --git a/tests/Integration/OffersTest.php b/tests/Integration/OffersTest.php
@@ -23,7 +23,7 @@ final class OffersTest extends IntegrationTestCase
 {
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_create_an_offer_export_csv_file
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_create_an_offer_export_csv_file
      */
     public function create_an_offer_export_csv_file(): void
     {
@@ -36,7 +36,7 @@ public function create_an_offer_export_csv_file(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_retrieve_an_offer_export_csv_file
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_retrieve_an_offer_export_csv_file
      */
     public function retrieve_an_offer_export_csv_file(): void
     {
@@ -49,7 +49,7 @@ public function retrieve_an_offer_export_csv_file(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_retrieve_an_offer
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_retrieve_an_offer
      */
     public function retrieve_an_offer(): void
     {
@@ -62,7 +62,7 @@ public function retrieve_an_offer(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
      */
     public function create_fbr_offer_for_ean_9780471117094_with_condition_new_with_vvb_proposition(): void
     {
@@ -98,7 +98,7 @@ public function create_fbr_offer_for_ean_9780471117094_with_condition_new_with_v
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_create_fbr_offer_for_ean_0045496420253_with_condition_moderate
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_create_fbr_offer_for_ean_0045496420253_with_condition_moderate
      */
     public
     function create_fbr_offer_for_ean_0045496420253_with_condition_moderate(): void
@@ -136,7 +136,7 @@ function create_fbr_offer_for_ean_0045496420253_with_condition_moderate(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_delete_an_already_existing_offer_that_is_known_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_delete_an_already_existing_offer_that_is_known_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
      */
     public
     function delete_an_already_existing_offer_that_is_known_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8(): void
@@ -150,7 +150,7 @@ function delete_an_already_existing_offer_that_is_known_with_offerid_13722de8_81
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_update_the_price_for_a_specific_offer
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_update_the_price_for_a_specific_offer
      */
     public
     function update_the_price_for_a_specific_offer(): void
@@ -174,7 +174,7 @@ function update_the_price_for_a_specific_offer(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_update_the_current_stock_level_for_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_update_the_current_stock_level_for_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
      */
     public
     function update_the_current_stock_level_for_offerid_13722de8_8182_d161_5422_4a0a1caab5c8(): void
@@ -190,7 +190,7 @@ function update_the_current_stock_level_for_offerid_13722de8_8182_d161_5422_4a0a
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8
      */
     public
     function update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8(): void
@@ -214,7 +214,7 @@ function update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_542
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8_2
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-OFFERS.html#_update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8_2
      */
     public
     function update_of_an_already_existing_offer_with_offerid_13722de8_8182_d161_5422_4a0a1caab5c8_2(): void

diff --git a/tests/Integration/OrdersTest.php b/tests/Integration/OrdersTest.php
@@ -11,7 +11,7 @@ final class OrdersTest extends IntegrationTestCase
 {
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbb_order_with_order_id_1042823870
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbb_order_with_order_id_1042823870
      */
     public function get_single_fbb_order_with_order_id_1042823870(): void
     {
@@ -24,7 +24,7 @@ public function get_single_fbb_order_with_order_id_1042823870(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbr_order_with_order_id_1042831430
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbr_order_with_order_id_1042831430
      */
     public function get_single_fbr_order_with_order_id_1042831430(): void
     {
@@ -37,7 +37,7 @@ public function get_single_fbr_order_with_order_id_1042831430(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbr_order_with_order_id_1042831430
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbr_order_with_order_id_1042831430
      */
     public function get_single_fbb_order_with_order_id_1043965710(): void
     {
@@ -50,7 +50,7 @@ public function get_single_fbb_order_with_order_id_1043965710(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbr_order_with_order_id_a4k8290lp0
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbr_order_with_order_id_a4k8290lp0
      */
     public function get_single_fbr_order_with_order_id_a4k8290lp0(): void
     {
@@ -63,7 +63,7 @@ public function get_single_fbr_order_with_order_id_a4k8290lp0(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbr_order_with_order_id_1043946570
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbr_order_with_order_id_1043946570
      */
     public function get_single_fbr_order_with_order_id_1043946570(): void
     {
@@ -76,7 +76,7 @@ public function get_single_fbr_order_with_order_id_1043946570(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_single_fbr_order_with_order_id_b3k8290lp0
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_single_fbr_order_with_order_id_b3k8290lp0
      */
     public function get_single_fbr_order_with_order_id_b3k8290lp0(): void
     {
@@ -89,7 +89,7 @@ public function get_single_fbr_order_with_order_id_b3k8290lp0(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_fbb_orders_with_status_all
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_fbb_orders_with_status_all
      */
     public function get_fbb_orders_with_status_all(): void
     {
@@ -102,7 +102,7 @@ public function get_fbb_orders_with_status_all(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_fbb_orders_with_status_open
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_fbb_orders_with_status_open
      */
     public function get_fbb_orders_with_status_open(): void
     {
@@ -115,7 +115,7 @@ public function get_fbb_orders_with_status_open(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_fbr_orders_with_status_all
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_fbr_orders_with_status_all
      */
     public function get_fbr_orders_with_status_all(): void
     {
@@ -128,7 +128,7 @@ public function get_fbr_orders_with_status_all(): void
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-ORDERS.html#_get_fbr_orders_with_status_open
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-ORDERS.html#_get_fbr_orders_with_status_open
      */
     public function get_fbr_orders_with_status_open(): void
     {

diff --git a/tests/Integration/ProcessStatusesTest.php b/tests/Integration/ProcessStatusesTest.php
@@ -8,7 +8,7 @@ final class ProcessStatusesTest extends IntegrationTestCase
 {
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-PROCESS_STATUS.html#_generate_a_process_status_pending_using_entity_id_and_event_type
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-PROCESS_STATUS.html#_generate_a_process_status_pending_using_entity_id_and_event_type
      */
     public function generate_a_process_status_pending_using_entity_id_and_event_type(): void
     {
@@ -21,7 +21,7 @@ public function generate_a_process_status_pending_using_entity_id_and_event_type
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-PROCESS_STATUS.html#_generate_a_process_status_failure_using_entity_id_and_event_type
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-PROCESS_STATUS.html#_generate_a_process_status_failure_using_entity_id_and_event_type
      */
     public function generate_a_process_status_failure_using_entity_id_and_event_type(): void
     {
@@ -34,7 +34,7 @@ public function generate_a_process_status_failure_using_entity_id_and_event_type
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-PROCESS_STATUS.html#_generate_a_process_status_timeout_using_entity_id_and_event_type
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-PROCESS_STATUS.html#_generate_a_process_status_timeout_using_entity_id_and_event_type
      */
     public function generate_a_process_status_timeout_using_entity_id_and_event_type(): void
     {
@@ -47,7 +47,7 @@ public function generate_a_process_status_timeout_using_entity_id_and_event_type
 
     /**
      * @test
-     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v9-PROCESS_STATUS.html#_generate_a_process_status_success_using_entity_id_and_event_type
+     * @see https://api.bol.com/retailer/public/Retailer-API/demo/v10-PROCESS_STATUS.html#_generate_a_process_status_success_using_entity_id_and_event_type
      */
     public function generate_a_process_status_success_using_entity_id_and_event_type(): void
     {