Function useExternalEventSubscription

Returns {
    loading: boolean;
    saving: boolean;
    error: any;
    refreshing: boolean;
    create: (
        data: undefined,
    ) => Promise<
        | undefined
        | {
            id: string;
            name?: string;
            userId: string;
            connectionId: string;
            integrationId: string;
            config?: {
                type: ExternalEventSubscriptionType;
                dataSource?: {
                    key?: string;
                    collectionKey?: any;
                    collectionParameters?: any;
                    udm?: any;
                    path?: string;
                    pullUpdatesIntervalSeconds?: number;
                    fullSyncIntervalSeconds?: number;
                };
                eventKey?: string;
                eventParameters?: any;
            };
            status?: Subscribed
            | Unsubscribed
            | Error;
            error?: ErrorDataSchema;
            isRealTime?: boolean;
            requiresPull?: boolean;
            requiresFullSync?: boolean;
            createdAt?: string;
            archivedAt?: string;
            stateData?: any;
            nextPullEventsTimestamp?: number;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            nextRefreshTimestamp?: number;
            globalWebhookKey?: string;
            globalWebhookEventSelector?: string;
            user?: {
                id: string;
                name: string;
                meta?: Record<string, any>;
                internalId: string;
                fields?: Record<string, any>;
                credentials?: any;
                lastActiveAt?: string;
                isTest?: boolean;
                isBillable?: boolean;
                createdAt?: string;
                archivedAt?: string;
            };
            connection?: {
                id: string;
                name: string;
                userId: string;
                isTest?: boolean;
                disconnected?: boolean;
                isDefunct?: boolean;
                state?: CONFIGURATION_ERROR
                | SETUP_FAILED
                | READY;
                error?: ErrorDataSchema;
                integrationId: string;
                authOptionKey?: string;
                createdAt: string;
                updatedAt: string;
                lastActiveAt?: string;
                nextCredentialsRefreshAt?: string;
                archivedAt?: string;
                isDeactivated?: boolean;
                meta?: Record<string, any>;
            };
            integration?: {
                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;
                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";
            };
        },
    >;
    patch: (data: undefined) => Promise<void>;
    put: (data: undefined) => Promise<void>;
    archive: () => Promise<void>;
    externalEventSubscription:
        | undefined
        | {
            id: string;
            name?: string;
            userId: string;
            connectionId: string;
            integrationId: string;
            config?: {
                type: ExternalEventSubscriptionType;
                dataSource?: {
                    key?: string;
                    collectionKey?: any;
                    collectionParameters?: any;
                    udm?: any;
                    path?: string;
                    pullUpdatesIntervalSeconds?: number;
                    fullSyncIntervalSeconds?: number;
                };
                eventKey?: string;
                eventParameters?: any;
            };
            status?: Subscribed
            | Unsubscribed
            | Error;
            error?: ErrorDataSchema;
            isRealTime?: boolean;
            requiresPull?: boolean;
            requiresFullSync?: boolean;
            createdAt?: string;
            archivedAt?: string;
            stateData?: any;
            nextPullEventsTimestamp?: number;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            nextRefreshTimestamp?: number;
            globalWebhookKey?: string;
            globalWebhookEventSelector?: string;
            user?: {
                id: string;
                name: string;
                meta?: Record<string, any>;
                internalId: string;
                fields?: Record<string, any>;
                credentials?: any;
                lastActiveAt?: string;
                isTest?: boolean;
                isBillable?: boolean;
                createdAt?: string;
                archivedAt?: string;
            };
            connection?: {
                id: string;
                name: string;
                userId: string;
                isTest?: boolean;
                disconnected?: boolean;
                isDefunct?: boolean;
                state?: CONFIGURATION_ERROR
                | SETUP_FAILED
                | READY;
                error?: ErrorDataSchema;
                integrationId: string;
                authOptionKey?: string;
                createdAt: string;
                updatedAt: string;
                lastActiveAt?: string;
                nextCredentialsRefreshAt?: string;
                archivedAt?: string;
                isDeactivated?: boolean;
                meta?: Record<string, any>;
            };
            integration?: {
                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;
                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";
            };
        };
    accessor: undefined
    | ExternalEventSubscriptionAccessor;
    refresh: () => Promise<
        {
            id: string;
            name?: string;
            userId: string;
            connectionId: string;
            integrationId: string;
            config?: {
                type: ExternalEventSubscriptionType;
                dataSource?: {
                    key?: string;
                    collectionKey?: any;
                    collectionParameters?: any;
                    udm?: any;
                    path?: string;
                    pullUpdatesIntervalSeconds?: number;
                    fullSyncIntervalSeconds?: number;
                };
                eventKey?: string;
                eventParameters?: any;
            };
            status?: Subscribed
            | Unsubscribed
            | Error;
            error?: ErrorDataSchema;
            isRealTime?: boolean;
            requiresPull?: boolean;
            requiresFullSync?: boolean;
            createdAt?: string;
            archivedAt?: string;
            stateData?: any;
            nextPullEventsTimestamp?: number;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            nextRefreshTimestamp?: number;
            globalWebhookKey?: string;
            globalWebhookEventSelector?: string;
            user?: {
                id: string;
                name: string;
                meta?: Record<string, any>;
                internalId: string;
                fields?: Record<string, any>;
                credentials?: any;
                lastActiveAt?: string;
                isTest?: boolean;
                isBillable?: boolean;
                createdAt?: string;
                archivedAt?: string;
            };
            connection?: {
                id: string;
                name: string;
                userId: string;
                isTest?: boolean;
                disconnected?: boolean;
                isDefunct?: boolean;
                state?: CONFIGURATION_ERROR
                | SETUP_FAILED
                | READY;
                error?: ErrorDataSchema;
                integrationId: string;
                authOptionKey?: string;
                createdAt: string;
                updatedAt: string;
                lastActiveAt?: string;
                nextCredentialsRefreshAt?: string;
                archivedAt?: string;
                isDeactivated?: boolean;
                meta?: Record<string, any>;
            };
            integration?: {
                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;
                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";
            };
        },
    >;
    setup: () => Promise<void>;
    subscribe: () => Promise<void>;
    resubscribe: () => Promise<void>;
    unsubscribe: () => Promise<void>;
    pullEvents: () => Promise<void>;
}