Skip to main content

Organizations

Workspace API

Workspace API / models/Organizations

models/Organizations

Functions​

createOrganization()​

createOrganization(data, log): Promise<Organization>

Defined in: models/Organizations.ts:87

Create a new organization

Parameters​

data​

CreateOrganizationData

log​

Logger = logger

Returns​

Promise<Organization>

findById()​

findById(organizationId): Promise<Organization | null>

Defined in: models/Organizations.ts:155

Find organization by ID

Parameters​

organizationId​

string

Returns​

Promise<Organization | null>

findBySlug()​

findBySlug(slug): Promise<Organization | null>

Defined in: models/Organizations.ts:167

Find organization by slug

Parameters​

slug​

string

Returns​

Promise<Organization | null>

findByEmail()​

findByEmail(email): Promise<Organization | null>

Defined in: models/Organizations.ts:178

Find organization by email

Parameters​

email​

string

Returns​

Promise<Organization | null>

updateOrganization()​

updateOrganization(organizationId, updateData): Promise<Organization | null>

Defined in: models/Organizations.ts:189

Update organization information

Parameters​

organizationId​

string

updateData​

UpdateOrganizationData

Returns​

Promise<Organization | null>

deleteOrganization()​

deleteOrganization(organizationId): Promise<boolean>

Defined in: models/Organizations.ts:283

Delete organization (soft delete by setting status to inactive)

Parameters​

organizationId​

string

Returns​

Promise<boolean>

permanentlyDeleteOrganization()​

permanentlyDeleteOrganization(organizationId, log): Promise<boolean>

Defined in: models/Organizations.ts:299

Permanently delete organization (hard delete) All related records in app database are automatically deleted via CASCADE foreign key constraints. RAG database records must be cleaned up manually (no cross-database FKs).

Parameters​

organizationId​

string

log​

Logger = logger

Returns​

Promise<boolean>

getOrganizations()​

getOrganizations(filters): Promise<{ organizations: Organization[]; total: number; }>

Defined in: models/Organizations.ts:354

Get organizations with filters and pagination

Parameters​

filters​

OrganizationFilters = {}

Returns​

Promise<{ organizations: Organization[]; total: number; }>

getUserOrganizations()​

getUserOrganizations(userId): Promise<Organization & object[]>

Defined in: models/Organizations.ts:403

Get user's organizations (returns organization info with user's role)

Parameters​

userId​

string

Returns​

Promise<Organization & object[]>

getOrganizationMembers()​

getOrganizationMembers(organizationId): Promise<OrganizationMember[]>

Defined in: models/Organizations.ts:430

Get organization members (returns user info with their role in organization)

Parameters​

organizationId​

string

Returns​

Promise<OrganizationMember[]>

getOrganizationMembersWithDetails()​

getOrganizationMembersWithDetails(organizationId): Promise<OrganizationMemberWithDetails[]>

Defined in: models/Organizations.ts:455

Parameters​

organizationId​

string

Returns​

Promise<OrganizationMemberWithDetails[]>

userHasAccess()​

userHasAccess(organizationId, userId): Promise<boolean>

Defined in: models/Organizations.ts:487

Check if user has access to organization

Parameters​

organizationId​

string

userId​

string

Returns​

Promise<boolean>

getOrganizationStats()​

getOrganizationStats(organizationId): Promise<OrganizationStats>

Defined in: models/Organizations.ts:501

Get organization statistics

Parameters​

organizationId​

string

Returns​

Promise<OrganizationStats>

isSlugAvailable()​

isSlugAvailable(slug): Promise<boolean>

Defined in: models/Organizations.ts:542

Check if organization slug is available

Parameters​

slug​

string

Returns​

Promise<boolean>

generateOrganizationId()​

generateOrganizationId(): string

Defined in: models/Organizations.ts:553

Generate a secure organization ID

Returns​

string

getOrganizationAddress()​

getOrganizationAddress(org): string

Defined in: models/Organizations.ts:560

Get organization's full address

Parameters​

org​

Organization

Returns​

string

isOrganizationActive()​

isOrganizationActive(org): boolean

Defined in: models/Organizations.ts:576

Check if organization is active

Parameters​

org​

Organization

Returns​

boolean

isOrganizationInTrial()​

isOrganizationInTrial(org): boolean

Defined in: models/Organizations.ts:583

Check if organization is in trial

Parameters​

org​

Organization

Returns​

boolean

createOrganizationWithAdmin()​

createOrganizationWithAdmin(data, client?, log?): Promise<{ organization: Organization; userOrganization: UserOrganization; }>

Defined in: models/Organizations.ts:590

Create organization with user as admin (for registration flow)

Parameters​

data​

CreateOrganizationData & object

client?​

any

log?​

Logger = logger

Returns​

Promise<{ organization: Organization; userOrganization: UserOrganization; }>