Membrane SDK - v0.8.0
    Preparing search index...

    Function getDownstreamNodeKeys

    • Return nodes that follow a given node - all the way until the end of the flow.

      Parameters

      • flow:
            | {
                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;
                };
                appliedToIntegrations?: {
                    element: {
                        id: string;
                        integrationId?: string;
                        isCustomized?: boolean;
                        universalFlowId?: 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;
                    };
                }[];
                dependencies?: any[];
                integrationId?: string;
                universalFlowId?: string;
                parametersSchema?: DataSchema;
                nodes?: Record<
                    string,
                    {
                        type?: string;
                        version?: number;
                        name?: string;
                        description?: string;
                        config?: any;
                        concurrency?: number;
                        onError?: "continue"
                        | "stop";
                        ui?: any;
                        inputSchema?: any;
                        outputSchema?: any;
                        outputExample?: any;
                        links?: { key?: string; filter?: any; name?: string }[];
                        isCustomized?: boolean;
                    },
                >;
                autoCreateInstances?: boolean;
                universalFlowRevision?: 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;
                isCustomized?: boolean;
            }
            | {
                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?: {
                    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;
                };
                flow?: {
                    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;
                    };
                    appliedToIntegrations?: {
                        element: {
                            id: string;
                            integrationId?: string;
                            isCustomized?: boolean;
                            universalFlowId?: 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;
                        };
                    }[];
                    dependencies?: any[];
                    integrationId?: string;
                    universalFlowId?: string;
                    parametersSchema?: DataSchema;
                    nodes?: Record<
                        string,
                        {
                            type?: string;
                            version?: number;
                            name?: string;
                            description?: string;
                            config?: any;
                            concurrency?: number;
                            onError?: "continue"
                            | "stop";
                            ui?: any;
                            inputSchema?: any;
                            outputSchema?: any;
                            outputExample?: any;
                            links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                            isCustomized?: boolean;
                        },
                    >;
                    autoCreateInstances?: boolean;
                    universalFlowRevision?: 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;
                    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;
                    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;
                connectionId?: string;
                flowId?: string;
                universalFlowId?: string;
                integrationId: string;
                instanceKey?: string;
                parameters?: any;
                parametersSchema?: DataSchema;
                nodes?: Record<string, any>;
                enabled: boolean;
                createdAt: string;
                updatedAt: string;
                state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                customized?: { name?: boolean; nodes?: boolean };
                dependencies?: any[];
                id: string;
                key?: string;
                uuid?: string;
                description?: string;
                meta?: Record<string, any>;
                name: string;
                errors?: ErrorDataSchema[];
                revision?: string;
                archivedAt?: string;
                isDeactivated?: 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;
                  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;
              };
              appliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[];
              dependencies?: any[];
              integrationId?: string;
              universalFlowId?: string;
              parametersSchema?: DataSchema;
              nodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: string; filter?: any; name?: string }[];
                      isCustomized?: boolean;
                  },
              >;
              autoCreateInstances?: boolean;
              universalFlowRevision?: 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;
              isCustomized?: boolean;
          }
          • Optionalintegration?: {
                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;
            }

            Integration this flow belongs to.

            • logoUri: string

              Publicly accessible logo of the integrated app.

            • OptionalconnectorId?: string
            • OptionalconnectorVersion?: string
            • OptionaloAuthCallbackUri?: string
            • Optionalparameters?: any
            • OptionalarchivedAt?: string
            • OptionalhasMissingParameters?: boolean
            • OptionalhasDocumentation?: boolean
            • OptionalhasOperations?: boolean
            • OptionaloperationsCount?: number
            • OptionalhasData?: boolean
            • OptionaldataCollectionsCount?: number
            • OptionalhasEvents?: boolean
            • OptionaleventsCount?: number
            • OptionalhasGlobalWebhooks?: boolean
            • OptionalhasUdm?: boolean
            • OptionalisTest?: boolean
            • OptionalappUuid?: string
            • OptionalisDeactivated?: boolean
            • OptionalauthType?:
                  | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials"
              • use authOptions instead
            • id: string
            • Optionalkey?: string
            • Optionaluuid?: string
            • Optionaldescription?: string
            • Optionalmeta?: Record<string, any>
            • name: string
            • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
            • Optionalerrors?: ErrorDataSchema[]
            • Optionalrevision?: string
            • OptionalcreatedAt?: string
            • OptionalupdatedAt?: string
          • OptionalappliedToIntegrations?: {
                element: {
                    id: string;
                    integrationId?: string;
                    isCustomized?: boolean;
                    universalFlowId?: 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;
                };
            }[]
          • Optionaldependencies?: any[]
          • OptionalintegrationId?: string
          • OptionaluniversalFlowId?: string
          • OptionalparametersSchema?: DataSchema

            DataSchema of parameters provided during the flow creation. Can be used to configure the flow logic.

          • Optionalnodes?: Record<
                string,
                {
                    type?: string;
                    version?: number;
                    name?: string;
                    description?: string;
                    config?: any;
                    concurrency?: number;
                    onError?: "continue"
                    | "stop";
                    ui?: any;
                    inputSchema?: any;
                    outputSchema?: any;
                    outputExample?: any;
                    links?: { key?: string; filter?: any; name?: string }[];
                    isCustomized?: boolean;
                },
            >

            Flow Nodes in the format :

          • OptionalautoCreateInstances?: boolean

            Automatically create a Flow Instance when a Connection is created.

          • OptionaluniversalFlowRevision?: string
          • id: string
          • Optionalkey?: string
          • Optionaluuid?: string
          • Optionaldescription?: string
          • Optionalmeta?: Record<string, any>
          • name: string
          • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
          • Optionalerrors?: ErrorDataSchema[]
          • Optionalrevision?: string
          • OptionalcreatedAt?: string
          • OptionalupdatedAt?: string
          • OptionalarchivedAt?: string
          • OptionalisDeactivated?: boolean
          • OptionalisCustomized?: boolean
        • {
              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?: {
                  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;
              };
              flow?: {
                  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;
                  };
                  appliedToIntegrations?: {
                      element: {
                          id: string;
                          integrationId?: string;
                          isCustomized?: boolean;
                          universalFlowId?: 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;
                      };
                  }[];
                  dependencies?: any[];
                  integrationId?: string;
                  universalFlowId?: string;
                  parametersSchema?: DataSchema;
                  nodes?: Record<
                      string,
                      {
                          type?: string;
                          version?: number;
                          name?: string;
                          description?: string;
                          config?: any;
                          concurrency?: number;
                          onError?: "continue"
                          | "stop";
                          ui?: any;
                          inputSchema?: any;
                          outputSchema?: any;
                          outputExample?: any;
                          links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                          isCustomized?: boolean;
                      },
                  >;
                  autoCreateInstances?: boolean;
                  universalFlowRevision?: 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;
                  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;
                  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;
              connectionId?: string;
              flowId?: string;
              universalFlowId?: string;
              integrationId: string;
              instanceKey?: string;
              parameters?: any;
              parametersSchema?: DataSchema;
              nodes?: Record<string, any>;
              enabled: boolean;
              createdAt: string;
              updatedAt: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              customized?: { name?: boolean; nodes?: boolean };
              dependencies?: any[];
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              errors?: ErrorDataSchema[];
              revision?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          }
          • Optionaluser?: {
                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;
            }
          • Optionalconnection?: {
                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;
            }
            • name: string

              User-readable name of the connection

            • userId: string
            • OptionalisTest?: boolean
            • Optionaldisconnected?: boolean
            • OptionalisDefunct?: boolean
              • use isDeactivated instead
            • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
            • Optionalerror?: ErrorDataSchema

              Error message for defunct connection

            • integrationId: string

              Id of an integration the connection is created with

            • OptionalauthOptionKey?: string
            • createdAt: string
            • updatedAt: string
            • OptionallastActiveAt?: string

              Timestamp when the connection was last active

            • OptionalnextCredentialsRefreshAt?: string

              Timestamp when the connection credentials should be refreshed

            • OptionalarchivedAt?: string
            • OptionalisDeactivated?: boolean
            • Optionalmeta?: Record<string, any>
            • id: string
          • Optionalflow?: {
                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;
                };
                appliedToIntegrations?: {
                    element: {
                        id: string;
                        integrationId?: string;
                        isCustomized?: boolean;
                        universalFlowId?: 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;
                    };
                }[];
                dependencies?: any[];
                integrationId?: string;
                universalFlowId?: string;
                parametersSchema?: DataSchema;
                nodes?: Record<
                    string,
                    {
                        type?: string;
                        version?: number;
                        name?: string;
                        description?: string;
                        config?: any;
                        concurrency?: number;
                        onError?: "continue"
                        | "stop";
                        ui?: any;
                        inputSchema?: any;
                        outputSchema?: any;
                        outputExample?: any;
                        links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                        isCustomized?: boolean;
                    },
                >;
                autoCreateInstances?: boolean;
                universalFlowRevision?: 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;
                isCustomized?: boolean;
            }
            • Optionalintegration?: {
                  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;
              }

              Integration this flow belongs to.

              • logoUri: string

                Publicly accessible logo of the integrated app.

              • OptionalconnectorId?: string
              • OptionalconnectorVersion?: string
              • OptionaloAuthCallbackUri?: string
              • Optionalparameters?: any
              • OptionalarchivedAt?: string
              • OptionalhasMissingParameters?: boolean
              • OptionalhasDocumentation?: boolean
              • OptionalhasOperations?: boolean
              • OptionaloperationsCount?: number
              • OptionalhasData?: boolean
              • OptionaldataCollectionsCount?: number
              • OptionalhasEvents?: boolean
              • OptionaleventsCount?: number
              • OptionalhasGlobalWebhooks?: boolean
              • OptionalhasUdm?: boolean
              • OptionalisTest?: boolean
              • OptionalappUuid?: string
              • OptionalisDeactivated?: boolean
              • OptionalauthType?:
                    | "proxy"
                    | "integration-app-token"
                    | "membrane-token"
                    | "oauth2"
                    | "oauth1"
                    | "client-credentials"
                • use authOptions instead
              • id: string
              • Optionalkey?: string
              • Optionaluuid?: string
              • Optionaldescription?: string
              • Optionalmeta?: Record<string, any>
              • name: string
              • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
              • Optionalerrors?: ErrorDataSchema[]
              • Optionalrevision?: string
              • OptionalcreatedAt?: string
              • OptionalupdatedAt?: string
            • OptionalappliedToIntegrations?: {
                  element: {
                      id: string;
                      integrationId?: string;
                      isCustomized?: boolean;
                      universalFlowId?: 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;
                  };
              }[]
            • Optionaldependencies?: any[]
            • OptionalintegrationId?: string
            • OptionaluniversalFlowId?: string
            • OptionalparametersSchema?: DataSchema

              DataSchema of parameters provided during the flow creation. Can be used to configure the flow logic.

            • Optionalnodes?: Record<
                  string,
                  {
                      type?: string;
                      version?: number;
                      name?: string;
                      description?: string;
                      config?: any;
                      concurrency?: number;
                      onError?: "continue"
                      | "stop";
                      ui?: any;
                      inputSchema?: any;
                      outputSchema?: any;
                      outputExample?: any;
                      links?: { key?: (...) | (...); filter?: any; name?: (...) | (...) }[];
                      isCustomized?: boolean;
                  },
              >

              Flow Nodes in the format :

            • OptionalautoCreateInstances?: boolean

              Automatically create a Flow Instance when a Connection is created.

            • OptionaluniversalFlowRevision?: string
            • id: string
            • Optionalkey?: string
            • Optionaluuid?: string
            • Optionaldescription?: string
            • Optionalmeta?: Record<string, any>
            • name: string
            • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
            • Optionalerrors?: ErrorDataSchema[]
            • Optionalrevision?: string
            • OptionalcreatedAt?: string
            • OptionalupdatedAt?: string
            • OptionalarchivedAt?: string
            • OptionalisDeactivated?: boolean
            • OptionalisCustomized?: boolean
          • Optionalintegration?: {
                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;
            }
            • logoUri: string

              Publicly accessible logo of the integrated app.

            • OptionalconnectorId?: string
            • OptionalconnectorVersion?: string
            • OptionaloAuthCallbackUri?: string
            • Optionalparameters?: any
            • OptionalarchivedAt?: string
            • OptionalhasMissingParameters?: boolean
            • OptionalhasDocumentation?: boolean
            • OptionalhasOperations?: boolean
            • OptionaloperationsCount?: number
            • OptionalhasData?: boolean
            • OptionaldataCollectionsCount?: number
            • OptionalhasEvents?: boolean
            • OptionaleventsCount?: number
            • OptionalhasGlobalWebhooks?: boolean
            • OptionalhasUdm?: boolean
            • OptionalisTest?: boolean
            • OptionalappUuid?: string
            • OptionalisDeactivated?: boolean
            • OptionalauthType?:
                  | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials"
              • use authOptions instead
            • id: string
            • Optionalkey?: string
            • Optionaluuid?: string
            • Optionaldescription?: string
            • Optionalmeta?: Record<string, any>
            • name: string
            • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
            • Optionalerrors?: ErrorDataSchema[]
            • Optionalrevision?: string
            • OptionalcreatedAt?: string
            • OptionalupdatedAt?: string
          • userId: string
          • OptionalconnectionId?: string
          • OptionalflowId?: string
          • OptionaluniversalFlowId?: string
          • integrationId: string
          • OptionalinstanceKey?: string
          • Optionalparameters?: any

            This flow's parameters. Can be used as variables in nodes.

          • OptionalparametersSchema?: DataSchema

            Schema of parameters the flow accepts. Copied from FlowBlueprint

          • Optionalnodes?: Record<string, any>

            Dictionary of flow's nodes: :

          • enabled: boolean

            Whether the flow is enabled (i.e. triggers are active)

          • createdAt: string
          • updatedAt: string
          • Optionalstate?: CONFIGURATION_ERROR | SETUP_FAILED | READY
          • Optionalcustomized?: { name?: boolean; nodes?: boolean }

            customization details.

            • Optionalname?: boolean
            • Optionalnodes?: boolean

              added or removed nodes.

          • Optionaldependencies?: any[]
          • id: string
          • Optionalkey?: string
          • Optionaluuid?: string
          • Optionaldescription?: string
          • Optionalmeta?: Record<string, any>
          • name: string
          • Optionalerrors?: ErrorDataSchema[]
          • Optionalrevision?: string
          • OptionalarchivedAt?: string
          • OptionalisDeactivated?: boolean
      • nodeKey: string

      Returns string[]