@membranehq/sdk 0.4.0 → 0.5.1

package/dist/dts/workspace-elements/api/external-event-subscriptions-api.d.ts

@@ -1,10 +1,559 @@
-import { BaseConnection } from '../base/connections';
-import { BaseCustomer } from '../base/customers';
-import { BaseExternalEventSubscription } from '../base/external-event-subscriptions';
-import { BaseIntegration } from '../base/integrations';
-export interface ExternalEventSubscription extends BaseExternalEventSubscription {
-    user?: BaseCustomer;
-    connection?: BaseConnection;
-    integration?: BaseIntegration;
-}
-export type ExternalEventSubscriptionApiResponse = ExternalEventSubscription;
+import { z } from 'zod';
+export declare const ExternalEventSubscriptionApiResponse: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    userId: z.ZodString;
+    connectionId: z.ZodString;
+    integrationId: z.ZodString;
+    config: z.ZodOptional<z.ZodObject<{
+        type: z.ZodNativeEnum<typeof import("../base/external-event-subscriptions").ExternalEventSubscriptionType>;
+        dataSource: z.ZodOptional<z.ZodObject<{
+            key: z.ZodOptional<z.ZodString>;
+            collectionKey: z.ZodOptional<z.ZodAny>;
+            collectionParameters: z.ZodOptional<z.ZodAny>;
+            udm: z.ZodOptional<z.ZodAny>;
+            path: z.ZodOptional<z.ZodString>;
+            pullUpdatesIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+            fullSyncIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        }, {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        }>>;
+        eventKey: z.ZodOptional<z.ZodString>;
+        eventParameters: z.ZodOptional<z.ZodAny>;
+    }, "strip", z.ZodTypeAny, {
+        type: import("../base/external-event-subscriptions").ExternalEventSubscriptionType;
+        eventKey?: string | undefined;
+        eventParameters?: any;
+        dataSource?: {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        } | undefined;
+    }, {
+        type: import("../base/external-event-subscriptions").ExternalEventSubscriptionType;
+        eventKey?: string | undefined;
+        eventParameters?: any;
+        dataSource?: {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        } | undefined;
+    }>>;
+    status: z.ZodOptional<z.ZodNativeEnum<typeof import("../base/external-event-subscriptions").ExternalEventSubscriptionStatus>>;
+    error: any;
+    isRealTime: z.ZodOptional<z.ZodBoolean>;
+    requiresPull: z.ZodOptional<z.ZodBoolean>;
+    requiresFullSync: z.ZodOptional<z.ZodBoolean>;
+    createdAt: z.ZodOptional<z.ZodString>;
+    archivedAt: z.ZodOptional<z.ZodString>;
+    stateData: z.ZodOptional<z.ZodAny>;
+    nextPullEventsTimestamp: z.ZodOptional<z.ZodNumber>;
+    pullUpdatesIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+    fullSyncIntervalSeconds: z.ZodOptional<z.ZodNumber>;
+    nextRefreshTimestamp: z.ZodOptional<z.ZodNumber>;
+    globalWebhookKey: z.ZodOptional<z.ZodString>;
+    globalWebhookEventSelector: z.ZodOptional<z.ZodString>;
+} & {
+    user: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        internalId: z.ZodString;
+        fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        credentials: z.ZodOptional<z.ZodAny>;
+        lastActiveAt: z.ZodOptional<z.ZodString>;
+        isTest: z.ZodOptional<z.ZodBoolean>;
+        isBillable: z.ZodOptional<z.ZodBoolean>;
+        createdAt: z.ZodOptional<z.ZodString>;
+        archivedAt: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        internalId: string;
+        createdAt?: string | undefined;
+        archivedAt?: string | undefined;
+        credentials?: any;
+        fields?: Record<string, any> | undefined;
+        isTest?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        isBillable?: boolean | undefined;
+    }, {
+        id: string;
+        name: string;
+        internalId: string;
+        createdAt?: string | undefined;
+        archivedAt?: string | undefined;
+        credentials?: any;
+        fields?: Record<string, any> | undefined;
+        isTest?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        isBillable?: boolean | undefined;
+    }>>;
+    connection: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+    } & {
+        name: z.ZodString;
+        userId: z.ZodString;
+        isTest: z.ZodOptional<z.ZodBoolean>;
+        disconnected: z.ZodOptional<z.ZodBoolean>;
+        isDefunct: z.ZodOptional<z.ZodBoolean>;
+        error: any;
+        integrationId: z.ZodString;
+        credentials: z.ZodOptional<z.ZodUnknown>;
+        parameters: z.ZodOptional<z.ZodUnknown>;
+        connectorParameters: z.ZodOptional<z.ZodUnknown>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        lastActiveAt: z.ZodOptional<z.ZodString>;
+        nextCredentialsRefreshAt: z.ZodOptional<z.ZodString>;
+        archivedAt: z.ZodOptional<z.ZodString>;
+        isDeactivated: z.ZodOptional<z.ZodBoolean>;
+        state: z.ZodOptional<z.ZodNativeEnum<typeof import("..").WorkspaceElementState>>;
+        errors: z.ZodOptional<z.ZodArray<any, "many">>;
+        meta: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        createdAt: string;
+        updatedAt: string;
+        userId: string;
+        integrationId: string;
+        error?: any;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        isDeactivated?: boolean | undefined;
+        archivedAt?: string | undefined;
+        credentials?: unknown;
+        parameters?: unknown;
+        connectorParameters?: unknown;
+        isTest?: boolean | undefined;
+        disconnected?: boolean | undefined;
+        isDefunct?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        nextCredentialsRefreshAt?: string | undefined;
+        meta?: Record<string, any> | undefined;
+    }, {
+        id: string;
+        name: string;
+        createdAt: string;
+        updatedAt: string;
+        userId: string;
+        integrationId: string;
+        error?: any;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        isDeactivated?: boolean | undefined;
+        archivedAt?: string | undefined;
+        credentials?: unknown;
+        parameters?: unknown;
+        connectorParameters?: unknown;
+        isTest?: boolean | undefined;
+        disconnected?: boolean | undefined;
+        isDefunct?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        nextCredentialsRefreshAt?: string | undefined;
+        meta?: Record<string, any> | undefined;
+    }>>;
+    integration: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        key: z.ZodOptional<z.ZodString>;
+        uuid: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        state: z.ZodOptional<z.ZodNativeEnum<typeof import("..").WorkspaceElementState>>;
+        errors: z.ZodOptional<z.ZodArray<any, "many">>;
+        revision: z.ZodOptional<z.ZodString>;
+        createdAt: z.ZodOptional<z.ZodString>;
+        updatedAt: z.ZodOptional<z.ZodString>;
+    } & {
+        logoUri: z.ZodString;
+        connectorId: z.ZodOptional<z.ZodString>;
+        connectorVersion: z.ZodOptional<z.ZodString>;
+        authOptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            key: z.ZodString;
+            type: z.ZodEnum<["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"]>;
+            title: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            ui: z.ZodOptional<z.ZodObject<{
+                schema: z.ZodOptional<z.ZodAny>;
+                helpUri: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                schema?: any;
+                helpUri?: string | undefined;
+            }, {
+                schema?: any;
+                helpUri?: string | undefined;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }, {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }>, "many">>;
+        oAuthCallbackUri: z.ZodOptional<z.ZodString>;
+        parametersSchema: z.ZodOptional<z.ZodType<import("../..").DataSchema, z.ZodTypeDef, import("../..").DataSchema>>;
+        parameters: z.ZodOptional<z.ZodAny>;
+        baseUri: z.ZodString;
+        archivedAt: z.ZodOptional<z.ZodString>;
+        hasMissingParameters: z.ZodOptional<z.ZodBoolean>;
+        hasDocumentation: z.ZodOptional<z.ZodBoolean>;
+        hasOperations: z.ZodOptional<z.ZodBoolean>;
+        operationsCount: z.ZodOptional<z.ZodNumber>;
+        hasData: z.ZodOptional<z.ZodBoolean>;
+        dataCollectionsCount: z.ZodOptional<z.ZodNumber>;
+        hasEvents: z.ZodOptional<z.ZodBoolean>;
+        eventsCount: z.ZodOptional<z.ZodNumber>;
+        hasGlobalWebhooks: z.ZodOptional<z.ZodBoolean>;
+        hasUdm: z.ZodOptional<z.ZodBoolean>;
+        isTest: z.ZodOptional<z.ZodBoolean>;
+        appUuid: z.ZodOptional<z.ZodString>;
+        isDeactivated: z.ZodOptional<z.ZodBoolean>;
+        authType: z.ZodOptional<z.ZodEnum<["integration-app-token", "membrane-token", "oauth2", "oauth1", "client-credentials", "proxy"]>>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        key?: string | undefined;
+        uuid?: string | undefined;
+        description?: string | undefined;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        revision?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        archivedAt?: string | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        operationsCount?: number | undefined;
+        hasData?: boolean | undefined;
+        dataCollectionsCount?: number | undefined;
+        hasEvents?: boolean | undefined;
+        eventsCount?: number | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }, {
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        key?: string | undefined;
+        uuid?: string | undefined;
+        description?: string | undefined;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        revision?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        archivedAt?: string | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        operationsCount?: number | undefined;
+        hasData?: boolean | undefined;
+        dataCollectionsCount?: number | undefined;
+        hasEvents?: boolean | undefined;
+        eventsCount?: number | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    userId: string;
+    connectionId: string;
+    integrationId: string;
+    connection?: {
+        id: string;
+        name: string;
+        createdAt: string;
+        updatedAt: string;
+        userId: string;
+        integrationId: string;
+        error?: any;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        isDeactivated?: boolean | undefined;
+        archivedAt?: string | undefined;
+        credentials?: unknown;
+        parameters?: unknown;
+        connectorParameters?: unknown;
+        isTest?: boolean | undefined;
+        disconnected?: boolean | undefined;
+        isDefunct?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        nextCredentialsRefreshAt?: string | undefined;
+        meta?: Record<string, any> | undefined;
+    } | undefined;
+    status?: import("../base/external-event-subscriptions").ExternalEventSubscriptionStatus | undefined;
+    error?: any;
+    integration?: {
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        key?: string | undefined;
+        uuid?: string | undefined;
+        description?: string | undefined;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        revision?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        archivedAt?: string | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        operationsCount?: number | undefined;
+        hasData?: boolean | undefined;
+        dataCollectionsCount?: number | undefined;
+        hasEvents?: boolean | undefined;
+        eventsCount?: number | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    } | undefined;
+    name?: string | undefined;
+    createdAt?: string | undefined;
+    archivedAt?: string | undefined;
+    nextRefreshTimestamp?: number | undefined;
+    user?: {
+        id: string;
+        name: string;
+        internalId: string;
+        createdAt?: string | undefined;
+        archivedAt?: string | undefined;
+        credentials?: any;
+        fields?: Record<string, any> | undefined;
+        isTest?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        isBillable?: boolean | undefined;
+    } | undefined;
+    config?: {
+        type: import("../base/external-event-subscriptions").ExternalEventSubscriptionType;
+        eventKey?: string | undefined;
+        eventParameters?: any;
+        dataSource?: {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        } | undefined;
+    } | undefined;
+    pullUpdatesIntervalSeconds?: number | undefined;
+    fullSyncIntervalSeconds?: number | undefined;
+    isRealTime?: boolean | undefined;
+    requiresPull?: boolean | undefined;
+    requiresFullSync?: boolean | undefined;
+    stateData?: any;
+    nextPullEventsTimestamp?: number | undefined;
+    globalWebhookKey?: string | undefined;
+    globalWebhookEventSelector?: string | undefined;
+}, {
+    id: string;
+    userId: string;
+    connectionId: string;
+    integrationId: string;
+    connection?: {
+        id: string;
+        name: string;
+        createdAt: string;
+        updatedAt: string;
+        userId: string;
+        integrationId: string;
+        error?: any;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        isDeactivated?: boolean | undefined;
+        archivedAt?: string | undefined;
+        credentials?: unknown;
+        parameters?: unknown;
+        connectorParameters?: unknown;
+        isTest?: boolean | undefined;
+        disconnected?: boolean | undefined;
+        isDefunct?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        nextCredentialsRefreshAt?: string | undefined;
+        meta?: Record<string, any> | undefined;
+    } | undefined;
+    status?: import("../base/external-event-subscriptions").ExternalEventSubscriptionStatus | undefined;
+    error?: any;
+    integration?: {
+        id: string;
+        name: string;
+        baseUri: string;
+        logoUri: string;
+        key?: string | undefined;
+        uuid?: string | undefined;
+        description?: string | undefined;
+        state?: import("..").WorkspaceElementState | undefined;
+        errors?: any[] | undefined;
+        revision?: string | undefined;
+        isDeactivated?: boolean | undefined;
+        createdAt?: string | undefined;
+        updatedAt?: string | undefined;
+        archivedAt?: string | undefined;
+        parameters?: any;
+        parametersSchema?: import("../..").DataSchema | undefined;
+        isTest?: boolean | undefined;
+        connectorId?: string | undefined;
+        connectorVersion?: string | undefined;
+        authOptions?: {
+            key: string;
+            type: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials";
+            description?: string | undefined;
+            title?: string | undefined;
+            ui?: {
+                schema?: any;
+                helpUri?: string | undefined;
+            } | undefined;
+        }[] | undefined;
+        oAuthCallbackUri?: string | undefined;
+        hasMissingParameters?: boolean | undefined;
+        hasDocumentation?: boolean | undefined;
+        hasOperations?: boolean | undefined;
+        operationsCount?: number | undefined;
+        hasData?: boolean | undefined;
+        dataCollectionsCount?: number | undefined;
+        hasEvents?: boolean | undefined;
+        eventsCount?: number | undefined;
+        hasGlobalWebhooks?: boolean | undefined;
+        hasUdm?: boolean | undefined;
+        appUuid?: string | undefined;
+        authType?: "proxy" | "integration-app-token" | "membrane-token" | "oauth2" | "oauth1" | "client-credentials" | undefined;
+    } | undefined;
+    name?: string | undefined;
+    createdAt?: string | undefined;
+    archivedAt?: string | undefined;
+    nextRefreshTimestamp?: number | undefined;
+    user?: {
+        id: string;
+        name: string;
+        internalId: string;
+        createdAt?: string | undefined;
+        archivedAt?: string | undefined;
+        credentials?: any;
+        fields?: Record<string, any> | undefined;
+        isTest?: boolean | undefined;
+        lastActiveAt?: string | undefined;
+        isBillable?: boolean | undefined;
+    } | undefined;
+    config?: {
+        type: import("../base/external-event-subscriptions").ExternalEventSubscriptionType;
+        eventKey?: string | undefined;
+        eventParameters?: any;
+        dataSource?: {
+            key?: string | undefined;
+            path?: string | undefined;
+            udm?: any;
+            collectionKey?: any;
+            collectionParameters?: any;
+            pullUpdatesIntervalSeconds?: number | undefined;
+            fullSyncIntervalSeconds?: number | undefined;
+        } | undefined;
+    } | undefined;
+    pullUpdatesIntervalSeconds?: number | undefined;
+    fullSyncIntervalSeconds?: number | undefined;
+    isRealTime?: boolean | undefined;
+    requiresPull?: boolean | undefined;
+    requiresFullSync?: boolean | undefined;
+    stateData?: any;
+    nextPullEventsTimestamp?: number | undefined;
+    globalWebhookKey?: string | undefined;
+    globalWebhookEventSelector?: string | undefined;
+}>;
+export type ExternalEventSubscriptionApiResponse = z.infer<typeof ExternalEventSubscriptionApiResponse>;
+export type ExternalEventSubscription = ExternalEventSubscriptionApiResponse;