Class ConnectionAccessor

constructor

• new ConnectionAccessor(
      client: IntegrationAppApiClient,
      connectionSelector: string,
  ): ConnectionAccessor

  Parameters

  • client: IntegrationAppApiClient
  • connectionSelector: string

  Returns ConnectionAccessor

client

connectionSelector

actions

• get actions(): ConnectionLevelActionsAccessor

  Returns ConnectionLevelActionsAccessor

flows

• get flows(): ConnectionLevelFlowsAccessor

  Returns ConnectionLevelFlowsAccessor

dataSources

• get dataSources(): ConnectionLevelDataSourcesAccessor

  Returns ConnectionLevelDataSourcesAccessor

fieldMappings

• get fieldMappings(): ConnectionLevelFieldMappingsAccessor

  Returns ConnectionLevelFieldMappingsAccessor

proxy

• get proxy(): ConnectionProxy

  Returns ConnectionProxy

action

• action(
      actionSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelActionAccessor

  Parameters

  • actionSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelActionAccessor

flow

• flow(
      flowSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelFlowAccessor

  Parameters

  • flowSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFlowAccessor

dataSource

• dataSource(
      dataSourceSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelDataSourceAccessor

  Parameters

  • dataSourceSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelDataSourceAccessor

fieldMapping

• fieldMapping(
      fieldMappingSelector: string,
      query?: InstanceKeyQuery,
  ): ConnectionLevelFieldMappingAccessor

  Parameters

  • fieldMappingSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFieldMappingAccessor

get

• get(query?: { includeSecrets?: boolean }): Promise<Connection>

  Parameters

  • query: { includeSecrets?: boolean } = ...

  Returns Promise<Connection>

patch

• patch(data: UpdateConnectionRequest): Promise<Connection>

  Parameters

  • data: UpdateConnectionRequest

  Returns Promise<Connection>

put

• put(data: UpdateConnectionRequest): Promise<Connection>

  Parameters

  • data: UpdateConnectionRequest

  Returns Promise<Connection>

archive

• archive(): Promise<void>

  Returns Promise<void>

request

• request(path: string, data?: any): Promise<any>

  Parameters

  • path: string
  • data: any = null

  Returns Promise<any>

operation

• operation(key: string): ConnectionOperationAccessor

  Parameters

  • key: string

  Returns ConnectionOperationAccessor

dataCollection

• dataCollection(
      key: string,
      parameters?: Record<string, any>,
  ): ConnectionDataCollectionAccessor

  Parameters

  • key: string
  • Optionalparameters: Record<string, any>

  Returns ConnectionDataCollectionAccessor

dataDirectory

• dataDirectory(
      key: string,
      parameters?: Record<string, any>,
  ): ConnectionDataDirectoryAccessor

  Parameters

  • key: string
  • Optionalparameters: Record<string, any>

  Returns ConnectionDataDirectoryAccessor

reconnect

• reconnect(
      __namedParameters?: {
          parameters?: any;
          authOptionKey?: string;
          connectorParameters?: any;
      },
  ): Promise<undefined | Connection>

  Parameters

  • __namedParameters: { parameters?: any; authOptionKey?: string; connectorParameters?: any } = {}

  Returns Promise<undefined | Connection>

openReconnectUI

• openReconnectUI(__namedParameters?: OpenConfigurationOptions): Promise<void>

  Parameters

  • __namedParameters: OpenConfigurationOptions = {}

  Returns Promise<void>

refreshCredentials

• refreshCredentials(): Promise<void>

  Returns Promise<void>

getPath

• getPath(subpath?: string, query?: Record<string, any>): string

  Parameters

  • Optionalsubpath: string
  • Optionalquery: Record<string, any>

  Returns string