Class IntegrationAppClient

Hierarchy

IntegrationAppApiClient
- IntegrationAppClient

Constructors

constructor

new IntegrationAppClient(options): IntegrationAppClient
Parameters
- options: IntegrationAppClientOptions
Returns IntegrationAppClient
Overrides IntegrationAppApiClient.constructor
- Defined in client.ts:77

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:81

flows

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

action

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

actions

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

screen

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

screens

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

actionInstance

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

actionInstances

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

flow

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

flowInstances

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

flowInstance

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

dataSourceInstances

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

dataSources

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

dataSource

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

dataSourceInstance

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

fieldMappings

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

fieldMapping

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

fieldMappingInstances

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

fieldMappingInstance

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

dataLinkTables

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

dataLinkTable

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

dataLinkTableInstances

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

dataLinkTableInstance

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

integrations

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

externalEventSubscriptions

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

externalEventSubscription

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

integration

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

connections

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

connection

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

appEventTypes

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

appEventType

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

appEventSubscriptions

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

appEventSubscription

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

appEvents

get appEvents(): AppEventsAccessor
Returns AppEventsAccessor
- Defined in client.ts:286

flowRuns

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

flowRun

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

appDataSchemas

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

appDataSchema

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

appDataSchemaInstances

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

appDataSchemaInstance

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

customers

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

scenarios

get scenarios(): ScenariosAccessor
Returns ScenariosAccessor
- Defined in client.ts:340

Methods

setCredentials

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

getToken

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

get

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

post

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

put

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

patch

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

delete

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

getEmbedUri

getEmbedUri(page, params?): Promise<string>
Parameters
- page: string
- Optionalparams: Record<string, any>
Returns Promise<string>
Inherited from IntegrationAppApiClient.getEmbedUri
- Defined in api-client.ts:134

open

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

scenario

scenario(selector): ScenarioAccessor
Parameters
- selector: string
Returns ScenarioAccessor
- Defined in client.ts:336

connectionRequest

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

Customers

customer

customer(selector): CustomerAccessor
Parameters
- selector: string | CustomerSelector
Returns CustomerAccessor
- Defined in client.ts:328