com.paypal.api.payments

Class WebProfile

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.WebProfile

Direct Known Subclasses:

CreateProfileResponse

public class WebProfile
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
WebProfile() Default Constructor
WebProfile(java.lang.String name) Parameterized Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
CreateProfileResponse	create(APIContext apiContext) Creates a web experience profile.
CreateProfileResponse	create(java.lang.String accessToken) Deprecated. Please use create(APIContext) instead.
void	delete(APIContext apiContext) Deletes a web experience profile, by ID.
void	delete(java.lang.String accessToken) Deprecated. Please use delete(APIContext) instead.
boolean	equals(java.lang.Object o)
static WebProfile	get(APIContext apiContext, java.lang.String profileId) Shows details for a web experience profile, by ID.
static WebProfile	get(java.lang.String accessToken, java.lang.String profileId) Deprecated. Please use get(APIContext, String) instead.
FlowConfig	getFlowConfig() Parameters for flow configuration.
java.lang.String	getId() The unique ID of the web experience profile.
InputFields	getInputFields() Parameters for input fields customization.
static java.util.List<WebProfile>	getList(APIContext apiContext) Lists all web experience profiles for a merchant or subject.
static java.util.List<WebProfile>	getList(java.lang.String accessToken) Deprecated. Please use getList(APIContext) instead.
java.lang.String	getName() The web experience profile name.
Presentation	getPresentation() Parameters for style and presentation.
java.lang.Boolean	getTemporary() Indicates whether the profile persists for three hours or permanently.
int	hashCode()
void	partialUpdate(APIContext apiContext, PatchRequest patchRequest) Partially-updates a web experience profile.
void	partialUpdate(java.lang.String accessToken, PatchRequest patchRequest) Deprecated. Please use partialUpdate(APIContext, PatchRequest) instead.
WebProfile	setFlowConfig(FlowConfig flowConfig) Parameters for flow configuration.
WebProfile	setId(java.lang.String id) The unique ID of the web experience profile.
WebProfile	setInputFields(InputFields inputFields) Parameters for input fields customization.
WebProfile	setName(java.lang.String name) The web experience profile name.
WebProfile	setPresentation(Presentation presentation) Parameters for style and presentation.
WebProfile	setTemporary(java.lang.Boolean temporary) Indicates whether the profile persists for three hours or permanently.
void	update(APIContext apiContext) Updates a web experience profile.
void	update(java.lang.String accessToken) Deprecated. Please use update(APIContext) instead.

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebProfile

public WebProfile()

Default Constructor

WebProfile

public WebProfile(java.lang.String name)

Parameterized Constructor

Method Detail

create

public CreateProfileResponse create(java.lang.String accessToken)
                             throws PayPalRESTException

Deprecated. Please use create(APIContext) instead.

Creates a web experience profile. Pass the profile name and details in the JSON request body.

Parameters:

accessToken - Access Token used for the API call.

Returns:

CreateProfileResponse

Throws:

PayPalRESTException

create

public CreateProfileResponse create(APIContext apiContext)
                             throws PayPalRESTException

Creates a web experience profile. Pass the profile name and details in the JSON request body.

Parameters:

apiContext - APIContext used for the API call.

Returns:

CreateProfileResponse

Throws:

PayPalRESTException

update

public void update(java.lang.String accessToken)
            throws PayPalRESTException

Deprecated. Please use update(APIContext) instead.

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:

accessToken - Access Token used for the API call.

Throws:

PayPalRESTException

update

public void update(APIContext apiContext)
            throws PayPalRESTException

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 - APIContext used for the API call.

Throws:

PayPalRESTException

partialUpdate

public void partialUpdate(java.lang.String accessToken,
                          PatchRequest patchRequest)
                   throws PayPalRESTException

Deprecated. Please use partialUpdate(APIContext, PatchRequest) instead.

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:

accessToken - Access Token used for the API call.

patchRequest - PatchRequest

Throws:

PayPalRESTException

partialUpdate

public void partialUpdate(APIContext apiContext,
                          PatchRequest patchRequest)
                   throws PayPalRESTException

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:

apiContext - APIContext used for the API call.

patchRequest - PatchRequest

Throws:

PayPalRESTException

get

public static WebProfile get(java.lang.String accessToken,
                             java.lang.String profileId)
                      throws PayPalRESTException

Deprecated. Please use get(APIContext, String) instead.

Shows details for a web experience profile, by ID.

Parameters:

accessToken - Access Token used for the API call.

profileId - String

Returns:

WebProfile

Throws:

PayPalRESTException

get

public static WebProfile get(APIContext apiContext,
                             java.lang.String profileId)
                      throws PayPalRESTException

Shows details for a web experience profile, by ID.

Parameters:

apiContext - APIContext used for the API call.

profileId - String

Returns:

WebProfile

Throws:

PayPalRESTException

getList

public static java.util.List<WebProfile> getList(java.lang.String accessToken)
                                          throws PayPalRESTException

Deprecated. Please use getList(APIContext) instead.

Lists all web experience profiles for a merchant or subject.

Parameters:

accessToken - Access Token used for the API call.

Returns:

WebProfileList

Throws:

PayPalRESTException

getList

public static java.util.List<WebProfile> getList(APIContext apiContext)
                                          throws PayPalRESTException

Lists all web experience profiles for a merchant or subject.

Parameters:

apiContext - APIContext used for the API call.

Returns:

WebProfileList

Throws:

PayPalRESTException

delete

public void delete(java.lang.String accessToken)
            throws PayPalRESTException

Deprecated. Please use delete(APIContext) instead.

Deletes a web experience profile, by ID.

Parameters:

accessToken - Access Token used for the API call.

Throws:

PayPalRESTException

delete

public void delete(APIContext apiContext)
            throws PayPalRESTException

Deletes a web experience profile, by ID.

Parameters:

apiContext - APIContext used for the API call.

Throws:

PayPalRESTException

getId

public java.lang.String getId()

The unique ID of the web experience profile.

getName

public java.lang.String getName()

The web experience profile name. Unique for a specified merchant's profiles.

getTemporary

public java.lang.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.

getFlowConfig

public FlowConfig getFlowConfig()

Parameters for flow configuration.

getInputFields

public InputFields getInputFields()

Parameters for input fields customization.

getPresentation

public Presentation getPresentation()

Parameters for style and presentation.

setId

public WebProfile setId(java.lang.String id)

The unique ID of the web experience profile.

Returns:

this

setName

public WebProfile setName(java.lang.String name)

The web experience profile name. Unique for a specified merchant's profiles.

Returns:

this

setTemporary

public WebProfile setTemporary(java.lang.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.

Returns:

this

setFlowConfig

public WebProfile setFlowConfig(FlowConfig flowConfig)

Parameters for flow configuration.

Returns:

this

setInputFields

public WebProfile setInputFields(InputFields inputFields)

Parameters for input fields customization.

Returns:

this

setPresentation

public WebProfile setPresentation(Presentation presentation)

Parameters for style and presentation.

Returns:

this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class PayPalModel

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class PayPalModel

hashCode

public int hashCode()

Overrides:

hashCode in class PayPalModel