view release on metacpan or  search on metacpan

lib/AsposeCellsCloud/CellsApi.pm  view on Meta::CPAN

}
#
# @return string
#
sub get_worksheets_with_local_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# AddWorksheetToSpreadsheetRequest
#
# The Web API enables users to add a new worksheet to a workbook, specifying the worksheet`s type, position, and name. This function provides flexibility in managing workbook structure by allowing detailed control over worksheet addition.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @sheetType  string   Specifies the name of the new worksheet.If not provided, a default name will be assigned.  
# @position  int   Specifies the position at which the new worksheet should be inserted.If not provided, the worksheet will be added at the end of the workbook.  
# @sheetName  string   Specifies the type of worksheet to be added.If not provided, a default worksheet type will be used.  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'AddWorksheetToSpreadsheetRequest',
            description => 'AddWorksheetToSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'add_worksheet_to_spreadsheet' } = { 
    	summary => 'The Web API enables users to add a new worksheet to a workbook, specifying the worksheet`s type, position, and name. This function provides flexibility in managing workbook structure by allowing detailed control over worksheet additi...
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub add_worksheet_to_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# DeleteWorksheetFromSpreadsheetRequest
#
# The Web API endpoint allows users to delete a specified worksheet from a workbook. This function provides a straightforward way to manage workbook structure by removing unnecessary or redundant worksheets.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @sheetName  string (required)  Specifies the name or identifier of the worksheet to be deleted. This parameter is required and must match the name of an existing worksheet in the workbook.  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'DeleteWorksheetFromSpreadsheetRequest',
            description => 'DeleteWorksheetFromSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'delete_worksheet_from_spreadsheet' } = { 
    	summary => 'The Web API endpoint allows users to delete a specified worksheet from a workbook. This function provides a straightforward way to manage workbook structure by removing unnecessary or redundant worksheets.',
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub delete_worksheet_from_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# RenameWorksheetInSpreadsheetRequest
#
# The Web API endpoint allows users to rename a specified worksheet within a workbook. This function provides a straightforward way to update worksheet names, enhancing workbook organization and readability.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @sourceName  string (required)  The current name of the worksheet to be renamed.  
# @targetName  string (required)  The new name for the worksheet.  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'RenameWorksheetInSpreadsheetRequest',
            description => 'RenameWorksheetInSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'rename_worksheet_in_spreadsheet' } = { 
    	summary => 'The Web API endpoint allows users to rename a specified worksheet within a workbook. This function provides a straightforward way to update worksheet names, enhancing workbook organization and readability.',
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub rename_worksheet_in_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# MoveWorksheetInSpreadsheetRequest
#
# The Web API endpoint allows users to move a specified worksheet within a workbook. This function provides a straightforward way to move a worksheet, enhancing workbook organization.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @worksheet  string (required)  The current name of the worksheet to be moved.  
# @position  int (required)  Move the worksheet to the position  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'MoveWorksheetInSpreadsheetRequest',
            description => 'MoveWorksheetInSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'move_worksheet_in_spreadsheet' } = { 
    	summary => 'The Web API endpoint allows users to move a specified worksheet within a workbook. This function provides a straightforward way to move a worksheet, enhancing workbook organization.',
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub move_worksheet_in_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# CompressSpreadsheetRequest
#
# The Web API endpoint allows users to compress a spreadsheet to reduce its file size. This function provides a straightforward way to optimize the storage and performance of spreadsheets by applying a specified compression level.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @level  int (required)  Specifies the compression level to be applied to the spreadsheet. The level should be within a valid range (e.g., 0-9 for most compression algorithms, where 0 is no compression and 9 is maximum compression).  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'CompressSpreadsheetRequest',
            description => 'CompressSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'compress_spreadsheet' } = { 
    	summary => 'The Web API endpoint allows users to compress a spreadsheet to reduce its file size. This function provides a straightforward way to optimize the storage and performance of spreadsheets by applying a specified compression level.',
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub compress_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# RepairSpreadsheetRequest
#
# The Web API endpoint allows users to repair a spreadsheet.
# 
# @Spreadsheet  string (required)  Upload spreadsheet file.  
# @outPath  string   (Optional) The folder path where the workbook is stored. The default is null.  
# @outStorageName  string   Output file Storage Name.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'RepairSpreadsheetRequest',
            description => 'RepairSpreadsheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'repair_spreadsheet' } = { 
    	summary => 'The Web API endpoint allows users to repair a spreadsheet.',
        params => $params,
        returns => 'string',
    };
}
#
# @return string
#
sub repair_spreadsheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('string', $response);
    return $_response_object;
}

#
# GetMergedCellsInRemotedWorksheetRequest
#
# Get all merged cell area form a remote spreadsheet worksheet.
# 
# @name  string (required)  spreadsheet name  
# @worksheet  string (required)  worksheet name  
# @folder  string   The cloud storage path of the spreadsheet.  
# @storageName  string   (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.  
# @region  string   The spreadsheet region setting.  
# @password  string   The password for opening spreadsheet file.   
#
{
    my $params = {
       'request' =>{
            data_type => 'GetMergedCellsInRemotedWorksheetRequest',
            description => 'GetMergedCellsInRemotedWorksheet Request.',
            required => '0',
       }
    };
    __PACKAGE__->method_documentation->{ 'get_merged_cells_in_remoted_worksheet' } = { 
    	summary => 'Get all merged cell area form a remote spreadsheet worksheet.',
        params => $params,
        returns => 'ARRAY[CellArea]',
    };
}
#
# @return ARRAY[CellArea]
#
sub get_merged_cells_in_remoted_worksheet{
    my ($self, %args) = @_;
    my $request = $args{'request'};
    my $response = $request->run_http_request('client' => $self->{api_client} );
    if (!$response) {
        return;
    }
    my $_response_object = $self->{api_client}->deserialize('ARRAY[CellArea]', $response);
    return $_response_object;
}

#
# GetMergedCellsInWorksheetRequest