Class EndShipperService

Class representing a set of EndShipper-related functionality.

Inheritance

System.Object

EasyPostService

EndShipperService

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 EndShipperService : EasyPostService, IEasyPostService

Methods

All(All, CancellationToken)

List all EndShippers. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
All	parameters	All parameter set.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<EndShipperCollection>	A EndShipperCollection instance.

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

List all EndShippers. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
System.Nullable<Dictionary<System.String, System.Object>>	parameters	A dictionary containing parameters to filter the list with. See All for valid keys.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<EndShipperCollection>	A EndShipperCollection instance.

Create(Dictionary<String, Object>, CancellationToken)

Create an EndShipper. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<EndShipper>	An EndShipper object.

Create(Create, CancellationToken)

Create an EndShipper. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<EndShipper>	An EndShipper object.

Retrieve(String, CancellationToken)

Retrieve an EndShipper. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<EndShipper>	The EndShipper.

Update(String, Dictionary<String, Object>, CancellationToken)

Update an EndShipper. Related API documentation.

Declaration

public async Task<EndShipper> Update(string id, Dictionary<string, object> parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	ID of the EndShipper to update.
Dictionary<System.String, System.Object>	parameters	Data to update EndShipper with.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<EndShipper>	The updated EndShipper.

Update(String, Update, CancellationToken)

Update an EndShipper. Related API documentation.

Declaration

public async Task<EndShipper> Update(string id, Update parameters, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	ID of the EndShipper to update.
Update	parameters	Data to update EndShipper with.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<EndShipper>	The updated EndShipper.

Implements

IEasyPostService

IDisposable