Ярослав Коршак > Monitis > Monitis::SubAccounts

Download:
Monitis-0.9.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Monitis::SubAccounts - Sub-accounts manipulation

SYNOPSIS ^

    use Monitis::SubAccounts;

DESCRIPTION ^

ATTRIBUTES ^

Monitis implements following attributes:

METHODS ^

Monitis implements following methods:

add

    my $response = $api->sub_accounts->add(
        firstName => 'John',
        lastName  => 'Smith',
        email     => 'john@smith.com',
        password  => 'test password',
        group     => 'test group'
    );

Add new sub account.

Mandatory parameters are:

    firstName lastName email password group

Normal response is:

    {   status => 'ok',
        data   => {userId => 12360}
    }

get

    my $response = $api->sub_accounts->get;

Returns all subaccount of your account. Normal response is:

    [   {   "id"        => 12360,
            "lastName"  => "Smith",
            "account"   => "john@smith.com",
            "firstName" => "John",
            "userkey"   => "80PMYRH3E8B7P5FMI6RDVJ84C1"
        },
        #...
    ]

pages

    my $response = $api->sub_accounts->pages;

Returns all subaccount's pages.

Normal response is:

    [   {   "id"    => 12360,
            "pages" => [
                "reports",
                "snapshots",

                # ...
            ],
            "account" => 'sfs@ss.com'
        },
    ]

add_pages

    my $response = $api->sub_accounts->add_pages(
        userId    => 12360,
        pageNames => 'Page One;Page Two'
    );

Add pages to subaccount.

Mandatory parameters are:

    userId pageNames

Normal response is:

    {"status" => "ok"}

delete_pages

    my $response = $api->sub_accounts->delete_pages(
        userId    => 12360,
        pageNames => 'Page One;Page Two'
    )

Delete pages from subaccount.

Mandatory parameters are:

    userId pageNames

Normal response is:

    {"status" => "ok"}

delete

    my $response = $api->sub_accounts->delete(userId => 12360)

Delete subaccount.

Mandatory parameters are:

    userId

Normal response is:

    {"status" => "ok"}

SEE ALSO ^

Monitis

Official API page: http://monitis.com/api/api.html#addSubAccount

AUTHOR ^

Yaroslav Korshak <ykorshak@gmail.com> Alexandr Babenko <foxcool@cpan.org>

LICENCE AND COPYRIGHT ^

Copyright (C) 2006-2011, Monitis Inc.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: