Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • Address
  • Agreement
  • AgreementDetails
  • AgreementStateDescriptor
  • AgreementTransaction
  • AgreementTransactions
  • AlternatePayment
  • Amount
  • Authorization
  • BankAccount
  • BankAccountsList
  • BankToken
  • BaseAddress
  • Billing
  • BillingAgreementToken
  • BillingInfo
  • CancelNotification
  • Capture
  • CarrierAccount
  • CarrierAccountToken
  • CartBase
  • ChargeModel
  • Cost
  • CountryCode
  • CreateProfileResponse
  • Credit
  • CreditCard
  • CreditCardHistory
  • CreditCardList
  • CreditCardToken
  • CreditFinancingOffered
  • Currency
  • CurrencyConversion
  • CustomAmount
  • DetailedRefund
  • Details
  • Error
  • ErrorDetails
  • ExtendedBankAccount
  • ExternalFunding
  • FileAttachment
  • FlowConfig
  • FmfDetails
  • FundingDetail
  • FundingInstrument
  • FundingOption
  • FundingSource
  • FuturePayment
  • HyperSchema
  • Image
  • Incentive
  • InputFields
  • InstallmentInfo
  • InstallmentOption
  • Invoice
  • InvoiceAddress
  • InvoiceItem
  • InvoiceNumber
  • InvoiceSearchResponse
  • Item
  • ItemList
  • Links
  • Measurement
  • MerchantInfo
  • MerchantPreferences
  • Metadata
  • NameValuePair
  • Notification
  • OpenIdAddress
  • OpenIdError
  • OpenIdSession
  • OpenIdTokeninfo
  • OpenIdUserinfo
  • Order
  • OverrideChargeModel
  • Participant
  • Patch
  • PatchRequest
  • Payee
  • Payer
  • PayerInfo
  • Payment
  • PaymentCard
  • PaymentCardToken
  • PaymentDefinition
  • PaymentDetail
  • PaymentExecution
  • PaymentHistory
  • PaymentInstruction
  • PaymentOptions
  • PaymentSummary
  • PaymentTerm
  • Payout
  • PayoutBatch
  • PayoutBatchHeader
  • PayoutItem
  • PayoutItemDetails
  • PayoutSenderBatchHeader
  • Phone
  • Plan
  • PlanList
  • PotentialPayerInfo
  • Presentation
  • PrivateLabelCard
  • ProcessorResponse
  • RecipientBankingInstruction
  • RedirectUrls
  • Refund
  • RefundDetail
  • RefundRequest
  • RelatedResources
  • Sale
  • Search
  • ShippingAddress
  • ShippingCost
  • ShippingInfo
  • Tax
  • Template
  • TemplateData
  • Templates
  • TemplateSettings
  • TemplateSettingsMetadata
  • Terms
  • Transaction
  • TransactionBase
  • Transactions
  • VerifyWebhookSignature
  • VerifyWebhookSignatureResponse
  • Webhook
  • WebhookEvent
  • WebhookEventList
  • WebhookEventType
  • WebhookEventTypeList
  • WebhookList
  • WebProfile

Class Templates

Class Templates

List of templates belonging to merchant.

PayPal\Common\PayPalModel
Extended by PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource
Extended by PayPal\Api\Templates
Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Templates.php

Methods summary

public
# setAddresses( PayPal\Api\Address[] $addresses )

List of addresses in merchant's profile.

List of addresses in merchant's profile.

Parameters

$addresses

Returns


$this
public PayPal\Api\Address[]
# getAddresses( )

List of addresses in merchant's profile.

List of addresses in merchant's profile.

Returns

PayPal\Api\Address[]
public
# addAddress( PayPal\Api\Address $address )

Append Addresses to the list.

Append Addresses to the list.

Parameters

$address

Returns


$this
public
# removeAddress( PayPal\Api\Address $address )

Remove Addresses from the list.

Remove Addresses from the list.

Parameters

$address

Returns


$this
public
# setEmails( string[] $emails )

List of emails in merchant's profile.

List of emails in merchant's profile.

Parameters

$emails

Returns


$this
public string[]
# getEmails( )

List of emails in merchant's profile.

List of emails in merchant's profile.

Returns

string[]
public
# addEmail( string $string )

Append Emails to the list.

Append Emails to the list.

Parameters

$string

Returns


$this
public
# removeEmail( string $string )

Remove Emails from the list.

Remove Emails from the list.

Parameters

$string

Returns


$this
public
# setPhones( PayPal\Api\Phone[] $phones )

List of phone numbers in merchant's profile.

List of phone numbers in merchant's profile.

Parameters

$phones

Returns


$this
public PayPal\Api\Phone[]
# getPhones( )

List of phone numbers in merchant's profile.

List of phone numbers in merchant's profile.

Returns

PayPal\Api\Phone[]
public
# addPhone( PayPal\Api\Phone $phone )

Append Phones to the list.

Append Phones to the list.

Parameters

$phone

Returns


$this
public
# removePhone( PayPal\Api\Phone $phone )

Remove Phones from the list.

Remove Phones from the list.

Parameters

$phone

Returns


$this
public
# setTemplates( PayPal\Api\Template[] $templates )

Array of templates.

Array of templates.

Parameters

$templates

Returns


$this
public PayPal\Api\Template[]
# getTemplates( )

Array of templates.

Array of templates.

Returns

PayPal\Api\Template[]
public
# addTemplate( PayPal\Api\Template $template )

Append Templates to the list.

Append Templates to the list.

Parameters

$template

Returns


$this
public
# removeTemplate( PayPal\Api\Template $template )

Remove Templates from the list.

Remove Templates from the list.

Parameters

$template

Returns


$this
public static PayPal\Api\Template
# get( string $templateId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )

Retrieve the details for a particular template by passing the template ID to the request URI.

Retrieve the details for a particular template by passing the template ID to the request URI.

Deprecated

Please use Template::get() instead.

Parameters

$templateId
$apiContext
is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall
is the Rest Call Service that is used to make rest calls

Returns

PayPal\Api\Template

See

PayPal\Api\Template::get()
public static PayPal\Api\Templates
# getAll( array $params = array(), PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )

Retrieves the template information of the merchant.

Retrieves the template information of the merchant.

Parameters

$params
$apiContext
is the APIContext for this call. It can be used to pass dynamic configuration and credentials.
$restCall
is the Rest Call Service that is used to make rest calls

Returns

PayPal\Api\Templates

Methods inherited from PayPal\Common\PayPalResourceModel

addLink(), executeCall(), getLink(), getLinks(), removeLink(), setLinks(), updateAccessToken()

Methods inherited from PayPal\Common\PayPalModel

__construct(), __get(), __isset(), __set(), __toString(), __unset(), fromArray(), fromJson(), getList(), setCredential(), toArray(), toJSON()

Properties summary

Properties inherited from PayPal\Common\PayPalModel

$credential

API documentation generated by ApiGen