Interface ConnectorDataCollection

interface ConnectorDataCollection {
    type: "collection";
    fieldsSchema?: DataSchema;
    isHidden?: boolean;
    customFields?: boolean;
    customFieldsSchema?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    spec?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    recordFromFields?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    fieldsFromApi?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    recordFromApi?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    recordFromApiCode?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    recordFromApiMapping?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    recordToApi?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    fieldsToApi?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    fieldsToApiCode?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    fieldsToApiMapping?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    methods?: {
        list?: ConnectorDataLocationMethod<
            DataCollectionListConfigType,
            ConnectorMethodImplementationBase,
        >;
        findById?: ConnectorDataLocationMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        match?: ConnectorDataLocationMethod<
            DataCollectionMatchConfigType,
            ConnectorMethodImplementationBase,
        >;
        search?: ConnectorDataLocationMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        create?: ConnectorDataLocationMethod<
            DataCollectionCreateConfigType,
            ConnectorMethodImplementationBase,
        >;
        update?: ConnectorDataLocationMethod<
            DataCollectionUpdateConfigType,
            ConnectorMethodImplementationBase,
        >;
        delete?: ConnectorDataLocationMethod<
            unknown,
            ConnectorMethodImplementationBase,
        >;
        find?: ConnectorDataLocationMethod<
            { queryFields?: string[] },
            ConnectorMethodImplementationBase,
        >;
    };
    events?: Partial<
        Record<
            "created"
            | "updated"
            | "deleted",
            ConnectorDataCollectionEvent<
                BaseConnectorDataCollectionEventImplementationFields,
            >,
        >,
    >;
    udm?: Partial<
        Record<
            string,
            {
                extract?: ConnectorDataLocationMethod<
                    unknown,
                    ConnectorMethodImplementationBase,
                >;
                parse?: ConnectorDataLocationMethod<
                    unknown,
                    ConnectorMethodImplementationBase,
                >;
            },
        >,
    >;
    key: string;
    name: string;
    parametersSchema?: DataSchema;
    extends?: DataLocationMixin[];
    relatedOperationKeys?: string[];
}

Hierarchy (View Summary, Expand)

Properties

type: "collection"
fieldsSchema?: DataSchema
isHidden?: boolean
customFields?: boolean
customFieldsSchema?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
recordFromFields?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
fieldsFromApi?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
recordFromApi?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
recordFromApiCode?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
recordFromApiMapping?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
recordToApi?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
fieldsToApi?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
fieldsToApiCode?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
fieldsToApiMapping?: ConnectorDataLocationMethod<
    unknown,
    ConnectorMethodImplementationBase,
>
methods?: {
    list?: ConnectorDataLocationMethod<
        DataCollectionListConfigType,
        ConnectorMethodImplementationBase,
    >;
    findById?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    match?: ConnectorDataLocationMethod<
        DataCollectionMatchConfigType,
        ConnectorMethodImplementationBase,
    >;
    search?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    create?: ConnectorDataLocationMethod<
        DataCollectionCreateConfigType,
        ConnectorMethodImplementationBase,
    >;
    update?: ConnectorDataLocationMethod<
        DataCollectionUpdateConfigType,
        ConnectorMethodImplementationBase,
    >;
    delete?: ConnectorDataLocationMethod<
        unknown,
        ConnectorMethodImplementationBase,
    >;
    find?: ConnectorDataLocationMethod<
        { queryFields?: string[] },
        ConnectorMethodImplementationBase,
    >;
}
events?: Partial<
    Record<
        "created"
        | "updated"
        | "deleted",
        ConnectorDataCollectionEvent<
            BaseConnectorDataCollectionEventImplementationFields,
        >,
    >,
>
udm?: Partial<
    Record<
        string,
        {
            extract?: ConnectorDataLocationMethod<
                unknown,
                ConnectorMethodImplementationBase,
            >;
            parse?: ConnectorDataLocationMethod<
                unknown,
                ConnectorMethodImplementationBase,
            >;
        },
    >,
>
key: string
name: string
parametersSchema?: DataSchema
extends?: DataLocationMixin[]
relatedOperationKeys?: string[]
MMNEPVFCICPMFPCPTTAAATR