Skip to main content

@wildix/wim-cache-client

wim-cache-client package

Classes

Class

Description

DeleteEntitiesFromGeneralCacheCommand

Deleting entities to the general cache, requires one of the parameters: email or phone or clean

DeleteIntegrationDataCommand

Deletes integration data by id with optional filters

ForbiddenException

GetEntitiesByIdsCommand

Allows to retrieve entities by id, use only in backend integrations

GetIntegrationDataCommand

Retrieves integration data by id with optional filters

PutEntitiesToGeneralCacheCommand

Adds entities to the general cache

PutIntegrationDataCommand

Upsert operation for storing untyped integration data in the cache

SearchEntitiesByListParamsCommand

searches for entities, unlike a GET request, allows you to specify more matching parameters

SearchEntitiesByParamsCommand

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

SyncCacheCommand

Allows to run target integration synchronization

UpdateEntitiesWeightCommand

Allows for batch updating the weight property of multiple entities

ValidationException

WimCache

WimCacheClient

WimCacheServiceException

Base exception class for all service exceptions from WimCache service.

Interfaces

Interface

Description

ClientDefaults

DeleteEntitiesFromGeneralCacheCommandInput

The input for DeleteEntitiesFromGeneralCacheCommand.

DeleteEntitiesFromGeneralCacheCommandOutput

The output of DeleteEntitiesFromGeneralCacheCommand.

DeleteEntitiesFromGeneralCacheInput

DeleteEntitiesFromGeneralCacheOutput

DeleteIntegrationDataCommandInput

The input for DeleteIntegrationDataCommand.

DeleteIntegrationDataCommandOutput

The output of DeleteIntegrationDataCommand.

DeleteIntegrationDataInput

DeleteIntegrationDataOutput

Entity

EntityData

GeneralEntityInputData

GetEntitiesByIdsCommandInput

The input for GetEntitiesByIdsCommand.

GetEntitiesByIdsCommandOutput

The output of GetEntitiesByIdsCommand.

GetEntitiesByIdsInput

GetEntitiesByIdsOutput

GetIntegrationDataCommandInput

The input for GetIntegrationDataCommand.

GetIntegrationDataCommandOutput

The output of GetIntegrationDataCommand.

GetIntegrationDataInput

GetIntegrationDataOutput

IntegrationDataItem

PutEntitiesToGeneralCacheCommandInput

The input for PutEntitiesToGeneralCacheCommand.

PutEntitiesToGeneralCacheCommandOutput

The output of PutEntitiesToGeneralCacheCommand.

PutEntitiesToGeneralCacheInput

PutEntitiesToGeneralCacheOutput

PutIntegrationDataCommandInput

The input for PutIntegrationDataCommand.

PutIntegrationDataCommandOutput

The output of PutIntegrationDataCommand.

PutIntegrationDataInput

PutIntegrationDataOutput

RuntimeExtension

SalesforceAttrubuteField

SearchEntitiesByListParamsCommandInput

The input for SearchEntitiesByListParamsCommand.

SearchEntitiesByListParamsCommandOutput

The output of SearchEntitiesByListParamsCommand.

SearchEntitiesByListParamsInput

SearchEntitiesByListParamsOutput

SearchEntitiesByParamsCommandInput

The input for SearchEntitiesByParamsCommand.

SearchEntitiesByParamsCommandOutput

The output of SearchEntitiesByParamsCommand.

SearchEntitiesByParamsInput

SearchEntitiesByParamsOutput

SearchPostParams

SearchResult

SyncCacheCommandInput

The input for SyncCacheCommand.

SyncCacheCommandOutput

The output of SyncCacheCommand.

SyncCacheInput

SyncCacheOutput

UpdateEntitiesWeightCommandInput

The input for UpdateEntitiesWeightCommand.

UpdateEntitiesWeightCommandOutput

The output of UpdateEntitiesWeightCommand.

UpdateEntitiesWeightInput

UpdateEntitiesWeightOutput

WimCache

WimCacheClientConfig

The configuration interface of WimCacheClient class constructor that set the region, credentials and other options.

WimCacheClientResolvedConfig

The resolved configuration interface of WimCacheClient class. This is resolved and normalized from the constructor configuration interface.

Type Aliases

Type Alias

Description

ServiceInputTypes

ServiceOutputTypes

WimCacheClientConfigType

WimCacheClientResolvedConfigType