chore: add docblocks for autocompletion (#280)

* chore: add docblocks for autocompletion

* fix: support model casting

* fix phpcs and add comments

* Fix property type for parent in Department model

* fix phpcs

* Update castAttribute method signature to typed parameters

* set iterable types in CreateArticle

* set iterable types in CreateMessage

* set iterable types in CreateTicket

* set iterable types in UpdateTicket

* set iterable types in User Requests

* set iterable types in models

* fix phpstan contravariant error

* fix?

* fix phpcs

* refactor code

* fix

* chore: add missing `null` to properties

* chore: add missing null types

---------

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

Author: ju5t

src/Model/Core/Brand.php

@@ -4,6 +4,43 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property int $id
+ * @property string $name
+ * @property int $enabled
+ * @property string $system_url
+ * @property int|null $enable_ssl
+ * @property string|null $brand_colour
+ * @property string|null $frontend_logo
+ * @property string|null $frontend_logo_dark_mode
+ * @property string|null $website_url
+ * @property string|null $favicon
+ * @property string|null $favicon_dark_mode
+ * @property string $frontend_template
+ * @property string|null $operator_icon
+ * @property string|null $operator_template
+ * @property string $default_email
+ * @property string $global_email_header
+ * @property string $global_email_footer
+ * @property string $email_method
+ * @property string|null $smtp_host
+ * @property int|null $smtp_port
+ * @property string|null $smtp_encryption
+ * @property int|null $smtp_requires_auth
+ * @property string|null $smtp_auth_mech
+ * @property string|null $smtp_username
+ * @property string|null $smtp_password
+ * @property string|null $smtp_oauth
+ * @property string $default_country
+ * @property string $default_timezone
+ * @property string $date_format
+ * @property string $time_format
+ * @property string $default_language
+ * @property int $language_toggle
+ * @property int $created_at
+ * @property int $updated_at
+ * @property BrandTranslation[] $translations
+ */
 class Brand extends Model
 {
     /** @var array<string, string> */

src/Model/Core/BrandTranslation.php

@@ -4,6 +4,11 @@
 
 use SupportPal\ApiClient\Model\Translation;
 
+/**
+ * @property int $id
+ * @property string $name
+ * @property int $brand_id
+ */
 class BrandTranslation extends Translation
 {
     /** @var array<string, string> */

src/Model/Core/IpBan.php

@@ -4,6 +4,18 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property int $id
+ * @property string|null $ip
+ * @property string|null $reason
+ * @property bool $event_user
+ * @property bool $event_operator
+ * @property bool $event_api
+ * @property int $type
+ * @property int|null $expiry
+ * @property int $created_at
+ * @property int $updated_at
+ */
 class IpBan extends Model
 {
     /** @var array<string, string> */

src/Model/Core/Language.php

@@ -4,6 +4,17 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property int $id
+ * @property string $name
+ * @property string $code
+ * @property bool $enabled
+ * @property bool $upgrade_available
+ * @property string|null $version
+ * @property int $created_at
+ * @property int $updated_at
+ * @property string $formatted_name
+ */
 class Language extends Model
 {
     /** @var array<string, string> */

src/Model/Core/Request/CreateIpBan.php

@@ -4,6 +4,15 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property string $ip
+ * @property string $reason
+ * @property int $type
+ * @property bool $event_user
+ * @property bool $event_operator
+ * @property bool $event_api
+ * @property int $expiry_time
+ */
 class CreateIpBan extends Model
 {
     /** @var array<string, string> */

src/Model/Core/Request/CreateSpamRule.php

@@ -4,6 +4,12 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property string $text
+ * @property int $type
+ * @property bool $event_message
+ * @property bool $event_comment
+ */
 class CreateSpamRule extends Model
 {
     /** @var array<string, string> */

src/Model/Core/Request/CreateWhitelistedIp.php

@@ -4,6 +4,13 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property string $ip
+ * @property string $description
+ * @property bool $event_user
+ * @property bool $event_operator
+ * @property bool $event_api
+ */
 class CreateWhitelistedIp extends Model
 {
     /** @var array<string, string> */

src/Model/Core/SpamRule.php

@@ -4,6 +4,15 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property int $id
+ * @property string $text
+ * @property bool $event_message
+ * @property bool $event_comment
+ * @property int $type
+ * @property int $created_at
+ * @property int $updated_at
+ */
 class SpamRule extends Model
 {
     /** @var array<string, string> */

src/Model/Core/Upload.php

@@ -4,6 +4,17 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property string $hash
+ * @property string $filename
+ * @property string $folder
+ * @property string $mime
+ * @property string $size
+ * @property string|null $token
+ * @property string|null $session_id
+ * @property int $created_at
+ * @property int $updated_at
+ */
 class Upload extends Model
 {
     /** @var array<string, string> */

src/Model/Core/WhitelistedIp.php

@@ -4,6 +4,16 @@
 
 use SupportPal\ApiClient\Model\Model;
 
+/**
+ * @property int $id
+ * @property string|null $ip
+ * @property string|null $description
+ * @property bool $event_user
+ * @property bool $event_operator
+ * @property bool $event_api
+ * @property int $created_at
+ * @property int $updated_at
+ */
 class WhitelistedIp extends Model
 {
     /** @var array<string, string> */