/ 
WWW-Liquidweb-Lite-0.01
/ WWW::Liquidweb::Lite

new

Create a new WWW::Liquidweb::Lite object

USAGE

This module builds the necessary tools to interact with the Liquidweb API from a JSON file that is usually located at the following address:

https://www.stormondemand.com/api/docs/v1/docs.json

This is built up in a way that slightly resembles WSDL, but the JSON structure is Liquidweb specific.

Example: my $liquidweb = WWW::Liquidweb::Lite->new(username => 'USERNAME', password => 'PASSWORD');

ARGUMENT	DESCRIPTION
---
username	Liquidweb API username
password	Liquidweb API password
json		Location of the JSON describing the Liquidweb API
			[DEFAULTS: https://www.stormondemand.com/api/docs/v1/docs.json]
timeout		LWP::UserAgent timeout
			[DEFAULTS: 60]
json		Location of the JSON to build the API object
			[DEFAULTS: https://www.stormondemand.com/api/docs/v1/docs.json]
version		Version of the API to use
			[DEFAULTS: v1]
host		The "base" host for the API
			[DEFAULTS: https://api.stormondemand.com]
---

help

Get help with the Liquidweb API

USAGE

Calling the method 'help' at the end of your method API calls will return a hash of helpful information:

my $server_list_help = $liquidweb->server->list->help;

In this example, $server_list_help will contain information about the 'Server/list' method in the Liquidweb API.

$server_list_help->{__input}		This will contain a hash describing valid input parameters for this
					method.

$server_list_help->{__description}	This will contain a string that will describe aspects of the method,
					and occasionally examples, insights, or other helpful information.

$server_list_help->{__output}		This will contain a hash describing valid output that you may receive
					back from the API call.

NAME

WWW::Liquidweb::Lite - A module to interface with the Liquidweb API

SYNOPSIS

You can create an object in this manner:

my $liquidweb = WWW::Liquidweb::Lite->new(username => "USERNAME", password => "PASSWORD");

USERNAME and PASSWORD correspond with the login credentials you would use for the Liquidweb API, as detailed here:

http://www.liquidweb.com/StormServers/api/index.html

Once you have the object you can call a method from the api in "object fashion". For example:

'Storm/Server/list'

Can be called from the object in this manner:

$liquidweb->server->list

The casing does not have to be correct.

Arguments can be sent to the method as well:

$liquidweb->server->list(category => 'Dedicated');

VERSION

Version 0.01

AUTHOR

Shane Utt, <shaneutt at linux.com>

BUGS

Please report any bugs or feature requests to bug-WWW-Liquidweb-Lite at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Liquidweb-Lite. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::Liquidweb::Lite

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2014 Shane Utt, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.