Class ScanFormService

Class representing a set of scan form-related functionality.

Inheritance

System.Object

EasyPostService

ScanFormService

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

Methods

All(All, CancellationToken)

List all ScanForms. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<ScanFormCollection>	A ScanFormCollection instance.

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

List all ScanForms. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<ScanFormCollection>	A ScanFormCollection instance.

Create(Create, CancellationToken)

Create a ScanForm. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<ScanForm>	A ScanForm objects.

Create(List<Shipment>, CancellationToken)

Create a ScanForm. Related API documentation.

Declaration

public async Task<ScanForm> Create(List<Shipment> shipments, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
List<Shipment>	shipments	Shipments to create a ScanForm for.
CancellationToken	cancellationToken	to use for the HTTP request.

Returns

Type	Description
Task<ScanForm>	A ScanForm objects.

GetNextPage(ScanFormCollection, Nullable<Int32>, CancellationToken)

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

Declaration

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

Parameters

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

Exceptions

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

Retrieve(String, CancellationToken)

Retrieve a ScanForm. Related API documentation.

Declaration

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

Parameters

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

Returns

Type	Description
Task<ScanForm>	The requested ScanForm.

Implements

IEasyPostService

IDisposable