File Coverage

lib/eBay/API/XML/Call/GetShippingDiscountProfiles.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::GetShippingDiscountProfiles;
4              
5 1     1   2473 use strict;
  1         1  
  1         27  
6 1     1   5 use warnings;
  1         2  
  1         25  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. GetShippingDiscountProfiles.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::GetShippingDiscountProfiles
21              
22             =head1 DESCRIPTION
23              
24              
25              
26             =head1 SYNOPSIS
27              
28             =cut
29              
30              
31             =head1 INHERITANCE
32              
33             eBay::API::XML::Call::GetShippingDiscountProfiles inherits from the L class
34              
35             =cut
36              
37 1     1   42 use eBay::API::XML::BaseCall;
  0            
  0            
38             our @ISA = ("eBay::API::XML::BaseCall");
39              
40             use eBay::API::XML::Call::GetShippingDiscountProfiles::GetShippingDiscountProfilesRequestType;
41             use eBay::API::XML::Call::GetShippingDiscountProfiles::GetShippingDiscountProfilesResponseType;
42              
43              
44             =head1 Subroutines:
45              
46             =cut
47              
48             sub getApiCallName {
49             return 'GetShippingDiscountProfiles';
50             }
51             sub getRequestDataTypeFullPackage {
52             return 'eBay::API::XML::Call::GetShippingDiscountProfiles::GetShippingDiscountProfilesRequestType';
53             }
54             sub getResponseDataTypeFullPackage {
55             return 'eBay::API::XML::Call::GetShippingDiscountProfiles::GetShippingDiscountProfilesResponseType';
56             }
57              
58             #
59             # input properties
60             #
61              
62              
63              
64             #
65             # output properties
66             #
67              
68             =head2 getCalculatedHandlingDiscount()
69              
70             The data for the specific packaging/handling details for combined payment.
71             Returned only if it has been defined.
72              
73             Returned: Conditionally
74             # Returns: 'ns:CalculatedHandlingDiscountType'
75              
76             =cut
77            
78             sub getCalculatedHandlingDiscount {
79             my $self = shift;
80             return $self->getResponseDataType()->getCalculatedHandlingDiscount();
81             }
82              
83             =head2 getCalculatedShippingDiscount()
84              
85             Details of an individual discount profile defined by the
86             user for calculated shipping--one for each profile defined by the user.
87             Empty if no shipping discount profiles were defined.
88              
89             Returned: Always
90             # Returns: 'ns:CalculatedShippingDiscountType'
91              
92             =cut
93            
94             sub getCalculatedShippingDiscount {
95             my $self = shift;
96             return $self->getResponseDataType()->getCalculatedShippingDiscount();
97             }
98              
99             =head2 getCombinedDuration()
100              
101             Only those items purchased within CombinedDuration days of each other can
102             be combined into an order and benefit from any shipping discounts.
103              
104             Returned: Always
105             # Returns: 'ns:CombinedPaymentPeriodCodeType'
106              
107             =cut
108            
109             sub getCombinedDuration {
110             my $self = shift;
111             return $self->getResponseDataType()->getCombinedDuration();
112             }
113              
114             =head2 getCurrencyID()
115              
116             The ID of the currency to be used for shipping cost discounts and
117             insurance for combined payment. A discount profile can only be associated
118             with a listing if the currency ID of the profile matches the currency ID
119             of the listing.
120              
121             Returned: Always
122             # Returns: 'ns:CurrencyCodeType'
123              
124             =cut
125            
126             sub getCurrencyID {
127             my $self = shift;
128             return $self->getResponseDataType()->getCurrencyID();
129             }
130              
131             =head2 getFlatShippingDiscount()
132              
133             Details of an individual discount profile defined by the
134             user for flat rate shipping--one for each profile defined by the user.
135             Empty if no shipping discount profiles were defined.
136              
137             Returned: Always
138             # Returns: 'ns:FlatShippingDiscountType'
139              
140             =cut
141            
142             sub getFlatShippingDiscount {
143             my $self = shift;
144             return $self->getResponseDataType()->getFlatShippingDiscount();
145             }
146              
147             =head2 getInternationalShippingInsurance()
148              
149             The data for the international insurance for combined payment.
150             Returned only if it has been defined.
151              
152             Returned: Conditionally
153             # Returns: 'ns:ShippingInsuranceType'
154              
155             =cut
156            
157             sub getInternationalShippingInsurance {
158             my $self = shift;
159             return $self->getResponseDataType()->getInternationalShippingInsurance();
160             }
161              
162             =head2 isPromotionalShippingDiscount()
163              
164             Indicates whether the user defined a promotional discount (the discount is active
165             as soon as it exists).
166              
167             Returned: Always
168             # Returns: 'xs:boolean'
169              
170             =cut
171            
172             sub isPromotionalShippingDiscount {
173             my $self = shift;
174             return $self->getResponseDataType()->isPromotionalShippingDiscount();
175             }
176              
177             =head2 getPromotionalShippingDiscountDetails()
178              
179             The data for the specific promotional shipping discount.
180             Returned only if it has been defined.
181              
182             Returned: Conditionally
183             # Returns: 'ns:PromotionalShippingDiscountDetailsType'
184              
185             =cut
186            
187             sub getPromotionalShippingDiscountDetails {
188             my $self = shift;
189             return $self->getResponseDataType()->getPromotionalShippingDiscountDetails();
190             }
191              
192             =head2 getShippingInsurance()
193              
194             The data for the domestic insurance for combined payment.
195             Returned only if it has been defined.
196              
197             Returned: Conditionally
198             # Returns: 'ns:ShippingInsuranceType'
199              
200             =cut
201            
202             sub getShippingInsurance {
203             my $self = shift;
204             return $self->getResponseDataType()->getShippingInsurance();
205             }
206              
207              
208              
209              
210              
211             1;