Class DataSourceInstanceAccessor

Hierarchy (View Summary)

ElementInstanceAccessor<
    DataSourceInstance,
    DataSourceInstanceSelector,
    CreateDataSourceInstanceRequest,
    UpdateDataSourceInstanceRequest,
>
- DataSourceInstanceAccessor

Index

Constructors

constructor

new DataSourceInstanceAccessor(
client: MembraneApiClient,
selector: string | DataSourceInstanceSelector,
): DataSourceInstanceAccessor
Parameters
- client: MembraneApiClient
- selector: string | DataSourceInstanceSelector
Returns DataSourceInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5666

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4018

get

get(): Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Returns Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Inherited from ElementInstanceAccessor.get
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4019

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4020

create

create(
    data?: { dataSourceId: string; connectionId: string; path?: string },
): Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Parameters
- Optionaldata: { dataSourceId: string; connectionId: string; path?: string }
Returns Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Inherited from ElementInstanceAccessor.create
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4021

put

put(
    data: { dataSourceId: string; connectionId: string; path?: string },
): Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Parameters
- data: { dataSourceId: string; connectionId: string; path?: string }
Returns Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Inherited from ElementInstanceAccessor.put
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4022

patch

patch(
    data: {
        path?: string;
        collectionKey?: string;
        collectionParameters?: any;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean };
    },
): Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Parameters
- data: {
      path?: string;
      collectionKey?: string;
      collectionParameters?: any;
      pullUpdatesIntervalSeconds?: number;
      fullSyncIntervalSeconds?: number;
      subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean };
  }
Returns Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Inherited from ElementInstanceAccessor.patch
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4023

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.delete
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4025

restore

restore(): Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Returns Promise<
    {
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
        userId: string;
        revision: string;
        dataSourceRevision?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        connectionId: string;
        integrationId: string;
        instanceKey?: string;
        collectionKey?: string;
        collectionParameters?: any;
        defaultCollectionKey?: string;
        defaultCollectionParameters?: any;
        collectionSpec?: {
            type: "collection";
            key?: string;
            name: string;
            parametersSchema?: DataSchema;
            fieldsSchema?: DataSchema;
            list?: {
                apiRequests?: { path: unknown; method: unknown }[];
                filterFields?: string[];
            };
            search?: { apiRequests?: { path: unknown; method: unknown }[] };
            match?: {
                apiRequests?: { path: unknown; method: unknown }[];
                fields?: string[];
            };
            findById?: { apiRequests?: { path: unknown; method: unknown }[] };
            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 }[] };
            events?: {
                created?: {
                    type: "push" | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                updated?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                deleted?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                all?: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
                [key: string]: {
                    type: "push"
                    | "pull";
                    isFullScan?: boolean;
                    isIdOnly?: boolean;
                };
            };
            customFields?: boolean;
            udm?: Record<
                string,
                {
                    fields?: string[];
                    extract?: Record<string, any>;
                    parse?: Record<string, any>;
                },
            >;
            find?: {
                apiRequests?: { path: unknown; method: unknown }[];
                queryFields?: string[];
            };
        };
        isCustomized?: boolean;
        errors?: ErrorDataSchema[];
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        path?: string;
        defaultPath?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        dataSource?: {
            id: string;
            key?: string;
            description?: string;
            instanceKey?: string;
            integrationId?: string;
            uuid?: string;
            meta?: Record<string, any>;
            integrationUuid?: string;
            parentUuid?: string;
            connectionId?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            isCustomized?: boolean;
            universalDataSourceRevision?: string;
        };
        connection?: {
            id: string;
            name: string;
            userId: string;
            isTest?: boolean;
            disconnected?: boolean;
            isDefunct?: boolean;
            state?: CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY;
            error?: ErrorDataSchema;
            integrationId: string;
            authOptionKey?: string;
            createdAt: string;
            updatedAt: string;
            lastActiveAt?: string;
            nextCredentialsRefreshAt?: string;
            nextRetryTimestamp?: string;
            retryAttempts?: number;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
        };
        integration?: {
            id: string;
            uuid?: string;
            key?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            logoUri: string;
            connectorId?: string;
            connectorVersion?: string;
            oAuthCallbackUri?: string;
            parameters?: any;
            archivedAt?: string;
            hasMissingParameters?: boolean;
            hasDocumentation?: boolean;
            hasOperations?: boolean;
            operationsCount?: number;
            hasData?: boolean;
            dataCollectionsCount?: number;
            hasEvents?: boolean;
            eventsCount?: number;
            hasGlobalWebhooks?: boolean;
            hasUdm?: boolean;
            isTest?: boolean;
            appUuid?: string;
            isDeactivated?: boolean;
            authType?:
                | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
        };
    },
>
Inherited from ElementInstanceAccessor.restore
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4026

`Protected`getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:4027

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5667

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5668

openConfiguration

openConfiguration(
__namedParameters?: OpenDataSourceConfigurationOptions,
): Promise<void>
Parameters
- Optional__namedParameters: OpenDataSourceConfigurationOptions
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5669

unifiedFieldsToNative

unifiedFieldsToNative(unifiedFields: any): Promise<any>
Parameters
- unifiedFields: any
Returns Promise<any>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5670

getCollection

getCollection(): Promise<
    {
        type: "collection";
        key?: string;
        name: string;
        parametersSchema?: DataSchema;
        fieldsSchema?: DataSchema;
        list?: {
            apiRequests?: { path: unknown; method: unknown }[];
            filterFields?: string[];
        };
        search?: { apiRequests?: { path: unknown; method: unknown }[] };
        match?: {
            apiRequests?: { path: unknown; method: unknown }[];
            fields?: string[];
        };
        findById?: { apiRequests?: { path: unknown; method: unknown }[] };
        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 }[] };
        events?: {
            created?: {
                type: "push" | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            updated?: {
                type: "push"
                | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            deleted?: {
                type: "push"
                | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            all?: { type: "push"
            | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
            [key: string]: {
                type: "push" | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
        };
        customFields?: boolean;
        udm?: Record<
            string,
            {
                fields?: string[];
                extract?: Record<string, any>;
                parse?: Record<string, any>;
            },
        >;
        find?: {
            apiRequests?: { path: unknown; method: unknown }[];
            queryFields?: string[];
        };
    },
>
Returns Promise<
    {
        type: "collection";
        key?: string;
        name: string;
        parametersSchema?: DataSchema;
        fieldsSchema?: DataSchema;
        list?: {
            apiRequests?: { path: unknown; method: unknown }[];
            filterFields?: string[];
        };
        search?: { apiRequests?: { path: unknown; method: unknown }[] };
        match?: {
            apiRequests?: { path: unknown; method: unknown }[];
            fields?: string[];
        };
        findById?: { apiRequests?: { path: unknown; method: unknown }[] };
        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 }[] };
        events?: {
            created?: {
                type: "push" | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            updated?: {
                type: "push"
                | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            deleted?: {
                type: "push"
                | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
            all?: { type: "push"
            | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
            [key: string]: {
                type: "push" | "pull";
                isFullScan?: boolean;
                isIdOnly?: boolean;
            };
        };
        customFields?: boolean;
        udm?: Record<
            string,
            {
                fields?: string[];
                extract?: Record<string, any>;
                parse?: Record<string, any>;
            },
        >;
        find?: {
            apiRequests?: { path: unknown; method: unknown }[];
            queryFields?: string[];
        };
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5671

listRecords

listRecords(
    request?: {
        parameters?: Record<string, any>;
        filter?: any;
        unifiedFilter?: any;
        cursor?: string;
    },
): Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        drilldowns?: {
            parameters?: Record<string, any>;
            filter?: Record<string, any>;
        }[];
        cursor?: string;
    },
>
Parameters
- Optionalrequest: {
      parameters?: Record<string, any>;
      filter?: any;
      unifiedFilter?: any;
      cursor?: string;
  }
Returns Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        drilldowns?: {
            parameters?: Record<string, any>;
            filter?: Record<string, any>;
        }[];
        cursor?: string;
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5672

matchRecord

matchRecord(
    request: {
        parameters?: Record<string, any>;
        query: ZodRecord<ZodString, ZodAny>;
    },
): Promise<
    {
        record?: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        };
    },
>
Parameters
- request: { parameters?: Record<string, any>; query: ZodRecord<ZodString, ZodAny> }
Returns Promise<
    {
        record?: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        };
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5673

searchRecords

searchRecords(
    request: {
        parameters?: Record<string, any>;
        query: string;
        cursor?: string;
    },
): Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        cursor?: string;
    },
>
Parameters
- request: { parameters?: Record<string, any>; query: string; cursor?: string }
Returns Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        cursor?: string;
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5674

findRecordById

findRecordById(
    request:
        | string
        | { parameters?: Record<string, any>; id: string; udm?: string },
): Promise<
    {
        record: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        };
    },
>
Parameters
- request: string | { parameters?: Record<string, any>; id: string; udm?: string }
Returns Promise<
    {
        record: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        };
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5675

createRecord

createRecord(
    request: {
        parameters?: Record<string, any>;
        fields: ZodRecord<ZodString, ZodAny>;
    },
): Promise<{ id: string }>
Parameters
- request: { parameters?: Record<string, any>; fields: ZodRecord<ZodString, ZodAny> }
Returns Promise<{ id: string }>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5676

updateRecord

updateRecord(
    request: {
        parameters?: Record<string, any>;
        id: string;
        fields: ZodRecord<ZodString, ZodAny>;
    },
): Promise<{ id: string }>
Parameters
- request: {
      parameters?: Record<string, any>;
      id: string;
      fields: ZodRecord<ZodString, ZodAny>;
  }
Returns Promise<{ id: string }>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5677

deleteRecord

deleteRecord(
    request:
        | string
        | { parameters?: Record<string, any>; id: string; udm?: string },
): Promise<Record<string, never>>
Parameters
- request: string | { parameters?: Record<string, any>; id: string; udm?: string }
Returns Promise<Record<string, never>>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5678

findRecords

findRecords(
    request?: { query?: any; cursor?: string },
): Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        cursor?: string;
    },
>
Parameters
- Optionalrequest: { query?: any; cursor?: string }
Returns Promise<
    {
        records: {
            id: string;
            name?: string;
            uri?: string;
            iconUri?: string;
            fields?: Record<string, any>;
            udm?: string;
            unifiedFields?: Record<string, any>;
            rawFields?: Record<string, any>;
            createdTime?: string;
            updatedTime?: string;
            deletedTime?: string;
            createdById?: string;
            updatedById?: string;
        }[];
        cursor?: string;
    },
>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:5679

Properties

`Protected`options

options: {
    client: MembraneApiClient;
    instancePath: string;
    selector: string | DataSourceInstanceSelector;
    type?: WorkspaceElementType;
}

client

client: MembraneApiClient

Class DataSourceInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns DataSourceInstanceAccessor

Methods

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

restore

ProtectedgetPath

Parameters

Returns string

setup

Returns Promise<void>

reset

Returns Promise<void>

openConfiguration

Parameters

Returns Promise<void>

unifiedFieldsToNative

Parameters

Returns Promise<any>

getCollection

listRecords

Parameters

matchRecord

Parameters

searchRecords

Parameters

findRecordById

Parameters

createRecord

Parameters

Returns Promise<{ id: string }>

updateRecord

Parameters

Returns Promise<{ id: string }>

deleteRecord

Parameters

Returns Promise<Record<string, never>>

findRecords

Parameters

Properties

Protectedoptions

client

Settings

On This Page

`Protected`getPath

`Protected`options