Class ReportService

Class representing a set of report-related functionality.

Inheritance

System.Object

EasyPostService

ReportService

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

Methods

All(All, CancellationToken)

List all Reports. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
All	parameters	Parameters to filter the list of Reports on.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<ReportCollection>	A ReportCollection instance.

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

List all Reports. Related API documentation.

Declaration

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

Parameters

Type	Name	Description
System.String	type	The type of Reports to list.
System.Nullable<Dictionary<System.String, System.Object>>	parameters	Parameters to filter the list of Reports on.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<ReportCollection>	A ReportCollection instance.

Create(Create, CancellationToken)

Create a Report. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<Report>	A Report objects.

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

Create a Report. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<Report>	A Report objects.

GetNextPage(ReportCollection, Nullable<Int32>, CancellationToken)

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

Declaration

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

Parameters

Type	Name	Description
ReportCollection	collection	The ReportCollection 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<ReportCollection>	The next page, as a ReportCollection instance.

Exceptions

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

Retrieve(String, CancellationToken)

Retrieve a Report. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<Report>	The requested Report.

Retrieve(String, String, CancellationToken)

Retrieve a Report. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<Report>	The requested Report.

Implements

IEasyPostService

IDisposable