Interface SubscriptionResponse<CustomFields>

interface SubscriptionResponse {
    approved?: boolean;
    customFields?: CustomFields;
    organizationId?: string;
    permissions?: ("admin" | "read" | "write")[];
    subscribedAt: string;
    topicId: string;
    userId?: string;
}

Type Parameters

  • CustomFields = unknown

Properties

approved? customFields? organizationId? permissions? subscribedAt topicId userId?

Properties

Optional approved

approved?: boolean

Whether the subscription is approved. This may not be used depending upon the application.

Optional customFields

customFields?: CustomFields

Custom fields for the subscription

Optional organizationId

organizationId?: string

Org ID for the subscription (either this or userId should be provided)

Optional permissions

permissions?: ("admin" | "read" | "write")[]

Permissions that this subscription has over the topic

subscribedAt

subscribedAt: string

ISO Datetime when the subscription was created

topicId

topicId: string

Topic ID for the subscription

Optional userId

userId?: string

User ID for the subscription (either this or organizationId should be provided)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc