File Coverage

lib/eBay/API/XML/Call/GeteBayDetails.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::GeteBayDetails;
4              
5 1     1   2734 use strict;
  1         2  
  1         29  
6 1     1   5 use warnings;
  1         1  
  1         35  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GeteBayDetails.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::GeteBayDetails
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GeteBayDetails inherits from the L class
34              
35             =cut
36              
37 1     1   40 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GeteBayDetails::GeteBayDetailsRequestType;
41             use eBay::API::XML::Call::GeteBayDetails::GeteBayDetailsResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GeteBayDetails';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GeteBayDetails::GeteBayDetailsRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GeteBayDetails::GeteBayDetailsResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62             =head2 setDetailName()
63              
64             A designation of what kind of information you wish returned
65             for the specified eBay site. If omitted, all details are
66             returned.
67             The possible values for input (the enumeration values of
68             DetailNameCodeType) are the same name as fields returned by
69             the response. See the documentation for the
70             GeteBayDetails response to better understand the DetailName
71             options.
72              
73             RequiredInput: No
74             # Argument: reference to an array
75             of 'ns:DetailNameCodeType'
76              
77             =cut
78            
79             sub setDetailName {
80             my $self = shift;
81             my $sDetailName = shift;
82             $self->getRequestDataType()->setDetailName($sDetailName);
83             }
84              
85              
86              
87             #
88             # output properties
89             #
90              
91             =head2 getCountryDetails()
92              
93             Details about a specific country. GeteBayDetails returns all countries in
94             the system, regardless of the site to which you sent the request.
95              
96             Returned: Conditionally
97             # Returns: reference to an array
98             of 'ns:CountryDetailsType'
99              
100             =cut
101            
102             sub getCountryDetails {
103             my $self = shift;
104             return $self->getResponseDataType()->getCountryDetails();
105             }
106              
107             =head2 getCurrencyDetails()
108              
109             Details about a specific currency that can be used for listing on an eBay
110             site. GeteBayDetails returns all site currencies in the system, regardless
111             of the site to which you sent the request.
112              
113             Returned: Conditionally
114             # Returns: reference to an array
115             of 'ns:CurrencyDetailsType'
116              
117             =cut
118            
119             sub getCurrencyDetails {
120             my $self = shift;
121             return $self->getResponseDataType()->getCurrencyDetails();
122             }
123              
124             =head2 getDispatchTimeMaxDetails()
125              
126             Details about a specific max dispatch time. A dispatch time specifies the
127             maximum number of business days a seller commits to for shipping an item
128             to domestic buyers after receiving a cleared payment. GeteBayDetails
129             returns all dispatch times in the system, regardless of the site to which
130             you sent the request.
131              
132             Returned: Conditionally
133             # Returns: reference to an array
134             of 'ns:DispatchTimeMaxDetailsType'
135              
136             =cut
137            
138             sub getDispatchTimeMaxDetails {
139             my $self = shift;
140             return $self->getResponseDataType()->getDispatchTimeMaxDetails();
141             }
142              
143             =head2 getItemSpecificDetails()
144              
145             The site's validation rules (e.g., string lengths) for custom Item Specifics.
146              
147             Returned: Conditionally
148             # Returns: reference to an array
149             of 'ns:ItemSpecificDetailsType'
150              
151             =cut
152            
153             sub getItemSpecificDetails {
154             my $self = shift;
155             return $self->getResponseDataType()->getItemSpecificDetails();
156             }
157              
158             =head2 getPaymentOptionDetails()
159              
160             Details about a specific buyer payment method. GeteBayDetails only returns
161             payment methods that are applicable to the site to which you sent the
162             request.
163              
164             Returned: Conditionally
165             # Returns: reference to an array
166             of 'ns:PaymentOptionDetailsType'
167              
168             =cut
169            
170             sub getPaymentOptionDetails {
171             my $self = shift;
172             return $self->getResponseDataType()->getPaymentOptionDetails();
173             }
174              
175             =head2 getRegionDetails()
176              
177             [Ignorable region values for all sites.]
178              
179             Returned: Conditionally
180             Ignore:
181             # Returns: reference to an array
182             of 'ns:RegionDetailsType'
183              
184             =cut
185            
186             sub getRegionDetails {
187             my $self = shift;
188             return $self->getResponseDataType()->getRegionDetails();
189             }
190              
191             =head2 getRegionOfOriginDetails()
192              
193             Details about the region of origin, specific to a site.
194              
195             Returned: Conditionally
196             Ignore:
197             # Returns: reference to an array
198             of 'ns:RegionOfOriginDetailsType'
199              
200             =cut
201            
202             sub getRegionOfOriginDetails {
203             my $self = shift;
204             return $self->getResponseDataType()->getRegionOfOriginDetails();
205             }
206              
207             =head2 getShippingCarrierDetails()
208              
209             The kinds of carrier supported by this shipping service.
210              
211             Returned: Conditionally
212             # Returns: reference to an array
213             of 'ns:ShippingCarrierDetailsType'
214              
215             =cut
216            
217             sub getShippingCarrierDetails {
218             my $self = shift;
219             return $self->getResponseDataType()->getShippingCarrierDetails();
220             }
221              
222             =head2 getShippingLocationDetails()
223              
224             Details about a location or region to which the seller is willing to ship.
225             GeteBayDetails returns all shipping locations in the system, regardless of
226             the site to which you sent the request.
227              
228             Returned: Conditionally
229             # Returns: reference to an array
230             of 'ns:ShippingLocationDetailsType'
231              
232             =cut
233            
234             sub getShippingLocationDetails {
235             my $self = shift;
236             return $self->getResponseDataType()->getShippingLocationDetails();
237             }
238              
239             =head2 getShippingPackageDetails()
240              
241             Details about various shipping packages.
242              
243             Returned: Conditionally
244             # Returns: reference to an array
245             of 'ns:ShippingPackageDetailsType'
246              
247             =cut
248            
249             sub getShippingPackageDetails {
250             my $self = shift;
251             return $self->getResponseDataType()->getShippingPackageDetails();
252             }
253              
254             =head2 getShippingServiceDetails()
255              
256             Details about a specific shipping service. GeteBayDetails only returns
257             shipping services that are applicable to the site to which you sent the
258             request.
259              
260             Returned: Conditionally
261             # Returns: reference to an array
262             of 'ns:ShippingServiceDetailsType'
263              
264             =cut
265            
266             sub getShippingServiceDetails {
267             my $self = shift;
268             return $self->getResponseDataType()->getShippingServiceDetails();
269             }
270              
271             =head2 getSiteDetails()
272              
273             Details about a specific eBay site. GeteBayDetails returns all sites in
274             the system, regardless of the site to which you sent the request.
275              
276             Returned: Conditionally
277             # Returns: reference to an array
278             of 'ns:SiteDetailsType'
279              
280             =cut
281            
282             sub getSiteDetails {
283             my $self = shift;
284             return $self->getResponseDataType()->getSiteDetails();
285             }
286              
287             =head2 getTaxJurisdiction()
288              
289             Details about a specific tax jurisdiction or tax region. GeteBayDetails
290             only returns jurisdictions that are applicable to the site to which you
291             sent the request.

292             Related fields:
293             TaxTable.TaxJurisdiction in SetTaxTable
294             Item.UseTaxTable in Additem
295              
296             Returned: Conditionally
297             # Returns: reference to an array
298             of 'ns:TaxJurisdictionType'
299              
300             =cut
301            
302             sub getTaxJurisdiction {
303             my $self = shift;
304             return $self->getResponseDataType()->getTaxJurisdiction();
305             }
306              
307             =head2 getTimeZoneDetails()
308              
309             Details about a specific eBay time zone. GeteBayDetails returns all time
310             zones eBay supports.
311              
312             Returned: Conditionally
313             # Returns: reference to an array
314             of 'ns:TimeZoneDetailsType'
315              
316             =cut
317            
318             sub getTimeZoneDetails {
319             my $self = shift;
320             return $self->getResponseDataType()->getTimeZoneDetails();
321             }
322              
323             =head2 getURLDetails()
324              
325             Details about a specific eBay URL. GeteBayDetails only returns URLs that
326             are applicable to the site to which you sent the request.
327              
328             Returned: Conditionally
329             # Returns: reference to an array
330             of 'ns:URLDetailsType'
331              
332             =cut
333            
334             sub getURLDetails {
335             my $self = shift;
336             return $self->getResponseDataType()->getURLDetails();
337             }
338              
339             =head2 getUnitOfMeasurementDetails()
340              
341             Suggested text to use when specifying units of measure in custom Item Specifics.
342              
343             Returned: Conditionally
344             # Returns: reference to an array
345             of 'ns:UnitOfMeasurementDetailsType'
346              
347             =cut
348            
349             sub getUnitOfMeasurementDetails {
350             my $self = shift;
351             return $self->getResponseDataType()->getUnitOfMeasurementDetails();
352             }
353              
354              
355              
356              
357              
358             1;