WebService::VaultPress::Partner::Request::GoldenTicket - The VaultPress Partner API Client Golden Ticket Request Object
version 0.05
my $vp = WebService::VaultPress::Partner->new( key => 'Your API Key Goes Here', ); my $result = eval { $vp->GetUsage }; if ( $@ ) { print "->GetUsage had an error: $@"; } else { printf( "%7s => %5d\n", $_, $result->$_ ) for qw/ unused basic premium /; } my @results = $vp->GetHistory; if ( $@ ) { print "->GetHistory had an error: $@"; } else { for my $res ( @results ) { printf( "| %-20s | %-20s | %-30s | %-19s | %-19s | %-7s |\n", $res->fname, $res->lname, $res->email, $res->created, $res->redeemed, $res->type ); } } # Give Alan Shore a 'Golden Ticket' to VaultPress my $ticket = eval { $vp->CreateGoldenTicket( fname => 'Alan', lname => 'Shore', email => 'alan.shore@gmail.com', ); }; if ( $@ ) { print "->CreateGoldenTicket had an error: $@"; } else { print "You can sign up for your VaultPress account <a href=\"" . $ticket->ticket ."\">Here!</a>\n"; }
This document outlines the methods available through the WebService::VaultPress::Partner::Request::GoldenTicket class. You should not instantiate an object of this class yourself when using WebService::VaultPress::Partner, it is created by the arguments to ->CreateGoldenTicket. Its primary purpose is to use Moose's type and error systems to throw errors when required parameters are not passed to ->CreateGoldenTicket
WebService::VaultPress::Partner is a set of Perl modules which provides a simple and consistent Client API to the VaultPress Partner API. The main focus of the library is to provide classes and functions that allow you to quickly access VaultPress from Perl applications.
The modules consist of the WebService::VaultPress::Partner module itself as well as a handful of WebService::VaultPress::Partner::Request modules as well as a response object, WebService::VaultPress::Partner::Response, that provides consistent error and success methods.
WebService::VaultPress::Partner->CreateGoldenTicket( key => value, … )
This key is not required.
Unless explicitly set the value for this method is "https://partner-api.vaultpress.com/gtm/1.0/"
This method provides WebService::VaultPress::Partner with the URL which will be used for the API call.
This key is required.
There is no default value associated with this method, it must be explicitly set.
This method provides WebService::VaultPress::Partner with the email address of the user on whose behalf the Golden Ticket is being requested.
This method provides WebService::VaultPress::Partner with the first name of the user on whose behalf the Golden Ticket is being requested.call.
This method provides WebService::VaultPress::Partner with the last name of the user on whose behalf the Golden Ticket is being requested.
WebService::VaultPress::Partner VaultPress::Partner::Response VaultPress::Partner::Request::History WebService::VaultPress::Partner::Usage
SymKat <symkat@symkat.com>
This is free software licensed under a BSD-Style License. Please see the LICENSE file included in this package for more detailed information.
The latest version of this software is available through GitHub at https://github.com/mediatemple/webservice/vaultpress-partner/
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '…'. Assuming UTF-8
To install WebService::VaultPress::Partner, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::VaultPress::Partner
CPAN shell
perl -MCPAN -e shell install WebService::VaultPress::Partner
For more information on module installation, please visit the detailed CPAN module installation guide.