Merge branch 'master' into release

Author: YaroslawEkimov

README.md

@@ -16,6 +16,11 @@ Python Cloud SDK wraps Aspose.Words Cloud API so you could seamlessly integrate
 - [Convert a document to desired file format](https://docs.aspose.cloud/display/wordscloud/Convert+Document+to+Destination+Format+with+Detailed+Settings+and+Save+Result+to+Storage) along with detailed settings.
 - Convert an encrypted PDF document into Word document format.
 
+## Enhancements in Version 24.6
+
+- Added the 'TranslateNodeId' method to transalate a node id to a node path.
+
+
 ## Enhancements in Version 24.5
 
 - Added the support of multistorage operations. Saving a file as a result of an operation can be performed in a specific storage, when, used file path in the next format '@storage:path/to/file.doc'.

asposewordscloud/__init__.py

@@ -258,6 +258,7 @@
 from asposewordscloud.models.text_save_options_data import TextSaveOptionsData
 from asposewordscloud.models.tiff_save_options_data import TiffSaveOptionsData
 from asposewordscloud.models.time_zone_info_data import TimeZoneInfoData
+from asposewordscloud.models.translate_node_id_response import TranslateNodeIdResponse
 from asposewordscloud.models.user_information import UserInformation
 from asposewordscloud.models.watermark_data_image import WatermarkDataImage
 from asposewordscloud.models.watermark_data_text import WatermarkDataText

asposewordscloud/api_client.py

@@ -323,6 +323,7 @@ class ApiClient(object):
         'TextSaveOptionsData, _': asposewordscloud.models.TextSaveOptionsData,
         'TiffSaveOptionsData, _': asposewordscloud.models.TiffSaveOptionsData,
         'TimeZoneInfoData, _': asposewordscloud.models.TimeZoneInfoData,
+        'TranslateNodeIdResponse, _': asposewordscloud.models.TranslateNodeIdResponse,
         'UserInformation, _': asposewordscloud.models.UserInformation,
         'WatermarkDataImage, _': asposewordscloud.models.WatermarkDataImage,
         'WatermarkDataText, _': asposewordscloud.models.WatermarkDataText,
@@ -347,12 +348,12 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
 
         self.pool = None
         self.rest_client = rest.RESTClientObject(configuration)
-        self.default_headers = {'x-aspose-client': 'python sdk', 'x-aspose-client-version': '24.5'}
+        self.default_headers = {'x-aspose-client': 'python sdk', 'x-aspose-client-version': '24.6'}
         if header_name is not None:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'python sdk 24.5'
+        self.user_agent = 'python sdk 24.6'
 
     def __del__(self):
         if not self.pool is None:

asposewordscloud/apis/words_api.py

@@ -23519,6 +23519,163 @@ def split_document_online_with_http_info(self, request, **kwargs):  # noqa: E501
             collection_formats=http_params['collection_formats']))
 
 
+    def translate_node_id(self, request, **kwargs):  # noqa: E501
+        """Translate a node id to a node path.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass is_async=True
+
+        :param is_async bool
+        :param name str : The filename of the input document. (required)
+        :param node_id str : The node identifier. Identifier examples: id0.0.0. (required)
+        :param folder str : Original document folder.
+        :param storage str : Original document storage.
+        :param load_encoding str : Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+        :param password str : Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
+        :param encrypted_password str : Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
+        :return: TranslateNodeIdResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        try:
+            if kwargs.get('is_async'):
+                return self.translate_node_id_with_http_info(request, **kwargs)  # noqa: E501
+            data = self.translate_node_id_with_http_info(request, **kwargs)  # noqa: E501
+            return data
+        except ApiException as e:
+            if e.status == 401:
+                self.api_client.request_token()
+                if kwargs.get('is_async'):
+                    return self.translate_node_id_with_http_info(request, **kwargs)  # noqa: E501
+            data = self.translate_node_id_with_http_info(request, **kwargs)  # noqa: E501
+            return data
+        
+    def translate_node_id_with_http_info(self, request, **kwargs):  # noqa: E501
+        """Translate a node id to a node path.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass is_async=True
+
+        :param is_async bool
+        :param request TranslateNodeIdRequest object with parameters
+        :return: TranslateNodeIdResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        params = locals()
+        params['is_async'] = ''
+        params['_preload_content'] = True
+        params['_request_timeout'] = self.timeout
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method translate_node_id" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        http_params = request.create_http_request(self.api_client, self)
+
+        # Authentication setting
+        auth_settings = ['JWT']  # noqa: E501
+
+        self.api_client.handle_password(http_params, self)
+
+        return request.deserialize_response(self.api_client, self.api_client.call_api(
+            http_params['path'],
+            http_params['method'],
+            http_params['query_params'],
+            http_params['header_params'],
+            body=None,
+            post_params=http_params['form_params'],
+            response_type=http_params['response_type'],  # noqa: E501
+            auth_settings=auth_settings,
+            is_async=params.get('is_async'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=http_params['collection_formats']))
+
+
+    def translate_node_id_online(self, request, **kwargs):  # noqa: E501
+        """Translate a node id to a node path.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass is_async=True
+
+        :param is_async bool
+        :param document file : The document. (required)
+        :param node_id str : The node identifier. Identifier examples: id0.0.0. (required)
+        :param load_encoding str : Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+        :param password str : Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
+        :param encrypted_password str : Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
+        :return: TranslateNodeIdResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        try:
+            if kwargs.get('is_async'):
+                return self.translate_node_id_online_with_http_info(request, **kwargs)  # noqa: E501
+            data = self.translate_node_id_online_with_http_info(request, **kwargs)  # noqa: E501
+            return data
+        except ApiException as e:
+            if e.status == 401:
+                self.api_client.request_token()
+                if kwargs.get('is_async'):
+                    return self.translate_node_id_online_with_http_info(request, **kwargs)  # noqa: E501
+            data = self.translate_node_id_online_with_http_info(request, **kwargs)  # noqa: E501
+            return data
+        
+    def translate_node_id_online_with_http_info(self, request, **kwargs):  # noqa: E501
+        """Translate a node id to a node path.  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass is_async=True
+
+        :param is_async bool
+        :param request TranslateNodeIdOnlineRequest object with parameters
+        :return: TranslateNodeIdResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        params = locals()
+        params['is_async'] = ''
+        params['_preload_content'] = True
+        params['_request_timeout'] = self.timeout
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method translate_node_id_online" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        http_params = request.create_http_request(self.api_client, self)
+
+        # HTTP header `Accept`
+        http_params['header_params']['Accept'] = self.api_client.select_header_accept(
+            ['application/xml', 'application/json'])  # noqa: E501
+        # Authentication setting
+        auth_settings = ['JWT']  # noqa: E501
+
+        self.api_client.handle_password(http_params, self)
+
+        return request.deserialize_response(self.api_client, self.api_client.call_api(
+            http_params['path'],
+            http_params['method'],
+            http_params['query_params'],
+            http_params['header_params'],
+            body=None,
+            post_params=http_params['form_params'],
+            response_type=http_params['response_type'],  # noqa: E501
+            auth_settings=auth_settings,
+            is_async=params.get('is_async'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=http_params['collection_formats']))
+
+
     def unprotect_document(self, request, **kwargs):  # noqa: E501
         """Removes protection from the document.  # noqa: E501
 

asposewordscloud/configuration.py

@@ -262,6 +262,6 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 24.5\n"\
-               "SDK Package Version: 24.5".\
+               "Version of the API: 24.6\n"\
+               "SDK Package Version: 24.6".\
                format(env=sys.platform, pyversion=sys.version)

asposewordscloud/models/__init__.py

@@ -253,6 +253,7 @@
 from asposewordscloud.models.text_save_options_data import TextSaveOptionsData
 from asposewordscloud.models.tiff_save_options_data import TiffSaveOptionsData
 from asposewordscloud.models.time_zone_info_data import TimeZoneInfoData
+from asposewordscloud.models.translate_node_id_response import TranslateNodeIdResponse
 from asposewordscloud.models.user_information import UserInformation
 from asposewordscloud.models.watermark_data_image import WatermarkDataImage
 from asposewordscloud.models.watermark_data_text import WatermarkDataText

asposewordscloud/models/requests/__init__.py

@@ -291,6 +291,8 @@
 from asposewordscloud.models.requests.search_online_request import SearchOnlineRequest
 from asposewordscloud.models.requests.split_document_request import SplitDocumentRequest
 from asposewordscloud.models.requests.split_document_online_request import SplitDocumentOnlineRequest
+from asposewordscloud.models.requests.translate_node_id_request import TranslateNodeIdRequest
+from asposewordscloud.models.requests.translate_node_id_online_request import TranslateNodeIdOnlineRequest
 from asposewordscloud.models.requests.unprotect_document_request import UnprotectDocumentRequest
 from asposewordscloud.models.requests.unprotect_document_online_request import UnprotectDocumentOnlineRequest
 from asposewordscloud.models.requests.update_bookmark_request import UpdateBookmarkRequest

asposewordscloud/models/requests/translate_node_id_online_request.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose" file="translate_node_id_online_request.py">
+#   Copyright (c) 2024 Aspose.Words for Cloud
+# </copyright>
+# <summary>
+#   Permission is hereby granted, free of charge, to any person obtaining a copy
+#  of this software and associated documentation files (the "Software"), to deal
+#  in the Software without restriction, including without limitation the rights
+#  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all
+#  copies or substantial portions of the Software.
+#
+#  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#  SOFTWARE.
+# </summary>
+# -----------------------------------------------------------------------------------
+import json
+
+from six.moves.urllib.parse import quote
+from asposewordscloud import *
+from asposewordscloud.models import *
+from asposewordscloud.models.requests import *
+from asposewordscloud.models.responses import *
+
+class TranslateNodeIdOnlineRequest(BaseRequestObject):
+    """
+    Request model for translate_node_id_online operation.
+    Initializes a new instance.
+    :param document The document.
+    :param node_id The node identifier. Identifier examples: id0.0.0.
+    :param load_encoding Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.
+    :param password Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don't recommend to use the parameter to pass a plain password for direct call of API.
+    :param encrypted_password Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.
+    """
+
+    def __init__(self, document, node_id, load_encoding=None, password=None, encrypted_password=None):
+        self.document = document
+        self.node_id = node_id
+        self.load_encoding = load_encoding
+        self.password = password
+        self.encrypted_password = encrypted_password
+
+    def create_http_request(self, api_client, encryptor):
+        # verify the required parameter 'document' is set
+        if self.document is None:
+            raise ValueError("Missing the required parameter `document` when calling `translate_node_id_online`")  # noqa: E501
+        # verify the required parameter 'node_id' is set
+        if self.node_id is None:
+            raise ValueError("Missing the required parameter `node_id` when calling `translate_node_id_online`")  # noqa: E501
+
+        path = '/v4.0/words/online/get/translate/{nodeId}'
+        path_params = {}
+        if self.node_id is not None:
+            path_params['nodeId'] = self.node_id  # noqa: E501
+        else:
+            path_params['nodeId'] = ''  # noqa: E501
+
+        # path parameters
+        collection_formats = {}
+        if path_params:
+            path_params = api_client.sanitize_for_serialization(path_params)
+            path_params = api_client.parameters_to_tuples(path_params, collection_formats)
+            for k, v in path_params:
+                # specified safe chars, encode everything
+                path = path.replace(
+                    '{%s}' % k,
+                    quote(str(v), safe=api_client.configuration.safe_chars_for_path_param)
+                )
+
+        # remove optional path parameters
+        path = path.replace('//', '/')
+
+        query_params = []
+        if self.load_encoding is not None:
+                query_params.append(('loadEncoding', self.load_encoding))  # noqa: E501
+        if self.password is not None:
+                query_params.append(('password', self.password))  # noqa: E501
+        if self.encrypted_password is not None:
+                query_params.append(('encryptedPassword', self.encrypted_password))  # noqa: E501
+
+        header_params = {}
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = api_client.select_header_content_type(  # noqa: E501
+            ['multipart/form-data'])  # noqa: E501
+
+        file_content_params = []
+        form_params = []
+        if self.document is not None:
+            form_params.append(['document', self.document, 'file'])  # noqa: E501
+
+        for file_content_value in file_content_params:
+            file_content_value.encryptPassword(encryptor)
+            if file_content_value.source == 'Request':
+                form_params.append([file_content_value.reference, file_content_value.content, 'file'])  # noqa: E501
+
+        return {
+            "method": "PUT",
+            "path": path,
+            "body": None,
+            "query_params": query_params,
+            "header_params": header_params,
+            "form_params": form_params,
+            "collection_formats": collection_formats,
+            "response_type": 'TranslateNodeIdResponse'  # noqa: E501
+        }
+
+    def get_response_type(self):
+        return 'TranslateNodeIdResponse'  # noqa: E501
+
+    def deserialize_response(self, api_client, response):
+        return api_client.deserialize(response.data, response.getheaders(), TranslateNodeIdResponse)