Class: Gathering

A live Gathering object. Every field from the API response is available directly on the object (e.g. gathering.name, gathering.joinCode), and the object also exposes action methods (start(), end(), addMember(), watchMembers(), …).

Extends

• GatheringResponse

Constructors

new Gathering()

new Gathering(
   ctx, 
   _projectId, 
   data): Gathering

Internal

Parameters

Parameter	Type	Description
ctx	ClientContext	-
_projectId	string	-
data	object	-
data.accessPolicy	string	Description Access policy
data.autoStartSession	boolean	Description Whether session starts automatically
data.createdAt	string	Format: date-time Description Creation timestamp
data.description?	string	Description Gathering description
data.endsAt?	string	Format: date-time Description Scheduled end time
data.expiresAt?	string	Format: date-time Description Expiration timestamp
data.id	string	Description Gathering ID
data.inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)
data.inviterName?	string	Description Display name of the gathering organizer
data.joinCode	string	Description Join code for sharing
data.listed	boolean	Description Whether gathering is listed for discovery
data.maxMembers	number	Description Maximum members allowed
data.memberCount	number	Description Current member count
data.members?	object[]	Description Members (included in detailed view)
data.name	string	Description Gathering name
data.ownerId?	string	Description Owner participant ID
data.projectId	string	Description Project ID
data.properties?	object	Description Custom properties
data.roomId?	string	Description Target ODIN room ID
data.sessionId?	string	Description Created session ID
data.startsAt?	string	Format: date-time Description Scheduled start time
data.status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status
data.tenantId	string	Description Tenant ID
data.timezone?	string	Description Timezone for scheduled times
data.type	"lobby" | "appointment" | "open"	Description Gathering type

Returns

Gathering

Inherited from

GatheringResponse.constructor

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:214

Properties

Property	Type	Description	Inherited from	Defined in
accessPolicy	string	Description Access policy	GatheringResponse.accessPolicy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	GatheringResponse.autoStartSession	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	GatheringResponse.createdAt	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	GatheringResponse.description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	GatheringResponse.endsAt	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	GatheringResponse.expiresAt	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	GatheringResponse.id	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	GatheringResponse.inviterEmail	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	GatheringResponse.inviterName	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	GatheringResponse.joinCode	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	GatheringResponse.listed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	GatheringResponse.maxMembers	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	GatheringResponse.memberCount	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	GatheringResponse.members	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	GatheringResponse.name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	GatheringResponse.ownerId	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	GatheringResponse.projectId	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	GatheringResponse.properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	GatheringResponse.roomId	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	GatheringResponse.sessionId	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	GatheringResponse.startsAt	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	GatheringResponse.status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	GatheringResponse.tenantId	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	GatheringResponse.timezone	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	GatheringResponse.type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Accessors

data

get data(): object

The raw API response object.

Deprecated

The response fields are now available directly on this object (e.g. gathering.name instead of gathering.data.name). This accessor will be removed before the stable release.

Returns

object

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:226

Methods

addMember()

addMember(body): Promise<object>

Add a member to this gathering

Parameters

Parameter	Type	Description
body	object	Member addition payload
body.participantId	string	Description Participant ID to add
body.properties?	object	Description Custom member properties
body.role?	"owner" | "member"	Description Role for the member (default: member)

Returns

Promise<object>

Added member

Name	Type	Description	Defined in
displayName	string	Description Participant display name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3734
gatheringId	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3730
id	string	Description Member record ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3728
invitedAt?	string	Format: date-time Description When the member was invited	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3753
joinedAt?	string	Format: date-time Description When the member joined	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3758
participantId	string	Description Participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3732
properties?	object	Description Custom member properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3746
readyAt?	string	Format: date-time Description When the member marked as ready	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3763
role	"owner" | "member"	Description Member role	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3744
status	"invited" | "joined" | "ready" | "left"	Description Member status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3739

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:304

---

cancel()

cancel(): Promise<object>

Cancel this gathering

Returns

Promise<object>

Cancelled gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:248

---

end()

end(): Promise<object>

End this gathering

Returns

Promise<object>

Ended gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:275

---

listInvitations()

listInvitations(): Promise<object[]>

List all invitation records for this gathering, regardless of status (pending, accepted, declined). Useful for tracking RSVP state of email invitations sent via CreateGatheringRequest.participants or Gathering.sendInvitations.

Returns

Promise<object[]>

Array of invitation records for this gathering

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:364

---

listMembers()

listMembers(): Promise<object[]>

List members of this gathering

Returns

Promise<object[]>

Array of gathering members

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:290

---

removeMember()

removeMember(participantId): Promise<void>

Remove a member from this gathering

Parameters

Parameter	Type	Description
participantId	string	Participant ID to remove

Returns

Promise<void>

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:332

---

sendInvitations()

sendInvitations(body): Promise<object[]>

Send invitations to this gathering

Parameters

Parameter	Type	Description
body	object	Invitations payload
body.baseUrl?	string	Description Base URL for HTTP join links Example https://game.example.com
body.customProtocol?	string	Description Custom protocol format for join URL Example mygame://
body.emails?	string[]	Description Email addresses to invite
body.invitedById	string	Description Participant UUID of the person sending invitations
body.participantIds?	string[]	Description Participant IDs to invite

Returns

Promise<object[]>

Array of created invitations

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:347

---

start()

start(body): Promise<object>

Start this gathering

Parameters

Parameter	Type	Description
body	object	Start payload (roomId)
body.actorParticipantId?	string	Description Participant acting on behalf of the caller. When set, the request is only accepted if that participant owns the gathering.
body.roomId?	string	Description ODIN room ID to use. Defaults to the room the gathering was created with. Example room-123

Returns

Promise<object>

Started gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:262

---

update()

update(body): Promise<object>

Update this gathering

Parameters

Parameter	Type	Description
body	object	Updated gathering data
body.accessPolicy?	"public" | "private" | "invite-only"	Description Updated access policy
body.actorParticipantId?	string	Description Participant acting on behalf of the caller. When set, the request is only accepted if that participant owns the gathering.
body.description?	string	Description Updated description
body.endsAt?	string	Description Updated scheduled end time
body.inviterEmail?	string	Description Updated inviter email address
body.inviterName?	string	Description Updated inviter display name
body.listed?	boolean	Description Updated visibility
body.maxMembers?	number	Description Updated max members
body.name?	string	Description Updated name
body.properties?	object	Description Updated properties
body.searchProperties?	object	Description Updated search properties
body.startsAt?	string	Description Updated scheduled start time

Returns

Promise<object>

Updated gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:235

---

updateMember()

updateMember(memberId, body): Promise<object>

Update a gathering member

Parameters

Parameter	Type	Description
memberId	string	Member ID
body	object	Updated member data
body.properties?	object	Description Updated member properties
body.status?	"invited" | "joined" | "ready" | "left"	Description Updated member status

Returns

Promise<object>

Updated member

Name	Type	Description	Defined in
displayName	string	Description Participant display name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3734
gatheringId	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3730
id	string	Description Member record ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3728
invitedAt?	string	Format: date-time Description When the member was invited	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3753
joinedAt?	string	Format: date-time Description When the member joined	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3758
participantId	string	Description Participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3732
properties?	object	Description Custom member properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3746
readyAt?	string	Format: date-time Description When the member marked as ready	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3763
role	"owner" | "member"	Description Member role	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3744
status	"invited" | "joined" | "ready" | "left"	Description Member status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3739

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:319

---

watch()

watch(): DocumentSubscription<object>

Live-subscribe to this gathering. current reflects status changes (started, ended, cancelled) and becomes undefined only if the gathering is deleted.

Returns

DocumentSubscription<object>

A DocumentSubscription for this gathering

Name	Type	Description	Defined in
accessPolicy	string	Description Access policy	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3795
autoStartSession	boolean	Description Whether session starts automatically	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3813
createdAt	string	Format: date-time Description Creation timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3828
description?	string	Description Gathering description	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3775
endsAt?	string	Format: date-time Description Scheduled end time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3807
expiresAt?	string	Format: date-time Description Expiration timestamp	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3833
id	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3767
inviterEmail?	string	Description Email address of the gathering organizer (used as Reply-To in invitation emails)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3779
inviterName?	string	Description Display name of the gathering organizer	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3777
joinCode	string	Description Join code for sharing	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3817
listed	boolean	Description Whether gathering is listed for discovery	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3797
maxMembers	number	Description Maximum members allowed	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3791
memberCount	number	Description Current member count	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3793
members?	object[]	Description Members (included in detailed view)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3835
name	string	Description Gathering name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3773
ownerId?	string	Description Owner participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3823
projectId	string	Description Project ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3769
properties?	object	Description Custom properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3819
roomId?	string	Description Target ODIN room ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3811
sessionId?	string	Description Created session ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3815
startsAt?	string	Format: date-time Description Scheduled start time	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3802
status	| "active" | "pending" | "started" | "ended" | "cancelled" | "expired"	Description Gathering status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3789
tenantId	string	Description Tenant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3771
timezone?	string	Description Timezone for scheduled times	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3809
type	"lobby" | "appointment" | "open"	Description Gathering type	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3784

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:380

---

watchInvitations()

watchInvitations(): CollectionSubscription<object>

Live-subscribe to this gathering's invitations. sent upserts the invitation record; accepted/declined update its status in place. Initial invitations are loaded via REST.

Returns

CollectionSubscription<object>

A CollectionSubscription of invitation records

Name	Type	Description	Defined in
displayName?	string	Description Display name of the invitee	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4244
email?	string	Description Invited email	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4242
expiresAt?	string	Format: date-time Description When invitation expires	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4265
gatheringId	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4238
id	string	Description Invitation ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4236
invitedAt	string	Format: date-time Description When invitation was sent	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4260
invitedById?	string	Description Who sent the invitation (null for system-generated invitations)	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4246
joinCode	string	Description Join code	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4255
joinUrl	string	Description Join URL	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4253
participantId?	string	Description Invited participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4240
respondedAt?	string	Format: date-time Description When invitee responded	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4270
status	"pending" | "expired" | "accepted" | "declined"	Description Invitation status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4251

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:416

---

watchMembers()

watchMembers(): CollectionSubscription<object>

Live-subscribe to this gathering's members. Members are keyed by participant ID; joined/ready upsert the member, left removes them. Initial members are loaded via REST.

Returns

CollectionSubscription<object>

A CollectionSubscription of gathering members

Name	Type	Description	Defined in
displayName	string	Description Participant display name	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3734
gatheringId	string	Description Gathering ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3730
id	string	Description Member record ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3728
invitedAt?	string	Format: date-time Description When the member was invited	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3753
joinedAt?	string	Format: date-time Description When the member joined	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3758
participantId	string	Description Participant ID	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3732
properties?	object	Description Custom member properties	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3746
readyAt?	string	Format: date-time Description When the member marked as ready	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3763
role	"owner" | "member"	Description Member role	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3744
status	"invited" | "joined" | "ready" | "left"	Description Member status	odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:3739

Defined in

odin-transcription-service/packages/cortex-typescript-sdk/src/resources/gatherings.ts:390