Ярослав Коршак > Monitis-0.9 > Monitis::Contacts

Download:
Monitis-0.9.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Monitis::Contacts - Contacts manipulation

SYNOPSIS ^

    use Monitis::Contacts;

DESCRIPTION ^

ATTRIBUTES ^

Monitis::Contacts implements following attributes:

METHODS ^

Monitis::Contacts implements following methods:

add

    my $response = $api->contacts->add(
        firstName   => 'John',
        lastName    => 'Smith',
        account     => '1234567',
        contactType => 3,           # ICQ
        timezone    => 300
    );

Add new contact.

Mandatory parameters:

    firstName lastName account contactType timezone

Optional parameters:

    group sendDailyReport sendWeeklyReport sendMonthlyReport portable country textType

Normal response is:

    {   "status" => "ok",
        "data"   => {
            "confirmationKey" => "1022312835020242188844937884154552",
            "contactId"       => 10223
        }
    }

edit

    my $response = $api->contacts->edit(
        contactId => 10223,
        firstName => 'Ivan'
    );

Edit contact details.

Mandatory parameters:

    contactId

Optional parameters:

    firstName lastName account contactType timezone sendDailyReport
    sendWeeklyReport sendMonthlyReport portable code country textType

Normal response is:

    {   "status" => "ok",
        "data"   => {"confirmationKey" => "1022312837120242188844937884195552"}

    }

delete

    my $response = $api->contacts->delete(contactId => 10223);

Delete contact.

Mandatory parameters:

    One of optional parameters required to be specified.

Optional parameters:

    contactId account contactType

Normal response is:

    {"status" => "ok"}

confirm

    my $response =
      $api->contacts->confirm(contactId => 10223, confirmationKey => $key);

Confirm contact.

Mandatory parameters:

    contactId confirmationKey

Normal response is:

    {"status" => "ok"}

activate

    my $response =
      $api->contacts->activate(contactId => 10223);

Activate contact.

Mandatory parameters:

    contactId

Normal response is:

    {"status" => "ok"}

deactivate

    my $response =
      $api->contacts->deactivate(contactId => 10223);

Activate contact.

Mandatory parameters:

    contactId

Normal response is:

    {"status" => "ok"}

get

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

Get all contacts.

Normal response is:

    [   {   "contactId"        => 3549,
            "name"             => "John Smith",
            "contactType"      => "Email",
            "contactAccount"   => "j_s@gmail.com",
            "timezone"         => 300,
            "portable"         => false,
            "activeFlag"       => 1,
            "textType"         => 0,
            "confirmationFlag" => 1,
            "country"          => "USA"
        },

        # ...
    ]

get_groups

    my $response = $api->contacts->get_groups;

Get all groups.

Normal response is:

    [   {   "id"         => 681,
            "activeFlag" => 1,
            "name"       => "Monitoring Team"
        },

        # ...
    ]

get_recent_alerts

    my $response =
      $api->contacts->get_recent_alerts(startDate => $start, endDate => $end);

Get all recent alerts.

Optional parameters:

    timezone startDate endDate limit

Normal response is:

    {   "status" => "ok",
        "data"   => [
            {   "dataType"   => "External Monitor",
                "recDate"    => "8 May 2011 07 => 09 => 59 GMT",
                "dataId"     => 36963,
                "failDate"   => "8 May 2011 07 => 04 => 58 GMT",
                "dataTypeId" => 0,
                "contacts"   => "someAccount@gmail.com",
                "dataName"   => "api_dns"
            },

            # ...
        ]
    }

SEE ALSO ^

Monitis

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

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: