Package com.mercadopago.client.preapproval

Class PreapprovalClient

java.lang.Object

com.mercadopago.client.MercadoPagoClient

com.mercadopago.client.preapproval.PreapprovalClient

public class PreapprovalClient
extends MercadoPagoClient

Client that use the Preapproval APIs.

Field Summary

Fields inherited from class com.mercadopago.client.MercadoPagoClient

defaultHeaders, httpClient

Constructor Summary

Constructors

Constructor	Description
PreapprovalClient()	Default constructor.
PreapprovalClient(MPHttpClient httpClient)	Constructor used for providing a custom http client.

Method Summary

Modifier and Type	Method	Description
Preapproval	create(PreapprovalCreateRequest request)	Creates a Preapproval.
Preapproval	create(PreapprovalCreateRequest request, MPRequestOptions requestOptions)	Creates a Preapproval.
Preapproval	get(String id)	Get a Preapproval by your ID.
Preapproval	get(String id, MPRequestOptions requestOptions)	Get a Preapproval by your ID.
MPResultsResourcesPage<Preapproval>	search(MPSearchRequest request)	Method responsible for search preapprovals.
MPResultsResourcesPage<Preapproval>	search(MPSearchRequest request, MPRequestOptions requestOptions)	Method responsible for search preapprovals.
Preapproval	update(String id, PreapprovalUpdateRequest request)	Updates a Preapproval.
Preapproval	update(String id, PreapprovalUpdateRequest request, MPRequestOptions requestOptions)	Updates a Preapproval.

Methods inherited from class com.mercadopago.client.MercadoPagoClient

list, list, search, search, send, send, send, send

Methods inherited from class java.lang.Object

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

Constructor Detail

PreapprovalClient

public PreapprovalClient()

Default constructor. Uses the default http client used by the SDK.

PreapprovalClient

public PreapprovalClient(MPHttpClient httpClient)

Constructor used for providing a custom http client.

Parameters:

httpClient - httpClient

Method Detail

get

public Preapproval get(String id)
                throws MPException,
                       MPApiException

Get a Preapproval by your ID.

Parameters:

id - preapproval id.

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

get

public Preapproval get(String id,
                       MPRequestOptions requestOptions)
                throws MPException,
                       MPApiException

Get a Preapproval by your ID.

Parameters:

id - preapprovalId.

requestOptions - metadata to customize the request

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

create

public Preapproval create(PreapprovalCreateRequest request)
                   throws MPException,
                          MPApiException

Creates a Preapproval.

Parameters:

request - attributes used to create a preapproval

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

create

public Preapproval create(PreapprovalCreateRequest request,
                          MPRequestOptions requestOptions)
                   throws MPException,
                          MPApiException

Creates a Preapproval.

Parameters:

request - attributes used to create a preapproval

requestOptions - metadata to customize the request

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

update

public Preapproval update(String id,
                          PreapprovalUpdateRequest request)
                   throws MPException,
                          MPApiException

Updates a Preapproval.

Parameters:

id - preapprovalId

request - attributes used for the update

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

update

public Preapproval update(String id,
                          PreapprovalUpdateRequest request,
                          MPRequestOptions requestOptions)
                   throws MPException,
                          MPApiException

Updates a Preapproval.

Parameters:

id - preapprovalId

request - attributes used for the update

requestOptions - metadata to customize the request

Returns:

Preapproval pre approval information

Throws:

MPException - an error if the request fails

MPApiException

search

public MPResultsResourcesPage<Preapproval> search(MPSearchRequest request)
                                           throws MPException,
                                                  MPApiException

Method responsible for search preapprovals.

Parameters:

request - attributes used for the search

Returns:

list of results

Throws:

MPException - an error if the request fails

MPApiException

search

public MPResultsResourcesPage<Preapproval> search(MPSearchRequest request,
                                                  MPRequestOptions requestOptions)
                                           throws MPException,
                                                  MPApiException

Method responsible for search preapprovals.

Parameters:

request - attributes used for the search

requestOptions - metadata to customize the request

Returns:

list of results

Throws:

MPException - an error if the request fails

MPApiException