[1.x] chore: add purified_description to custom field models (#224)

* chore: add purified_description to custom field models

* fix phpcs

* add to translations too

* fix

* fix

* fix

Author: jshah4517

src/Model/Shared/CustomField.php

@@ -108,6 +108,12 @@ abstract class CustomField extends BaseModel
      */
     private $description;
 
+    /**
+     * @var string|null
+     * @SerializedName("purified_description")
+     */
+    private $purifiedDescription;
+
     /**
      * @var int|null
      * @SerializedName("type")
@@ -385,6 +391,25 @@ public function setDescription(?string $description): self
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getPurifiedDescription(): ?string
+    {
+        return $this->purifiedDescription;
+    }
+
+    /**
+     * @param string|null $description
+     * @return self
+     */
+    public function setPurifiedDescription(?string $description): self
+    {
+        $this->purifiedDescription = $description;
+
+        return $this;
+    }
+
     /**
      * @return int|null
      */

src/Model/Ticket/TicketCustomFieldTranslation.php

@@ -31,6 +31,12 @@ class TicketCustomFieldTranslation extends BaseTranslation
      */
     private $description;
 
+    /**
+     * @var string|null
+     * @SerializedName("purified_description")
+     */
+    private $purifiedDescription;
+
     /**
      * @var string|null
      * @SerializedName("regex_error_message")
@@ -113,6 +119,25 @@ public function setDescription(?string $description): self
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getPurifiedDescription(): ?string
+    {
+        return $this->purifiedDescription;
+    }
+
+    /**
+     * @param string|null $description
+     * @return self
+     */
+    public function setPurifiedDescription(?string $description): self
+    {
+        $this->purifiedDescription = $description;
+
+        return $this;
+    }
+
     /**
      * @return string|null
      */

src/Model/User/UserCustomFieldTranslation.php

@@ -31,6 +31,12 @@ class UserCustomFieldTranslation extends BaseTranslation
      */
     private $description;
 
+    /**
+     * @var string|null
+     * @SerializedName("purified_description")
+     */
+    private $purifiedDescription;
+
     /**
      * @var string|null
      * @SerializedName("regex_error_message")
@@ -113,6 +119,25 @@ public function setDescription(?string $description): self
         return $this;
     }
 
+    /**
+     * @return string|null
+     */
+    public function getPurifiedDescription(): ?string
+    {
+        return $this->purifiedDescription;
+    }
+
+    /**
+     * @param string|null $description
+     * @return self
+     */
+    public function setPurifiedDescription(?string $description): self
+    {
+        $this->purifiedDescription = $description;
+
+        return $this;
+    }
+
     /**
      * @return string|null
      */

test/DataFixtures/Ticket/TicketCustomFieldData.php

@@ -13,7 +13,8 @@ class TicketCustomFieldData extends BaseModelData
     public const DATA = [
         'id' => 1,
         'name' => 'Related Product/Service',
-        'description' => 'Please select an option if this ticket is related to one of your products/services.',
+        'description' => '<div class="sp-editor-content"><p>Please select an option if this ticket is related to one of your products/services.</p></div>',
+        'purified_description' => '<div class="sp-editor-content"><p>Please select an option if this ticket is related to one of your products/services.</p></div>',
         'type' => 5,
         'depends_on_field_id' => null,
         'depends_on_option_id' => null,

test/DataFixtures/User/UserCustomFieldData.php

@@ -13,7 +13,8 @@ class UserCustomFieldData extends BaseModelData
     public const DATA = [
         'id' => 1,
         'name' => 'test',
-        'description' => 'custom',
+        'description' => '<div class="sp-editor-content"><p>Custom</p></div>',
+        'purified_description' => '<div class="sp-editor-content"><p>Custom</p></div>',
         'type' => 0,
         'depends_on_field_id' => null,
         'depends_on_option_id' => null,

test/Unit/Config/ApiContextTest.php

@@ -94,7 +94,7 @@ public function provideGetApiUrlCases(): iterable
 
         yield [$apiContext, 'http://localhost:80/test/test/api/'];
 
-        $apiContext = (new ApiContext(self::HOST, self::TOKEN));
+        $apiContext = new ApiContext(self::HOST, self::TOKEN);
 
         yield [$apiContext, 'https://localhost:443/api/'];
 
@@ -120,7 +120,7 @@ public function provideGetApiPathCases(): iterable
 
         yield [$apiContext, '/test/test/api/'];
 
-        $apiContext = (new ApiContext(self::HOST, self::TOKEN));
+        $apiContext = new ApiContext(self::HOST, self::TOKEN);
 
         yield [$apiContext, '/api/'];
     }