Merge branch 'hotfix/update' into 'main'

chore: generate models See merge request internal/api-models-php!1
bookboon · Aug 25, 2022 · 7adf56d · 7adf56d
2 parents 4574bdb + 52add62
commit 7adf56d
Show file tree

Hide file tree

Showing 32 changed files with 106 additions and 35 deletions.
diff --git a/ApiModels/AcademicBook.php b/ApiModels/AcademicBook.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books')]
 class AcademicBook extends Book
 {
 }
diff --git a/ApiModels/Advert.php b/ApiModels/Advert.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class Advert
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
     protected ?string $link = null;
     protected string $thumbnail = '';

diff --git a/ApiModels/Answer.php b/ApiModels/Answer.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class Answer
 {
     protected string $id = '';

diff --git a/ApiModels/AttributeRequest.php b/ApiModels/AttributeRequest.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class AttributeRequest
 {
     protected string $name = '';

diff --git a/ApiModels/AudioBook.php b/ApiModels/AudioBook.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books')]
 class AudioBook extends Book
 {
 }
diff --git a/ApiModels/AudioTalkBook.php b/ApiModels/AudioTalkBook.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books')]
 class AudioTalkBook extends Book
 {
 }
diff --git a/ApiModels/Author.php b/ApiModels/Author.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/authors')]
 class Author
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
 
     /** @var Book[]|null $books */

diff --git a/ApiModels/Book.php b/ApiModels/Book.php
@@ -2,10 +2,16 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books')]
 class Book
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
+
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_slug')]
     protected string $slug = '';
+
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_type')]
     protected string $type = '';
     protected ?string $abstract = null;
     protected ?string $authors = null;
@@ -24,13 +30,13 @@ class Book
     protected ?array $formats = null;
     protected ?string $homepage = null;
     protected ?string $isbn = null;
-    protected ?Language $language = null;
+    protected Language $language;
     protected ?\DateTime $liveUtcTime = null;
     protected ?int $pages = null;
     protected ?bool $premium = null;
     protected ?int $premiumLevel = null;
     protected string $priceLevel = '';
-    protected ?\DateTime $published = null;
+    protected \DateTime $published;
     protected ?Rating $rating = null;
 
     /** @var Review[]|null $reviews */
@@ -205,12 +211,12 @@ public function getIsbn(): ?string
         return $this->isbn;
     }
 
-    public function setLanguage(?Language $language): void
+    public function setLanguage(Language $language): void
     {
         $this->language = $language;
     }
 
-    public function getLanguage(): ?Language
+    public function getLanguage(): Language
     {
         return $this->language;
     }
@@ -265,12 +271,12 @@ public function getPriceLevel(): string
         return $this->priceLevel;
     }
 
-    public function setPublished(?\DateTime $published): void
+    public function setPublished(\DateTime $published): void
     {
         $this->published = $published;
     }
 
-    public function getPublished(): ?\DateTime
+    public function getPublished(): \DateTime
     {
         return $this->published;
     }
@@ -382,4 +388,10 @@ public function getVersion(): ?int
     {
         return $this->version;
     }
+
+    public function __construct()
+    {
+        $this->language = new Language();
+        $this->published = new \DateTime();
+    }
 }
diff --git a/ApiModels/BookChapter.php b/ApiModels/BookChapter.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books/{bookId}/chapters')]
 class BookChapter
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
     protected int $duration = 0;
     protected int $position = 0;

diff --git a/ApiModels/BookDetail.php b/ApiModels/BookDetail.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class BookDetail
 {
     protected string $body = '';

diff --git a/ApiModels/BookTimeTag.php b/ApiModels/BookTimeTag.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books/{bookId}/timetags')]
 class BookTimeTag
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
     protected string $name = '';
     protected int $offset = 0;

diff --git a/ApiModels/Category.php b/ApiModels/Category.php
@@ -2,9 +2,13 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/categories')]
 class Category
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
+
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_slug')]
     protected string $slug = '';
 
     /** @var Book[] $books */

diff --git a/ApiModels/Chat.php b/ApiModels/Chat.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class Chat
 {
     protected string $roomPassword = '';

diff --git a/ApiModels/ClassroomBook.php b/ApiModels/ClassroomBook.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/books')]
 class ClassroomBook extends Book
 {
 }
diff --git a/ApiModels/Exam.php b/ApiModels/Exam.php
@@ -2,11 +2,13 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/exams')]
 class Exam
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
-    protected ?Book $book = null;
-    protected ?Language $language = null;
+    protected Book $book;
+    protected Language $language;
     protected int $passScore = 0;
     protected int $questionsCount = 0;
     protected int $timeSeconds = 0;
@@ -22,22 +24,22 @@ public function getId(): string
         return $this->id;
     }
 
-    public function setBook(?Book $book): void
+    public function setBook(Book $book): void
     {
         $this->book = $book;
     }
 
-    public function getBook(): ?Book
+    public function getBook(): Book
     {
         return $this->book;
     }
 
-    public function setLanguage(?Language $language): void
+    public function setLanguage(Language $language): void
     {
         $this->language = $language;
     }
 
-    public function getLanguage(): ?Language
+    public function getLanguage(): Language
     {
         return $this->language;
     }
@@ -81,4 +83,10 @@ public function getTitle(): string
     {
         return $this->title;
     }
+
+    public function __construct()
+    {
+        $this->book = new Book();
+        $this->language = new Language();
+    }
 }
diff --git a/ApiModels/FrontPage.php b/ApiModels/FrontPage.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/frontpage')]
 class FrontPage
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_slug')]
     protected string $slug = '';
 
     /** @var Book[] $books */

diff --git a/ApiModels/Journey.php b/ApiModels/Journey.php
@@ -2,17 +2,21 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/journeys')]
 class Journey
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_id')]
     protected string $id = '';
     protected string $abstract = '';
 
     /** @var string[] $books */
     protected array $books = [];
     protected string $description = '';
+
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: 'isFeatured')]
     protected bool $featured = false;
-    protected ?Language $language = null;
-    protected ?\DateTime $published = null;
+    protected Language $language;
+    protected \DateTime $published;
 
     /** @var Thumbnail[] $thumbnail */
     protected array $thumbnail = [];
@@ -74,22 +78,22 @@ public function isFeatured(): bool
         return $this->featured;
     }
 
-    public function setLanguage(?Language $language): void
+    public function setLanguage(Language $language): void
     {
         $this->language = $language;
     }
 
-    public function getLanguage(): ?Language
+    public function getLanguage(): Language
     {
         return $this->language;
     }
 
-    public function setPublished(?\DateTime $published): void
+    public function setPublished(\DateTime $published): void
     {
         $this->published = $published;
     }
 
-    public function getPublished(): ?\DateTime
+    public function getPublished(): \DateTime
     {
         return $this->published;
     }
@@ -119,4 +123,10 @@ public function getTitle(): string
     {
         return $this->title;
     }
+
+    public function __construct()
+    {
+        $this->language = new Language();
+        $this->published = new \DateTime();
+    }
 }
diff --git a/ApiModels/Language.php b/ApiModels/Language.php
@@ -2,8 +2,10 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v1/languages')]
 class Language
 {
+    #[\Bookboon\JsonLDClient\Attributes\JsonLDProperty(mappedName: '_slug')]
     protected ?string $slug = null;
     protected string $code = '';
     protected ?string $id = null;

diff --git a/ApiModels/MetricsHeader.php b/ApiModels/MetricsHeader.php
@@ -2,6 +2,7 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '')]
 class MetricsHeader
 {
     protected ?string $name = null;

diff --git a/ApiModels/MetricsResult.php b/ApiModels/MetricsResult.php
@@ -2,14 +2,13 @@
 
 namespace Bookboon\ApiModels;
 
+#[\Bookboon\JsonLDClient\Attributes\JsonLDEntity(url: '/v2/metrics/query', singleton: true)]
 class MetricsResult
 {
     /** @var MetricsHeader[]|null $headers */
     protected ?array $headers = null;
-
-    /** @var object[]|null $parameters */
-    protected ?array $parameters = null;
-    protected ?string $query = null;
+    protected array $parameters = [];
+    protected string $query = '';
 
     /** @var object[]|null $results */
     protected ?array $results = null;
@@ -30,28 +29,22 @@ public function getHeaders(): ?array
         return $this->headers;
     }
 
-    /**
-     * @param object[]|null $parameters
-     */
-    public function setParameters(?array $parameters): void
+    public function setParameters(array $parameters): void
     {
         $this->parameters = $parameters;
     }
 
-    /**
-     * @return object[]|null
-     */
-    public function getParameters(): ?array
+    public function getParameters(): array
     {
         return $this->parameters;
     }
 
-    public function setQuery(?string $query): void
+    public function setQuery(string $query): void
     {
         $this->query = $query;
     }
 
-    public function getQuery(): ?string
+    public function getQuery(): string
     {
         return $this->query;
     }