Class Template

Invoicing Template

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

PayPal\Api\Template

Namespace: PayPal\Api
Package: PayPal\Api
Located at PayPal/Api/Template.php

Methods summary

`public`	# `setTemplateId( string $template_id )` Unique identifier id of the template. Unique identifier id of the template. Parameters `$template_id` Returns $this
`public string`	# `getTemplateId( )` Unique identifier id of the template. Unique identifier id of the template. Returns string
`public`	# `setName( string $name )` Name of the template. Name of the template. Parameters `$name` Returns $this
`public string`	# `getName( )` Name of the template. Name of the template. Returns string
`public`	# `setDefault( boolean $default )` Indicates that this template is merchant's default. There can be only one template which can be a default. Indicates that this template is merchant's default. There can be only one template which can be a default. Parameters `$default` Returns $this
`public boolean`	# `getDefault( )` Indicates that this template is merchant's default. There can be only one template which can be a default. Indicates that this template is merchant's default. There can be only one template which can be a default. Returns boolean
`public`	# `setTemplateData( PayPal\Api\TemplateData $template_data )` Customized invoice data which is saved as template Customized invoice data which is saved as template Parameters `$template_data` Returns $this
`public PayPal\Api\TemplateData`	# `getTemplateData( )` Customized invoice data which is saved as template Customized invoice data which is saved as template Returns `PayPal\Api\TemplateData`
`public`	# `setSettings( PayPal\Api\TemplateSettings[] $settings )` Settings for each template Settings for each template Parameters `$settings` Returns $this
`public PayPal\Api\TemplateSettings[]`	# `getSettings( )` Settings for each template Settings for each template Returns `PayPal\Api\TemplateSettings[]`
`public`	# `addSetting( PayPal\Api\TemplateSettings $templateSettings )` Append Settings to the list. Append Settings to the list. Parameters `$templateSettings` Returns $this
`public`	# `removeSetting( PayPal\Api\TemplateSettings $templateSettings )` Remove Settings from the list. Remove Settings from the list. Parameters `$templateSettings` Returns $this
`public`	# `setUnitOfMeasure( string $unit_of_measure )` Unit of measure for the template, possible values are Quantity, Hours, Amount. Unit of measure for the template, possible values are Quantity, Hours, Amount. Parameters `$unit_of_measure` Returns $this
`public string`	# `getUnitOfMeasure( )` Unit of measure for the template, possible values are Quantity, Hours, Amount. Unit of measure for the template, possible values are Quantity, Hours, Amount. Returns string
`public`	# `setCustom( boolean $custom )` Indicates whether this is a custom template created by the merchant. Non custom templates are system generated Indicates whether this is a custom template created by the merchant. Non custom templates are system generated Parameters `$custom` Returns $this
`public boolean`	# `getCustom( )` Indicates whether this is a custom template created by the merchant. Non custom templates are system generated Indicates whether this is a custom template created by the merchant. Non custom templates are system generated Returns boolean
`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. 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`
`public boolean`	# `delete( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Delete a particular template by passing the template ID to the request URI. Delete a particular template by passing the template ID to the request URI. Parameters `$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 boolean
`public PayPal\Api\Template`	# `create( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Creates a template. Creates a template. Parameters `$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`
`public PayPal\Api\Template`	# `update( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Update an existing template by passing the template ID to the request URI. In addition, pass a complete template object in the request JSON. Partial updates are not supported. Update an existing template by passing the template ID to the request URI. In addition, pass a complete template object in the request JSON. Partial updates are not supported. Parameters `$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`

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

Namespaces

Classes

Class Template

Methods summary

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from PayPal\Common\PayPalResourceModel

Methods inherited from PayPal\Common\PayPalModel

Properties summary

Properties inherited from PayPal\Common\PayPalModel