API-ParallelsWPB
view release on metacpan or search on metacpan
lib/API/ParallelsWPB/Requests.pm view on Meta::CPAN
sub gen_token {
my ( $self, %param ) = @_;
$param{localeCode} ||= DEFAULT_LOCALE_CODE;
$param{sessionLifeTime} ||= DEFAULT_SESSIONLIFETIME;
my $uuid = $self->_get_uuid( %param );
return $self->f_request(
[ 'sites', $uuid, 'token' ],
{
req_type => 'post',
post_data => [
{
localeCode => $param{localeCode},
sessionLifeTime => $param{sessionLifeTime},
} ],
}
);
}
sub deploy {
my ( $self, %param ) = @_;
$param{localeCode} ||= $self->DEFAULT_LOCALE_CODE;
$param{templateCode} ||= $self->DEFAULT_TEMPLATE_CODE;
my $siteuuid = $self->_get_uuid( %param );
my @post_data = map { $param{$_} } qw/templateCode localeCode title/;
return $self->f_request(
[ 'sites', $siteuuid, 'deploy' ],
{
req_type => 'post',
post_data => \@post_data
}
);
}
sub get_site_info {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid ], { req_type => 'get' } );
}
sub get_sites_info {
my ( $self ) = @_;
return $self->f_request( [qw/ sites /], { req_type => 'get' } );
}
sub change_site_properties {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request(
[ 'sites', $uuid ],
{
req_type => 'put',
post_data => [\%param]
}
);
}
sub publish {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request(
[ 'sites', $uuid, 'publish' ],
{
req_type => 'post',
}
);
}
sub delete_site {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid ], { req_type => 'delete' } );
}
sub get_promo_footer {
my ( $self ) = @_;
return $self->f_request( [qw/ system promo-footer /],
{ req_type => 'get' } );
}
sub get_site_custom_variable {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid, 'custom-properties' ], { req_type => 'get' } );
}
sub set_site_custom_variable {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
delete $param{uuid} if ( exists $param{uuid} );
return $self->f_request( [ 'sites', $uuid, 'custom-properties' ],
{
req_type => 'put',
post_data => [ \%param ],
}
);
}
sub get_sites_custom_variables {
my ( $self ) = @_;
return $self->f_request( [qw/ system custom-properties /],
{ req_type => 'get' } );
}
sub set_sites_custom_variables {
my ( $self, %param ) = @_;
return $self->f_request( [ qw/ system custom-properties / ],
{
req_type => 'put',
post_data => [ \%param ],
}
);
}
sub set_custom_trial_messages {
my ( $self, @param ) = @_;
return $self->f_request( [ qw/ system trial-mode messages / ],
{
req_type => 'put',
post_data => [ \@param ]
}
);
}
sub get_custom_trial_messages {
my ( $self ) = @_;
return $self->f_request( [qw/ system trial-mode messages /],
{ req_type => 'get' } );
}
sub change_promo_footer {
my ( $self, %param ) = @_;
confess "Required parameter message!" unless ( $param{message} );
return $self->f_request( [ qw/ system promo-footer / ],
{
req_type => 'put',
post_data => [ $param{message} ],
}
);
}
sub set_site_promo_footer_visible {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid ], {
req_type => 'put',
post_data => [ { isPromoFooterVisible => 'true' } ],
}
);
}
sub set_site_promo_footer_invisible {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid ], {
req_type => 'put',
post_data => [ { isPromoFooterVisible => 'false' } ],
}
);
}
sub set_limits {
my ( $self, %param ) = @_;
my $uuid = $self->_get_uuid( %param );
return $self->f_request( [ 'sites', $uuid, 'limits' ], {
req_type => 'put',
post_data => [ \%param ],
}
);
}
sub configure_buy_and_publish_dialog {
my ( $self, $params ) = @_;
return $self->f_request(['system', 'trial-mode', 'messages'], {req_type => 'put', post_data => [ $params ]});
}
lib/API/ParallelsWPB/Requests.pm view on Meta::CPAN
ru_RU - Russian.
zh_CN - simplified Chinese.
zh_TW - traditional Chinese.
If no locale is defined, en_US will be used.
sessionLifeTime
This parameter is optional. It specifies the period of inactivity for a user's session in the editor. When this period elapses,
the security token expires and the user needs to log in again. 1800 seconds by default.
L<Generating a Security Token for Accessing a Site|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=69691.htm>
=head2 B<deploy($self, %param)>
Creates site based on a specified topic.
my $response =
$client->deploy( localeCode => 'en_US', templateCode => 'music_blog' );
%param:
uuid
Site UUID. This parameter is mandatory.
localeCode
Locale code. The default value is en_US.
templateCode
Internal topic identification code. This parameter is optional. Default value is 'generic'.
title
Website name. This parameter is optional. Specifies what should be shown as the website name in the browser's title bar.
L<Creating a Site Based on a Website Topic|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=72111.htm>
=head2 B<get_site_info($self, %param)>
Retrieving information about a specific site.
%param:
uuid
Site UUID. This parameter is mandatory.
L<Retrieving Information About a Specific Site|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=69690.htm>
=head2 B<get_sites_info($self)>
Retrieving information about all sites.
No parameters are required.
L<Retrieving Information About All Sites|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71285.htm>
=head2 B<change_site_properties($self, %param)>
Changes site properties.
%param:
state
trial | suspended | regular
This parameter is optional. It specifies whether the site is in trial mode, suspended or active (regular value). Sites in trial mode can be edited, but cannot be published to a hosting account.
publicationSettings
This parameter is optional. It specifies where to publish the site over FTP and what account credentials to use:
ownerInfo
This parameter is optional. It specifies the contact information of the site owner.
isPromoFooterVisible
1 | 0
This parameter is optional. It specifies whether a text box with an advertisement should be shown in the website footer.
L<Changing Site Properties and Settings|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=69692.htm>
=head2 B<publish($self,%param)>
Publish a site.
%param:
uuid
Site UUID.
L<Publishing a Website|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=72112.htm>
=head2 B<delete_site($self, %param)>
Deleting a site.
%param:
uuid
Site UUID.
L<Deleting a Site|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=69669.htm>
=head2 B<get_promo_footer( $self )>
Retrieving the current content of the promotional footer.
L<Retrieving the Current Content of the Promotional Footer|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71979_1.htm>
=head2 B<get_site_custom_variable($self, %param)>
Retrieving a List of Custom Variables for a Website.
lib/API/ParallelsWPB/Requests.pm view on Meta::CPAN
L<Configuring the Trial Mode|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71623.htm>
L<Setting Trial Mode Messages|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71727.htm>
=head2 B<get_sites_custom_variables($self)>
Retrieving Custom Variables Defined for All Websites
L<Configuring the Trial Mode|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71623.htm>
L<Setting Trial Mode Messages|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71727.htm>
=head2 B<set_sites_custom_variables($self, %param)>
Setting Custom Variables for All Websites
%param:
variable1 => value1
variable2 => value2
...
variableN => valueN
L<Configuring the Trial Mode|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71623.htm>
L<Setting Trial Mode Messages|http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide/index.htm?fileName=71727.htm>
=head2 B<set_custom_trial_messages($self, @param)>
Setting Custom Messages for the Trial Mode
my $response = $api->set_custom_trial_messages(
{
localeCode => 'en_US',
messages => {
defaultPersonalName => '{message1_en}',
editorTopMessageTrialSite => '{message2_en}',
initialMailSubject => '{message3_en}',
initialMailHtml => '{message4_en}',
trialSiteSignUpPublishTitle => '{message5_en}',
trialSiteSignUpPublishMsg => '{message6_en}'
}
},
{
localeCode => 'de_DE',
messages => {
defaultPersonalName => '{message1_de}',
editorTopMessageTrialSite => '{message2_de}',
initialMailSubject => '{message3_de}',
initialMailHtml => '{message4_de}',
trialSiteSignUpPublishTitle => '{message5_de}',
trialSiteSignUpPublishMsg => '{message6_de}'
}
},
);
=head2 B<get_custom_trial_messages($self)>
Retrieving Custom Messages for the Trial Mode
=head2 B<change_promo_footer($self, %param)>
Changing the Default Content of the Promotional Footer
%param:
message
=head2 B<set_site_promo_footer_visible($self, %param)>
Showing the Promotional Footer on Websites
%param:
uuid
=head2 B<set_site_promo_footer_invisible($self, %param)>
Removing the Promotional Footer from Websites
%param:
uuid
=head2 B<set_limits>
Set limitations for single site
%param:
uuid
Site UUID.
The next list contains parameters/modules, that can be limited. Value for parameter must be an integer, that means maximum number of elements, that can be added on site. Value -1 means unlimited elements count
for all modules/pages except eshop module. It can accept only positive numbers.
maxPagesNumber
Number of pages on a site.
video
Embedded Video module.
imagegallery
Image Gallery module.
blog
Blog module.
eshop
Online Store and Shopping Cart modules.
commenting
Commenting module.
( run in 0.580 second using v1.01-cache-2.11-cpan-e1769b4cff6 )