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

    Interface FindIntegrationsResponse

    interface FindIntegrationsResponse {
        items: {
            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;
            };
            spec?: any;
            authOptions?: {
                key: string;
                type: | "proxy"
                | "integration-app-token"
                | "membrane-token"
                | "oauth2"
                | "oauth1"
                | "client-credentials";
                title?: string;
                description?: string;
                ui?: { schema?: any; helpUri?: string };
            }[];
            parametersSchema?: DataSchema;
            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;
        }[];
        cursor?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Properties

    items: {
        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;
        };
        spec?: any;
        authOptions?: {
            key: string;
            type: | "proxy"
            | "integration-app-token"
            | "membrane-token"
            | "oauth2"
            | "oauth1"
            | "client-credentials";
            title?: string;
            description?: string;
            ui?: { schema?: any; helpUri?: string };
        }[];
        parametersSchema?: DataSchema;
        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;
    }[]

    Type declaration

    • 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
    • Optionalspec?: any
    • OptionalauthOptions?: {
          key: string;
          type:
              | "proxy"
              | "integration-app-token"
              | "membrane-token"
              | "oauth2"
              | "oauth1"
              | "client-credentials";
          title?: string;
          description?: string;
          ui?: { schema?: any; helpUri?: string };
      }[]
    • OptionalparametersSchema?: DataSchema
    • 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
    cursor?: string