Skip to main content

project

Workspace API


Workspace API / types/project

types/project

Interfaces

Project

Defined in: types/project.ts:2

Extended by

Properties

project_id

project_id: string

Defined in: types/project.ts:3

organization_id

organization_id: string

Defined in: types/project.ts:4

name

name: string

Defined in: types/project.ts:5

description?

optional description: string

Defined in: types/project.ts:6

status

status: string

Defined in: types/project.ts:7

created_at

created_at: Date

Defined in: types/project.ts:8

updated_at

updated_at: Date

Defined in: types/project.ts:9

created_by?

optional created_by: string

Defined in: types/project.ts:10


CreateProjectData

Defined in: types/project.ts:13

Properties

organization_id

organization_id: string

Defined in: types/project.ts:14

name

name: string

Defined in: types/project.ts:15

description?

optional description: string

Defined in: types/project.ts:16

status?

optional status: string

Defined in: types/project.ts:17

created_by?

optional created_by: string

Defined in: types/project.ts:18


UpdateProjectData

Defined in: types/project.ts:21

Properties

name?

optional name: string

Defined in: types/project.ts:22

description?

optional description: string

Defined in: types/project.ts:23

status?

optional status: string

Defined in: types/project.ts:24


ProjectFilters

Defined in: types/project.ts:27

Properties

organization_id?

optional organization_id: string

Defined in: types/project.ts:28

status?

optional status: string

Defined in: types/project.ts:29

name?

optional name: string

Defined in: types/project.ts:30

created_by?

optional created_by: string

Defined in: types/project.ts:31

limit?

optional limit: number

Defined in: types/project.ts:32

offset?

optional offset: number

Defined in: types/project.ts:33


ProjectStats

Defined in: types/project.ts:36

Properties

total_projects

total_projects: number

Defined in: types/project.ts:37

active_projects

active_projects: number

Defined in: types/project.ts:38

inactive_projects

inactive_projects: number

Defined in: types/project.ts:39

completed_projects

completed_projects: number

Defined in: types/project.ts:40

projects_by_status

projects_by_status: Record<string, number>

Defined in: types/project.ts:41


ProjectWithOrganization

Defined in: types/project.ts:44

Extends

Properties

project_id

project_id: string

Defined in: types/project.ts:3

Inherited from

Project.project_id

organization_id

organization_id: string

Defined in: types/project.ts:4

Inherited from

Project.organization_id

name

name: string

Defined in: types/project.ts:5

Inherited from

Project.name

description?

optional description: string

Defined in: types/project.ts:6

Inherited from

Project.description

status

status: string

Defined in: types/project.ts:7

Inherited from

Project.status

created_at

created_at: Date

Defined in: types/project.ts:8

Inherited from

Project.created_at

updated_at

updated_at: Date

Defined in: types/project.ts:9

Inherited from

Project.updated_at

created_by?

optional created_by: string

Defined in: types/project.ts:10

Inherited from

Project.created_by

organization_name

organization_name: string

Defined in: types/project.ts:45

organization_slug

organization_slug: string

Defined in: types/project.ts:46

creator_name?

optional creator_name: string

Defined in: types/project.ts:47

creator_email?

optional creator_email: string

Defined in: types/project.ts:48


ProjectResponse

Defined in: types/project.ts:52

Properties

id

id: string

Defined in: types/project.ts:53

organizationId

organizationId: string

Defined in: types/project.ts:54

name

name: string

Defined in: types/project.ts:55

description?

optional description: string

Defined in: types/project.ts:56

status

status: string

Defined in: types/project.ts:57

createdAt

createdAt: Date

Defined in: types/project.ts:58

updatedAt

updatedAt: Date

Defined in: types/project.ts:59

createdBy?

optional createdBy: string

Defined in: types/project.ts:60


CreateProjectRequest

Defined in: types/project.ts:63

Properties

name

name: string

Defined in: types/project.ts:64

description?

optional description: string

Defined in: types/project.ts:65

status?

optional status: string

Defined in: types/project.ts:66


UpdateProjectRequest

Defined in: types/project.ts:69

Properties

name?

optional name: string

Defined in: types/project.ts:70

description?

optional description: string

Defined in: types/project.ts:71

status?

optional status: string

Defined in: types/project.ts:72


ProjectMember

Defined in: types/project.ts:76

Extended by

Properties

assignment_id

assignment_id: string

Defined in: types/project.ts:77

project_id

project_id: string

Defined in: types/project.ts:78

user_id

user_id: string

Defined in: types/project.ts:79

project_role_id

project_role_id: string

Defined in: types/project.ts:80

assigned_by?

optional assigned_by: string

Defined in: types/project.ts:81

assigned_at

assigned_at: Date

Defined in: types/project.ts:82

is_active

is_active: boolean

Defined in: types/project.ts:83

created_at

created_at: Date

Defined in: types/project.ts:84

updated_at

updated_at: Date

Defined in: types/project.ts:85


ProjectMemberWithDetails

Defined in: types/project.ts:88

Extends

Properties

assignment_id

assignment_id: string

Defined in: types/project.ts:77

Inherited from

ProjectMember.assignment_id

project_id

project_id: string

Defined in: types/project.ts:78

Inherited from

ProjectMember.project_id

user_id

user_id: string

Defined in: types/project.ts:79

Inherited from

ProjectMember.user_id

project_role_id

project_role_id: string

Defined in: types/project.ts:80

Inherited from

ProjectMember.project_role_id

assigned_by?

optional assigned_by: string

Defined in: types/project.ts:81

Inherited from

ProjectMember.assigned_by

assigned_at

assigned_at: Date

Defined in: types/project.ts:82

Inherited from

ProjectMember.assigned_at

is_active

is_active: boolean

Defined in: types/project.ts:83

Inherited from

ProjectMember.is_active

created_at

created_at: Date

Defined in: types/project.ts:84

Inherited from

ProjectMember.created_at

updated_at

updated_at: Date

Defined in: types/project.ts:85

Inherited from

ProjectMember.updated_at

user_email

user_email: string

Defined in: types/project.ts:89

first_name?

optional first_name: string

Defined in: types/project.ts:90

last_name?

optional last_name: string

Defined in: types/project.ts:91

role_name

role_name: string

Defined in: types/project.ts:92

role_description?

optional role_description: string

Defined in: types/project.ts:93


AddProjectMemberData

Defined in: types/project.ts:96

Properties

project_id

project_id: string

Defined in: types/project.ts:97

user_id

user_id: string

Defined in: types/project.ts:98

project_role_id

project_role_id: string

Defined in: types/project.ts:99

assigned_by?

optional assigned_by: string

Defined in: types/project.ts:100


UpdateProjectMemberData

Defined in: types/project.ts:103

Properties

project_role_id?

optional project_role_id: string

Defined in: types/project.ts:104

is_active?

optional is_active: boolean

Defined in: types/project.ts:105


ProjectMemberFilters

Defined in: types/project.ts:108

Properties

project_id?

optional project_id: string

Defined in: types/project.ts:109

role_name?

optional role_name: string

Defined in: types/project.ts:110

is_active?

optional is_active: boolean

Defined in: types/project.ts:111

limit?

optional limit: number

Defined in: types/project.ts:112

offset?

optional offset: number

Defined in: types/project.ts:113


ProjectMemberResponse

Defined in: types/project.ts:121

Properties

assignmentId

assignmentId: string

Defined in: types/project.ts:122

projectId

projectId: string

Defined in: types/project.ts:123

userId

userId: string

Defined in: types/project.ts:124

userEmail

userEmail: string

Defined in: types/project.ts:125

firstName?

optional firstName: string

Defined in: types/project.ts:126

lastName?

optional lastName: string

Defined in: types/project.ts:127

roleName

roleName: string

Defined in: types/project.ts:128

roleDescription?

optional roleDescription: string

Defined in: types/project.ts:129

assignedAt

assignedAt: Date

Defined in: types/project.ts:130

assignedBy?

optional assignedBy: string

Defined in: types/project.ts:131

isActive

isActive: boolean

Defined in: types/project.ts:132


AddProjectMemberRequest

Defined in: types/project.ts:135

Properties

userId

userId: string

Defined in: types/project.ts:136

roleId

roleId: string

Defined in: types/project.ts:137


UpdateProjectMemberRequest

Defined in: types/project.ts:140

Properties

roleId?

optional roleId: string

Defined in: types/project.ts:141

isActive?

optional isActive: boolean

Defined in: types/project.ts:142

Type Aliases

ProjectRole

ProjectRole = "admin" | "member" | "viewer"

Defined in: types/project.ts:116


ProjectPermission

ProjectPermission = "admin" | "write" | "read"

Defined in: types/project.ts:118