Generating SDK with model renames (Azure#38108)

* Generating SDK with model name updates

* Fixing the missed api name change for SDT

* Updated the TypeSpec and re-generated the SDK with TranslationStatus id as string

* Fixing TranslationIds and DocumentIds renames in patched methods

* Updating changelog

Author: hamshavathimunibyraiah

sdk/translation/azure-ai-translation-document/CHANGELOG.md

@@ -2,13 +2,8 @@
 
 ## 1.1.0b2 (Unreleased)
 
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
 ### Other Changes
+- Renamed SingleDocumentTranslationClient's API from `document_translate` to `translate`
 
 ## 1.1.0b1 (2024-05-21)
 

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_model_base.py

@@ -5,7 +5,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
-# pylint: disable=protected-access, arguments-differ, signature-differs, broad-except, too-many-lines
+# pylint: disable=protected-access, broad-except
 
 import copy
 import calendar
@@ -574,7 +574,7 @@ def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None:
     def copy(self) -> "Model":
         return Model(self.__dict__)
 
-    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: disable=unused-argument
+    def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:
         if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated:
             # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping',
             # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object'
@@ -585,8 +585,8 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: di
             annotations = {
                 k: v
                 for mro_class in mros
-                if hasattr(mro_class, "__annotations__")  # pylint: disable=no-member
-                for k, v in mro_class.__annotations__.items()  # pylint: disable=no-member
+                if hasattr(mro_class, "__annotations__")
+                for k, v in mro_class.__annotations__.items()
             }
             for attr, rf in attr_to_rest_field.items():
                 rf._module = cls.__module__
@@ -601,8 +601,8 @@ def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self:  # pylint: di
 
     def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None:
         for base in cls.__bases__:
-            if hasattr(base, "__mapping__"):  # pylint: disable=no-member
-                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore  # pylint: disable=no-member
+            if hasattr(base, "__mapping__"):
+                base.__mapping__[discriminator or cls.__name__] = cls  # type: ignore
 
     @classmethod
     def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]:
@@ -613,7 +613,7 @@ def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField
 
     @classmethod
     def _deserialize(cls, data, exist_discriminators):
-        if not hasattr(cls, "__mapping__"):  # pylint: disable=no-member
+        if not hasattr(cls, "__mapping__"):
             return cls(data)
         discriminator = cls._get_discriminator(exist_discriminators)
         if discriminator is None:
@@ -633,7 +633,7 @@ def _deserialize(cls, data, exist_discriminators):
                 discriminator_value = data.find(xml_name).text  # pyright: ignore
         else:
             discriminator_value = data.get(discriminator._rest_name)
-        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore # pylint: disable=no-member
+        mapped_cls = cls.__mapping__.get(discriminator_value, cls)  # pyright: ignore
         return mapped_cls._deserialize(data, exist_discriminators)
 
     def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]:

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_operations/_operations.py

@@ -81,7 +81,7 @@ def build_document_translation_list_translation_statuses_request(  # pylint: dis
     top: Optional[int] = None,
     skip: Optional[int] = None,
     maxpagesize: Optional[int] = None,
-    ids: Optional[List[str]] = None,
+    translation_ids: Optional[List[str]] = None,
     statuses: Optional[List[str]] = None,
     created_date_time_utc_start: Optional[datetime.datetime] = None,
     created_date_time_utc_end: Optional[datetime.datetime] = None,
@@ -105,8 +105,8 @@ def build_document_translation_list_translation_statuses_request(  # pylint: dis
         _params["skip"] = _SERIALIZER.query("skip", skip, "int")
     if maxpagesize is not None:
         _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int")
-    if ids is not None:
-        _params["ids"] = _SERIALIZER.query("ids", ids, "[str]", div=",")
+    if translation_ids is not None:
+        _params["ids"] = _SERIALIZER.query("translation_ids", translation_ids, "[str]", div=",")
     if statuses is not None:
         _params["statuses"] = _SERIALIZER.query("statuses", statuses, "[str]", div=",")
     if created_date_time_utc_start is not None:
@@ -211,7 +211,7 @@ def build_document_translation_list_document_statuses_request(  # pylint: disabl
     top: Optional[int] = None,
     skip: Optional[int] = None,
     maxpagesize: Optional[int] = None,
-    ids: Optional[List[str]] = None,
+    document_ids: Optional[List[str]] = None,
     statuses: Optional[List[str]] = None,
     created_date_time_utc_start: Optional[datetime.datetime] = None,
     created_date_time_utc_end: Optional[datetime.datetime] = None,
@@ -240,8 +240,8 @@ def build_document_translation_list_document_statuses_request(  # pylint: disabl
         _params["skip"] = _SERIALIZER.query("skip", skip, "int")
     if maxpagesize is not None:
         _params["maxpagesize"] = _SERIALIZER.query("maxpagesize", maxpagesize, "int")
-    if ids is not None:
-        _params["ids"] = _SERIALIZER.query("ids", ids, "[str]", div=",")
+    if document_ids is not None:
+        _params["ids"] = _SERIALIZER.query("document_ids", document_ids, "[str]", div=",")
     if statuses is not None:
         _params["statuses"] = _SERIALIZER.query("statuses", statuses, "[str]", div=",")
     if created_date_time_utc_start is not None:
@@ -284,7 +284,7 @@ def build_document_translation_get_supported_formats_request(  # pylint: disable
     return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs)
 
 
-def build_single_document_translation_document_translate_request(  # pylint: disable=name-too-long
+def build_single_document_translation_translate_request(  # pylint: disable=name-too-long
     *,
     target_language: str,
     source_language: Optional[str] = None,
@@ -581,7 +581,7 @@ def list_translation_statuses(
         *,
         top: Optional[int] = None,
         skip: Optional[int] = None,
-        ids: Optional[List[str]] = None,
+        translation_ids: Optional[List[str]] = None,
         statuses: Optional[List[str]] = None,
         created_date_time_utc_start: Optional[datetime.datetime] = None,
         created_date_time_utc_end: Optional[datetime.datetime] = None,
@@ -668,8 +668,8 @@ def list_translation_statuses(
          server can't honor top and/or skip, the server MUST return an error to the
          client informing about it instead of just ignoring the query options. Default value is None.
         :paramtype skip: int
-        :keyword ids: Ids to use in filtering. Default value is None.
-        :paramtype ids: list[str]
+        :keyword translation_ids: Ids to use in filtering. Default value is None.
+        :paramtype translation_ids: list[str]
         :keyword statuses: Statuses to use in filtering. Default value is None.
         :paramtype statuses: list[str]
         :keyword created_date_time_utc_start: the start datetime to get items after. Default value is
@@ -706,7 +706,7 @@ def prepare_request(next_link=None):
                     top=top,
                     skip=skip,
                     maxpagesize=maxpagesize,
-                    ids=ids,
+                    translation_ids=translation_ids,
                     statuses=statuses,
                     created_date_time_utc_start=created_date_time_utc_start,
                     created_date_time_utc_end=created_date_time_utc_end,
@@ -975,7 +975,7 @@ def list_document_statuses(
         *,
         top: Optional[int] = None,
         skip: Optional[int] = None,
-        ids: Optional[List[str]] = None,
+        document_ids: Optional[List[str]] = None,
         statuses: Optional[List[str]] = None,
         created_date_time_utc_start: Optional[datetime.datetime] = None,
         created_date_time_utc_end: Optional[datetime.datetime] = None,
@@ -1058,8 +1058,8 @@ def list_document_statuses(
          server can't honor top and/or skip, the server MUST return an error to the
          client informing about it instead of just ignoring the query options. Default value is None.
         :paramtype skip: int
-        :keyword ids: Ids to use in filtering. Default value is None.
-        :paramtype ids: list[str]
+        :keyword document_ids: Ids to use in filtering. Default value is None.
+        :paramtype document_ids: list[str]
         :keyword statuses: Statuses to use in filtering. Default value is None.
         :paramtype statuses: list[str]
         :keyword created_date_time_utc_start: the start datetime to get items after. Default value is
@@ -1097,7 +1097,7 @@ def prepare_request(next_link=None):
                     top=top,
                     skip=skip,
                     maxpagesize=maxpagesize,
-                    ids=ids,
+                    document_ids=document_ids,
                     statuses=statuses,
                     created_date_time_utc_start=created_date_time_utc_start,
                     created_date_time_utc_end=created_date_time_utc_end,
@@ -1160,7 +1160,7 @@ def get_next(next_link=None):
         return ItemPaged(get_next, extract_data)
 
     @distributed_trace
-    def _get_supported_formats(  # pylint: disable=protected-access
+    def _get_supported_formats(
         self, *, type: Optional[Union[str, _models.FileFormatType]] = None, **kwargs: Any
     ) -> _models._models.SupportedFileFormats:
         """Returns a list of supported document formats.
@@ -1235,7 +1235,7 @@ class SingleDocumentTranslationClientOperationsMixin(  # pylint: disable=name-to
 ):
 
     @overload
-    def document_translate(
+    def translate(
         self,
         body: _models.DocumentTranslateContent,
         *,
@@ -1279,7 +1279,7 @@ def document_translate(
         """
 
     @overload
-    def document_translate(
+    def translate(
         self,
         body: JSON,
         *,
@@ -1323,7 +1323,7 @@ def document_translate(
         """
 
     @distributed_trace
-    def document_translate(
+    def translate(
         self,
         body: Union[_models.DocumentTranslateContent, JSON],
         *,
@@ -1384,7 +1384,7 @@ def document_translate(
         _data_fields: List[str] = []
         _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields)
 
-        _request = build_single_document_translation_document_translate_request(
+        _request = build_single_document_translation_translate_request(
             target_language=target_language,
             source_language=source_language,
             category=category,

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_operations/_patch.py

@@ -43,7 +43,7 @@
     SingleDocumentTranslationClientOperationsMixin as GeneratedSingleDocumentTranslationClientOperationsMixin,
     JSON,
     ClsType,
-    build_single_document_translation_document_translate_request,
+    build_single_document_translation_translate_request,
 )
 
 from .._vendor import prepare_multipart_form_data
@@ -336,7 +336,7 @@ class SingleDocumentTranslationClientOperationsMixin(
 ):  # pylint: disable=name-too-long
 
     @overload
-    def document_translate(
+    def translate(
         self,
         body: _models.DocumentTranslateContent,
         *,
@@ -389,7 +389,7 @@ def document_translate(
         """
 
     @overload
-    def document_translate(
+    def translate(
         self,
         body: JSON,
         *,
@@ -433,7 +433,7 @@ def document_translate(
         """
 
     @distributed_trace
-    def document_translate(
+    def translate(
         self,
         body: Union[_models.DocumentTranslateContent, JSON],
         *,
@@ -502,7 +502,7 @@ def document_translate(
         _data_fields: List[str] = []
         _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields)
 
-        _request = build_single_document_translation_document_translate_request(
+        _request = build_single_document_translation_translate_request(
             target_language=target_language,
             source_language=source_language,
             category=category,

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_patch.py

@@ -19,7 +19,7 @@
 from ._operations._patch import DocumentTranslationLROPoller, DocumentTranslationLROPollingMethod, TranslationPolling
 from ._client import DocumentTranslationClient as GeneratedDocumentTranslationClient
 from .models import (
-    BatchRequest,
+    DocumentBatch,
     SourceInput,
     TranslationTarget,
     DocumentFilter,
@@ -107,7 +107,7 @@ def get_translation_input(args, kwargs, continuation_token):
 
             request = StartTranslationDetails(
                 inputs=[
-                    BatchRequest(
+                    DocumentBatch(
                         source=SourceInput(
                             source_url=source_url,
                             filter=DocumentFilter(prefix=prefix, suffix=suffix),
@@ -552,7 +552,7 @@ def list_translation_statuses(
             super().list_translation_statuses(
                 created_date_time_utc_start=created_after,
                 created_date_time_utc_end=created_before,
-                ids=translation_ids,
+                translation_ids=translation_ids,
                 orderby=order_by,
                 statuses=statuses,
                 top=top,
@@ -620,7 +620,7 @@ def list_document_statuses(  # type: ignore[override]
                 translation_id=translation_id,
                 created_date_time_utc_start=created_after,
                 created_date_time_utc_end=created_before,
-                ids=document_ids,
+                document_ids=document_ids,
                 orderby=order_by,
                 statuses=statuses,
                 top=top,

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_serialization.py

@@ -1,3 +1,4 @@
+# pylint: disable=too-many-lines
 # --------------------------------------------------------------------------
 #
 # Copyright (c) Microsoft Corporation. All rights reserved.
@@ -506,7 +507,6 @@ def _flatten_subtype(cls, key, objects):
     def _classify(cls, response, objects):
         """Check the class _subtype_map for any child classes.
         We want to ignore any inherited _subtype_maps.
-        Remove the polymorphic key from the initial data.
 
         :param dict response: The initial data
         :param dict objects: The class objects
@@ -518,7 +518,7 @@ def _classify(cls, response, objects):
 
             if not isinstance(response, ET.Element):
                 rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1]
-                subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None)
+                subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None)
             else:
                 subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response)
             if subtype_value: