Class WebProfile

Class WebProfile

Payment web experience profile resource

PayPal\Common\PayPalModel

Extended by

PayPal\Common\PayPalResourceModel implements PayPal\Rest\IResource

Extended by

PayPal\Api\WebProfile

Direct known subclasses

PayPal\Api\CreateProfileResponse

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

Methods summary

`public`	# `setId( string $id )` The unique ID of the web experience profile. The unique ID of the web experience profile. Parameters `$id` Returns $this
`public string`	# `getId( )` The unique ID of the web experience profile. The unique ID of the web experience profile. Returns string
`public`	# `setName( string $name )` The web experience profile name. Unique for a specified merchant's profiles. The web experience profile name. Unique for a specified merchant's profiles. Parameters `$name` Returns $this
`public string`	# `getName( )` The web experience profile name. Unique for a specified merchant's profiles. The web experience profile name. Unique for a specified merchant's profiles. Returns string
`public`	# `setTemporary( boolean $temporary )` Indicates whether the profile persists for three hours or permanently. Set to `false` to persist the profile permanently. Set to `true` to persist the profile for three hours. Indicates whether the profile persists for three hours or permanently. Set to `false` to persist the profile permanently. Set to `true` to persist the profile for three hours. Parameters `$temporary` Returns $this
`public boolean`	# `getTemporary( )` Indicates whether the profile persists for three hours or permanently. Set to `false` to persist the profile permanently. Set to `true` to persist the profile for three hours. Indicates whether the profile persists for three hours or permanently. Set to `false` to persist the profile permanently. Set to `true` to persist the profile for three hours. Returns boolean
`public`	# `setFlowConfig( PayPal\Api\FlowConfig $flow_config )` Parameters for flow configuration. Parameters for flow configuration. Parameters `$flow_config` Returns $this
`public PayPal\Api\FlowConfig`	# `getFlowConfig( )` Parameters for flow configuration. Parameters for flow configuration. Returns `PayPal\Api\FlowConfig`
`public`	# `setInputFields( PayPal\Api\InputFields $input_fields )` Parameters for input fields customization. Parameters for input fields customization. Parameters `$input_fields` Returns $this
`public PayPal\Api\InputFields`	# `getInputFields( )` Parameters for input fields customization. Parameters for input fields customization. Returns `PayPal\Api\InputFields`
`public`	# `setPresentation( PayPal\Api\Presentation $presentation )` Parameters for style and presentation. Parameters for style and presentation. Parameters `$presentation` Returns $this
`public PayPal\Api\Presentation`	# `getPresentation( )` Parameters for style and presentation. Parameters for style and presentation. Returns `PayPal\Api\Presentation`
`public PayPal\Api\CreateProfileResponse`	# `create( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Creates a web experience profile. Pass the profile name and details in the JSON request body. Creates a web experience profile. Pass the profile name and details in the JSON request body. 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\CreateProfileResponse`
`public boolean`	# `update( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Updates a web experience profile. Pass the ID of the profile to the request URI and pass the profile details in the JSON request body. If your request omits any profile detail fields, the operation removes the previously set values for those fields. Updates a web experience profile. Pass the ID of the profile to the request URI and pass the profile details in the JSON request body. If your request omits any profile detail fields, the operation removes the previously set values for those fields. 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 boolean`	# `partial_update( PayPal\Api\Patch[] $patch, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Partially-updates a web experience profile. Pass the profile ID to the request URI. Pass a patch object with the operation, path of the profile location to update, and, if needed, a new value to complete the operation in the JSON request body. Partially-updates a web experience profile. Pass the profile ID to the request URI. Pass a patch object with the operation, path of the profile location to update, and, if needed, a new value to complete the operation in the JSON request body. Parameters `$patch` `$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 static PayPal\Api\WebProfile`	# `get( string $profileId, PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Shows details for a web experience profile, by ID. Shows details for a web experience profile, by ID. Parameters `$profileId` `$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\WebProfile`
`public static PayPal\Api\WebProfile[]`	# `get_list( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Lists all web experience profiles for a merchant or subject. Lists all web experience profiles for a merchant or subject. 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\WebProfile[]`
`public boolean`	# `delete( PayPal\Rest\ApiContext $apiContext = null, PayPal\Transport\PayPalRestCall $restCall = null )` Deletes a web experience profile, by ID. Deletes a web experience profile, by ID. 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

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