Merge pull request #30 from vienthuong/1.4.0

Release 1.4.0

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to `shopware-php-sdk` will be documented in this file.
 
 Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
+### 1.4.0
+- Updated Latest DAL Classes
+- Added NotificationService to allow sending/getting notification from external app (success/error/warning/info)
+- Added UserConfigService to getting/saving admin's config
+- Added AdminSearchService to search for multiple entities as one request
+- Added more service's examples
+- Deprecated SystemConfigService::saveConfiguration, use SystemConfigService::save instead
+- Deprecated SystemConfigService::batchSaveConfiguration, use SystemConfigService::batchSave instead
+
 ### 1.3.3
 - [Use correct sync operator for syncDeleted](https://github.com/vienthuong/shopware-php-sdk/pull/16)
 - [Remove extends HttpClient from GuzzleClient](https://github.com/vienthuong/shopware-php-sdk/issues/5)

README.md

@@ -14,6 +14,9 @@ If you're familiar with Shopware 6 DAL syntax and how to retrieve it you might s
 
 ![image](https://i.imgur.com/NyXy2db.png)
 
+Or sending notification from external server
+![image](https://i.imgur.com/26LdTab.png)
+
 ## Installation
 Install with Composer
 ```shell
@@ -25,6 +28,9 @@ composer require vin-sw/shopware-sdk
 - Admin API
   - CRUD API 
   - Sync Api
+  - User Config API
+  - Notification API
+  - Admin Search API
   - Other services  
   - ... (TODO)
 
@@ -165,6 +171,9 @@ new OpenModalResponse($shopSecret, $iframeUrl, OpenModalResponse::LARGE_SIZE, tr
   - [UserService](/src/Service/UserService.php)
   - [StateMachineService](/src/Service/StateMachineService.php)
   - [SyncService](/src/Service/SyncService.php)
+  - [NotificationService](/src/Service/NotificationService.php)
+  - [UserConfigService](/src/Service/UserConfigService.php)
+  - [AdminSearchService](/src/Service/AdminSearchService.php)
   - For other services that does not have a concrete class, use: [AdminActionService](/src/Service/AdminActionService.php)   
 
 An ApiService requires a [Context](src/Data/Context.php) object as its first argument. 

composer.json

@@ -3,7 +3,7 @@
     "description": "A PHP SDK for Shopware 6 Platform",
     "type": "library",
     "license": "MIT",
-    "version": "1.3.3",
+    "version": "1.4.0",
     "authors": [
         {
             "name": "vin",

examples/admin-search-service.php

@@ -0,0 +1,37 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Vin\ShopwareSdk\Data\Context;
+use Vin\ShopwareSdk\Service\AdminSearchService;
+use Vin\ShopwareSdk\Data\Criteria;
+use Vin\ShopwareSdk\Service\Struct\KeyValuePairs;
+use Vin\ShopwareSdk\Service\Struct\KeyValuePair;
+
+class AdminSearchExample {
+    public function execute(): void
+    {
+        require __DIR__ . '/token.php';
+
+        $context = new Context($config['shop_url'], $accessToken);
+        $service = new AdminSearchService($context);
+
+        $productCriteria = new Criteria();
+        $productCriteria->addAssociation('categories');
+        $productCriteria->setTerm('feeb9f03a8ca49749f8cce86c9a3d4d7');
+
+        $customerCriteria = new Criteria();
+        $customerCriteria->setTerm('501e41803e7b4ca8b54a7ed72b498568pharvey@example.com');
+
+        $criteriaCollection = new KeyValuePairs();
+        $criteriaCollection->add(KeyValuePair::create('product', $productCriteria));
+        $criteriaCollection->add(KeyValuePair::create('customer', $customerCriteria));
+
+        $result = $service->search($criteriaCollection);
+
+        dd($result);
+    }
+}
+
+$example = new AdminSearchExample();
+$example->execute();

examples/notification-service.php

@@ -0,0 +1,27 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Vin\ShopwareSdk\Data\Context;
+use Vin\ShopwareSdk\Service\NotificationService;
+use Vin\ShopwareSdk\Service\Struct\Notification;
+
+class NotificationServiceExample {
+    public function execute(): void
+    {
+        require __DIR__ . '/token.php';
+
+        $context = new Context($config['shop_url'], $accessToken);
+        $service = new NotificationService($context);
+
+        $notification = Notification::createNotificationSuccess('Hello from External App!');
+
+        $service->sendNotification($notification);
+
+        $notifications = $service->fetchNotification();
+        dump($notifications);
+    }
+}
+
+$example = new NotificationServiceExample();
+$example->execute();

examples/system-config-service.php

@@ -0,0 +1,27 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Vin\ShopwareSdk\Data\Context;
+use Vin\ShopwareSdk\Service\SystemConfigService;
+use Vin\ShopwareSdk\Service\Struct\KeyValuePair;
+
+class SystemConfigServiceExample {
+    public function execute(): void
+    {
+        require __DIR__ . '/token.php';
+
+        $context = new Context($config['shop_url'], $accessToken);
+        $service = new SystemConfigService($context);
+
+        $config = KeyValuePair::create('my.config.key1', ['test' => 'my.config.value1']);
+
+        $service->save($config);
+
+        $config = $service->getConfiguration('core.basicInformation');
+        dump($config);
+    }
+}
+
+$example = new SystemConfigServiceExample();
+$example->execute();

examples/user-config-service.php

@@ -0,0 +1,31 @@
+<?php
+
+require __DIR__ . '/../vendor/autoload.php';
+
+use Vin\ShopwareSdk\Data\Context;
+use Vin\ShopwareSdk\Service\UserConfigService;
+use Vin\ShopwareSdk\Service\Struct\KeyValuePair;
+use Vin\ShopwareSdk\Service\Struct\KeyValuePairs;
+
+class UserConfigServiceExample {
+    public function execute(): void
+    {
+        require __DIR__ . '/token.php';
+
+        $context = new Context($config['shop_url'], $accessToken);
+        $service = new UserConfigService($context);
+
+        $config1 = KeyValuePair::create('my.config.key1', ['test' => 'my.config.value1']);
+        $config2 = KeyValuePair::create('my.config.key2', ['another' => 'my.config.value2']);
+
+        $pairs = new KeyValuePairs([$config1, $config2]);
+
+        $service->saveConfigMe($pairs);
+
+        $configs = $service->getConfigMe($pairs->getKeys());
+        dump($configs);
+    }
+}
+
+$example = new UserConfigServiceExample();
+$example->execute();

script/src/CodeGenerator.php

@@ -240,6 +240,11 @@ private static function escapeJson(array $input) {
 
     private static function getTypedProperty(string $entityNamespace, string $entityName, ClassGenerator $class, Property $property): ?string
     {
+        // TODO: hotfix for ConfigJsonFieldSerializer bug in core
+        if ($entityName === 'SystemConfig' && $property->name === 'configurationValue') {
+            return null;
+        }
+
         $prefix = '?';
 
 //        $flags = $property->flags;

src/Data/Aggregation/HistogramAggregation.php

@@ -9,11 +9,17 @@
 class HistogramAggregation extends Aggregation
 {
     public const PER_MINUTE = 'minute';
+
     public const PER_HOUR = 'hour';
+
     public const PER_DAY = 'day';
+
     public const PER_WEEK = 'week';
+
     public const PER_MONTH = 'month';
+
     public const PER_QUARTER = 'quarter';
+
     public const PER_YEAR = 'year';
 
     public string $name;

src/Data/Entity/App/AppDefinition.php

@@ -63,6 +63,7 @@ public function getSchema() : Schema
             new Property('customFieldSets', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('cascade_delete', 1), ]), ['entity' => 'custom_field_set', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
             new Property('actionButtons', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('cascade_delete', 1), ]), ['entity' => 'app_action_button', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
             new Property('templates', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('cascade_delete', 1), ]), ['entity' => 'app_template', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
+            new Property('scripts', 'association', new FlagCollection([new Flag('cascade_delete', 1), ]), ['entity' => 'script', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
             new Property('webhooks', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('cascade_delete', 1), ]), ['entity' => 'webhook', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
             new Property('paymentMethods', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('set_null_on_delete', 1), ]), ['entity' => 'app_payment_method', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),
             new Property('cmsBlocks', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('cascade_delete', 1), ]), ['entity' => 'app_cms_block', 'referenceField' => 'appId', 'localField' => 'id', 'relation' => 'one_to_many', ]),

src/Data/Entity/App/AppEntity.php

@@ -7,6 +7,7 @@
 use Vin\ShopwareSdk\Data\Entity\CustomFieldSet\CustomFieldSetCollection;
 use Vin\ShopwareSdk\Data\Entity\AppActionButton\AppActionButtonCollection;
 use Vin\ShopwareSdk\Data\Entity\AppTemplate\AppTemplateCollection;
+use Vin\ShopwareSdk\Data\Entity\Script\ScriptCollection;
 use Vin\ShopwareSdk\Data\Entity\Webhook\WebhookCollection;
 use Vin\ShopwareSdk\Data\Entity\AppPaymentMethod\AppPaymentMethodCollection;
 use Vin\ShopwareSdk\Data\Entity\AppCmsBlock\AppCmsBlockCollection;
@@ -71,6 +72,8 @@ class AppEntity extends Entity
 
     public ?AppTemplateCollection $templates = null;
 
+    public ?ScriptCollection $scripts = null;
+
     public ?WebhookCollection $webhooks = null;
 
     public ?AppPaymentMethodCollection $paymentMethods = null;

src/Data/Entity/AppPaymentMethod/AppPaymentMethodDefinition.php

@@ -40,6 +40,8 @@ public function getSchema() : Schema
             new Property('identifier', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('required', 1), ]), []),
             new Property('payUrl', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('finalizeUrl', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
+            new Property('validateUrl', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
+            new Property('captureUrl', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('appId', 'uuid', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('app', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), ['entity' => 'app', 'referenceField' => 'id', 'localField' => 'appId', 'relation' => 'many_to_one', ]),
             new Property('originalMediaId', 'uuid', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),

src/Data/Entity/AppPaymentMethod/AppPaymentMethodEntity.php

@@ -21,6 +21,10 @@ class AppPaymentMethodEntity extends Entity
 
     public ?string $finalizeUrl = null;
 
+    public ?string $validateUrl = null;
+
+    public ?string $captureUrl = null;
+
     public ?string $appId = null;
 
     public ?AppEntity $app = null;

src/Data/Entity/Country/CountryDefinition.php

@@ -39,7 +39,6 @@ public function getSchema() : Schema
             new Property('name', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('required', 1), new Flag('search_ranking', 500), new Flag('translatable', 1), ]), []),
             new Property('iso', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('search_ranking', 250), ]), []),
             new Property('position', 'int', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
-            new Property('taxFree', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('deprecated', unserialize('a:3:{s:16:"deprecated_since";s:6:"v6.4.0";s:18:"will_be_removed_in";s:6:"v6.5.0";s:11:"replaced_by";N;}')), ]), []),
             new Property('active', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('shippingAvailable', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('iso3', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('search_ranking', 250), ]), []),
@@ -48,6 +47,7 @@ public function getSchema() : Schema
             new Property('companyTaxFree', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('deprecated', unserialize('a:3:{s:16:"deprecated_since";s:6:"v6.4.0";s:18:"will_be_removed_in";s:6:"v6.5.0";s:11:"replaced_by";N;}')), ]), []),
             new Property('checkVatIdPattern', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('vatIdRequired', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
+            new Property('taxFree', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('deprecated', unserialize('a:3:{s:16:"deprecated_since";s:6:"v6.4.0";s:18:"will_be_removed_in";s:6:"v6.5.0";s:11:"replaced_by";N;}')), ]), []),
             new Property('vatIdPattern', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('customFields', 'json_object', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('translatable', 1), ]), []),
             new Property('customerTax', 'json_object', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), ['properties' => json_decode('{"enabled":{"type":"boolean","flags":{"read_protected":[["Shopware\\Core\\Framework\\Api\\Context\\AdminApiSource"]],"required":true}},"currencyId":{"type":"string","flags":{"read_protected":[["Shopware\\Core\\Framework\\Api\\Context\\AdminApiSource"]],"required":true}},"amount":{"type":"float","flags":{"read_protected":[["Shopware\\Core\\Framework\\Api\\Context\\AdminApiSource"]],"required":true}}}', true), ]),

src/Data/Entity/Country/CountryEntity.php

@@ -23,8 +23,6 @@ class CountryEntity extends Entity
 
     public ?int $position = null;
 
-    public ?bool $taxFree = null;
-
     public ?bool $active = null;
 
     public ?bool $shippingAvailable = null;
@@ -41,6 +39,8 @@ class CountryEntity extends Entity
 
     public ?bool $vatIdRequired = null;
 
+    public ?bool $taxFree = null;
+
     public ?string $vatIdPattern = null;
 
     public ?array $customerTax = null;

src/Data/Entity/Customer/CustomerDefinition.php

@@ -63,6 +63,7 @@ public function getSchema() : Schema
             new Property('guest', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('firstLogin', 'date', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('lastLogin', 'date', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
+            new Property('newsletterSalesChannelIds', 'json_object', new FlagCollection([new Flag('write_protected', [['system']]), ]), []),
             new Property('newsletter', 'boolean', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('birthday', 'date', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), ]), []),
             new Property('lastOrderDate', 'date', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource', 'Shopware\Core\Framework\Api\Context\SalesChannelApiSource']]), new Flag('write_protected', [['system']]), ]), []),

src/Data/Entity/Customer/CustomerEntity.php

@@ -77,6 +77,8 @@ class CustomerEntity extends Entity
 
     public ?\DateTimeInterface$lastLogin = null;
 
+    public ?array $newsletterSalesChannelIds = null;
+
     public ?bool $newsletter = null;
 
     public ?\DateTimeInterface$birthday = null;

src/Data/Entity/ImportExportLog/ImportExportLogDefinition.php

@@ -46,6 +46,7 @@ public function getSchema() : Schema
             new Property('username', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('profileName', 'string', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('config', 'json_object', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), new Flag('required', 1), ]), []),
+            new Property('result', 'json_object', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), []),
             new Property('user', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), ['entity' => 'user', 'referenceField' => 'id', 'localField' => 'userId', 'relation' => 'many_to_one', ]),
             new Property('profile', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), ['entity' => 'import_export_profile', 'referenceField' => 'id', 'localField' => 'profileId', 'relation' => 'many_to_one', ]),
             new Property('file', 'association', new FlagCollection([new Flag('read_protected', [['Shopware\Core\Framework\Api\Context\AdminApiSource']]), ]), ['entity' => 'import_export_file', 'referenceField' => 'id', 'localField' => 'fileId', 'relation' => 'one_to_one', ]),

src/Data/Entity/ImportExportLog/ImportExportLogEntity.php

@@ -33,6 +33,8 @@ class ImportExportLogEntity extends Entity
 
     public ?array $config = null;
 
+    public ?array $result = null;
+
     public ?UserEntity $user = null;
 
     public ?ImportExportProfileEntity $profile = null;