Class: Sanction
A live Sanction object. Every field from the API response is available directly
on the object (e.g. sanction.type, sanction.reason), and the object also
exposes action methods (update(), revoke(), watch()).
Extends
Constructors
new Sanction()
Internal
projectId is a public field of the API response since sanctions became
project-scoped, so it is set by the Object.assign below; the projectId
parameter only serves as a fallback for responses of older API versions.
Parameters
| Parameter | Type | Description |
|---|---|---|
ctx | ClientContext | - |
projectId | string | - |
data | object | - |
data.createdAt | string | Format: date-time Description Creation timestamp |
data.createdByUserId? | string | Description User who created the sanction |
data.endAt? | string | Format: date-time Description When sanction expires (null = permanent) |
data.externalUserId? | string | Description External user ID |
data.gatheringId? | string | Description Gathering the sanction was issued in (if any) |
data.id | string | Description Sanction ID |
data.isActive | boolean | Description Whether the sanction is currently active |
data.metadata? | object | Description Additional metadata |
data.participant? | object | Description Participant information (if available) |
data.participant.displayName | string | Description Display name of the participant |
data.participant.externalUserId | string | Description External user ID from ODIN |
data.participant.id | string | Description Participant ID |
data.participant.joinedAt? | string | Format: date-time Description When the participant first joined the project |
data.participant.projectId | string | Description ODIN project ID this participant belongs to |
data.participant.userData? | object | Description User data from ODIN (parsed JSON) |
data.participantId? | string | Description Participant ID (if session-scoped) |
data.projectId | string | Description Project the sanction belongs to |
data.reason? | string | Description Reason for sanction |
data.revokedAt? | string | Format: date-time Description When sanction was revoked |
data.revokedByUserId? | string | Description User who revoked the sanction |
data.scope? | object | Description Scope configuration |
data.sessionId? | string | Description Session ID (if session-scoped) |
data.startAt | string | Format: date-time Description When sanction becomes active |
data.status | string | Description Status: active, expired, or revoked |
data.tenantId | string | Description Tenant ID |
data.type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction |
data.updatedAt | string | Format: date-time Description Last update timestamp |
Returns
Inherited from
SanctionResponse.constructor
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sanctions.ts:179
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
createdAt | string | Format: date-time Description Creation timestamp | SanctionResponse.createdAt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4446 |
createdByUserId? | string | Description User who created the sanction | SanctionResponse.createdByUserId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4441 |
endAt? | string | Format: date-time Description When sanction expires (null = permanent) | SanctionResponse.endAt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4439 |
externalUserId? | string | Description External user ID | SanctionResponse.externalUserId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4410 |
gatheringId? | string | Description Gathering the sanction was issued in (if any) | SanctionResponse.gatheringId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4414 |
id | string | Description Sanction ID | SanctionResponse.id | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4402 |
isActive | boolean | Description Whether the sanction is currently active | SanctionResponse.isActive | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4460 |
metadata? | object | Description Additional metadata | SanctionResponse.metadata | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4427 |
participant? | object | Description Participant information (if available) | SanctionResponse.participant | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4464 |
participant.displayName | string | Description Display name of the participant | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4387 |
participant.externalUserId | string | Description External user ID from ODIN | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4389 |
participant.id | string | Description Participant ID | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4383 |
participant.joinedAt? | string | Format: date-time Description When the participant first joined the project | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4398 |
participant.projectId | string | Description ODIN project ID this participant belongs to | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4385 |
participant.userData? | object | Description User data from ODIN (parsed JSON) | - | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4391 |
participantId? | string | Description Participant ID (if session-scoped) | SanctionResponse.participantId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4408 |
projectId | string | Description Project the sanction belongs to | SanctionResponse.projectId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4406 |
reason? | string | Description Reason for sanction | SanctionResponse.reason | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4425 |
revokedAt? | string | Format: date-time Description When sanction was revoked | SanctionResponse.revokedAt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4456 |
revokedByUserId? | string | Description User who revoked the sanction | SanctionResponse.revokedByUserId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4458 |
scope? | object | Description Scope configuration | SanctionResponse.scope | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4421 |
sessionId? | string | Description Session ID (if session-scoped) | SanctionResponse.sessionId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4412 |
startAt | string | Format: date-time Description When sanction becomes active | SanctionResponse.startAt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4434 |
status | string | Description Status: active, expired, or revoked | SanctionResponse.status | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4462 |
tenantId | string | Description Tenant ID | SanctionResponse.tenantId | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4404 |
type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction | SanctionResponse.type | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4419 |
updatedAt | string | Format: date-time Description Last update timestamp | SanctionResponse.updatedAt | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4451 |
Accessors
data
The raw API response object.
Deprecated
The response fields are now available directly on this object
(e.g. sanction.type instead of sanction.data.type). This accessor will be
removed before the stable release.
Returns
object
| Name | Type | Description | Defined in |
|---|---|---|---|
createdAt | string | Format: date-time Description Creation timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4446 |
createdByUserId? | string | Description User who created the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4441 |
endAt? | string | Format: date-time Description When sanction expires (null = permanent) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4439 |
externalUserId? | string | Description External user ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4410 |
gatheringId? | string | Description Gathering the sanction was issued in (if any) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4414 |
id | string | Description Sanction ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4402 |
isActive | boolean | Description Whether the sanction is currently active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4460 |
metadata? | object | Description Additional metadata | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4427 |
participant? | object | Description Participant information (if available) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4464 |
participant.displayName | string | Description Display name of the participant | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4387 |
participant.externalUserId | string | Description External user ID from ODIN | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4389 |
participant.id | string | Description Participant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4383 |
participant.joinedAt? | string | Format: date-time Description When the participant first joined the project | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4398 |
participant.projectId | string | Description ODIN project ID this participant belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4385 |
participant.userData? | object | Description User data from ODIN (parsed JSON) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4391 |
participantId? | string | Description Participant ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4408 |
projectId | string | Description Project the sanction belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4406 |
reason? | string | Description Reason for sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4425 |
revokedAt? | string | Format: date-time Description When sanction was revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4456 |
revokedByUserId? | string | Description User who revoked the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4458 |
scope? | object | Description Scope configuration | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4421 |
sessionId? | string | Description Session ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4412 |
startAt | string | Format: date-time Description When sanction becomes active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4434 |
status | string | Description Status: active, expired, or revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4462 |
tenantId | string | Description Tenant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4404 |
type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4419 |
updatedAt | string | Format: date-time Description Last update timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4451 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sanctions.ts:191
Methods
revoke()
Revoke this sanction
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Revocation payload (optional reason) |
body.reason? | string | Description Reason for revocation Example False positive from automated detection |
Returns
Promise<object>
Revoked sanction
| Name | Type | Description | Defined in |
|---|---|---|---|
createdAt | string | Format: date-time Description Creation timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4446 |
createdByUserId? | string | Description User who created the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4441 |
endAt? | string | Format: date-time Description When sanction expires (null = permanent) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4439 |
externalUserId? | string | Description External user ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4410 |
gatheringId? | string | Description Gathering the sanction was issued in (if any) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4414 |
id | string | Description Sanction ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4402 |
isActive | boolean | Description Whether the sanction is currently active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4460 |
metadata? | object | Description Additional metadata | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4427 |
participant? | object | Description Participant information (if available) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4464 |
participant.displayName | string | Description Display name of the participant | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4387 |
participant.externalUserId | string | Description External user ID from ODIN | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4389 |
participant.id | string | Description Participant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4383 |
participant.joinedAt? | string | Format: date-time Description When the participant first joined the project | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4398 |
participant.projectId | string | Description ODIN project ID this participant belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4385 |
participant.userData? | object | Description User data from ODIN (parsed JSON) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4391 |
participantId? | string | Description Participant ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4408 |
projectId | string | Description Project the sanction belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4406 |
reason? | string | Description Reason for sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4425 |
revokedAt? | string | Format: date-time Description When sanction was revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4456 |
revokedByUserId? | string | Description User who revoked the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4458 |
scope? | object | Description Scope configuration | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4421 |
sessionId? | string | Description Session ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4412 |
startAt | string | Format: date-time Description When sanction becomes active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4434 |
status | string | Description Status: active, expired, or revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4462 |
tenantId | string | Description Tenant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4404 |
type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4419 |
updatedAt | string | Format: date-time Description Last update timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4451 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sanctions.ts:214
update()
Update this sanction
Parameters
| Parameter | Type | Description |
|---|---|---|
body | object | Updated sanction data |
body.endAt? | string | Description Updated end time |
body.metadata? | object | Description Updated metadata |
body.reason? | string | Description Updated reason |
body.scope? | object | Description Updated scope configuration |
body.type? | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Updated sanction type |
Returns
Promise<object>
Updated sanction
| Name | Type | Description | Defined in |
|---|---|---|---|
createdAt | string | Format: date-time Description Creation timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4446 |
createdByUserId? | string | Description User who created the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4441 |
endAt? | string | Format: date-time Description When sanction expires (null = permanent) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4439 |
externalUserId? | string | Description External user ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4410 |
gatheringId? | string | Description Gathering the sanction was issued in (if any) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4414 |
id | string | Description Sanction ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4402 |
isActive | boolean | Description Whether the sanction is currently active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4460 |
metadata? | object | Description Additional metadata | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4427 |
participant? | object | Description Participant information (if available) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4464 |
participant.displayName | string | Description Display name of the participant | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4387 |
participant.externalUserId | string | Description External user ID from ODIN | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4389 |
participant.id | string | Description Participant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4383 |
participant.joinedAt? | string | Format: date-time Description When the participant first joined the project | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4398 |
participant.projectId | string | Description ODIN project ID this participant belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4385 |
participant.userData? | object | Description User data from ODIN (parsed JSON) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4391 |
participantId? | string | Description Participant ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4408 |
projectId | string | Description Project the sanction belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4406 |
reason? | string | Description Reason for sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4425 |
revokedAt? | string | Format: date-time Description When sanction was revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4456 |
revokedByUserId? | string | Description User who revoked the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4458 |
scope? | object | Description Scope configuration | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4421 |
sessionId? | string | Description Session ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4412 |
startAt | string | Format: date-time Description When sanction becomes active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4434 |
status | string | Description Status: active, expired, or revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4462 |
tenantId | string | Description Tenant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4404 |
type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4419 |
updatedAt | string | Format: date-time Description Last update timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4451 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sanctions.ts:200
watch()
Live-subscribe to this sanction. current reflects status changes including
revocation (the object remains, with status updated).
Returns
DocumentSubscription<object>
A DocumentSubscription for this sanction
| Name | Type | Description | Defined in |
|---|---|---|---|
createdAt | string | Format: date-time Description Creation timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4446 |
createdByUserId? | string | Description User who created the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4441 |
endAt? | string | Format: date-time Description When sanction expires (null = permanent) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4439 |
externalUserId? | string | Description External user ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4410 |
gatheringId? | string | Description Gathering the sanction was issued in (if any) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4414 |
id | string | Description Sanction ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4402 |
isActive | boolean | Description Whether the sanction is currently active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4460 |
metadata? | object | Description Additional metadata | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4427 |
participant? | object | Description Participant information (if available) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4464 |
participant.displayName | string | Description Display name of the participant | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4387 |
participant.externalUserId | string | Description External user ID from ODIN | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4389 |
participant.id | string | Description Participant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4383 |
participant.joinedAt? | string | Format: date-time Description When the participant first joined the project | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4398 |
participant.projectId | string | Description ODIN project ID this participant belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4385 |
participant.userData? | object | Description User data from ODIN (parsed JSON) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4391 |
participantId? | string | Description Participant ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4408 |
projectId | string | Description Project the sanction belongs to | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4406 |
reason? | string | Description Reason for sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4425 |
revokedAt? | string | Format: date-time Description When sanction was revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4456 |
revokedByUserId? | string | Description User who revoked the sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4458 |
scope? | object | Description Scope configuration | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4421 |
sessionId? | string | Description Session ID (if session-scoped) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4412 |
startAt | string | Format: date-time Description When sanction becomes active | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4434 |
status | string | Description Status: active, expired, or revoked | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4462 |
tenantId | string | Description Tenant ID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4404 |
type | | "warn" | "mute" | "listen_only" | "text_only" | "rate_limit" | "shadow_mute" | "temp_ban" | "perm_ban" | "ranked_restriction" | "queue_delay" | "party_restriction" | "human_review" | Description Type of sanction | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4419 |
updatedAt | string | Format: date-time Description Last update timestamp | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:4451 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/sanctions.ts:228