Class WhenFreshApiClient

A class representing the WhenFresh Api client that implements all supported methods for interaction with the WhenFresh Api.

Inheritance
object
WhenFreshApiClient
Implements
Inherited Members
Namespace: WhenFresh.Api.Client
Assembly: WhenFresh.Api.Client.dll
Syntax
public class WhenFreshApiClient : IWhenFreshApiClient

Constructors

WhenFreshApiClient(Action<WhenFreshApiClientOptions>)

Initializes a new instance of the WhenFreshApiClient class.

Declaration
public WhenFreshApiClient(Action<WhenFreshApiClientOptions> configuration = null)
Parameters
Type Name Description
Action<WhenFreshApiClientOptions> configuration

Optional configuration

Properties

Internal

A class representing the WhenFresh Api client that implements all supported methods for interaction with the WhenFresh Api.

Declaration
public WhenFreshApiClientInternals Internal { get; }
Property Value
Type Description
WhenFreshApiClientInternals

Methods

FindAddressesAsync(FindAddressesByPostcodeRequest, CancellationToken)

Finds PostalAddress Resources for a given Postcode.

Declaration
public 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
public 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
public 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
public Task<PurchaseVariablesResponse> PurchaseVariablesAsync(PurchaseVariablesRequest request, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PurchaseVariablesRequest request
CancellationToken cancellationToken
Returns
Type Description
Task<PurchaseVariablesResponse>

Implements

Extension Methods