idea-toolbox/dist/src/membership.model.d.ts

IDEA's utility functions

import { Resource } from './resource.model';
/**
 * This class serve two purposes:
 *  1. To represent the resource IDEA Membership, which is stored in the table below.
 *  2. To give a generic representation to the concept of Membership in IDEA's project.
 *
 * Table: `idea_teams_users`.
 *
 * Indexes:
 *    - `userId-index`.
 */
export declare class Membership extends Resource {
    /**
     * The id of the team.
     */
    teamId: string;
    /**
     * The id of the user (Cognito sub).
     */
    userId: string;
    /**
     * The name of the user in the team.
     * In generic scenarios, it's usually the user's email address.
     */
    name: string;
    /**
     * If set, a short representation of the name, through initials.
     */
    initials?: string;
    /**
     * Whether the user has still to accept the invitation to join the team.
     */
    pendingInvitation?: boolean;
    load(x: any): void;
    safeLoad(newData: any, safeData: any): void;
    validate(): string[];
}
/**
 * Minimal info on the membership, to attach to other entities.
 */
export declare class MembershipSummary extends Resource {
    /**
     * The id of the member of the team.
     */
    userId: string;
    /**
     * The name of the member of the team.
     * In generic scenarios, it's usually the user's email address.
     */
    name: string;
    /**
     * If set, a short representation of the name, through initials.
     */
    initials?: string;
    load(x: any): void;
    validate(): string[];
}