Table of contents

Methods

Methods

ContextServiceClient

Please be aware that ContextServiceClient needs to have the correct (zone-specific) domain added to the allowlist. As this is not done by default.

▸ 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

IFaaSContextServiceClient

ConversationUtil

▸ Static ConversationUtil(): IConversationUtil

Returns a Conversation Util, which can be used to retrieve conversations and execute operations upon them.

Returns

IConversationUtil

GDPRUtil

▸ Static GDPRUtil(): IGDPRUtil

Returns GDPR Util, which can be used for GDPR related functionality such as deleting files of a conversation.

Returns

IGDPRUtil

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

ILpClient

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

IMTLSClient

LPMtlsClient

▸ Static LPMtlsClient(clientTLS): ILPMtlsClient

Returns a Client for the LP mTLS Service, please be aware that you need to perform the onboarding before being able to leverage the client. It will use the provided OAuth2 App Installation credentials to obtain an access token and use that for communication with sentinel. Errors related to LP mTLS or Upstream failing will be thrown as MTLSError and can be differentiated using the MTLSError.code property.

Parameters

Name Type Description
config IOAuth2ClientCreds OAuth2 Client Credentials created during App Installation

Returns

ILPMtlsClient

OrchestratorClient

▸ Static OrchestratorClient(): IOrchestratorClient

Returns an OrchestratorClient which can be used to invoke other functions

Returns

IOrchestratorClient

SDEUtil

▸ Static SDEUtil(): ISDEUtil

Returns a SDE Util, which can be used to add SDEs and other SDE related operations.

Returns

ISDEUtil

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.

Returns

ISecretClient