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

    Class DataSourcesAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Parameters

      • Optionalquery: {
            limit?: number;
            cursor?: string;
            includeArchived?: boolean;
            search?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            externalAppId?: string;
            integrationKey?: string;
            integrationId?: string;
            connectionId?: string;
            connectionKey?: string;
            instanceKey?: string;
            universalParentId?: string;
            tenantId?: string;
            userId?: string;
            isUniversal?: boolean;
            layer?: "connection" | "integration" | "universal";
        }

      Returns Promise<
          PaginationResponse<
              {
                  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;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<string, any> },
                      >;
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
                  appliedToIntegrations?: {
                      element: {
                          connectionId?: string;
                          instanceKey?: string;
                          dataSourceId?: string;
                          universalDataSourceId?: string;
                          udm?: string;
                          pullUpdatesIntervalSeconds?: number;
                          fullSyncIntervalSeconds?: number;
                          collectionKey?: string;
                          collectionParameters?: any;
                          dataSourceRevision?: string;
                          universalDataSourceRevision?: string;
                          defaultCollectionKey?: string;
                          defaultCollectionParameters?: any;
                          collectionSpec?: {
                              type: "collection";
                              key?: string;
                              name: string;
                              parametersSchema?: DataSchema;
                              fieldsSchema?: DataSchema;
                              list?: { apiRequests?: ...; filterFields?: ... };
                              search?: { apiRequests?: ... };
                              match?: { apiRequests?: ...; fields?: ... };
                              findById?: { apiRequests?: ... };
                              create?: {
                                  apiRequests?: ...;
                                  fields?: ...;
                                  requiredFields?: ...;
                                  excludedFields?: ...;
                              };
                              update?: { apiRequests?: ...; fields?: ...; excludedFields?: ... };
                              delete?: { apiRequests?: ... };
                              events?: {
                                  created?: ...;
                                  updated?: ...;
                                  deleted?: ...;
                                  all?: ...;
                                  [key: ...]: ...;
                              };
                              customFields?: boolean;
                              udm?: Record<(...), (...)>;
                              find?: { apiRequests?: ...; queryFields?: ... };
                          };
                          isCustomized?: boolean;
                          errors?: ErrorDataSchema[];
                          id: string;
                          uuid?: string;
                          key?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          state?:
                              | BUILDING
                              | CLIENT_ACTION_REQUIRED
                              | CONFIGURATION_ERROR
                              | SETUP_FAILED
                              | READY
                              | DISCONNECTING;
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isReadOnly?: boolean;
                          integrationId?: string;
                          integrationUuid?: string;
                          integrationKey?: string;
                          parentUuid?: string;
                          parentKey?: string;
                          isUniversal?: boolean;
                          externalAppId?: string;
                          externalAppUuid?: string;
                          externalAppKey?: string;
                          userId?: string;
                          tenantId?: 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;
                          externalAppId?: string;
                          appUuid?: string;
                          isDeactivated?: boolean;
                          authType?: | "proxy"
                          | "integration-app-token"
                          | "membrane-token"
                          | "oauth2"
                          | "oauth1"
                          | "client-credentials";
                          optionsConfig?: Record<
                              string,
                              { disabled?: (...)
                              | (...)
                              | (...); parameters?: (...) | (...) },
                          >;
                          id: string;
                          uuid?: string;
                          key?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          state?:
                              | BUILDING
                              | CLIENT_ACTION_REQUIRED
                              | CONFIGURATION_ERROR
                              | SETUP_FAILED
                              | READY
                              | DISCONNECTING;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          isReadOnly?: boolean;
                      };
                  }[];
                  user?: {
                      id: string;
                      name: string;
                      meta?: Record<string, any>;
                      internalId: string;
                      fields?: Record<string, any>;
                      credentials?: any;
                      lastActiveAt?: string;
                      isTest?: boolean;
                      isBillable?: boolean;
                      isActive?: boolean;
                      aiCreditsRolling30DayLimit?: number | null;
                      createdAt?: string;
                      archivedAt?: string;
                  };
                  connection?: {
                      type?: "connector"
                      | "mcp";
                      name: string;
                      key?: string;
                      isTest?: boolean;
                      connected?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      requestError?: ErrorDataSchema;
                      error?: ErrorDataSchema;
                      integrationId?: string;
                      connectorId?: string;
                      externalAppId?: string;
                      connectorVersion?: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      nextRetryTimestamp?: string;
                      retryAttempts?: number;
                      canTest?: boolean;
                      canRefreshCredentials?: boolean;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                      buildingAgentSessionId?: string;
                      clientAction?: {
                          type: "connect" | "provide-input";
                          description: string;
                          uiUrl?: string;
                          agentInstructions?: string;
                          handoffAgentInstructions?: string;
                          reason?: "provide-input" | "authenticate" | "reauthenticate";
                      };
                      id: string;
                      userId: string;
                      tenantId?: string;
                  };
                  dataSource?: {
                      connectionId?: string;
                      instanceKey?: string;
                      dataSourceId?: string;
                      universalDataSourceId?: string;
                      udm?: string;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      collectionKey?: string;
                      collectionParameters?: any;
                      dataSourceRevision?: string;
                      universalDataSourceRevision?: string;
                      defaultCollectionKey?: string;
                      defaultCollectionParameters?: any;
                      collectionSpec?: {
                          type: "collection";
                          key?: string;
                          name: string;
                          parametersSchema?: DataSchema;
                          fieldsSchema?: DataSchema;
                          list?: { apiRequests?: (...)[]; filterFields?: (...)[] };
                          search?: { apiRequests?: (...)[] };
                          match?: { apiRequests?: (...)[]; fields?: (...)[] };
                          findById?: { apiRequests?: (...)[] };
                          create?: {
                              apiRequests?: (...)[];
                              fields?: (...)[];
                              requiredFields?: (...)[];
                              excludedFields?: (...)[];
                          };
                          update?: {
                              apiRequests?: (...)[];
                              fields?: (...)[];
                              excludedFields?: (...)[];
                          };
                          delete?: { apiRequests?: (...)[] };
                          events?: {
                              created?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                              updated?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                              deleted?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                              all?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                              [key: string]: {
                                  type: (...) | (...);
                                  isFullScan?: (...) | (...) | (...);
                                  isIdOnly?: (...) | (...) | (...);
                              };
                          };
                          customFields?: boolean;
                          udm?: Record<
                              string,
                              {
                                  fields?: (...)
                                  | (...);
                                  extract?: (...) | (...);
                                  parse?: (...) | (...);
                              },
                          >;
                          find?: { apiRequests?: (...)[]; queryFields?: (...)[] };
                      };
                      isCustomized?: boolean;
                      errors?: ErrorDataSchema[];
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                      userId?: string;
                      tenantId?: string;
                  };
                  path?: string;
                  defaultPath?: string;
                  connectionId?: string;
                  instanceKey?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  dataSourceRevision?: string;
                  universalDataSourceRevision?: string;
                  defaultCollectionKey?: string;
                  defaultCollectionParameters?: any;
                  collectionSpec?: {
                      type: "collection";
                      key?: string;
                      name: string;
                      parametersSchema?: DataSchema;
                      fieldsSchema?: DataSchema;
                      list?: {
                          apiRequests?: { path: unknown; method: unknown }[];
                          filterFields?: string[];
                      };
                      search?: { apiRequests?: { path: unknown; method: unknown }[] };
                      match?: {
                          apiRequests?: { path: unknown; method: unknown }[];
                          fields?: string[];
                      };
                      findById?: { apiRequests?: { path: unknown; method: unknown }[] };
                      create?: {
                          apiRequests?: { path: unknown; method: unknown }[];
                          fields?: string[];
                          requiredFields?: string[];
                          excludedFields?: string[];
                      };
                      update?: {
                          apiRequests?: { path: unknown; method: unknown }[];
                          fields?: string[];
                          excludedFields?: string[];
                      };
                      delete?: { apiRequests?: { path: unknown; method: unknown }[] };
                      events?: {
                          created?: {
                              type: "push" | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                          updated?: {
                              type: "push"
                              | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                          deleted?: {
                              type: "push"
                              | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                          all?: {
                              type: "push"
                              | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                          [key: string]: {
                              type: "push"
                              | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                      };
                      customFields?: boolean;
                      udm?: Record<
                          string,
                          {
                              fields?: string[];
                              extract?: Record<string, any>;
                              parse?: Record<string, any>;
                          },
                      >;
                      find?: {
                          apiRequests?: { path: unknown; method: unknown }[];
                          queryFields?: string[];
                      };
                  };
                  isCustomized?: boolean;
                  errors?: ErrorDataSchema[];
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isReadOnly?: boolean;
                  integrationId?: string;
                  integrationUuid?: string;
                  integrationKey?: string;
                  parentUuid?: string;
                  parentKey?: string;
                  isUniversal?: boolean;
                  externalAppId?: string;
                  externalAppUuid?: string;
                  externalAppKey?: string;
                  userId?: string;
                  tenantId?: string;
              },
          >,
      >

    • Parameters

      • Optionalquery: Omit<
            {
                limit?: number;
                cursor?: string;
                includeArchived?: boolean;
                search?: string;
                dataSourceId?: string;
                universalDataSourceId?: string;
                externalAppId?: string;
                integrationKey?: string;
                integrationId?: string;
                connectionId?: string;
                connectionKey?: string;
                instanceKey?: string;
                universalParentId?: string;
                tenantId?: string;
                userId?: string;
                isUniversal?: boolean;
                layer?: "connection"
                | "integration"
                | "universal";
            },
            "limit",
        >

      Returns Promise<
          {
              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;
                  externalAppId?: string;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  optionsConfig?: Record<
                      string,
                      { disabled?: boolean; parameters?: Record<string, any> },
                  >;
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  isReadOnly?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      connectionId?: string;
                      instanceKey?: string;
                      dataSourceId?: string;
                      universalDataSourceId?: string;
                      udm?: string;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      collectionKey?: string;
                      collectionParameters?: any;
                      dataSourceRevision?: string;
                      universalDataSourceRevision?: string;
                      defaultCollectionKey?: string;
                      defaultCollectionParameters?: any;
                      collectionSpec?: {
                          type: "collection";
                          key?: string;
                          name: string;
                          parametersSchema?: DataSchema;
                          fieldsSchema?: DataSchema;
                          list?: { apiRequests?: ...; filterFields?: ... };
                          search?: { apiRequests?: ... };
                          match?: { apiRequests?: ...; fields?: ... };
                          findById?: { apiRequests?: ... };
                          create?: {
                              apiRequests?: ...;
                              fields?: ...;
                              requiredFields?: ...;
                              excludedFields?: ...;
                          };
                          update?: { apiRequests?: ...; fields?: ...; excludedFields?: ... };
                          delete?: { apiRequests?: ... };
                          events?: {
                              created?: ...;
                              updated?: ...;
                              deleted?: ...;
                              all?: ...;
                              [key: ...]: ...;
                          };
                          customFields?: boolean;
                          udm?: Record<(...), (...)>;
                          find?: { apiRequests?: ...; queryFields?: ... };
                      };
                      isCustomized?: boolean;
                      errors?: ErrorDataSchema[];
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                      userId?: string;
                      tenantId?: 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;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: (...)
                          | (...)
                          | (...); parameters?: (...) | (...) },
                      >;
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  isActive?: boolean;
                  aiCreditsRolling30DayLimit?: number | null;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              dataSource?: {
                  connectionId?: string;
                  instanceKey?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  dataSourceRevision?: string;
                  universalDataSourceRevision?: string;
                  defaultCollectionKey?: string;
                  defaultCollectionParameters?: any;
                  collectionSpec?: {
                      type: "collection";
                      key?: string;
                      name: string;
                      parametersSchema?: DataSchema;
                      fieldsSchema?: DataSchema;
                      list?: { apiRequests?: (...)[]; filterFields?: (...)[] };
                      search?: { apiRequests?: (...)[] };
                      match?: { apiRequests?: (...)[]; fields?: (...)[] };
                      findById?: { apiRequests?: (...)[] };
                      create?: {
                          apiRequests?: (...)[];
                          fields?: (...)[];
                          requiredFields?: (...)[];
                          excludedFields?: (...)[];
                      };
                      update?: {
                          apiRequests?: (...)[];
                          fields?: (...)[];
                          excludedFields?: (...)[];
                      };
                      delete?: { apiRequests?: (...)[] };
                      events?: {
                          created?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                          updated?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                          deleted?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                          all?: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                          [key: string]: {
                              type: (...) | (...);
                              isFullScan?: (...) | (...) | (...);
                              isIdOnly?: (...) | (...) | (...);
                          };
                      };
                      customFields?: boolean;
                      udm?: Record<
                          string,
                          {
                              fields?: (...)
                              | (...);
                              extract?: (...) | (...);
                              parse?: (...) | (...);
                          },
                      >;
                      find?: { apiRequests?: (...)[]; queryFields?: (...)[] };
                  };
                  isCustomized?: boolean;
                  errors?: ErrorDataSchema[];
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isReadOnly?: boolean;
                  integrationId?: string;
                  integrationUuid?: string;
                  integrationKey?: string;
                  parentUuid?: string;
                  parentKey?: string;
                  isUniversal?: boolean;
                  externalAppId?: string;
                  externalAppUuid?: string;
                  externalAppKey?: string;
                  userId?: string;
                  tenantId?: string;
              };
              path?: string;
              defaultPath?: string;
              connectionId?: string;
              instanceKey?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              collectionKey?: string;
              collectionParameters?: any;
              dataSourceRevision?: string;
              universalDataSourceRevision?: string;
              defaultCollectionKey?: string;
              defaultCollectionParameters?: any;
              collectionSpec?: {
                  type: "collection";
                  key?: string;
                  name: string;
                  parametersSchema?: DataSchema;
                  fieldsSchema?: DataSchema;
                  list?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      filterFields?: string[];
                  };
                  search?: { apiRequests?: { path: unknown; method: unknown }[] };
                  match?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                  };
                  findById?: { apiRequests?: { path: unknown; method: unknown }[] };
                  create?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      requiredFields?: string[];
                      excludedFields?: string[];
                  };
                  update?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      excludedFields?: string[];
                  };
                  delete?: { apiRequests?: { path: unknown; method: unknown }[] };
                  events?: {
                      created?: {
                          type: "push" | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      updated?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      deleted?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      all?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      [key: string]: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                  };
                  customFields?: boolean;
                  udm?: Record<
                      string,
                      {
                          fields?: string[];
                          extract?: Record<string, any>;
                          parse?: Record<string, any>;
                      },
                  >;
                  find?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      queryFields?: string[];
                  };
              };
              isCustomized?: boolean;
              errors?: ErrorDataSchema[];
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentUuid?: string;
              parentKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
              userId?: string;
              tenantId?: string;
          }[],
      >

    • Parameters

      • data: {
            connectionId?: string;
            instanceKey?: string;
            dataSourceId?: string;
            universalDataSourceId?: string;
            udm?: string;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            collectionKey?: string;
            collectionParameters?: any;
            uuid?: string;
            key?: string;
            name?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationId?: string;
            integrationUuid?: string;
            integrationKey?: string;
            parentUuid?: string;
            parentKey?: string;
            isUniversal?: boolean;
            externalAppId?: string;
            externalAppUuid?: string;
            externalAppKey?: string;
        }

      Returns Promise<
          {
              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;
                  externalAppId?: string;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  optionsConfig?: Record<
                      string,
                      { disabled?: boolean; parameters?: Record<string, any> },
                  >;
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  isReadOnly?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      connectionId?: string;
                      instanceKey?: string;
                      dataSourceId?: string;
                      universalDataSourceId?: string;
                      udm?: string;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      collectionKey?: string;
                      collectionParameters?: any;
                      dataSourceRevision?: string;
                      universalDataSourceRevision?: string;
                      defaultCollectionKey?: string;
                      defaultCollectionParameters?: any;
                      collectionSpec?: {
                          type: "collection";
                          key?: string;
                          name: string;
                          parametersSchema?: DataSchema;
                          fieldsSchema?: DataSchema;
                          list?: { apiRequests?: (...)
                          | (...); filterFields?: (...) | (...) };
                          search?: { apiRequests?: (...) | (...) };
                          match?: { apiRequests?: (...) | (...); fields?: (...) | (...) };
                          findById?: { apiRequests?: (...) | (...) };
                          create?: {
                              apiRequests?: (...) | (...);
                              fields?: (...) | (...);
                              requiredFields?: (...) | (...);
                              excludedFields?: (...) | (...);
                          };
                          update?: {
                              apiRequests?: (...)
                              | (...);
                              fields?: (...) | (...);
                              excludedFields?: (...) | (...);
                          };
                          delete?: { apiRequests?: (...)
                          | (...) };
                          events?: {
                              created?: (...) | (...);
                              updated?: (...) | (...);
                              deleted?: (...) | (...);
                              all?: (...) | (...);
                              [key: string]: { type: ...; isFullScan?: ...; isIdOnly?: ... };
                          };
                          customFields?: boolean;
                          udm?: Record<string, { fields?: ...; extract?: ...; parse?: ... }>;
                          find?: { apiRequests?: (...) | (...); queryFields?: (...) | (...) };
                      };
                      isCustomized?: boolean;
                      errors?: ErrorDataSchema[];
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isReadOnly?: boolean;
                      integrationId?: string;
                      integrationUuid?: string;
                      integrationKey?: string;
                      parentUuid?: string;
                      parentKey?: string;
                      isUniversal?: boolean;
                      externalAppId?: string;
                      externalAppUuid?: string;
                      externalAppKey?: string;
                      userId?: string;
                      tenantId?: 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;
                      externalAppId?: string;
                      appUuid?: string;
                      isDeactivated?: boolean;
                      authType?: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      optionsConfig?: Record<
                          string,
                          { disabled?: boolean; parameters?: Record<(...), (...)> },
                      >;
                      id: string;
                      uuid?: string;
                      key?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?:
                          | BUILDING
                          | CLIENT_ACTION_REQUIRED
                          | CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY
                          | DISCONNECTING;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      isReadOnly?: boolean;
                  };
              }[];
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  isActive?: boolean;
                  aiCreditsRolling30DayLimit?: number | null;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              dataSource?: {
                  connectionId?: string;
                  instanceKey?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  dataSourceRevision?: string;
                  universalDataSourceRevision?: string;
                  defaultCollectionKey?: string;
                  defaultCollectionParameters?: any;
                  collectionSpec?: {
                      type: "collection";
                      key?: string;
                      name: string;
                      parametersSchema?: DataSchema;
                      fieldsSchema?: DataSchema;
                      list?: {
                          apiRequests?: { path: ...; method: ... }[];
                          filterFields?: string[];
                      };
                      search?: { apiRequests?: { path: ...; method: ... }[] };
                      match?: {
                          apiRequests?: { path: ...; method: ... }[];
                          fields?: string[];
                      };
                      findById?: { apiRequests?: { path: ...; method: ... }[] };
                      create?: {
                          apiRequests?: { path: ...; method: ... }[];
                          fields?: string[];
                          requiredFields?: string[];
                          excludedFields?: string[];
                      };
                      update?: {
                          apiRequests?: { path: ...; method: ... }[];
                          fields?: string[];
                          excludedFields?: string[];
                      };
                      delete?: { apiRequests?: { path: ...; method: ... }[] };
                      events?: {
                          created?: {
                              type: (...) | (...);
                              isFullScan?: (...) | (...) | (...);
                              isIdOnly?: (...) | (...) | (...);
                          };
                          updated?: {
                              type: (...)
                              | (...);
                              isFullScan?: (...) | (...) | (...);
                              isIdOnly?: (...) | (...) | (...);
                          };
                          deleted?: {
                              type: (...)
                              | (...);
                              isFullScan?: (...) | (...) | (...);
                              isIdOnly?: (...) | (...) | (...);
                          };
                          all?: {
                              type: (...)
                              | (...);
                              isFullScan?: (...) | (...) | (...);
                              isIdOnly?: (...) | (...) | (...);
                          };
                          [key: string]: {
                              type: "push"
                              | "pull";
                              isFullScan?: boolean;
                              isIdOnly?: boolean;
                          };
                      };
                      customFields?: boolean;
                      udm?: Record<
                          string,
                          {
                              fields?: (...)[];
                              extract?: Record<(...), (...)>;
                              parse?: Record<(...), (...)>;
                          },
                      >;
                      find?: {
                          apiRequests?: { path: ...; method: ... }[];
                          queryFields?: string[];
                      };
                  };
                  isCustomized?: boolean;
                  errors?: ErrorDataSchema[];
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  isReadOnly?: boolean;
                  integrationId?: string;
                  integrationUuid?: string;
                  integrationKey?: string;
                  parentUuid?: string;
                  parentKey?: string;
                  isUniversal?: boolean;
                  externalAppId?: string;
                  externalAppUuid?: string;
                  externalAppKey?: string;
                  userId?: string;
                  tenantId?: string;
              };
              path?: string;
              defaultPath?: string;
              connectionId?: string;
              instanceKey?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              collectionKey?: string;
              collectionParameters?: any;
              dataSourceRevision?: string;
              universalDataSourceRevision?: string;
              defaultCollectionKey?: string;
              defaultCollectionParameters?: any;
              collectionSpec?: {
                  type: "collection";
                  key?: string;
                  name: string;
                  parametersSchema?: DataSchema;
                  fieldsSchema?: DataSchema;
                  list?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      filterFields?: string[];
                  };
                  search?: { apiRequests?: { path: unknown; method: unknown }[] };
                  match?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                  };
                  findById?: { apiRequests?: { path: unknown; method: unknown }[] };
                  create?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      requiredFields?: string[];
                      excludedFields?: string[];
                  };
                  update?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      excludedFields?: string[];
                  };
                  delete?: { apiRequests?: { path: unknown; method: unknown }[] };
                  events?: {
                      created?: {
                          type: "push" | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      updated?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      deleted?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      all?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      [key: string]: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                  };
                  customFields?: boolean;
                  udm?: Record<
                      string,
                      {
                          fields?: string[];
                          extract?: Record<string, any>;
                          parse?: Record<string, any>;
                      },
                  >;
                  find?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      queryFields?: string[];
                  };
              };
              isCustomized?: boolean;
              errors?: ErrorDataSchema[];
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?:
                  | BUILDING
                  | CLIENT_ACTION_REQUIRED
                  | CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY
                  | DISCONNECTING;
              revision?: string;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              isReadOnly?: boolean;
              integrationId?: string;
              integrationUuid?: string;
              integrationKey?: string;
              parentUuid?: string;
              parentKey?: string;
              isUniversal?: boolean;
              externalAppId?: string;
              externalAppUuid?: string;
              externalAppKey?: string;
              userId?: string;
              tenantId?: string;
          },
      >