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

    Class IntegrationLevelFieldMappingAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client integrationSelector fieldMappingSelector endpoint elementSelector elementKey

    Methods

    getUniqueIdentifier get patch put archive reset

    Constructors

    Properties

    client: MembraneApiClient
    integrationSelector: string
    fieldMappingSelector: string
    endpoint: string
    elementSelector: string
    elementKey: string

    Methods

    • Returns Promise<
          {
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  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;
              };
              appliedToIntegrations?: {
                  element: {
                      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;
                  };
                  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;
                  };
              }[];
              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;
          },
      >

    • Parameters

      Returns Promise<
          {
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  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;
              };
              appliedToIntegrations?: {
                  element: {
                      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;
                  };
                  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;
                  };
              }[];
              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;
          },
      >

    • Parameters

      • data: {
            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;
            key?: string;
            name?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            integrationId?: string;
        }
        • OptionaluniversalFieldMappingId?: string
        • OptionaldataSourceKey?: string
        • OptionaldataSourceId?: string
        • OptionalappSchema?: DataSchema
        • Optionaldirection?: IMPORT | EXPORT | BOTH
        • OptionaldefaultImportValue?: any
        • OptionaldefaultExportValue?: any
        • OptionalimportValue?: any
        • OptionalexportValue?: any
        • OptionalfrozenImportFields?: any
        • OptionalfrozenExportFields?: any
        • OptionalfrozenUnifiedExportFields?: any
        • Optionalkey?: string
        • Optionalname?: string
        • Optionaluuid?: string
        • Optionaldescription?: string
        • Optionalmeta?: Record<string, any>
        • OptionalintegrationId?: string

      Returns Promise<
          {
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  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;
              };
              appliedToIntegrations?: {
                  element: {
                      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;
                  };
                  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;
                  };
              }[];
              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;
          },
      >

    • Returns Promise<
          {
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  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;
              };
              appliedToIntegrations?: {
                  element: {
                      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;
                  };
                  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;
                  };
              }[];
              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;
          },
      >

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods