[UC-3] Add create event for user method & add return type to getApiEndpointUrl

Author: DominikWolos

src/Api/AbstractClient.php

@@ -70,7 +70,7 @@ protected function getApiEndpointUrl(
         UserComApiAwareInterface $resource,
         string $endpoint,
         string $query = null,
-    ) {
+    ): string {
         $url = sprintf(
             '%s/%s/%s/',
             trim($resource->getUserComUrl(), '/'),

src/Api/UserApi.php

@@ -112,4 +112,18 @@ public function updateUserByCustomId(UserComApiAwareInterface $resource, string
             $this->buildOptions($resource, ['json' => $data]),
         );
     }
+
+    public function createEventForUser(UserComApiAwareInterface $resource, array $data): ?array
+    {
+        return $this->request(
+            $this->getApiEndpointUrl($resource, self::CREATE_EVENT_FOR_USER_BY_CUSTOM_ID_ENDPOINT),
+            Request::METHOD_POST,
+            $this->buildOptions($resource, [
+                'json' => $data,
+                'headers' => [
+                    'Content-Type' => 'application/json',
+                ],
+            ]),
+        );
+    }
 }

src/Api/UserApiInterface.php

@@ -21,15 +21,17 @@ interface UserApiInterface
 
     public const FIND_USER_ENDPOINT = 'users/search';
 
-    public const UPDATE_OR_CREATE_USER_ENDPOINT = '/users/update_or_create/';
+    public const GET_USER_ENDPOINT = '/users/%s';
+
+    public const CREATE_USER_ENDPOINT = '/users/';
 
     public const UPDATE_USER_ENDPOINT = '/users/%s';
 
-    public const UPDATE_USER_BY_CUSTOM_ID_ENDPOINT = '/users-by-id/%s';
+    public const UPDATE_OR_CREATE_USER_ENDPOINT = '/users/update_or_create/';
 
-    public const GET_USER_ENDPOINT = '/users/%s';
+    public const UPDATE_USER_BY_CUSTOM_ID_ENDPOINT = '/users-by-id/%s';
 
-    public const CREATE_USER_ENDPOINT = '/users/';
+    public const CREATE_EVENT_FOR_USER_BY_CUSTOM_ID_ENDPOINT = '/users-by-id/%s/events';
 
     public const MERGE_USERS_ENDPOINT = '/users/merge';
 
@@ -46,4 +48,8 @@ public function updateUser(UserComApiAwareInterface $resource, int $userId, arra
     public function createUser(UserComApiAwareInterface $resource, array $data): ?array;
 
     public function mergeUsers(UserComApiAwareInterface $resource, int $parentId, array $usersList): ?array;
+
+    public function updateUserByCustomId(UserComApiAwareInterface $resource, string $customId, array $data): ?array;
+
+    public function createEventForUser(UserComApiAwareInterface $resource, array $data): ?array;
 }