line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
#!/usr/bin/perl |
2
|
|
|
|
|
|
|
|
3
|
|
|
|
|
|
|
package eBay::API::XML::Call::GetNotificationsUsage; |
4
|
|
|
|
|
|
|
|
5
|
1
|
|
|
1
|
|
2286
|
use strict; |
|
1
|
|
|
|
|
1
|
|
|
1
|
|
|
|
|
29
|
|
6
|
1
|
|
|
1
|
|
5
|
use warnings; |
|
1
|
|
|
|
|
2
|
|
|
1
|
|
|
|
|
31
|
|
7
|
|
|
|
|
|
|
|
8
|
|
|
|
|
|
|
########################################################################## |
9
|
|
|
|
|
|
|
# |
10
|
|
|
|
|
|
|
# Module: ............... eBay/API/XML |
11
|
|
|
|
|
|
|
# File: ................. GetNotificationsUsage.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::GetNotificationsUsage |
21
|
|
|
|
|
|
|
|
22
|
|
|
|
|
|
|
=head1 DESCRIPTION |
23
|
|
|
|
|
|
|
|
24
|
|
|
|
|
|
|
|
25
|
|
|
|
|
|
|
|
26
|
|
|
|
|
|
|
=head1 SYNOPSIS |
27
|
|
|
|
|
|
|
|
28
|
|
|
|
|
|
|
=cut |
29
|
|
|
|
|
|
|
|
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=head1 INHERITANCE |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
eBay::API::XML::Call::GetNotificationsUsage inherits from the L class |
34
|
|
|
|
|
|
|
|
35
|
|
|
|
|
|
|
=cut |
36
|
|
|
|
|
|
|
|
37
|
1
|
|
|
1
|
|
38
|
use eBay::API::XML::BaseCall; |
|
0
|
|
|
|
|
|
|
|
0
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
our @ISA = ("eBay::API::XML::BaseCall"); |
39
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
use eBay::API::XML::Call::GetNotificationsUsage::GetNotificationsUsageRequestType; |
41
|
|
|
|
|
|
|
use eBay::API::XML::Call::GetNotificationsUsage::GetNotificationsUsageResponseType; |
42
|
|
|
|
|
|
|
|
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
=head1 Subroutines: |
45
|
|
|
|
|
|
|
|
46
|
|
|
|
|
|
|
=cut |
47
|
|
|
|
|
|
|
|
48
|
|
|
|
|
|
|
sub getApiCallName { |
49
|
|
|
|
|
|
|
return 'GetNotificationsUsage'; |
50
|
|
|
|
|
|
|
} |
51
|
|
|
|
|
|
|
sub getRequestDataTypeFullPackage { |
52
|
|
|
|
|
|
|
return 'eBay::API::XML::Call::GetNotificationsUsage::GetNotificationsUsageRequestType'; |
53
|
|
|
|
|
|
|
} |
54
|
|
|
|
|
|
|
sub getResponseDataTypeFullPackage { |
55
|
|
|
|
|
|
|
return 'eBay::API::XML::Call::GetNotificationsUsage::GetNotificationsUsageResponseType'; |
56
|
|
|
|
|
|
|
} |
57
|
|
|
|
|
|
|
|
58
|
|
|
|
|
|
|
# |
59
|
|
|
|
|
|
|
# input properties |
60
|
|
|
|
|
|
|
# |
61
|
|
|
|
|
|
|
|
62
|
|
|
|
|
|
|
=head2 setEndTime() |
63
|
|
|
|
|
|
|
|
64
|
|
|
|
|
|
|
Specifies the end date and time for which notification information |
65
|
|
|
|
|
|
|
will be retrieved. EndTime is optional. If no EndTime is specified, |
66
|
|
|
|
|
|
|
the current time (the time the call is made) is used. If no EndTime |
67
|
|
|
|
|
|
|
is specified or if an invalid EndTime is specified, date range errors |
68
|
|
|
|
|
|
|
are returned in the response. For an EndTime to be valid, it must be no |
69
|
|
|
|
|
|
|
more than 72 hours before the time the of the call, it cannot be before |
70
|
|
|
|
|
|
|
the StartTime, and it cannot be later than the time of the call. If an |
71
|
|
|
|
|
|
|
invalid EndTime is specified, the current time is used. |
72
|
|
|
|
|
|
|
|
73
|
|
|
|
|
|
|
RequiredInput: Conditionally |
74
|
|
|
|
|
|
|
# Argument: 'xs:dateTime' |
75
|
|
|
|
|
|
|
|
76
|
|
|
|
|
|
|
=cut |
77
|
|
|
|
|
|
|
|
78
|
|
|
|
|
|
|
sub setEndTime { |
79
|
|
|
|
|
|
|
my $self = shift; |
80
|
|
|
|
|
|
|
my $sEndTime = shift; |
81
|
|
|
|
|
|
|
$self->getRequestDataType()->setEndTime($sEndTime); |
82
|
|
|
|
|
|
|
} |
83
|
|
|
|
|
|
|
|
84
|
|
|
|
|
|
|
=head2 setItemID() |
85
|
|
|
|
|
|
|
|
86
|
|
|
|
|
|
|
Specifies an item ID for which detailed notification information will be |
87
|
|
|
|
|
|
|
retrieved. ItemID is optional. If no ItemID is specified, the response |
88
|
|
|
|
|
|
|
will not include any individual notification details. |
89
|
|
|
|
|
|
|
|
90
|
|
|
|
|
|
|
MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) |
91
|
|
|
|
|
|
|
|
92
|
|
|
|
|
|
|
RequiredInput: Conditionally |
93
|
|
|
|
|
|
|
# Argument: 'ns:ItemIDType' |
94
|
|
|
|
|
|
|
|
95
|
|
|
|
|
|
|
=cut |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
sub setItemID { |
98
|
|
|
|
|
|
|
my $self = shift; |
99
|
|
|
|
|
|
|
my $pItemID = shift; |
100
|
|
|
|
|
|
|
$self->getRequestDataType()->setItemID($pItemID); |
101
|
|
|
|
|
|
|
} |
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
=head2 setStartTime() |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
Specifies the start date and time for which notification information |
106
|
|
|
|
|
|
|
will be retrieved. StartTime is optional. If no StartTime is specified, |
107
|
|
|
|
|
|
|
the default value of 24 hours prior to the call time is used. If no |
108
|
|
|
|
|
|
|
StartTime is specified or if an invalid StartTime is specified, date |
109
|
|
|
|
|
|
|
range errors are returned in the response. For a StartTime to be valid, |
110
|
|
|
|
|
|
|
it must be no more than 72 hours before the time of the call, it cannot |
111
|
|
|
|
|
|
|
be more recent than the EndTime, and it cannot be later than the time of |
112
|
|
|
|
|
|
|
the call. If an invalid StartTime is specified, the default value is |
113
|
|
|
|
|
|
|
used. |
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
RequiredInput: Conditionally |
116
|
|
|
|
|
|
|
# Argument: 'xs:dateTime' |
117
|
|
|
|
|
|
|
|
118
|
|
|
|
|
|
|
=cut |
119
|
|
|
|
|
|
|
|
120
|
|
|
|
|
|
|
sub setStartTime { |
121
|
|
|
|
|
|
|
my $self = shift; |
122
|
|
|
|
|
|
|
my $sStartTime = shift; |
123
|
|
|
|
|
|
|
$self->getRequestDataType()->setStartTime($sStartTime); |
124
|
|
|
|
|
|
|
} |
125
|
|
|
|
|
|
|
|
126
|
|
|
|
|
|
|
|
127
|
|
|
|
|
|
|
|
128
|
|
|
|
|
|
|
# |
129
|
|
|
|
|
|
|
# output properties |
130
|
|
|
|
|
|
|
# |
131
|
|
|
|
|
|
|
|
132
|
|
|
|
|
|
|
=head2 getEndTime() |
133
|
|
|
|
|
|
|
|
134
|
|
|
|
|
|
|
Returns the end date and time for the notification information that is |
135
|
|
|
|
|
|
|
returned by this call. The default is Now. |
136
|
|
|
|
|
|
|
|
137
|
|
|
|
|
|
|
Returned: Always |
138
|
|
|
|
|
|
|
# Returns: 'xs:dateTime' |
139
|
|
|
|
|
|
|
|
140
|
|
|
|
|
|
|
=cut |
141
|
|
|
|
|
|
|
|
142
|
|
|
|
|
|
|
sub getEndTime { |
143
|
|
|
|
|
|
|
my $self = shift; |
144
|
|
|
|
|
|
|
return $self->getResponseDataType()->getEndTime(); |
145
|
|
|
|
|
|
|
} |
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
=head2 getMarkUpMarkDownHistory() |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
List of objects representing MarkUp or MarkDown history for a given appID |
150
|
|
|
|
|
|
|
and for given StartTime and EndTime. This node will always be returned. |
151
|
|
|
|
|
|
|
|
152
|
|
|
|
|
|
|
Returned: Always |
153
|
|
|
|
|
|
|
# Returns: 'ns:MarkUpMarkDownHistoryType' |
154
|
|
|
|
|
|
|
|
155
|
|
|
|
|
|
|
=cut |
156
|
|
|
|
|
|
|
|
157
|
|
|
|
|
|
|
sub getMarkUpMarkDownHistory { |
158
|
|
|
|
|
|
|
my $self = shift; |
159
|
|
|
|
|
|
|
return $self->getResponseDataType()->getMarkUpMarkDownHistory(); |
160
|
|
|
|
|
|
|
} |
161
|
|
|
|
|
|
|
|
162
|
|
|
|
|
|
|
=head2 getNotificationDetailsArray() |
163
|
|
|
|
|
|
|
|
164
|
|
|
|
|
|
|
List of notification objects representing the notifications sent to an |
165
|
|
|
|
|
|
|
application for the given time period. It will only be returned if ItemID |
166
|
|
|
|
|
|
|
was specified in the input request. |
167
|
|
|
|
|
|
|
|
168
|
|
|
|
|
|
|
Returned: Conditionally |
169
|
|
|
|
|
|
|
# Returns: 'ns:NotificationDetailsArrayType' |
170
|
|
|
|
|
|
|
|
171
|
|
|
|
|
|
|
=cut |
172
|
|
|
|
|
|
|
|
173
|
|
|
|
|
|
|
sub getNotificationDetailsArray { |
174
|
|
|
|
|
|
|
my $self = shift; |
175
|
|
|
|
|
|
|
return $self->getResponseDataType()->getNotificationDetailsArray(); |
176
|
|
|
|
|
|
|
} |
177
|
|
|
|
|
|
|
|
178
|
|
|
|
|
|
|
=head2 getNotificationStatistics() |
179
|
|
|
|
|
|
|
|
180
|
|
|
|
|
|
|
Summary information about number of notifications that were successfully |
181
|
|
|
|
|
|
|
delivered, queued, failed, connection attempts made, connection timeouts, |
182
|
|
|
|
|
|
|
http errors for the given appID and given time period. By default, statistics |
183
|
|
|
|
|
|
|
for only one day (Now-1day) is included. Maximum time duration allowed is 3 days |
184
|
|
|
|
|
|
|
(Now-3days). |
185
|
|
|
|
|
|
|
|
186
|
|
|
|
|
|
|
Returned: Always |
187
|
|
|
|
|
|
|
# Returns: 'ns:NotificationStatisticsType' |
188
|
|
|
|
|
|
|
|
189
|
|
|
|
|
|
|
=cut |
190
|
|
|
|
|
|
|
|
191
|
|
|
|
|
|
|
sub getNotificationStatistics { |
192
|
|
|
|
|
|
|
my $self = shift; |
193
|
|
|
|
|
|
|
return $self->getResponseDataType()->getNotificationStatistics(); |
194
|
|
|
|
|
|
|
} |
195
|
|
|
|
|
|
|
|
196
|
|
|
|
|
|
|
=head2 getStartTime() |
197
|
|
|
|
|
|
|
|
198
|
|
|
|
|
|
|
Returns the start date and time for the notification information that is |
199
|
|
|
|
|
|
|
returned by this call. The oldest date allowed for this field is Now-3days. |
200
|
|
|
|
|
|
|
Default is Now-1day. |
201
|
|
|
|
|
|
|
|
202
|
|
|
|
|
|
|
Returned: Always |
203
|
|
|
|
|
|
|
# Returns: 'xs:dateTime' |
204
|
|
|
|
|
|
|
|
205
|
|
|
|
|
|
|
=cut |
206
|
|
|
|
|
|
|
|
207
|
|
|
|
|
|
|
sub getStartTime { |
208
|
|
|
|
|
|
|
my $self = shift; |
209
|
|
|
|
|
|
|
return $self->getResponseDataType()->getStartTime(); |
210
|
|
|
|
|
|
|
} |
211
|
|
|
|
|
|
|
|
212
|
|
|
|
|
|
|
|
213
|
|
|
|
|
|
|
|
214
|
|
|
|
|
|
|
|
215
|
|
|
|
|
|
|
|
216
|
|
|
|
|
|
|
1; |