Interface IAnybillClientStoreModule

Namespace

anybill.POS.Client.Modules

Assembly

anybill.POS.Client.Abstractions.dll

Module of the IAnybillClient for working with stores.

public interface IAnybillClientStoreModule

Methods

DeleteStoreAsync(string, CancellationToken)

Delete store

Task<IDeleteStoreResponse> DeleteStoreAsync(string storeId, CancellationToken cancellationToken = default)

Parameters

storeId string

Id of the store.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IDeleteStoreResponse>

Deletes the store with the given id.

GetStoreByIdAsync(string, CancellationToken)

Get store

Task<IStoreResponse> GetStoreByIdAsync(string storeId, CancellationToken cancellationToken = default)

Parameters

storeId string

Id of the store.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IStoreResponse>

return the store with the given id.

GetStoresAsync(int, int, CancellationToken)

Get all stores

Task<IReadOnlyCollection<IStoreResponse>> GetStoresAsync(int skip, int take, CancellationToken cancellationToken = default)

Parameters

skip int

Elements to skip for pagination.

take int

How much elements to take for pagination.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IReadOnlyCollection<IStoreResponse>>

Returns an array of all existing stores.

UpSertStoreAsync(UpSertStore, CancellationToken)

UpSert store

Task<IStoreResponse> UpSertStoreAsync(UpSertStore upSertStore, CancellationToken cancellationToken = default)

Parameters

upSertStore UpSertStore

The available data for the store.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<IStoreResponse>

Creates or updates a store. The valid from datetime will be set to the current timestamp if null or in the past.