The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
SMS-MessageBird-0.04
River stage one • 1 direct dependent • 1 total dependent
1 ++
/ SMS::MessageBird::API::Verify

NAME

SMS::MessageBird::API::Verify - Sub-module for the SMS::MessageBird distribution.

SYNOPSIS

This is a sub-module which is part of the SMS::MessageBird distribution.

While this module can be used directly, it's designed to be used via SMS::MessageBird

DESCRIPTION

This module provides the interface to the Verify methods of the MessageBird JSON API.

The methods implmented acceept the paramteres as named in the MessageBird API documentation which can be found at the MessageBird Developer Documentation. If you're using this distribution you should be familiar with the API documentation.

Response Data

Every method returns a standardised hashref containin the following keys:

ok

Value of 0 or 1. Indicates if the request was completed successfully or not. This value is based on LWP::UserAgent's is_success() method.

code

This is the HTTP code returned by the API. In the event of ok => 0 - it's possible that the request was a 401 etc. So this is provided for sanity checking.

content

This is a Perl hashref data structure decoded from the API's response JSON as-is.

Please see the MessageBird Developer Documentation for more information on the expected structure.

METHODS

request

  In:  %params   - Hash of params accepted by the MessageBird API.
  Out: $response - Hashref of response data. See "Response Data" above.

This method implements the POST /verify route of the API.

Requests creation and sending of a verification link to the supplied MSISDN.

Accepted parameters are listed in the MessageBird API documentation.

Require parameters are as follows:

recipient

The MSISDN formatted telephone number to do send the verification link to.

All other parameters are optional.

Please see the MessageBird Developer Documentation for more information.

verify

  In:  $verification_id - The verification ID returned by the request call.
  In:  $token           - The token to attempt to verify.
  Out: $response - Hashref of response data. See "Response Data" above.

This method implements the GET /verify/{verification_id}?token={token} route of the API.

Attempts to verify a sent verification token.

Please see the MessageBird API Documentation for more information.

get

  In:  $verification_id - The verification ID returned by the request call.
  Out: $response - Hashref of response data. See "Response Data" above.

This method implements the GET /verify/{verification_id} route of the API.

Returns the existing verification object identified by $verification_id.

remove

  In:  $verification_id - The verification ID returned by the request call.
  Out: $response - Hashref of response data. See "Response Data" above.

This method implements the DELETE /verify/{verification_id} route of the API.

Deletes an existing verification object identified by $verification_id.

del

Synonym for the remove() method.

AUTHOR

James Ronan, <james at ronanweb.co.uk>

BUGS

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

Alternatively you can raise an issue on the source code which is available on GitHub.

LICENSE AND COPYRIGHT

Copyright 2016 James Ronan.

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