AsposeCellsCloud-CellsApi
view release on metacpan or search on metacpan
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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;
}
#
# ExportSpreadsheetAsFormatRequest
#
# Converts a spreadsheet in cloud storage to the specified format.
#
# @name string (required) (Required) The name of the workbook file to be retrieved.
# @format string (required) (Required) The desired output format (e.g., "Xlsx", "Pdf", "Csv").
# @folder string (Optional) The folder path where the workbook is stored. The default is null.
# @storageName string (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExportSpreadsheetAsFormatRequest',
description => 'ExportSpreadsheetAsFormat Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'export_spreadsheet_as_format' } = {
summary => 'Converts a spreadsheet in cloud storage to the specified format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub export_spreadsheet_as_format{
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;
}
#
# ExportWorksheetAsFormatRequest
#
# Converts a worksheet of spreadsheet in cloud storage to the specified format.
#
# @name string (required) (Required) The name of the workbook file to be retrieved.
# @worksheet string (required)
# @format string (required) (Required) The desired pdf or image format (e.g., "png", "Pdf", "svg").
# @folder string (Optional) The folder path where the workbook is stored. The default is null.
# @storageName string (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExportWorksheetAsFormatRequest',
description => 'ExportWorksheetAsFormat Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'export_worksheet_as_format' } = {
summary => 'Converts a worksheet of spreadsheet in cloud storage to the specified format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub export_worksheet_as_format{
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;
}
#
# ExportChartAsFormatRequest
#
# Converts a chart of spreadsheet in cloud storage to the specified format.
#
# @name string (required) (Required) The name of the workbook file to be retrieved.
# @worksheet string (required) worksheet name
# @chartIndex int (required) chart index
# @format string (required) (Required) The desired pdf or image format (e.g., "png", "Pdf", "svg").
# @folder string (Optional) The folder path where the workbook is stored. The default is null.
# @storageName string (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExportChartAsFormatRequest',
description => 'ExportChartAsFormat Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'export_chart_as_format' } = {
summary => 'Converts a chart of spreadsheet in cloud storage to the specified format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub export_chart_as_format{
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;
}
#
# ExportTableAsFormatRequest
#
# Converts a table of spreadsheet in cloud storage to the specified format.
#
# @name string (required) (Required) The name of the workbook file to be retrieved.
# @worksheet string (required) worksheet name
# @tableName string (required) table name
# @format string (required) (Required) The desired format (e.g., "png", "Pdf", "svg").
# @folder string (Optional) The folder path where the workbook is stored. The default is null.
# @storageName string (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExportTableAsFormatRequest',
description => 'ExportTableAsFormat Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'export_table_as_format' } = {
summary => 'Converts a table of spreadsheet in cloud storage to the specified format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub export_table_as_format{
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;
}
#
# ExportRangeAsFormatRequest
#
# Converts the range of spreadsheet in cloud storage to the specified format.
#
# @name string (required) (Required) The name of the workbook file to be retrieved.
# @worksheet string (required) worksheet name
# @range string (required) range: A1:C12
# @format string (required) (Required) The desired format (e.g., "png", "Pdf", "svg").
# @folder string (Optional) The folder path where the workbook is stored. The default is null.
# @storageName string (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ExportRangeAsFormatRequest',
description => 'ExportRangeAsFormat Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'export_range_as_format' } = {
summary => 'Converts the range of spreadsheet in cloud storage to the specified format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub export_range_as_format{
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;
}
#
# ConvertSpreadsheetRequest
#
# Converts a spreadsheet on a local drive to the specified format.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @format string (required) (Required) The desired output format (e.g., "Xlsx", "Pdf", "Csv").
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertSpreadsheetRequest',
description => 'ConvertSpreadsheet Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_spreadsheet' } = {
summary => 'Converts a spreadsheet on a local drive to the specified format.',
params => $params,
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
# @return string
#
sub convert_spreadsheet_to_json{
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;
}
#
# ConvertSpreadsheetToCsvRequest
#
# Converts a spreadsheet on a local drive to the csv file.
#
# @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.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertSpreadsheetToCsvRequest',
description => 'ConvertSpreadsheetToCsv Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_spreadsheet_to_csv' } = {
summary => 'Converts a spreadsheet on a local drive to the csv file.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_spreadsheet_to_csv{
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;
}
#
# ConvertWorksheetToImageRequest
#
# Converts a worksheet of spreadsheet on a local drive to the image format.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @format string (required) image format:svg, png, and so on.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertWorksheetToImageRequest',
description => 'ConvertWorksheetToImage Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_worksheet_to_image' } = {
summary => 'Converts a worksheet of spreadsheet on a local drive to the image format.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_worksheet_to_image{
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;
}
#
# ConvertWorksheetToPdfRequest
#
# Converts a worksheet of spreadsheet on a local drive to the pdf file.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertWorksheetToPdfRequest',
description => 'ConvertWorksheetToPdf Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_worksheet_to_pdf' } = {
summary => 'Converts a worksheet of spreadsheet on a local drive to the pdf file.',
params => $params,
returns => 'string',
};
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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;
}
#
# ConvertTableToJsonRequest
#
# Converts a table of spreadsheet on a local drive to the json file.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @tableName string (required) table name
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertTableToJsonRequest',
description => 'ConvertTableToJson Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_table_to_json' } = {
summary => 'Converts a table of spreadsheet on a local drive to the json file.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_table_to_json{
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;
}
#
# ConvertRangeToImageRequest
#
# Converts a range of spreadsheet on a local drive to the image file.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @range string (required) cell area. e.g. A1:C10
# @format string (required) file format. e.g. png, svg, tiff
# @printHeadings boolean Represents if row and column headings are printed with this page.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertRangeToImageRequest',
description => 'ConvertRangeToImage Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_range_to_image' } = {
summary => 'Converts a range of spreadsheet on a local drive to the image file.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_range_to_image{
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;
}
#
# ConvertRangeToPdfRequest
#
# Converts a range of spreadsheet on a local drive to the pdf file.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @range string (required) cell area. e.g. A1:C10
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertRangeToPdfRequest',
description => 'ConvertRangeToPdf Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_range_to_pdf' } = {
summary => 'Converts a range of spreadsheet on a local drive to the pdf file.',
params => $params,
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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;
}
#
# ConvertRangeToJsonRequest
#
# Converts a range of spreadsheet on a local drive to the json file.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @range string (required) cell area. e.g. A1:C10
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertRangeToJsonRequest',
description => 'ConvertRangeToJson Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_range_to_json' } = {
summary => 'Converts a range of spreadsheet on a local drive to the json file.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_range_to_json{
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;
}
#
# ConvertChartToImageRequest
#
# Converts a chart of spreadsheet on a local drive to image.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @chartIndex int (required) chart index of worksheet.
# @format string (required) (Required) The desired image type (e.g., svg, png, jpg).
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertChartToImageRequest',
description => 'ConvertChartToImage Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_chart_to_image' } = {
summary => 'Converts a chart of spreadsheet on a local drive to image.',
params => $params,
returns => 'string',
};
}
#
# @return string
#
sub convert_chart_to_image{
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;
}
#
# ConvertChartToPdfRequest
#
# Converts a chart of spreadsheet on a local drive to pdf.
#
# @Spreadsheet string (required) Upload spreadsheet file.
# @worksheet string (required) worksheet name of spreadsheet.
# @chartIndex int (required) chart index of worksheet.
# @outPath string (Optional) The folder path where the workbook is stored. The default is null.
# @outStorageName string Output file Storage Name.
# @fontsLocation string Use Custom fonts.
# @region string The spreadsheet region setting.
# @password string The password for opening spreadsheet file.
#
{
my $params = {
'request' =>{
data_type => 'ConvertChartToPdfRequest',
description => 'ConvertChartToPdf Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'convert_chart_to_pdf' } = {
summary => 'Converts a chart of spreadsheet on a local drive to pdf.',
params => $params,
returns => 'string',
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
return $_response_object;
}
#
# PostConvertWorkbookToPDFRequest
#
# Convert Excel file to PDF files.
#
# @File string (required) File to upload
# @password string The password needed to open an Excel file.
# @checkExcelRestriction boolean Whether check restriction of excel file when user modify cells related objects.
# @region string The regional settings for workbook.
# @FontsLocation string Use Custom fonts.
#
{
my $params = {
'request' =>{
data_type => 'PostConvertWorkbookToPDFRequest',
description => 'PostConvertWorkbookToPDF Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_convert_workbook_to_pdf' } = {
summary => 'Convert Excel file to PDF files.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_convert_workbook_to_pdf{
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('FileInfo', $response);
return $_response_object;
}
#
# PostConvertWorkbookToPNGRequest
#
# Convert Excel file to PNG files.
#
# @File string (required) File to upload
# @password string The password needed to open an Excel file.
# @checkExcelRestriction boolean Whether check restriction of excel file when user modify cells related objects.
# @region string The regional settings for workbook.
#
{
my $params = {
'request' =>{
data_type => 'PostConvertWorkbookToPNGRequest',
description => 'PostConvertWorkbookToPNG Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_convert_workbook_to_png' } = {
summary => 'Convert Excel file to PNG files.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_convert_workbook_to_png{
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('FileInfo', $response);
return $_response_object;
}
#
# PostConvertWorkbookToDocxRequest
#
# Convert Excel file to Docx files.
#
# @File string (required) File to upload
# @password string The password needed to open an Excel file.
# @checkExcelRestriction boolean Whether check restriction of excel file when user modify cells related objects.
# @region string The regional settings for workbook.
# @FontsLocation string Use Custom fonts.
#
{
my $params = {
'request' =>{
data_type => 'PostConvertWorkbookToDocxRequest',
description => 'PostConvertWorkbookToDocx Request.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'post_convert_workbook_to_docx' } = {
summary => 'Convert Excel file to Docx files.',
params => $params,
returns => 'FileInfo',
};
}
#
# @return FileInfo
#
sub post_convert_workbook_to_docx{
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('FileInfo', $response);
return $_response_object;
}
#
# PostConvertWorkbookToPptxRequest
#
# Convert Excel file to Pptx files.
#
# @File string (required) File to upload
# @password string The password needed to open an Excel file.
# @checkExcelRestriction boolean Whether check restriction of excel file when user modify cells related objects.
# @region string The regional settings for workbook.
# @FontsLocation string Use Custom fonts.
#
( run in 3.149 seconds using v1.01-cache-2.11-cpan-6736b670a1e )