Class DataSourceAccessor

Hierarchy (View Summary)

ElementAccessor<DataSource, UpdateDataSourceRequest, DataSourceSelector>
- DataSourceAccessor

Index

Constructors

constructor

new DataSourceAccessor(
client: MembraneApiClient,
selector: string | DataSourceSelector,
): DataSourceAccessor
Parameters
- client: MembraneApiClient
- selector: string | DataSourceSelector
Returns DataSourceAccessor
Overrides ElementAccessor.constructor
- Defined in accessors/data-sources-accessors.ts:64

Properties

`Protected`options

options: {
    client: MembraneApiClient;
    path: string;
    selector: string | DataSourceSelector;
}

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors/base-accessors.ts:39

get

get(): Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Returns Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Inherited from ElementAccessor.get
- Defined in accessors/base-accessors.ts:43

put

put(
    data: {
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        uuid?: string;
        key?: string;
        name?: string;
        description?: string;
        meta?: Record<string, any>;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
    },
): Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Parameters
- data: {
      connectionId?: string;
      dataSourceId?: string;
      universalDataSourceId?: string;
      udm?: string;
      pullUpdatesIntervalSeconds?: number;
      fullSyncIntervalSeconds?: number;
      collectionKey?: string;
      collectionParameters?: any;
      defaultPath?: string;
      uuid?: string;
      key?: string;
      name?: string;
      description?: string;
      meta?: Record<string, any>;
      integrationId?: string;
      integrationUuid?: string;
      parentUuid?: string;
      instanceKey?: string;
  }
  - OptionalconnectionId?: string
  - OptionaldataSourceId?: string
  - OptionaluniversalDataSourceId?: string
  - Optionaludm?: string
  - OptionalpullUpdatesIntervalSeconds?: number
  - OptionalfullSyncIntervalSeconds?: number
  - OptionalcollectionKey?: string
  - OptionalcollectionParameters?: any
  - OptionaldefaultPath?: string
    Deprecated
  - Optionaluuid?: string
  - Optionalkey?: string
  - Optionalname?: string
  - Optionaldescription?: string
  - Optionalmeta?: Record<string, any>
  - OptionalintegrationId?: string
  - OptionalintegrationUuid?: string
  - OptionalparentUuid?: string
  - OptionalinstanceKey?: string
Returns Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Inherited from ElementAccessor.put
- Defined in accessors/base-accessors.ts:47

patch

patch(
    data: Partial<UpdateRequest>,
): Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Parameters
- data: Partial<UpdateRequest>
Returns Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Inherited from ElementAccessor.patch
- Defined in accessors/base-accessors.ts:51

restore

restore(): Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Returns Promise<
    {
        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;
            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;
        };
        appliedToIntegrations?: {
            element: {
                connectionId?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                udm?: string;
                pullUpdatesIntervalSeconds?: number;
                fullSyncIntervalSeconds?: number;
                collectionKey?: string;
                collectionParameters?: any;
                defaultPath?: string;
                universalDataSourceRevision?: string;
                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;
                archivedAt?: string;
                isDeactivated?: boolean;
                integrationId?: string;
                integrationUuid?: string;
                parentUuid?: string;
                instanceKey?: string;
                isCustomized?: boolean;
            };
            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;
                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;
            };
        }[];
        connectionId?: string;
        dataSourceId?: string;
        universalDataSourceId?: string;
        udm?: string;
        pullUpdatesIntervalSeconds?: number;
        fullSyncIntervalSeconds?: number;
        collectionKey?: string;
        collectionParameters?: any;
        defaultPath?: string;
        universalDataSourceRevision?: string;
        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;
        archivedAt?: string;
        isDeactivated?: boolean;
        integrationId?: string;
        integrationUuid?: string;
        parentUuid?: string;
        instanceKey?: string;
        isCustomized?: boolean;
    },
>
Inherited from ElementAccessor.restore
- Defined in accessors/base-accessors.ts:59

getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementAccessor.getPath
- Defined in accessors/base-accessors.ts:63

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in accessors/data-sources-accessors.ts:72

reset

reset(): Promise<any>
Returns Promise<any>
- Defined in accessors/data-sources-accessors.ts:76

Class DataSourceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DataSourceAccessor

Properties

Protectedoptions

Methods

getUniqueIdentifier

Returns string

get

put

Parameters

OptionalconnectionId?: string

OptionaldataSourceId?: string

OptionaluniversalDataSourceId?: string

Optionaludm?: string

OptionalpullUpdatesIntervalSeconds?: number

OptionalfullSyncIntervalSeconds?: number

OptionalcollectionKey?: string

OptionalcollectionParameters?: any

OptionaldefaultPath?: string

Deprecated

Optionaluuid?: string

Optionalkey?: string

Optionalname?: string

Optionaldescription?: string

Optionalmeta?: Record<string, any>

OptionalintegrationId?: string

OptionalintegrationUuid?: string

OptionalparentUuid?: string

OptionalinstanceKey?: string

patch

Parameters

archive

Returns Promise<void>

restore

getPath

Parameters

Returns string

setup

Returns Promise<void>

reset

Returns Promise<any>

Settings

On This Page

`Protected`options

`Optional`connectionId?: string

`Optional`dataSourceId?: string

`Optional`universalDataSourceId?: string

`Optional`udm?: string

`Optional`pullUpdatesIntervalSeconds?: number

`Optional`fullSyncIntervalSeconds?: number

`Optional`collectionKey?: string

`Optional`collectionParameters?: any

`Optional`defaultPath?: string

`Optional`uuid?: string

`Optional`key?: string

`Optional`name?: string

`Optional`description?: string

`Optional`meta?: Record<string, any>

`Optional`integrationId?: string

`Optional`integrationUuid?: string

`Optional`parentUuid?: string

`Optional`instanceKey?: string