CELLSCLOUD-10181 Add format parameter to some APIs to specify export file format in Python sdk

Author: nickliuaspose

README.md

@@ -393,6 +393,7 @@ Class | Method | HTTP request | Description
  - [WorksheetMovingRequest](docs/WorksheetMovingRequest.md)
  - [AutoFilter](docs/AutoFilter.md)
  - [AutoFilterResponse](docs/AutoFilterResponse.md)
+ - [AutoShapeResponse](docs/AutoShapeResponse.md)
  - [AutoShapes](docs/AutoShapes.md)
  - [AutoShapesResponse](docs/AutoShapesResponse.md)
  - [Cell](docs/Cell.md)
@@ -525,6 +526,7 @@ Class | Method | HTTP request | Description
  - [XlsSaveOptions](docs/XlsSaveOptions.md)
  - [XlsbSaveOptions](docs/XlsbSaveOptions.md)
  - [XpsSaveOptions](docs/XpsSaveOptions.md)
+ - [AutoShape](docs/AutoShape.md)
  - [ChartArea](docs/ChartArea.md)
  - [Legend](docs/Legend.md)
  - [OleObject](docs/OleObject.md)

asposecellscloud/__init__.py

@@ -101,6 +101,7 @@
 from .models.worksheet_moving_request import WorksheetMovingRequest
 from .models.auto_filter import AutoFilter
 from .models.auto_filter_response import AutoFilterResponse
+from .models.auto_shape_response import AutoShapeResponse
 from .models.auto_shapes import AutoShapes
 from .models.auto_shapes_response import AutoShapesResponse
 from .models.cell import Cell
@@ -233,6 +234,7 @@
 from .models.xls_save_options import XlsSaveOptions
 from .models.xlsb_save_options import XlsbSaveOptions
 from .models.xps_save_options import XpsSaveOptions
+from .models.auto_shape import AutoShape
 from .models.chart_area import ChartArea
 from .models.legend import Legend
 from .models.ole_object import OleObject

asposecellscloud/api_client.py

@@ -143,13 +143,17 @@ def __call_api(self, resource_path, method,
 
         # request url
         url = self.host + resource_path
+        
+        preload_content = _preload_content
+        if response_type == 'file':
+            preload_content = False
 
         # perform request and return response
         response_data = self.request(method, url,
                                      query_params=query_params,
                                      headers=header_params,
                                      post_params=post_params, body=body,
-                                     _preload_content=_preload_content,
+                                     _preload_content=preload_content,
                                      _request_timeout=_request_timeout)
 
         self.last_response = response_data

asposecellscloud/apis/cells_autoshapes_api.py

@@ -56,6 +56,7 @@ def cells_autoshapes_get_worksheet_autoshape(self, name, sheet_name, autoshape_n
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
         :param int autoshape_number: The autoshape number. (required)
+        :param str format: Exported format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
@@ -85,14 +86,15 @@ def cells_autoshapes_get_worksheet_autoshape_with_http_info(self, name, sheet_na
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
         :param int autoshape_number: The autoshape number. (required)
+        :param str format: Exported format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['name', 'sheet_name', 'autoshape_number', 'folder', 'storage']
+        all_params = ['name', 'sheet_name', 'autoshape_number', 'format', 'folder', 'storage']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -129,6 +131,8 @@ def cells_autoshapes_get_worksheet_autoshape_with_http_info(self, name, sheet_na
             path_params['autoshapeNumber'] = params['autoshape_number']
 
         query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))
         if 'folder' in params:
             query_params.append(('folder', params['folder']))
         if 'storage' in params:

asposecellscloud/apis/cells_ole_objects_api.py

@@ -301,6 +301,7 @@ def cells_ole_objects_get_worksheet_ole_object(self, name, sheet_name, object_nu
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
         :param int object_number: The object number. (required)
+        :param str format: The exported object format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
@@ -330,14 +331,15 @@ def cells_ole_objects_get_worksheet_ole_object_with_http_info(self, name, sheet_
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
         :param int object_number: The object number. (required)
+        :param str format: The exported object format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['name', 'sheet_name', 'object_number', 'folder', 'storage']
+        all_params = ['name', 'sheet_name', 'object_number', 'format', 'folder', 'storage']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -374,6 +376,8 @@ def cells_ole_objects_get_worksheet_ole_object_with_http_info(self, name, sheet_
             path_params['objectNumber'] = params['object_number']
 
         query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))
         if 'folder' in params:
             query_params.append(('folder', params['folder']))
         if 'storage' in params:

asposecellscloud/apis/cells_pictures_api.py

@@ -285,7 +285,7 @@ def cells_pictures_delete_worksheet_pictures_with_http_info(self, name, sheet_na
                                         _request_timeout=params.get('_request_timeout'),
                                         collection_formats=collection_formats)
 
-    def cells_pictures_get_worksheet_picture(self, name, sheet_name, picture_number, **kwargs):
+    def cells_pictures_get_worksheet_picture(self, name, sheet_name, picture_index, **kwargs):
         """
         GRead worksheet picture by number.
         This method makes a synchronous HTTP request by default. To make an
@@ -294,13 +294,14 @@ def cells_pictures_get_worksheet_picture(self, name, sheet_name, picture_number,
         >>> def callback_function(response):
         >>>     pprint(response)
         >>>
-        >>> thread = api.cells_pictures_get_worksheet_picture(name, sheet_name, picture_number, callback=callback_function)
+        >>> thread = api.cells_pictures_get_worksheet_picture(name, sheet_name, picture_index, callback=callback_function)
 
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
-        :param int picture_number: The picture number. (required)
+        :param int picture_index: The picture index. (required)
+        :param str format: The exported object format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
@@ -309,12 +310,12 @@ def cells_pictures_get_worksheet_picture(self, name, sheet_name, picture_number,
         """
         kwargs['_return_http_data_only'] = True
         if kwargs.get('callback'):
-            return self.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_number, **kwargs)
+            return self.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, **kwargs)
         else:
-            (data) = self.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_number, **kwargs)
+            (data) = self.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, **kwargs)
             return data
 
-    def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name, picture_number, **kwargs):
+    def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name, picture_index, **kwargs):
         """
         GRead worksheet picture by number.
         This method makes a synchronous HTTP request by default. To make an
@@ -323,21 +324,22 @@ def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name,
         >>> def callback_function(response):
         >>>     pprint(response)
         >>>
-        >>> thread = api.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_number, callback=callback_function)
+        >>> thread = api.cells_pictures_get_worksheet_picture_with_http_info(name, sheet_name, picture_index, callback=callback_function)
 
         :param callback function: The callback function
             for asynchronous request. (optional)
         :param str name: Document name. (required)
         :param str sheet_name: Worksheet name. (required)
-        :param int picture_number: The picture number. (required)
+        :param int picture_index: The picture index. (required)
+        :param str format: The exported object format.
         :param str folder: The document folder.
         :param str storage: storage name.
         :return: file
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['name', 'sheet_name', 'picture_number', 'folder', 'storage']
+        all_params = ['name', 'sheet_name', 'picture_index', 'format', 'folder', 'storage']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -358,9 +360,9 @@ def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name,
         # verify the required parameter 'sheet_name' is set
         if ('sheet_name' not in params) or (params['sheet_name'] is None):
             raise ValueError("Missing the required parameter `sheet_name` when calling `cells_pictures_get_worksheet_picture`")
-        # verify the required parameter 'picture_number' is set
-        if ('picture_number' not in params) or (params['picture_number'] is None):
-            raise ValueError("Missing the required parameter `picture_number` when calling `cells_pictures_get_worksheet_picture`")
+        # verify the required parameter 'picture_index' is set
+        if ('picture_index' not in params) or (params['picture_index'] is None):
+            raise ValueError("Missing the required parameter `picture_index` when calling `cells_pictures_get_worksheet_picture`")
 
 
         collection_formats = {}
@@ -370,10 +372,12 @@ def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name,
             path_params['name'] = params['name']
         if 'sheet_name' in params:
             path_params['sheetName'] = params['sheet_name']
-        if 'picture_number' in params:
-            path_params['pictureNumber'] = params['picture_number']
+        if 'picture_index' in params:
+            path_params['pictureIndex'] = params['picture_index']
 
         query_params = []
+        if 'format' in params:
+            query_params.append(('format', params['format']))
         if 'folder' in params:
             query_params.append(('folder', params['folder']))
         if 'storage' in params:
@@ -396,7 +400,7 @@ def cells_pictures_get_worksheet_picture_with_http_info(self, name, sheet_name,
         # Authentication setting
         auth_settings = []
 
-        return self.api_client.call_api('/cells/{name}/worksheets/{sheetName}/pictures/{pictureNumber}', 'GET',
+        return self.api_client.call_api('/cells/{name}/worksheets/{sheetName}/pictures/{pictureIndex}', 'GET',
                                         path_params,
                                         query_params,
                                         header_params,

asposecellscloud/apis/cells_workbook_api.py

@@ -630,9 +630,12 @@ def cells_workbook_get_workbook(self, name, **kwargs):
             for asynchronous request. (optional)
         :param str name: The document name. (required)
         :param str password: The document password.
+        :param str format: The exported file format.
         :param bool is_auto_fit: Set document rows to be autofit.
+        :param bool only_save_table: Only save table data.
         :param str folder: The document folder.
         :param str storage: storage name.
+        :param str out_path: The document output folder.
         :return: file
                  If the method is called asynchronously,
                  returns the request thread.
@@ -659,15 +662,18 @@ def cells_workbook_get_workbook_with_http_info(self, name, **kwargs):
             for asynchronous request. (optional)
         :param str name: The document name. (required)
         :param str password: The document password.
+        :param str format: The exported file format.
         :param bool is_auto_fit: Set document rows to be autofit.
+        :param bool only_save_table: Only save table data.
         :param str folder: The document folder.
         :param str storage: storage name.
+        :param str out_path: The document output folder.
         :return: file
                  If the method is called asynchronously,
                  returns the request thread.
         """
 
-        all_params = ['name', 'password', 'is_auto_fit', 'folder', 'storage']
+        all_params = ['name', 'password', 'format', 'is_auto_fit', 'only_save_table', 'folder', 'storage', 'out_path']
         all_params.append('callback')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -696,12 +702,18 @@ def cells_workbook_get_workbook_with_http_info(self, name, **kwargs):
         query_params = []
         if 'password' in params:
             query_params.append(('password', params['password']))
+        if 'format' in params:
+            query_params.append(('format', params['format']))
         if 'is_auto_fit' in params:
             query_params.append(('isAutoFit', params['is_auto_fit']))
+        if 'only_save_table' in params:
+            query_params.append(('onlySaveTable', params['only_save_table']))
         if 'folder' in params:
             query_params.append(('folder', params['folder']))
         if 'storage' in params:
             query_params.append(('storage', params['storage']))
+        if 'out_path' in params:
+            query_params.append(('outPath', params['out_path']))
 
         header_params = {}
 

asposecellscloud/models/__init__.py

@@ -101,6 +101,7 @@
 from .worksheet_moving_request import WorksheetMovingRequest
 from .auto_filter import AutoFilter
 from .auto_filter_response import AutoFilterResponse
+from .auto_shape_response import AutoShapeResponse
 from .auto_shapes import AutoShapes
 from .auto_shapes_response import AutoShapesResponse
 from .cell import Cell
@@ -233,6 +234,7 @@
 from .xls_save_options import XlsSaveOptions
 from .xlsb_save_options import XlsbSaveOptions
 from .xps_save_options import XpsSaveOptions
+from .auto_shape import AutoShape
 from .chart_area import ChartArea
 from .legend import Legend
 from .ole_object import OleObject