com.braintreegateway

Class CustomerGateway

java.lang.Object

com.braintreegateway.CustomerGateway

public class CustomerGateway
extends Object

Provides methods to create, delete, find, and update Customer objects. This class does not need to be instantiated directly. Instead, use BraintreeGateway.customer() to get an instance of this class:

 BraintreeGateway gateway = new BraintreeGateway(...);
 gateway.customer().create(...)
 

For more detailed information on Customers, see https://developers.braintreepayments.com/reference/response/customer/java

Constructor Summary

Constructors

Constructor and Description
CustomerGateway(Http http, Configuration configuration)

Method Summary

Modifier and Type	Method and Description
ResourceCollection<Customer>	all() Finds all Customers and returns a ResourceCollection.
Result<Customer>	confirmTransparentRedirect(String queryString) Deprecated. see TransparentRedirectGateway#confirmCustomer(String)
Result<Customer>	create(CustomerRequest request) Creates a Customer.
Result<Customer>	delete(String id) Deletes a Customer by id.
Customer	find(String id) Finds a Customer by id.
Customer	find(String id, String associationFilterId) Finds a Customer by id.
ResourceCollection<Customer>	search(CustomerSearchRequest query) Finds all Transactions that match the query and returns a ResourceCollection.
String	transparentRedirectURLForCreate() Deprecated. see TransparentRedirectGateway#url()
String	transparentRedirectURLForUpdate() Deprecated. see TransparentRedirectGateway#url()
Result<Customer>	update(String id, CustomerRequest request) Updates a Customer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomerGateway

public CustomerGateway(Http http,
                       Configuration configuration)

Method Detail

all

public ResourceCollection<Customer> all()

Finds all Customers and returns a ResourceCollection.

Returns:

a ResourceCollection.

confirmTransparentRedirect

@Deprecated
public Result<Customer> confirmTransparentRedirect(String queryString)

Deprecated. see TransparentRedirectGateway#confirmCustomer(String)

Please use gateway.transparentRedirect().confirmCustomer() instead

Parameters:

queryString - the query string

Returns:

a customer

create

public Result<Customer> create(CustomerRequest request)

Creates a Customer.

Parameters:

request - the request.

Returns:

a Result.

delete

public Result<Customer> delete(String id)

Deletes a Customer by id.

Parameters:

id - the id of the Customer.

Returns:

a Result.

find

public Customer find(String id)

Finds a Customer by id.

Parameters:

id - the id of the Customer.

Returns:

the Customer or raises a NotFoundException.

find

public Customer find(String id,
                     String associationFilterId)

Finds a Customer by id.

Parameters:

id - the id of the Customer.

associationFilterId - the id of the association filter to use.

Returns:

the Customer or raises a NotFoundException.

search

public ResourceCollection<Customer> search(CustomerSearchRequest query)

Finds all Transactions that match the query and returns a ResourceCollection. See: https://developers.braintreepayments.com/reference/request/transaction/search/java

Parameters:

query - the request query to use for search

Returns:

a ResourceCollection.

transparentRedirectURLForCreate

@Deprecated
public String transparentRedirectURLForCreate()

Deprecated. see TransparentRedirectGateway#url()

Please use gateway.transparentRedirect().url() instead

Returns:

the redirect URL for create

transparentRedirectURLForUpdate

@Deprecated
public String transparentRedirectURLForUpdate()

Deprecated. see TransparentRedirectGateway#url()

Please use gateway.transparentRedirect().url() instead

Returns:

the redirect URL for update

update

public Result<Customer> update(String id,
                               CustomerRequest request)

Updates a Customer.

Parameters:

id - the id of the Customer.

request - the request.

Returns:

a Result.