Class CarrierAccountService

Class representing a set of carrier account-related functionality.

Inheritance

System.Object

EasyPostService

CarrierAccountService

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

Methods

All(CancellationToken)

List all available CarrierAccounts. Related API documentation.

Declaration

public async Task<List<CarrierAccount>> All(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<List<CarrierAccount>>	A list of CarrierAccounts.

Create(Dictionary<String, Object>, CancellationToken)

Create a CarrierAccount. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<CarrierAccount>	A CarrierAccount object.

Create(ACreate, CancellationToken)

Create a CarrierAccount. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
ACreate	parameters	Data to use to create the CarrierAccount.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<CarrierAccount>	A CarrierAccount object.

Delete(String, CancellationToken)

Delete a CarrierAccount. Related API documentation.

Declaration

public async Task Delete(string id, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	id	ID of the CarrierAccount to delete.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task	None.

Retrieve(String, CancellationToken)

Retrieve a CarrierAccount. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
System.String	id	String representing a carrier account. Starts with "ca_".
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<CarrierAccount>	The retrieved CarrierAccount.

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

Update a CarrierAccount. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<CarrierAccount>	The updated CarrierAccount.

Update(String, AUpdate, CancellationToken)

Update a CarrierAccount. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<CarrierAccount>	The updated CarrierAccount.

Implements

IEasyPostService

IDisposable