Interface GongNodeParameters

Source
interface GongNodeParameters {
    authentication?: "oAuth2" | "accessToken";
    call?: { mode: "id" | "list" | "url"; value: string };
    filters?:
        | {
            callIds?: string;
            fromDateTime?: string;
            primaryUserIds?: {
                mode: "id"
                | "list";
                value: string;
            };
            toDateTime?: string;
            workspaceId?: string;
        }
        | {
            createdFromDateTime?: string;
            createdToDateTime?: string;
            userIds?: string;
        };
    limit?: number;
    operation?: "get"
    | "getAll";
    options?:
        | {
            properties?: (
                | "pointsOfInterest"
                | "media"
                | "brief"
                | "publicComments"
                | "highlights"
                | "keyPoints"
                | "callOutcome"
                | "outline"
                | "parties"
                | "structure"
                | "topics"
                | "trackers"
                | "transcript"
            )[];
        }
        | { properties?: ("parties" | "topics")[] };
    resource?: "user" | "call";
    returnAll?: boolean;
    user?: { mode: "id" | "list"; value: string };
}

Properties§

§readonly authentication?: "oAuth2" | "accessToken"

Default: "accessToken"

§readonly call?: { ... }

Default: {"mode":"list","value":""}

§readonly filters?:
    | {
        callIds?: string;
        fromDateTime?: string;
        primaryUserIds?: {
            mode: "id"
            | "list";
            value: string;
        };
        toDateTime?: string;
        workspaceId?: string;
    }
    | {
        createdFromDateTime?: string;
        createdToDateTime?: string;
        userIds?: string;
    }

Default: {}

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly operation?: "get" | "getAll"

Default: "getAll"

§readonly options?:
    | {
        properties?: (
            | "pointsOfInterest"
            | "media"
            | "brief"
            | "publicComments"
            | "highlights"
            | "keyPoints"
            | "callOutcome"
            | "outline"
            | "parties"
            | "structure"
            | "topics"
            | "trackers"
            | "transcript"
        )[];
    }
    | { properties?: ("parties" | "topics")[] }

Default: {}

§readonly resource?: "user" | "call"

Default: "call"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly user?: { ... }

Default: {"mode":"list","value":""}