Table of contents
Methods
Please be aware that ContextServiceClient
needs to have the correct (zone-specific) domain added to the allowlist. As this is not done by default.
Methods
ContextServiceClient
▸ Static
ContextServiceClient(config
): IFaaSContextServiceClient
Returns a Context Service Client which can be used to interact with the Context Session Store.
Parameters
Name | Type | Description |
---|---|---|
config |
IFaaSContextServiceClientConfig |
Config Object in which the account ID for which the Client will be used and a key for the Context Session Store API need to be provided |
Returns
ConversationUtil
▸ Static
ConversationUtil(): IConversationUtil
Returns a Conversation Util, which can be used to retrieve conversations and execute operations upon them.
Returns
GDPRUtil
▸ Static
GDPRUtil(): IGDPRUtil
Returns GDPR Util, which can be used for GDPR related functionality such as deleting files of a conversation.
Returns
HTTPClient
▸ Static
HTTPClient(): RequestAPI
Returns an HTTP CLient, that is configured to work with the proxy. It is based on request-promise and shares the same interface.
Returns
RequestAPI
___
LpClient
▸ Static
LpClient(): ILpClient
Returns a LivePerson (LP) Client which is a wrapper for the HTTP Client. It simplifies the usage of LivePerson APIs by providing automatic service discovery as well as taking care of the authorization.
Returns
MTLSClient
▸ Static
MTLSClient(clientTLS
): IMTLSClient
Returns an mTLS Client which is configured with the provided config. Please make sure that you set allowSelfSigned to true when calling an endpoint that relies on a self-signed cert. Another alternative would be to leverage the ca cert, that needs to be passed via the clientTLS config.
Parameters
Name | Type | Description |
---|---|---|
clientTLS |
ClientTLS |
Client Bundle consisting of cert + key and optionally the ca cert |
Returns
OrchestratorClient
▸ Static
OrchestratorClient(): IOrchestratorClient
Returns an OrchestratorClient which can be used to invoke other functions
Returns
SDEUtil
▸ Static
SDEUtil(): ISDEUtil
Returns a SDE Util, which can be used to add SDEs and other SDE related operations.
Returns
SFClient
▸ Static
SFClient(): Object
Returns an Salesforce Client, that is configured to work with the proxy.
Returns
Object
Name | Type |
---|---|
connectToSalesforce |
(params : IConnectionOptions ) => Connection
|
SecretClient
▸ Static
SecretClient(): ISecretClient
Returns a Secret Client, which is setup to allow read and update access to the secret storage of the Site ID.