diff --git a/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.init.md b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.init.md index 5090391..d83cabd 100644 --- a/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.init.md +++ b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.init.md @@ -20,5 +20,5 @@ init(messageResponse: MessageResponse): Promise> diff --git a/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.reinitializesession.md b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.reinitializesession.md index a246324..eeae624 100644 --- a/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.reinitializesession.md +++ b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesk.reinitializesession.md @@ -16,7 +16,7 @@ reinitializeSession(credentials: ChatCoreZendeskSessionCredentials): Promise + +[Home](./index.md) > [@yext/chat-core-zendesk](./chat-core-zendesk.md) > [ChatCoreZendeskSessionCredentials](./chat-core-zendesk.chatcorezendesksessioncredentials.md) > [conversationId](./chat-core-zendesk.chatcorezendesksessioncredentials.conversationid.md) + +## ChatCoreZendeskSessionCredentials.conversationId property + +The conversation ID for the current chat session. + +**Signature:** + +```typescript +conversationId: string; +``` diff --git a/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesksessioncredentials.md b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesksessioncredentials.md new file mode 100644 index 0000000..ecaa78d --- /dev/null +++ b/packages/chat-core-zendesk/docs/chat-core-zendesk.chatcorezendesksessioncredentials.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/chat-core-zendesk](./chat-core-zendesk.md) > [ChatCoreZendeskSessionCredentials](./chat-core-zendesk.chatcorezendesksessioncredentials.md) + +## ChatCoreZendeskSessionCredentials interface + +Credentials for the Zendesk session created by the [ChatCoreZendesk](./chat-core-zendesk.chatcorezendesk.md). Used for reinitializing the session across page reloads. + +**Signature:** + +```typescript +export interface ChatCoreZendeskSessionCredentials +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [conversationId](./chat-core-zendesk.chatcorezendesksessioncredentials.conversationid.md) | | string | The conversation ID for the current chat session. | + diff --git a/packages/chat-core-zendesk/docs/chat-core-zendesk.md b/packages/chat-core-zendesk/docs/chat-core-zendesk.md index 9787d76..41cf1aa 100644 --- a/packages/chat-core-zendesk/docs/chat-core-zendesk.md +++ b/packages/chat-core-zendesk/docs/chat-core-zendesk.md @@ -16,4 +16,5 @@ | --- | --- | | [ChatCoreZendesk](./chat-core-zendesk.chatcorezendesk.md) | Provides methods for interacting with Chat's Zendesk integration. | | [ChatCoreZendeskConfig](./chat-core-zendesk.chatcorezendeskconfig.md) | Configuration for this instance of the [ChatCoreZendesk](./chat-core-zendesk.chatcorezendesk.md). | +| [ChatCoreZendeskSessionCredentials](./chat-core-zendesk.chatcorezendesksessioncredentials.md) | Credentials for the Zendesk session created by the [ChatCoreZendesk](./chat-core-zendesk.chatcorezendesk.md). Used for reinitializing the session across page reloads. | diff --git a/packages/chat-core-zendesk/etc/chat-core-zendesk.api.md b/packages/chat-core-zendesk/etc/chat-core-zendesk.api.md index 85c3f02..128cae0 100644 --- a/packages/chat-core-zendesk/etc/chat-core-zendesk.api.md +++ b/packages/chat-core-zendesk/etc/chat-core-zendesk.api.md @@ -13,7 +13,6 @@ import { MessageResponse } from '@yext/chat-core'; export interface ChatCoreZendesk { emit(eventName: T, data: EventMap[T]): void; getSession(): string | undefined; - // Warning: (ae-forgotten-export) The symbol "ChatCoreZendeskSessionCredentials" needs to be exported by the entry point index.d.ts init(messageResponse: MessageResponse): Promise; // Warning: (ae-forgotten-export) The symbol "EventMap" needs to be exported by the entry point index.d.ts // Warning: (ae-forgotten-export) The symbol "EventCallback" needs to be exported by the entry point index.d.ts @@ -29,6 +28,11 @@ export interface ChatCoreZendeskConfig { ticketTags?: string[]; } +// @public +export interface ChatCoreZendeskSessionCredentials { + conversationId: string; +} + // Warning: (ae-forgotten-export) The symbol "ChatCoreZendeskImpl" needs to be exported by the entry point index.d.ts // // @public diff --git a/packages/chat-core-zendesk/src/models/index.ts b/packages/chat-core-zendesk/src/models/index.ts index 0767bba..6ac772a 100644 --- a/packages/chat-core-zendesk/src/models/index.ts +++ b/packages/chat-core-zendesk/src/models/index.ts @@ -1,2 +1,3 @@ export { ChatCoreZendeskConfig } from "./ChatCoreZendeskConfig"; export { ChatCoreZendesk } from "./ChatCoreZendesk"; +export { ChatCoreZendeskSessionCredentials } from "./ChatCoreZendeskSessionCredentials";