Integration App SDK - v0.2.0
    Preparing search index...

    Integration App SDK - v0.2.0

    Modules

    @membranehq/sdk

    Namespaces

    Formula

    Enumerations

    ActionType
    ActionDependencyType
    ActionRunLogStatus
    AlertStatus
    AlertSeverity
    AlertType
    ConnectorCopilotSuggestionType
    ConnectorCopilotFileChunkTopicKey
    CopilotTaskType
    CopilotTaskStatus
    CopilotActionType
    CopilotActionStatus
    CopilotActivityType
    DataLocationType
    DataDirectoryOperation
    ConnectorEventImplementationType
    ConnectorMethodImplementationType
    ConnectorStatus
    DataBuilderFormulaType
    DataLocatorStepType
    DataCollectionEventType
    DataLinkDirection
    ErrorDoc
    ErrorType
    BadRequestErrorKey
    ConnectionErrorKey
    ConcurrencyErrorKey
    ExternalEventType
    ExternalEventSubscriptionStatus
    ExternalEventPullStatus
    IncomingWebhooksState
    ExternalEventSubscriptionType
    ExternalEventLogStatus
    FieldMappingDirection
    FlowNodeRunStatus
    FlowRunState
    FlowRunNodeState
    FlowRunLaunchedByTrigger
    FlowNodeType
    FlowInstanceNodeState
    HttpRequestMethod
    IntegrationElementLevel
    IntegrationElementType
    LogRecordType
    OrgLimitsType
    OrgUserRole
    OrgUserStatus
    ScenarioTemplateCategory
    ScreenType
    ScreenBlockType
    UDM
    UsageType
    WebhookTypeEnum
    ConfigurationState
    WorkspaceElementType
    WorkspaceEventType
    WorkspaceElementState
    WorkspaceElementDependencyType
    WorkspaceOnboardingStep
    WorkspaceNotificationType
    ParallelExecutionLimits
    RateLimits
    WorkspaceSizeLimits
    CustomerLimits
    LimitUnits
    WorkspaceType

    Classes

    ElementAccessor
    ElementListAccessor
    ElementInstanceListAccessor
    ElementInstanceAccessor
    ActionsAccessor
    ActionAccessor
    ActionInstancesAccessor
    ActionInstanceAccessor
    IntegrationLevelActionAccessor
    IntegrationLevelActionsListAccessor
    ConnectionLevelActionAccessor
    ConnectionLevelActionsAccessor
    AppDataSchemasAccessor
    AppDataSchemaAccessor
    AppDataSchemaInstancesAccessor
    AppDataSchemaInstanceAccessor
    AppEventTypesAccessor
    AppEventTypeAccessor
    AppEventSubscriptionsAccessor
    AppEventSubscriptionAccessor
    AppEventsAccessor
    SelfAccessor
    IntegrationAppClient
    ConnectionsAccessor
    ConnectionAccessor
    ConnectionOperationAccessor
    ConnectionDataDirectoryAccessor
    ConnectionDataCollectionAccessor
    ConnectionProxy
    CreateConnectionRequest
    UpdateConnectionRequest
    FindConnectionsResponse
    Connection
    ConnectionSpec
    DataLocatorStep
    DataLocatorStepObjectProperty
    DataLocatorStepArrayItem
    InvalidLocatorError
    DataFilterCondition
    DataForm
    DataLinkTablesAccessor
    DataLinkTableAccessor
    DataLinkTableInstancesAccessor
    DataLinkTableInstanceAccessor
    IDataField
    DataField
    DataSourcesAccessor
    DataSourceAccessor
    DataSourceInstancesAccessor
    DataSourceInstanceAccessor
    IntegrationLevelDataSourceAccessor
    IntegrationLevelDataSourcesListAccessor
    ConnectionLevelDataSourceAccessor
    ConnectionLevelDataSourcesAccessor
    PaginationResponse
    ErrorData
    IntegrationAppError
    InternalError
    BadRequestError
    ConcurrencyError
    ConfigurationError
    DependencyError
    FlowInstanceSetupError
    FlowRunError
    ActionRunError
    ActionInstanceSetupError
    UnitRunError
    ConnectionError
    NotFoundError
    RateLimitExceededError
    NotAuthenticatedError
    AccessDeniedError
    CustomCodeError
    ExternalEventSubscriptionsAccessor
    ExternalEventSubscriptionAccessor
    FieldMappingsAccessor
    FieldMappingAccessor
    FieldMappingInstancesAccessor
    FieldMappingInstanceAccessor
    IntegrationLevelFieldMappingAccessor
    IntegrationLevelFieldMappingsListAccessor
    ConnectionLevelFieldMappingAccessor
    ConnectionLevelFieldMappingsAccessor
    FlowRunsAccessor
    FlowRunAccessor
    FlowsAccessor
    FlowAccessor
    FlowInstancesAccessor
    FlowInstanceAccessor
    IntegrationLevelFlowAccessor
    IntegrationLevelFlowsListAccessor
    ConnectionLevelFlowAccessor
    ConnectionLevelFlowsAccessor
    FlowNodeSpec
    IntegrationsAccessor
    IntegrationAccessor
    ScenariosAccessor
    ScenarioAccessor
    ScreensAccessor
    ScreenAccessor
    CustomersAccessor
    CustomerAccessor

    Interfaces

    BaseElementInstance
    ElementInstanceSelector
    IntegrationSpecificElementSelector
    ActionSpec
    ActionDependency
    Action
    ActionInstance
    ListActionsForIntegrationQuery
    FindActionsQuery
    ActionSelector
    ActionInstanceSelector
    FindActionInstancesQuery
    CreateActionInstanceRequest
    UpdateActionInstanceRequest
    OpenActionConfigurationOptions
    ActionRunResponse
    Alert
    FindAppDataSchemasQuery
    AppDataSchemaInstanceSelector
    UpdateAppDataSchemaInstanceRequest
    CreateAppDataSchemaInstanceRequest
    FindAppDataSchemaInstancesQuery
    AppDataSchema
    AppDataSchemaInstance
    UpdateAppEventTypeRequest
    CreateAppEventTypeRequest
    AppEventSubscriptionSelector
    AppEventSubscriptionCreateRequest
    AppEventSubscriptionUpdateRequest
    FindAppEventTypesQuery
    FindAppEventSubscriptionsQuery
    FindAppEventsQuery
    AppEventType
    AppEventSubscription
    AppEvent
    App
    AppCategory
    Self
    FindConnectionsQuery
    ConnectionSelector
    ConnectionRequest
    ConnectorCopilotSuggestion
    ConnectorCopilotSuggestionAction
    CopilotTask
    CopilotAction
    CopilotActivityDataTask
    CopilotActivity
    CopilotActionReference
    ConnectorAuthHandlerBase
    ConnectorAuthOAuth2
    ConnectorAuthOAuth1
    ConnectorAuthClientCredentials
    ConnectorAuthProxy
    ConnectorAuthIntegrationAppToken
    ConnectorAuthOAuth2Config
    ConnectorAuthOAuth1Config
    ConnectorDataLocationBase
    PullLatestRecordsEventOutput
    ConnectorDataCollection
    ConnectorDataDirectory
    DataLocationListItem
    DataLocationPointer
    DataLocation
    DataLocationMixin
    DataCollectionSpec
    ApiRequestSpec
    DataDirectorySpec
    DataCollectionMethodSpec
    DataCollectionFindSpec
    DataCollectionMatchSpec
    DataCollectionListSpec
    DataCollectionSearchSpec
    DataCollectionFindByIdSpec
    DataCollectionCreateSpec
    DataCollectionUpdateSpec
    DataCollectionDeleteSpec
    DataCollectionMethodRequest
    DataCollectionFindRequest
    DataCollectionFindResponse
    DataCollectionListRequest
    DataCollectionListResponseDrilldown
    DataCollectionListResponse
    DataCollectionSearchRequest
    DataCollectionSearchResponse
    DataCollectionFindByIdRequest
    DataCollectionFindByIdResponse
    DataCollectionMatchRequest
    DataCollectionMatchResponse
    DataCollectionCreateRequest
    DataCollectionCreateResponse
    DataCollectionUpdateRequest
    DataCollectionUpdateResponse
    DataCollectionDeleteRequest
    DataCollectionDeleteResponse
    DataCollectionSubscribeRequest
    DataCollectionSubscribeResponse
    DataCollectionUpdateSubscriptionRequest
    DataCollectionUpdateSubscriptionResponse
    DataCollectionUnsubscribeRequest
    DataCollectionUnsubscribeResponse
    DataCollectionEventsRequest
    DataCollectionEventsResponse
    DataEventWebhookPayload
    DataCollectionParseUnifiedFieldsRequest
    DataCollectionParseUnifiedFieldsResponse
    DataDirectoryListRequest
    DataDirectoryListResponse
    ConnectorEventHandler
    ConnectorEventSpec
    ConnectorEventListItem
    ConnectorEventGlobalWebhookGetEventSelectorResponse
    ConnectorGlobalWebhookHandler
    ConnectorGlobalWebhookSpec
    ConnectorGlobalWebhookHandleRequest
    ConnectorGlobalWebhookHandleResponse
    ConnectorGlobalWebhookListItem
    GraphqlApiClientInput
    GraphQLApiMapping
    GraphQLFieldMapping
    ConnectorMethodImplementationBase
    ConnectorMethodImplementationMapping
    ConnectorMethodImplementationOperationMapping
    ConnectorMethodImplementationRestApiMapping
    ConnectorMethodImplementationGraphqlApiMapping
    ConnectorMethodImplementationJavascript
    ConnectorMethodImplementationNotSupported
    OpenapiMapping
    ConnectorOperationHandler
    OperationListItem
    OperationSpec
    OperationRunRequest
    OperationRunResponse
    OperationMapping
    RestApiClientInput
    RestApiClientOutput
    RestApiMapping
    RestApiClientResponseHandler
    RestApiClientOverride
    RestApiClientOptions
    RestApiClientConstructorOptions
    ConnectorUiSpec
    ConnectorSpec
    ConnectorUdmListLitem
    ConnectorUdmSpec
    ConnectorUdmCollectionMapping
    LookupValue
    CaseFormulaValueItem
    EvalOperator
    MappingItem
    DataRecord
    DataCollectionEvent
    DataFormArgs
    FieldValueOption
    FindDataLinkTablesQuery
    FindDataLinkTableInstancesQuery
    DataLinkTableInstanceSelector
    UpdateDataLinkTableInstanceRequest
    CreateDataLinkTableInstanceRequest
    FindDataLinksInTableQuery
    CreateDataLinkRequest
    DeleteDataLinkRequest
    FindDataLinksQuery
    FindDataLinksResponse
    FindDataLinkQuery
    DataLinkInTableSelector
    DataLinkSelector
    DataLinkTable
    DataLinkTableInstance
    DataLinkTableConfig
    PatchSchemaOption
    DataSchema
    ValueToSchemaOptions
    OpenDataSourceConfigurationOptions
    ListDataSourcesForIntegrationQuery
    FindDataSourcesQuery
    DataSourceInstanceSelector
    FindDataSourceInstancesQuery
    CreateDataSourceInstanceRequest
    UpdateDataSourceInstanceRequest
    FindDataSourceEventsQuery
    FindDataSourceSyncsQuery
    FindDataSourceInstanceSyncsQuery
    DataSourceUnitConfig
    DataSource
    DataSourceInstance
    DataSourceSelector
    FindExternalEventSubscriptionsQuery
    FindExternalEventLogsQuery
    FindExternalEventPullsQuery
    ExternalEventUnitConfig
    ExternalEventSubscriptionConfig
    ExternalEvent
    ExternalEventSubscription
    ExternalEventLogRecord
    ExternalEventCustomPullSubscribeResponse
    ExternalEventCustomPullCollectEventsRequest
    ExternalEventCustomPullCollectEventsResponse
    ExternalEventWebhookSubscribeRequest
    ExternalEventWebhookSubscribeResponse
    ExternalEventWebhookUnsubscribeRequest
    ExternalEventWebhookHandleRequest
    ExternalEventWebhookHandleResponse
    ExternalEventWebhookRefreshRequest
    ExternalEventWebhookRefreshResponse
    ExternalEventPull
    OpenFieldMappingInstanceConfigurationOptions
    ListFieldMappingsForIntegrationQuery
    FindFieldMappingsQuery
    UpdateFieldMappingRequest
    CreateFieldMappingRequest
    CreateFieldMappingInstanceRequest
    UpdateFieldMappingInstanceRequest
    FieldMappingInstanceSelector
    FieldMappingSelector
    FieldMapping
    FieldMappingInstance
    FieldMappingUnitConfig
    OpenFlowRunEditorOptions
    FlowNodeHandlerRunResponse
    UpstreamFlowNodeRun
    DownstreamFlowNodeRun
    FlowNodeRunParameters
    FlowNodeRunOutput
    FlowNodeRunResult
    FlowNodeRunRecord
    FlowRun
    FlowRunNode
    FlowRunLaunchedBy
    CreateFlowRunRequest
    FindFlowRunsQuery
    FindFlowRunsResponse
    OpenFlowInstanceConfigurationOptions
    OpenFlowInstanceEditorOptions
    ListFlowsForIntegrationQuery
    FindFlowsQuery
    CreateFlowNodeRequest
    CreateFlowRequest
    UpdateFlowRequest
    FlowSelector
    FlowInstanceSelector
    ResetFlowInstanceOptions
    RunFlowOptions
    FlowNode
    Flow
    FlowInstance
    FlowInstanceNode
    HttpRequestSpec
    ElementTemplateFields
    ElementInstanceFields
    IntegrationElement
    IntegrationElementInstance
    IntegrationElementInstanceDependency
    CreateIntegrationRequest
    UpdateIntegrationRequest
    FindIntegrationsQuery
    FindIntegrationsResponse
    OpenNewConnectionOptions
    Integration
    LogRecord
    OrgLimits
    Org
    PlatformUser
    OrgUser
    OrgWorkspace
    Scenario
    FindScenariosQuery
    CreateScenarioRequest
    UpdateScenarioRequest
    ScenarioTemplate
    FindScenarioTemplatesQuery
    CreateScenarioTemplateRequest
    UpdateScenarioTemplateRequest
    HandyScenarioTemplateElement
    ScreenBlock
    ScreenSelector
    UpdateScreenRequest
    CreateScreenRequest
    FindScreensQuery
    Screen
    UnifiedDataModel
    UsageWithCredits
    UsageEntry
    Webhook
    WorkspaceElementSpec
    WorkspaceElements
    ConfigurationStateResult
    WorkspaceElementCalculateStateResult
    WorkspaceElement
    WorkspaceElementReference
    WorkspaceElementDependency
    WorkspaceUpdate
    IWorkspaceUpdate
    Workspace
    EngineWorkspaceSettings
    EngineWorkspace
    WorkspaceUser
    UserWorkspaceSettings
    WorkspaceNotification
    CopilotActivityNotificationData
    WorkspaceLimit
    WorkspaceLimits
    EngineWorkspaceWithOrgData

    Type Aliases

    CreateActionRequest
    UpdateActionRequest
    ListActionInstancesForConnectionQuery
    CreateAppDataSchemaRequest
    UpdateAppDataSchemaRequest
    ConnectionUiSpec
    ConnectionUdmSpec
    ConnectionDataSpec
    ConnectionMessagePayload
    ConnectorAuthType
    ConnectorAuthSpec
    ConnectorAuth
    ConnectorAuthOAuthConfig
    ConnectorDataCollectionEvent
    ConnectorDataCollectionEventWebhook
    ConnectorDataCollectionEventPullLatestRecords
    ConnectorDataCollectionEventCustomPull
    ConnectorDataCollectionEventFullScan
    ConnectorDataCollectionEventType
    ConnectorDataCollectionEventImplementationTypeKey
    ConnectorDataLocationMethod
    DataLocationSpec
    DataCollectionUdmSpec
    DataCollectionUdmsSpec
    DataCollectionEventTypeSpec
    DataCollectionEventsSpec
    ConnectorDataLocation
    ConnectorMethodImplementation
    ConnectorOperationMethod
    Connector
    ConnectorDataUdmSpec
    ConnectorDataSpec
    ConnectorApiType
    MinimalConnector
    CaseFormulaValue
    DataLocator
    DataFilter
    CreateDataLinkTableRequest
    UpdateDataLinkTableRequest
    CreateDataSourceRequest
    UpdateDataSourceRequest
    FindDataSourceInstancesResponse
    ListDataSourceInstancesForConnectionQuery
    CommonListElementsQuery
    CommonInstancesListQuery
    CommonIntegrationOrConnectionQuery
    IncludeArchivedQuery
    SearchQuery
    PaginationQuery
    ListFieldMappingInstancesForConnectionQuery
    FindFieldMappingInstancesQuery
    FlowNodeRunRecordWithoutOutputsData
    FlowNodeRunOutputWithoutDownstreamRuns
    ListFlowInstancesForConnectionQuery
    FindFlowInstancesQuery
    CreateFlowInstanceRequest
    UpdateFlowInstanceRequest
    IntegrationAuthOption
    AppliedToIntegrations
    WithExecutionLogs
    ScenarioToDo
    ScenarioElement
    ScenarioTemplateElementOverride
    ScenarioTemplateKeyCollision
    ScenarioTemplateIntegration
    ScenarioTemplateElements
    CreateCustomerRequest
    UpdateCustomerRequest
    FindCustomersQuery
    CustomerSelector
    CreateUserRequest
    UpdateUserRequest
    FindUsersQuery
    UserSelector
    Customer
    User
    WebhookType

    Variables

    ACTIONS
    CopilotActivityScope
    CONNECTOR_AUTH_TYPES
    ConnectorAuthMethodTypes
    OAUTH_CONFIG_SCHEMA
    OAUTH1_CONFIG_SCHEMA
    CONNECTOR_DATA_DIR
    CONNECTOR_OPERATIONS_DIR
    CONNECTOR_DOCS_DIR
    CONNECTOR_GLOBAL_WEBHOOKS_DIR
    CONNECTOR_EVENTS_DIR
    ConnectorDataCollectionEventImplementationType
    DataLocationTypeCollection
    ConnectorDataCollectionMethodKeys
    DataLocationTypeDirectory
    ConnectorDataDirectoryMethodKeys
    DataLocationMethodImplementationTypes
    ConnectorDataLocationTypes
    DATA_RECORD_SCHEMA
    ConnectorEventHandlerMethods
    CONNECTOR_METHOD_IMPLEMENTATION_SUFFIXES
    ConnectorOperationMethodImplementationTypes
    CONNECTOR_CATEGORIES
    getFullTitleForLocator
    DEFAULT_PULL_UPDATES_INTERVAL_SECONDS
    DEFAULT_FULL_SYNC_INTERVAL_SECONDS
    MIN_FULL_SYNC_INTERVAL_SECONDS
    MIN_PULL_UPDATES_INTERVAL_SECONDS
    FLOW_NODE_SPECS
    createFlowInstanceSchema
    updateFlowInstanceSchema
    HTTP_REQUEST_SCHEMA
    UNIFIED_DATA_MODELS
    WorkspaceElementSpecs
    PARALLEL_EXECUTION_LIMITS
    RATE_LIMITS
    WORKSPACE_SIZE_LIMITS
    EDITABLE_LIMITS

    Functions

    isDataActionType
    getEventMethodFileKey
    getAllEventMethodFilePaths
    getDataLocationMethodPath
    dataLocationParametersMatch
    parseDataLocationPath
    makeDataLocationPath
    makeDataLocationOperationPath
    isSameDataLocation
    isDataLocationMethodSupported
    getDataCollectionCreateFields
    getDataCollectionUpdateFields
    getWritableFieldsSchema
    makeDataRecordSchema
    findUdmCollectionMapping
    buildData
    resolveFormulas
    resolveValue
    valueToString
    buildValue
    processCopy
    getVariableLocators
    transformVars
    removeNonExistentVars
    getValueByLocator
    isFormula
    hasFormulas
    getFormula
    locatorToField
    makeObjectPropertyLocator
    getLocatorsFromSchema
    getSchemaByLocator
    findValueLocators
    getValueAtLocator
    setValueAtLocator
    pickFieldsFromValue
    excludeFieldsFromValue
    setSchemaAtLocator
    extractFieldLocator
    makeSchemaForLocator
    getNameForLocator
    getNameComponentsForLocator
    getFullNameForLocator
    getIconUriForLocator
    getLocatorsFromData
    isValidLocator
    locatorToSteps
    locatorToString
    stepsToLocator
    createObjectFromLocators
    getFormulaLocators
    transformVariablesWith
    backwardCompatibleFilterMatch
    doesMatchFilter
    getOperatorsBySchema
    getFilterFieldValuesByLocator
    createSchema
    createCompoundSchema
    mergeSchemas
    patchSchema
    unwrapSchema
    unwrapSchemas
    wrapAnyOfSchema
    buildDataSchema
    updateImpliedSchema
    schemaHasProperties
    nonEmptyObjectProperties
    getSchemaFromValue
    schemaTypeFromValue
    valueToSchema
    schemaIsScalar
    schemaHasFixedValues
    schemaAllowsCustomValue
    schemaIsNumber
    schemaWithTitle
    pickFieldsFromSchema
    excludeReadOnlyFieldsFromSchema
    excludeWriteOnlyFieldsFromSchema
    excludeFieldsFromSchema
    getRequiredFieldsFromSchema
    addRequiredFieldsToSchema
    removeRequiredFieldsFromSchema
    getMissingRequiredFields
    populateSchemaTitles
    generateExampleFromSchema
    isSchemaEmpty
    compressDataSchema
    getReferenceCollectionPointerForSchema
    getReferenceCollectionPathForSchema
    walkSchema
    parseDate
    isIntegrationAppError
    getErrorFromData
    extractIntegrationAppErrorData
    buildUserFriendlyErrorMessage
    externalEventTypeToDataCollectionEventType
    dataCollectionEventTypeToExternalEventType
    externalEventTypeToSubscriptionType
    mergeWithFormulas
    isObject
    getFlowNode
    getFlowNodeTitle
    getFlowNodeDescription
    getFlowNodeSpec
    getFlowInstanceNodeDependency
    getRootNodeKeys
    getChildNodeKeys
    getDownstreamNodeKeys
    getParentNodeKeys
    getUpstreamNodeKeys
    hasCycles
    isStream
    streamToString
    truncateData
    findUdmRootLocation
    findUdmDefaultCollection
    addUdmFallbackFields
    getNodeInputSchema
    getFlowNodeConfigTimeVariablesSchema
    getActionRunTimeVariablesSchema
    getActionInstanceVariableSchema
    getFlowNodeRunTimeVariablesSchema