Class PartnerUserClient

Partner User API client for OAuth-authenticated user endpoints.

Provides access to meetings, action items, calendar events, and user profile for the authenticated user. Requires an OAuth access token.

Example

const { oauth, user } = ContioPartnerSDK.forUser({
  clientId: 'your-client-id',
  clientSecret: 'your-client-secret',
  redirectUri: 'https://your-app.com/callback'
});

// After OAuth flow completes
const meetings = await user.getMeetings({ limit: 10 });

Hierarchy (View Summary)

BaseClient
- PartnerUserClient

Index

Constructors

constructor

new PartnerUserClient(
oauthClient: OAuthClient,
config?: ClientConfig,
): PartnerUserClient
Create a new PartnerUserClient instance.
Parameters
- oauthClient: OAuthClient
  Configured OAuthClient with access token
- Optionalconfig: ClientConfig
  Optional client configuration (baseURL, timeout, etc.)
Returns PartnerUserClient
Overrides BaseClient.constructor
- Defined in src/client/user/index.ts:107

Properties

`Protected`axiosInstance

axiosInstance: AxiosInstance

`Protected`config

config: ClientConfig

Methods

`Protected`addAuthHeaders

addAuthHeaders(
config: InternalAxiosRequestConfig,
): Promise<InternalAxiosRequestConfig<any>>
Internal
Add authorization headers, automatically refreshing the token if expired.
Parameters
- config: InternalAxiosRequestConfig
Returns Promise<InternalAxiosRequestConfig<any>>
Overrides BaseClient.addAuthHeaders
- Defined in src/client/user/index.ts:133

addMeetingParticipant

addMeetingParticipant(
    meetingId: string,
    data: { email: string; name: string; role: "EDITOR" | "VIEWER" },
    options?: RequestOptions,
): Promise<MeetingParticipant>
Add a participant to a meeting.
Parameters
- meetingId: string
  The meeting ID to add the participant to
- data: { email: string; name: string; role: "EDITOR" | "VIEWER" }
  Participant data including email, name, and role
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<MeetingParticipant>
The newly added participant

Throws
If the meeting is not found or participant already exists
- Defined in src/client/user/index.ts:275

`Protected`buildRequestConfig

buildRequestConfig(
options?: RequestOptions,
baseConfig?: AxiosRequestConfig<any>,
): AxiosRequestConfig
Build axios config with optional per-request timezone override
Parameters
- Optionaloptions: RequestOptions
- OptionalbaseConfig: AxiosRequestConfig<any>
Returns AxiosRequestConfig
Inherited from BaseClient.buildRequestConfig
- Defined in src/client/base.ts:128

createActionItem

createActionItem(
data: CreateActionItemRequest,
options?: RequestOptions,
): Promise<ActionItem>
Create a new action item.
Parameters
- data: CreateActionItemRequest
  Action item creation data
  - Optionaldescription?: string
  - Optionaldue_date?: string
  - meeting_id: string
  - Optionalpartner_context?: Record<string, unknown>
  - Optionalstatus?: ActionItemStatus
  - title: string
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ActionItem>
The newly created action item
Throws
If validation fails
Example
```
const item = await user.createActionItem({
  meeting_id: 'meeting-456',
  title: 'Follow up with client',
  due_date: '2026-01-25T17:00:00Z',
  status: 'needs_review'
});
```
- Defined in src/client/user/index.ts:576

createAgendaItem

createAgendaItem(
    meetingId: string,
    data: CreateAgendaItemRequest,
    options?: RequestOptions,
): Promise<AgendaItem>
Create a new agenda item for a meeting.
Parameters
- meetingId: string
  The meeting ID to add the agenda item to
- data: CreateAgendaItemRequest
  Agenda item creation data
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<AgendaItem>
The newly created agenda item
Throws
If the meeting is not found or validation fails
Example
```
const item = await user.createAgendaItem('meeting-id', {
  title: 'Review Q1 metrics',
  description: 'Discuss performance trends',
});
```
- Defined in src/client/user/index.ts:324

createChatSession

createChatSession(
data: CreateChatSessionRequest,
options?: RequestOptions,
): Promise<ChatSession>
Create a new chat session and submit the first user message.

The agent begins processing immediately. The response includes the session and the initial user turn as current_turn. Listen for a session.turn.completed webhook to know when the agent response is ready, then call getSession to retrieve it.

Requires the chat:write OAuth scope.
Parameters
- data: CreateChatSessionRequest
  Session creation data including the meeting ID and opening message
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ChatSession>
The newly created session with current_turn populated
Throws
If validation fails or the meeting is not found
Example
```
const session = await user.createChatSession({
  meeting_id: 'meeting-uuid',
  message: 'Summarize the key decisions from this meeting.',
  metadata: { partner_ref: 'crm-case-4821' },
});
console.log('Session created:', session.id);
```
- Defined in src/client/user/index.ts:958

createMeeting

createMeeting(
data: CreateMeetingRequest,
options?: RequestOptions,
): Promise<Meeting>
Create a new meeting.
Parameters
- data: CreateMeetingRequest
  Meeting creation data
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<Meeting>
The newly created meeting
Throws
If validation fails
Example
```
const meeting = await user.createMeeting({
  title: 'Weekly Standup',
  scheduled_start: '2026-01-20T10:00:00Z',
});
```
- Defined in src/client/user/index.ts:233

createMeetingFromCalendarEvent

createMeetingFromCalendarEvent(
calendarEventId: string,
options?: RequestOptions,
): Promise<CreateMeetingFromCalendarEventResponse>
Create a new meeting from a calendar event.

Automatically populates meeting details from the calendar event including title, time, and participants.
Parameters
- calendarEventId: string
  The calendar event ID to create a meeting from
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<CreateMeetingFromCalendarEventResponse>
The newly created meeting linked to the calendar event
Throws
If the calendar event is not found
Example
```
const result = await user.createMeetingFromCalendarEvent('cal-event-123');
console.log('Created meeting:', result.meeting?.id);
```
- Defined in src/client/user/index.ts:738
createMeetingFromCalendarEvent(
data: CreateMeetingFromCalendarEventRequest,
options?: RequestOptions,
): Promise<CreateMeetingFromCalendarEventResponse>
Parameters
- data: CreateMeetingFromCalendarEventRequest
- Optionaloptions: RequestOptions
Returns Promise<CreateMeetingFromCalendarEventResponse>
Deprecated
Pass the calendar event ID as a string instead of a request object. Use createMeetingFromCalendarEvent('cal-event-123') instead of createMeetingFromCalendarEvent({ calendar_event_id: 'cal-event-123' }). This overload will be removed in the next major version.
- Defined in src/client/user/index.ts:745

`Protected`delete

delete<T>(path: string, options?: RequestOptions): Promise<T>
Make a DELETE request
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: RequestOptions
Returns Promise<T>
Inherited from BaseClient.delete
- Defined in src/client/base.ts:188

deleteActionItem

deleteActionItem(actionItemId: string, options?: RequestOptions): Promise<void>
Delete an action item.
Parameters
- actionItemId: string
  The unique action item ID to delete
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<void>
Throws
If the action item is not found or deletion is denied
- Defined in src/client/user/index.ts:608

deleteAgendaItem

deleteAgendaItem(
    meetingId: string,
    itemId: string,
    options?: RequestOptions,
): Promise<void>
Delete an agenda item.
Parameters
- meetingId: string
  The meeting ID the agenda item belongs to
- itemId: string
  The agenda item ID to delete
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<void>
Throws
If the item is not found
- Defined in src/client/user/index.ts:350

deleteMeetingContextDocument

deleteMeetingContextDocument(
    meetingId: string,
    documentId: string,
    options?: RequestOptions,
): Promise<void>
Delete a context document from a meeting.

This performs a soft-delete — the document's deleted_at timestamp is set and it will no longer appear in list results or be available for download.
Parameters
- meetingId: string
  The meeting ID the document belongs to (UUID format)
- documentId: string
  The context document ID to delete (UUID format)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<void>
Throws
If the document is not found or deletion is denied
Example
```
await user.deleteMeetingContextDocument('meeting-id', 'doc-id');
```
- Defined in src/client/user/index.ts:887

downloadMeetingContextDocumentContent

downloadMeetingContextDocumentContent(
    meetingId: string,
    documentId: string,
    options?: RequestOptions,
): Promise<MeetingContextContentResponse>
Download the raw content of a context document.

Returns the file bytes along with metadata extracted from the response headers (filename, content type, size). The data field is an ArrayBuffer that can be written to disk, converted to a Buffer, or processed in-memory.
Parameters
- meetingId: string
  The meeting ID the document belongs to (UUID format)
- documentId: string
  The context document ID to download (UUID format)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingContextContentResponse>
Structured response containing the file bytes and metadata
Throws
If the document is not found or access is denied
Example
```
import { writeFile } from 'node:fs/promises';

const content = await user.downloadMeetingContextDocumentContent(
  'meeting-id',
  'doc-id',
);
console.log(`Downloading ${content.filename} (${content.size} bytes)`);
await writeFile(content.filename ?? 'download.bin', Buffer.from(content.data));
```
- Defined in src/client/user/index.ts:921

ensureValidToken

ensureValidToken(): Promise<void>
Ensure the OAuth access token is valid, refreshing if necessary.

Call this before making API requests if you want to proactively refresh expired tokens rather than handling refresh on error.

Returns Promise<void>
Throws
If token refresh fails
Example
```
// Proactively refresh before a batch of operations
await user.ensureValidToken();
const meetings = await user.getMeetings();
const items = await user.getActionItems();
```
- Defined in src/client/user/index.ts:1212

executeNextStep

executeNextStep(
    meetingId: string,
    nextStepId: string,
    data?: ExecuteNextStepRequest,
    options?: RequestOptions,
): Promise<ExecuteNextStepResponse>
Execute a next step for a meeting.

Triggers the AI-powered execution of a next step, which may generate content based on the meeting transcript and the step's AI prompt.
Parameters
- meetingId: string
  The meeting ID
- nextStepId: string
  The next step ID to execute
- Optionaldata: ExecuteNextStepRequest
  Optional execution parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<ExecuteNextStepResponse>
Execution response with result ID for tracking
Throws
If the meeting or next step is not found
Example
```
const result = await user.executeNextStep('meeting-uuid', 'step-uuid');
console.log(`Execution started: ${result.result_id}`);

// Poll for result
const finalResult = await user.getNextStepResult(result.result_id);
console.log(finalResult.content);
```
- Defined in src/client/user/index.ts:409

`Protected`get

get<T>(path: string, params?: object, options?: RequestOptions): Promise<T>
Make a GET request
Type Parameters
- T
Parameters
- path: string
- Optionalparams: object
- Optionaloptions: RequestOptions
Returns Promise<T>
Inherited from BaseClient.get
- Defined in src/client/base.ts:144

getActionItem

getActionItem(
actionItemId: string,
options?: RequestOptions,
): Promise<ActionItem>
Get a specific action item by ID.
Parameters
- actionItemId: string
  The unique action item ID (UUID format)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ActionItem>
The action item with full details

Throws
If the action item is not found or access is denied
- Defined in src/client/user/index.ts:548

getActionItems

getActionItems(
params?: ActionItemListParams,
options?: RequestOptions,
): Promise<ActionItemListResponse>
Get a paginated list of action items for the authenticated user.
Parameters
- Optionalparams: ActionItemListParams
  Optional pagination and filter parameters
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<ActionItemListResponse>
Paginated action item list with total count
Throws
If the request fails
Example
```
// Get all incomplete action items
const items = await user.getActionItems({ is_completed: false });

// Get action items for a specific meeting
const meetingItems = await user.getActionItems({ meeting_id: 'meeting-uuid' });

// Get action items within a date range
const recent = await user.getActionItems({
  start_date: '2026-01-01',
  end_date: '2026-01-31',
});
```
- Defined in src/client/user/index.ts:511

getAllActionItems

getAllActionItems(
params?: Omit<ActionItemListParams, "limit" | "offset">,
options?: RequestOptions,
): Promise<ActionItem[]>
Get all action items by automatically paginating through all pages.

Use this when you need to fetch all action items without manually handling pagination. For large datasets, consider using getActionItems() with pagination for better control.
Parameters
- Optionalparams: Omit<ActionItemListParams, "limit" | "offset">
  Optional filter parameters (limit/offset are managed automatically)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<ActionItem[]>
Array of all action items matching the filter criteria
Throws
If any request fails
Example
```
// Get all incomplete action items
const allItems = await user.getAllActionItems({ is_completed: false });
console.log(`${allItems.length} items need attention`);

// Get all action items for a meeting
const meetingItems = await user.getAllActionItems({ meeting_id: 'meeting-uuid' });
```
- Defined in src/client/user/index.ts:536

getAllCalendarEvents

getAllCalendarEvents(
params: Omit<CalendarEventListParams, "limit" | "offset">,
options?: RequestOptions,
): Promise<CalendarEvent[]>
Get all calendar events within a date range by automatically paginating through all pages.
Parameters
- params: Omit<CalendarEventListParams, "limit" | "offset">
  Required date range, optional direction (limit/offset managed automatically)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<CalendarEvent[]>
Array of all calendar events within the date range
Throws
If calendar is not connected or request fails
Example
```
const allEvents = await user.getAllCalendarEvents({
  start_date: '2026-01-01T00:00:00Z',
  end_date: '2026-01-31T23:59:59Z'
});
console.log(`Found ${allEvents.length} events`);
```
- Defined in src/client/user/index.ts:684

getAllMeetingContextDocuments

getAllMeetingContextDocuments(
meetingId: string,
options?: RequestOptions,
): Promise<MeetingContextDocument[]>
Get all context documents for a meeting by automatically paginating through all pages.
Parameters
- meetingId: string
  The meeting ID to list context documents for (UUID format)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingContextDocument[]>
Array of all context documents for the meeting
Throws
If any page request fails
Example
```
const allDocs = await user.getAllMeetingContextDocuments('meeting-id');
console.log(`Total: ${allDocs.length} context documents`);
```
- Defined in src/client/user/index.ts:802

getAllMeetings

getAllMeetings(
params?: Omit<MeetingListParams, "limit" | "offset">,
options?: RequestOptions,
): Promise<Meeting[]>
Get all meetings by automatically paginating through all pages.
Parameters
- Optionalparams: Omit<MeetingListParams, "limit" | "offset">
  Optional filter parameters (limit/offset are managed automatically)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<Meeting[]>
Array of all meetings matching the filter criteria
Throws
If any request fails
Example
```
const allMeetings = await user.getAllMeetings();
console.log(`${allMeetings.length} total meetings`);
```
- Defined in src/client/user/index.ts:191

getCalendarEvent

getCalendarEvent(
calendarEventId: string,
options?: RequestOptions,
): Promise<CalendarEventDetail>
Get detailed information about a specific calendar event.
Parameters
- calendarEventId: string
  The calendar event ID to retrieve
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<CalendarEventDetail>
Complete calendar event details
Throws
If the event is not found or user doesn't have access
Example
```
const event = await user.getCalendarEvent('cal-event-123');
console.log(`Event: ${event.title}`);
console.log(`Organizer: ${event.organizer?.email}`);
```
- Defined in src/client/user/index.ts:703

getCalendarEvents

getCalendarEvents(
params: CalendarEventListParams,
options?: RequestOptions,
): Promise<CalendarEventListResponse>
Get calendar events for the authenticated user within a time range.

Requires the user to have connected their calendar via OAuth.
Parameters
- params: CalendarEventListParams
  Filter parameters
  - Optionaldirection?: string
    Sort direction: asc or desc (default: asc)
  - Optionalend?: string
    End time in RFC3339 format
    
    Deprecated
    Use end_date instead. Will be removed in the next major version.
  - Optionalend_date?: string
    End date/time in ISO 8601 format (preferred over end)
  - Optionallimit?: number
    Number of results per page (default 25, max 100)
  - Optionaloffset?: number
    Pagination offset (default 0)
  - Optionalstart?: string
    Start time in RFC3339 format
    
    Deprecated
    Use start_date instead. Will be removed in the next major version.
  - Optionalstart_date?: string
    Start date/time in ISO 8601 format (preferred over start)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<CalendarEventListResponse>
List of calendar events within the specified range
Throws
If calendar is not connected or request fails
Example
```
const events = await user.getCalendarEvents({
  start_date: '2026-01-20T00:00:00Z',
  end_date: '2026-01-27T23:59:59Z'
});
```
- Defined in src/client/user/index.ts:663

getChatSession

getChatSession(
    sessionId: string,
    params?: GetChatSessionParams,
    options?: RequestOptions,
): Promise<ChatSession>
Get a specific chat session by ID, including its turns.

By default returns only turns not yet seen by the caller (include: 'undelivered'). Pass include: 'all_turns' to retrieve the full conversation history.

Requires the chat:read OAuth scope.
Parameters
- sessionId: string
  The unique session ID (UUID format)
- Optionalparams: GetChatSessionParams
  Optional query parameters (include, turn_limit, turn_offset)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ChatSession>
The session with its turns
Throws
If the session is not found
Example
```
// Fetch full conversation history after receiving a webhook
const session = await user.getChatSession('session-uuid', { include: 'all_turns' });
for (const turn of session.turns?.items ?? []) {
  console.log(`[${turn.role}] ${turn.content}`);
}
```
- Defined in src/client/user/index.ts:1005

getChatSessions

getChatSessions(
params?: ChatSessionListParams,
options?: RequestOptions,
): Promise<ChatSessionListResponse>
Get a paginated list of chat sessions for the authenticated user.

Requires the chat:read OAuth scope.
Parameters
- Optionalparams: ChatSessionListParams
  Optional filter and pagination parameters
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ChatSessionListResponse>
Paginated session list with total count
Throws
If the request fails
Example
```
const response = await user.getChatSessions({ meeting_id: 'meeting-uuid' });
console.log(`Found ${response.total} sessions`);
```
- Defined in src/client/user/index.ts:978

getChatTurn

getChatTurn(
    sessionId: string,
    turnId: string,
    options?: RequestOptions,
): Promise<ChatTurn>
Retrieve a specific turn by ID within a session.

This is useful when a turn_id is received via webhook and the partner wants to fetch only that turn instead of the full session history.

Requires the chat:read OAuth scope.
Parameters
- sessionId: string
  The session ID that contains the turn
- turnId: string
  The turn ID to retrieve
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ChatTurn>
The requested turn with full details
Throws
If the session or turn is not found
Example
```
// Fetch a specific turn after receiving a webhook with turn_id
const turn = await user.getChatTurn('session-uuid', 'turn-uuid');
console.log(`[${turn.role}] ${turn.content}`);
```
- Defined in src/client/user/index.ts:1057

getMeeting

getMeeting(meetingId: string, options?: RequestOptions): Promise<Meeting>
Get a specific meeting by ID.

Automatically follows smart-redirect references (CON-1640) — if the meeting has been merged or moved, the response from the canonical meeting is returned transparently.
Parameters
- meetingId: string
  The unique meeting ID (UUID format)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<Meeting>
The meeting with full details
Throws
If the meeting is not found or access is denied
Example
```
const meeting = await user.getMeeting('meeting-uuid');
console.log(meeting.title);
```
- Defined in src/client/user/index.ts:213

getMeetingActionButtons

getMeetingActionButtons(
    meetingId: string,
    params?: MeetingActionButtonListParams,
    options?: RequestOptions,
): Promise<MeetingActionButtonListResponse>
Get action buttons available for a meeting.

Returns action buttons that can be triggered for the meeting, typically associated with next steps.
Parameters
- meetingId: string
  The meeting ID
- Optionalparams: MeetingActionButtonListParams
  Optional pagination parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<MeetingActionButtonListResponse>
Paginated list of action buttons

Throws
If the meeting is not found
- Defined in src/client/user/index.ts:446

getMeetingAgendaItems

getMeetingAgendaItems(
meetingId: string,
options?: RequestOptions,
): Promise<AgendaItemListResponse>
Get agenda items for a specific meeting.
Parameters
- meetingId: string
  The meeting ID to get agenda items for
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<AgendaItemListResponse>
List of agenda items for the meeting

Throws
If the meeting is not found
- Defined in src/client/user/index.ts:303

getMeetingContextDocument

getMeetingContextDocument(
    meetingId: string,
    documentId: string,
    options?: RequestOptions,
): Promise<MeetingContextDocument>
Get a specific context document by ID.
Parameters
- meetingId: string
  The meeting ID the document belongs to (UUID format)
- documentId: string
  The context document ID to retrieve (UUID format)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingContextDocument>
The context document with full metadata
Throws
If the document is not found or access is denied
Example
```
const doc = await user.getMeetingContextDocument('meeting-id', 'doc-id');
console.log(`${doc.title} — format: ${doc.source_format}`);
```
- Defined in src/client/user/index.ts:824

getMeetingContextDocuments

getMeetingContextDocuments(
    meetingId: string,
    params?: MeetingContextListParams,
    options?: RequestOptions,
): Promise<MeetingContextListResponse>
Get a paginated list of context documents for a meeting.

Returns only documents uploaded by the current partner application — documents created by other partners or by users directly are not visible.
Parameters
- meetingId: string
  The meeting ID to list context documents for (UUID format)
- Optionalparams: MeetingContextListParams
  Optional pagination parameters
  
  Pagination parameters for listing meeting context documents.
  - Optionallimit?: number
    Maximum number of documents to return (default: 25, max: 100)
  - Optionaloffset?: number
    Number of documents to skip for pagination (default: 0)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingContextListResponse>
Paginated list of context documents with total count
Throws
If the request fails
Example
```
const response = await user.getMeetingContextDocuments('meeting-id', {
  limit: 10,
});
console.log(`Found ${response.total} context documents`);
for (const doc of response.items) {
  console.log(`${doc.title} (${doc.source_format})`);
}
```
- Defined in src/client/user/index.ts:779

getMeetingNextSteps

getMeetingNextSteps(
    meetingId: string,
    params?: MeetingNextStepListParams,
    options?: RequestOptions,
): Promise<MeetingNextStepListResponse>
Get next steps for a specific meeting.

Returns the next steps associated with the meeting, including any available action buttons for each next step.
Parameters
- meetingId: string
  The meeting ID
- Optionalparams: MeetingNextStepListParams
  Optional pagination parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<MeetingNextStepListResponse>
Paginated list of next steps
Throws
If the meeting is not found
Example
```
const nextSteps = await user.getMeetingNextSteps('meeting-uuid');
for (const step of nextSteps.items) {
  console.log(`${step.name}: ${step.action_buttons?.length ?? 0} buttons`);
}
```
- Defined in src/client/user/index.ts:378

getMeetingParticipants

getMeetingParticipants(
meetingId: string,
options?: RequestOptions,
): Promise<MeetingParticipantListResponse>
Get participants for a specific meeting.
Parameters
- meetingId: string
  The meeting ID to get participants for
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<MeetingParticipantListResponse>
List of meeting participants with their roles

Throws
If the meeting is not found
- Defined in src/client/user/index.ts:262

getMeetings

getMeetings(
params?: MeetingListParams,
options?: RequestOptions,
): Promise<MeetingListResponse>
Get a paginated list of meetings for the authenticated user.
Parameters
- Optionalparams: MeetingListParams
  Optional pagination and filter parameters
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingListResponse>
Paginated meeting list with total count
Throws
If the request fails
Example
```
const response = await user.getMeetings({ limit: 10 });
console.log(`Found ${response.total} meetings`);
```
- Defined in src/client/user/index.ts:173

getMeetingTemplate

getMeetingTemplate(
templateId: string,
options?: RequestOptions,
): Promise<UserMeetingTemplate>
Get a specific meeting template.
Parameters
- templateId: string
  The unique template ID
- Optionaloptions: RequestOptions
  Request options
Returns Promise<UserMeetingTemplate>
The meeting template with full details

Throws
If the template is not found
- Defined in src/client/user/index.ts:1185

getMeetingTemplates

getMeetingTemplates(
params?: UserMeetingTemplateListParams,
options?: RequestOptions,
): Promise<UserMeetingTemplateListResponse>
Get meeting templates available to the user.

Returns templates that the user can use to create meetings, including associated next steps and action buttons.
Parameters
- Optionalparams: UserMeetingTemplateListParams
  Optional pagination parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<UserMeetingTemplateListResponse>
Paginated list of meeting templates
Throws
If the request fails
Example
```
const templates = await user.getMeetingTemplates({ limit: 10 });
for (const t of templates.items) {
  console.log(`${t.name}: ${t.next_steps?.length ?? 0} next steps`);
}
```
- Defined in src/client/user/index.ts:1170

getNextStepResult

getNextStepResult(
resultId: string,
options?: RequestOptions,
): Promise<NextStepResult>
Get the result of a next step execution.
Parameters
- resultId: string
  The result ID from executeNextStep
- Optionaloptions: RequestOptions
  Request options
Returns Promise<NextStepResult>
The next step execution result

Throws
If the result is not found
- Defined in src/client/user/index.ts:426

`Protected`getRaw

getRaw(
    path: string,
    params?: object,
    options?: RequestOptions,
    responseType?: "arraybuffer" | "blob" | "stream",
): Promise<AxiosResponse<any, any, {}>>
Make a GET request that returns the full AxiosResponse, including headers and raw data.

Use this for endpoints that return binary content (e.g. file downloads) where the caller needs access to response headers such as Content-Disposition or Content-Type.
Parameters
- path: string
  Request path relative to the client's base URL
- Optionalparams: object
  Optional query parameters
- Optionaloptions: RequestOptions
  Optional per-request options (e.g. timezone override)
- responseType: "arraybuffer" | "blob" | "stream" = 'arraybuffer'
  Axios response type (default: 'arraybuffer')
Returns Promise<AxiosResponse<any, any, {}>>
The full axios response
Inherited from BaseClient.getRaw
- Defined in src/client/base.ts:231

getToolkit

getToolkit(
toolkitId: string,
options?: RequestOptions,
): Promise<ToolkitWithInstallation>
Get a specific toolkit with installation status.
Parameters
- toolkitId: string
  The unique toolkit ID
- Optionaloptions: RequestOptions
  Request options
Returns Promise<ToolkitWithInstallation>
The toolkit with installation status

Throws
If the toolkit is not found
- Defined in src/client/user/index.ts:1099

getToolkits

getToolkits(
params?: ToolkitListParams,
options?: RequestOptions,
): Promise<ToolkitWithInstallationListResponse>
Get available toolkits with installation status.

Returns toolkits that are active and available to install, along with installation status for the user's workspace.
Parameters
- Optionalparams: ToolkitListParams
  Optional pagination parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<ToolkitWithInstallationListResponse>
Paginated list of toolkits with installation status
Throws
If the request fails
Example
```
const toolkits = await user.getToolkits({ limit: 10 });
for (const t of toolkits.items) {
  console.log(`${t.toolkit.name}: ${t.installation ? 'installed' : 'not installed'}`);
}
```
- Defined in src/client/user/index.ts:1084

getUserProfile

getUserProfile(options?: RequestOptions): Promise<UserProfile>
Get the authenticated user's profile.
Parameters
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<UserProfile>
The user's profile including name, email, and preferences
Throws
If the request fails
Example
```
const profile = await user.getUserProfile();
console.log(`Logged in as ${profile.name} (${profile.email})`);
```
- Defined in src/client/user/index.ts:630

installToolkit

installToolkit(
    toolkitId: string,
    params?: InstallToolkitParams,
    options?: RequestOptions,
): Promise<ToolkitInstallation>
Install a toolkit in the user's workspace.

Creates all toolkit entities (templates, next steps, action buttons) in the user's workspace based on the toolkit manifest.
Parameters
- toolkitId: string
  The unique toolkit ID to install
- Optionalparams: InstallToolkitParams
- Optionaloptions: RequestOptions
  Request options
Returns Promise<ToolkitInstallation>
The installation record
Throws
If the toolkit is not found or already installed
Example
```
const installation = await user.installToolkit('toolkit-uuid');
console.log(`Installed at ${installation.installed_at}`);
```
- Defined in src/client/user/index.ts:1120

linkCalendarEvent

linkCalendarEvent(
    meetingId: string,
    data: LinkCalendarEventRequest,
    options?: RequestOptions,
): Promise<LinkCalendarEventResponse>
Link a calendar event to an existing meeting.
Parameters
- meetingId: string
  The meeting ID to link to
- data: LinkCalendarEventRequest
  Calendar event linking data
  - calendar_event_id: string
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<LinkCalendarEventResponse>
Confirmation of the link with event details

Throws
If the meeting or event is not found
- Defined in src/client/user/index.ts:717

`Protected`patch

patch<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>
Make a PATCH request
Type Parameters
- T
Parameters
- path: string
- Optionaldata: unknown
- Optionaloptions: RequestOptions
Returns Promise<T>
Inherited from BaseClient.patch
- Defined in src/client/base.ts:177

`Protected`post

post<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>
Make a POST request
Type Parameters
- T
Parameters
- path: string
- Optionaldata: unknown
- Optionaloptions: RequestOptions
Returns Promise<T>
Inherited from BaseClient.post
- Defined in src/client/base.ts:155

`Protected`postForm

postForm<T>(
    path: string,
    formData: FormData,
    options?: RequestOptions,
): Promise<T>
Make a POST request with multipart/form-data.

Overrides the default application/json content type so that axios sets the correct multipart/form-data boundary automatically.
Type Parameters
- T
Parameters
- path: string
  Request path relative to the client's base URL
- formData: FormData
  A FormData instance containing the fields and files to upload
- Optionaloptions: RequestOptions
  Optional per-request options (e.g. timezone override)
Returns Promise<T>
Parsed response body
Inherited from BaseClient.postForm
- Defined in src/client/base.ts:207

`Protected`put

put<T>(path: string, data?: unknown, options?: RequestOptions): Promise<T>
Make a PUT request
Type Parameters
- T
Parameters
- path: string
- Optionaldata: unknown
- Optionaloptions: RequestOptions
Returns Promise<T>
Inherited from BaseClient.put
- Defined in src/client/base.ts:166

removeMeetingParticipant

removeMeetingParticipant(
    meetingId: string,
    participantId: string,
    options?: RequestOptions,
): Promise<void>
Remove a participant from a meeting.
Parameters
- meetingId: string
  The meeting ID to remove the participant from
- participantId: string
  The participant ID to remove
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<void>
Throws
If the meeting or participant is not found
- Defined in src/client/user/index.ts:287

sendChatMessage

sendChatMessage(
    sessionId: string,
    data: SendChatMessageRequest,
    options?: RequestOptions,
): Promise<SendChatMessageResponse>
Enqueue a new user message as the next turn in an existing session.

Returns immediately with the queued turn and its position in the processing queue. The agent processes all queued turns sequentially — wait for a session.turn.completed webhook before calling getChatSession.

Requires the chat:write OAuth scope.
Parameters
- sessionId: string
  The session ID to add a message to
- data: SendChatMessageRequest
  The message to send
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<SendChatMessageResponse>
The queued turn and its position in the processing queue
Throws
If the session is not found, closed, or the turn limit is reached
Example
```
const { turn, position } = await user.sendChatMessage('session-uuid', {
  message: 'Create action items for each open question.',
});
console.log(`Turn ${turn.sequence_number} queued at position ${position}`);
```
- Defined in src/client/user/index.ts:1032

triggerActionButton

triggerActionButton(
    meetingId: string,
    buttonId: string,
    data?: TriggerActionButtonRequest,
    options?: RequestOptions,
): Promise<TriggerActionButtonResponse>
Trigger an action button for a meeting.

Executes the action associated with the button, which may send an email, create a document, trigger a webhook, or perform other actions.
Parameters
- meetingId: string
  The meeting ID
- buttonId: string
  The action button ID to trigger
- Optionaldata: TriggerActionButtonRequest
  Optional trigger parameters
- Optionaloptions: RequestOptions
  Request options
Returns Promise<TriggerActionButtonResponse>
Trigger response with result information
Throws
If the meeting or button is not found
Example
```
const result = await user.triggerActionButton('meeting-uuid', 'button-uuid');
if (result.redirect_url) {
  window.open(result.redirect_url);
}
```
- Defined in src/client/user/index.ts:475

uninstallToolkit

uninstallToolkit(toolkitId: string, options?: RequestOptions): Promise<void>
Uninstall a toolkit from the user's workspace.

Removes all toolkit-created entities from the user's workspace.
Parameters
- toolkitId: string
  The unique toolkit ID to uninstall
- Optionaloptions: RequestOptions
  Request options
Returns Promise<void>
Throws
If the toolkit is not found or not installed
Example
```
await user.uninstallToolkit('toolkit-uuid');
console.log('Toolkit uninstalled');
```
- Defined in src/client/user/index.ts:1143

updateActionItem

updateActionItem(
    actionItemId: string,
    data: UpdateActionItemRequest,
    options?: RequestOptions,
): Promise<ActionItem>
Update an existing action item.
Parameters
- actionItemId: string
  The unique action item ID to update
- data: UpdateActionItemRequest
  Fields to update (all optional)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<ActionItem>
The updated action item
Throws
If the action item is not found or update is denied
Example
```
// Mark as completed
const updated = await user.updateActionItem('item-id', {
  status: 'completed'
});
```
- Defined in src/client/user/index.ts:597

updateAgendaItem

updateAgendaItem(
    meetingId: string,
    itemId: string,
    data: UpdateAgendaItemRequest,
    options?: RequestOptions,
): Promise<AgendaItem>
Update an existing agenda item.
Parameters
- meetingId: string
  The meeting ID the agenda item belongs to
- itemId: string
  The agenda item ID to update
- data: UpdateAgendaItemRequest
  Fields to update
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<AgendaItem>
The updated agenda item

Throws
If the item is not found
- Defined in src/client/user/index.ts:338

updateMeeting

updateMeeting(
    meetingId: string,
    data: UpdateMeetingRequest,
    options?: RequestOptions,
): Promise<Meeting>
Update an existing meeting.
Parameters
- meetingId: string
  The meeting ID to update
- data: UpdateMeetingRequest
  Fields to update (all optional)
- Optionaloptions: RequestOptions
  Optional request options
Returns Promise<Meeting>
The updated meeting

Throws
If the meeting is not found or update is denied
- Defined in src/client/user/index.ts:246

uploadMeetingContextDocument

uploadMeetingContextDocument(
    meetingId: string,
    data: UploadMeetingContextRequest,
    options?: RequestOptions,
): Promise<MeetingContextDocument>
Upload a context document to a meeting.

The file is sent as multipart/form-data. The SDK handles FormData construction automatically — callers supply a plain request object.
Parameters
- meetingId: string
  The meeting ID to attach the document to (UUID format)
- data: UploadMeetingContextRequest
  Upload parameters including the file, source format, and optional metadata
  
  Parameters for uploading a meeting context document.
  
  The file field accepts any Blob-compatible value — in Node.js ≥ 22 this includes Buffer, File, and Blob instances. The SDK converts the request into a multipart/form-data upload automatically.
  - Optionalcontext_type?: string
    Logical context type — a free-form partner-defined category.
    
    Example
    `"agenda"`, `"crm_record"`, `"project_brief"`
  - file: Blob
    Document file contents
  - source_format: ContextSourceFormat
    Source format of the file.
    
    Must match the actual content — the server validates the file against this declaration.
  - Optionaltitle?: string
    Human-readable document title (defaults to the filename if omitted)
- Optionaloptions: RequestOptions
  Optional request options (e.g., timezone override)
Returns Promise<MeetingContextDocument>
The newly created context document
Throws
If the meeting is not found, validation fails, or upload is denied
Example
```
import { readFile } from 'node:fs/promises';

const buffer = await readFile('./agenda.md');
const doc = await user.uploadMeetingContextDocument('meeting-id', {
  file: new Blob([buffer]),
  source_format: 'md',
  title: 'Sprint planning agenda',
  context_type: 'agenda',
});
console.log(`Uploaded: ${doc.id}`);
```
- Defined in src/client/user/index.ts:862

Class PartnerUserClient

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PartnerUserClient

Properties

ProtectedaxiosInstance

Protectedconfig

Methods

ProtectedaddAuthHeaders

Parameters

Returns Promise<InternalAxiosRequestConfig<any>>

addMeetingParticipant

Parameters

Returns Promise<MeetingParticipant>

Throws

ProtectedbuildRequestConfig

Parameters

Returns AxiosRequestConfig

createActionItem

Parameters

Optionaldescription?: string

Optionaldue_date?: string

meeting_id: string

Optionalpartner_context?: Record<string, unknown>

Optionalstatus?: ActionItemStatus

title: string

Returns Promise<ActionItem>

Throws

Example

createAgendaItem

Parameters

Returns Promise<AgendaItem>

Throws

Example

createChatSession

Parameters

Returns Promise<ChatSession>

Throws

Example

createMeeting

Parameters

Returns Promise<Meeting>

Throws

Example

createMeetingFromCalendarEvent

Parameters

Returns Promise<CreateMeetingFromCalendarEventResponse>

Throws

Example

Parameters

Returns Promise<CreateMeetingFromCalendarEventResponse>

Deprecated

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

deleteActionItem

Parameters

Returns Promise<void>

Throws

deleteAgendaItem

Parameters

Returns Promise<void>

Throws

deleteMeetingContextDocument

Parameters

Returns Promise<void>

Throws

Example

downloadMeetingContextDocumentContent

Parameters

Returns Promise<MeetingContextContentResponse>

Throws

`Protected`axiosInstance

`Protected`config

`Protected`addAuthHeaders

`Protected`buildRequestConfig

`Optional`description?: string

`Optional`due_date?: string

`Optional`partner_context?: Record<string, unknown>

`Optional`status?: ActionItemStatus

`Protected`delete

`Protected`get

`Optional`direction?: string

`Optional`end?: string

`Optional`end_date?: string

`Optional`limit?: number

`Optional`offset?: number

`Optional`start?: string

`Optional`start_date?: string