Welcome WorkflowApi

Author: roberto-butti

CHANGELOG.md

@@ -1,8 +1,9 @@
 # Changelog
 
-## 0.0.3 - WIP
+## 0.0.3 - 2025-02-03
 
 - Adding helper methods for SpaceData (id(), updatedAt())
+- Adding WorkflowApi class for handling workflows
 
 ## 0.0.2 - 2025-02-01
 

README.md

@@ -525,7 +525,35 @@ if ($response->isOk()) {
 ```
 
 
+## Handling Workflows
 
+If you need to handle workflows (retrieving workflows or create new custome workflow - in the case you have a proper plan - ) you can use the `WorkflowApi` class.
+
+### Retrieving workflows
+
+```php
+$workflowApi = $client->workflowApi($spaceId);
+$response = $workflowApi->list();
+/** @var WorkflowsData $workflows */
+$workflows = $response->data();
+
+foreach ($workflows as $key => $workflow) {
+    echo $workflow->name() . PHP_EOL;
+    echo print_r($workflow->contentTypes(), true) . PHP_EOL;
+    echo $workflow->isDefault() . PHP_EOL;
+    echo "---" . PHP_EOL;
+}
+
+```
+
+### Creating a new custom workflow
+
+```php
+$workflowApi = $client->workflowApi($spaceId);
+$workflowData = new WorkflowData();
+$workflowData->setName("Name");
+$response = $workflowApi->create($workflowData);
+```
 
 
 ## Using the `ManagementApi` class

rector.php

@@ -17,6 +17,7 @@
         typeDeclarations: true,
         // naming: true,
         instanceOf: true,
+
         earlyReturn: true,
         strictBooleans: true,
         carbon: true,

src/Data/StoryblokData.php

@@ -5,6 +5,7 @@
 namespace Storyblok\ManagementApi\Data;
 
 use ArrayAccess;
+use ArrayObject;
 use Countable;
 use Iterator;
 
@@ -121,7 +122,7 @@ public function getInt(mixed $key, int|null $defaultValue = null, string $charNe
 
     public function getBoolean(mixed $key, bool $defaultValue = false, string $charNestedKey = "."): bool
     {
-        $returnValue = $this->get($key, false, $charNestedKey);
+        $returnValue = $this->get($key, $defaultValue, $charNestedKey);
 
         if (is_scalar($returnValue)) {
             return boolval($returnValue);
@@ -130,6 +131,25 @@ public function getBoolean(mixed $key, bool $defaultValue = false, string $charN
         return $defaultValue;
     }
 
+    /**
+     * @param mixed[] $defaultValue
+     * @return mixed[]
+     */
+    public function getArray(mixed $key, array $defaultValue = [], string $charNestedKey = "."): array
+    {
+        $returnValue = $this->get($key, $defaultValue, $charNestedKey);
+
+        if (is_scalar($returnValue)) {
+            return [strval($returnValue) ];
+        }
+
+        if ($returnValue instanceof StoryblokData) {
+            return $returnValue->toArray();
+        }
+
+        return $defaultValue;
+    }
+
     public function getFormattedDateTime(
         mixed $key,
         string $defaultValue = "",

src/Data/WorkflowData.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Data;
+
+use Storyblok\ManagementApi\Data\StoryblokData;
+use Storyblok\ManagementApi\StoryblokUtils;
+
+class WorkflowData extends StoryblokData
+{
+    /**
+     * @param array<string, array<mixed>> $data
+     */
+    public static function makeFromResponse(array $data = []): self
+    {
+        return new self($data["workflow"] ?? []);
+    }
+
+    #[\Override]
+    public static function make(array $data = []): self
+    {
+        return new self($data);
+    }
+
+    public function setName(string $name): void
+    {
+        $this->set('name', $name);
+    }
+
+
+
+    public function name(): string
+    {
+        return $this->getString('name', "");
+    }
+
+    public function id(): string
+    {
+        return $this->getString('id', "");
+    }
+
+    public function isDefault(): bool
+    {
+        return $this->getBoolean('is_default', false);
+    }
+
+    /**
+     * @return mixed[]|null
+     */
+    public function contentTypes(): null|array
+    {
+        return $this->getArray('content_types', []);
+    }
+
+}

src/Data/WorkflowsData.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Data;
+
+class WorkflowsData extends StoryblokData
+{
+    #[\Override]
+    public function getDataClass(): string
+    {
+        return WorkflowData::class;
+    }
+
+    #[\Override]
+    public static function make(array $data = []): self
+    {
+        return new self($data);
+    }
+
+    /**
+     * @param array<string, array<mixed>> $data
+     */
+    public static function makeFromResponse(array $data = []): self
+    {
+        return new self($data["workflows"] ?? []);
+    }
+
+
+    public function howManyWorkflows(): int
+    {
+        return $this->count();
+    }
+
+}

src/Endpoints/TagApi.php

@@ -72,7 +72,7 @@ public function update(string $name, string $newName): StoryblokResponseInterfac
     {
         return $this->makeRequest(
             "POST",
-            "/v1/spaces/" . $this->spaceId . '/tags' . $name,
+            "/v1/spaces/" . $this->spaceId . '/tags/' . $name,
             [
                 "body" => [
                     "name" => $newName,

src/Endpoints/WorkflowApi.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Storyblok\ManagementApi\Endpoints;
+
+use Storyblok\ManagementApi\Data\StoryblokData;
+use Storyblok\ManagementApi\Data\WorkflowData;
+use Storyblok\ManagementApi\Data\WorkflowsData;
+use Storyblok\ManagementApi\StoryblokResponseInterface;
+
+/**
+ *
+ */
+class WorkflowApi extends EndpointSpace
+{
+    /**
+     * @param string|string[]|null $contentType
+     * @throws \Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface
+     */
+    public function list(
+        string|array|null $contentType = null,
+    ): StoryblokResponseInterface {
+        $options = [];
+        if (null !== $contentType) {
+            if (is_array($contentType)) {
+                $contentType = implode(',', $contentType);
+            }
+
+            $options = [
+                'query' => [
+                    'content_type' => $contentType,
+                ],
+            ];
+
+        }
+
+        return $this->makeRequest(
+            "GET",
+            '/v1/spaces/' . $this->spaceId . '/workflows',
+            options: $options,
+            dataClass: WorkflowsData::class,
+        );
+    }
+
+    public function get(string|int $workflowId): StoryblokResponseInterface
+    {
+
+        return $this->makeRequest(
+            "GET",
+            '/v1/spaces/' . $this->spaceId . '/workflows/' . $workflowId,
+            dataClass: WorkflowData::class,
+        );
+    }
+
+
+    /**
+     * @param string|int $workflowId the workflow identifier
+     */
+    public function delete(string|int $workflowId): StoryblokResponseInterface
+    {
+        return $this->makeRequest(
+            "DELETE",
+            '/v1/spaces/' . $this->spaceId . '/workflows/' . $workflowId,
+        );
+    }
+
+    public function create(StoryblokData $storyblokData): StoryblokResponseInterface
+    {
+        return $this->makeRequest(
+            "POST",
+            "/v1/spaces/" . $this->spaceId . '/workflows',
+            [
+                "body" => [
+                    "workflow" => $storyblokData->toArray(),
+                ],
+            ],
+            dataClass: WorkflowData::class,
+        );
+    }
+
+    public function update(string|int $workflowId, StoryblokData $storyblokData): StoryblokResponseInterface
+    {
+        return $this->makeRequest(
+            "POST",
+            "/v1/spaces/" . $this->spaceId . '/workflows/' . $workflowId,
+            [
+                "body" => $storyblokData->toArray(),
+            ],
+            dataClass: WorkflowData::class,
+        );
+    }
+
+
+
+
+
+}

src/ManagementApiClient.php

@@ -11,6 +11,7 @@
 use Storyblok\ManagementApi\Endpoints\StoryApi;
 use Storyblok\ManagementApi\Endpoints\TagApi;
 use Storyblok\ManagementApi\Endpoints\UserApi;
+use Storyblok\ManagementApi\Endpoints\WorkflowApi;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 use Psr\Log\LoggerInterface;
@@ -99,6 +100,11 @@ public function tagApi(string|int $spaceId): TagApi
         return new TagApi($this->httpClient, $spaceId);
     }
 
+    public function workflowApi(string|int $spaceId): WorkflowApi
+    {
+        return new WorkflowApi($this->httpClient, $spaceId);
+    }
+
     public function managementApi(): ManagementApi
     {
         return new ManagementApi($this->httpClient);

tests/Feature/Data/list-workflows.json

@@ -0,0 +1,19 @@
+{
+    "workflows": [
+        {
+            "id": 12345,
+            "content_types": [
+                "article"
+            ],
+            "is_default": false,
+            "name": "Article "
+        },
+        {
+            "id": 12346,
+            "content_types": [
+            ],
+            "is_default": true,
+            "name": "Default one"
+        }
+    ]
+}