symkat > WebService-VaultPress-Partner > WebService::VaultPress::Partner::Response

Download:
WebService-VaultPress-Partner-0.05.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.05   Source  

NAME ^

WebService::VaultPress::Partner::Response - The VaultPress Partner API Client Response Object

VERSION ^

version 0.05

SYNOPSIS ^

  #!/usr/bin/perl
  use warnings;
  use strict;
  use lib 'lib';
  use WebService::VaultPress::Partner;
  
  
  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";
  }

DESCRIPTION ^

This document outlines the methods available through the WebService::VaultPress::Partner::Response class. You should not instantiate an object of this class yourself when using WebService::VaultPress::Partner, it is returned in response to a request. Please extend this class when adding new methods to WebService::VaultPress::Partner.

WebService::VaultPress::Partner is a set of Perl modules that provide 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.

METHODS ^

api_call
Set By

WebService::VaultPress::Partner->CreateGoldenTicket WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory WebService::VaultPress::Partner->GetUsage

Value Description

The name of the request type for which this is a response of. "CreateGoldenTicket" or a response to ->CreateGoldenTicket, "GetHistory" for a response to ->GetHistory and so on.

ticket
Set By

WebService::VaultPress::Partner->CreateGoldenTicket

Value Description

Upon a successful execution and return of ->CreateGoldenTicket this will hold a string for whose value is theURL for the user to redeem her Golden Ticket.

unused
Set By

WebService::VaultPress::Partner->GetUsage

Value Description

Upon a successful execution and return of ->GetUsage this will hold an integer whose value is the number of Golden Tickets created for which there has yet to be a redemption.

basic
Set By

WebService::VaultPress::Partner->GetUsage

Value Description

Upon a successful execution and return of ->GetUsage this will hold an integer whose value is the number of Golden Tickets created for which there was redemption of as an account type 'basic'.

premium
Set By

WebService::VaultPress::Partner->GetUsage

Value Description

Upon a successful execution and return of ->GetUsage this will hold an integer whose value is the number of Golden Tickets created for which there was redemption of as an account type 'premium'.

email
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the email address of the user for whom a Golden Ticket was issued.

fname
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the first name of the user for whom a Golden Ticket was issued.

lname
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the last name of the user for whom a Golden Ticket was issued.

created
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the date and time when the Golden Ticket was created. The format is 'YYYY-MM-DD HH:MM:SS'

<ype
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the type of service for which the Golden Ticket was redeemed for. 'basic' or 'premium'. In a case where the Golden Ticket has not been redeemed this will be "".

redeemed
Set By

WebService::VaultPress::Partner->GetHistory WebService::VaultPress::Partner->GetRedeemedHistory

Value Description

Upon successful execution and return of ->GetHistory or ->GetRedeemedHistory this will hold a string whose value is the date and time when the Golden Ticket was created. The format is 'YYYY-MM-DD HH:MM:SS'

If the Golden Ticket has not been redeemed the value will be '0000-00-00 00:00:00'.

GetRedeemedHistory will not return results in the set which has not been redeemed.

SEE ALSO ^

WebService::VaultPress::Partner VaultPress::Partner::Request::History VaultPress::Partner::Usage WebService::VaultPress::Partner::GoldenTicket

AUTHOR ^

SymKat <symkat@symkat.com>

COPYRIGHT AND LICENSE ^

This is free software licensed under a BSD-Style License. Please see the LICENSE file included in this package for more detailed information.

AVAILABILITY ^

The latest version of this software is available through GitHub at https://github.com/mediatemple/webservice-vaultpress-partner/

syntax highlighting: