Interface IAnybillClientStoreModule
Module of the IAnybillClient for working with stores.
Namespace: anybill.POS.Client.Modules
Assembly: anybill.POS.Client.Abstractions.dll
Syntax
public interface IAnybillClientStoreModule
Methods
DeleteStoreAsync(String, CancellationToken)
Delete store
Declaration
Task<IDeleteStoreResponse> DeleteStoreAsync(string storeId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | storeId | Id of the store. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<IDeleteStoreResponse> | Deletes the store with the given id. |
GetStoreByIdAsync(String, CancellationToken)
Get store
Declaration
Task<IStoreResponse> GetStoreByIdAsync(string storeId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | storeId | Id of the store. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<IStoreResponse> | return the store with the given id. |
GetStoreHistoryAsync(String, CancellationToken)
Get store history
Declaration
Task<IReadOnlyCollection<IStoreHistoryResponse>> GetStoreHistoryAsync(string storeId, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | storeId | Id of the store. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IStoreHistoryResponse>> | returns the history of the store with the given id. |
GetStoresAsync(Int32, Int32, CancellationToken)
Get all stores
Declaration
Task<IReadOnlyCollection<IStoreResponse>> GetStoresAsync(int skip, int take, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | skip | Elements to skip for pagination. |
System.Int32 | take | How much elements to take for pagination. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IStoreResponse>> | Returns an array of all existing stores. |
UpSertStoreAsync(UpSertStore, CancellationToken)
UpSert store
Declaration
Task<IStoreResponse> UpSertStoreAsync(UpSertStore upSertStore, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
UpSertStore | upSertStore | The available data for the store. |
System.Threading.CancellationToken | cancellationToken | The cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<IStoreResponse> | Creates or updates a store. The valid from datetime will be set to the current timestamp if null or in the past. |