feat/add-dictionaries-class/SDKPY-123

docs/source/Resources/Dictionaries/Dictionaries_Type.rst

@@ -0,0 +1,103 @@
+**Dictionaries Type**
+=====================
+
+
+.. _DictionaryCreateInfo:
+
+DictionaryCreateInfo
+-------------------
+
+    **Attributes:**
+
+        | name: str
+        | Name of the dictionary.
+
+        | slug: str
+        | Unique identifier slug for the dictionary.
+
+        | fallback: str
+        | First dictionary language E.g "en-US"
+
+
+.. _DictionaryLanguage:
+
+DictionaryLanguage
+-----------------
+
+    **Attributes:**
+
+        | code: str
+        | Language code E.g "en-US"
+
+        | active: bool
+        | Indicates if the language is active.
+
+
+.. _DictionaryInfo:
+
+DictionaryInfo(:ref:`DictionaryCreateInfo`)
+-------------
+
+    **Attributes:**
+
+        | id: :ref:`GenericID`
+        | Unique identifier for the dictionary.
+
+        | languages: List[:ref:`DictionaryLanguage`]
+        | List of languages supported by the dictionary.
+
+        | created_at: datetime
+        | Date and time when the dictionary was created.
+
+        | updated_at: datetime
+        | Date and time when the dictionary was last updated.
+
+
+.. _LanguageData:
+
+LanguageData
+-----------
+
+    **Attributes:**
+
+        | Dict[str, str]
+        | Dictionary of key-value pairs for translations.
+
+
+.. _LanguageEditData:
+
+LanguageEditData
+--------------
+
+    **Attributes:**
+
+        | dictionary: :ref:`LanguageData`
+        | The dictionary containing the translations.
+
+        | active: bool
+        | Indicates if the language is active.
+
+
+.. _LanguageInfoQuery:
+
+LanguageInfoQuery
+---------------
+
+    **Attributes:**
+
+        | fallback: Optional[bool]
+        | Whether to return fallback language data if requested language is not found.
+
+
+.. _DictionaryQuery:
+
+DictionaryQuery(:ref:`Query`)
+--------------
+
+    **Attributes:**
+
+        | fields: Optional[Literal["name", "slug", "languages", "fallback", "created_at", "updated_at"]]
+        | List of fields to include in the query results.
+
+        | filter: Optional[:ref:`DictionaryInfo`]
+        | Filter criteria for the query.

docs/source/Resources/Dictionaries/index.rst

@@ -0,0 +1,289 @@
+**Dictionaries**
+==========
+
+Manage dictionaries in your application.
+
+========
+list
+========
+
+Lists all dictionaries from your application with pagination support.
+
+See: `Dictionaries <https://help.tago.io/portal/en/kb/articles/487-dictionaries>`_
+
+    **Parameters:**
+
+        | *Optional* **queryObj**: :ref:`DictionaryQuery`
+        | Query parameters to filter the results.
+
+        .. code-block::
+            :caption: **Default queryObj:**
+
+            queryObj = {
+                "page": 1,
+                "fields": ["id", "name", "slug", "languages"],
+                "filter": {},
+                "amount": 20,
+                "orderBy": ["name", "asc"]
+            }
+
+    **Returns:**
+
+        | list[:ref:`DictionaryInfo`]
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.list({
+            "page": 1,
+            "fields": ["id", "name", "slug"],
+            "amount": 10,
+            "orderBy": ["name", "asc"]
+        })
+        print(result)  # [{'id': 'dictionary-id-123', 'name': 'My Dictionary', 'slug': 'DICT'}, ...]
+
+
+========
+create
+========
+
+Creates a new dictionary in your application.
+
+See: `Using Dictionaries (Multi-Language) <https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language>`_
+
+    **Parameters:**
+
+        | **dictionaryObj**: :ref:`DictionaryCreateInfo`
+        | Dictionary information
+
+    **Returns:**
+
+        | dict
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.create({
+            "name": "My Dictionary",
+            "slug": "DICT",
+        })
+        print(result["dictionary"])  # dictionary-id-123
+
+
+========
+edit
+========
+
+Modifies an existing dictionary's properties.
+
+See: `Using Dictionaries (Multi-Language) <https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+        | **dictionaryObj**: dict
+        | Dictionary information to update
+
+    **Returns:**
+
+        | string
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.edit("dictionary-id-123", {
+            "name": "Updated Dictionary",
+        })
+        print(result)  # Successfully Updated
+
+
+========
+delete
+========
+
+Deletes a dictionary from your application.
+
+See: `Using Dictionaries (Multi-Language) <https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+    **Returns:**
+
+        | string
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.delete("dictionary-id-123")
+        print(result)  # Successfully Removed
+
+
+========
+info
+========
+
+Retrieves detailed information about a specific dictionary.
+
+See: `Dictionaries <https://help.tago.io/portal/en/kb/articles/487-dictionaries>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+    **Returns:**
+
+        | :ref:`DictionaryInfo`
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.info("dictionary-id-123")
+        print(result)  # {'id': 'dictionary-id-123', 'name': 'My Dictionary', 'slug': 'DICT', 'languages': ['en-US'], ...}
+
+
+===========
+languageEdit
+===========
+
+Edits a language's content in a dictionary.
+
+See: `Using Dictionaries (Multi-Language) <https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+        | **locale**: str
+        | Language code
+
+        | **languageObj**: :ref:`LanguageEditData`
+        | Language data to update
+
+    **Returns:**
+
+        | string
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.languageEdit("dictionary-id-123", "en-US", {
+            "dictionary": {"HELLO": "Hello"},
+            "active": True
+        })
+        print(result)  # Dictionary language Successfully Updated
+
+
+===========
+languageDelete
+===========
+
+Removes a language from a dictionary.
+
+See: `Using Dictionaries (Multi-Language) <https://help.tago.io/portal/en/kb/articles/489-using-dictionaries-multi-language>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+        | **locale**: str
+        | Language code
+
+    **Returns:**
+
+        | string
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.languageDelete("dictionary-id-123", "en-US")
+        print(result)
+
+
+===========
+languageInfo
+===========
+
+Retrieves language-specific content from a dictionary by ID.
+
+See: `Dictionaries <https://help.tago.io/portal/en/kb/articles/487-dictionaries>`_
+
+    **Parameters:**
+
+        | **dictionaryID**: str
+        | Dictionary ID
+
+        | **locale**: str
+        | Language code
+
+        | *Optional* **queryObj**: :ref:`LanguageInfoQuery`
+        | Query options
+
+    **Returns:**
+
+        | :ref:`LanguageData`
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.languageInfo("dictionary-id-123", "en-US", {
+            "fallback": True
+        })
+        print(result)  # {'ACCEPT': 'Accept', 'ACCEPTED': 'Accepted', ...}
+
+
+=================
+languageInfoBySlug
+=================
+
+Retrieves language-specific content from a dictionary by its slug.
+
+See: `Dictionaries <https://help.tago.io/portal/en/kb/articles/487-dictionaries>`_
+
+    **Parameters:**
+
+        | **slug**: str
+        | Dictionary slug
+
+        | **locale**: str
+        | Language code
+
+        | *Optional* **queryObj**: :ref:`LanguageInfoQuery`
+        | Query options
+
+    **Returns:**
+
+        | :ref:`LanguageData`
+
+    .. code-block:: python
+
+        from tagoio_sdk import Resources
+
+        resources = Resources()
+        result = resources.dictionaries.languageInfoBySlug("SLUG", "en-US", {
+            "fallback": True
+        })
+        print(result)