Class ConnectionAccessor

constructor

• new ConnectionAccessor(client, connectionSelector): 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, query?): ConnectionLevelActionAccessor

• Parameters

  • actionSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelActionAccessor

flow

• flow(flowSelector, query?): ConnectionLevelFlowAccessor

• Parameters

  • flowSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFlowAccessor

dataSource

• dataSource(dataSourceSelector, query?): ConnectionLevelDataSourceAccessor

• Parameters

  • dataSourceSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelDataSourceAccessor

fieldMapping

• fieldMapping(fieldMappingSelector, query?): ConnectionLevelFieldMappingAccessor

• Parameters

  • fieldMappingSelector: string
  • Optionalquery: InstanceKeyQuery

  Returns ConnectionLevelFieldMappingAccessor

get

• get(query?): Promise<Connection>

• Parameters

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

    • OptionalincludeSecrets?: boolean

  Returns Promise<Connection>

patch

• patch(data): Promise<Connection>

• Parameters

  • data: UpdateConnectionRequest

  Returns Promise<Connection>

put

• put(data): Promise<Connection>

• Parameters

  • data: UpdateConnectionRequest

  Returns Promise<Connection>

archive

• archive(): Promise<void>

• Returns Promise<void>

request

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

• Parameters

  • path: string
  • data: any = null

  Returns Promise<any>

operation

• operation(key): ConnectionOperationAccessor

• Parameters

  • key: string

  Returns ConnectionOperationAccessor

dataCollection

• dataCollection(key, parameters?): ConnectionDataCollectionAccessor

• Parameters

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

  Returns ConnectionDataCollectionAccessor

dataDirectory

• dataDirectory(key, parameters?): ConnectionDataDirectoryAccessor

• Parameters

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

  Returns ConnectionDataDirectoryAccessor

reconnect

• reconnect(__namedParameters?): Promise<undefined | Connection>

• Parameters

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

    • Optionalparameters?: any

    • OptionalauthOptionKey?: string

  Returns Promise<undefined | Connection>

openReconnectUI

• openReconnectUI(__namedParameters?): Promise<void>

• Parameters

  • __namedParameters: OpenConfigurationOptions = {}

  Returns Promise<void>

refreshCredentials

• refreshCredentials(): Promise<void>

• Returns Promise<void>

getPath

• getPath(subpath?, query?): string

• Parameters

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

  Returns string