Add Customer Feedback API

Author: jlevers

README.md

@@ -251,6 +251,10 @@ $sellerConnector = SellingPartnerApi::seller(/* ... */);
     ```php
     $catalogItemsApi = $sellerConnector->catalogItemsV0();
     ```
+* **Customer Feedback API (v2024-06-01)** ([docs](https://developer-docs.amazon.com/sp-api/docs/customer-feedback-api-v2024-06-01-reference))
+    ```php
+    $customerFeedbackApi = $sellerConnector->customerFeedbackV20240601();
+    ```
 * **Data Kiosk API (v2023-11-15)** ([docs](https://developer-docs.amazon.com/sp-api/v0/docs/data-kiosk-api-v2023-11-15-reference))
     ```php
     $dataKioskApi = $sellerConnector->dataKioskV20231115();

resources/apis.json

@@ -53,6 +53,15 @@
                 }
             ]
         },
+        "customer-feedback": {
+            "name": "Customer Feedback",
+            "versions": [
+                {
+                    "version": "2024-06-01",
+                    "url": "https://raw.githubusercontent.com/amzn/selling-partner-api-models/refs/heads/main/models/customer-feedback-api-model/customerFeedback_2024-06-01.json"
+                }
+            ]
+        },
         "data-kiosk": {
             "name": "Data Kiosk",
             "versions": [

resources/models/raw/seller/customer-feedback/v2024-06-01.json

@@ -0,0 +1,95 @@
+<?php
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601;
+
+use Saloon\Http\Response;
+use SellingPartnerApi\BaseResource;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetBrowseNodeReturnTopics;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetBrowseNodeReturnTrends;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetBrowseNodeReviewTopics;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetBrowseNodeReviewTrends;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetItemBrowseNode;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetItemReviewTopics;
+use SellingPartnerApi\Seller\CustomerFeedbackV20240601\Requests\GetItemReviewTrends;
+
+class Api extends BaseResource
+{
+    /**
+     * @param  string  $asin  The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. The value must be a child ASIN.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     * @param  string  $sortBy  The metric by which to sort data in the response.
+     */
+    public function getItemReviewTopics(string $asin, string $marketplaceId, string $sortBy): Response
+    {
+        $request = new GetItemReviewTopics($asin, $marketplaceId, $sortBy);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $asin  The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     */
+    public function getItemBrowseNode(string $asin, string $marketplaceId): Response
+    {
+        $request = new GetItemBrowseNode($asin, $marketplaceId);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $browseNodeId  The ID of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     * @param  string  $sortBy  The metric by which to sort the data in the response.
+     */
+    public function getBrowseNodeReviewTopics(string $browseNodeId, string $marketplaceId, string $sortBy): Response
+    {
+        $request = new GetBrowseNodeReviewTopics($browseNodeId, $marketplaceId, $sortBy);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $asin  The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. This API takes child ASIN as an input.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     */
+    public function getItemReviewTrends(string $asin, string $marketplaceId): Response
+    {
+        $request = new GetItemReviewTrends($asin, $marketplaceId);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $browseNodeId  A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+     * @param  string  $marketplaceId  The marketplace ID is the globally unique identifier of a marketplace. For more information, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
+     */
+    public function getBrowseNodeReviewTrends(string $browseNodeId, string $marketplaceId): Response
+    {
+        $request = new GetBrowseNodeReviewTrends($browseNodeId, $marketplaceId);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $browseNodeId  A browse node ID is a unique identifier for a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     */
+    public function getBrowseNodeReturnTopics(string $browseNodeId, string $marketplaceId): Response
+    {
+        $request = new GetBrowseNodeReturnTopics($browseNodeId, $marketplaceId);
+
+        return $this->connector->send($request);
+    }
+
+    /**
+     * @param  string  $browseNodeId  A browse node ID is a unique identifier of a browse node. A browse node is a named location in a browse tree that is used for navigation, product classification, and website content.
+     * @param  string  $marketplaceId  The MarketplaceId is the globally unique identifier of a marketplace, you can refer to the marketplaceId here : https://developer-docs.amazon.com/sp-api/docs/marketplace-ids.
+     */
+    public function getBrowseNodeReturnTrends(string $browseNodeId, string $marketplaceId): Response
+    {
+        $request = new GetBrowseNodeReturnTrends($browseNodeId, $marketplaceId);
+
+        return $this->connector->send($request);
+    }
+}

resources/models/seller/customer-feedback/v2024-06-01.json

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class BrowseNodeAllOccurrence extends Dto
+{
+    /**
+     * @param  float  $topTwentyFivePercentProducts  The percentage of reviews of the top 25 percent of products in the browse node that mention the topic.
+     * @param  float  $allProducts  The percentage of reviews of products in the browse node that mention the topic.
+     */
+    public function __construct(
+        public float $topTwentyFivePercentProducts,
+        public float $allProducts,
+    ) {}
+}

src/Seller/CustomerFeedbackV20240601/Api.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class BrowseNodeAllStarRatingImpact extends Dto
+{
+    /**
+     * @param  float  $topTwentyFivePercentProducts  The effect of the topic on the star rating of the top 25 percent of products in the browse node. This value can be positive or negative.
+     * @param  float  $allProducts  The effect of the topic on the star rating of all products in the browse node. This value can be positive or negative.
+     */
+    public function __construct(
+        public float $topTwentyFivePercentProducts,
+        public float $allProducts,
+    ) {}
+}

src/Seller/CustomerFeedbackV20240601/Dto/BrowseNodeAllOccurrence.php

@@ -0,0 +1,23 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class BrowseNodeOccurrence extends Dto
+{
+    /**
+     * @param  float  $allProducts  The percentage of reviews of products in the browse node that mention a topic.
+     */
+    public function __construct(
+        public float $allProducts,
+    ) {}
+}

src/Seller/CustomerFeedbackV20240601/Dto/BrowseNodeAllStarRatingImpact.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class BrowseNodeReturnTopics extends Dto
+{
+    /**
+     * @param  string  $topic  The name of the return feedback topic .
+     * @param  BrowseNodeTrendMetrics  $browseNodeMetrics  A single browse node review or return trend metric.
+     */
+    public function __construct(
+        public string $topic,
+        public BrowseNodeTrendMetrics $browseNodeMetrics,
+    ) {}
+}

src/Seller/CustomerFeedbackV20240601/Dto/BrowseNodeOccurrence.php

@@ -0,0 +1,27 @@
+<?php
+
+/**
+ * This file is auto-generated by Saloon SDK Generator
+ * Generator: Crescat\SaloonSdkGenerator\Generators\DtoGenerator
+ * Do not modify it directly.
+ */
+
+declare(strict_types=1);
+
+namespace SellingPartnerApi\Seller\CustomerFeedbackV20240601\Dto;
+
+use SellingPartnerApi\Dto;
+
+final class BrowseNodeReturnTrend extends Dto
+{
+    protected static array $complexArrayTypes = ['trendMetrics' => BrowseNodeReturnTrendPoint::class];
+
+    /**
+     * @param  string  $topic  The name of the topic.
+     * @param  BrowseNodeReturnTrendPoint[]  $trendMetrics  The browse node return trend metrics.
+     */
+    public function __construct(
+        public string $topic,
+        public array $trendMetrics,
+    ) {}
+}