Overview
  • Namespace
  • Class

Namespaces

  • PayPal
    • Api
    • Auth
    • Cache
    • Common
    • Converter
    • Core
    • Exception
    • Handler
    • Log
    • Rest
    • Security
    • Transport
    • Validation

Classes

  • PayPal\Api\Address
  • PayPal\Api\Agreement
  • PayPal\Api\AgreementDetails
  • PayPal\Api\AgreementStateDescriptor
  • PayPal\Api\AgreementTransaction
  • PayPal\Api\AgreementTransactions
  • PayPal\Api\AlternatePayment
  • PayPal\Api\Amount
  • PayPal\Api\Authorization
  • PayPal\Api\BankAccount
  • PayPal\Api\BankAccountsList
  • PayPal\Api\BankToken
  • PayPal\Api\BaseAddress
  • PayPal\Api\Billing
  • PayPal\Api\BillingAgreementToken
  • PayPal\Api\BillingInfo
  • PayPal\Api\CancelNotification
  • PayPal\Api\Capture
  • PayPal\Api\CarrierAccount
  • PayPal\Api\CarrierAccountToken
  • PayPal\Api\CartBase
  • PayPal\Api\ChargeModel
  • PayPal\Api\Cost
  • PayPal\Api\CountryCode
  • PayPal\Api\CreateProfileResponse
  • PayPal\Api\Credit
  • PayPal\Api\CreditCard
  • PayPal\Api\CreditCardHistory
  • PayPal\Api\CreditCardList
  • PayPal\Api\CreditCardToken
  • PayPal\Api\CreditFinancingOffered
  • PayPal\Api\Currency
  • PayPal\Api\CurrencyConversion
  • PayPal\Api\CustomAmount
  • PayPal\Api\DetailedRefund
  • PayPal\Api\Details
  • PayPal\Api\Error
  • PayPal\Api\ErrorDetails
  • PayPal\Api\ExtendedBankAccount
  • PayPal\Api\ExternalFunding
  • PayPal\Api\FileAttachment
  • PayPal\Api\FlowConfig
  • PayPal\Api\FmfDetails
  • PayPal\Api\FundingDetail
  • PayPal\Api\FundingInstrument
  • PayPal\Api\FundingOption
  • PayPal\Api\FundingSource
  • PayPal\Api\FuturePayment
  • PayPal\Api\HyperSchema
  • PayPal\Api\Image
  • PayPal\Api\Incentive
  • PayPal\Api\InputFields
  • PayPal\Api\InstallmentInfo
  • PayPal\Api\InstallmentOption
  • PayPal\Api\Invoice
  • PayPal\Api\InvoiceAddress
  • PayPal\Api\InvoiceItem
  • PayPal\Api\InvoiceNumber
  • PayPal\Api\InvoiceSearchResponse
  • PayPal\Api\Item
  • PayPal\Api\ItemList
  • PayPal\Api\Links
  • PayPal\Api\Measurement
  • PayPal\Api\MerchantInfo
  • PayPal\Api\MerchantPreferences
  • PayPal\Api\Metadata
  • PayPal\Api\NameValuePair
  • PayPal\Api\Notification
  • PayPal\Api\OpenIdAddress
  • PayPal\Api\OpenIdError
  • PayPal\Api\OpenIdSession
  • PayPal\Api\OpenIdTokeninfo
  • PayPal\Api\OpenIdUserinfo
  • PayPal\Api\Order
  • PayPal\Api\OverrideChargeModel
  • PayPal\Api\Participant
  • PayPal\Api\Patch
  • PayPal\Api\PatchRequest
  • PayPal\Api\Payee
  • PayPal\Api\Payer
  • PayPal\Api\PayerInfo
  • PayPal\Api\Payment
  • PayPal\Api\PaymentCard
  • PayPal\Api\PaymentCardToken
  • PayPal\Api\PaymentDefinition
  • PayPal\Api\PaymentDetail
  • PayPal\Api\PaymentExecution
  • PayPal\Api\PaymentHistory
  • PayPal\Api\PaymentInstruction
  • PayPal\Api\PaymentOptions
  • PayPal\Api\PaymentSummary
  • PayPal\Api\PaymentTerm
  • PayPal\Api\Payout
  • PayPal\Api\PayoutBatch
  • PayPal\Api\PayoutBatchHeader
  • PayPal\Api\PayoutItem
  • PayPal\Api\PayoutItemDetails
  • PayPal\Api\PayoutSenderBatchHeader
  • PayPal\Api\Phone
  • PayPal\Api\Plan
  • PayPal\Api\PlanList
  • PayPal\Api\PotentialPayerInfo
  • PayPal\Api\Presentation
  • PayPal\Api\PrivateLabelCard
  • PayPal\Api\ProcessorResponse
  • PayPal\Api\RecipientBankingInstruction
  • PayPal\Api\RedirectUrls
  • PayPal\Api\Refund
  • PayPal\Api\RefundDetail
  • PayPal\Api\RefundRequest
  • PayPal\Api\RelatedResources
  • PayPal\Api\Sale
  • PayPal\Api\Search
  • PayPal\Api\ShippingAddress
  • PayPal\Api\ShippingCost
  • PayPal\Api\ShippingInfo
  • PayPal\Api\Tax
  • PayPal\Api\Template
  • PayPal\Api\TemplateData
  • PayPal\Api\Templates
  • PayPal\Api\TemplateSettings
  • PayPal\Api\TemplateSettingsMetadata
  • PayPal\Api\Terms
  • PayPal\Api\Transaction
  • PayPal\Api\TransactionBase
  • PayPal\Api\Transactions
  • PayPal\Api\VerifyWebhookSignature
  • PayPal\Api\VerifyWebhookSignatureResponse
  • PayPal\Api\Webhook
  • PayPal\Api\WebhookEvent
  • PayPal\Api\WebhookEventList
  • PayPal\Api\WebhookEventType
  • PayPal\Api\WebhookEventTypeList
  • PayPal\Api\WebhookList
  • PayPal\Api\WebProfile
  • PayPal\Auth\OAuthTokenCredential
  • PayPal\Cache\AuthorizationCache
  • PayPal\Common\ArrayUtil
  • PayPal\Common\PayPalModel
  • PayPal\Common\PayPalResourceModel
  • PayPal\Common\PayPalUserAgent
  • PayPal\Common\ReflectionUtil
  • PayPal\Converter\FormatConverter
  • PayPal\Core\PayPalConfigManager
  • PayPal\Core\PayPalConstants
  • PayPal\Core\PayPalCredentialManager
  • PayPal\Core\PayPalHttpConfig
  • PayPal\Core\PayPalHttpConnection
  • PayPal\Core\PayPalLoggingManager
  • PayPal\Handler\OauthHandler
  • PayPal\Handler\RestHandler
  • PayPal\Log\PayPalDefaultLogFactory
  • PayPal\Log\PayPalLogger
  • PayPal\Rest\ApiContext
  • PayPal\Security\Cipher
  • PayPal\Transport\PayPalRestCall
  • PayPal\Validation\ArgumentValidator
  • PayPal\Validation\JsonValidator
  • PayPal\Validation\NumericValidator
  • PayPal\Validation\UrlValidator

Interfaces

  • PayPal\Handler\IPayPalHandler
  • PayPal\Log\PayPalLogFactory
  • PayPal\Rest\IResource

Exceptions

  • PayPal\Exception\PayPalConfigurationException
  • PayPal\Exception\PayPalConnectionException
  • PayPal\Exception\PayPalInvalidCredentialException
  • PayPal\Exception\PayPalMissingCredentialException
  1 <?php
  2 
  3 namespace PayPal\Api;
  4 
  5 use PayPal\Common\PayPalModel;
  6 
  7 /**
  8  * Class BaseAddress
  9  *
 10  * Base Address object used as billing address in a payment or extended for Shipping Address.
 11  *
 12  * @package PayPal\Api
 13  *
 14  * @property string line1
 15  * @property string line2
 16  * @property string city
 17  * @property string country_code
 18  * @property string postal_code
 19  * @property string state
 20  * @property string normalization_status
 21  * @property string status
 22  */
 23 class BaseAddress extends PayPalModel
 24 {
 25     /**
 26      * Line 1 of the Address (eg. number, street, etc).
 27      *
 28      * @param string $line1
 29      * 
 30      * @return $this
 31      */
 32     public function setLine1($line1)
 33     {
 34         $this->line1 = $line1;
 35         return $this;
 36     }
 37 
 38     /**
 39      * Line 1 of the Address (eg. number, street, etc).
 40      *
 41      * @return string
 42      */
 43     public function getLine1()
 44     {
 45         return $this->line1;
 46     }
 47 
 48     /**
 49      * Optional line 2 of the Address (eg. suite, apt #, etc.).
 50      *
 51      * @param string $line2
 52      * 
 53      * @return $this
 54      */
 55     public function setLine2($line2)
 56     {
 57         $this->line2 = $line2;
 58         return $this;
 59     }
 60 
 61     /**
 62      * Optional line 2 of the Address (eg. suite, apt #, etc.).
 63      *
 64      * @return string
 65      */
 66     public function getLine2()
 67     {
 68         return $this->line2;
 69     }
 70 
 71     /**
 72      * City name.
 73      *
 74      * @param string $city
 75      * 
 76      * @return $this
 77      */
 78     public function setCity($city)
 79     {
 80         $this->city = $city;
 81         return $this;
 82     }
 83 
 84     /**
 85      * City name.
 86      *
 87      * @return string
 88      */
 89     public function getCity()
 90     {
 91         return $this->city;
 92     }
 93 
 94     /**
 95      * 2 letter country code.
 96      *
 97      * @param string $country_code
 98      * 
 99      * @return $this
100      */
101     public function setCountryCode($country_code)
102     {
103         $this->country_code = $country_code;
104         return $this;
105     }
106 
107     /**
108      * 2 letter country code.
109      *
110      * @return string
111      */
112     public function getCountryCode()
113     {
114         return $this->country_code;
115     }
116 
117     /**
118      * Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
119      *
120      * @param string $postal_code
121      * 
122      * @return $this
123      */
124     public function setPostalCode($postal_code)
125     {
126         $this->postal_code = $postal_code;
127         return $this;
128     }
129 
130     /**
131      * Zip code or equivalent is usually required for countries that have them. For list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.
132      *
133      * @return string
134      */
135     public function getPostalCode()
136     {
137         return $this->postal_code;
138     }
139 
140     /**
141      * 2 letter code for US states, and the equivalent for other countries.
142      *
143      * @param string $state
144      * 
145      * @return $this
146      */
147     public function setState($state)
148     {
149         $this->state = $state;
150         return $this;
151     }
152 
153     /**
154      * 2 letter code for US states, and the equivalent for other countries.
155      *
156      * @return string
157      */
158     public function getState()
159     {
160         return $this->state;
161     }
162 
163     /**
164      * Address normalization status
165      * Valid Values: ["UNKNOWN", "UNNORMALIZED_USER_PREFERRED", "NORMALIZED", "UNNORMALIZED"]
166      *
167      * @param string $normalization_status
168      *
169      * @return $this
170      */
171     public function setNormalizationStatus($normalization_status)
172     {
173         $this->normalization_status = $normalization_status;
174         return $this;
175     }
176 
177     /**
178      * Address normalization status
179      *
180      * @return string
181      */
182     public function getNormalizationStatus()
183     {
184         return $this->normalization_status;
185     }
186 
187     /**
188      * Address status
189      * Valid Values: ["CONFIRMED", "UNCONFIRMED"]
190      *
191      * @param string $status
192      *
193      * @return $this
194      */
195     public function setStatus($status)
196     {
197         $this->status = $status;
198         return $this;
199     }
200 
201     /**
202      * Address status
203      *
204      * @return string
205      */
206     public function getStatus()
207     {
208         return $this->status;
209     }
210 
211 }
212 
API documentation generated by ApiGen