Class PickupService

Class representing a set of pickup-related functionality.

Inheritance

System.Object

EasyPostService

PickupService

Implements

IEasyPostService

IDisposable

Inherited Members

EasyPostService.Client

EasyPostService.RequestAsync<T>(Method, String, CancellationToken, Nullable<Dictionary<String, Object>>, Nullable<String>, ApiVersion)

EasyPostService.RequestAsync(Method, String, CancellationToken, Nullable<Dictionary<String, Object>>, ApiVersion)

EasyPostService.Dispose()

EasyPostService.Dispose(Boolean)

Namespace: EasyPost.Services

Assembly: EasyPost.dll

Syntax

public class PickupService : EasyPostService, IEasyPostService

Methods

All(All, CancellationToken)

List all Pickup objects. Related API documentation.

Declaration

public async Task<PickupCollection> All(All parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
All	parameters	The parameters to filter the list of Pickup objects by.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<PickupCollection>	An PickupCollection object.

All(Nullable<Dictionary<String, Object>>, CancellationToken)

List all Pickup objects. Related API documentation.

Declaration

public async Task<PickupCollection> All(Dictionary<string, object>? parameters = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<Dictionary<System.String, System.Object>>	parameters	The parameters to filter the list of Pickup objects by.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<PickupCollection>	An PickupCollection object.

Buy(String, Buy, CancellationToken)

Purchase a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Buy(string id, Buy parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	The ID of the Pickup to purchase.
Buy	parameters	The parameters to purchase the Pickup with.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	An updated Pickup instance.

Buy(String, String, String, CancellationToken)

Purchase a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Buy(string id, string withCarrier, string withService, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	The ID of the Pickup to purchase.
System.String	withCarrier	The name of the carrier to purchase the Pickup with.
System.String	withService	The name of the service to purchase the Pickup with.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	An updated Pickup instance.

Cancel(String, CancellationToken)

Cancel a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Cancel(string id, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	The ID of the Pickup to cancel.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	An updated Pickup instance.

Create(Dictionary<String, Object>, CancellationToken)

Create a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Create(Dictionary<string, object> parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Dictionary<System.String, System.Object>	parameters	Data to use to create the Pickup.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	A Pickup object.

Create(Create, CancellationToken)

Create a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Create(Create parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Create	parameters	Data to use to create the Pickup.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	A Pickup object.

GetNextPage(PickupCollection, Nullable<Int32>, CancellationToken)

Get the next page of a paginated PickupCollection. Related API documentation.

Declaration

public async Task<PickupCollection> GetNextPage(PickupCollection collection, int? pageSize = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PickupCollection	collection	The PickupCollection to get the next page of.
System.Nullable<System.Int32>	pageSize	The size of the next page.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<PickupCollection>	The next page, as a PickupCollection instance.

Exceptions

Type	Condition
EndOfPaginationError	Thrown if there is no next page to retrieve.

Retrieve(String, CancellationToken)

Retrieve a Pickup. Related API documentation.

Declaration

public async Task<Pickup> Retrieve(string id, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	The ID of the Pickup to retrieve.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<Pickup>	A Pickup object.

Implements

IEasyPostService

IDisposable