chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -2,6 +2,15 @@ title: Invite
|
||||
description: Represents an invite
|
||||
type: object
|
||||
required:
|
||||
- accepted
|
||||
- created_at
|
||||
- deleted_at
|
||||
- expires_at
|
||||
- id
|
||||
- metadata
|
||||
- role
|
||||
- token
|
||||
- updated_at
|
||||
- user_email
|
||||
properties:
|
||||
id:
|
||||
@@ -9,42 +18,45 @@ properties:
|
||||
description: The invite's ID
|
||||
example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
|
||||
user_email:
|
||||
type: string
|
||||
description: The email of the user being invited.
|
||||
type: string
|
||||
format: email
|
||||
role:
|
||||
type: string
|
||||
description: The user's role.
|
||||
nullable: true
|
||||
type: string
|
||||
enum:
|
||||
- admin
|
||||
- member
|
||||
- developer
|
||||
default: member
|
||||
accepted:
|
||||
type: boolean
|
||||
description: Whether the invite was accepted or not.
|
||||
example: false
|
||||
type: boolean
|
||||
default: false
|
||||
token:
|
||||
type: string
|
||||
description: The token used to accept the invite.
|
||||
expores_at:
|
||||
type: string
|
||||
expires_at:
|
||||
description: The date the invite expires at.
|
||||
type: string
|
||||
format: date-time
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user