Release Aspose.Cells Cloud SDK 24.2.1

aspose-cells-cloud · Feb 22, 2024 · 9ce98f9 · 9ce98f9
1 parent e51f7c4
commit 9ce98f9
Show file tree

Hide file tree

Showing 75 changed files with 3,201 additions and 119 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Aspose Pty Ltd
+Copyright (c) 2024 Aspose Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![](https://img.shields.io/badge/REST%20API-v3.0-lightgrey) ![Gem](https://img.shields.io/gem/v/aspose_cells_cloud) ![Gem](https://img.shields.io/gem/dt/aspose_cells_cloud) [![GitHub license](https://img.shields.io/github/license/aspose-cells-cloud/aspose-cells-cloud-ruby)](https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby/blob/master/LICENSE) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/aspose-cells-cloud/aspose-cells-cloud-ruby/23.12)
+![](https://img.shields.io/badge/REST%20API-v3.0-lightgrey) ![Gem](https://img.shields.io/gem/v/aspose_cells_cloud) ![Gem](https://img.shields.io/gem/dt/aspose_cells_cloud) [![GitHub license](https://img.shields.io/github/license/aspose-cells-cloud/aspose-cells-cloud-ruby)](https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby/blob/master/LICENSE) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/aspose-cells-cloud/aspose-cells-cloud-ruby/24.2.1)
 
 
 # Ruby SDK for Spreadsheet Processing in the Cloud
@@ -22,20 +22,11 @@ Ruby Cloud SDK wraps Aspose.Cells REST API so you could seamlessly integrate Mic
 - [Convert Excel files to popular formats](https://docs.aspose.cloud/cells/convert-excel-workbook-to-different-file-formats/).
 
 
-## Feature & Enhancements in Version 23.12
+## Feature & Enhancements in Version 24.2.1
 
 Full list of issues covering all changes in this release:
 
-- Conversion APIs add region parameter.
-- Protection APIs add region parameter.
-- Assemble data API adds region parameter.
-- Merge files API adds region parameter.
-- Split files API adds region parameter.
-- Import data API adds region parameter.
-- Watermark API adds region parameter.
-- Clear object API adds region parameter.
-- Reverse data API adds region parameter.
-- Rotate data API adds region parameter.
+- Add the analyze excel api for analyze controller.
 
 ## Read & Write Spreadsheet Formats
 

diff --git a/docs/AnalyzeExcelRequest.md b/docs/AnalyzeExcelRequest.md
@@ -0,0 +1,16 @@
+# AsposeCellsCloud::Object::AnalyzeExcelRequest 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzeExcelRequest;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Files** | **ARRAY[FileInfo]** |  |
+**NeedThumbnail** | **boolean** |  |
+**BuildSuggestoinSheet** | **boolean** |  |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AnalyzeExcelResponse.md b/docs/AnalyzeExcelResponse.md
@@ -0,0 +1,14 @@
+# AsposeCellsCloud::Object::AnalyzeExcelResponse 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzeExcelResponse;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Suggestions** | **ARRAY[AnalyzeSuggestion]** |  |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AnalyzeSuggestion.md b/docs/AnalyzeSuggestion.md
@@ -0,0 +1,21 @@
+# AsposeCellsCloud::Object::AnalyzeSuggestion 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzeSuggestion;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Name** | **string** |  |
+**Filename** | **string** | Excel file name. |
+**SheetName** | **string** | The worksheet where the data is aAnalyzed. |
+**DateSourceType** | **string** | The type of data being analyzed. |
+**SuggestedOutputType** | **string** | Based on the results of the data analysis, suggestions for creating new data types are given. |
+**Description** | **string** | Based on the results of the data analysis, a business description of the new data object is created. |
+**DataSouceThumbnail** | **string** |  |
+**Thumbnail** | **string** |  |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AnalyzedColumnDescription.md b/docs/AnalyzedColumnDescription.md
@@ -0,0 +1,22 @@
+# AsposeCellsCloud::Object::AnalyzedColumnDescription 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzedColumnDescription;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Index** | **int** | Column index. |
+**ColumnIndex** | **int** | The true position index value of the column. |
+**Title** | **string** |  |
+**RepetitionRate** | **double** | When the repetition rate is high, can it be viewed as a group display? |
+**ColumnDataDataType** | **string** | The column type is identified, and the attributes of the column are determined after data analysis. |
+**NumberCategoryType** | **string** |  |
+**TextCategoryType** | **string** |  |
+**StyleNumber** | **int** |  |
+**columnDataExceptionDescription** | **string** | Column data exception description. |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AnalyzedResult.md b/docs/AnalyzedResult.md
@@ -0,0 +1,18 @@
+# AsposeCellsCloud::Object::AnalyzedResult 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzedResult;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Filename** | **string** |  |
+**Description** | **string** |  |
+**BasicStatistics** | **ExcelDataStatistics** |  |
+**Results** | **ARRAY[AnalyzedTableDescription]** |  |
+**SuggestedFile** | **string** | base64String Excel file |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AnalyzedTableDescription.md b/docs/AnalyzedTableDescription.md
@@ -0,0 +1,29 @@
+# AsposeCellsCloud::Object::AnalyzedTableDescription 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::AnalyzedTableDescription;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Name** | **string** |  |
+**SheetName** | **string** |  |
+**Columns** | **ARRAY[AnalyzedColumnDescription]** |  |
+**DateColumns** | **ARRAY[int?]** |  |
+**NumberColumns** | **ARRAY[int?]** |  |
+**TextColumns** | **ARRAY[int?]** |  |
+**ExceptionColumns** | **ARRAY[int?]** |  |
+**HasTableHeaderRow** | **boolean** |  |
+**HasTableTotalRow** | **boolean** |  |
+**StartDataColumnIndex** | **int** |  |
+**EndDataColumnIndex** | **int** |  |
+**StartDataRowIndex** | **int** |  |
+**EndDataRowIndex** | **int** |  |
+**Thumbnail** | **string** | Base64String |
+**DiscoverCharts** | **ARRAY[DiscoverChart]** |  |
+**DiscoverPivotTables** | **ARRAY[DiscoverPivotTable]** |  |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/AutoFitterOptions.md b/docs/AutoFitterOptions.md
@@ -9,7 +9,6 @@ use AsposeCellsCloud::Object::AutoFitterOptions;
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **AutoFitMergedCellsType** | **string** | Gets and set the type of auto fitting row height of merged cells. |
-**AutoFitMergedCells** | **boolean** | Indicates whether auto fit row height when the cells is merged in a row.                        The default value is false. |
 **IgnoreHidden** | **boolean** | Ignores the hidden rows/columns. |
 **OnlyAuto** | **boolean** | Indicates whether only fit the rows which height are not customed. |
 **DefaultEditLanguage** | **string** | Gets or sets default edit language. |

diff --git a/docs/CellArea.md b/docs/CellArea.md
@@ -8,10 +8,10 @@ use AsposeCellsCloud::Object::CellArea;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**EndColumn** | **int** |  |
-**EndRow** | **int** |  |
-**StartColumn** | **int** |  |
-**StartRow** | **int** |  |  
+**EndColumn** | **int** | The end column index. |
+**EndRow** | **int** | The end row index. |
+**StartColumn** | **int** | The start column index. |
+**StartRow** | **int** | The start row index. |  
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/CellsCloudFileInfo.md b/docs/CellsCloudFileInfo.md
@@ -8,10 +8,10 @@ use AsposeCellsCloud::Object::CellsCloudFileInfo;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**Name** | **string** |  |
-**Size** | **int** |  |
-**Folder** | **string** |  |
-**Storage** | **string** |  |  
+**Name** | **string** | The file name. |
+**Size** | **int** | The file size. |
+**Folder** | **string** | The file position. |
+**Storage** | **string** | The storage name. |  
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/CellsDocumentProperties.md b/docs/CellsDocumentProperties.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Object::CellsDocumentProperties;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**DocumentPropertyList** | **ARRAY[CellsDocumentProperty]** |  |  
+**DocumentPropertyList** | **ARRAY[CellsDocumentProperty]** | Document property list. |  
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/Chart.md b/docs/Chart.md
@@ -46,8 +46,8 @@ Name | Type | Description | Notes
 **SideWall** | **LinkElement** | Returns a  object that represents the side wall of a 3-D chart. |
 **SizeWithWindow** | **boolean** | True if Microsoft Excel resizes the chart to match the size of the chart sheet window. |
 **Style** | **int** | Gets and sets the builtin style. |
-**Title** | **LinkElement** | Gets the chart's title. |
-**Type** | **string** | Gets or sets a chart's type. |
+**Title** | **LinkElement** |  |
+**Type** | **string** |  |
 **ValueAxis** | **LinkElement** | Gets the chart's Y axis. |
 **Walls** | **LinkElement** | Returns a  object that represents the walls of a 3-D chart. |
 **WallsAndGridlines2D** | **boolean** | True if gridlines are drawn two-dimensionally on a 3-D chart. |

diff --git a/docs/Color.md b/docs/Color.md
@@ -8,10 +8,10 @@ use AsposeCellsCloud::Object::Color;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**A** | **int** |  |
-**R** | **int** |  |
-**G** | **int** |  |
-**B** | **int** |  |  
+**A** | **int** | Gets the alpha component value of this System.Drawing.Color structure.             |
+**R** | **int** | Gets the red component value of this System.Drawing.Color structure.             |
+**G** | **int** | Gets the green component value of this System.Drawing.Color structure. |
+**B** | **int** | Gets the blue component value of this System.Drawing.Color structure.             |  
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/ColorFilter.md b/docs/ColorFilter.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Object::ColorFilter;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**FilterByFillColor** | **boolean** | Flag indicating whether filter by the cell's fill color.  |
+**FilterByFillColor** | **boolean** | Whether filter by the cell's fill color.             |
 **Pattern** | **string** |  |
 **Color** | **CellsColor** |  |
 **ForegroundColorColor** | **CellsColor** |  |

diff --git a/docs/Columns.md b/docs/Columns.md
@@ -8,9 +8,9 @@ use AsposeCellsCloud::Object::Columns;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**MaxColumn** | **int** |  |
-**ColumnsCount** | **int** |  |
-**ColumnsList** | **ARRAY[LinkElement]** |  |
+**MaxColumn** | **int** | The max column index. |
+**ColumnsCount** | **int** | Column count. |
+**ColumnsList** | **ARRAY[LinkElement]** | Columns list. |
 **link** | **Link** |  |  
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/docs/DeleteMetadataRequest.md b/docs/DeleteMetadataRequest.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Request::DeleteMetadata;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **string** | Cells document property name. |
+**file** | **string** | File to upload |
 **type** | **string** | Cells document property name. |
 **out_format** | **string** | The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers) |
 **password** | **string** | The password needed to open an Excel file. |

diff --git a/docs/DiscoverChart.md b/docs/DiscoverChart.md
@@ -0,0 +1,19 @@
+# AsposeCellsCloud::Object::DiscoverChart 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::DiscoverChart;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Name** | **string** |  |
+**SheetName** | **string** |  |
+**Title** | **string** |  |
+**Type** | **string** |  |
+**DataRange** | **string** |  |
+**Thumbnail** | **string** | Base64String |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/DiscoverPivotTable.md b/docs/DiscoverPivotTable.md
@@ -0,0 +1,20 @@
+# AsposeCellsCloud::Object::DiscoverPivotTable 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::DiscoverPivotTable;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Name** | **string** |  |
+**Title** | **string** |  |
+**DataRange** | **string** |  |
+**PivotFieldRows** | **ARRAY[int?]** | Represents row fields in a PivotTable report. |
+**PivotFieldColumns** | **ARRAY[int?]** | Represents column fields in a PivotTable report. |
+**PivotFieldData** | **ARRAY[int?]** | Represents data fields in a PivotTable report. |
+**Thumbnail** | **string** | Base64String |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/ExcelDataStatistics.md b/docs/ExcelDataStatistics.md
@@ -0,0 +1,15 @@
+# AsposeCellsCloud::Object::ExcelDataStatistics 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Object::ExcelDataStatistics;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**WorksheetDataStatistics** | **ARRAY[WorksheetDataStatistics]** |  |
+**NamesCount** | **int** |  |  
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/GetMetadataRequest.md b/docs/GetMetadataRequest.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Request::GetMetadata;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **string** | Cells document property name. |
+**file** | **string** | File to upload |
 **type** | **string** | Cells document property name. |
 **password** | **string** | The password needed to open an Excel file. |
 **check_excel_restriction** | **boolean** | Whether check restriction of excel file when user modify cells related objects. |  

diff --git a/docs/GetWorksheetColumnsRequest.md b/docs/GetWorksheetColumnsRequest.md
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **string** | The file name. |
 **sheet_name** | **string** | The worksheet name. |
-**offset** | **int** | The folder where the file is situated. |
-**count** | **int** | The storage name where the file is situated. |
-**folder** | **string** | The workdook folder. |
-**storage_name** | **string** |  |  
+**offset** | **int** | The workdook folder. |
+**count** | **int** |  |
+**folder** | **string** | The folder where the file is situated. |
+**storage_name** | **string** | The storage name where the file is situated. |  
 
 [[Back to Model list]](../README.md#documentation-for-requests) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/docs/PdfSecurityOptions.md b/docs/PdfSecurityOptions.md
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
 **AnnotationsPermission** | **boolean** |  |
 **AssembleDocumentPermission** | **boolean** |  |
 **ExtractContentPermission** | **boolean** |  |
-**ExtractContentPermissionObsolete** | **boolean** |  |
 **FillFormsPermission** | **boolean** |  |
 **FullQualityPrintPermission** | **boolean** |  |
 **ModifyDocumentPermission** | **boolean** |  |

diff --git a/docs/PostAnalyzeExcelRequest.md b/docs/PostAnalyzeExcelRequest.md
@@ -0,0 +1,14 @@
+# AsposeCellsCloud::Request::PostAnalyzeExcel 
+
+## Load the model package
+```perl
+use AsposeCellsCloud::Request::PostAnalyzeExcel;
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**analyze_excel_request** | **AnalyzeExcelRequest** | Excel files and analysis output requirements |  
+
+[[Back to Model list]](../README.md#documentation-for-requests) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/docs/PostAssembleRequest.md b/docs/PostAssembleRequest.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Request::PostAssemble;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **string** | The format to convert(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers) |
+**file** | **string** | File to upload |
 **datasource** | **string** |  |
 **out_format** | **string** | The format to convert(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers) |
 **password** | **string** | The password needed to open an Excel file. |

diff --git a/docs/PostClearObjectsRequest.md b/docs/PostClearObjectsRequest.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Request::PostClearObjects;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **string** | chart/comment/picture/shape/listobject/hyperlink/oleobject/pivottable/validation/Background |
+**file** | **string** | File to upload |
 **objecttype** | **string** | chart/comment/picture/shape/listobject/hyperlink/oleobject/pivottable/validation/Background |
 **sheetname** | **string** | The worksheet name, specify the scope of the deletion. |
 **out_format** | **string** | The output data file format.(CSV/XLS/HTML/MHTML/ODS/PDF/XML/TXT/TIFF/XLSB/XLSM/XLSX/XLTM/XLTX/XPS/PNG/JPG/JPEG/GIF/EMF/BMP/MD[Markdown]/Numbers) |

diff --git a/docs/PostCompressRequest.md b/docs/PostCompressRequest.md
@@ -8,7 +8,7 @@ use AsposeCellsCloud::Request::PostCompress;
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**file** | **string** | Compress level. The compression ratio 1-100. |
+**file** | **string** | File to upload |
 **compress_level** | **int** | Compress level. The compression ratio 1-100. |
 **password** | **string** | The password needed to open an Excel file. |
 **check_excel_restriction** | **boolean** | Whether check restriction of excel file when user modify cells related objects. |