File Coverage

lib/eBay/API/XML/Call/GetClientAlertsAuthToken.pm
Criterion Covered Total %
statement 7 9 77.7
branch n/a
condition n/a
subroutine 3 3 100.0
pod n/a
total 10 12 83.3


line stmt bran cond sub pod time code
1             #!/usr/bin/perl
2              
3             package eBay::API::XML::Call::GetClientAlertsAuthToken;
4              
5 1     1   2260 use strict;
  1         2  
  1         24  
6 1     1   4 use warnings;
  1         2  
  1         24  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetClientAlertsAuthToken.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 08/24/2008 16:44
14             # API Release Number: ... 579
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::Call::GetClientAlertsAuthToken
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetClientAlertsAuthToken inherits from the L class
34              
35             =cut
36              
37 1     1   33 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetClientAlertsAuthToken::GetClientAlertsAuthTokenRequestType;
41             use eBay::API::XML::Call::GetClientAlertsAuthToken::GetClientAlertsAuthTokenResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetClientAlertsAuthToken';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetClientAlertsAuthToken::GetClientAlertsAuthTokenRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetClientAlertsAuthToken::GetClientAlertsAuthTokenResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62              
63              
64             #
65             # output properties
66             #
67              
68             =head2 getClientAlertsAuthToken()
69              
70             This token string is required for the Login call in the Client Alerts API.
71             The Client Alerts GetUserAlerts call, which returns alerts about events
72             associated with a specific user, requires Login.
73              
74             Returned: Always
75             # Returns: 'xs:string'
76              
77             =cut
78            
79             sub getClientAlertsAuthToken {
80             my $self = shift;
81             return $self->getResponseDataType()->getClientAlertsAuthToken();
82             }
83              
84             =head2 getHardExpirationTime()
85              
86             A Client Alerts token expires after seven days.
87              
88             Returned: Always
89             # Returns: 'xs:dateTime'
90              
91             =cut
92            
93             sub getHardExpirationTime {
94             my $self = shift;
95             return $self->getResponseDataType()->getHardExpirationTime();
96             }
97              
98              
99              
100              
101              
102             1;