Organization.md

@neuralinnovations/dataisland-sdk - v0.0.1-dev54 / Exports / Organization

Class: Organization

Organization.

Hierarchy

• EventDispatcher<OrganizationEvent, Organization>

  ↳ Organization

Table of contents

Constructors

• constructor

Accessors

• accessGroups
• chats
• description
• id
• name
• workspaces

Methods

• change
• createInviteCode
• dispatch
• inviteUsers
• limitSegments
• members
• membersStatistics
• organizationLimits
• statistics
• subscribe
• userLimits
• userStatistic

Constructors

constructor

• new Organization(): Organization

Returns

Organization

Inherited from

EventDispatcher.constructor

Accessors

accessGroups

• get accessGroups(): Groups

Groups.

Returns

Groups

---

chats

• get chats(): Chats

Chats.

Returns

Chats

---

description

• get description(): string

Organization description.

Returns

string

---

id

• get id(): string

Organization id.

Returns

string

---

name

• get name(): string

Organization name.

Returns

string

---

workspaces

• get workspaces(): Workspaces

Workspaces.

Returns

Workspaces

Methods

change

▸ change(name, description): Promise<void>

Change organization name and description.

Parameters

Name	Type
name	string
description	string

Returns

Promise<void>

---

createInviteCode

▸ createInviteCode(accessGroups): Promise<string>

Create invite code for users outside organization

Parameters

Name	Type
accessGroups	string[]

Returns

Promise<string>

---

dispatch

▸ dispatch(input): void

Parameters

Name	Type
input	Input<CHANGED, Organization>

Returns

void

Inherited from

EventDispatcher.dispatch

---

inviteUsers

▸ inviteUsers(emails, accessGroups): Promise<void>

Invite users with given emails to organization

Parameters

Name	Type
emails	string[]
accessGroups	string[]

Returns

Promise<void>

---

limitSegments

▸ limitSegments(): Promise<SegmentData[]>

Get all available segments data

Returns

Promise<SegmentData[]>

---

members

▸ members(): Promise<UserDto[]>

Get organization members

Returns

Promise<UserDto[]>

---

membersStatistics

▸ membersStatistics(dateFrom, dateTo): Promise<UsersStatisticsResponse>

Get organization statistics

Parameters

Name	Type
dateFrom	number
dateTo	number

Returns

Promise<UsersStatisticsResponse>

---

organizationLimits

▸ organizationLimits(): Promise<SegmentData>

Get default organization limits

Returns

Promise<SegmentData>

---

statistics

▸ statistics(dateFrom, dateTo): Promise<StatisticsResponse>

Get organization statistics

Parameters

Name	Type
dateFrom	number
dateTo	number

Returns

Promise<StatisticsResponse>

---

subscribe

▸ subscribe(callback, type?): Disposable

Parameters

Name	Type
callback	(event: Event<CHANGED, Organization>) => void
type?	CHANGED

Returns

Disposable

Inherited from

EventDispatcher.subscribe

---

userLimits

▸ userLimits(): Promise<CurrentLimitsData>

Get user limits data

Returns

Promise<CurrentLimitsData>

---

userStatistic

▸ userStatistic(userid, dateFrom, dateTo): Promise<StatisticsResponse>

Get statistics for user

Parameters

Name	Type
userid	string
dateFrom	number
dateTo	number

Returns

Promise<StatisticsResponse>