Notes (#79)

* Added 'Notes' feature

* Fixed return type in 'NotesResponse.php'

* - Refactored variable names to camel case.
- Ran 'composer run lint && composer run lint-fix'

Co-authored-by: ryanopily <[email protected]>

Author: ryanopily

src/Client/Client.php

@@ -14,6 +14,7 @@
 use Instagram\SDK\Client\Features\FriendshipsFeaturesTrait;
 use Instagram\SDK\Client\Features\GeneralFeaturesTrait;
 use Instagram\SDK\Client\Features\MediaFeaturesTrait;
+use Instagram\SDK\Client\Features\NotesFeaturesTrait;
 use Instagram\SDK\Client\Features\SearchFeaturesTrait;
 use Instagram\SDK\Client\Features\UsersFeaturesTrait;
 use Instagram\SDK\Device\Builders\DeviceBuilder;
@@ -52,6 +53,7 @@ class Client
     use FeedFeaturesTrait;
     use FriendshipsFeaturesTrait;
     use MediaFeaturesTrait;
+    use NotesFeaturesTrait;
     use UsersFeaturesTrait;
 
     /** @var HttpClient */

src/Client/Features/NotesFeaturesTrait.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Instagram\SDK\Client\Features;
+
+use GuzzleHttp\Promise\PromiseInterface;
+use Instagram\SDK\Exceptions\InstagramException;
+use Instagram\SDK\Request\Http\Factories\PayloadSerializerFactory;
+use Instagram\SDK\Request\Utils\SignatureUtils;
+use Instagram\SDK\Response\Responses\Common\GeneralResponse;
+use Instagram\SDK\Response\Responses\Notes\NotesResponse;
+use Instagram\SDK\Response\Responses\ResponseEnvelope;
+
+/**
+ * Trait NotesFeaturesTrait
+ *
+ * @package            Instagram\SDK\Client\Features
+ * @phan-file-suppress PhanUnreferencedUseNormal
+ */
+trait NotesFeaturesTrait
+{
+
+    use DefaultFeaturesTrait;
+
+    /**
+     * Retrieve notes.
+     *
+     * @return PromiseInterface<NotesResponse|InstagramException>
+     */
+    public function notes(): PromiseInterface
+    {
+        return $this->authenticated(function (): PromiseInterface {
+            $request = $this->buildRequest('notes/get_notes/', new NotesResponse(), 'GET');
+
+            return $this->call($request);
+        });
+    }
+
+    /**
+     * Create a note.
+     *
+     * @param string $text
+     * @param int $audience
+     * @return PromiseInterface<GeneralResponse|InstagramException>
+     */
+    public function createNote(string $text, int $audience = 0): PromiseInterface
+    {
+        return $this->authenticated(function () use ($text, $audience): PromiseInterface {
+            $request = $this->buildRequest('notes/create_note/', new GeneralResponse(), 'POST')
+                ->addUuid($this->session)
+                ->addPayloadParam('text', $text)
+                ->addPayloadParam('audience', $audience);
+
+            return $this->call($request);
+        });
+    }
+}

src/Response/DTO/Notes/Note.php

@@ -0,0 +1,133 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Instagram\SDK\Response\DTO\Notes;
+
+use Instagram\SDK\Response\DTO\General\User;
+
+/**
+ * Class Note
+ *
+ * @package Instagram\SDK\Payloads\Notes
+ */
+final class Note
+{
+
+    /**
+     * @var int
+     */
+    private $id;
+
+    /**
+     * @var string
+     */
+    private $text;
+
+    /**
+     * @var int
+     */
+    private $userId;
+
+    /**
+     * @var User
+     */
+    private $user;
+
+    /**
+     * @var int
+     */
+    private $audience;
+
+    /**
+     * @var int
+     */
+    private $createdAt;
+
+    /**
+     * @var int
+     */
+    private $expiresAt;
+
+    /**
+     * @var bool
+     */
+    private $isEmojiOnly;
+
+    /**
+     * @var bool
+     */
+    private $hasTranslation;
+
+    /**
+     * @return int
+     */
+    public function getId(): int
+    {
+        return $this->id;
+    }
+
+    /**
+     * @return string
+     */
+    public function getText(): string
+    {
+        return $this->text;
+    }
+
+    /**
+     * @return int
+     */
+    public function getUserId(): int
+    {
+        return $this->userId;
+    }
+
+    /**
+     * @return User
+     */
+    public function getUser(): User
+    {
+        return $this->user;
+    }
+
+    /**
+     * @return int
+     */
+    public function getAudience(): int
+    {
+        return $this->audience;
+    }
+
+    /**
+     * @return int
+     */
+    public function getCreatedAt(): int
+    {
+        return $this->createdAt;
+    }
+
+    /**
+     * @return int
+     */
+    public function getExpiresAt(): int
+    {
+        return $this->expiresAt;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isEmojiOnly(): bool
+    {
+        return $this->isEmojiOnly;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getHasTranslation(): bool
+    {
+        return $this->hasTranslation;
+    }
+}

src/Response/Responses/Notes/NotesResponse.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Instagram\SDK\Response\Responses\Notes;
+
+use Instagram\SDK\Response\DTO\Notes\Note;
+use Instagram\SDK\Response\Responses\ResponseEnvelope;
+
+/**
+ * Class NotesResponse
+ *
+ * @package Instagram\SDK\Response\Responses\Notes
+ */
+final class NotesResponse extends ResponseEnvelope
+{
+
+    /**
+     * @var Note[]
+     */
+    private $items;
+
+    /**
+     * @return Note[]
+     */
+    public function getItems(): array
+    {
+        return $this->items;
+    }
+}

src/Traits/MakeNotesRequestAccessible.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Instagram\SDK\Traits;
+
+use Instagram\SDK\Client\Client;
+use Instagram\SDK\Exceptions\InstagramException;
+use Instagram\SDK\Response\Responses\Common\GeneralResponse;
+use Instagram\SDK\Response\Responses\Notes\NotesResponse;
+use Instagram\SDK\Utils\PromiseUtils;
+
+/**
+ * Trait MakeNotesRequestAccessible
+ *
+ * @package Instagram\SDK\Traits
+ */
+trait MakeNotesRequestAccessible
+{
+    /**
+     * Retrieve notes.
+     *
+     * @return NotesResponse
+     * @throws InstagramException in case of an error
+     */
+    public function notes(): NotesResponse
+    {
+        return PromiseUtils::wait($this->getClient()->notes());
+    }
+
+    /**
+     * Create a note.
+     *
+     * @param string $text
+     * @param int $audience
+     * @return GeneralResponse
+     * @throws InstagramException in case of an error
+     */
+    public function createNote(string $text, int $audience = 0): GeneralResponse
+    {
+        return PromiseUtils::wait($this->getClient()->createNote($text, $audience));
+    }
+
+    /**
+     * Returns the client.
+     *
+     * @return Client
+     */
+    abstract protected function getClient(): Client;
+}

src/Traits/MakeRequestsAccessible.php

@@ -22,6 +22,7 @@ trait MakeRequestsAccessible
     use MakeSearchRequestsAccessible;
     use MakeFriendshipsRequestsAccessible;
     use MakeMediaRequestsAccessible;
+    use MakeNotesRequestAccessible;
     use MakeUsersRequestAccessible;
 
     /**