Class IntegrationAccessor

constructor

• new IntegrationAccessor(
      client: IntegrationAppApiClient,
      integrationSelector: string,
  ): IntegrationAccessor

  Parameters

  • client: IntegrationAppApiClient
  • integrationSelector: string

  Returns IntegrationAccessor

baseUri

actions

• get actions(): IntegrationLevelActionsListAccessor

  Returns IntegrationLevelActionsListAccessor

flows

• get flows(): IntegrationLevelFlowsListAccessor

  Returns IntegrationLevelFlowsListAccessor

dataSources

• get dataSources(): IntegrationLevelDataSourcesListAccessor

  Returns IntegrationLevelDataSourcesListAccessor

fieldMappings

• get fieldMappings(): IntegrationLevelFieldMappingsListAccessor

  Returns IntegrationLevelFieldMappingsListAccessor

action

• action(actionSelector: string): IntegrationLevelActionAccessor

  Parameters

  • actionSelector: string

  Returns IntegrationLevelActionAccessor

flow

• flow(flowSelector: string): IntegrationLevelFlowAccessor

  Parameters

  • flowSelector: string

  Returns IntegrationLevelFlowAccessor

dataSource

• dataSource(dataSourceSelector: string): IntegrationLevelDataSourceAccessor

  Parameters

  • dataSourceSelector: string

  Returns IntegrationLevelDataSourceAccessor

fieldMapping

• fieldMapping(fieldMappingSelector: string): IntegrationLevelFieldMappingAccessor

  Parameters

  • fieldMappingSelector: string

  Returns IntegrationLevelFieldMappingAccessor

setup

• setup(): Promise<Integration>

  Returns Promise<Integration>

getConnectorSpec

• getConnectorSpec(): Promise<ConnectionSpec>

  Returns Promise<ConnectionSpec>

open

• open(
      __namedParameters?: OpenIntegrationUIIntegrationConfigurationOptions,
  ): Promise<void>

  Show integration UI to your user.

  Parameters

  • __namedParameters: OpenIntegrationUIIntegrationConfigurationOptions = {}

  Returns Promise<void>

openNewConnection

• openNewConnection(
      __namedParameters?: OpenNewConnectionOptions,
  ): Promise<Connection>

  Shows UI to create a new connection for this integration or refresh an existing one. Returns promise with a new connection or null if the user cancels the connection flow.

  Parameters

  • __namedParameters: OpenNewConnectionOptions = {}

  Returns Promise<Connection>

connect

• connect(
      __namedParameters?: {
          name?: string;
          parameters?: any;
          connectorParameters?: any;
          authOptionKey?: string;
          allowMultipleConnections?: boolean;
      } & (
          | { sameWindow: true; redirectUri: string }
          | { sameWindow?: false; redirectUri?: undefined }
      ),
  ): Promise<undefined | Connection>

  Creates or updates default connection for this integration.

  Parameters

  • __namedParameters: {
        name?: string;
        parameters?: any;
        connectorParameters?: any;
        authOptionKey?: string;
        allowMultipleConnections?: boolean;
    } & (
        | { sameWindow: true; redirectUri: string }
        | { sameWindow?: false; redirectUri?: undefined }
    ) = {}

  Returns Promise<undefined | Connection>

createConnection

• createConnection(
      __namedParameters: { parameters?: any; name?: string },
  ): Promise<undefined | Connection>

  Parameters

  • __namedParameters: { parameters?: any; name?: string }

  Returns Promise<undefined | Connection>

  Deprecated

  • call connect() instead.

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

getOperations

• getOperations(): Promise<OperationListItem[]>

  Returns Promise<OperationListItem[]>

getOperation

• getOperation(key: string): Promise<OperationSpec>

  Parameters

  • key: string

  Returns Promise<OperationSpec>

getDataCollections

• getDataCollections(): Promise<DataLocationListItem[]>

  Returns Promise<DataLocationListItem[]>

getDataCollection

• getDataCollection(key: string): Promise<DataLocationSpec>

  Parameters

  • key: string

  Returns Promise<DataLocationSpec>

getDataLocations

• getDataLocations(): Promise<DataLocationListItem[]>

  Returns Promise<DataLocationListItem[]>

  Deprecated

getDataLocation

• getDataLocation(key: string): Promise<DataLocationSpec>

  Parameters

  • key: string

  Returns Promise<DataLocationSpec>

  Deprecated