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

    Interface WorkspaceExport

    interface WorkspaceExport {
        "app-data-schema": {
            instanceKey?: string;
            schema?: any;
            code?: string;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
        }[];
        "app-event-type": {
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
        }[];
        "data-link-table": {
            instanceKey?: string;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
        }[];
        integration: {
            logoUri?: string;
            externalAppUuid?: string;
            appUuid?: string;
            oAuthCallbackUri?: string;
            logoBase64?: string;
            connectorVersion?: string;
            connectorUuid?: string;
            connectorKey?: string;
            optionsConfig?: Record<
                string,
                { disabled?: boolean; parameters?: Record<string, any> },
            >;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
        }[];
        "data-source": {
            instanceKey?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            path?: string;
            defaultPath?: string;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            externalAppUuid?: string;
            isCustomized?: boolean;
            isUniversal?: boolean;
        }[];
        "field-mapping": {
            instanceKey?: string;
            dataSourceUuid?: string;
            dataSourceKey?: string;
            appSchema?: DataSchema;
            direction?: IMPORT
            | EXPORT
            | BOTH;
            defaultImportValue?: any;
            defaultExportValue?: any;
            importValue?: any;
            exportValue?: any;
            unifiedImportValue?: any;
            unifiedExportValue?: any;
            frozenImportFields?: any;
            frozenExportFields?: any;
            frozenUnifiedExportFields?: any;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            externalAppUuid?: string;
            isCustomized?: boolean;
            isUniversal?: boolean;
        }[];
        action: {
            instanceKey?: string;
            inputSchema?: DataSchema;
            type?: | ListDataRecords
            | FindDataRecordById
            | MatchDataRecord
            | CreateDataRecord
            | FindOrCreateDataRecord
            | UpdateDataRecord
            | DeleteDataRecord
            | SearchDataRecords
            | ConnectorOperation
            | ApiRequestToExternalApp
            | ApiRequestToYourApp
            | HttpRequest
            | RunJavascript
            | ApiRequest;
            config?: { [key: string]: unknown };
            outputMapping?: any;
            customOutputSchema?: DataSchema;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            externalAppUuid?: string;
            isCustomized?: boolean;
            isUniversal?: boolean;
        }[];
        flow: {
            instanceKey?: string;
            parametersSchema?: DataSchema;
            parameters?: any;
            enabled?: boolean;
            nodes?: Record<
                string,
                {
                    type?: string;
                    version?: number;
                    name?: string;
                    description?: string;
                    config?: any;
                    concurrency?: number;
                    onError?: "continue"
                    | "stop";
                    ui?: any;
                    inputSchema?: any;
                    outputSchema?: any;
                    outputExample?: any;
                    links?: { key?: string; filter?: any; name?: string }[];
                    isCustomized?: boolean;
                    state?: SETUP_FAILED | READY;
                    errors?: ErrorDataSchema[];
                    userConfig?: any;
                    testInput?: any;
                    dependencies?: any[];
                },
            >;
            autoCreateInstances?: boolean;
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            externalAppUuid?: string;
            isCustomized?: boolean;
            isUniversal?: boolean;
        }[];
        package: {
            elements?: { uuid: string; type: WorkspaceElementType; element?: any }[];
            uuid: string;
            key: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            externalAppUuid?: string;
            isCustomized?: boolean;
            isUniversal?: boolean;
        }[];
    }
    Index

    Properties

    "app-data-schema": {
        instanceKey?: string;
        schema?: any;
        code?: string;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
    }[]
    "app-event-type": {
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
    }[]
    "data-link-table": {
        instanceKey?: string;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
    }[]
    integration: {
        logoUri?: string;
        externalAppUuid?: string;
        appUuid?: string;
        oAuthCallbackUri?: string;
        logoBase64?: string;
        connectorVersion?: string;
        connectorUuid?: string;
        connectorKey?: string;
        optionsConfig?: Record<
            string,
            { disabled?: boolean; parameters?: Record<string, any> },
        >;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
    }[]
    "data-source": {
        instanceKey?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        path?: string;
        defaultPath?: string;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationUuid?: string;
        parentUuid?: string;
        externalAppUuid?: string;
        isCustomized?: boolean;
        isUniversal?: boolean;
    }[]
    "field-mapping": {
        instanceKey?: string;
        dataSourceUuid?: string;
        dataSourceKey?: string;
        appSchema?: DataSchema;
        direction?: IMPORT | EXPORT | BOTH;
        defaultImportValue?: any;
        defaultExportValue?: any;
        importValue?: any;
        exportValue?: any;
        unifiedImportValue?: any;
        unifiedExportValue?: any;
        frozenImportFields?: any;
        frozenExportFields?: any;
        frozenUnifiedExportFields?: any;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationUuid?: string;
        parentUuid?: string;
        externalAppUuid?: string;
        isCustomized?: boolean;
        isUniversal?: boolean;
    }[]
    action: {
        instanceKey?: string;
        inputSchema?: DataSchema;
        type?:
            | ListDataRecords
            | FindDataRecordById
            | MatchDataRecord
            | CreateDataRecord
            | FindOrCreateDataRecord
            | UpdateDataRecord
            | DeleteDataRecord
            | SearchDataRecords
            | ConnectorOperation
            | ApiRequestToExternalApp
            | ApiRequestToYourApp
            | HttpRequest
            | RunJavascript
            | ApiRequest;
        config?: { [key: string]: unknown };
        outputMapping?: any;
        customOutputSchema?: DataSchema;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationUuid?: string;
        parentUuid?: string;
        externalAppUuid?: string;
        isCustomized?: boolean;
        isUniversal?: boolean;
    }[]
    flow: {
        instanceKey?: string;
        parametersSchema?: DataSchema;
        parameters?: any;
        enabled?: boolean;
        nodes?: Record<
            string,
            {
                type?: string;
                version?: number;
                name?: string;
                description?: string;
                config?: any;
                concurrency?: number;
                onError?: "continue"
                | "stop";
                ui?: any;
                inputSchema?: any;
                outputSchema?: any;
                outputExample?: any;
                links?: { key?: string; filter?: any; name?: string }[];
                isCustomized?: boolean;
                state?: SETUP_FAILED | READY;
                errors?: ErrorDataSchema[];
                userConfig?: any;
                testInput?: any;
                dependencies?: any[];
            },
        >;
        autoCreateInstances?: boolean;
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationUuid?: string;
        parentUuid?: string;
        externalAppUuid?: string;
        isCustomized?: boolean;
        isUniversal?: boolean;
    }[]

    Type Declaration

    • OptionalinstanceKey?: string
    • OptionalparametersSchema?: DataSchema

      DataSchema of parameters provided during the flow creation. Can be used to configure the flow logic.

    • Optionalparameters?: any
    • Optionalenabled?: boolean
    • Optionalnodes?: Record<
          string,
          {
              type?: string;
              version?: number;
              name?: string;
              description?: string;
              config?: any;
              concurrency?: number;
              onError?: "continue"
              | "stop";
              ui?: any;
              inputSchema?: any;
              outputSchema?: any;
              outputExample?: any;
              links?: { key?: string; filter?: any; name?: string }[];
              isCustomized?: boolean;
              state?: SETUP_FAILED | READY;
              errors?: ErrorDataSchema[];
              userConfig?: any;
              testInput?: any;
              dependencies?: any[];
          },
      >

      Flow Nodes in the format :

    • OptionalautoCreateInstances?: boolean

      Automatically create a Flow Instance when a Connection is created.

    • uuid: string
    • key: string
    • Optionalname?: string
    • Optionaldescription?: string
    • Optionalmeta?: Record<string, any>
    • OptionalintegrationUuid?: string
    • OptionalparentUuid?: string
    • OptionalexternalAppUuid?: string
    • OptionalisCustomized?: boolean
    • OptionalisUniversal?: boolean
    package: {
        elements?: { uuid: string; type: WorkspaceElementType; element?: any }[];
        uuid: string;
        key: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationUuid?: string;
        parentUuid?: string;
        externalAppUuid?: string;
        isCustomized?: boolean;
        isUniversal?: boolean;
    }[]