Updated articles api

Author: 0xRy4n

intercom_python_sdk/__init__.py

@@ -58,3 +58,4 @@
 from .core.configuration import Configuration
 from .core.api_base import create_api_client
 from .apis.tags_to_api import tags_to_api_dict as API_TAGS
+from .core.errors import IntercomErrorList

intercom_python_sdk/apis/articles/languages.py

@@ -0,0 +1,39 @@
+from enum import Enum
+class ArticleLanguages(Enum):
+    ARABIC = "ar"
+    BULGARIAN = "bg"
+    BRAZILIAN_PORTUGUESE = "pt-BR"
+    BOSNIAN = "bs"
+    CATALAN = "ca"
+    CZECH = "cs"
+    DANISH = "da"
+    GERMAN = "de"
+    GREEK = "el"
+    ENGLISH = "en"
+    SPANISH = "es"
+    ESTONIAN = "et"
+    FINNISH = "fi"
+    FRENCH = "fr"
+    HEBREW = "he"
+    HINDI = "hi"
+    CROATIAN = "hr"
+    HUNGARIAN = "hu"
+    INDONESIAN = "id"
+    ITALIAN = "it"
+    JAPANESE = "ja"
+    KOREAN = "ko"
+    LITHUANIAN = "lt"
+    LATVIAN = "lv"
+    NORWEGIAN = "nb"
+    DUTCH = "nl"
+    POLISH = "pl"
+    PORTUGUESE = "pt"
+    ROMANIAN = "ro"
+    RUSSIAN = "ru"
+    SLOVAK = "sk"
+    SLOVENIAN = "sl"
+    SWEDISH = "sv"
+    TURKISH = "tr"
+    VIETNAMESE = "vi"
+    CHINESE = "zh-CN"
+    TAIWANESE = "zh-TW"

intercom_python_sdk/apis/articles/models.py

@@ -26,12 +26,25 @@
 # From Current Package
 from ...core.model_base import ModelBase
 
+from .languages import ArticleLanguages
+
 # Type Check Imports - TYPE_CHECKING is assumed True by type-checkers but is False at runtime.
 # See: https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING
 if TYPE_CHECKING:
     from .api import ArticlesAPI
 
 
+class ArticleTranslation(ModelBase):
+    type: str
+
+    def __init__(self, *args, **kwargs):
+        self.type = kwargs.get('type', 'article_translated_content')
+
+        for language in ArticleLanguages:
+            locale_code = language.value
+            setattr(self, locale_code, kwargs.get(locale_code, None))
+
+
 class ArticleStatistics(ModelBase):
     """
     This model represents the statistics of an Article on Intercom.
@@ -428,7 +441,7 @@ def translated_content(self, translated_content: dict):
 
     # Methods
 
-    def update(self):
+    def update(self) -> 'Article':
         """
         Update the Article.
         """

intercom_python_sdk/apis/articles/schemas.py

@@ -11,12 +11,16 @@
 - [1] https://developers.intercom.com/intercom-api-reference/reference/the-article-model
 """
 
+# Built-in
+from enum import Enum
+
 # External
 import marshmallow
 from marshmallow import fields
 
 # From Current API
 from . import models as a_models
+from .languages import ArticleLanguages
 
 # From Current Package
 from ...core.schema_base import SchemaBase
@@ -65,34 +69,52 @@ class ArticleSchema(SchemaBase):
         default_locale (str): The default locale of the Article.
         statistics (dict): The statistics of the Article.
     """
-    id = fields.Int(required=True)
-    type = fields.Str(allow_none=True)
-    workspace_id = fields.Str(allow_none=True)
+    id = fields.Int(required=False)
+    type = fields.Str(allow_none=True, required=False)
+    workspace_id = fields.Str(allow_none=True, required=False)
     title = fields.Str(required=True)
-    description = fields.Str(allow_none=True)
-    body = fields.Str(required=True)
-    author_id = fields.Int(required=True)
-    state = fields.Str(allow_none=True)
-    created_at = fields.Int(allow_none=True)
-    updated_at = fields.Int(allow_none=True)
-    url = fields.Str(allow_none=True)
-    default_locale = fields.Str(allow_none=True)
-    translated_content = fields.Dict(values=fields.Str(), default='', allow_none=True)
-    statistics = fields.Nested(ArticleStatisticsSchema, allow_none=True)
-
-    parent_id = fields.Int(allow_none=True)
-    parent_type = fields.Str(allow_none=True)
+    description = fields.Str(allow_none=True, required=False)
+    body = fields.Str(required=False)
+    author_id = fields.Int(required=False)
+    state = fields.Str(allow_none=True, required=False)
+    created_at = fields.Int(allow_none=True, required=False)
+    updated_at = fields.Int(allow_none=True, required=False)
+    url = fields.Str(allow_none=True, required=False)
+    default_locale = fields.Str(allow_none=True, required=False)
+    translated_content = fields.Raw(allow_none=True, required=False)
+    statistics = fields.Nested(ArticleStatisticsSchema, allow_none=True, required=False)
+
+    parent_id = fields.Int(allow_none=True, required=False)
+    parent_type = fields.Str(allow_none=True, required=False)
 
     @marshmallow.post_load
     def make_article(self, data, **kwargs):
         return a_models.Article(**data)
 
 
+class ArticleTranslationSchema(SchemaBase):
+    """
+    This schema represents the translation of an Article on Intercom.
+    """
+    type = fields.Str(default="article_translated_content")
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        for language in ArticleLanguages:
+            locale_code = language.value
+            self.fields[locale_code] = fields.Str(allow_none=True, required=False)
+
+    @marshmallow.post_load
+    def make_article_translation(self, data, **kwargs):
+        return a_models.ArticleTranslation(**data)
+
+
+
 class ArticlePagesSchema(SchemaBase):
     """ Paging information for a list of Articles on Intercom. """
     type = fields.Str(default='pages')
     page = fields.Int()
-    next = fields.Url(allow_none=True)
+    next = fields.Url(allow_none=True, required=False)
     per_page = fields.Int(default=50)
     total_pages = fields.Int()
 
@@ -112,3 +134,5 @@ class ArticleListSchema(SchemaBase):
     @marshmallow.post_load
     def make_article_list(self, data, **kwargs):
         return a_models.ArticleList(**data)
+
+

intercom_python_sdk/core/__init__.py

@@ -8,3 +8,4 @@
 from . import api_base # noqa 
 from . import configuration
 from . import model_base
+from . import errors

intercom_python_sdk/schemas/__init__.py

@@ -22,6 +22,7 @@
     ArticleSchema, 
     ArticleListSchema, 
     ArticleStatisticsSchema, 
+    ArticleTranslationSchema
 )
 
 from ..apis.data_attributes.schemas import (