@deepdesk/deepdesk-sdk 19.6.2-beta.0 → 19.6.2-beta.2

package/dist/index.d.mts

@@ -2806,6 +2806,28 @@ declare class DeepdeskSDK {
      * ```
      */
     getAgentSettings<T = unknown>(): Promise<T>;
+    /**
+     * Retrieves the currently logged-in agent's own Deepdesk profile.
+     *
+     * This is the agent's Deepdesk-side identity, including the display name
+     * (`nickname`) they configured in Studio under Profile settings. Platform
+     * integrations should prefer this `nickname` over any name supplied by the
+     * host platform (e.g. Genesys Cloud, LiveEngage) when populating
+     * `agentNickname` via `setAgentInfo`, since the agent's Deepdesk profile
+     * setting is the one they explicitly chose to expose to customers.
+     *
+     * @returns Promise that resolves to the agent's Deepdesk profile
+     *
+     * @example
+     * ```typescript
+     * const me = await sdk.getMe();
+     * await sdk.setAgentInfo({
+     *   agentId: platformAgent.id,
+     *   agentNickname: me.nickname || platformAgent.name,
+     * });
+     * ```
+     */
+    getMe(): Promise<CamelCaseKeys<Server.Me>>;
     /**
      * Refreshes suggestions based on the current conversation.
      *

package/dist/index.d.ts

@@ -2806,6 +2806,28 @@ declare class DeepdeskSDK {
      * ```
      */
     getAgentSettings<T = unknown>(): Promise<T>;
+    /**
+     * Retrieves the currently logged-in agent's own Deepdesk profile.
+     *
+     * This is the agent's Deepdesk-side identity, including the display name
+     * (`nickname`) they configured in Studio under Profile settings. Platform
+     * integrations should prefer this `nickname` over any name supplied by the
+     * host platform (e.g. Genesys Cloud, LiveEngage) when populating
+     * `agentNickname` via `setAgentInfo`, since the agent's Deepdesk profile
+     * setting is the one they explicitly chose to expose to customers.
+     *
+     * @returns Promise that resolves to the agent's Deepdesk profile
+     *
+     * @example
+     * ```typescript
+     * const me = await sdk.getMe();
+     * await sdk.setAgentInfo({
+     *   agentId: platformAgent.id,
+     *   agentNickname: me.nickname || platformAgent.name,
+     * });
+     * ```
+     */
+    getMe(): Promise<CamelCaseKeys<Server.Me>>;
     /**
      * Refreshes suggestions based on the current conversation.
      *