Class ConnectionLevelFieldMappingsAccessor

client

connectionSelector

list

• list(
      query?: ListFieldMappingInstancesForConnectionQuery,
  ): Promise<
      PaginationResponse<
          {
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  name: string;
                  userId: string;
                  isTest?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?: CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY;
                  error?: ErrorDataSchema;
                  integrationId: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: string;
              };
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
              };
              fieldMapping?: {
                  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;
                  universalFieldMappingRevision?: string;
                  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;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  integrationId?: string;
                  isCustomized?: boolean;
              };
              dataSourceInstance?: {
                  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?: {
                      universalDataSourceId?: string;
                      udm?: string;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      collectionKey?: string;
                      collectionParameters?: any;
                      defaultPath?: string;
                      universalDataSourceRevision?: string;
                      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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      integrationId?: 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;
                      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;
                      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;
                  };
                  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;
                  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;
              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;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          }[],
      >,
  >

  Parameters

  • Optionalquery: ListFieldMappingInstancesForConnectionQuery

  Returns Promise<
      PaginationResponse<
          {
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  name: string;
                  userId: string;
                  isTest?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?: CONFIGURATION_ERROR
                  | SETUP_FAILED
                  | READY;
                  error?: ErrorDataSchema;
                  integrationId: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  id: string;
              };
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
              };
              fieldMapping?: {
                  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;
                  universalFieldMappingRevision?: string;
                  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;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  integrationId?: string;
                  isCustomized?: boolean;
              };
              dataSourceInstance?: {
                  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?: {
                      universalDataSourceId?: string;
                      udm?: string;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      collectionKey?: string;
                      collectionParameters?: any;
                      defaultPath?: string;
                      universalDataSourceRevision?: string;
                      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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      integrationId?: 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;
                      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;
                      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;
                  };
                  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;
                  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;
              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;
              id: string;
              key?: string;
              uuid?: string;
              description?: string;
              meta?: Record<string, any>;
              name: string;
              errors?: ErrorDataSchema[];
              createdAt?: string;
              updatedAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
          }[],
      >,
  >