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

    Interface ConnectorDataCollection

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

    Hierarchy (View Summary)

    Index

    Properties

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