Interface IWhenFreshApiClient

An interface representing the WhenFresh Api client that describes all supported methods for interaction with the WhenFresh Api.

Namespace: WhenFresh.Api.Client
Assembly: WhenFresh.Api.Client.dll
Syntax
public interface IWhenFreshApiClient

Methods

FindAddressesAsync(FindAddressesByPostcodeRequest, CancellationToken)

Finds PostalAddress Resources for a given Postcode.

Declaration
Task<FindAddressResponse> FindAddressesAsync(FindAddressesByPostcodeRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
FindAddressesByPostcodeRequest request
CancellationToken cancellationToken
Returns
Type Description
Task<FindAddressResponse>

GetAddressAsync(GetAddressRequest, CancellationToken)

Gets a PostalAddress Resource for a given PostalAddressFileKey.

Declaration
Task<GetAddressResponse> GetAddressAsync(GetAddressRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetAddressRequest request
CancellationToken cancellationToken
Returns
Type Description
Task<GetAddressResponse>

GetResourceCatalogAsync(GetResourceCatalogRequest, CancellationToken)

Gets a ResourceCatalog Resource for a given ResourceCatalogId.

Declaration
Task<GetResourceCatalogResponse> GetResourceCatalogAsync(GetResourceCatalogRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GetResourceCatalogRequest request
CancellationToken cancellationToken
Returns
Type Description
Task<GetResourceCatalogResponse>

PurchaseVariablesAsync(PurchaseVariablesRequest, CancellationToken)

Purchases Variables from a ResourceCatalog for a given ResourceCatalogId.

Declaration
Task<PurchaseVariablesResponse> PurchaseVariablesAsync(PurchaseVariablesRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PurchaseVariablesRequest request
CancellationToken cancellationToken
Returns
Type Description
Task<PurchaseVariablesResponse>

Extension Methods