adapters
@meeting-baas/sdk v7 - Unified Multi-Provider SDK / adapters
adapters
Classes
BaasAdapter
BaaS v2 Provider Adapter
Provides access to Meeting BaaS v2 API with unified interface
Implements
Constructors
Constructor
new BaasAdapter(
config):BaasAdapter
Parameters
| Parameter | Type |
|---|---|
config | ProviderConfig |
Returns
Methods
createBot()
createBot(
params):Promise<UnifiedResponse<BotInfo>>
Create a bot to join a meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
params | CreateBotParams | Bot creation parameters |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
Implementation of
createCalendar()
createCalendar(
params):Promise<UnifiedResponse<Calendar>>
Create a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
params | CreateCalendarParams | Calendar connection parameters |
Returns
Promise<UnifiedResponse<Calendar>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
Implementation of
MeetingProvider.createCalendar
deleteBot()
deleteBot(
identifier):Promise<UnifiedResponse<void>>
Delete bot data (recordings, transcripts, etc.)
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
Implementation of
deleteCalendar()
deleteCalendar(
calendar_id):Promise<UnifiedResponse<void>>
Delete a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
calendar_id | string | Calendar identifier |
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
Throws
Error if provider doesn't support calendar integration
Implementation of
MeetingProvider.deleteCalendar
getBot()
getBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Get bot details
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
Implementation of
getCalendar()
getCalendar(
calendar_id):Promise<UnifiedResponse<Calendar>>
Get a specific calendar
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
calendar_id | string | Calendar identifier |
Returns
Promise<UnifiedResponse<Calendar>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
Implementation of
getRecording()
getRecording(
identifier):Promise<UnifiedResponse<Recording>>
Get recording URL for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Recording>>
Unified response with recording information
Implementation of
getTranscript()
getTranscript(
identifier):Promise<UnifiedResponse<Transcript>>
Get transcript for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Transcript>>
Unified response with transcript data
Implementation of
leaveBot()
leaveBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Have the bot leave the meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with updated bot information
Implementation of
listBots()
listBots(
params?):Promise<UnifiedResponse<BotInfo[]>>
List bots for the authenticated account
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | ListBotsParams | Optional filtering parameters |
Returns
Promise<UnifiedResponse<BotInfo[]>>
Unified response with list of bots
Implementation of
listCalendars()
listCalendars():
Promise<UnifiedResponse<Calendar[]>>
List calendar connections
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<Calendar[]>>
Unified response with list of calendars
Throws
Error if provider doesn't support calendar integration
Implementation of
Properties
capabilities
readonlycapabilities:ProviderCapabilities
Provider capabilities for feature detection
This allows runtime checking of which features are available.
Implementation of
providerId
readonlyproviderId:"baas"
Provider identifier
Implementation of
VexaAdapter
Vexa Provider Adapter
Provides access to Vexa API with unified interface
Implements
Constructors
Constructor
new VexaAdapter(
config):VexaAdapter
Parameters
| Parameter | Type |
|---|---|
config | ProviderConfig |
Returns
Methods
createBot()
createBot(
params):Promise<UnifiedResponse<BotInfo>>
Create a bot to join a meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
params | CreateBotParams | Bot creation parameters |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
Implementation of
createCalendar()
createCalendar():
Promise<UnifiedResponse<any>>
Create a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<any>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
Implementation of
MeetingProvider.createCalendar
deleteBot()
deleteBot(
identifier):Promise<UnifiedResponse<void>>
Delete bot data (recordings, transcripts, etc.)
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
Implementation of
deleteCalendar()
deleteCalendar():
Promise<UnifiedResponse<void>>
Delete a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
Throws
Error if provider doesn't support calendar integration
Implementation of
MeetingProvider.deleteCalendar
getBot()
getBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Get bot details
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
Implementation of
getCalendar()
getCalendar():
Promise<UnifiedResponse<any>>
Get a specific calendar
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<any>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
Implementation of
getRecording()
getRecording(
identifier):Promise<UnifiedResponse<Recording>>
Get recording URL for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Recording>>
Unified response with recording information
Implementation of
getTranscript()
getTranscript(
identifier):Promise<UnifiedResponse<Transcript>>
Get transcript for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Transcript>>
Unified response with transcript data
Implementation of
leaveBot()
leaveBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Have the bot leave the meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with updated bot information
Implementation of
listBots()
listBots(
params?):Promise<UnifiedResponse<BotInfo[]>>
List bots for the authenticated account
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | ListBotsParams | Optional filtering parameters |
Returns
Promise<UnifiedResponse<BotInfo[]>>
Unified response with list of bots
Implementation of
listCalendars()
listCalendars():
Promise<UnifiedResponse<any[]>>
List calendar connections
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<any[]>>
Unified response with list of calendars
Throws
Error if provider doesn't support calendar integration
Implementation of
updateBotConfig()
updateBotConfig(
params):Promise<UnifiedResponse<void>>
Update bot configuration (language, task) Vexa-specific feature
Parameters
| Parameter | Type |
|---|---|
params | { config: { language?: string; task?: string; }; native_meeting_id: string; platform: string; } |
params.config | { language?: string; task?: string; } |
params.config.language? | string |
params.config.task? | string |
params.native_meeting_id | string |
params.platform | string |
Returns
Promise<UnifiedResponse<void>>
updateMeetingData()
updateMeetingData(
params):Promise<UnifiedResponse<BotInfo>>
Update meeting metadata Vexa-specific feature
Parameters
| Parameter | Type |
|---|---|
params | { data: { languages?: string[]; name?: string; notes?: string; participants?: string[]; }; native_meeting_id: string; platform: string; } |
params.data | { languages?: string[]; name?: string; notes?: string; participants?: string[]; } |
params.data.languages? | string[] |
params.data.name? | string |
params.data.notes? | string |
params.data.participants? | string[] |
params.native_meeting_id | string |
params.platform | string |
Returns
Promise<UnifiedResponse<BotInfo>>
Properties
capabilities
readonlycapabilities:ProviderCapabilities
Provider capabilities for feature detection
This allows runtime checking of which features are available.
Implementation of
providerId
readonlyproviderId:"vexa"
Provider identifier
Implementation of
Interfaces
MeetingProvider
Base interface that all provider adapters must implement
This ensures that all providers support the core operations exposed through the UnifiedMeetingClient bridge interface.
Methods
createBot()
createBot(
params):Promise<UnifiedResponse<BotInfo>>
Create a bot to join a meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
params | CreateBotParams | Bot creation parameters |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
deleteBot()
deleteBot(
identifier):Promise<UnifiedResponse<void>>
Delete bot data (recordings, transcripts, etc.)
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
getBot()
getBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Get bot details
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with bot information
getRecording()
getRecording(
identifier):Promise<UnifiedResponse<Recording>>
Get recording URL for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Recording>>
Unified response with recording information
getTranscript()
getTranscript(
identifier):Promise<UnifiedResponse<Transcript>>
Get transcript for a bot
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<Transcript>>
Unified response with transcript data
leaveBot()
leaveBot(
identifier):Promise<UnifiedResponse<BotInfo>>
Have the bot leave the meeting
Parameters
| Parameter | Type | Description |
|---|---|---|
identifier | BotIdentifier | Bot identifier |
Returns
Promise<UnifiedResponse<BotInfo>>
Unified response with updated bot information
listBots()
listBots(
params?):Promise<UnifiedResponse<BotInfo[]>>
List bots for the authenticated account
Parameters
| Parameter | Type | Description |
|---|---|---|
params? | ListBotsParams | Optional filtering parameters |
Returns
Promise<UnifiedResponse<BotInfo[]>>
Unified response with list of bots
createCalendar()?
optionalcreateCalendar(params):Promise<UnifiedResponse<Calendar>>
Create a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
params | CreateCalendarParams | Calendar connection parameters |
Returns
Promise<UnifiedResponse<Calendar>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
deleteCalendar()?
optionaldeleteCalendar(calendar_id):Promise<UnifiedResponse<void>>
Delete a calendar connection
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
calendar_id | string | Calendar identifier |
Returns
Promise<UnifiedResponse<void>>
Unified response indicating success
Throws
Error if provider doesn't support calendar integration
getCalendar()?
optionalgetCalendar(calendar_id):Promise<UnifiedResponse<Calendar>>
Get a specific calendar
Note: Only supported by providers with supportsCalendarIntegration = true
Parameters
| Parameter | Type | Description |
|---|---|---|
calendar_id | string | Calendar identifier |
Returns
Promise<UnifiedResponse<Calendar>>
Unified response with calendar information
Throws
Error if provider doesn't support calendar integration
listCalendars()?
optionallistCalendars():Promise<UnifiedResponse<Calendar[]>>
List calendar connections
Note: Only supported by providers with supportsCalendarIntegration = true
Returns
Promise<UnifiedResponse<Calendar[]>>
Unified response with list of calendars
Throws
Error if provider doesn't support calendar integration
Properties
capabilities
readonlycapabilities:ProviderCapabilities
Provider capabilities for feature detection
This allows runtime checking of which features are available.
providerId
readonlyproviderId:"baas"|"vexa"|"attendee"
Provider identifier
References
BotIdentifier
Re-exports BotIdentifier
BotInfo
Re-exports BotInfo
CreateBotParams
Re-exports CreateBotParams
ListBotsParams
Re-exports ListBotsParams
ProviderCapabilities
Re-exports ProviderCapabilities
UnifiedResponse
Re-exports UnifiedResponse