├── .gitignore
├── tests
    ├── fixtures
    │   ├── BasketUpdateRequest.json
    │   ├── BasketAddItemRequest.json
    │   ├── WishlistAddItemRequest.json
    │   └── BrandGetResponse.json
    ├── RedirectTest.php
    ├── PromotionTest.php
    ├── SearchTest.php
    ├── AttributeTest.php
    ├── FilterTest.php
    ├── ShopConfigurationTest.php
    ├── MatchRedirectTest.php
    ├── CampaignTest.php
    ├── VariantTest.php
    ├── TypeaheadTest.php
    ├── NavigationTest.php
    ├── BrandTest.php
    ├── WishlistTest.php
    ├── BasketTest.php
    ├── CategoryTest.php
    ├── ProductTest.php
    └── BaseApiTestCase.php
├── phpstan.neon.dist
├── lib
    ├── Models
    │   ├── ApiCollection.php
    │   ├── ArrayCollection.php
    │   ├── Search.php
    │   ├── Navigation.php
    │   ├── Packages.php
    │   ├── Timestamp.php
    │   ├── DisplayData.php
    │   ├── FilterValues.php
    │   ├── BrandCustomData.php
    │   ├── BasketItemPromotion.php
    │   ├── ResponseCustomData.php
    │   ├── NavigationTreeResponse.php
    │   ├── SearchV2ResolveResponse.php
    │   ├── FilterCollection.php
    │   ├── ProductName.php
    │   ├── CategoryCollection.php
    │   ├── OffsetPagination.php
    │   ├── Vat.php
    │   ├── SearchResolveResponse.php
    │   ├── Deliverable.php
    │   ├── DeliveryDate.php
    │   ├── NavigationItemExtraFilter.php
    │   ├── SearchV2ProductSuggestion.php
    │   ├── BasketItemPrice.php
    │   ├── DefiningAttribute.php
    │   ├── NavigationTreeCollection.php
    │   ├── ShopProperties.php
    │   ├── Tax.php
    │   ├── SubsequentDelivery.php
    │   ├── BooleanFilterValue.php
    │   ├── BuyXGetYEffect.php
    │   ├── CategoryProperty.php
    │   ├── MatchRedirectBody.php
    │   ├── IdentifierFilterValue.php
    │   ├── AppliedReductionAmount.php
    │   ├── AutomaticDiscountEffect.php
    │   ├── Condition.php
    │   ├── PromotionsResponse.php
    │   ├── SearchV2AttributeFilter.php
    │   ├── AttributeValue.php
    │   ├── RangeFilterValue.php
    │   ├── Tier.php
    │   ├── DeliveryForecast.php
    │   ├── RedirectsResponse.php
    │   ├── Merchant.php
    │   ├── SearchV2SuggestionsResponse.php
    │   ├── AdvancedAttributeGroupSet.php
    │   ├── SearchV2CategorySuggestion.php
    │   ├── SearchV2ProductResponse.php
    │   ├── AppliedReduction.php
    │   ├── SearchV2CategoryResponse.php
    │   ├── NavigationTree.php
    │   ├── ResolveMatch.php
    │   ├── TypeaheadResponse.php
    │   ├── Wishlist.php
    │   ├── AttributeFilterValue.php
    │   ├── Image.php
    │   ├── Package.php
    │   ├── ProductSuggestion.php
    │   ├── BrandsResponse.php
    │   ├── Cost.php
    │   ├── PriceRange.php
    │   ├── ProductsResponse.php
    │   ├── ReductionRange.php
    │   ├── AdvancedAttribute.php
    │   ├── Match.php
    │   ├── Stock.php
    │   ├── MatchRedirect.php
    │   ├── Basket.php
    │   ├── Pagination.php
    │   ├── TypeaheadProductSuggestion.php
    │   ├── VariantsResponse.php
    │   ├── ApplicablePromotion.php
    │   ├── BaseCategory.php
    │   ├── BrandOrCategorySuggestion.php
    │   ├── CampaignsResponse.php
    │   ├── CustomData.php
    │   ├── Campaign.php
    │   ├── TypeaheadBrandOrCategorySuggestion.php
    │   ├── Filter.php
    │   ├── Typeahead.php
    │   ├── BasketItemDisplayData.php
    │   ├── TypeaheadSuggestion.php
    │   ├── ProductCategory.php
    │   ├── CreateWishlistBody.php
    │   ├── Identifier.php
    │   ├── Redirect.php
    │   ├── DisplayDataValue.php
    │   ├── CreateBasketItemBody.php
    │   ├── LowestPriorPrice.php
    │   ├── NavigationItem.php
    │   ├── ShopConfiguration.php
    │   ├── Price.php
    │   ├── SearchSuggestions.php
    │   ├── UpdateBasketItemBody.php
    │   ├── WishlistItem.php
    │   ├── TypeaheadRequestBody.php
    │   ├── Attribute.php
    │   ├── Promotion.php
    │   ├── TypeaheadBody.php
    │   ├── ItemGroup.php
    │   ├── CreateBasketBody.php
    │   ├── Variant.php
    │   ├── Brand.php
    │   ├── BasketItem.php
    │   ├── Category.php
    │   ├── Product.php
    │   └── ApiObject.php
    ├── Exceptions
    │   ├── InvalidArgumentException.php
    │   ├── ApiError.php
    │   └── ApiErrorException.php
    ├── Serializers
    │   ├── AttributeAdapter.php
    │   └── ModelSerializer.php
    ├── Services
    │   ├── AttributeService.php
    │   ├── FilterService.php
    │   ├── RedirectService.php
    │   ├── PromotionService.php
    │   ├── SearchService.php
    │   ├── VariantService.php
    │   ├── MatchRedirectService.php
    │   ├── ShopConfigurationService.php
    │   ├── AbstractServiceFactory.php
    │   ├── TypeaheadService.php
    │   ├── NavigationService.php
    │   ├── CampaignService.php
    │   ├── BrandService.php
    │   ├── ProductService.php
    │   ├── ServiceFactory.php
    │   ├── WishlistService.php
    │   ├── CategoryService.php
    │   ├── BasketService.php
    │   └── AbstractService.php
    ├── StorefrontClient.php
    └── AbstractApi.php
├── phpunit.xml.dist
├── composer.json
├── .php_cs.dist
├── .gitlab-ci.yml
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | .api
2 | 


--------------------------------------------------------------------------------
/tests/fixtures/BasketUpdateRequest.json:
--------------------------------------------------------------------------------
1 | {
2 |     "quantity": 2
3 | }


--------------------------------------------------------------------------------
/tests/fixtures/BasketAddItemRequest.json:
--------------------------------------------------------------------------------
1 | {
2 |     "variantId": 5,
3 |     "quantity": 1
4 | }


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
1 | parameters:
2 |     level: 4
3 |     paths:
4 |         - lib
5 |         - tests


--------------------------------------------------------------------------------
/tests/fixtures/WishlistAddItemRequest.json:
--------------------------------------------------------------------------------
1 | {
2 |     "productId": 7,
3 |     "quantity": 1
4 | }


--------------------------------------------------------------------------------
/lib/Models/ApiCollection.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Scayle\StorefrontApi\Models;
4 | 
5 | class ApiCollection extends ApiObject
6 | {
7 |     protected $classMap = [
8 |     ];
9 | }


--------------------------------------------------------------------------------
/lib/Exceptions/InvalidArgumentException.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | namespace Scayle\StorefrontApi\Exceptions;
4 | 
5 | class InvalidArgumentException extends \InvalidArgumentException
6 | {
7 | }


--------------------------------------------------------------------------------
/lib/Models/ArrayCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array $entities
 7 |  */
 8 | class ArrayCollection extends ApiCollection
 9 | {
10 |     /**
11 |     * @return array
12 |     */
13 |     public function getEntities()
14 |     {
15 |         return $this->entities;
16 |     }
17 | }


--------------------------------------------------------------------------------
/lib/Serializers/AttributeAdapter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Serializers;
 4 | 
 5 | class AttributeAdapter
 6 | {
 7 |     public function deserialize($attributes)
 8 |     {
 9 |         $arr = $attributes['values'];
10 |         if (array_keys($arr) !== range(0, count($arr) - 1)) {
11 |             $attributes['values'] = [$arr];
12 |         }
13 | 
14 |         return new \Scayle\StorefrontApi\Models\Attribute($attributes);
15 |     }
16 | }


--------------------------------------------------------------------------------
/lib/Models/Search.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class Search extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/Navigation.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class Navigation extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/Packages.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class Packages extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/Timestamp.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class Timestamp extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <phpunit bootstrap="vendor/autoload.php" colors="true">
 2 |     <testsuites>
 3 |         <testsuite name="StorefrontClient Test Suite">
 4 |             <directory suffix="Test.php">tests</directory>
 5 |         </testsuite>
 6 |     </testsuites>
 7 |     <filter>
 8 |         <whitelist>
 9 |             <directory>lib</directory>
10 |         </whitelist>
11 |     </filter>
12 |     <php>
13 |         <env name="API_URL" value="http://127.0.0.1:4010"/>
14 |     </php>
15 | </phpunit>


--------------------------------------------------------------------------------
/lib/Models/DisplayData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class DisplayData extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/FilterValues.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class FilterValues extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/BrandCustomData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class BrandCustomData extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/BasketItemPromotion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class BasketItemPromotion extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/ResponseCustomData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class ResponseCustomData extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/NavigationTreeResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class NavigationTreeResponse extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2ResolveResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  */
 7 | class SearchV2ResolveResponse extends ApiObject
 8 | {
 9 |     protected $defaultValues = [
10 |         
11 |     ];
12 | 
13 |     protected $classMap = [
14 |     ];
15 | 
16 |     protected $collectionClassMap = [
17 |     ];
18 | 
19 |     protected $collection2dClassMap = [
20 |     ];
21 | 
22 | protected $polymorphic = [
23 |     ];
24 | 
25 |     protected $polymorphicCollections = [
26 |     ];
27 | }


--------------------------------------------------------------------------------
/lib/Models/FilterCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property \Scayle\StorefrontApi\Models\Filter[] $entities
 7 |  */
 8 | class FilterCollection extends ApiCollection
 9 | {
10 | 	protected $collectionClassMap = [
11 | 		'entities' => \Scayle\StorefrontApi\Models\Filter::class,
12 |     ];
13 | 
14 |     /**
15 |     * @return \Scayle\StorefrontApi\Models\Filter[]
16 |     */
17 |     public function getEntities()
18 |     {
19 |         return $this->entities;
20 |     }
21 | }


--------------------------------------------------------------------------------
/lib/Models/ProductName.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $term 
 7 |  */
 8 | class ProductName extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/CategoryCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property \Scayle\StorefrontApi\Models\Category[] $entities
 7 |  */
 8 | class CategoryCollection extends ApiCollection
 9 | {
10 | 	protected $collectionClassMap = [
11 | 		'entities' => \Scayle\StorefrontApi\Models\Category::class,
12 |     ];
13 | 
14 |     /**
15 |     * @return \Scayle\StorefrontApi\Models\Category[]
16 |     */
17 |     public function getEntities()
18 |     {
19 |         return $this->entities;
20 |     }
21 | }


--------------------------------------------------------------------------------
/lib/Models/OffsetPagination.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $total 
 7 |  */
 8 | class OffsetPagination extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/Vat.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property float $amount 
 7 |  * @property float $rate 
 8 |  */
 9 | class Vat extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/SearchResolveResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property mixed $matches 
 7 |  */
 8 | class SearchResolveResponse extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/Deliverable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property int $quantity 
 8 |  */
 9 | class Deliverable extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/DeliveryDate.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $min 
 7 |  * @property string $max 
 8 |  */
 9 | class DeliveryDate extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/NavigationItemExtraFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array[] $attributes 
 7 |  */
 8 | class NavigationItemExtraFilter extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2ProductSuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Product $product 
 7 |  */
 8 | class SearchV2ProductSuggestion extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/BasketItemPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Price $total 
 7 |  * @property Price $unit 
 8 |  */
 9 | class BasketItemPrice extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/DefiningAttribute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $label 
 8 |  */
 9 | class DefiningAttribute extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/NavigationTreeCollection.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property \Scayle\StorefrontApi\Models\NavigationTree[] $entities
 7 |  */
 8 | class NavigationTreeCollection extends ApiCollection
 9 | {
10 | 	protected $collectionClassMap = [
11 | 		'entities' => \Scayle\StorefrontApi\Models\NavigationTree::class,
12 |     ];
13 | 
14 |     /**
15 |     * @return \Scayle\StorefrontApi\Models\NavigationTree[]
16 |     */
17 |     public function getEntities()
18 |     {
19 |         return $this->entities;
20 |     }
21 | }


--------------------------------------------------------------------------------
/lib/Models/ShopProperties.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property string $value 
 8 |  */
 9 | class ShopProperties extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/Tax.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Vat $vat 
 7 |  */
 8 | class Tax extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 | 		'vat' => \Scayle\StorefrontApi\Models\Vat::class,
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/SubsequentDelivery.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property int $quantity 
 8 |  */
 9 | class SubsequentDelivery extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/BooleanFilterValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property bool $name 
 7 |  * @property int $productCount 
 8 |  */
 9 | class BooleanFilterValue extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/BuyXGetYEffect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property array $additionalData 
 8 |  */
 9 | class BuyXGetYEffect extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/CategoryProperty.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $name 
 7 |  * @property string|float $value 
 8 |  */
 9 | class CategoryProperty extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/MatchRedirectBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $url The url to find a redirect for
 7 | 
 8 |  */
 9 | class MatchRedirectBody extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/IdentifierFilterValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $productCount 
 7 |  * @property int $id 
 8 |  */
 9 | class IdentifierFilterValue extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/AppliedReductionAmount.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $absoluteWithTax 
 7 |  * @property float $relative 
 8 |  */
 9 | class AppliedReductionAmount extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/AutomaticDiscountEffect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property array $additionalData 
 8 |  */
 9 | class AutomaticDiscountEffect extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/Condition.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $level 
 7 |  * @property string $key 
 8 |  * @property string $condition 
 9 |  */
10 | class Condition extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/PromotionsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Promotion[] $entities 
 7 |  * @property Pagination $pagination 
 8 |  */
 9 | class PromotionsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2AttributeFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property array $attributeFilter 
 8 |  */
 9 | class SearchV2AttributeFilter extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/AttributeValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $label 
 8 |  * @property string $value 
 9 |  */
10 | class AttributeValue extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/RangeFilterValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $max 
 7 |  * @property int $min 
 8 |  * @property int $productCount 
 9 |  */
10 | class RangeFilterValue extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/Tier.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $name 
 8 |  * @property int $MOV 
 9 |  * @property array $effect 
10 |  */
11 | class Tier extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/DeliveryForecast.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Deliverable $deliverable 
 7 |  * @property SubsequentDelivery $subsequentDelivery 
 8 |  */
 9 | class DeliveryForecast extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/RedirectsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Redirect[] $entities 
 7 |  * @property Pagination|OffsetPagination $pagination 
 8 |  */
 9 | class RedirectsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/Merchant.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $key 
 8 |  * @property string $name 
 9 |  * @property array $legal 
10 |  */
11 | class Merchant extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2SuggestionsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property SearchV2CategoryResponse[]|SearchV2ProductResponse[] $suggestions 
 7 |  */
 8 | class SearchV2SuggestionsResponse extends ApiObject
 9 | {
10 |     protected $defaultValues = [
11 |         
12 |     ];
13 | 
14 |     protected $classMap = [
15 |     ];
16 | 
17 |     protected $collectionClassMap = [
18 |     ];
19 | 
20 |     protected $collection2dClassMap = [
21 |     ];
22 | 
23 | protected $polymorphic = [
24 |     ];
25 | 
26 |     protected $polymorphicCollections = [
27 |     ];
28 | }


--------------------------------------------------------------------------------
/lib/Models/AdvancedAttributeGroupSet.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array[] $fieldSet 
 7 |  * @property AdvancedAttributeGroupSet[] $groupSet 
 8 |  */
 9 | class AdvancedAttributeGroupSet extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2CategorySuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Category $category 
 7 |  * @property SearchV2AttributeFilter[] $filters 
 8 |  */
 9 | class SearchV2CategorySuggestion extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2ProductResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property SearchV2ProductSuggestion $productSuggestion 
 8 |  */
 9 | class SearchV2ProductResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/AppliedReduction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property AppliedReductionAmount $amount 
 7 |  * @property string $category 
 8 |  * @property string $type 
 9 |  */
10 | class AppliedReduction extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/SearchV2CategoryResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property SearchV2CategorySuggestion $categorySuggestion 
 8 |  */
 9 | class SearchV2CategoryResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/NavigationTree.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $key 
 8 |  * @property string $name 
 9 |  * @property NavigationItem[] $items 
10 |  */
11 | class NavigationTree extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/ResolveMatch.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $count 
 7 |  * @property string $match 
 8 |  * @property array $category 
 9 |  * @property array[] $attributes 
10 |  */
11 | class ResolveMatch extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/TypeaheadResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property TypeaheadBrandOrCategorySuggestion|TypeaheadProductSuggestion $suggestions 
 7 |  * @property array $topMatch 
 8 |  */
 9 | class TypeaheadResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/Wishlist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property WishlistItem[] $items 
 8 |  */
 9 | class Wishlist extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |         'items' => \Scayle\StorefrontApi\Models\WishlistItem::class,
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/AttributeFilterValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $name 
 7 |  * @property int $productCount 
 8 |  * @property int $id 
 9 |  * @property string $value 
10 |  */
11 | class AttributeFilterValue extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/tests/RedirectTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class RedirectTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->redirects->Get( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('RedirectGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\RedirectsResponse::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 | 
20 |     }
21 | 
22 | }


--------------------------------------------------------------------------------
/lib/Models/Image.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array<string, Attribute> $attributes 
 7 |  * @property string $hash 
 8 |  */
 9 | class Image extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |         'attributes' => \Scayle\StorefrontApi\Models\Attribute::class,
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/Package.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $carrierKey The carrier key which will deliver the package
 8 |  * @property DeliveryDate $deliveryDate 
 9 |  */
10 | class Package extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/ProductSuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $suggestion 
 7 |  * @property Product $product 
 8 |  */
 9 | class ProductSuggestion extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'product' => \Scayle\StorefrontApi\Models\Product::class,
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Serializers/ModelSerializer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Serializers;
 4 | 
 5 | class ModelSerializer
 6 | {
 7 |     private $adapters = [
 8 |        \Scayle\StorefrontApi\Models\Attribute::class => AttributeAdapter::class,
 9 |     ];
10 | 
11 |     public function parse($class, $attributes)
12 |     {
13 |         foreach ($this->adapters as $adapterClass => $adapter) {
14 |             if ($adapterClass !== $class) {
15 |                 continue;
16 |             }
17 |             return (new $adapter())->deserialize($attributes);
18 |         }
19 | 
20 |         return new $class($attributes);
21 |     }
22 | 
23 | }
24 | 


--------------------------------------------------------------------------------
/tests/PromotionTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class PromotionTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->promotions->Get( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('PromotionGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\PromotionsResponse::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 | 
20 |     }
21 | 
22 | }


--------------------------------------------------------------------------------
/lib/Models/BrandsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Brand[] $entities 
 7 |  * @property Pagination|OffsetPagination $pagination 
 8 |  */
 9 | class BrandsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |         'entities' => \Scayle\StorefrontApi\Models\Brand::class,
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/tests/SearchTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class SearchTest extends BaseApiTestCase
 8 | {
 9 |     public function testSuggestions()
10 |     {
11 |         $responseEntity = $this->api->searches->Suggestions('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('SearchSuggestionsResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\SearchSuggestions::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 | 
20 |     }
21 | 
22 | }


--------------------------------------------------------------------------------
/lib/Models/Cost.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property AppliedReduction[] $appliedReductions 
 7 |  * @property string $currencyCode The currency of the price.
 8 |  * @property int $withoutTax 
 9 |  * @property int $withTax 
10 |  */
11 | class Cost extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/PriceRange.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Price $max 
 7 |  * @property Price $min 
 8 |  */
 9 | class PriceRange extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'max' => \Scayle\StorefrontApi\Models\Price::class,
17 | 		'min' => \Scayle\StorefrontApi\Models\Price::class,
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/ProductsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Product[] $entities 
 7 |  * @property Pagination|OffsetPagination $pagination 
 8 |  */
 9 | class ProductsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |         'entities' => \Scayle\StorefrontApi\Models\Product::class,
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/ReductionRange.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Price $max 
 7 |  * @property Price $min 
 8 |  */
 9 | class ReductionRange extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'max' => \Scayle\StorefrontApi\Models\Price::class,
17 | 		'min' => \Scayle\StorefrontApi\Models\Price::class,
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/AdvancedAttribute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $key 
 8 |  * @property string $label 
 9 |  * @property string $type 
10 |  * @property AdvancedAttributeGroupSet[] $values 
11 |  */
12 | class AdvancedAttribute extends ApiObject
13 | {
14 |     protected $defaultValues = [
15 |         
16 |     ];
17 | 
18 |     protected $classMap = [
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/lib/Models/Match.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $type 
 7 |  * @property int $id 
 8 |  * @property string $name 
 9 |  * @property string $match 
10 |  * @property array $attributeGroup 
11 |  * @property int[] $attributeIds 
12 |  */
13 | class Match extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Models/Stock.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $supplierId 
 7 |  * @property int $warehouseId 
 8 |  * @property int $quantity 
 9 |  * @property bool $isSellableWithoutStock 
10 |  * @property string $expectedAvailabilityAt 
11 |  */
12 | class Stock extends ApiObject
13 | {
14 |     protected $defaultValues = [
15 |         
16 |     ];
17 | 
18 |     protected $classMap = [
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/lib/Models/MatchRedirect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $source The source URL for the redirect
 7 |  * @property string $target The target URL for the redirect
 8 |  * @property int $statusCode The status code for the redirect
 9 |  */
10 | class MatchRedirect extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/Basket.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key A unique key identifying the basket.
 7 |  * @property BasketItem[] $items 
 8 |  * @property Price $cost 
 9 |  * @property Package[] $packages 
10 |  * @property ApplicablePromotion[] $applicablePromotions 
11 |  */
12 | class Basket extends ApiObject
13 | {
14 |     protected $defaultValues = [
15 |         
16 |     ];
17 | 
18 |     protected $classMap = [
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/lib/Models/Pagination.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $current 
 7 |  * @property int $first 
 8 |  * @property int $last 
 9 |  * @property int $next 
10 |  * @property int $page 
11 |  * @property int $perPage 
12 |  * @property int $prev 
13 |  * @property int $total 
14 |  */
15 | class Pagination extends ApiObject
16 | {
17 |     protected $defaultValues = [
18 |         
19 |     ];
20 | 
21 |     protected $classMap = [
22 |     ];
23 | 
24 |     protected $collectionClassMap = [
25 |     ];
26 | 
27 |     protected $collection2dClassMap = [
28 |     ];
29 | 
30 | protected $polymorphic = [
31 |     ];
32 | 
33 |     protected $polymorphicCollections = [
34 |     ];
35 | }


--------------------------------------------------------------------------------
/lib/Models/TypeaheadProductSuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property ProductSuggestion $productSuggestion 
 7 |  * @property float $score 
 8 |  * @property string $type 
 9 |  */
10 | class TypeaheadProductSuggestion extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 | 		'productSuggestion' => \Scayle\StorefrontApi\Models\ProductSuggestion::class,
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/VariantsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Variant[] $entities 
 7 |  * @property Pagination $pagination 
 8 |  */
 9 | class VariantsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'pagination' => \Scayle\StorefrontApi\Models\Pagination::class,
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |         'entities' => \Scayle\StorefrontApi\Models\Variant::class,
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "scayle/storefront-api",
 3 |     "description": "SCAYLE Storefront API SDK",
 4 |     "type": "library",
 5 |     "require": {
 6 |       "ext-json": "*",
 7 |         "psr/http-client": "^1.0",
 8 |         "guzzlehttp/guzzle": "^7.0"
 9 |     },
10 |     "require-dev": {
11 |         "phpunit/phpunit": "^9.3",
12 |         "friendsofphp/php-cs-fixer": "^3.13",
13 |         "phpstan/phpstan": "^1.9"
14 |     },
15 |     "autoload": {
16 |         "psr-4": {
17 |             "Scayle\\StorefrontApi\\": "lib/"
18 |         }
19 |     },
20 |     "autoload-dev": {
21 |         "psr-4": {
22 |             "Scayle\\StorefrontApi\\": [
23 |                 "tests/"
24 |             ]
25 |         }
26 |     }
27 | }
28 | 


--------------------------------------------------------------------------------
/lib/Models/ApplicablePromotion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $itemId The Basket Item ID to which the promotion should be applied. This can be null in case of a `bux_x_get_y` effect where the free item is not in the basket yet.
 7 |  * @property Promotion $promotion 
 8 |  */
 9 | class ApplicablePromotion extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 |     ];
17 | 
18 |     protected $collectionClassMap = [
19 |     ];
20 | 
21 |     protected $collection2dClassMap = [
22 |     ];
23 | 
24 | protected $polymorphic = [
25 |     ];
26 | 
27 |     protected $polymorphicCollections = [
28 |     ];
29 | }


--------------------------------------------------------------------------------
/lib/Models/BaseCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $categoryId Unique identifier of the category
 7 |  * @property string $categoryName Name of the category
 8 |  * @property int $categoryParentId Parent ID of the category
 9 |  * @property string $categoryPath Category path as text
10 |  */
11 | class BaseCategory extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/BrandOrCategorySuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array[] $attributeFilters 
 7 |  * @property array $brand 
 8 |  * @property Category $category 
 9 |  * @property string $primaryMatch 
10 |  * @property int $productCount 
11 |  * @property string $suggestion 
12 |  */
13 | class BrandOrCategorySuggestion extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Models/CampaignsResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property Pagination|OffsetPagination $pagination 
 7 |  * @property Campaign[] $entities 
 8 |  */
 9 | class CampaignsResponse extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'pagination' => \Scayle\StorefrontApi\Models\Pagination::class,
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |         'entities' => \Scayle\StorefrontApi\Models\Campaign::class,
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/CustomData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property string $value 
 8 |  * @property string $pricePromotionKey Adjust variant price based on the specified `pricePromotionKey`. If the variant does not have a matching price promotion, the default price is returned.
 9 |  */
10 | class CustomData extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |     ];
21 | 
22 |     protected $collection2dClassMap = [
23 |     ];
24 | 
25 | protected $polymorphic = [
26 |     ];
27 | 
28 |     protected $polymorphicCollections = [
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/Campaign.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $name 
 8 |  * @property string $key 
 9 |  * @property string $description 
10 |  * @property int $reduction 
11 |  * @property array $customData 
12 |  * @property string $start_at 
13 |  * @property string $end_at 
14 |  */
15 | class Campaign extends ApiObject
16 | {
17 |     protected $defaultValues = [
18 |         
19 |     ];
20 | 
21 |     protected $classMap = [
22 |     ];
23 | 
24 |     protected $collectionClassMap = [
25 |     ];
26 | 
27 |     protected $collection2dClassMap = [
28 |     ];
29 | 
30 | protected $polymorphic = [
31 |     ];
32 | 
33 |     protected $polymorphicCollections = [
34 |     ];
35 | }


--------------------------------------------------------------------------------
/lib/Models/TypeaheadBrandOrCategorySuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property BrandOrCategorySuggestion $brandOrCategorySuggestion 
 7 |  * @property float $score 
 8 |  * @property string $type 
 9 |  */
10 | class TypeaheadBrandOrCategorySuggestion extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 | 		'brandOrCategorySuggestion' => \Scayle\StorefrontApi\Models\BrandOrCategorySuggestion::class,
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/Filter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $name 
 8 |  * @property string $slug short text to describe the current category (usable, for example, in URLs as `fashion`).
 9 |  * @property string $attributeGroupType 
10 |  * @property string $type 
11 |  * @property FilterValues $values 
12 |  */
13 | class Filter extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Services/AttributeService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class AttributeService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $groupName
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\Attribute
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function getByKey($groupName)
22 | 	 {
23 |          $combinedOptions = [];
24 | 
25 | 		 return $this->request('get', $this->resolvePath('attributes/%s', $groupName), $combinedOptions, \Scayle\StorefrontApi\Models\Attribute::class);
26 |      }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/Models/Typeahead.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property BrandOrCategorySuggestion|ProductSuggestion $suggestions 
 7 |  * @property BrandOrCategorySuggestion $topMatch 
 8 |  */
 9 | class Typeahead extends ApiObject
10 | {
11 |     protected $defaultValues = [
12 |         
13 |     ];
14 | 
15 |     protected $classMap = [
16 | 		'topMatch' => \Scayle\StorefrontApi\Models\TypeaheadSuggestion::class,
17 |     ];
18 | 
19 |     protected $collectionClassMap = [
20 |         'suggestions' => \Scayle\StorefrontApi\Models\TypeaheadSuggestion::class,
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/BasketItemDisplayData.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property DisplayDataValue $meta 
 7 |  * @property DisplayDataValue $name 
 8 |  * @property DisplayDataValue $identifier 
 9 |  * @property DisplayDataValue $attribute-1 
10 |  * @property DisplayDataValue $attribute-2 
11 |  * @property DisplayDataValue $attribute-3 
12 |  */
13 | class BasketItemDisplayData extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Services/FilterService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class FilterService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\FilterCollection
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function get($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'filters', $combinedOptions, \Scayle\StorefrontApi\Models\FilterCollection::class);
26 |      }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/tests/AttributeTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class AttributeTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetByKey()
10 |     {
11 |         $responseEntity = $this->api->attributes->GetByKey('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('AttributeGetByKeyResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Attribute::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'values', \Scayle\StorefrontApi\Models\AttributeValue::class);
18 | 
19 | 
20 | 
21 |     }
22 | 
23 | }


--------------------------------------------------------------------------------
/lib/Services/RedirectService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class RedirectService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\RedirectsResponse
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function get($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'redirects', $combinedOptions, \Scayle\StorefrontApi\Models\RedirectsResponse::class);
26 |      }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/Services/PromotionService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class PromotionService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\PromotionsResponse
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function get($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'promotions', $combinedOptions, \Scayle\StorefrontApi\Models\PromotionsResponse::class);
26 |      }
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/lib/Models/TypeaheadSuggestion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property BrandOrCategorySuggestion $brandOrCategorySuggestion 
 7 |  * @property float $score 
 8 |  * @property string $type 
 9 |  */
10 | class TypeaheadSuggestion extends ApiObject
11 | {
12 |     protected $defaultValues = [
13 |         
14 |     ];
15 | 
16 |     protected $classMap = [
17 | 		'brandOrCategorySuggestion' => \Scayle\StorefrontApi\Models\BrandOrCategorySuggestion::class,
18 | 		'productSuggestion' => \Scayle\StorefrontApi\Models\ProductSuggestion::class,
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/tests/FilterTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class FilterTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->filters->Get( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('FilterGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\FilterCollection::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 |         foreach ($responseEntity->getEntities() as $collectionEntity) {
20 |             $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Filter::class, $collectionEntity);
21 | 
22 |         }
23 |     }
24 | 
25 | }


--------------------------------------------------------------------------------
/lib/Models/ProductCategory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $categoryId 
 7 |  * @property bool $categoryHidden 
 8 |  * @property string $categoryName 
 9 |  * @property array $categoryProperties 
10 |  * @property array $shopLevelCustomData 
11 |  * @property array $countryLevelCustomData 
12 |  * @property string $categoryUrl 
13 |  * @property string $categorySlug 
14 |  */
15 | class ProductCategory extends ApiObject
16 | {
17 |     protected $defaultValues = [
18 |         
19 |     ];
20 | 
21 |     protected $classMap = [
22 |     ];
23 | 
24 |     protected $collectionClassMap = [
25 |     ];
26 | 
27 |     protected $collection2dClassMap = [
28 |     ];
29 | 
30 | protected $polymorphic = [
31 |     ];
32 | 
33 |     protected $polymorphicCollections = [
34 |     ];
35 | }


--------------------------------------------------------------------------------
/lib/Models/CreateWishlistBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $variantId Variant ID to add to the wishlist.
 7 |  * @property int $productId Product ID to add to the wishlist. When provided, the first found in-stock variant of the product will be added.
 8 |  * @property array<string, CustomData> $customData 
 9 |  * @property int $quantity The quantity for the variant.
10 |  */
11 | class CreateWishlistBody extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         'quantity' => '1',
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/.php_cs.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | $finder = PhpCsFixer\Finder::create()
 4 |     ->in(__DIR__ . '/lib')
 5 |     ->in(__DIR__ . '/tests')
 6 |     ->name('*.php');
 7 | 
 8 | return PhpCsFixer\Config::create()
 9 |     ->setRiskyAllowed(true)
10 |     ->setFinder($finder)
11 |     ->setRules([
12 |         '@PSR2' => true,
13 |         '@PhpCsFixer' => true,
14 |         '@PhpCsFixer:risky' => true,
15 |         '@PHP56Migration:risky' => true,
16 |         '@PHPUnit57Migration:risky' => true,
17 |         'fopen_flags' => true,
18 |         'linebreak_after_opening_tag' => true,
19 |         'native_function_invocation' => true,
20 |         'concat_space' => ['spacing' => 'one'],
21 |         'ordered_class_elements' => false,
22 |         'phpdoc_align' => false,
23 |         'self_accessor' => false,
24 |         'php_unit_test_class_requires_covers' => false
25 |     ]);


--------------------------------------------------------------------------------
/lib/Models/Identifier.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | class Identifier
 6 | {
 7 |     /**
 8 |      * @var string
 9 |      */
10 |     private $identifier;
11 | 
12 |     private function __construct(string $identifier)
13 |     {
14 |         $this->identifier = $identifier;
15 |     }
16 | 
17 |     /**
18 |      * @param int $id
19 |      *
20 |      * @return Identifier
21 |      */
22 |     public static function fromId($id)
23 |     {
24 |         return new self('' . $id);
25 |     }
26 | 
27 |     /**
28 |      * @param string $referenceKey
29 |      *
30 |      * @return Identifier
31 |      */
32 |     public static function fromKey($referenceKey)
33 |     {
34 |         return new self('key=' . $referenceKey);
35 |     }
36 | 
37 |     public function __toString()
38 |     {
39 |         return $this->identifier;
40 |     }
41 | }


--------------------------------------------------------------------------------
/lib/Models/Redirect.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id The unique identifier of the redirect
 7 |  * @property string $source The source URL for the redirect
 8 |  * @property string $target The target URL for the redirect
 9 |  * @property int $statusCode The status code for the redirect
10 |  * @property int $priority The priority for the redirect
11 |  * @property bool $isRegex The flag if the source is a regex
12 |  */
13 | class Redirect extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Models/DisplayDataValue.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key A key identifying which data is displayed here.
 7 | The value is not shown in the Scayle Checkout.
 8 | 
 9 |  * @property string $label The label explaining the value which will be displayed in the Scayle Checkout for the Basket Item.
10 |  * @property string $value The value which will be displayed in the Scayle Checkout for the Basket Item.
11 |  */
12 | class DisplayDataValue extends ApiObject
13 | {
14 |     protected $defaultValues = [
15 |         
16 |     ];
17 | 
18 |     protected $classMap = [
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/lib/Models/CreateBasketItemBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $quantity The quantity for the variant.
 7 |  * @property int $variantId The variant to be added to the basket.
 8 |  * @property string $promotionId An optional promotion ID which should be applied to this item.
 9 |  * @property BasketItemCustomData $customData 
10 |  * @property BasketItemDisplayData $displayData 
11 |  * @property ItemGroup $itemGroup 
12 |  */
13 | class CreateBasketItemBody extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Services/SearchService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class SearchService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $term
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\SearchSuggestions
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function suggestions($term, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 |          $combinedOptions["term"] = $term;
26 | 
27 | 		 return $this->request('get', 'search/suggestions', $combinedOptions, \Scayle\StorefrontApi\Models\SearchSuggestions::class);
28 |      }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Models/LowestPriorPrice.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $withTax The lowest price including tax.
 7 |  * @property float $relativeDifferenceToPrice The relative difference from the lowest prior price to the current price.
 8 | 
 9 | If the value is positive, it means that the current price is higher than the lowest prior price.
10 | If the value is negative, it means that the current price is lower than the lowest prior price.
11 | 
12 |  */
13 | class LowestPriorPrice extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |     ];
24 | 
25 |     protected $collection2dClassMap = [
26 |     ];
27 | 
28 | protected $polymorphic = [
29 |     ];
30 | 
31 |     protected $polymorphicCollections = [
32 |     ];
33 | }


--------------------------------------------------------------------------------
/lib/Models/NavigationItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property array $assets 
 8 |  * @property string $name 
 9 |  * @property string $type 
10 |  * @property string $visibleFrom 
11 |  * @property string $visibleTo 
12 |  * @property array $options 
13 |  * @property NavigationItemExtraFilter $extraFilters 
14 |  * @property Category $category 
15 |  * @property NavigationItem[] $children 
16 |  * @property array $customData 
17 |  */
18 | class NavigationItem extends ApiObject
19 | {
20 |     protected $defaultValues = [
21 |         
22 |     ];
23 | 
24 |     protected $classMap = [
25 |     ];
26 | 
27 |     protected $collectionClassMap = [
28 |     ];
29 | 
30 |     protected $collection2dClassMap = [
31 |     ];
32 | 
33 | protected $polymorphic = [
34 |     ];
35 | 
36 |     protected $polymorphicCollections = [
37 |     ];
38 | }


--------------------------------------------------------------------------------
/lib/Services/VariantService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class VariantService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $variantIds
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\VariantsResponse
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function getByIds($variantIds, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 |          $combinedOptions["ids"] = implode(',', $variantIds);
26 | 
27 | 		 return $this->request('get', 'variants', $combinedOptions, \Scayle\StorefrontApi\Models\VariantsResponse::class);
28 |      }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Models/ShopConfiguration.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $shopId 
 7 |  * @property string $name 
 8 |  * @property array<string, CustomData> $shopCustomData 
 9 |  * @property ShopProperties[] $properties 
10 |  * @property array<string, CustomData> $customData 
11 |  * @property string $country 
12 |  */
13 | class ShopConfiguration extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 | 		'customData' => \Scayle\StorefrontApi\Models\CustomData::class,
21 |     ];
22 | 
23 |     protected $collectionClassMap = [
24 |         'properties' => \Scayle\StorefrontApi\Models\ShopProperties::class,
25 |     ];
26 | 
27 |     protected $collection2dClassMap = [
28 |     ];
29 | 
30 | protected $polymorphic = [
31 |     ];
32 | 
33 |     protected $polymorphicCollections = [
34 |     ];
35 | }


--------------------------------------------------------------------------------
/lib/Services/MatchRedirectService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class MatchRedirectService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param \Scayle\StorefrontApi\Models\MatchRedirectBody $model the model to create or update
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\MatchRedirect
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function match($model, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 | 
26 | 		 return $this->request('post', 'redirects', $combinedOptions, \Scayle\StorefrontApi\Models\MatchRedirect::class, $model);
27 |      }
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/lib/Services/ShopConfigurationService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class ShopConfigurationService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $locale
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\ShopConfiguration
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function get($locale, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 |          $combinedOptions["locale"] = $locale;
26 | 
27 | 		 return $this->request('get', 'shop-configuration', $combinedOptions, \Scayle\StorefrontApi\Models\ShopConfiguration::class);
28 |      }
29 | 
30 | }
31 | 


--------------------------------------------------------------------------------
/lib/Models/Price.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property AppliedReduction[] $appliedReductions 
 7 |  * @property string $currencyCode The currency of the price.
 8 |  * @property array $reference 
 9 |  * @property Tax $tax 
10 |  * @property int $withoutTax 
11 |  * @property int $withTax 
12 |  * @property int $recommendedRetailPrice 
13 |  */
14 | class Price extends ApiObject
15 | {
16 |     protected $defaultValues = [
17 |         
18 |     ];
19 | 
20 |     protected $classMap = [
21 | 		'tax' => \Scayle\StorefrontApi\Models\Tax::class,
22 |     ];
23 | 
24 |     protected $collectionClassMap = [
25 |         'appliedReductions' => \Scayle\StorefrontApi\Models\AppliedReduction::class,
26 |     ];
27 | 
28 |     protected $collection2dClassMap = [
29 |     ];
30 | 
31 | protected $polymorphic = [
32 |     ];
33 | 
34 |     protected $polymorphicCollections = [
35 |     ];
36 | }


--------------------------------------------------------------------------------
/tests/ShopConfigurationTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class ShopConfigurationTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->shopConfigurations->Get('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('ShopConfigurationGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\ShopConfiguration::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'customData', \Scayle\StorefrontApi\Models\CustomData::class);
18 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'properties', \Scayle\StorefrontApi\Models\ShopProperties::class);
19 | 
20 | 
21 | 
22 |     }
23 | 
24 | }


--------------------------------------------------------------------------------
/lib/Services/AbstractServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\AbstractApi;
 6 | 
 7 | abstract class AbstractServiceFactory
 8 | {
 9 |     /**
10 |      * @var array<string, string>
11 |      */
12 |     protected $classMap = [];
13 | 
14 |     /**
15 |      * @var array<string, AbstractService>
16 |      */
17 |     private $services;
18 | 
19 |     /**
20 |      * @var AbstractApi
21 |      */
22 |     private $client;
23 | 
24 |     /**
25 |      * @param AbstractApi $client
26 |      */
27 |     public function __construct($client)
28 |     {
29 |         $this->client = $client;
30 |         $this->services = [];
31 |     }
32 | 
33 |     public function get($name)
34 |     {
35 |         if (!array_key_exists($name, $this->services)) {
36 |             $this->services[$name] = new $this->classMap[$name]($this->client);
37 |         }
38 | 
39 |         return $this->services[$name];
40 |     }
41 | }


--------------------------------------------------------------------------------
/lib/Models/SearchSuggestions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property AttributeValue[] $brands 
 7 |  * @property Category[] $categories 
 8 |  * @property ProductName[] $productNames 
 9 |  * @property Product[] $products 
10 |  */
11 | class SearchSuggestions extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |         'brands' => \Scayle\StorefrontApi\Models\AttributeValue::class,
22 |         'categories' => \Scayle\StorefrontApi\Models\Category::class,
23 |         'productNames' => \Scayle\StorefrontApi\Models\ProductName::class,
24 |         'products' => \Scayle\StorefrontApi\Models\Product::class,
25 |     ];
26 | 
27 |     protected $collection2dClassMap = [
28 |     ];
29 | 
30 | protected $polymorphic = [
31 |     ];
32 | 
33 |     protected $polymorphicCollections = [
34 |     ];
35 | }


--------------------------------------------------------------------------------
/lib/Services/TypeaheadService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class TypeaheadService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $term
16 | 	 * @param \Scayle\StorefrontApi\Models\TypeaheadBody $model the model to create or update
17 | 	 * @param array $options additional options like limit or filters
18 | 	 *
19 | 	 * @return \Scayle\StorefrontApi\Models\Typeahead
20 |      * @throws ClientExceptionInterface
21 |      * @throws ApiErrorException
22 | 	 */
23 | 	 public function postSuggestions($term, $model, $options = [])
24 | 	 {
25 |          $combinedOptions = $options;
26 |          $combinedOptions["term"] = $term;
27 | 
28 | 		 return $this->request('post', 'typeahead', $combinedOptions, \Scayle\StorefrontApi\Models\Typeahead::class, $model);
29 |      }
30 | 
31 | }
32 | 


--------------------------------------------------------------------------------
/tests/MatchRedirectTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class MatchRedirectTest extends BaseApiTestCase
 8 | {
 9 |     public function testMatch()
10 |     {
11 |         $expectedRequestJson = $this->loadFixture('MatchRedirectMatchRequest.json');
12 | 
13 |         $requestEntity = new \Scayle\StorefrontApi\Models\MatchRedirectBody($expectedRequestJson);
14 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedRequestJson), $requestEntity->toJson());
15 | 
16 |         $responseEntity = $this->api->matchRedirects->Match($requestEntity,  []);
17 | 
18 |         $expectedResponseJson = $this->loadFixture('MatchRedirectMatchResponse.json');
19 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\MatchRedirect::class, $responseEntity);
20 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
21 | 
22 | 
23 | 
24 | 
25 |     }
26 | 
27 | }


--------------------------------------------------------------------------------
/lib/Models/UpdateBasketItemBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $quantity The updated quantity for the basket item.
 7 |  * @property string $promotionId Updates the promotion id of the item.
 8 | 
 9 | If the 'promotionId' property is not sent in the request no update is performed on the field.
10 | if the value is null then any previous applied promotion will be removed from the item.
11 | 
12 |  * @property BasketItemCustomData $customData 
13 |  * @property BasketItemDisplayData $displayData 
14 |  * @property ItemGroup $itemGroup 
15 |  */
16 | class UpdateBasketItemBody extends ApiObject
17 | {
18 |     protected $defaultValues = [
19 |         
20 |     ];
21 | 
22 |     protected $classMap = [
23 |     ];
24 | 
25 |     protected $collectionClassMap = [
26 |     ];
27 | 
28 |     protected $collection2dClassMap = [
29 |     ];
30 | 
31 | protected $polymorphic = [
32 |     ];
33 | 
34 |     protected $polymorphicCollections = [
35 |     ];
36 | }


--------------------------------------------------------------------------------
/lib/Exceptions/ApiError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Exceptions;
 4 | 
 5 | class ApiError
 6 | {
 7 |     /**
 8 |      * @var string
 9 |      */
10 |     private $errorKey;
11 | 
12 |     /**
13 |      * @var string
14 |      */
15 |     private $message;
16 | 
17 |     /**
18 |      * @var array
19 |      */
20 |     private $context;
21 | 
22 |     public function __construct($errorKey, $message, $context)
23 |     {
24 |         $this->errorKey = $errorKey;
25 |         $this->message = $message;
26 |         $this->context = $context;
27 |     }
28 | 
29 |     /**
30 |      * @return string
31 |      */
32 |     public function getErrorKey()
33 |     {
34 |         return $this->errorKey;
35 |     }
36 | 
37 |     /**
38 |      * @return string
39 |      */
40 |     public function getMessage()
41 |     {
42 |         return $this->message;
43 |     }
44 | 
45 |     /**
46 |      * @return array
47 |      */
48 |     public function getContext()
49 |     {
50 |         return $this->context;
51 |     }
52 | }


--------------------------------------------------------------------------------
/lib/Models/WishlistItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key 
 7 |  * @property int $packageId 
 8 |  * @property int $quantity 
 9 |  * @property string $status 
10 |  * @property Product $product 
11 |  * @property Variant $variant 
12 |  * @property int $productId 
13 |  * @property string $masterKey 
14 |  * @property int $variantId 
15 |  * @property array<string, CustomData> $customData 
16 |  */
17 | class WishlistItem extends ApiObject
18 | {
19 |     protected $defaultValues = [
20 |         
21 |     ];
22 | 
23 |     protected $classMap = [
24 | 		'product' => \Scayle\StorefrontApi\Models\Product::class,
25 | 		'variant' => \Scayle\StorefrontApi\Models\Variant::class,
26 | 		'customData' => \Scayle\StorefrontApi\Models\CustomData::class,
27 |     ];
28 | 
29 |     protected $collectionClassMap = [
30 |     ];
31 | 
32 |     protected $collection2dClassMap = [
33 |     ];
34 | 
35 | protected $polymorphic = [
36 |     ];
37 | 
38 |     protected $polymorphicCollections = [
39 |     ];
40 | }


--------------------------------------------------------------------------------
/lib/Models/TypeaheadRequestBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string|int $fuzziness The fuzziness parameter can enable some typo tolerance. Available values are 0, 1, 2, and auto. Defaults to auto. Note: The value set in the SCAYLE Panel will not impact this search.
 7 |  * @property int $categoryId The `categoryId` parameter can filter by category ID.
 8 |  * @property int $limit The `limit` parameter allows limiting the number of suggested products returned.
 9 |  * @property string $term The `term` parameter allows you to query for any entity with a full or partial match with the given term.
10 |  */
11 | class TypeaheadRequestBody extends ApiObject
12 | {
13 |     protected $defaultValues = [
14 |         
15 |     ];
16 | 
17 |     protected $classMap = [
18 |     ];
19 | 
20 |     protected $collectionClassMap = [
21 |     ];
22 | 
23 |     protected $collection2dClassMap = [
24 |     ];
25 | 
26 | protected $polymorphic = [
27 |     ];
28 | 
29 |     protected $polymorphicCollections = [
30 |     ];
31 | }


--------------------------------------------------------------------------------
/lib/Models/Attribute.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property string $key Reference that identifies the attribute
 8 |  * @property string $label The label that describes the attribute group will be set according to the shop's language in the SCAYLE Panel.
 9 |  * @property bool $multiSelect A flag which determines whether an attribute has a single or possibly multiple values.
10 |  * @property string $type Attribute type
11 |  * @property AttributeValue[] $values The values are a collection of attributes from the attribute group.
12 |  */
13 | class Attribute extends ApiObject
14 | {
15 |     protected $defaultValues = [
16 |         
17 |     ];
18 | 
19 |     protected $classMap = [
20 |     ];
21 | 
22 |     protected $collectionClassMap = [
23 |         'values' => \Scayle\StorefrontApi\Models\AttributeValue::class,
24 |     ];
25 | 
26 |     protected $collection2dClassMap = [
27 |     ];
28 | 
29 | protected $polymorphic = [
30 |     ];
31 | 
32 |     protected $polymorphicCollections = [
33 |     ];
34 | }


--------------------------------------------------------------------------------
/tests/CampaignTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class CampaignTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetAll()
10 |     {
11 |         $responseEntity = $this->api->campaigns->GetAll( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('CampaignGetAllResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\CampaignsResponse::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 | 
20 |     }
21 | 
22 |     public function testGetById()
23 |     {
24 |         $responseEntity = $this->api->campaigns->GetById('1',  []);
25 | 
26 |         $expectedResponseJson = $this->loadFixture('CampaignGetByIdResponse.json');
27 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Campaign::class, $responseEntity);
28 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
29 | 
30 | 
31 | 
32 | 
33 |     }
34 | 
35 | }


--------------------------------------------------------------------------------
/lib/Models/Promotion.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $id The unique identifier of the promotion
 7 |  * @property string $name Promotion name
 8 |  * @property array $schedule Promotion's initial and end date, formatted according to RFC 3339.
 9 |  * @property bool $isActive Promotion's status
10 |  * @property AutomaticDiscountEffect|BuyXGetYEffect $effect 
11 |  * @property Condition[] $conditions Promotion's conditions
12 |  * @property array $customData Promotion's custom data
13 |  * @property float $priority The priority of the promotion compared to other promotions.
14 | This can be used to decide which promotion to apply if there is a conflict between two.
15 | 
16 |  * @property Tier[] $tiers 
17 |  */
18 | class Promotion extends ApiObject
19 | {
20 |     protected $defaultValues = [
21 |         
22 |     ];
23 | 
24 |     protected $classMap = [
25 |     ];
26 | 
27 |     protected $collectionClassMap = [
28 |     ];
29 | 
30 |     protected $collection2dClassMap = [
31 |     ];
32 | 
33 | protected $polymorphic = [
34 |     ];
35 | 
36 |     protected $polymorphicCollections = [
37 |     ];
38 | }


--------------------------------------------------------------------------------
/lib/Models/TypeaheadBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $fuzziness The fuzziness parameter can enable some typo tolerance. Available values are 0, 1, 2, and auto. Defaults to auto. Note: The value set in the SCAYLE Panel will not impact this search.
 7 |  * @property int[] $likedBrands The `likedBrands` parameter can boost and adjust results by matching the given brand IDs.
 8 |  * @property int $categoryId The `categoryId` parameter can filter by category ID.
 9 |  * @property int $limit The `limit` parameter allows limiting the number of suggested products returned.
10 |  * @property string $term The `term` parameter allows you to query for any entity with a full or partial match with the given term.
11 |  */
12 | class TypeaheadBody extends ApiObject
13 | {
14 |     protected $defaultValues = [
15 |         
16 |     ];
17 | 
18 |     protected $classMap = [
19 |     ];
20 | 
21 |     protected $collectionClassMap = [
22 |     ];
23 | 
24 |     protected $collection2dClassMap = [
25 |     ];
26 | 
27 | protected $polymorphic = [
28 |     ];
29 | 
30 |     protected $polymorphicCollections = [
31 |     ];
32 | }


--------------------------------------------------------------------------------
/tests/VariantTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class VariantTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetByIds()
10 |     {
11 |         $responseEntity = $this->api->variants->GetByIds('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('VariantGetByIdsResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\VariantsResponse::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'attributes', \Scayle\StorefrontApi\Models\Attribute::class);
18 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'advancedAttributes', \Scayle\StorefrontApi\Models\AdvancedAttribute::class);
19 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'price', \Scayle\StorefrontApi\Models\Price::class);
20 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'stock', \Scayle\StorefrontApi\Models\Stock::class);
21 | 
22 | 
23 | 
24 |     }
25 | 
26 | }


--------------------------------------------------------------------------------
/tests/fixtures/BrandGetResponse.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "entities": [
 3 |         {
 4 |             "id": 21,
 5 |             "name": "About You",
 6 |             "slug": "aboutyou",
 7 |             "group": "default",
 8 |             "isActive": true,
 9 |             "logoHash": "01dfae6e5d4d90d9892622325959afbe",
10 |             "createdAt": "2019-04-17 16:05:36",
11 |             "updatedAt": "2019-04-17 16:05:36",
12 |             "indexedAt": "2023-04-26 16:05:36"
13 |         },
14 |         {
15 |             "id": 22,
16 |             "name": "Edited",
17 |             "slug": "edited",
18 |             "group": "default",
19 |             "externalReference": "0815",
20 |             "isActive": true,
21 |             "logoHash": "8743b52063cd84097a65d1633f5c74f5",
22 |             "createdAt": "2019-04-17 16:05:36",
23 |             "updatedAt": "2019-04-17 16:05:36",
24 |             "indexedAt": "2023-04-26 16:05:36"
25 |         }
26 |     ],
27 |     "pagination": {
28 |         "current": 2,
29 |         "first": 1,
30 |         "last": 49,
31 |         "next": 2,
32 |         "page": 1,
33 |         "perPage": 2,
34 |         "prev": 1,
35 |         "total": 4879
36 |     }
37 | }


--------------------------------------------------------------------------------
/lib/Models/ItemGroup.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $id A unique identifier for the item group which should be used for all basket items of the item group.
 7 | 
 8 | Any string based identifier can be chosen and it only has to be unique within the current basket.
 9 | 
10 |  * @property bool $isMainItem Whether or not the current item is the main item within the item group.
11 | This property can be used for display purposes to only show the main item within the Checkout.
12 | 
13 |  * @property bool $isRequired Whether or not the item is required to be present for the item group.
14 | When you delete an item from your basket which is required for the item group, all other items assigned to the item group will also be deleted.
15 | 
16 |  */
17 | class ItemGroup extends ApiObject
18 | {
19 |     protected $defaultValues = [
20 |         
21 |     ];
22 | 
23 |     protected $classMap = [
24 |     ];
25 | 
26 |     protected $collectionClassMap = [
27 |     ];
28 | 
29 |     protected $collection2dClassMap = [
30 |     ];
31 | 
32 | protected $polymorphic = [
33 |     ];
34 | 
35 |     protected $polymorphicCollections = [
36 |     ];
37 | }


--------------------------------------------------------------------------------
/lib/Services/NavigationService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class NavigationService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 *
16 | 	 * @return \Scayle\StorefrontApi\Models\NavigationTreeCollection
17 |      * @throws ClientExceptionInterface
18 |      * @throws ApiErrorException
19 | 	 */
20 | 	 public function getAll()
21 | 	 {
22 |          $combinedOptions = [];
23 | 
24 | 		 return $this->request('get', 'navigation/trees', $combinedOptions, \Scayle\StorefrontApi\Models\NavigationTreeCollection::class);
25 |      }
26 | 
27 | 	/**
28 | 	 * Description
29 | 	 *
30 | 	 * @param int $navigationTreeId
31 | 	 *
32 | 	 * @return \Scayle\StorefrontApi\Models\NavigationTree
33 |      * @throws ClientExceptionInterface
34 |      * @throws ApiErrorException
35 | 	 */
36 | 	 public function getById($navigationTreeId)
37 | 	 {
38 |          $combinedOptions = [];
39 | 
40 | 		 return $this->request('get', $this->resolvePath('navigation/trees/%s', $navigationTreeId), $combinedOptions, \Scayle\StorefrontApi\Models\NavigationTree::class);
41 |      }
42 | 
43 | }
44 | 


--------------------------------------------------------------------------------
/lib/Services/CampaignService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class CampaignService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\CampaignsResponse
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function getAll($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'campaigns', $combinedOptions, \Scayle\StorefrontApi\Models\CampaignsResponse::class);
26 |      }
27 | 
28 | 	/**
29 | 	 * Description
30 | 	 *
31 | 	 * @param int $campaignId
32 | 	 *
33 | 	 * @return \Scayle\StorefrontApi\Models\Campaign
34 |      * @throws ClientExceptionInterface
35 |      * @throws ApiErrorException
36 | 	 */
37 | 	 public function getById($campaignId)
38 | 	 {
39 |          $combinedOptions = [];
40 | 
41 | 		 return $this->request('get', $this->resolvePath('campaigns/%s', $campaignId), $combinedOptions, \Scayle\StorefrontApi\Models\Campaign::class);
42 |      }
43 | 
44 | }
45 | 


--------------------------------------------------------------------------------
/tests/TypeaheadTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class TypeaheadTest extends BaseApiTestCase
 8 | {
 9 |     public function testPostSuggestions()
10 |     {
11 |         $expectedRequestJson = $this->loadFixture('TypeaheadPostSuggestionsRequest.json');
12 | 
13 |         $requestEntity = new \Scayle\StorefrontApi\Models\TypeaheadBody($expectedRequestJson);
14 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedRequestJson), $requestEntity->toJson());
15 | 
16 |         $responseEntity = $this->api->typeaheads->PostSuggestions('1', $requestEntity,  []);
17 | 
18 |         $expectedResponseJson = $this->loadFixture('TypeaheadPostSuggestionsResponse.json');
19 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Typeahead::class, $responseEntity);
20 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
21 | 
22 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'suggestions', \Scayle\StorefrontApi\Models\TypeaheadSuggestion::class);
23 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'topMatch', \Scayle\StorefrontApi\Models\TypeaheadSuggestion::class);
24 | 
25 | 
26 | 
27 |     }
28 | 
29 | }


--------------------------------------------------------------------------------
/lib/Models/CreateBasketBody.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property array $customData For each item, you can add an additional custom data array. This will not change the API behavior. The data will remain attached to the basket item and you may retrieve it at any time during or after the checkout and order process.
 7 | 
 8 |  * @property array $displayData Custom basket item properties for display during SCAYLE  checkout and order process can be set with displayData.
 9 |  * @property int $quantity The quantity for the variant.
10 | 
11 |  * @property int $shopId If you are operating multiple shops (for example, for different domain names or different languages), each shop is identified by its specific `shopId`.
12 | 
13 |  * @property int $variantId The variant to be added to the basket. This is the only required parameter.
14 |  * @property array $itemGroup 
15 |  */
16 | class CreateBasketBody extends ApiObject
17 | {
18 |     protected $defaultValues = [
19 |         
20 |     ];
21 | 
22 |     protected $classMap = [
23 |     ];
24 | 
25 |     protected $collectionClassMap = [
26 |     ];
27 | 
28 |     protected $collection2dClassMap = [
29 |     ];
30 | 
31 | protected $polymorphic = [
32 |     ];
33 | 
34 |     protected $polymorphicCollections = [
35 |     ];
36 | }


--------------------------------------------------------------------------------
/tests/NavigationTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class NavigationTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetAll()
10 |     {
11 |         $responseEntity = $this->api->navigations->GetAll( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('NavigationGetAllResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\NavigationTreeCollection::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 |         foreach ($responseEntity->getEntities() as $collectionEntity) {
20 |             $this->assertInstanceOf(\Scayle\StorefrontApi\Models\NavigationTree::class, $collectionEntity);
21 | 
22 |         }
23 |     }
24 | 
25 |     public function testGetById()
26 |     {
27 |         $responseEntity = $this->api->navigations->GetById('1',  []);
28 | 
29 |         $expectedResponseJson = $this->loadFixture('NavigationGetByIdResponse.json');
30 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\NavigationTree::class, $responseEntity);
31 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
32 | 
33 | 
34 | 
35 | 
36 |     }
37 | 
38 | }


--------------------------------------------------------------------------------
/lib/Services/BrandService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class BrandService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\BrandsResponse
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function get($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'brands', $combinedOptions, \Scayle\StorefrontApi\Models\BrandsResponse::class);
26 |      }
27 | 
28 | 	/**
29 | 	 * Description
30 | 	 *
31 | 	 * @param int $brandId
32 | 	 * @param array $options additional options like limit or filters
33 | 	 *
34 | 	 * @return \Scayle\StorefrontApi\Models\BrandsResponse
35 |      * @throws ClientExceptionInterface
36 |      * @throws ApiErrorException
37 | 	 */
38 | 	 public function getById($brandId, $options = [])
39 | 	 {
40 |          $combinedOptions = $options;
41 | 
42 | 		 return $this->request('get', $this->resolvePath('brands/%s', $brandId), $combinedOptions, \Scayle\StorefrontApi\Models\BrandsResponse::class);
43 |      }
44 | 
45 | }
46 | 


--------------------------------------------------------------------------------
/tests/BrandTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class BrandTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->brands->Get( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('BrandGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\BrandsResponse::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'customData', \Scayle\StorefrontApi\Models\CustomData::class);
18 | 
19 | 
20 | 
21 |     }
22 | 
23 |     public function testGetById()
24 |     {
25 |         $responseEntity = $this->api->brands->GetById('1',  []);
26 | 
27 |         $expectedResponseJson = $this->loadFixture('BrandGetByIdResponse.json');
28 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\BrandsResponse::class, $responseEntity);
29 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
30 | 
31 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'customData', \Scayle\StorefrontApi\Models\CustomData::class);
32 | 
33 | 
34 | 
35 |     }
36 | 
37 | }


--------------------------------------------------------------------------------
/lib/Services/ProductService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class ProductService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param int $productId
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\Product
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function getById($productId, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 | 
26 | 		 return $this->request('get', $this->resolvePath('products/%s', $productId), $combinedOptions, \Scayle\StorefrontApi\Models\Product::class);
27 |      }
28 | 
29 | 	/**
30 | 	 * Description
31 | 	 *
32 | 	 * @param array $options additional options like limit or filters
33 | 	 *
34 | 	 * @return \Scayle\StorefrontApi\Models\ProductsResponse
35 |      * @throws ClientExceptionInterface
36 |      * @throws ApiErrorException
37 | 	 */
38 | 	 public function query($options = [])
39 | 	 {
40 |          $combinedOptions = $options;
41 | 
42 | 		 return $this->request('get', 'products', $combinedOptions, \Scayle\StorefrontApi\Models\ProductsResponse::class);
43 |      }
44 | 
45 | }
46 | 


--------------------------------------------------------------------------------
/lib/Models/Variant.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property array<string, AdvancedAttribute> $advancedAttributes 
 8 |  * @property string $appliedPricePromotionKey 
 9 |  * @property array<string, Attribute> $attributes 
10 |  * @property LowestPriorPrice $lowestPriorPrice 
11 |  * @property Price $price 
12 |  * @property int $productId 
13 |  * @property string $referenceKey 
14 |  * @property Timestamp $firstLiveAt 
15 |  * @property Stock $stock 
16 |  * @property array<string, CustomData> $customData 
17 |  * @property Merchant $merchant 
18 |  * @property Timestamp $createdAt 
19 |  * @property Timestamp $updatedAt 
20 |  */
21 | class Variant extends ApiObject
22 | {
23 |     protected $defaultValues = [
24 |         
25 |     ];
26 | 
27 |     protected $classMap = [
28 | 		'price' => \Scayle\StorefrontApi\Models\Price::class,
29 | 		'stock' => \Scayle\StorefrontApi\Models\Stock::class,
30 |     ];
31 | 
32 |     protected $collectionClassMap = [
33 |         'attributes' => \Scayle\StorefrontApi\Models\Attribute::class,
34 |         'advancedAttributes' => \Scayle\StorefrontApi\Models\AdvancedAttribute::class,
35 |     ];
36 | 
37 |     protected $collection2dClassMap = [
38 |     ];
39 | 
40 | protected $polymorphic = [
41 |     ];
42 | 
43 |     protected $polymorphicCollections = [
44 |     ];
45 | }


--------------------------------------------------------------------------------
/lib/Models/Brand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id The unique identifier of the brand (referred as `attributeId`), can be used for retrieving specific brand. ID which would be used to filter for brands in the `products` and `filters` endpoint
 7 |  * @property string $slug short text to describe the current category (usable, for example, in URLs as `fashion`).
 8 |  * @property string $name 
 9 |  * @property BrandCustomData $customData 
10 |  * @property string $externalReference External reference set by the client to integrate a third-party party system.
11 |  * @property string $group Brand group.
12 |  * @property bool $isActive Whether the brand is currently active or not.
13 |  * @property string $logoHash Logo hash used for generating the full url.
14 |  * @property Timestamp $createdAt 
15 |  * @property Timestamp $updatedAt 
16 |  * @property Timestamp $indexedAt 
17 |  */
18 | class Brand extends ApiObject
19 | {
20 |     protected $defaultValues = [
21 |         
22 |     ];
23 | 
24 |     protected $classMap = [
25 |     ];
26 | 
27 |     protected $collectionClassMap = [
28 |         'customData' => \Scayle\StorefrontApi\Models\CustomData::class,
29 |     ];
30 | 
31 |     protected $collection2dClassMap = [
32 |     ];
33 | 
34 | protected $polymorphic = [
35 |     ];
36 | 
37 |     protected $polymorphicCollections = [
38 |     ];
39 | }


--------------------------------------------------------------------------------
/lib/Services/ServiceFactory.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | /**
 6 |  * Factory to create API services
 7 |  */
 8 | class ServiceFactory extends AbstractServiceFactory
 9 | {
10 | 	/**
11 | 	 * @var array<string, string>
12 |      */
13 |     protected $classMap = [
14 |         'baskets' => \Scayle\StorefrontApi\Services\BasketService::class,
15 |         'attributes' => \Scayle\StorefrontApi\Services\AttributeService::class,
16 |         'brands' => \Scayle\StorefrontApi\Services\BrandService::class,
17 |         'categories' => \Scayle\StorefrontApi\Services\CategoryService::class,
18 |         'filters' => \Scayle\StorefrontApi\Services\FilterService::class,
19 |         'typeahead' => \Scayle\StorefrontApi\Services\TypeaheadService::class,
20 |         'campaign' => \Scayle\StorefrontApi\Services\CampaignService::class,
21 |         'navigation' => \Scayle\StorefrontApi\Services\NavigationService::class,
22 |         'products' => \Scayle\StorefrontApi\Services\ProductService::class,
23 |         'shopConfigurations' => \Scayle\StorefrontApi\Services\ShopConfigurationService::class,
24 |         'variants' => \Scayle\StorefrontApi\Services\VariantService::class,
25 |         'wishlists' => \Scayle\StorefrontApi\Services\WishlistService::class,
26 |         'redirects' => \Scayle\StorefrontApi\Services\RedirectService::class,
27 |         'matchRedirects' => \Scayle\StorefrontApi\Services\MatchRedirectService::class,
28 |         'promotions' => \Scayle\StorefrontApi\Services\PromotionService::class,
29 |     ];
30 | }


--------------------------------------------------------------------------------
/lib/Models/BasketItem.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property string $key A unique key for the basket item which can be used for updating or deleting it.
 7 |  * @property int $packageId The package in which the basket item will be send.
 8 | 
 9 | Corresponds to a package id in the `packages` list of a `Basket`.
10 | 
11 |  * @property int $quantity The quantity of the item.
12 |  * @property int $availableQuantity The total available quantity for the variant which can be added to the basket.
13 |  * @property string $status The status of the basket item, either it is 'available' which means in stock
14 | or it's unavailable meaning it's out of stock.
15 | 
16 |  * @property Variant $variant 
17 |  * @property Product $product 
18 |  * @property BasketItemPrice $price 
19 |  * @property LowestPriorPrice $lowestPriorPrice 
20 |  * @property string $promotionId The promotion which will be applied to the item.
21 |  * @property ItemGroup $itemGroup 
22 |  * @property BasketItemCustomData $customData 
23 |  * @property BasketItemDisplayData $displayData 
24 |  * @property DeliveryForecast $deliveryForecast 
25 |  * @property BasketItemPromotion $promotion 
26 |  */
27 | class BasketItem extends ApiObject
28 | {
29 |     protected $defaultValues = [
30 |         
31 |     ];
32 | 
33 |     protected $classMap = [
34 |     ];
35 | 
36 |     protected $collectionClassMap = [
37 |     ];
38 | 
39 |     protected $collection2dClassMap = [
40 |     ];
41 | 
42 | protected $polymorphic = [
43 |     ];
44 | 
45 |     protected $polymorphicCollections = [
46 |     ];
47 | }


--------------------------------------------------------------------------------
/lib/StorefrontClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Services\ServiceFactory;
 6 | 
 7 | /**
 8 |  * Allows access to AdminApi functions.
 9 |  *
10 |  * @property \Scayle\StorefrontApi\Services\BasketService $baskets
11 |  * @property \Scayle\StorefrontApi\Services\AttributeService $attributes
12 |  * @property \Scayle\StorefrontApi\Services\BrandService $brands
13 |  * @property \Scayle\StorefrontApi\Services\CategoryService $categories
14 |  * @property \Scayle\StorefrontApi\Services\FilterService $filters
15 |  * @property \Scayle\StorefrontApi\Services\TypeaheadService $typeahead
16 |  * @property \Scayle\StorefrontApi\Services\CampaignService $campaign
17 |  * @property \Scayle\StorefrontApi\Services\NavigationService $navigation
18 |  * @property \Scayle\StorefrontApi\Services\ProductService $products
19 |  * @property \Scayle\StorefrontApi\Services\ShopConfigurationService $shopConfigurations
20 |  * @property \Scayle\StorefrontApi\Services\VariantService $variants
21 |  * @property \Scayle\StorefrontApi\Services\WishlistService $wishlists
22 |  * @property \Scayle\StorefrontApi\Services\RedirectService $redirects
23 |  * @property \Scayle\StorefrontApi\Services\MatchRedirectService $matchRedirects
24 |  * @property \Scayle\StorefrontApi\Services\PromotionService $promotions
25 |  */
26 | class StorefrontClient extends AbstractApi
27 | {
28 | 	/**
29 | 	 * @var ServiceFactory $serviceFactory
30 | 	 */
31 | 	private $serviceFactory;
32 | 
33 | 	public function __get($name)
34 | 	{
35 | 		if ($this->serviceFactory === null) {
36 |             $this->serviceFactory = new ServiceFactory($this);
37 |         }
38 | 
39 |         return $this->serviceFactory->get($name);
40 |     }
41 | }


--------------------------------------------------------------------------------
/lib/Exceptions/ApiErrorException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Exceptions;
 4 | 
 5 | use Throwable;
 6 | 
 7 | class ApiErrorException extends \Exception
 8 | {
 9 |     /**
10 |      * @var ApiError[]
11 |      */
12 |     private $errors = [];
13 | 
14 |     /**
15 |      * @var int
16 |      */
17 |     private $statusCode;
18 | 
19 |     /**
20 |      * @param array $responseErrors
21 |      * @param int $statusCode
22 |      */
23 |     public function __construct($responseErrors, $statusCode)
24 |     {
25 |         $this->statusCode = $statusCode;
26 |         $this->errors = $this->parseErrors($responseErrors);
27 |         parent::__construct("Errors occured while handling the API request ", $statusCode);
28 |     }
29 | 
30 |     /**
31 |      * @return ApiError|null
32 |      */
33 |     public function getFirstError()
34 |     {
35 |         return empty($this->errors) ? null : $this->errors[0];
36 |     }
37 | 
38 |     /**
39 |      * @return ApiError[]
40 |      */
41 |     public function getErrors()
42 |     {
43 |         return $this->errors;
44 |     }
45 | 
46 |     /**
47 |      * @return int
48 |      */
49 |     public function getStatusCode()
50 |     {
51 |         return $this->statusCode;
52 |     }
53 | 
54 |     /**
55 |      * @param array $errors
56 |      * @return ApiError[]
57 |      */
58 |     private function parseErrors($errors)
59 |     {
60 |         $adminApiErrors = [];
61 | 
62 |         if (array_key_exists('errors', $errors)) {
63 |             foreach ($errors['errors'] as $error) {
64 |                 $adminApiErrors[] = new ApiError($error['errorKey'], $error['message'], $error['context']);
65 |             }
66 |         } else {
67 |             $code = $errors['code'] ?? $this->getStatusCode();
68 |             $adminApiErrors[] = new ApiError($code, $errors['message'] ?? '', '');
69 |         }
70 | 
71 | 
72 |         return $adminApiErrors;
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/.gitlab-ci.yml:
--------------------------------------------------------------------------------
 1 | workflow:
 2 |   rules:
 3 |     - if: $CI_PIPELINE_SOURCE == "pipeline" && $API_COMMIT_SHA
 4 |     - if: $CI_PIPELINE_SOURCE == "web" && $API_COMMIT_SHA
 5 | 
 6 | default:
 7 |   image: docker:20
 8 |   services:
 9 |     - name: docker:dind
10 |       command: ["--tls=false"]
11 |   tags:
12 |     - ay-shared-runner
13 |   before_script:
14 |     # Configure docker to also use our auth config for building the docker image
15 |     # https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#option-3-use-docker_auth_config
16 |     - mkdir -p $HOME/.docker
17 |     - echo $DOCKER_AUTH_CONFIG > $HOME/.docker/config.json
18 | 
19 |     - apk add --no-cache curl git
20 | 
21 |     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
22 |     - docker pull $CI_REGISTRY/aboutyou/scayle/core-engine/storefront-unit/storefront-api/sdks/generator:latest
23 | 
24 | stages:
25 |   - build
26 | 
27 | Build SDK:
28 |   stage: build
29 |   script:
30 |     - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@gitlab.com/aboutyou/scayle/core-engine/storefront-unit/storefront-api/storefront-api.git .api
31 |     - cd .api
32 |     - git checkout $API_COMMIT_SHA
33 |     - cd ..
34 | 
35 |     - echo "Initializing Git"
36 |     - git config user.name $SDK_AUTOMATION_USER
37 |     - git config user.email $SDK_AUTOMATION_EMAIL
38 |     - git remote set-url origin https://$SDK_AUTOMATION_USER:$SDK_AUTOMATION_TOKEN@gitlab.com/${CI_PROJECT_PATH}.git
39 | 
40 |     - git checkout -b chore/update-sdk-$API_COMMIT_SHA
41 | 
42 |     - cp .api/http/docs/swagger.yaml swagger.yaml
43 |     - docker run 
44 |         --rm 
45 |         -v "$(pwd)":/gen/out/php
46 |         -v "$(pwd)/swagger.yaml":/gen/swagger.yaml 
47 |         $CI_REGISTRY/aboutyou/scayle/core-engine/storefront-unit/storefront-api/sdks/generator:latest
48 |         php ./src/CodeGen.php generate php-storefront swagger.yaml
49 | 
50 |     - git add .
51 |     - 'git commit -m "chore: Upgrade to $API_COMMIT_SHA"'
52 |     - git push -o merge_request.create --set-upstream origin chore/update-sdk-$API_COMMIT_SHA
53 | 


--------------------------------------------------------------------------------
/lib/Models/Category.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id The unique identifier of the category.
 7 |  * @property string $path The slugs for all `rootlineIds` combined with `/` (e.g., `/women/fashion`).
 8 |  * @property string $name The name of the category
 9 |  * @property string $slug A short string to describe the current category (usable, for example, in URLs as).
10 |  * @property int $parentId The parent category ID (root-level categories have a parent ID of `0`)
11 |  * @property int[] $rootlineIds The IDs for the path from the topmost root category to the current category, which is included as the last item.
12 |  * @property int[] $childrenIds The child category IDs attached to the current category
13 |  * @property CategoryProperty[] $properties Properties attached to this category.
14 |  * @property bool $isHidden A flag that defines if a category should be displayed by the frontend
15 |  * @property int $depth The nesting level of the category (root-level depth = 1, child nodes = 2, child nodes' children = 3, etc.)
16 |  * @property string[] $supportedFilter A list of filters that can be used for filtering products in the category
17 |  * @property mixed $parent 
18 |  * @property array $shopLevelCustomData Additional category data defined on the shop level
19 |  * @property array $countryLevelCustomData Additional category data defined on the country level
20 |  * @property Category[] $children An array of child category objects.
21 | Returned if requested as `tree format` or using `with`.
22 | 
23 |  */
24 | class Category extends ApiObject
25 | {
26 |     protected $defaultValues = [
27 |         
28 |     ];
29 | 
30 |     protected $classMap = [
31 | 		'parent' => \Scayle\StorefrontApi\Models\Category::class,
32 |     ];
33 | 
34 |     protected $collectionClassMap = [
35 |         'children' => \Scayle\StorefrontApi\Models\Category::class,
36 |     ];
37 | 
38 |     protected $collection2dClassMap = [
39 |     ];
40 | 
41 | protected $polymorphic = [
42 |     ];
43 | 
44 |     protected $polymorphicCollections = [
45 |     ];
46 | }


--------------------------------------------------------------------------------
/lib/Services/WishlistService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class WishlistService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $wishlistId
16 | 	 * @param \Scayle\StorefrontApi\Models\CreateWishlistBody $model the model to create or update
17 | 	 * @param array $options additional options like limit or filters
18 | 	 *
19 | 	 * @return \Scayle\StorefrontApi\Models\Wishlist
20 |      * @throws ClientExceptionInterface
21 |      * @throws ApiErrorException
22 | 	 */
23 | 	 public function addItem($wishlistId, $model, $options = [])
24 | 	 {
25 |          $combinedOptions = $options;
26 | 
27 | 		 return $this->request('post', $this->resolvePath('wishlists/%s/items', $wishlistId), $combinedOptions, \Scayle\StorefrontApi\Models\Wishlist::class, $model);
28 |      }
29 | 
30 | 	/**
31 | 	 * Description
32 | 	 *
33 | 	 * @param string $wishlistId
34 | 	 * @param array $options additional options like limit or filters
35 | 	 *
36 | 	 * @return \Scayle\StorefrontApi\Models\Wishlist
37 |      * @throws ClientExceptionInterface
38 |      * @throws ApiErrorException
39 | 	 */
40 | 	 public function get($wishlistId, $options = [])
41 | 	 {
42 |          $combinedOptions = $options;
43 | 
44 | 		 return $this->request('get', $this->resolvePath('wishlists/%s', $wishlistId), $combinedOptions, \Scayle\StorefrontApi\Models\Wishlist::class);
45 |      }
46 | 
47 | 	/**
48 | 	 * Description
49 | 	 *
50 | 	 * @param string $wishlistId
51 | 	 * @param string $itemKey
52 | 	 * @param array $options additional options like limit or filters
53 | 	 *
54 | 	 * @return \Scayle\StorefrontApi\Models\Wishlist
55 |      * @throws ClientExceptionInterface
56 |      * @throws ApiErrorException
57 | 	 */
58 | 	 public function remove($wishlistId, $itemKey, $options = [])
59 | 	 {
60 |          $combinedOptions = $options;
61 | 
62 | 		 return $this->request('delete', $this->resolvePath('wishlists/%s/items/%s', $wishlistId, $itemKey), $combinedOptions, \Scayle\StorefrontApi\Models\Wishlist::class);
63 |      }
64 | 
65 | }
66 | 


--------------------------------------------------------------------------------
/tests/WishlistTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class WishlistTest extends BaseApiTestCase
 8 | {
 9 |     public function testAddItem()
10 |     {
11 |         $expectedRequestJson = $this->loadFixture('WishlistAddItemRequest.json');
12 | 
13 |         $requestEntity = new \Scayle\StorefrontApi\Models\CreateWishlistBody($expectedRequestJson);
14 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedRequestJson), $requestEntity->toJson());
15 | 
16 |         $responseEntity = $this->api->wishlists->AddItem('1', $requestEntity,  []);
17 | 
18 |         $expectedResponseJson = $this->loadFixture('WishlistAddItemResponse.json');
19 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Wishlist::class, $responseEntity);
20 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
21 | 
22 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'items', \Scayle\StorefrontApi\Models\WishlistItem::class);
23 | 
24 | 
25 | 
26 |     }
27 | 
28 |     public function testGet()
29 |     {
30 |         $responseEntity = $this->api->wishlists->Get('1',  []);
31 | 
32 |         $expectedResponseJson = $this->loadFixture('WishlistGetResponse.json');
33 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Wishlist::class, $responseEntity);
34 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
35 | 
36 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'items', \Scayle\StorefrontApi\Models\WishlistItem::class);
37 | 
38 | 
39 | 
40 |     }
41 | 
42 |     public function testRemove()
43 |     {
44 |         $responseEntity = $this->api->wishlists->Remove('1', '1',  []);
45 | 
46 |         $expectedResponseJson = $this->loadFixture('WishlistRemoveResponse.json');
47 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Wishlist::class, $responseEntity);
48 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
49 | 
50 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'items', \Scayle\StorefrontApi\Models\WishlistItem::class);
51 | 
52 | 
53 | 
54 |     }
55 | 
56 | }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ![scayle-logo-cr](https://cdn-prod.scayle.com/public/media/general/SCAYLE-Commerce-Engine-header.png)
 2 | 
 3 | <h1 align="center">
 4 |   SCAYLE Storefront API PHP SDK
 5 | </h1>
 6 | 
 7 | <h4 align="center">
 8 |   <a href="https://new.scayle.dev">Documentation</a> |
 9 |   <a href="https://www.scayle.com/">Website</a>
10 | </h4>
11 | 
12 | <p align="center">
13 |   The SCAYLE <strong>Storefront API PHP SDK</strong> streamlines interactions with Storefront REST APIs.
14 | </p>
15 | <p align="center">
16 |   <a href="#"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="SCAYLE's **Storefront API PHP SDK is released under the MIT license." /></a>
17 | </p>
18 | 
19 | ## Getting Started
20 | 
21 | Visit the [Quickstart Guide](https://new.scayle.dev/en/developer-guide/introduction/apis#sdk-setup) to set up the Storefront API PHP SDK
22 | 
23 | Visit the [Docs](https://new.scayle.dev) to learn more about our system requirements.
24 | 
25 | ## Installation
26 | ```PHP
27 | # Install the PHP library with Composer
28 | `composer require scayle/storefront-api`
29 | 
30 | # Initialise SDK
31 | use Scayle\StorefrontApi\StorefrontClient;
32 | 
33 | $client = new StorefrontClient([
34 |   'apiUrl' => 'https://{{tenant-space}}.storefront.api.scayle.cloud/v1/',
35 |   'shopId' => 1001,
36 |   'auth' => [
37 |     'type' => 'token',
38 |     'token' => '{{Access-Token}}',
39 |   ],
40 | ]);
41 | ```
42 | ## What is Scayle ?
43 | 
44 | [SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs. Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.
45 | 
46 | Learn more about Scayles’s architecture and commerce modules in the [Docs] (https://new.scayle.dev/en/user-guide).
47 | 
48 | 
49 | 
50 | ##  Community
51 | 
52 | The community and core teams are available in [GitHub](https://github.com/scayle/), where you can ask for support, discuss roadmap, and share ideas.
53 | 
54 | ## Other channels
55 | 
56 | - [GitHub Issues](https://github.com/scayle/storefront-api-php-sdk/issues)
57 | - [LinkedIn](https://www.linkedin.com/company/scaylecommerce/)
58 | - [Jobs](https://careers.smartrecruiters.com/ABOUTYOUGmbH/scayle)
59 | - [AboutYou Tech Blog](https://aboutyou.tech/)
60 | 
61 | ## License
62 | Licensed under the [MIT](https://opensource.org/license/mit/)
63 | 


--------------------------------------------------------------------------------
/lib/Models/Product.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Models;
 4 | 
 5 | /**
 6 |  * @property int $id 
 7 |  * @property array<string, AdvancedAttribute> $advancedAttributes 
 8 |  * @property array<string, Attribute> $attributes 
 9 |  * @property BaseCategory[] $baseCategories 
10 |  * @property ProductCategory[][] $categories 
11 |  * @property DefiningAttribute $definingAttributes 
12 |  * @property Image[] $images 
13 |  * @property ResponseCustomData $customData 
14 |  * @property bool $isActive Identifies whether a product is active or not
15 |  * @property bool $isNew Identifies whether a product is new or not
16 |  * @property bool $isSoldOut Identifies if a product is still available to sell
17 |  * @property string $masterKey Identifies the master product which this product belongs
18 |  * @property Timestamp $firstLiveAt 
19 |  * @property PriceRange $priceRange 
20 |  * @property ReductionRange $reductionRange 
21 |  * @property LowestPriorPrice $lowestPriorPrice 
22 |  * @property string $referenceKey 
23 |  * @property int[] $searchCategoryIds 
24 |  * @property Product[] $siblings list of Products
25 |  * @property Variant[] $variants 
26 |  * @property Timestamp $createdAt 
27 |  * @property Timestamp $updatedAt 
28 |  * @property Timestamp $indexedAt 
29 |  */
30 | class Product extends ApiObject
31 | {
32 |     protected $defaultValues = [
33 |         
34 |     ];
35 | 
36 |     protected $classMap = [
37 | 		'definingAttributes' => \Scayle\StorefrontApi\Models\DefiningAttribute::class,
38 | 		'priceRange' => \Scayle\StorefrontApi\Models\PriceRange::class,
39 | 		'reductionRange' => \Scayle\StorefrontApi\Models\ReductionRange::class,
40 | 		'lowestPriorPrice' => \Scayle\StorefrontApi\Models\LowestPriorPrice::class,
41 |     ];
42 | 
43 |     protected $collectionClassMap = [
44 |         'attributes' => \Scayle\StorefrontApi\Models\Attribute::class,
45 |         'advancedAttributes' => \Scayle\StorefrontApi\Models\AdvancedAttribute::class,
46 |         'images' => \Scayle\StorefrontApi\Models\Image::class,
47 |         'siblings' => \Scayle\StorefrontApi\Models\Product::class,
48 |         'baseCategories' => \Scayle\StorefrontApi\Models\BaseCategory::class,
49 |         'variants' => \Scayle\StorefrontApi\Models\Variant::class,
50 |     ];
51 | 
52 |     protected $collection2dClassMap = [
53 |             'categories' => \Scayle\StorefrontApi\Models\ProductCategory::class,
54 |     ];
55 | 
56 | protected $polymorphic = [
57 |     ];
58 | 
59 |     protected $polymorphicCollections = [
60 |     ];
61 | }


--------------------------------------------------------------------------------
/lib/Services/CategoryService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class CategoryService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param array $options additional options like limit or filters
16 | 	 *
17 | 	 * @return \Scayle\StorefrontApi\Models\CategoryCollection
18 |      * @throws ClientExceptionInterface
19 |      * @throws ApiErrorException
20 | 	 */
21 | 	 public function getRoots($options = [])
22 | 	 {
23 |          $combinedOptions = $options;
24 | 
25 | 		 return $this->request('get', 'categories', $combinedOptions, \Scayle\StorefrontApi\Models\CategoryCollection::class);
26 |      }
27 | 
28 | 	/**
29 | 	 * Description
30 | 	 *
31 | 	 * @param array $categoryIds
32 | 	 * @param array $options additional options like limit or filters
33 | 	 *
34 | 	 * @return \Scayle\StorefrontApi\Models\CategoryCollection
35 |      * @throws ClientExceptionInterface
36 |      * @throws ApiErrorException
37 | 	 */
38 | 	 public function getByIds($categoryIds, $options = [])
39 | 	 {
40 |          $combinedOptions = $options;
41 |          $combinedOptions["ids"] = implode(',', $categoryIds);
42 | 
43 | 		 return $this->request('get', 'categories', $combinedOptions, \Scayle\StorefrontApi\Models\CategoryCollection::class);
44 |      }
45 | 
46 | 	/**
47 | 	 * Description
48 | 	 *
49 | 	 * @param int $categoryId
50 | 	 * @param array $options additional options like limit or filters
51 | 	 *
52 | 	 * @return \Scayle\StorefrontApi\Models\Category
53 |      * @throws ClientExceptionInterface
54 |      * @throws ApiErrorException
55 | 	 */
56 | 	 public function getById($categoryId, $options = [])
57 | 	 {
58 |          $combinedOptions = $options;
59 | 
60 | 		 return $this->request('get', $this->resolvePath('categories/%s', $categoryId), $combinedOptions, \Scayle\StorefrontApi\Models\Category::class);
61 |      }
62 | 
63 | 	/**
64 | 	 * Description
65 | 	 *
66 | 	 * @param string $categoryPath
67 | 	 * @param array $options additional options like limit or filters
68 | 	 *
69 | 	 * @return \Scayle\StorefrontApi\Models\Category
70 |      * @throws ClientExceptionInterface
71 |      * @throws ApiErrorException
72 | 	 */
73 | 	 public function getByPath($categoryPath, $options = [])
74 | 	 {
75 |          $combinedOptions = $options;
76 | 
77 | 		 return $this->request('get', $this->resolvePath('categories/%s', $categoryPath), $combinedOptions, \Scayle\StorefrontApi\Models\Category::class);
78 |      }
79 | 
80 | }
81 | 


--------------------------------------------------------------------------------
/tests/BasketTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class BasketTest extends BaseApiTestCase
 8 | {
 9 |     public function testGet()
10 |     {
11 |         $responseEntity = $this->api->baskets->Get('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('BasketGetResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Basket::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 | 
18 | 
19 | 
20 |     }
21 | 
22 |     public function testAddItem()
23 |     {
24 |         $expectedRequestJson = $this->loadFixture('BasketAddItemRequest.json');
25 | 
26 |         $requestEntity = new \Scayle\StorefrontApi\Models\CreateBasketItemBody($expectedRequestJson);
27 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedRequestJson), $requestEntity->toJson());
28 | 
29 |         $responseEntity = $this->api->baskets->AddItem('1', $requestEntity,  []);
30 | 
31 |         $expectedResponseJson = $this->loadFixture('BasketAddItemResponse.json');
32 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Basket::class, $responseEntity);
33 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
34 | 
35 | 
36 | 
37 | 
38 |     }
39 | 
40 |     public function testRemove()
41 |     {
42 |         $responseEntity = $this->api->baskets->Remove('1', '1',  []);
43 | 
44 |         $expectedResponseJson = $this->loadFixture('BasketRemoveResponse.json');
45 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Basket::class, $responseEntity);
46 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
47 | 
48 | 
49 | 
50 | 
51 |     }
52 | 
53 |     public function testUpdate()
54 |     {
55 |         $expectedRequestJson = $this->loadFixture('BasketUpdateRequest.json');
56 | 
57 |         $requestEntity = new \Scayle\StorefrontApi\Models\UpdateBasketItemBody($expectedRequestJson);
58 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedRequestJson), $requestEntity->toJson());
59 | 
60 |         $responseEntity = $this->api->baskets->Update('1', '1', $requestEntity,  []);
61 | 
62 |         $expectedResponseJson = $this->loadFixture('BasketUpdateResponse.json');
63 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Basket::class, $responseEntity);
64 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
65 | 
66 | 
67 | 
68 | 
69 |     }
70 | 
71 | }


--------------------------------------------------------------------------------
/lib/Services/BasketService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 6 | use Psr\Http\Client\ClientExceptionInterface;
 7 | 
 8 | /**
 9 |  */
10 | class BasketService extends AbstractService
11 | {
12 | 	/**
13 | 	 * Description
14 | 	 *
15 | 	 * @param string $basketId
16 | 	 * @param array $options additional options like limit or filters
17 | 	 *
18 | 	 * @return \Scayle\StorefrontApi\Models\Basket
19 |      * @throws ClientExceptionInterface
20 |      * @throws ApiErrorException
21 | 	 */
22 | 	 public function get($basketId, $options = [])
23 | 	 {
24 |          $combinedOptions = $options;
25 | 
26 | 		 return $this->request('get', $this->resolvePath('baskets/%s', $basketId), $combinedOptions, \Scayle\StorefrontApi\Models\Basket::class);
27 |      }
28 | 
29 | 	/**
30 | 	 * Description
31 | 	 *
32 | 	 * @param string $basketId
33 | 	 * @param \Scayle\StorefrontApi\Models\CreateBasketItemBody $model the model to create or update
34 | 	 * @param array $options additional options like limit or filters
35 | 	 *
36 | 	 * @return \Scayle\StorefrontApi\Models\Basket
37 |      * @throws ClientExceptionInterface
38 |      * @throws ApiErrorException
39 | 	 */
40 | 	 public function addItem($basketId, $model, $options = [])
41 | 	 {
42 |          $combinedOptions = $options;
43 | 
44 | 		 return $this->request('post', $this->resolvePath('baskets/%s/items', $basketId), $combinedOptions, \Scayle\StorefrontApi\Models\Basket::class, $model);
45 |      }
46 | 
47 | 	/**
48 | 	 * Description
49 | 	 *
50 | 	 * @param string $basketId
51 | 	 * @param string $itemKey
52 | 	 * @param array $options additional options like limit or filters
53 | 	 *
54 | 	 * @return \Scayle\StorefrontApi\Models\Basket
55 |      * @throws ClientExceptionInterface
56 |      * @throws ApiErrorException
57 | 	 */
58 | 	 public function remove($basketId, $itemKey, $options = [])
59 | 	 {
60 |          $combinedOptions = $options;
61 | 
62 | 		 return $this->request('delete', $this->resolvePath('baskets/%s/items/%s', $basketId, $itemKey), $combinedOptions, \Scayle\StorefrontApi\Models\Basket::class);
63 |      }
64 | 
65 | 	/**
66 | 	 * Description
67 | 	 *
68 | 	 * @param string $basketId
69 | 	 * @param string $itemKey
70 | 	 * @param \Scayle\StorefrontApi\Models\UpdateBasketItemBody $model the model to create or update
71 | 	 * @param array $options additional options like limit or filters
72 | 	 *
73 | 	 * @return \Scayle\StorefrontApi\Models\Basket
74 |      * @throws ClientExceptionInterface
75 |      * @throws ApiErrorException
76 | 	 */
77 | 	 public function update($basketId, $itemKey, $model, $options = [])
78 | 	 {
79 |          $combinedOptions = $options;
80 | 
81 | 		 return $this->request('patch', $this->resolvePath('baskets/%s/items/%s', $basketId, $itemKey), $combinedOptions, \Scayle\StorefrontApi\Models\Basket::class, $model);
82 |      }
83 | 
84 | }
85 | 


--------------------------------------------------------------------------------
/lib/Services/AbstractService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi\Services;
 4 | 
 5 | use Scayle\StorefrontApi\AbstractApi;
 6 | use Scayle\StorefrontApi\Exceptions\ApiErrorException;
 7 | use Scayle\StorefrontApi\Models\ApiObject;
 8 | use Scayle\StorefrontApi\Models\ApiCollection;
 9 | use Psr\Http\Client\ClientExceptionInterface;
10 | 
11 | abstract class AbstractService
12 | {
13 |     /**
14 |      * @var AbstractApi
15 |      */
16 |     private $client;
17 | 
18 |     /**
19 |      * @param AbstractApi $client
20 |      */
21 |     public function __construct($client)
22 |     {
23 |         $this->client = $client;
24 |     }
25 | 
26 |     /**
27 |      * @param string $method the http method
28 |      * @param string $relativeUrl the relative url of endpoint
29 |      * @param string|null $modelClass the classname of which the response gets transformed to
30 |      * @param array<string, string> $options array of additional options
31 |      * @param ApiObject|null $body the request body object
32 |      *
33 |      * @return mixed|null
34 |      *
35 |      * @throws ClientExceptionInterface
36 |      * @throws ApiErrorException
37 |      */
38 |     protected function request($method, $relativeUrl, $options = [], $modelClass = null, $body = null)
39 |     {
40 |         try {
41 |             if ($body instanceof ApiObject) {
42 |                 $body = $body->toJson();
43 |             } elseif ($body !== null) {
44 |                 $body = json_encode($body);
45 |             }
46 | 
47 |             $response = $this->client->request($method, $relativeUrl, $options, $body);
48 |             $statusCode = $response->getStatusCode();
49 | 
50 |             $responseBody = $response->getBody()->getContents();
51 |             // Catching all NON 2xx status codes for further error processing
52 |             if ($statusCode < 200 || $statusCode >= 300) {
53 |                 $responseJson = json_decode($responseBody, true);
54 |                 throw new ApiErrorException(is_null($responseJson) ? [] : $responseJson, $statusCode);
55 |             }
56 | 
57 |             if ($responseBody && $modelClass && class_exists($modelClass)) {
58 |                 $responseJson = json_decode($responseBody, true);
59 | 
60 |                 if (!is_subclass_of($modelClass, ApiCollection::class)) {
61 |                     return new $modelClass($responseJson);
62 |                 }
63 | 
64 |                 return new $modelClass(['entities' => $responseJson]);
65 |             } else {
66 |                 return json_decode($responseBody, true);
67 |             }
68 |         } catch (ClientExceptionInterface $e) {
69 |             throw $e;
70 |         }
71 |     }
72 | 
73 |     /**
74 |      * @param string $path
75 |      * @param mixed ...$params
76 |      *
77 |      * @return string
78 |      */
79 |     protected function resolvePath($path, ...$params)
80 |     {
81 |         return vsprintf($path, $params);
82 |     }
83 | }
84 | 


--------------------------------------------------------------------------------
/tests/CategoryTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class CategoryTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetRoots()
10 |     {
11 |         $responseEntity = $this->api->categories->GetRoots( []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('CategoryGetRootsResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\CategoryCollection::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
18 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
19 | 
20 | 
21 |         foreach ($responseEntity->getEntities() as $collectionEntity) {
22 |             $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Category::class, $collectionEntity);
23 |             $this->assertPropertyHasTheCorrectType($collectionEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
24 |             $this->assertPropertyHasTheCorrectType($collectionEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
25 | 
26 |         }
27 |     }
28 | 
29 |     public function testGetByIds()
30 |     {
31 |         $responseEntity = $this->api->categories->GetByIds('1',  []);
32 | 
33 |         $expectedResponseJson = $this->loadFixture('CategoryGetByIdsResponse.json');
34 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\CategoryCollection::class, $responseEntity);
35 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
36 | 
37 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
38 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
39 | 
40 | 
41 |         foreach ($responseEntity->getEntities() as $collectionEntity) {
42 |             $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Category::class, $collectionEntity);
43 |             $this->assertPropertyHasTheCorrectType($collectionEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
44 |             $this->assertPropertyHasTheCorrectType($collectionEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
45 | 
46 |         }
47 |     }
48 | 
49 |     public function testGetById()
50 |     {
51 |         $responseEntity = $this->api->categories->GetById('1',  []);
52 | 
53 |         $expectedResponseJson = $this->loadFixture('CategoryGetByIdResponse.json');
54 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Category::class, $responseEntity);
55 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
56 | 
57 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
58 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
59 | 
60 | 
61 | 
62 |     }
63 | 
64 |     public function testGetByPath()
65 |     {
66 |         $responseEntity = $this->api->categories->GetByPath('1',  []);
67 | 
68 |         $expectedResponseJson = $this->loadFixture('CategoryGetByPathResponse.json');
69 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Category::class, $responseEntity);
70 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
71 | 
72 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'parent', \Scayle\StorefrontApi\Models\Category::class);
73 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'children', \Scayle\StorefrontApi\Models\Category::class);
74 | 
75 | 
76 | 
77 |     }
78 | 
79 | }


--------------------------------------------------------------------------------
/tests/ProductTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Scayle\StorefrontApi;
 4 | 
 5 | use Scayle\StorefrontApi\Models\Identifier;
 6 | 
 7 | class ProductTest extends BaseApiTestCase
 8 | {
 9 |     public function testGetById()
10 |     {
11 |         $responseEntity = $this->api->products->GetById('1',  []);
12 | 
13 |         $expectedResponseJson = $this->loadFixture('ProductGetByIdResponse.json');
14 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\Product::class, $responseEntity);
15 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
16 | 
17 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'attributes', \Scayle\StorefrontApi\Models\Attribute::class);
18 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'advancedAttributes', \Scayle\StorefrontApi\Models\AdvancedAttribute::class);
19 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'categories', \Scayle\StorefrontApi\Models\ProductCategory::class);
20 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'definingAttributes', \Scayle\StorefrontApi\Models\DefiningAttribute::class);
21 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'images', \Scayle\StorefrontApi\Models\Image::class);
22 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'priceRange', \Scayle\StorefrontApi\Models\PriceRange::class);
23 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'reductionRange', \Scayle\StorefrontApi\Models\ReductionRange::class);
24 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'lowestPriorPrice', \Scayle\StorefrontApi\Models\LowestPriorPrice::class);
25 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'siblings', \Scayle\StorefrontApi\Models\Product::class);
26 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'baseCategories', \Scayle\StorefrontApi\Models\BaseCategory::class);
27 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'variants', \Scayle\StorefrontApi\Models\Variant::class);
28 | 
29 | 
30 | 
31 |     }
32 | 
33 |     public function testQuery()
34 |     {
35 |         $responseEntity = $this->api->products->Query( []);
36 | 
37 |         $expectedResponseJson = $this->loadFixture('ProductQueryResponse.json');
38 |         $this->assertInstanceOf(\Scayle\StorefrontApi\Models\ProductsResponse::class, $responseEntity);
39 |         $this->assertJsonStringEqualsJsonString(json_encode($expectedResponseJson), $responseEntity->toJson());
40 | 
41 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'attributes', \Scayle\StorefrontApi\Models\Attribute::class);
42 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'advancedAttributes', \Scayle\StorefrontApi\Models\AdvancedAttribute::class);
43 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'categories', \Scayle\StorefrontApi\Models\ProductCategory::class);
44 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'definingAttributes', \Scayle\StorefrontApi\Models\DefiningAttribute::class);
45 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'images', \Scayle\StorefrontApi\Models\Image::class);
46 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'priceRange', \Scayle\StorefrontApi\Models\PriceRange::class);
47 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'reductionRange', \Scayle\StorefrontApi\Models\ReductionRange::class);
48 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'lowestPriorPrice', \Scayle\StorefrontApi\Models\LowestPriorPrice::class);
49 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'siblings', \Scayle\StorefrontApi\Models\Product::class);
50 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'baseCategories', \Scayle\StorefrontApi\Models\BaseCategory::class);
51 |             $this->assertPropertyHasTheCorrectType($responseEntity, 'variants', \Scayle\StorefrontApi\Models\Variant::class);
52 | 
53 | 
54 | 
55 |     }
56 | 
57 | }


--------------------------------------------------------------------------------
/tests/BaseApiTestCase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Scayle\StorefrontApi;
  4 | 
  5 | use Scayle\StorefrontApi\Models\ApiObject;
  6 | use PHPUnit\Framework\TestCase;
  7 | use ReflectionProperty;
  8 | 
  9 | abstract class BaseApiTestCase extends TestCase
 10 | {
 11 |     /**
 12 |      * @var StorefrontClient
 13 |      */
 14 |     protected $api;
 15 | 
 16 |     protected function setUp()
 17 |     {
 18 |         parent::setUp();
 19 | 
 20 |         //Mock Server
 21 |         $this->api = new StorefrontClient([
 22 |             'apiUrl' => getenv('API_URL') ? getenv('API_URL') : 'http://127.0.0.1:4010',
 23 |             'accessToken' => 'abc123',
 24 |         ]);
 25 |     }
 26 | 
 27 |     /**
 28 |      * Gets a protected property from an ApiObject
 29 |      *
 30 |      * @param \Scayle\StorefrontApi\Models\ApiObject $apiObject
 31 |      * @param string $propertyName
 32 |      *
 33 |      * @return mixed|null
 34 |      *
 35 |      * @throws \ReflectionException
 36 |      */
 37 |     private function getProtectedProperty($apiObject, $propertyName)
 38 |     {
 39 |         $reflect = new \ReflectionClass($apiObject);
 40 | 
 41 |         $props = $reflect->getProperties(ReflectionProperty::IS_PROTECTED);
 42 | 
 43 |         foreach ($props as $prop) {
 44 |             if ($prop->getName() === $propertyName) {
 45 |                 $prop->setAccessible(true);
 46 | 
 47 |                 return $prop->getValue($apiObject);
 48 |             }
 49 |         }
 50 | 
 51 |         return null;
 52 |     }
 53 | 
 54 |     /**
 55 |      * @param \Scayle\StorefrontApi\Models\ApiObject $apiObject an ApiObject instance
 56 |      * @param string $propertyName the property to type check
 57 |      * @param string $className the expected classname
 58 |      * @throws \ReflectionException
 59 |      */
 60 |     protected function assertPropertyHasTheCorrectType($apiObject, $propertyName, $className)
 61 |     {
 62 |         $attributes = $this->getProtectedProperty($apiObject, '_attributes');
 63 | 
 64 |         foreach ($attributes as $objPropertyName => $objPropertyValue) {
 65 |             if ($objPropertyName === $propertyName) {
 66 |                 if (is_array($objPropertyValue)) {
 67 |                     foreach ($objPropertyValue as $objPropertyItem) {
 68 |                         $this->assertInstanceOf($className, $objPropertyItem);
 69 |                     }
 70 |                 } else {
 71 |                     $this->assertInstanceOf($className, $objPropertyValue);
 72 |                 }
 73 | 
 74 |                 break;
 75 |             }
 76 |         }
 77 |     }
 78 | 
 79 |     /**
 80 |      * @param ApiObject $apiObject an ApiObject instance
 81 |      * @param string $propertyName the property to type check
 82 |      * @param string $discriminator the discriminator field name
 83 |      * @param array<string, string> $mapping mapping of discriminator value to concrete class
 84 |      * @throws \ReflectionException
 85 |      */
 86 |     protected function assertPropertyHasCorrectPolymorphicType($apiObject, $propertyName, $discriminator, $mapping)
 87 |     {
 88 |         $attributes = $this->getProtectedProperty($apiObject, '_attributes');
 89 | 
 90 |         foreach ($attributes as $objPropertyName => $objPropertyValue) {
 91 |             if ($objPropertyName === $propertyName) {
 92 |                 if (is_array($objPropertyValue)) {
 93 |                     foreach ($objPropertyValue as $objPropertyItem) {
 94 |                         $discriminatorValue = $objPropertyItem->{$discriminator};
 95 |                         $this->assertArrayHasKey($discriminatorValue, $mapping);
 96 |                         $className = $mapping[$discriminatorValue];
 97 |                         $this->assertInstanceOf($className, $objPropertyItem);
 98 |                     }
 99 |                 } else {
100 |                     $discriminatorValue = $objPropertyValue->{$discriminator};
101 |                     $className = $mapping[$discriminatorValue];
102 |                     $this->assertArrayHasKey($discriminatorValue, $mapping);
103 |                     $this->assertInstanceOf($className, $objPropertyValue);
104 |                 }
105 | 
106 |                 break;
107 |             }
108 |         }
109 |     }
110 | 
111 |     protected function loadFixture(string $filename) : array
112 |     {
113 |         $filename = __DIR__ . '/fixtures/' . $filename;
114 |         $this->assertFileExists($filename, "Fixtures do not exist. Are you sure you have valid request and response examples in your OpenAPI specification?");
115 |         return json_decode(file_get_contents($filename), true);
116 |     }
117 | }


--------------------------------------------------------------------------------
/lib/AbstractApi.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Scayle\StorefrontApi;
  4 | 
  5 | use Scayle\StorefrontApi\Exceptions\InvalidArgumentException;
  6 | use GuzzleHttp\Client;
  7 | use GuzzleHttp\Psr7\Request;
  8 | use Psr\Http\Client\ClientExceptionInterface;
  9 | use Psr\Http\Client\ClientInterface;
 10 | use Psr\Http\Message\ResponseInterface;
 11 | 
 12 | abstract class AbstractApi
 13 | {
 14 |     const VERSION = '1.0.0';
 15 | 
 16 |     const API_URL = 'apiUrl';
 17 | 
 18 |     const AUTH = 'auth';
 19 |     const AUTH_TYPE = 'type';
 20 |     const AUTH_TOKEN = 'token';
 21 |     const AUTH_USERNAME = 'username';
 22 |     const AUTH_PASSWORD = 'password';
 23 |     const AUTH_HEADER_NAME = 'X-Access-Token';
 24 | 
 25 |     const SHOP_ID = 'shopId';
 26 |     const SHOP_HEADER_NAME = 'X-Shop-Id';
 27 | 
 28 |     /**
 29 |      * @var ClientInterface
 30 |      */
 31 |     private $httpClient;
 32 | 
 33 |     /**
 34 |      * @var array<string, string>
 35 |      */
 36 |     private $config;
 37 | 
 38 |     /**
 39 |      * AbstractAdminApi constructor.
 40 |      * @param array<string, string> $config
 41 |      * @example ['apiUrl' => 'http://cloud.aboutyou.com', 'accessToken' => 'myToken']
 42 |      * @param ClientInterface $httpClient
 43 |      */
 44 |     public function __construct($config = [], $httpClient = null)
 45 |     {
 46 |         $this->validateConfig($config);
 47 | 
 48 |         $this->config = $config;
 49 |         $this->httpClient = $httpClient ?: new Client();
 50 |     }
 51 | 
 52 |     /**
 53 |      * @return string
 54 |      */
 55 |     public function getApiUrl()
 56 |     {
 57 |         return $this->config[self::API_URL];
 58 |     }
 59 | 
 60 |     /**
 61 |      * @return array
 62 |      */
 63 |     public function getAuth()
 64 |     {
 65 |         return $this->config[self::AUTH];
 66 |     }
 67 | 
 68 |     /**
 69 |     * @return string
 70 |     */
 71 |     public function getShopId()
 72 |     {
 73 |         return $this->config[self::SHOP_ID];
 74 |     }
 75 | 
 76 | /**
 77 | * @param string $method
 78 |      * @param string $relativePath
 79 |      * @param array<string, string> $options
 80 |      * @param null|string $body
 81 |      *
 82 |      * @return ResponseInterface
 83 |      *
 84 |      * @throws ClientExceptionInterface
 85 |      */
 86 |     public function request($method, $relativePath, $options = [], $body = null)
 87 |     {
 88 |         $url = $this->getApiUrl() . $relativePath . $this->makeQueryString($options);
 89 | 
 90 |         $headers = $this->getAuthHeader();
 91 |         $headers[self::SHOP_HEADER_NAME] = $this->getShopId();
 92 |         $headers['Content-Type'] = 'application/json';
 93 |         $headers['Accept'] = 'application/json, */*';
 94 |         $headers['X-SDK'] = 'php/' . self::VERSION;
 95 | 
 96 |         $request = new Request($method, $url, $headers, $body);
 97 |         return $this->httpClient->sendRequest($request);
 98 |     }
 99 | 
100 |     private function getAuthHeader()
101 |     {
102 |         $auth = $this->getAuth();
103 |         if (array_key_exists(self::AUTH_TOKEN, $auth)) {
104 |             return [
105 |                 self::AUTH_HEADER_NAME => $auth[self::AUTH_TOKEN],
106 |             ];
107 |         }
108 | 
109 |         $credentials = base64_encode($auth[self::AUTH_USERNAME] . ':' . $auth[self::AUTH_PASSWORD]);
110 | 
111 |         return [
112 |             'Authorization' => 'Basic ' . $credentials,
113 |         ];
114 |     }
115 | 
116 |     private function makeQueryString(array $options): string
117 |     {
118 |         if (empty($options)) {
119 |             return '';
120 |         }
121 | 
122 |         foreach ($options as &$value) {
123 |             if (is_bool($value)) {
124 |                 $value = $value ? 'true' : 'false';
125 |             }
126 |         }
127 | 
128 |         unset($value);
129 | 
130 |         return '?' . http_build_query($options);
131 |     }
132 | 
133 |     /**
134 |      * @param array<string, string> $config
135 |      *
136 |      * @throws InvalidArgumentException
137 |      */
138 |     private function validateConfig($config)
139 |     {
140 |         if (empty($config[self::API_URL])) {
141 |             $message = sprintf('%s cannot be empty', self::API_URL);
142 |             throw new InvalidArgumentException($message);
143 |         }
144 | 
145 |         if (empty($config[self::SHOP_ID])) {
146 |             $message = sprintf('%s cannot be empty', self::SHOP_ID);
147 |             throw new InvalidArgumentException($message);
148 |         }
149 | 
150 |         if (empty($config[self::AUTH])) {
151 |             $message = sprintf('%s cannot be empty', self::AUTH);
152 |             throw new InvalidArgumentException($message);
153 |         }
154 | 
155 |         $auth = $config[self::AUTH];
156 |         if ((empty($auth[self::AUTH_TYPE]) || empty($auth[self::AUTH_TOKEN])) && (empty($auth[self::AUTH_USERNAME]) || empty($auth[self::AUTH_PASSWORD]))) {
157 |             $message = sprintf('%s array must consist of either type and token or username and password', self::AUTH);
158 |             throw new InvalidArgumentException($message);
159 |         }
160 |     }
161 | }
162 | 


--------------------------------------------------------------------------------
/lib/Models/ApiObject.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Scayle\StorefrontApi\Models;
  4 | 
  5 | abstract class ApiObject implements \JsonSerializable
  6 | {
  7 |     /**
  8 |      * @var array
  9 |      */
 10 |     protected $_attributes;
 11 | 
 12 |     /**
 13 |      * @var array
 14 |      */
 15 |     protected $defaultValues = [];
 16 | 
 17 |     /**
 18 |      * @var array
 19 |      */
 20 |     protected $classMap = [];
 21 | 
 22 |     /**
 23 |      * @var array
 24 |      */
 25 |     protected $polymorphic = [];
 26 | 
 27 |     /**
 28 |      * @var array
 29 |      */
 30 |     protected $polymorphicCollections = [];
 31 | 
 32 |     /**
 33 |      * @var array
 34 |      */
 35 |     protected $collectionClassMap = [];
 36 | 
 37 |     /**
 38 |      * @var array
 39 |      */
 40 |     protected $collection2dClassMap = [];
 41 | 
 42 |     /**
 43 |      * @var \Scayle\StorefrontApi\Serializers\ModelSerializer
 44 |      */
 45 |     private $serializer;
 46 | 
 47 |     public function __construct($attributes = [])
 48 |     {
 49 |         $this->serializer = new \Scayle\StorefrontApi\Serializers\ModelSerializer();
 50 |         $attributes = $this->mergeDefaultValues($attributes);
 51 |         $this->_attributes = $this->unserialize($attributes);
 52 |     }
 53 | 
 54 |     public function __set($name, $value)
 55 |     {
 56 |         $this->_attributes[$name] = $value;
 57 |     }
 58 | 
 59 |     public function &__get($name)
 60 |     {
 61 |         if (array_key_exists($name, $this->_attributes)) {
 62 |             return $this->_attributes[$name];
 63 |         }
 64 | 
 65 |         $nullRef = null;
 66 |         return $nullRef;
 67 |     }
 68 | 
 69 |     public function __isset($name)
 70 |     {
 71 |         return isset($this->_attributes[$name]);
 72 |     }
 73 | 
 74 |     /**
 75 |      * @return array
 76 |      */
 77 |     public function jsonSerialize()
 78 |     {
 79 |         $serialized = [];
 80 | 
 81 |         foreach ($this->_attributes as $key => $value) {
 82 |             if ($value instanceof ApiObject) {
 83 |                 $value = $value->jsonSerialize();
 84 |             }
 85 | 
 86 |             $serialized[$key] = $value;
 87 |         }
 88 | 
 89 |         return $serialized;
 90 |     }
 91 | 
 92 |     /**
 93 |      * @return false|string
 94 |      */
 95 |     public function toJson()
 96 |     {
 97 |         return json_encode($this->_attributes);
 98 |     }
 99 | 
100 |     /**
101 |     * @param array $attributes
102 |     *
103 |     * @return array mixed
104 |     */
105 |     private function mergeDefaultValues($attributes)
106 |     {
107 |         $diff = array_diff_key($this->defaultValues, $attributes);
108 |         $attributes = array_merge($attributes, $diff);
109 | 
110 |         return $attributes;
111 |     }
112 | 
113 |     /**
114 |      * @param array $attributes
115 |      * @return array
116 |      */
117 |     private function unserialize($attributes)
118 |     {
119 |         $unserialized = [];
120 | 
121 |         foreach ($attributes as $key => $value) {
122 |             if (is_null($value)) {
123 |                 $unserialized[$key] = $value;
124 |                 continue;
125 |             }
126 | 
127 |             // Handle nested single object instantiation
128 |             if (array_key_exists($key, $this->classMap)) {
129 |                 $value = new $this->classMap[$key]($value);
130 |             }
131 | 
132 |             // Handle nested object collection instantiation
133 |             if (array_key_exists($key, $this->collectionClassMap)) {
134 |                 $nestedObjects = [];
135 |                 foreach ($value as $nestedKey => $nestedValue) {
136 |                     $nestedObjects[$nestedKey] = $this->serializer->parse($this->collectionClassMap[$key], $nestedValue);
137 |                 }
138 | 
139 |                 $value = $nestedObjects;
140 |             }
141 | 
142 |             if (array_key_exists($key, $this->collection2dClassMap)) {
143 |                 $nestedObjects = [];
144 |                 foreach ($value as $nestedValue) {
145 |                     $nestedObjects[] = array_map(fn($v) => new $this->collection2dClassMap[$key]($v), $nestedValue);
146 |                 }
147 | 
148 |                 $value = $nestedObjects;
149 |             }
150 | 
151 | 
152 |             // Handle single nested object polymorphism
153 |             if (array_key_exists($key, $this->polymorphic)) {
154 |                 $discriminator = $this->polymorphic[$key]['discriminator'];
155 |                 $discriminatorValue = $attributes[$discriminator];
156 |                 $className = $this->polymorphic[$key]['mapping'][$discriminatorValue];
157 |                 $value = new $className([$key => $value]);
158 |             }
159 | 
160 |             // Handle nested object collection polymorphism
161 |             if (array_key_exists($key, $this->polymorphicCollections)) {
162 |                 $discriminator = $this->polymorphicCollections[$key]['discriminator'];
163 |                 $objects = [];
164 |                 foreach ($attributes[$key] as $nestedAttribute) {
165 |                     $discriminatorValue = $nestedAttribute[$discriminator];
166 |                     if (array_key_exists($discriminatorValue, $this->polymorphicCollections[$key]['mapping'])) {
167 |                         $className = $this->polymorphicCollections[$key]['mapping'][$discriminatorValue];
168 |                         $objects[] = new $className($nestedAttribute);
169 |                     }
170 |                 }
171 | 
172 |                 $value = $objects;
173 |             }
174 | 
175 |             $unserialized[$key] = $value;
176 |         }
177 | 
178 |         return $unserialized;
179 |     }
180 | }
181 | 
182 | 


--------------------------------------------------------------------------------