diff --git a/Generator/Generator.csproj b/Generator/Generator.csproj index 3103c82..e12960d 100644 --- a/Generator/Generator.csproj +++ b/Generator/Generator.csproj @@ -9,7 +9,7 @@ - + diff --git a/Generator/Generator.sln.DotSettings b/Generator/Generator.sln.DotSettings new file mode 100644 index 0000000..f7bddd5 --- /dev/null +++ b/Generator/Generator.sln.DotSettings @@ -0,0 +1,2 @@ + + True \ No newline at end of file diff --git a/Generator/Program.cs b/Generator/Program.cs index a4df274..45da03d 100644 --- a/Generator/Program.cs +++ b/Generator/Program.cs @@ -38,11 +38,11 @@ var phpClientWriter = new PhpClientWriter(phpWriter); -phpClientWriter.GenerateClientClass(typeof(Tracker), new[] { "Track" }); -phpClientWriter.GenerateClientClass(typeof(Searcher), new[] { "Search", "Predict", "Batch" }); -phpClientWriter.GenerateClientClass(typeof(Recommender), new[] { "Recommend" }); -phpClientWriter.GenerateClientClass(typeof(SearchAdministrator), new[] { "Delete", "Save", "Load" }); -phpClientWriter.GenerateClientClass(typeof(Analyzer), new[] { "Analyze" }); +phpClientWriter.GenerateClientClass(typeof(Tracker), ["Track"]); +phpClientWriter.GenerateClientClass(typeof(Searcher), ["Search", "Predict", "Batch"]); +phpClientWriter.GenerateClientClass(typeof(Recommender), ["Recommend"]); +phpClientWriter.GenerateClientClass(typeof(SearchAdministrator), ["Delete", "Save", "Load"]); +phpClientWriter.GenerateClientClass(typeof(Analyzer), ["Analyze"]); if (phpWriter.MissingTypeDefinitions.Count > 0) { diff --git a/src/Models/CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics.php b/src/Models/CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics.php index fa708ba..6cc41a8 100644 --- a/src/Models/CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics.php +++ b/src/Models/CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics.php @@ -9,14 +9,14 @@ class CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics implements JsonSerializab { public string $typeDefinition = "Relewise.Client.DataTypes.RetailMedia.CampaignAnalytics+DisplayAdAnalytics+PeriodMetrics, Relewise.Client"; public DateTime $periodFromUtc; - public int $views; + public int $promotions; public int $clicks; - public static function create(DateTime $periodFromUtc, int $views, int $clicks) : CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics + public static function create(DateTime $periodFromUtc, int $promotions, int $clicks) : CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics { $result = new CampaignAnalyticsDisplayAdAnalyticsPeriodMetrics(); $result->periodFromUtc = $periodFromUtc; - $result->views = $views; + $result->promotions = $promotions; $result->clicks = $clicks; return $result; } @@ -28,9 +28,9 @@ public static function hydrate(array $arr) : CampaignAnalyticsDisplayAdAnalytics { $result->periodFromUtc = new DateTime($arr["periodFromUtc"]); } - if (array_key_exists("views", $arr)) + if (array_key_exists("promotions", $arr)) { - $result->views = $arr["views"]; + $result->promotions = $arr["promotions"]; } if (array_key_exists("clicks", $arr)) { @@ -45,9 +45,9 @@ function setPeriodFromUtc(DateTime $periodFromUtc) return $this; } - function setViews(int $views) + function setPromotions(int $promotions) { - $this->views = $views; + $this->promotions = $promotions; return $this; } @@ -65,9 +65,9 @@ public function jsonSerialize(): mixed { $result["periodFromUtc"] = $this->periodFromUtc->format(DATE_ATOM); } - if (isset($this->views)) + if (isset($this->promotions)) { - $result["views"] = $this->views; + $result["promotions"] = $this->promotions; } if (isset($this->clicks)) { diff --git a/src/Models/CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics.php b/src/Models/CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics.php index 570d430..c2e0631 100644 --- a/src/Models/CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics.php +++ b/src/Models/CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics.php @@ -9,6 +9,7 @@ class CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics public int $promotions; public int $lastClickedUnixMinutes; public int $numberOfTimesClicked; + public DisplayAdResult $displayAd; public static function create(string $displayAdId, int $promotions, int $lastClickedUnixMinutes, int $numberOfTimesClicked) : CampaignAnalyticsDisplayAdAnalyticsPromotedDisplayAdMetrics { @@ -39,6 +40,10 @@ public static function hydrate(array $arr) : CampaignAnalyticsDisplayAdAnalytics { $result->numberOfTimesClicked = $arr["numberOfTimesClicked"]; } + if (array_key_exists("displayAd", $arr)) + { + $result->displayAd = DisplayAdResult::hydrate($arr["displayAd"]); + } return $result; } @@ -65,4 +70,10 @@ function setNumberOfTimesClicked(int $numberOfTimesClicked) $this->numberOfTimesClicked = $numberOfTimesClicked; return $this; } + + function setDisplayAd(DisplayAdResult $displayAd) + { + $this->displayAd = $displayAd; + return $this; + } } diff --git a/src/Models/CampaignAnalyticsProductAnalyticsPeriodMetrics.php b/src/Models/CampaignAnalyticsProductAnalyticsPeriodMetrics.php index dc60904..8681fc3 100644 --- a/src/Models/CampaignAnalyticsProductAnalyticsPeriodMetrics.php +++ b/src/Models/CampaignAnalyticsProductAnalyticsPeriodMetrics.php @@ -12,14 +12,16 @@ class CampaignAnalyticsProductAnalyticsPeriodMetrics implements JsonSerializable public int $views; public int $salesQuantity; public array $currencies; + public int $promotions; - public static function create(DateTime $periodFromUtc, int $views, int $salesQuantity, CampaignAnalyticsProductAnalyticsPeriodMetricsCurrencyMetrics ... $currencies) : CampaignAnalyticsProductAnalyticsPeriodMetrics + public static function create(DateTime $periodFromUtc, int $views, int $salesQuantity, array $currencies, int $promotions) : CampaignAnalyticsProductAnalyticsPeriodMetrics { $result = new CampaignAnalyticsProductAnalyticsPeriodMetrics(); $result->periodFromUtc = $periodFromUtc; $result->views = $views; $result->salesQuantity = $salesQuantity; $result->currencies = $currencies; + $result->promotions = $promotions; return $result; } @@ -46,6 +48,10 @@ public static function hydrate(array $arr) : CampaignAnalyticsProductAnalyticsPe array_push($result->currencies, CampaignAnalyticsProductAnalyticsPeriodMetricsCurrencyMetrics::hydrate($value)); } } + if (array_key_exists("promotions", $arr)) + { + $result->promotions = $arr["promotions"]; + } return $result; } @@ -90,6 +96,12 @@ function addToCurrencies(CampaignAnalyticsProductAnalyticsPeriodMetricsCurrencyM return $this; } + function setPromotions(int $promotions) + { + $this->promotions = $promotions; + return $this; + } + public function jsonSerialize(): mixed { $result = array(); @@ -110,6 +122,10 @@ public function jsonSerialize(): mixed { $result["currencies"] = $this->currencies; } + if (isset($this->promotions)) + { + $result["promotions"] = $this->promotions; + } return $result; } } diff --git a/src/Models/CampaignAnalyticsProductAnalyticsPromotedProductMetrics.php b/src/Models/CampaignAnalyticsProductAnalyticsPromotedProductMetrics.php index 208a5a2..c638952 100644 --- a/src/Models/CampaignAnalyticsProductAnalyticsPromotedProductMetrics.php +++ b/src/Models/CampaignAnalyticsProductAnalyticsPromotedProductMetrics.php @@ -7,6 +7,7 @@ class CampaignAnalyticsProductAnalyticsPromotedProductMetrics public string $typeDefinition = "Relewise.Client.DataTypes.RetailMedia.CampaignAnalytics+ProductAnalytics+PromotedProductMetrics, Relewise.Client"; public string $productId; public int $promotions; + public ProductResult $product; public static function create(string $productId, int $promotions) : CampaignAnalyticsProductAnalyticsPromotedProductMetrics { @@ -27,6 +28,10 @@ public static function hydrate(array $arr) : CampaignAnalyticsProductAnalyticsPr { $result->promotions = $arr["promotions"]; } + if (array_key_exists("product", $arr)) + { + $result->product = ProductResult::hydrate($arr["product"]); + } return $result; } @@ -41,4 +46,10 @@ function setPromotions(int $promotions) $this->promotions = $promotions; return $this; } + + function setProduct(ProductResult $product) + { + $this->product = $product; + return $this; + } } diff --git a/src/Models/CampaignAnalyticsRequest.php b/src/Models/CampaignAnalyticsRequest.php index fe6abad..23b7e44 100644 --- a/src/Models/CampaignAnalyticsRequest.php +++ b/src/Models/CampaignAnalyticsRequest.php @@ -11,6 +11,10 @@ class CampaignAnalyticsRequest extends LicensedRequest public DateTimeRange $periodUtc; public ?FilterCollection $productFilters; public ?FilterCollection $displayAdFilters; + public ?Language $language; + public ?Currency $currency; + public ?SelectedProductPropertiesSettings $selectedProductProperties; + public ?SelectedDisplayAdPropertiesSettings $selectedDisplayAdProperties; public static function create(string $id, DateTimeRange $periodUtc, ?FilterCollection $productFilters, ?FilterCollection $displayAdFilters) : CampaignAnalyticsRequest { @@ -41,6 +45,22 @@ public static function hydrate(array $arr) : CampaignAnalyticsRequest { $result->displayAdFilters = FilterCollection::hydrate($arr["displayAdFilters"]); } + if (array_key_exists("language", $arr)) + { + $result->language = Language::hydrate($arr["language"]); + } + if (array_key_exists("currency", $arr)) + { + $result->currency = Currency::hydrate($arr["currency"]); + } + if (array_key_exists("selectedProductProperties", $arr)) + { + $result->selectedProductProperties = SelectedProductPropertiesSettings::hydrate($arr["selectedProductProperties"]); + } + if (array_key_exists("selectedDisplayAdProperties", $arr)) + { + $result->selectedDisplayAdProperties = SelectedDisplayAdPropertiesSettings::hydrate($arr["selectedDisplayAdProperties"]); + } return $result; } @@ -68,4 +88,28 @@ function setDisplayAdFilters(?FilterCollection $displayAdFilters) $this->displayAdFilters = $displayAdFilters; return $this; } + + function setLanguage(?Language $language) + { + $this->language = $language; + return $this; + } + + function setCurrency(?Currency $currency) + { + $this->currency = $currency; + return $this; + } + + function setSelectedProductProperties(?SelectedProductPropertiesSettings $selectedProductProperties) + { + $this->selectedProductProperties = $selectedProductProperties; + return $this; + } + + function setSelectedDisplayAdProperties(?SelectedDisplayAdPropertiesSettings $selectedDisplayAdProperties) + { + $this->selectedDisplayAdProperties = $selectedDisplayAdProperties; + return $this; + } } diff --git a/src/Models/CategoryIndexConfiguration.php b/src/Models/CategoryIndexConfiguration.php index 17f17ba..6c3608b 100644 --- a/src/Models/CategoryIndexConfiguration.php +++ b/src/Models/CategoryIndexConfiguration.php @@ -4,7 +4,10 @@ class CategoryIndexConfiguration { + /** Default configuration entry used when no specific category scope is specified. This serves as the fallback configuration for category indexing operations. */ public CategoryIndexConfigurationEntry $unspecified; + /** Scope-specific configuration entries mapped by CategoryScope enum values. Allows different indexing configurations for different category relationship scopes (e.g., ImmediateParent, ImmediateParentOrItsParent, Ancestor). When null, only the Unspecified configuration will be used. */ + public ?array $byScope; public static function create() : CategoryIndexConfiguration { @@ -19,12 +22,42 @@ public static function hydrate(array $arr) : CategoryIndexConfiguration { $result->unspecified = CategoryIndexConfigurationEntry::hydrate($arr["unspecified"]); } + if (array_key_exists("byScope", $arr)) + { + $result->byScope = array(); + foreach($arr["byScope"] as $key => $value) + { + $result->byScope[CategoryScope::from($key)] = CategoryIndexConfigurationEntry::hydrate($value); + } + } return $result; } + /** Default configuration entry used when no specific category scope is specified. This serves as the fallback configuration for category indexing operations. */ function setUnspecified(CategoryIndexConfigurationEntry $unspecified) { $this->unspecified = $unspecified; return $this; } + + /** Scope-specific configuration entries mapped by CategoryScope enum values. Allows different indexing configurations for different category relationship scopes (e.g., ImmediateParent, ImmediateParentOrItsParent, Ancestor). When null, only the Unspecified configuration will be used. */ + function addToByScope(CategoryScope $key, CategoryIndexConfigurationEntry $value) + { + if (!isset($this->byScope)) + { + $this->byScope = array(); + } + $this->byScope[$key] = $value; + return $this; + } + + /** + * Scope-specific configuration entries mapped by CategoryScope enum values. Allows different indexing configurations for different category relationship scopes (e.g., ImmediateParent, ImmediateParentOrItsParent, Ancestor). When null, only the Unspecified configuration will be used. + * @param ?array $byScope associative array. + */ + function setByScopeFromAssociativeArray(array $byScope) + { + $this->byScope = $byScope; + return $this; + } } diff --git a/src/Models/Location.php b/src/Models/Location.php index 4dd40be..42ced1b 100644 --- a/src/Models/Location.php +++ b/src/Models/Location.php @@ -12,8 +12,6 @@ class Location extends LocationEntityStatestringLocationMetadataValuesRetailMedi public ?string $key; /** The placements where promotions may be displayed at this location If null or empty, no promotions will be shown at this location */ public ?LocationPlacementCollection $placements; - /** Defines what kinds of promotions are supported by this location */ - public ?PromotionSpecificationCollection $supportedPromotions; public static function create(?string $id, LocationEntityState $state, string $name) : Location { @@ -39,10 +37,6 @@ public static function hydrate(array $arr) : Location { $result->placements = LocationPlacementCollection::hydrate($arr["placements"]); } - if (array_key_exists("supportedPromotions", $arr)) - { - $result->supportedPromotions = PromotionSpecificationCollection::hydrate($arr["supportedPromotions"]); - } return $result; } @@ -67,13 +61,6 @@ function setPlacements(?LocationPlacementCollection $placements) return $this; } - /** Defines what kinds of promotions are supported by this location */ - function setSupportedPromotions(?PromotionSpecificationCollection $supportedPromotions) - { - $this->supportedPromotions = $supportedPromotions; - return $this; - } - function setState(LocationEntityState $state) { $this->state = $state; diff --git a/src/Models/ProductCategoryIndexConfiguration.php b/src/Models/ProductCategoryIndexConfiguration.php index 90acec2..322d3cf 100644 --- a/src/Models/ProductCategoryIndexConfiguration.php +++ b/src/Models/ProductCategoryIndexConfiguration.php @@ -18,6 +18,14 @@ public static function hydrate(array $arr) : ProductCategoryIndexConfiguration { $result->unspecified = CategoryIndexConfigurationEntry::hydrate($arr["unspecified"]); } + if (array_key_exists("byScope", $arr)) + { + $result->byScope = array(); + foreach($arr["byScope"] as $key => $value) + { + $result->byScope[CategoryScope::from($key)] = CategoryIndexConfigurationEntry::hydrate($value); + } + } return $result; } @@ -26,4 +34,21 @@ function setUnspecified(CategoryIndexConfigurationEntry $unspecified) $this->unspecified = $unspecified; return $this; } + + function addToByScope(CategoryScope $key, CategoryIndexConfigurationEntry $value) + { + if (!isset($this->byScope)) + { + $this->byScope = array(); + } + $this->byScope[$key] = $value; + return $this; + } + + /** @param ?array $byScope associative array. */ + function setByScopeFromAssociativeArray(array $byScope) + { + $this->byScope = $byScope; + return $this; + } } diff --git a/src/Models/PromotionSpecification.php b/src/Models/PromotionSpecification.php index 23792e5..48af698 100644 --- a/src/Models/PromotionSpecification.php +++ b/src/Models/PromotionSpecification.php @@ -9,10 +9,6 @@ abstract class PromotionSpecification public static function hydrate(array $arr) { $type = $arr["\$type"]; - if ($type=="Relewise.Client.DataTypes.RetailMedia.DisplayAdPromotion+Specification, Relewise.Client") - { - return DisplayAdPromotionSpecification::hydrate($arr); - } if ($type=="Relewise.Client.DataTypes.RetailMedia.ProductPromotion+Specification, Relewise.Client") { return ProductPromotionSpecification::hydrate($arr); diff --git a/src/Models/PromotionSpecificationCollection.php b/src/Models/PromotionSpecificationCollection.php index f243f3e..cb91e59 100644 --- a/src/Models/PromotionSpecificationCollection.php +++ b/src/Models/PromotionSpecificationCollection.php @@ -5,7 +5,6 @@ class PromotionSpecificationCollection { public ?ProductPromotionSpecification $productPromotion; - public ?DisplayAdPromotionSpecification $displayAdPromotion; public static function create() : PromotionSpecificationCollection { @@ -20,10 +19,6 @@ public static function hydrate(array $arr) : PromotionSpecificationCollection { $result->productPromotion = ProductPromotionSpecification::hydrate($arr["productPromotion"]); } - if (array_key_exists("displayAdPromotion", $arr)) - { - $result->displayAdPromotion = DisplayAdPromotionSpecification::hydrate($arr["displayAdPromotion"]); - } return $result; } @@ -32,10 +27,4 @@ function setProductPromotion(?ProductPromotionSpecification $productPromotion) $this->productPromotion = $productPromotion; return $this; } - - function setDisplayAdPromotion(?DisplayAdPromotionSpecification $displayAdPromotion) - { - $this->displayAdPromotion = $displayAdPromotion; - return $this; - } } diff --git a/src/Models/RequestContextFilter.php b/src/Models/RequestContextFilter.php index 3e6a9b8..49245d1 100644 --- a/src/Models/RequestContextFilter.php +++ b/src/Models/RequestContextFilter.php @@ -10,7 +10,9 @@ class RequestContextFilter public array $languages; public array $currencies; public RequestFilterCriteria $filters; + /** @deprecated Use SearchTermCriteria instead */ public ?SearchTermConditionByLanguageCollection $searchTerms; + public ?SearchTermCriteria $searchTermCriteria; public static function create() : RequestContextFilter { @@ -61,6 +63,10 @@ public static function hydrate(array $arr) : RequestContextFilter { $result->searchTerms = SearchTermConditionByLanguageCollection::hydrate($arr["searchTerms"]); } + if (array_key_exists("searchTermCriteria", $arr)) + { + $result->searchTermCriteria = SearchTermCriteria::hydrate($arr["searchTermCriteria"]); + } return $result; } @@ -151,9 +157,16 @@ function setFilters(RequestFilterCriteria $filters) return $this; } + /** @deprecated Use SearchTermCriteria instead */ function setSearchTerms(?SearchTermConditionByLanguageCollection $searchTerms) { $this->searchTerms = $searchTerms; return $this; } + + function setSearchTermCriteria(?SearchTermCriteria $searchTermCriteria) + { + $this->searchTermCriteria = $searchTermCriteria; + return $this; + } } diff --git a/src/Models/RetailMediaResultPlacementResultEntityDisplayAd.php b/src/Models/RetailMediaResultPlacementResultEntityDisplayAd.php index 76cca92..565bc7d 100644 --- a/src/Models/RetailMediaResultPlacementResultEntityDisplayAd.php +++ b/src/Models/RetailMediaResultPlacementResultEntityDisplayAd.php @@ -5,6 +5,7 @@ class RetailMediaResultPlacementResultEntityDisplayAd { public DisplayAdResult $result; + public string $campaignId; public static function create() : RetailMediaResultPlacementResultEntityDisplayAd { @@ -19,6 +20,10 @@ public static function hydrate(array $arr) : RetailMediaResultPlacementResultEnt { $result->result = DisplayAdResult::hydrate($arr["result"]); } + if (array_key_exists("campaignId", $arr)) + { + $result->campaignId = $arr["campaignId"]; + } return $result; } @@ -27,4 +32,10 @@ function setResult(DisplayAdResult $result) $this->result = $result; return $this; } + + function setCampaignId(string $campaignId) + { + $this->campaignId = $campaignId; + return $this; + } } diff --git a/src/Models/SearchTermCriteria.php b/src/Models/SearchTermCriteria.php new file mode 100644 index 0000000..f284f7b --- /dev/null +++ b/src/Models/SearchTermCriteria.php @@ -0,0 +1,41 @@ +policy = SearchTermCriteriaSearchTermPolicy::from($arr["policy"]); + } + if (array_key_exists("termCriteria", $arr)) + { + $result->termCriteria = SearchTermConditionByLanguageCollection::hydrate($arr["termCriteria"]); + } + return $result; + } + + function setPolicy(?SearchTermCriteriaSearchTermPolicy $policy) + { + $this->policy = $policy; + return $this; + } + + function setTermCriteria(?SearchTermConditionByLanguageCollection $termCriteria) + { + $this->termCriteria = $termCriteria; + return $this; + } +} diff --git a/src/Models/SearchTermCriteriaSearchTermPolicy.php b/src/Models/SearchTermCriteriaSearchTermPolicy.php new file mode 100644 index 0000000..a3c2e9d --- /dev/null +++ b/src/Models/SearchTermCriteriaSearchTermPolicy.php @@ -0,0 +1,11 @@ +trackProductUpdate($productUpdate); self::assertNull($tracking); - // Validate that the product was created with search. - $searcher = new Searcher($this->DATASET_ID(), $this->API_KEY()); + // Does not work as there is a delay before the product is searchable. + // // Validate that the product was created with search. + // $searcher = new Searcher($this->DATASET_ID(), $this->API_KEY()); - $productSearch = ProductSearchRequest::create( - Language::UNDEFINED, - Currency::UNDEFINED, - UserFactory::anonymous(), - "integration test", - null, - 0, - 1 - )->setFilters(FilterCollection::create(ProductIdFilter::create()->setProductIds("unique_delete_test"))); + // $productSearch = ProductSearchRequest::create( + // Language::UNDEFINED, + // Currency::UNDEFINED, + // UserFactory::anonymous(), + // "integration test", + // null, + // 0, + // 1 + // )->setFilters(FilterCollection::create(ProductIdFilter::create()->setProductIds("unique_delete_test"))); - $searchResult = $searcher->productSearch($productSearch); + // $searchResult = $searcher->productSearch($productSearch); - self::assertEquals(1, $searchResult->hits); + // self::assertEquals(1, $searchResult->hits); // Delete product $administrativeActionRequest = TrackProductAdministrativeActionRequest::create( @@ -215,22 +216,23 @@ public function testDisableAdministrativeAction(): void ); $tracking = $tracker->trackProductAdministrativeAction($administrativeActionRequest); + // Does not work as there is a delay before the product is searchable. // Validate that the product was created with search. - $searcher = new Searcher($this->DATASET_ID(), $this->API_KEY()); + // $searcher = new Searcher($this->DATASET_ID(), $this->API_KEY()); - $productSearch = ProductSearchRequest::create( - Language::UNDEFINED, - Currency::UNDEFINED, - UserFactory::anonymous(), - "integration test", - null, - 0, - 1 - )->setFilters(FilterCollection::create(ProductIdFilter::create()->setProductIds("unique_disable_test"))); + // $productSearch = ProductSearchRequest::create( + // Language::UNDEFINED, + // Currency::UNDEFINED, + // UserFactory::anonymous(), + // "integration test", + // null, + // 0, + // 1 + // )->setFilters(FilterCollection::create(ProductIdFilter::create()->setProductIds("unique_disable_test"))); - $searchResult = $searcher->productSearch($productSearch); + // $searchResult = $searcher->productSearch($productSearch); - self::assertEquals(1, $searchResult->hits); + // self::assertEquals(1, $searchResult->hits); // Disable product $administrativeActionRequest = TrackProductAdministrativeActionRequest::create(