wim-cache-client package
Classes
Class | Description |
|---|---|
Deleting entities to the general cache, requires one of the parameters: email or phone or clean | |
Allows to retrieve entities by id, use only in backend integrations | |
Adds entities to the general cache | |
searches for entities, unlike a GET request, allows you to specify more matching parameters | |
Searches for entities, unlike a POST request allows to specify additional parameters such as 'query', 'from', and 'size'. requires one of the parameters: query or email or phone | |
Allows to run target integration synchronization | |
Allows for batch updating the weight property of multiple entities | |
Base exception class for all service exceptions from WimCache service. |
Interfaces
Interface | Description |
|---|---|
The input for DeleteEntitiesFromGeneralCacheCommand. | |
The output of DeleteEntitiesFromGeneralCacheCommand. | |
The input for GetEntitiesByIdsCommand. | |
The output of GetEntitiesByIdsCommand. | |
The input for PutEntitiesToGeneralCacheCommand. | |
The output of PutEntitiesToGeneralCacheCommand. | |
The input for SearchEntitiesByListParamsCommand. | |
The output of SearchEntitiesByListParamsCommand. | |
The input for SearchEntitiesByParamsCommand. | |
The output of SearchEntitiesByParamsCommand. | |
The input for SyncCacheCommand. | |
The output of SyncCacheCommand. | |
The input for UpdateEntitiesWeightCommand. | |
The output of UpdateEntitiesWeightCommand. | |
The configuration interface of WimCacheClient class constructor that set the region, credentials and other options. | |
The resolved configuration interface of WimCacheClient class. This is resolved and normalized from the constructor configuration interface. |
Type Aliases
Type Alias | Description |
|---|---|