AsposeCellsCloud-CellsApi
view release on metacpan or search on metacpan
docs/DeveloperGuide.md view on Meta::CPAN
| [SplitTable](api/SplitTable.md) | Split an Excel worksheet tale into multiple sheets by column value. |
| [SplitRemoteSpreadsheet](api/SplitRemoteSpreadsheet.md) | Split a spreadsheet in cloud storage into the specified format, multi-file. |
| [ImportDataIntoSpreadsheet](api/ImportDataIntoSpreadsheet.md) | Import data into a spreadsheet from a supported data file format. |
| [ImportJSONDataIntoSpreadsheet](api/ImportJSONDataIntoSpreadsheet.md) | Import JSON data file into the local spreadsheet. |
| [ImportXMLDataIntoSpreadsheet](api/ImportXMLDataIntoSpreadsheet.md) | Import XML data file into the local spreadsheet. |
| [ImportCSVDataIntoSpreadsheet](api/ImportCSVDataIntoSpreadsheet.md) | Import CSV data file into the local spreadsheet. |
| [GetPublicKey](api/GetPublicKey.md) | Get an asymmetric public key. |
| [CreateSpreadsheet](api/CreateSpreadsheet.md) | The Web API allows users to create a new spreadsheet with a specified name. Optionally, a template can be provided to initialize the spreadsheet with predefined content or formatting. |
| [GetWorksheetsWithLocalSpreadsheet](api/GetWorksheetsWithLocalSpreadsheet.md) | Fetches a complete list of worksheets from the currently active local spreadsheet. |
| [AddWorksheetToSpreadsheet](api/AddWorksheetToSpreadsheet.md) | 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 b...
| [DeleteWorksheetFromSpreadsheet](api/DeleteWorksheetFromSpreadsheet.md) | 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 unnec...
| [RenameWorksheetInSpreadsheet](api/RenameWorksheetInSpreadsheet.md) | 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 or...
| [MoveWorksheetInSpreadsheet](api/MoveWorksheetInSpreadsheet.md) | 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. ...
| [CompressSpreadsheet](api/CompressSpreadsheet.md) | 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 applyin...
| [RepairSpreadsheet](api/RepairSpreadsheet.md) | The Web API endpoint allows users to repair a spreadsheet. |
| [GetMergedCellsInRemotedWorksheet](api/GetMergedCellsInRemotedWorksheet.md) | Get all merged cell area form a remote spreadsheet worksheet. |
| [GetMergedCellsInWorksheet](api/GetMergedCellsInWorksheet.md) | Get all merged cell area form a local spreadsheet worksheet. |
| [AcceptAllRevisions](api/AcceptAllRevisions.md) | |
| [AcceptAllRevisionsInRemoteSpreadsheet](api/AcceptAllRevisionsInRemoteSpreadsheet.md) | |
| [ProtectSpreadsheet](api/ProtectSpreadsheet.md) | Applies dual-layer password protection to Excel spreadsheets, supporting both open and modify passwords with encryption. |
| [UnprotectSpreadsheet](api/UnprotectSpreadsheet.md) | Removes dual-layer password protection from Excel spreadsheets, supporting both open and modify passwords with encryption. |
| [SpreadsheetDigitalsignature](api/SpreadsheetDigitalsignature.md) | |
| [SearchAllTextItemsInRemoteSpreadsheet](api/SearchAllTextItemsInRemoteSpreadsheet.md) | Get all text items in the remote spreadsheet. |
| [SearchSpreadsheetAllTextItems](api/SearchSpreadsheetAllTextItems.md) | Get all text items in the remote spreadsheet. |
| [SearchSpreadsheetContent](api/SearchSpreadsheetContent.md) | Search text in the local spreadsheet. |
docs/api/CompressSpreadsheet.md view on Meta::CPAN
# **Spreadsheet Cloud API: compressSpreadsheet**
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.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
docs/api/DeleteWorksheetFromSpreadsheet.md view on Meta::CPAN
# **Spreadsheet Cloud API: deleteWorksheetFromSpreadsheet**
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.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
docs/api/GetMergedCellsInRemotedWorksheet.md view on Meta::CPAN
- **Example**
## **Interface Details**
### **Endpoint**
```
GET http://api.aspose.cloud/v4.0/cells/{name}/worksheets/{worksheet}/mergedcells
```
### **Function Description**
This endpoint queries a remote spreadsheet service (e.g., Google Sheets, Office 365 Excel Online) for a specific worksheet and returns a structured list of all merged cell areas.Each merged area is typically defined by its top-left and bottom-right c...
### The request parameters of **getMergedCellsInRemotedWorksheet** API are:
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
| :- | :- | :- |:- |
|name|String|Path|spreadsheet name|
|worksheet|String|Path|worksheet name|
|folder|String|Query|The cloud storage path of the spreadsheet.|
|storageName|String|Query|(Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.|
|region|String|Query|The spreadsheet region setting.|
docs/api/GetWorksheetsWithLocalSpreadsheet.md view on Meta::CPAN
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
## **Interface Details**
### **Endpoint**
```
PUT http://api.aspose.cloud/v4.0/cells/spreadsheet/worksheets
```
### **Function Description**
This endpoint accesses the local spreadsheet application (e.g., Excel) via interop or a local API,collects the name and type (e.g., standard, chart, macro) of every worksheet,and returns the collection as a structured JSON array. This is typically us...
### The request parameters of **getWorksheetsWithLocalSpreadsheet** API are:
| Parameter Name | Type | Path/Query String/HTTPBody | Description |
| :- | :- | :- |:- |
|Spreadsheet|File|FormData|Upload spreadsheet file.|
|region|String|Query|The spreadsheet region setting.|
|password|String|Query|The password for opening spreadsheet file.|
### **Response Description**
docs/api/MoveWorksheetInSpreadsheet.md view on Meta::CPAN
# **Spreadsheet Cloud API: moveWorksheetInSpreadsheet**
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.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
docs/api/RenameWorksheetInSpreadsheet.md view on Meta::CPAN
# **Spreadsheet Cloud API: renameWorksheetInSpreadsheet**
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.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
docs/api/RepairSpreadsheet.md view on Meta::CPAN
# **Spreadsheet Cloud API: repairSpreadsheet**
The Web API endpoint allows users to repair a spreadsheet.
## **Quick Start**
- **Base URL**: `http://api.aspose.cloud/v4.0`
- **Authentication Method**: `JWT (OAuth2, application)` **Token URL**: `https://api.aspose.cloud/connect/token`
- **Example**
## **Interface Details**
lib/AsposeCellsCloud/ApiClient.pm view on Meta::CPAN
my $difference_in_seconds=time() - $self->{get_access_token_time};
if($difference_in_seconds < 86300){
return;
}
}
my $access_token = $self->o_auth_post('grant_type' => "client_credentials", 'client_id' => $self->{config}->{client_id}, 'client_secret' =>$self->{config}->{client_secret})->access_token;
$self->{config}->{access_token} = $access_token;
}
# make the HTTP request
# @param string $resourcePath path to method endpoint
# @param string $method method to call
# @param array $queryParams parameters to be place in query URL
# @param array $postData parameters to be placed in POST body
# @param array $headerParams parameters to be place in request header
# @return mixed
sub call_api {
my $self = shift;
my ($resource_path, $method, $query_params, $post_params, $header_params, $body_data, $auth_settings,$get_token) = @_;
# update parameters based on authentication settings
lib/AsposeCellsCloud/ApiClient.pm view on Meta::CPAN
# @param array $queryParams query parameters (by ref)
# @param array $authSettings array of authentication scheme (e.g ['api_key'])
sub update_params_for_auth {
my ($self, $header_params, $query_params, $auth_settings) = @_;
if(!$self->need_auth()){
return;
}
return $self->_global_auth_setup($header_params, $query_params)
unless $auth_settings && @$auth_settings;
# one endpoint can have more than 1 auth settings
foreach my $auth (@$auth_settings) {
# determine which one to use
if (!defined($auth)) {
# TODO show warning about auth setting not defined
}
elsif ($auth eq 'appsid') {
my $api_key = $self->get_api_key_with_prefix('appsid');
if ($api_key) {
$query_params->{'appsid'} = $api_key;
lib/AsposeCellsCloud/ApiClient.pm view on Meta::CPAN
if ($api_key) {
$query_params->{'signature'} = $api_key;
}
}
else {
# TODO show warning about security definition not found
}
}
}
# The endpoint API class has not found any settings for auth. This may be deliberate,
# in which case update_params_for_auth() will be a no-op. But it may also be that the
# OpenAPI Spec does not describe the intended authorization. So we check in the config for any
# auth tokens and if we find any, we use them for all endpoints;
sub _global_auth_setup {
my ($self, $header_params, $query_params) = @_;
my $tokens = $self->{config}->get_tokens;
return unless keys %$tokens;
# basic
if (my $uname = delete $tokens->{username}) {
my $pword = delete $tokens->{password};
$header_params->{'Authorization'} = 'Basic '.encode_base64($uname.":".$pword);
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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'};
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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'};
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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'};
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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'};
lib/AsposeCellsCloud/CellsApi.pm view on Meta::CPAN
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'};
lib/AsposeCellsCloud/Request/CompressSpreadsheetRequest.pm view on Meta::CPAN
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
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',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Request/DeleteWorksheetFromSpreadsheetRequest.pm view on Meta::CPAN
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
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',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Request/MoveWorksheetInSpreadsheetRequest.pm view on Meta::CPAN
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
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',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Request/RenameWorksheetInSpreadsheetRequest.pm view on Meta::CPAN
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
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',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Request/RepairSpreadsheetRequest.pm view on Meta::CPAN
{
my $params = {
'client' =>{
data_type => 'ApiClient',
description => 'API Client.',
required => '0',
}
};
__PACKAGE__->method_documentation->{ 'repair_spreadsheet' } = {
summary => 'The Web API endpoint allows users to repair a spreadsheet.',
params => $params,
returns => 'string',
};
}
sub run_http_request {
my ($self, %args) = @_;
my $client = $args{'client'};
lib/AsposeCellsCloud/Role.pm view on Meta::CPAN
has base_url => ( is => 'ro',
required => 0,
isa => 'Str',
documentation => 'Root of the server that requests are sent to',
);
has api_factory => ( is => 'ro',
isa => 'AsposeCellsCloud::ApiFactory',
builder => '_build_af',
lazy => 1,
documentation => 'Builds an instance of the endpoint API class',
);
has tokens => ( is => 'ro',
isa => 'HashRef',
required => 0,
default => sub { {} },
documentation => 'The auth tokens required by the application - basic, OAuth and/or API key(s)',
);
has _cfg => ( is => 'ro',
lib/AsposeCellsCloud/Role.pm view on Meta::CPAN
with 'AsposeCellsCloud::Role';
package main;
my $api = MyApp->new({ tokens => $tokens });
my $pet = $api->get_pet_by_id(pet_id => $pet_id);
=head2 Structure of the library
The library consists of a set of API classes, one for each endpoint. These APIs
implement the method calls available on each endpoint.
Additionally, there is a set of "object" classes, which represent the objects
returned by and sent to the methods on the endpoints.
An API factory class is provided, which builds instances of each endpoint API.
This Moose role flattens all the methods from the endpoint APIs onto the consuming
class. It also provides methods to retrieve the endpoint API objects, and the API
factory object, should you need it.
For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.
=head2 Configuring authentication
In the normal case, the OpenAPI Spec will describe what parameters are
required and where to put them. You just need to supply the tokens.
my $tokens = {
lib/AsposeCellsCloud/Role.pm view on Meta::CPAN
=head2 C<api_factory>
Returns an API factory object. You probably won't need to call this directly.
$self->api_factory('Pet'); # returns a AsposeCellsCloud::PetApi instance
$self->pet_api; # the same
=head1 MISSING METHODS
Most of the methods on the API are delegated to individual endpoint API objects
(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
same method name (e.g. C<new()>), these methods can't be delegated. So you need
to call C<$api-E<gt>pet_api-E<gt>new()>.
In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's
unlikely in general that any methods will be undelegatable, except for:
new()
class_documentation()
method_documentation()
lib/AsposeCellsCloud/Role.pm view on Meta::CPAN
-c your application class
The C<-c> option allows you to load and inspect your own application. A dummy
namespace is used if you don't supply your own class.
=head1 DOCUMENTATION FROM THE OpenAPI Spec
Additional documentation for each class and method may be provided by the Swagger
spec. If so, this is available via the C<class_documentation()> and
C<method_documentation()> methods on each generated object class, and the
C<method_documentation()> method on the endpoint API classes:
my $cmdoc = $api->pet_api->method_documentation->{$method_name};
my $odoc = $api->get_pet_by_id->(pet_id => $pet_id)->class_documentation;
my $omdoc = $api->get_pet_by_id->(pet_id => $pet_id)->method_documentation->{method_name};
Each of these calls returns a hashref with various useful pieces of information.
=cut
( run in 3.232 seconds using v1.01-cache-2.11-cpan-5735350b133 )