Class IntegrationAppClient

Hierarchy (View Summary)

MembraneApiClient
- IntegrationAppClient

Constructors

constructor

new IntegrationAppClient(options: MembraneClientOptions): IntegrationAppClient
Parameters
- options: MembraneClientOptions
Returns IntegrationAppClient
Overrides MembraneApiClient.constructor
- Defined in client.ts:67

Properties

apiUri

apiUri: string

uiUri

uiUri: string

`Optional`token

token?: string

`Protected` `Optional`fetchToken

fetchToken?: () => Promise<string>

Accessors

self

get self(): SelfAccessor
Returns SelfAccessor
- Defined in client.ts:71

flows

get flows(): FlowsAccessor
Returns FlowsAccessor
- Defined in client.ts:75

action

action(selector: string | ActionSelector): ActionAccessor
Parameters
- selector: string | ActionSelector
Returns ActionAccessor
- Defined in client.ts:89

actions

get actions(): ActionsAccessor
Returns ActionsAccessor
- Defined in client.ts:93

screen

screen(selector: string | ScreenSelector): ScreenAccessor
Parameters
- selector: string | ScreenSelector
Returns ScreenAccessor
- Defined in client.ts:100

screens

get screens(): ScreensAccessor
Returns ScreensAccessor
- Defined in client.ts:104

actionInstance

actionInstance(
selector: string | ActionInstanceSelector,
): ActionInstanceAccessor
Parameters
- selector: string | ActionInstanceSelector
Returns ActionInstanceAccessor
- Defined in client.ts:111

actionInstances

get actionInstances(): ActionInstancesAccessor
Returns ActionInstancesAccessor
- Defined in client.ts:115

flow

flow(selector: string | FlowSelector): FlowAccessor
Parameters
- selector: string | FlowSelector
Returns FlowAccessor
- Defined in client.ts:122

flowInstances

get flowInstances(): FlowInstancesAccessor
Returns FlowInstancesAccessor
- Defined in client.ts:126

flowInstance

flowInstance(selector: string | FlowInstanceSelector): FlowInstanceAccessor
Parameters
- selector: string | FlowInstanceSelector
Returns FlowInstanceAccessor
- Defined in client.ts:133

dataSourceInstances

get dataSourceInstances(): DataSourceInstancesAccessor
Returns DataSourceInstancesAccessor
- Defined in client.ts:137

dataSources

get dataSources(): DataSourcesAccessor
Returns DataSourcesAccessor
- Defined in client.ts:141

dataSource

dataSource(selector: string | DataSourceSelector): DataSourceAccessor
Parameters
- selector: string | DataSourceSelector
Returns DataSourceAccessor
- Defined in client.ts:148

dataSourceInstance

dataSourceInstance(
selector: string | DataSourceInstanceSelector,
): DataSourceInstanceAccessor
Parameters
- selector: string | DataSourceInstanceSelector
Returns DataSourceInstanceAccessor
- Defined in client.ts:155

fieldMappings

get fieldMappings(): FieldMappingsAccessor
Returns FieldMappingsAccessor
- Defined in client.ts:162

fieldMapping

fieldMapping(selector: string | FieldMappingSelector): FieldMappingAccessor
Parameters
- selector: string | FieldMappingSelector
Returns FieldMappingAccessor
- Defined in client.ts:169

fieldMappingInstances

get fieldMappingInstances(): FieldMappingInstancesAccessor
Returns FieldMappingInstancesAccessor
- Defined in client.ts:173

fieldMappingInstance

fieldMappingInstance(
selector: string | FieldMappingInstanceSelector,
): FieldMappingInstanceAccessor
Parameters
- selector: string | FieldMappingInstanceSelector
Returns FieldMappingInstanceAccessor
- Defined in client.ts:180

dataLinkTables

get dataLinkTables(): DataLinkTablesAccessor
Returns DataLinkTablesAccessor
- Defined in client.ts:184

dataLinkTable

dataLinkTable(idOrKey: string): DataLinkTableAccessor
Parameters
- idOrKey: string
Returns DataLinkTableAccessor
- Defined in client.ts:191

dataLinkTableInstances

get dataLinkTableInstances(): DataLinkTableInstancesAccessor
Returns DataLinkTableInstancesAccessor
- Defined in client.ts:195

dataLinkTableInstance

dataLinkTableInstance(
selector: string | DataLinkTableInstanceSelector,
): DataLinkTableInstanceAccessor
Parameters
- selector: string | DataLinkTableInstanceSelector
Returns DataLinkTableInstanceAccessor
- Defined in client.ts:202

integrations

get integrations(): IntegrationsAccessor
Returns IntegrationsAccessor
- Defined in client.ts:206

externalEventSubscriptions

externalEventSubscriptions(): ExternalEventSubscriptionsAccessor
Returns ExternalEventSubscriptionsAccessor
- Defined in client.ts:213

externalEventSubscription

externalEventSubscription(id: string): ExternalEventSubscriptionAccessor
Parameters
- id: string
Returns ExternalEventSubscriptionAccessor
- Defined in client.ts:220

integration

integration(identifier: string): IntegrationAccessor
Parameters
- identifier: string
Returns IntegrationAccessor
- Defined in client.ts:227

connections

get connections(): ConnectionsAccessor
Returns ConnectionsAccessor
- Defined in client.ts:231

connection

connection(connectionSelector: string): ConnectionAccessor
Parameters
- connectionSelector: string
Returns ConnectionAccessor
- Defined in client.ts:238

appEventTypes

get appEventTypes(): AppEventTypesAccessor
Returns AppEventTypesAccessor
- Defined in client.ts:242

appEventType

appEventType(id: string): AppEventTypeAccessor
Parameters
- id: string
Returns AppEventTypeAccessor
- Defined in client.ts:249

appEventSubscriptions

get appEventSubscriptions(): AppEventSubscriptionsAccessor
Returns AppEventSubscriptionsAccessor
- Defined in client.ts:253

appEventSubscription

appEventSubscription(
selector: string | AppEventSubscriptionSelector,
): AppEventSubscriptionAccessor
Parameters
- selector: string | AppEventSubscriptionSelector
Returns AppEventSubscriptionAccessor
- Defined in client.ts:260

flowRuns

get flowRuns(): FlowRunsAccessor
Returns FlowRunsAccessor
- Defined in client.ts:264

flowRun

flowRun(id: string): FlowRunAccessor
Parameters
- id: string
Returns FlowRunAccessor
- Defined in client.ts:271

appDataSchemas

get appDataSchemas(): AppDataSchemasAccessor
Returns AppDataSchemasAccessor
- Defined in client.ts:275

appDataSchema

appDataSchema(id: string): AppDataSchemaAccessor
Parameters
- id: string
Returns AppDataSchemaAccessor
- Defined in client.ts:282

appDataSchemaInstances

get appDataSchemaInstances(): AppDataSchemaInstancesAccessor
Returns AppDataSchemaInstancesAccessor
- Defined in client.ts:286

appDataSchemaInstance

appDataSchemaInstance(
selector: string | AppDataSchemaInstanceSelector,
): AppDataSchemaInstanceAccessor
Parameters
- selector: string | AppDataSchemaInstanceSelector
Returns AppDataSchemaInstanceAccessor
- Defined in client.ts:293

customers

get customers(): CustomersAccessor
Returns CustomersAccessor
- Defined in client.ts:304

packages

get packages(): PackagesAccessor
Returns PackagesAccessor
- Defined in client.ts:315

Methods

setCredentials

setCredentials(credentials: any): Promise<any>
Parameters
- credentials: any
Returns Promise<any>
Inherited from MembraneApiClient.setCredentials
- Defined in api-client.ts:78

getToken

getToken(): Promise<string>
Returns Promise<string>
Inherited from MembraneApiClient.getToken
- Defined in api-client.ts:82

get

get<T = any>(
    uri: string,
    queryParams?: Record<string, any>,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- OptionalqueryParams: Record<string, any>
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from MembraneApiClient.get
- Defined in api-client.ts:109

post

post<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from MembraneApiClient.post
- Defined in api-client.ts:116

put

put<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from MembraneApiClient.put
- Defined in api-client.ts:120

patch

patch<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from MembraneApiClient.patch
- Defined in api-client.ts:124

delete

delete<T = any>(
    uri: string,
    data?: any,
    options?: AxiosRequestConfig<any>,
): Promise<T>
Type Parameters
- T = any
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<T>
Inherited from MembraneApiClient.delete
- Defined in api-client.ts:128

getEmbedUri

getEmbedUri(
    page: string,
    pageParams?: Record<string, any>,
    options?: { embedMode: "isolated-embed" | "popup-embed" },
): Promise<string>
Parameters
- page: string
- OptionalpageParams: Record<string, any>
- Optionaloptions: { embedMode: "isolated-embed" | "popup-embed" }
Returns Promise<string>
Inherited from MembraneApiClient.getEmbedUri
- Defined in api-client.ts:142

open

open(__namedParameters?: OpenMembraneConfigurationOptions): Promise<void>
Parameters
- __namedParameters: OpenMembraneConfigurationOptions = {}
Returns Promise<void>
- Defined in client.ts:79

package

package(selector: string): PackageAccessor
Parameters
- selector: string
Returns PackageAccessor
Deprecated
- Defined in client.ts:311

createEventSource

createEventSource(
uri: string,
queryParams?: Record<string, any>,
): Promise<EventSource>
Parameters
- uri: string
- OptionalqueryParams: Record<string, any>
Returns Promise<EventSource>
Overrides MembraneApiClient.createEventSource
- Defined in client.ts:319

connectionRequest

connectionRequest(connectionId: string, uri: string, data?: any): Promise<any>
Parameters
- connectionId: string
- uri: string
- Optionaldata: any
Returns Promise<any>
- Defined in client.ts:323

Customers

customer

customer(selector: string | { id: string }): CustomerAccessor
Parameters
- selector: string | { id: string }
Returns CustomerAccessor
- Defined in client.ts:300