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

    Class ConnectionsAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Methods

    • Parameters

      • Optionalquery: {
            limit?: number;
            cursor?: string;
            userId?: string;
            isTest?: boolean;
            integrationKey?: string;
            integrationId?: string;
            includeArchived?: boolean;
        }

      Returns Promise<
          PaginationResponse<
              {
                  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;
                  };
                  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;
                  };
                  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;
              },
          >,
      >

    • Parameters

      • data: { name: string; integrationId: string; credentials?: string }

      Returns Promise<
          {
              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;
              };
              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;
              };
              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;
          },
      >