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

    Class DataSourceInstanceAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    options client

    Methods

    getUniqueIdentifier get getId create put patch archive delete restore getPath setup reset openConfiguration unifiedFieldsToNative getCollection listRecords matchRecord searchRecords findRecordById createRecord updateRecord deleteRecord findRecords

    Constructors

    Properties

    options: {
        client: MembraneApiClient;
        instancePath: string;
        selector: string | DataSourceInstanceSelector;
        type?: WorkspaceElementType;
    }
    client: MembraneApiClient

    Methods

    • 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;
              };
              dataSource?: {
                  connectionId?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  defaultPath?: string;
                  universalDataSourceRevision?: string;
                  id: string;
                  uuid?: string;
                  key?: 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;
                  integrationId?: string;
                  integrationUuid?: string;
                  parentUuid?: string;
                  instanceKey?: string;
                  isCustomized?: boolean;
              };
              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;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: 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;
                  uuid?: string;
                  key?: 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;
              revision: string;
              dataSourceRevision?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              connectionId: string;
              integrationId: string;
              instanceKey?: string;
              collectionKey?: string;
              collectionParameters?: any;
              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[];
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              path?: string;
              defaultPath?: string;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      • Optionaldata: { dataSourceId: string; connectionId: string; path?: 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;
              };
              dataSource?: {
                  connectionId?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  defaultPath?: string;
                  universalDataSourceRevision?: string;
                  id: string;
                  uuid?: string;
                  key?: 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;
                  integrationId?: string;
                  integrationUuid?: string;
                  parentUuid?: string;
                  instanceKey?: string;
                  isCustomized?: boolean;
              };
              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;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: 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;
                  uuid?: string;
                  key?: 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;
              revision: string;
              dataSourceRevision?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              connectionId: string;
              integrationId: string;
              instanceKey?: string;
              collectionKey?: string;
              collectionParameters?: any;
              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[];
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              path?: string;
              defaultPath?: string;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      • data: { dataSourceId: string; connectionId: string; path?: 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;
              };
              dataSource?: {
                  connectionId?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  defaultPath?: string;
                  universalDataSourceRevision?: string;
                  id: string;
                  uuid?: string;
                  key?: 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;
                  integrationId?: string;
                  integrationUuid?: string;
                  parentUuid?: string;
                  instanceKey?: string;
                  isCustomized?: boolean;
              };
              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;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: 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;
                  uuid?: string;
                  key?: 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;
              revision: string;
              dataSourceRevision?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              connectionId: string;
              integrationId: string;
              instanceKey?: string;
              collectionKey?: string;
              collectionParameters?: any;
              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[];
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              path?: string;
              defaultPath?: string;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      • data: {
            path?: string;
            collectionKey?: string;
            collectionParameters?: any;
            pullUpdatesIntervalSeconds?: number;
            fullSyncIntervalSeconds?: number;
            subscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean };
        }
        • Optionalpath?: string
          • use path instead
        • OptionalcollectionKey?: string
        • OptionalcollectionParameters?: any
        • OptionalpullUpdatesIntervalSeconds?: number
        • OptionalfullSyncIntervalSeconds?: number
        • OptionalsubscribedTo?: { created?: boolean; updated?: boolean; deleted?: boolean }

      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;
              };
              dataSource?: {
                  connectionId?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  defaultPath?: string;
                  universalDataSourceRevision?: string;
                  id: string;
                  uuid?: string;
                  key?: 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;
                  integrationId?: string;
                  integrationUuid?: string;
                  parentUuid?: string;
                  instanceKey?: string;
                  isCustomized?: boolean;
              };
              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;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: 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;
                  uuid?: string;
                  key?: 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;
              revision: string;
              dataSourceRevision?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              connectionId: string;
              integrationId: string;
              instanceKey?: string;
              collectionKey?: string;
              collectionParameters?: any;
              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[];
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              path?: string;
              defaultPath?: string;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Returns Promise<void>

      • use archive instead

    • 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;
              };
              dataSource?: {
                  connectionId?: string;
                  dataSourceId?: string;
                  universalDataSourceId?: string;
                  udm?: string;
                  pullUpdatesIntervalSeconds?: number;
                  fullSyncIntervalSeconds?: number;
                  collectionKey?: string;
                  collectionParameters?: any;
                  defaultPath?: string;
                  universalDataSourceRevision?: string;
                  id: string;
                  uuid?: string;
                  key?: 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;
                  integrationId?: string;
                  integrationUuid?: string;
                  parentUuid?: string;
                  instanceKey?: string;
                  isCustomized?: boolean;
              };
              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;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: 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;
                  uuid?: string;
                  key?: 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;
              revision: string;
              dataSourceRevision?: string;
              dataSourceId?: string;
              universalDataSourceId?: string;
              udm?: string;
              connectionId: string;
              integrationId: string;
              instanceKey?: string;
              collectionKey?: string;
              collectionParameters?: any;
              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[];
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              path?: string;
              defaultPath?: string;
              id: string;
              uuid?: string;
              key?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • unifiedFields: any

      Returns Promise<any>

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

    • Parameters

      • request: {
            parameters?: Record<string, any>;
            filter?: any;
            unifiedFilter?: any;
            cursor?: string;
        } = {}

      Returns Promise<
          {
              records: {
                  id: string;
                  name?: string;
                  uri?: string;
                  iconUri?: string;
                  fields?: Record<string, any>;
                  udm?: string;
                  unifiedFields?: Record<string, any>;
                  rawFields?: Record<string, any>;
                  createdTime?: string;
                  updatedTime?: string;
                  deletedTime?: string;
                  createdById?: string;
                  updatedById?: string;
              }[];
              drilldowns?: {
                  parameters?: Record<string, any>;
                  filter?: Record<string, any>;
              }[];
              cursor?: string;
          },
      >

    • Parameters

      • request: { parameters?: Record<string, any>; query: Record<string, any> }

      Returns Promise<
          {
              record?: {
                  id: string;
                  name?: string;
                  uri?: string;
                  iconUri?: string;
                  fields?: Record<string, any>;
                  udm?: string;
                  unifiedFields?: Record<string, any>;
                  rawFields?: Record<string, any>;
                  createdTime?: string;
                  updatedTime?: string;
                  deletedTime?: string;
                  createdById?: string;
                  updatedById?: string;
              };
          },
      >

    • Parameters

      • request: { parameters?: Record<string, any>; query: string; cursor?: string }

      Returns Promise<
          {
              records: {
                  id: string;
                  name?: string;
                  uri?: string;
                  iconUri?: string;
                  fields?: Record<string, any>;
                  udm?: string;
                  unifiedFields?: Record<string, any>;
                  rawFields?: Record<string, any>;
                  createdTime?: string;
                  updatedTime?: string;
                  deletedTime?: string;
                  createdById?: string;
                  updatedById?: string;
              }[];
              cursor?: string;
          },
      >

    • Parameters

      • request: string | { parameters?: Record<string, any>; id: string; udm?: string }

      Returns Promise<
          {
              record: {
                  id: string;
                  name?: string;
                  uri?: string;
                  iconUri?: string;
                  fields?: Record<string, any>;
                  udm?: string;
                  unifiedFields?: Record<string, any>;
                  rawFields?: Record<string, any>;
                  createdTime?: string;
                  updatedTime?: string;
                  deletedTime?: string;
                  createdById?: string;
                  updatedById?: string;
              };
          },
      >

    • Parameters

      • request: { parameters?: Record<string, any>; fields: Record<string, any> }

      Returns Promise<{ id: string }>

    • Parameters

      • request: { parameters?: Record<string, any>; id: string; fields: Record<string, any> }

      Returns Promise<{ id: string }>

    • Parameters

      • request: string | { parameters?: Record<string, any>; id: string; udm?: string }

      Returns Promise<Record<string, never>>

    • Parameters

      • request: { query?: any; cursor?: string } = {}

      Returns Promise<
          {
              records: {
                  id: string;
                  name?: string;
                  uri?: string;
                  iconUri?: string;
                  fields?: Record<string, any>;
                  udm?: string;
                  unifiedFields?: Record<string, any>;
                  rawFields?: Record<string, any>;
                  createdTime?: string;
                  updatedTime?: string;
                  deletedTime?: string;
                  createdById?: string;
                  updatedById?: string;
              }[];
              cursor?: string;
          },
      >

      • use listRecords instead

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods