Class OrganizationModule

Organization Module

Organization/tenant management functionality.

Remarks

This module is pending backend implementation. All methods will throw NotImplementedError until the backend endpoints are available.

Index

Constructors

Methods

getOrganization updateOrganization getOrgSettings updateOrgSettings getOrgFeatures hasFeature getOrgMembers getOrgMember getOrgUsage inviteMember removeMember

Constructors

constructor

new OrganizationModule(client: HttpClient): OrganizationModule
Parameters
- client: HttpClient
Returns OrganizationModule
- Defined in packages/core/src/organization/index.ts:39

Methods

getOrganization

getOrganization(): Promise<Organization>
Get current organization details

Returns Promise<Organization>
Organization details

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:46

updateOrganization

updateOrganization(request: UpdateOrganizationRequest): Promise<Organization>
Update organization details
Parameters
- request: UpdateOrganizationRequest
  Update request
Returns Promise<Organization>
Updated organization

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:56

getOrgSettings

getOrgSettings(): Promise<OrgSettings>
Get organization settings

Returns Promise<OrgSettings>
Organization settings

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:65

updateOrgSettings

updateOrgSettings(request: UpdateOrgSettingsRequest): Promise<OrgSettings>
Update organization settings
Parameters
- request: UpdateOrgSettingsRequest
  Partial settings to update
Returns Promise<OrgSettings>
Updated settings

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:75

getOrgFeatures

getOrgFeatures(): Promise<GetOrgFeaturesResponse>
Get organization features

Returns Promise<GetOrgFeaturesResponse>
List of features and their status

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:84

hasFeature

hasFeature(featureName: string): Promise<boolean>
Check if a specific feature is enabled
Parameters
- featureName: string
  Name of the feature to check
Returns Promise<boolean>
True if feature is enabled

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:94

getOrgMembers

getOrgMembers(options?: GetOrgMembersOptions): Promise<GetOrgMembersResponse>
Get organization members
Parameters
- Optionaloptions: GetOrgMembersOptions
  Filter and pagination options
Returns Promise<GetOrgMembersResponse>
Paginated list of members

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:104

getOrgMember

getOrgMember(memberId: string): Promise<OrgMember>
Get a specific organization member
Parameters
- memberId: string
  Member ID
Returns Promise<OrgMember>
Member details

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:114

getOrgUsage

getOrgUsage(): Promise<OrgUsage>
Get organization usage metrics

Returns Promise<OrgUsage>
Usage metrics

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:123

inviteMember

inviteMember(email: string, role: string): Promise<OrgMember>
Invite a new member to the organization
Parameters
- email: string
  Email address to invite
- role: string
  Role to assign
Returns Promise<OrgMember>
Invited member details

Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:134

removeMember

removeMember(memberId: string): Promise<void>
Remove a member from the organization
Parameters
- memberId: string
  Member ID to remove
Returns Promise<void>
Throws
NotImplementedError - Backend endpoint pending
- Defined in packages/core/src/organization/index.ts:143