API-ParallelsWPB

 view release on metacpan or  search on metacpan

lib/API/ParallelsWPB/Requests.pm  view on Meta::CPAN

Creating a site.

%param:

state

    trial | suspended | regular

    This parameter is optional.
    It specifies whether the site is in the trial mode, suspended or active (regular value). Sites in the trial mode can be edited, but cannot be published to a hosting account.

publicationSettings

    {
        "targetUrl" => "ftp://username:password@ftp.example.com/path",
        "webSiteUrl" => "http://example.com",
        "fallbackIp" => "192.168.1.3"
    }

    This parameter is optional.

lib/API/ParallelsWPB/Requests.pm  view on Meta::CPAN

%param:

uuid

    Site UUID. This parameter is mandatory.

localeCode

    This parameter is optional.

    It specifies the language that should be set for the user interface when the user (site owner) logs in to the editor.

    The following languages are supported:

        en_US - American English.
        en_GB - British English.
        de_DE - German.
        es_ES - Spanish.
        fr_FR - French
        it_IT - Italian.
        ja_JP - Japanese.

lib/API/ParallelsWPB/Requests.pm  view on Meta::CPAN

        pl_PL - Polish.
        pt_BR - Brazilian Portuguese
        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' );

lib/API/ParallelsWPB/Requests.pm  view on Meta::CPAN

=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

lib/API/ParallelsWPB/Requests.pm  view on Meta::CPAN

=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)>