Membrane SDK - v0.8.0
    Preparing search index...

    Interface ConnectorDataCollection

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

    Hierarchy (View Summary)

    Index

    Properties

    key: string
    name: string
    parametersSchema?: DataSchema
    relatedOperationKeys?: string[]
    type: "collection"
    fieldsSchema?: DataSchema
    isHidden?: boolean
    customFields?: boolean
    customFieldsSchema?: ConnectorDataCollectionMethod
    recordFromApiCode?: ConnectorDataCollectionMethod
    recordFromApiMapping?: ConnectorDataCollectionMethod
    fieldsToApiMapping?: ConnectorDataCollectionMethod
    events?: Partial<
        Record<"created" | "updated" | "deleted", ConnectorDataCollectionEvent>,
    >
    udm?: Partial<
        Record<
            string,
            {
                extract?: ConnectorDataCollectionMethod;
                parse?: ConnectorDataCollectionMethod;
            },
        >,
    >