Class PreapprovalClient

Client that use the Preapproval APIs.

Inheritance

object

MercadoPagoClient<Preapproval>

PreapprovalClient

Inherited Members

MercadoPagoClient<Preapproval>.HttpClient

MercadoPagoClient<Preapproval>.Serializer

MercadoPagoClient<Preapproval>.DefaultHeaders

MercadoPagoClient<Preapproval>.SendAsync(string, HttpMethod, object, RequestOptions, CancellationToken)

MercadoPagoClient<Preapproval>.Send(string, HttpMethod, object, RequestOptions)

MercadoPagoClient<Preapproval>.ListAsync(string, HttpMethod, object, RequestOptions, CancellationToken)

MercadoPagoClient<Preapproval>.List(string, HttpMethod, object, RequestOptions)

MercadoPagoClient<Preapproval>.SearchAsync<TPageResult>(string, SearchRequest, RequestOptions, CancellationToken)

MercadoPagoClient<Preapproval>.Search<TPageResult>(string, SearchRequest, RequestOptions)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: MercadoPago.Client.Preapproval

Assembly: MercadoPago.dll

Syntax

public class PreapprovalClient : MercadoPagoClient<Preapproval>

Constructors

| Edit this page View Source

PreapprovalClient()

Initializes a new instance of the PreapprovalClient class.

Declaration

public PreapprovalClient()

| Edit this page View Source

PreapprovalClient(IHttpClient)

Initializes a new instance of the PreapprovalClient class.

Declaration

public PreapprovalClient(IHttpClient httpClient)

Parameters

Type	Name	Description
IHttpClient	httpClient	The http client that will be used in HTTP requests.

| Edit this page View Source

PreapprovalClient(IHttpClient, ISerializer)

Initializes a new instance of the PreapprovalClient class.

Declaration

public PreapprovalClient(IHttpClient httpClient, ISerializer serializer)

Parameters

Type	Name	Description
IHttpClient	httpClient	The http client that will be used in HTTP requests.
ISerializer	serializer	The serializer that will be used to serialize the HTTP requests content and to deserialize the HTTP response content.

| Edit this page View Source

PreapprovalClient(ISerializer)

Initializes a new instance of the PreapprovalClient class.

Declaration

public PreapprovalClient(ISerializer serializer)

Parameters

Type	Name	Description
ISerializer	serializer	The serializer that will be used to serialize the HTTP requests content and to deserialize the HTTP response content.

Methods

| Edit this page View Source

Create(PreapprovalCreateRequest, RequestOptions)

Creates a Preapproval.

Declaration

public Preapproval Create(PreapprovalCreateRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
PreapprovalCreateRequest	request	The data to create a Preapproval.
RequestOptions	requestOptions	RequestOptions

Returns

Type	Description
Preapproval	The created Preapproval.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

CreateAsync(PreapprovalCreateRequest, RequestOptions, CancellationToken)

Creates a Preapproval as an asynchronous operation.

Declaration

public Task<Preapproval> CreateAsync(PreapprovalCreateRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PreapprovalCreateRequest	request	The data to create a Preapproval.
RequestOptions	requestOptions	RequestOptions
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Preapproval>	A task whose the result is the created Preapproval.

Remarks

Check the API documentation here.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Get(string, RequestOptions)

Get a Preapproval by your ID.

Declaration

public Preapproval Get(string id, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The Preapproval ID.
RequestOptions	requestOptions	RequestOptions

Returns

Type	Description
Preapproval	The Preapproval.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

GetAsync(string, RequestOptions, CancellationToken)

Get async a Preapproval by your ID.

Declaration

public Task<Preapproval> GetAsync(string id, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The Preapproval ID.
RequestOptions	requestOptions	RequestOptions
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Preapproval>	A task whose the result is the Preapproval.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Search(SearchRequest, RequestOptions)

Searches for Preapprovals that match the criteria of AdvancedSearchRequest.

Declaration

public ResultsResourcesPage<Preapproval> Search(SearchRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
SearchRequest	request	The search request parameters.
RequestOptions	requestOptions	RequestOptions.

Returns

Type	Description
ResultsResourcesPage<Preapproval>	A page of Preapprovals.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

SearchAsync(SearchRequest, RequestOptions, CancellationToken)

Searches async for Preapprovals that match the criteria of AdvancedSearchRequest.

Declaration

public Task<ResultsResourcesPage<Preapproval>> SearchAsync(SearchRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SearchRequest	request	The search request parameters.
RequestOptions	requestOptions	RequestOptions.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<ResultsResourcesPage<Preapproval>>	A task whose the result is a page of Preapprovals.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

Update(string, PreapprovalUpdateRequest, RequestOptions)

Updates a Preapproval. Just send in request the properties you want to update.

Declaration

public Preapproval Update(string id, PreapprovalUpdateRequest request, RequestOptions requestOptions = null)

Parameters

Type	Name	Description
string	id	The Preapproval ID.
PreapprovalUpdateRequest	request	The data to update the Preapproval.
RequestOptions	requestOptions	RequestOptions

Returns

Type	Description
Preapproval	The updated Preapproval.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.

| Edit this page View Source

UpdateAsync(string, PreapprovalUpdateRequest, RequestOptions, CancellationToken)

Updates a Preapproval as an asynchronous operation. Just send in request the properties you want to update.

Declaration

public Task<Preapproval> UpdateAsync(string id, PreapprovalUpdateRequest request, RequestOptions requestOptions = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	id	The Preapproval ID.
PreapprovalUpdateRequest	request	The data to update the Preapproval.
RequestOptions	requestOptions	RequestOptions
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<Preapproval>	A task whose the result is the updated Preapproval.

Exceptions

Type	Condition
MercadoPagoException	If a unexpected exception occurs.
MercadoPagoApiException	If the API returns a error.