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

    Class ActionInstanceAccessor

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client options

    Methods

    setup reset run open getUniqueIdentifier get getId create put patch archive delete restore getPath

    Constructors

    Properties

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

    Methods

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • Optionalinput: any

      Returns Promise<{ output?: any; logs?: any[] }>

    • 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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: 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;
              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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: 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;
              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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: 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;
              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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: 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;
              isCustomized?: boolean;
          },
      >

    • Returns Promise<void>

      • use archive instead

    • 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;
              };
              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;
              };
              parent?: {
                  integrationId?: string;
                  connectionId?: string;
                  parentId?: string;
                  instanceKey?: string;
                  inputSchema?: DataSchema;
                  type?: | ListDataRecords
                  | FindDataRecordById
                  | MatchDataRecord
                  | CreateDataRecord
                  | FindOrCreateDataRecord
                  | UpdateDataRecord
                  | DeleteDataRecord
                  | SearchDataRecords
                  | ConnectorOperation
                  | ApiRequestToExternalApp
                  | ApiRequestToYourApp
                  | HttpRequest
                  | RunJavascript
                  | ApiRequest;
                  config?: any;
                  outputMapping?: any;
                  customOutputSchema?: DataSchema;
                  universalParentId?: string;
                  userId?: string;
                  outputSchema?: any;
                  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;
                  isCustomized?: boolean;
              };
              appliedToIntegrations?: {
                  element: {
                      integrationId?: string;
                      connectionId?: string;
                      parentId?: string;
                      instanceKey?: string;
                      inputSchema?: DataSchema;
                      type?: | ListDataRecords
                      | FindDataRecordById
                      | MatchDataRecord
                      | CreateDataRecord
                      | FindOrCreateDataRecord
                      | UpdateDataRecord
                      | DeleteDataRecord
                      | SearchDataRecords
                      | ConnectorOperation
                      | ApiRequestToExternalApp
                      | ApiRequestToYourApp
                      | HttpRequest
                      | RunJavascript
                      | ApiRequest;
                      config?: any;
                      outputMapping?: any;
                      customOutputSchema?: DataSchema;
                      universalParentId?: string;
                      userId?: string;
                      outputSchema?: any;
                      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;
                      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;
                  };
              }[];
              defaultOutputSchema?: DataSchema;
              transformedOutputSchema?: DataSchema;
              outputSchema?: DataSchema;
              dependencies?: any[];
              integrationId?: string;
              connectionId?: string;
              parentId?: string;
              instanceKey?: string;
              inputSchema?: DataSchema;
              type?: | ListDataRecords
              | FindDataRecordById
              | MatchDataRecord
              | CreateDataRecord
              | FindOrCreateDataRecord
              | UpdateDataRecord
              | DeleteDataRecord
              | SearchDataRecords
              | ConnectorOperation
              | ApiRequestToExternalApp
              | ApiRequestToYourApp
              | HttpRequest
              | RunJavascript
              | ApiRequest;
              config?: any;
              outputMapping?: any;
              customOutputSchema?: DataSchema;
              universalParentId?: string;
              userId?: 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;
              isCustomized?: boolean;
          },
      >

    • Parameters

      • operation: string = ''

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods