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

    Interface UnifiedDataModel

    interface UnifiedDataModel {
        singularName: string;
        pluralName: string;
        fieldsSchema: any;
        description?: string;
        categories?: (
            | "Accounting"
            | "Ads"
            | "Analytics"
            | "ATS"
            | "Communication"
            | "CRM"
            | "Customer Success"
            | "Document Management"
            | "E-Commerce"
            | "E-Signature"
            | "ERP"
            | "File Storage"
            | "HRIS"
            | "Legal"
            | "Marketing Automation"
            | "Payments"
            | "Project Management"
            | "Sales"
            | "Ticketing"
        )[];
        normalizeFields?: (fields: Record<string, any>) => Record<string, any>;
        populateFields?: (fields: Record<string, any>) => Record<string, any>;
        list?: {
            apiRequests?: { path: unknown; method: unknown }[];
            filterFields?: string[];
        };
        find?: {
            apiRequests?: { path: unknown; method: unknown }[];
            queryFields?: string[];
        };
        match?: {
            apiRequests?: { path: unknown; method: unknown }[];
            fields?: string[];
        };
        create?: {
            apiRequests?: { path: unknown; method: unknown }[];
            fields?: string[];
            requiredFields?: string[];
            excludedFields?: string[];
        };
        update?: {
            apiRequests?: { path: unknown; method: unknown }[];
            fields?: string[];
            excludedFields?: string[];
        };
        delete?: { apiRequests?: { path: unknown; method: unknown }[] };
        udmFallbacks?: UDMFallback[];
        fieldFallbacks?: Record<string, FieldFallbackValues>;
    }
    Index

    Properties

    singularName: string
    pluralName: string
    fieldsSchema: any
    description?: string
    categories?: (
        | "Accounting"
        | "Ads"
        | "Analytics"
        | "ATS"
        | "Communication"
        | "CRM"
        | "Customer Success"
        | "Document Management"
        | "E-Commerce"
        | "E-Signature"
        | "ERP"
        | "File Storage"
        | "HRIS"
        | "Legal"
        | "Marketing Automation"
        | "Payments"
        | "Project Management"
        | "Sales"
        | "Ticketing"
    )[]
    normalizeFields?: (fields: Record<string, any>) => Record<string, any>

    Normalize field values. For example, normalize phone numbers to E.164 format.

    populateFields?: (fields: Record<string, any>) => Record<string, any>

    Using dependencies between fields, populates missing fields. For example, if primaryEmail is missing, it will be populated from emails.

    list?: {
        apiRequests?: { path: unknown; method: unknown }[];
        filterFields?: string[];
    }
    find?: {
        apiRequests?: { path: unknown; method: unknown }[];
        queryFields?: string[];
    }
    match?: {
        apiRequests?: { path: unknown; method: unknown }[];
        fields?: string[];
    }
    create?: {
        apiRequests?: { path: unknown; method: unknown }[];
        fields?: string[];
        requiredFields?: string[];
        excludedFields?: string[];
    }
    update?: {
        apiRequests?: { path: unknown; method: unknown }[];
        fields?: string[];
        excludedFields?: string[];
    }
    delete?: { apiRequests?: { path: unknown; method: unknown }[] }
    udmFallbacks?: UDMFallback[]
    fieldFallbacks?: Record<string, FieldFallbackValues>