Class ConnectionLevelDataSourceAccessor

Hierarchy (View Summary)

ConnectionLevelElementAccessor<
DataSourceInstance,
UpdateDataSourceInstanceRequest,
>
- ConnectionLevelDataSourceAccessor

Index

Constructors

constructor

new ConnectionLevelDataSourceAccessor(
    client: MembraneApiClient,
    connectionSelector: string,
    dataSourceSelector: string,
    query: InstanceKeyQuery,
): ConnectionLevelDataSourceAccessor
Parameters
- client: MembraneApiClient
- connectionSelector: string
- dataSourceSelector: string
- query: InstanceKeyQuery
Returns ConnectionLevelDataSourceAccessor
Overrides ConnectionLevelElementAccessor.constructor
- Defined in accessors/data-sources-accessors.ts:201

Properties

client

client: MembraneApiClient

connectionSelector

connectionSelector: string

dataSourceSelector

dataSourceSelector: string

query

query: InstanceKeyQuery

`Protected`endpoint

endpoint: string

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

Methods

openConfiguration

openConfiguration(options?: OpenDataSourceConfigurationOptions): Promise<void>
Parameters
- Optionaloptions: OpenDataSourceConfigurationOptions
Returns Promise<void>
- Defined in accessors/data-sources-accessors.ts:210

`Protected`uri

uri(path?: string, query?: {}): string
Parameters
- path: string = ''
- query: {} = {}
Returns string
Inherited from ConnectionLevelElementAccessor.uri
- Defined in integration-elements/connection-level-element.accessor.ts:19

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ConnectionLevelElementAccessor.getUniqueIdentifier
- Defined in integration-elements/connection-level-element.accessor.ts:23

get

get(
    query?: { autoCreate?: boolean },
): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Parameters
- query: { autoCreate?: boolean } = {}
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.get
- Defined in integration-elements/connection-level-element.accessor.ts:27

create

create(): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.create
- Defined in integration-elements/connection-level-element.accessor.ts:31

patch

patch(
    data: Partial<UpdateElement>,
): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Parameters
- data: Partial<UpdateElement>
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.patch
- Defined in integration-elements/connection-level-element.accessor.ts:35

put

put(
    data: {
        path?: string;
        collectionKey?: string;
        collectionParameters?: any;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean };
    },
): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Parameters
- data: {
      path?: string;
      collectionKey?: string;
      collectionParameters?: any;
      pullUpdatesIntervalSeconds?: number;
      fullSyncIntervalSeconds?: number;
      subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean };
  }
  - Optionalpath?: string
    Deprecated
    
    use path instead
  - OptionalcollectionKey?: string
  - OptionalcollectionParameters?: any
  - OptionalpullUpdatesIntervalSeconds?: number
  - OptionalfullSyncIntervalSeconds?: number
  - OptionalsubscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean }
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.put
- Defined in integration-elements/connection-level-element.accessor.ts:39

reset

reset(): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.reset
- Defined in integration-elements/connection-level-element.accessor.ts:47

setup

setup(): Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Returns Promise<
    {
        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?: {
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            defaultPath?: string;
            universalDataSourceRevision?: string;
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
            archivedAt?: string;
            isDeactivated?: boolean;
            integrationId?: string;
            isCustomized?: boolean;
        };
        connection?: {
            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;
            archivedAt?: string;
            isDeactivated?: boolean;
            meta?: Record<string, any>;
            id: string;
        };
        integration?: {
            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";
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            revision?: string;
            createdAt?: string;
            updatedAt?: string;
        };
        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;
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        createdAt?: string;
        updatedAt?: string;
        archivedAt?: string;
        isDeactivated?: boolean;
    },
>
Inherited from ConnectionLevelElementAccessor.setup
- Defined in integration-elements/connection-level-element.accessor.ts:51

Class ConnectionLevelDataSourceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConnectionLevelDataSourceAccessor

Properties

client

connectionSelector

dataSourceSelector

query

Protectedendpoint

Protectedselector

ProtectedelementKey

Methods

openConfiguration

Parameters

Returns Promise<void>

Protecteduri

Parameters

Returns string

getUniqueIdentifier

Returns string

get

Parameters

create

patch

Parameters

put

Parameters

Optionalpath?: string

Deprecated

OptionalcollectionKey?: string

OptionalcollectionParameters?: any

OptionalpullUpdatesIntervalSeconds?: number

OptionalfullSyncIntervalSeconds?: number

OptionalsubscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean }

archive

Returns Promise<void>

reset

setup

Settings

On This Page

`Protected`endpoint

`Protected`selector

`Protected`elementKey

`Protected`uri

`Optional`path?: string

`Optional`collectionKey?: string

`Optional`collectionParameters?: any

`Optional`pullUpdatesIntervalSeconds?: number

`Optional`fullSyncIntervalSeconds?: number

`Optional`subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean }