Interface Organization

interface Organization {
    addressLine1: string;
    addressLine2: string;
    addressLine3: string;
    ancestorIds: string[];
    ancestorNamePath: string;
    auditStatus: "waiting_for_review" | "in_review" | "rejected" | "approved" | "change_requested" | "waiting_for_change_review";
    branchName: string;
    certificateImageId: string;
    certifiedQualifications: Qualification[];
    childrenCount: number;
    createdAt: Date;
    customFields: Record<string, unknown>;
    depth: number;
    description: string;
    iconImageId: string;
    id: string;
    logoImageId: string;
    name: string;
    numberOfProjects: string;
    parentId: null | string;
    phoneNumber: string;
    pictureUrl: string;
    postalCode: string;
    qualifications: Qualification[];
    reviewStats?: {
        averageRate?: number;
        averageSubRates?: Record<string, number>;
        totalCount?: number;
    };
    size: string;
    status: "cancelled" | "normal" | "restricted" | "prohibited";
    typeId: string;
    updatedAt: Date;
    url: string;
    users: OrganizationUser[];
}

Hierarchy (view full)

Implemented by

Properties

addressLine1 addressLine2 addressLine3 ancestorIds ancestorNamePath auditStatus branchName certificateImageId certifiedQualifications childrenCount createdAt customFields depth description iconImageId id logoImageId name numberOfProjects parentId phoneNumber pictureUrl postalCode qualifications reviewStats? size status typeId updatedAt url users

Properties

addressLine1

addressLine1: string

addressLine2

addressLine2: string

addressLine3

addressLine3: string

ancestorIds

ancestorIds: string[]

The ancestor organization IDs (in order from root to this organization)

ancestorNamePath

ancestorNamePath: string

The ancestor organization name path (comma separated name path, starting from root)

auditStatus

auditStatus: "waiting_for_review" | "in_review" | "rejected" | "approved" | "change_requested" | "waiting_for_change_review"

branchName

branchName: string

certificateImageId

certificateImageId: string

certifiedQualifications

certifiedQualifications: Qualification[]

childrenCount

childrenCount: number

The number of children this organization has

createdAt

createdAt: Date

customFields

customFields: Record<string, unknown>

depth

depth: number

The depth that this organization is in the tree

description

description: string

iconImageId

iconImageId: string

id

id: string

logoImageId

logoImageId: string

name

name: string

numberOfProjects

numberOfProjects: string

parentId

parentId: null | string

The parent organization's ID

phoneNumber

phoneNumber: string

pictureUrl

pictureUrl: string

postalCode

postalCode: string

qualifications

qualifications: Qualification[]

Optional reviewStats

reviewStats?: {
    averageRate?: number;
    averageSubRates?: Record<string, number>;
    totalCount?: number;
}

Type declaration

  • Optional averageRate?: number
  • Optional averageSubRates?: Record<string, number>
  • Optional totalCount?: number

size

size: string

status

status: "cancelled" | "normal" | "restricted" | "prohibited"

typeId

typeId: string

updatedAt

updatedAt: Date

url

url: string

users

users: OrganizationUser[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc