Membrane React - v0.6.0
    Preparing search index...

    Function useFieldMappingInstance

    • Parameters

      Returns {
          loading: boolean;
          saving: boolean;
          error: any;
          refreshing: boolean;
          create: (
              data: CreateFieldMappingInstanceRequest,
          ) => Promise<
              | undefined
              | {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  userId: string;
                  revision: string;
                  connectionId: string;
                  integrationId: string;
                  fieldMappingRevision?: string;
                  fieldMappingId?: string;
                  instanceKey?: string;
                  dataSourceInstanceId?: string;
                  dataSourceSchema?: DataSchema;
                  direction?: IMPORT | EXPORT | BOTH;
                  appSchema?: DataSchema;
                  importValue?: any;
                  exportValue?: any;
                  isCustomized?: boolean;
                  unifiedExportValue?: any;
                  unifiedImportValue?: any;
                  frozenImportFields?: string[];
                  frozenExportFields?: string[];
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  error?: ErrorDataSchema;
                  externalSchema?: any;
                  user?: {
                      id: string;
                      name: string;
                      meta?: Record<string, any>;
                      internalId: string;
                      fields?: Record<string, any>;
                      credentials?: any;
                      lastActiveAt?: string;
                      isTest?: boolean;
                      isBillable?: boolean;
                      createdAt?: string;
                      archivedAt?: string;
                  };
                  connection?: {
                      id: string;
                      name: string;
                      userId: string;
                      isTest?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?: CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY;
                      error?: ErrorDataSchema;
                      integrationId: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  integration?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      logoUri: string;
                      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";
                  };
                  fieldMapping?: {
                      id: string;
                      key?: string;
                      description?: string;
                      uuid?: string;
                      meta?: Record<string, any>;
                      integrationId?: string;
                      universalFieldMappingId?: string;
                      dataSourceKey?: string;
                      dataSourceId?: string;
                      appSchema?: DataSchema;
                      direction?: IMPORT | EXPORT | BOTH;
                      defaultImportValue?: any;
                      defaultExportValue?: any;
                      importValue?: any;
                      exportValue?: any;
                      frozenImportFields?: any;
                      frozenExportFields?: any;
                      frozenUnifiedExportFields?: any;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isCustomized?: boolean;
                      universalFieldMappingRevision?: string;
                  };
                  dataSourceInstance?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      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?: ...; 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[];
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      path?: string;
                      defaultPath?: string;
                      user?: {
                          id: string;
                          name: string;
                          meta?: Record<(...), (...)>;
                          internalId: string;
                          fields?: Record<(...), (...)>;
                          credentials?: any;
                          lastActiveAt?: string;
                          isTest?: boolean;
                          isBillable?: boolean;
                          createdAt?: string;
                          archivedAt?: string;
                      };
                      dataSource?: {
                          id: string;
                          key?: string;
                          description?: string;
                          uuid?: string;
                          meta?: Record<(...), (...)>;
                          integrationId?: string;
                          universalDataSourceId?: string;
                          udm?: string;
                          pullUpdatesIntervalSeconds?: number;
                          fullSyncIntervalSeconds?: number;
                          collectionKey?: string;
                          collectionParameters?: any;
                          defaultPath?: string;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: (...)[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isCustomized?: boolean;
                          universalDataSourceRevision?: string;
                      };
                      connection?: {
                          id: string;
                          name: string;
                          userId: string;
                          isTest?: boolean;
                          disconnected?: boolean;
                          isDefunct?: boolean;
                          state?: CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY;
                          error?: ErrorDataSchema;
                          integrationId: string;
                          authOptionKey?: string;
                          createdAt: string;
                          updatedAt: string;
                          lastActiveAt?: string;
                          nextCredentialsRefreshAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          meta?: Record<(...), (...)>;
                      };
                      integration?: {
                          id: string;
                          key?: string;
                          uuid?: string;
                          description?: string;
                          meta?: Record<(...), (...)>;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: (...)[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          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";
                      };
                  };
              },
          >;
          patch: (data: Partial<UpdateRequest>) => Promise<void>;
          put: (data: UpdateFieldMappingInstanceRequest) => Promise<void>;
          archive: () => Promise<void>;
          fieldMappingInstance:
              | undefined
              | {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  userId: string;
                  revision: string;
                  connectionId: string;
                  integrationId: string;
                  fieldMappingRevision?: string;
                  fieldMappingId?: string;
                  instanceKey?: string;
                  dataSourceInstanceId?: string;
                  dataSourceSchema?: DataSchema;
                  direction?: IMPORT | EXPORT | BOTH;
                  appSchema?: DataSchema;
                  importValue?: any;
                  exportValue?: any;
                  isCustomized?: boolean;
                  unifiedExportValue?: any;
                  unifiedImportValue?: any;
                  frozenImportFields?: string[];
                  frozenExportFields?: string[];
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  error?: ErrorDataSchema;
                  externalSchema?: any;
                  user?: {
                      id: string;
                      name: string;
                      meta?: Record<string, any>;
                      internalId: string;
                      fields?: Record<string, any>;
                      credentials?: any;
                      lastActiveAt?: string;
                      isTest?: boolean;
                      isBillable?: boolean;
                      createdAt?: string;
                      archivedAt?: string;
                  };
                  connection?: {
                      id: string;
                      name: string;
                      userId: string;
                      isTest?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?: CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY;
                      error?: ErrorDataSchema;
                      integrationId: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  integration?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      logoUri: string;
                      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";
                  };
                  fieldMapping?: {
                      id: string;
                      key?: string;
                      description?: string;
                      uuid?: string;
                      meta?: Record<string, any>;
                      integrationId?: string;
                      universalFieldMappingId?: string;
                      dataSourceKey?: string;
                      dataSourceId?: string;
                      appSchema?: DataSchema;
                      direction?: IMPORT | EXPORT | BOTH;
                      defaultImportValue?: any;
                      defaultExportValue?: any;
                      importValue?: any;
                      exportValue?: any;
                      frozenImportFields?: any;
                      frozenExportFields?: any;
                      frozenUnifiedExportFields?: any;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isCustomized?: boolean;
                      universalFieldMappingRevision?: string;
                  };
                  dataSourceInstance?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      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?: (...)[]; 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[];
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      path?: string;
                      defaultPath?: string;
                      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?: {
                          id: string;
                          key?: string;
                          description?: string;
                          uuid?: string;
                          meta?: Record<string, any>;
                          integrationId?: string;
                          universalDataSourceId?: string;
                          udm?: string;
                          pullUpdatesIntervalSeconds?: number;
                          fullSyncIntervalSeconds?: number;
                          collectionKey?: string;
                          collectionParameters?: any;
                          defaultPath?: string;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isCustomized?: boolean;
                          universalDataSourceRevision?: string;
                      };
                      connection?: {
                          id: string;
                          name: string;
                          userId: string;
                          isTest?: boolean;
                          disconnected?: boolean;
                          isDefunct?: boolean;
                          state?: CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY;
                          error?: ErrorDataSchema;
                          integrationId: string;
                          authOptionKey?: string;
                          createdAt: string;
                          updatedAt: string;
                          lastActiveAt?: string;
                          nextCredentialsRefreshAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          meta?: Record<string, any>;
                      };
                      integration?: {
                          id: string;
                          key?: string;
                          uuid?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          logoUri: string;
                          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";
                      };
                  };
              };
          accessor: undefined
          | FieldMappingInstanceAccessor;
          refresh: () => Promise<
              {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  errors?: ErrorDataSchema[];
                  createdAt?: string;
                  updatedAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  userId: string;
                  revision: string;
                  connectionId: string;
                  integrationId: string;
                  fieldMappingRevision?: string;
                  fieldMappingId?: string;
                  instanceKey?: string;
                  dataSourceInstanceId?: string;
                  dataSourceSchema?: DataSchema;
                  direction?: IMPORT | EXPORT | BOTH;
                  appSchema?: DataSchema;
                  importValue?: any;
                  exportValue?: any;
                  isCustomized?: boolean;
                  unifiedExportValue?: any;
                  unifiedImportValue?: any;
                  frozenImportFields?: string[];
                  frozenExportFields?: string[];
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  error?: ErrorDataSchema;
                  externalSchema?: any;
                  user?: {
                      id: string;
                      name: string;
                      meta?: Record<string, any>;
                      internalId: string;
                      fields?: Record<string, any>;
                      credentials?: any;
                      lastActiveAt?: string;
                      isTest?: boolean;
                      isBillable?: boolean;
                      createdAt?: string;
                      archivedAt?: string;
                  };
                  connection?: {
                      id: string;
                      name: string;
                      userId: string;
                      isTest?: boolean;
                      disconnected?: boolean;
                      isDefunct?: boolean;
                      state?: CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY;
                      error?: ErrorDataSchema;
                      integrationId: string;
                      authOptionKey?: string;
                      createdAt: string;
                      updatedAt: string;
                      lastActiveAt?: string;
                      nextCredentialsRefreshAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  integration?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      logoUri: string;
                      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";
                  };
                  fieldMapping?: {
                      id: string;
                      key?: string;
                      description?: string;
                      uuid?: string;
                      meta?: Record<string, any>;
                      integrationId?: string;
                      universalFieldMappingId?: string;
                      dataSourceKey?: string;
                      dataSourceId?: string;
                      appSchema?: DataSchema;
                      direction?: IMPORT | EXPORT | BOTH;
                      defaultImportValue?: any;
                      defaultExportValue?: any;
                      importValue?: any;
                      exportValue?: any;
                      frozenImportFields?: any;
                      frozenExportFields?: any;
                      frozenUnifiedExportFields?: any;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      revision?: string;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      isCustomized?: boolean;
                      universalFieldMappingRevision?: string;
                  };
                  dataSourceInstance?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      createdAt?: string;
                      updatedAt?: string;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      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?: (...) | (...); 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[];
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      path?: string;
                      defaultPath?: string;
                      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?: {
                          id: string;
                          key?: string;
                          description?: string;
                          uuid?: string;
                          meta?: Record<string, any>;
                          integrationId?: string;
                          universalDataSourceId?: string;
                          udm?: string;
                          pullUpdatesIntervalSeconds?: number;
                          fullSyncIntervalSeconds?: number;
                          collectionKey?: string;
                          collectionParameters?: any;
                          defaultPath?: string;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          isCustomized?: boolean;
                          universalDataSourceRevision?: string;
                      };
                      connection?: {
                          id: string;
                          name: string;
                          userId: string;
                          isTest?: boolean;
                          disconnected?: boolean;
                          isDefunct?: boolean;
                          state?: CONFIGURATION_ERROR
                          | SETUP_FAILED
                          | READY;
                          error?: ErrorDataSchema;
                          integrationId: string;
                          authOptionKey?: string;
                          createdAt: string;
                          updatedAt: string;
                          lastActiveAt?: string;
                          nextCredentialsRefreshAt?: string;
                          archivedAt?: string;
                          isDeactivated?: boolean;
                          meta?: Record<string, any>;
                      };
                      integration?: {
                          id: string;
                          key?: string;
                          uuid?: string;
                          description?: string;
                          meta?: Record<string, any>;
                          name: string;
                          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                          errors?: ErrorDataSchema[];
                          revision?: string;
                          createdAt?: string;
                          updatedAt?: string;
                          logoUri: string;
                          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";
                      };
                  };
              },
          >;
          setup: () => Promise<void>;
          reset: () => Promise<void>;
          openConfiguration: (
              options?: OpenFieldMappingInstanceConfigurationOptions,
          ) => Promise<undefined | void>;
      }