Skip to content

Latest commit

 

History

History
119 lines (63 loc) · 1.87 KB

Invitation.md

File metadata and controls

119 lines (63 loc) · 1.87 KB

@letsgo/tenant / Invitation

Interface: Invitation

An invitation for a new user to join a tenant.

Hierarchy

  • DBItem

    Invitation

Table of contents

Properties

Properties

category

category: string

The DynamoDB partition key.

Inherited from

DBItem.category

Defined in

db/dist/index.d.ts:49


createdAt

createdAt: string

The timestamp of the invitation's creation.

Defined in

tenant/src/index.ts:184


createdBy

createdBy: Identity

The identity of the user who created the invitation.

Defined in

tenant/src/index.ts:180


expiresAt

expiresAt: string

The timestamp of the invitation's expiration.

Defined in

tenant/src/index.ts:188


invitationId

invitationId: string

The invitation ID. This is unique within a tenant.

Defined in

tenant/src/index.ts:176


key

key: string

The DynamoDB sort key.

Inherited from

DBItem.key

Defined in

db/dist/index.d.ts:53


ttl

ttl: number

The time-to-live of the invitation in seconds.

Overrides

DBItem.ttl

Defined in

tenant/src/index.ts:192