Renee Baecker > Nexmo-SMS-0.06 > Nexmo::SMS::GetBalance

Download:
Nexmo-SMS-0.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.02   Source  

NAME ^

Nexmo::SMS::GetBalance - Module to ask for the balance for the Nexmo SMS API!

VERSION ^

version 0.06

SYNOPSIS ^

This module simplifies sending SMS through the Nexmo API.

    use Nexmo::SMS::GetBalance;

    my $nexmo = Nexmo::SMS::GetBalance->new(
        server   => 'http://rest.nexmo.com/sms/json',
        username => 'testuser1',
        password => 'testpasswd2',
    );
        
    my $balance = $sms->get_balance;

VERSION ^

Version 0.02

METHODS ^

new

create a new object

    my $object = Nexmo::SMS::GetBalance->new(
        server   => 'http://rest.nexmo.com/sms/json',
        username => 'testuser1',
        password => 'testpasswd2',
    );

This method recognises these parameters:

    server            => 'required',
    username          => 'required',
    password          => 'required',

user_agent

Getter/setter for the user_agent attribute of the object. By default a new object of LWP::UserAgent is used, but you can use your own class as long as it is compatible to LWP::UserAgent.

  $sms->user_agent( MyUserAgent->new );
  my $ua = $sms->user_agent;

get_balance

This actually calls the Nexmo SMS API. It returns the balance of the account.

   my $balance = $object->get_balance;

Attributes ^

These attributes are available for Nexmo::SMS::GetBalance objects. For each attribute there is a getter/setter:

  $nexmo->server( 'servername' );
  my $server = $nexmo->server;

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2011 Renee Baecker.

This program is released under the following license: artistic_2

AUTHOR ^

Renee Baecker <module@renee-baecker.de>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2011 by Renee Baecker.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)
syntax highlighting: