Class IntegrationAppClient

Hierarchy (View Summary)

IntegrationAppApiClient
- IntegrationAppClient

Accessors

self

get self(): SelfAccessor
Returns SelfAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4906

flows

get flows(): FlowsAccessor
Returns FlowsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4907

actions

get actions(): ActionsAccessor
Returns ActionsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4910

screens

get screens(): ScreensAccessor
Returns ScreensAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4912

actionInstances

get actionInstances(): ActionInstancesAccessor
Returns ActionInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4914

flowInstances

get flowInstances(): FlowInstancesAccessor
Returns FlowInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4916

dataSourceInstances

get dataSourceInstances(): DataSourceInstancesAccessor
Returns DataSourceInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4918

dataSources

get dataSources(): DataSourcesAccessor
Returns DataSourcesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4919

fieldMappings

get fieldMappings(): FieldMappingsAccessor
Returns FieldMappingsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4922

fieldMappingInstances

get fieldMappingInstances(): FieldMappingInstancesAccessor
Returns FieldMappingInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4924

dataLinkTables

get dataLinkTables(): DataLinkTablesAccessor
Returns DataLinkTablesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4926

dataLinkTableInstances

get dataLinkTableInstances(): DataLinkTableInstancesAccessor
Returns DataLinkTableInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4928

integrations

get integrations(): IntegrationsAccessor
Returns IntegrationsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4930

connections

get connections(): ConnectionsAccessor
Returns ConnectionsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4934

appEventTypes

get appEventTypes(): AppEventTypesAccessor
Returns AppEventTypesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4936

appEventSubscriptions

get appEventSubscriptions(): AppEventSubscriptionsAccessor
Returns AppEventSubscriptionsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4938

appEvents

get appEvents(): AppEventsAccessor
Returns AppEventsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4940

flowRuns

get flowRuns(): FlowRunsAccessor
Returns FlowRunsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4941

appDataSchemas

get appDataSchemas(): AppDataSchemasAccessor
Returns AppDataSchemasAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4943

appDataSchemaInstances

get appDataSchemaInstances(): AppDataSchemaInstancesAccessor
Returns AppDataSchemaInstancesAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4945

customers

get customers(): CustomersAccessor
Returns CustomersAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4948

scenarios

get scenarios(): ScenariosAccessor
Returns ScenariosAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4950

Constructors

constructor

new IntegrationAppClient(
options: IntegrationAppClientOptions,
): IntegrationAppClient
Parameters
- options: IntegrationAppClientOptions
Returns IntegrationAppClient
Overrides IntegrationAppApiClient.constructor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4905

Methods

setCredentials

setCredentials(credentials: any): Promise<any>
Parameters
- credentials: any
Returns Promise<any>
Inherited from IntegrationAppApiClient.setCredentials
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:208

getToken

getToken(): Promise<string>
Returns Promise<string>
Inherited from IntegrationAppApiClient.getToken
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:209

get

get(
    uri: string,
    queryParams?: Record<string, any>,
    options?: AxiosRequestConfig<any>,
): Promise<any>
Parameters
- uri: string
- OptionalqueryParams: Record<string, any>
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<any>
Inherited from IntegrationAppApiClient.get
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:210

post

post(uri: string, data?: any, options?: AxiosRequestConfig<any>): Promise<any>
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<any>
Inherited from IntegrationAppApiClient.post
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:211

put

put(uri: string, data?: any, options?: AxiosRequestConfig<any>): Promise<any>
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<any>
Inherited from IntegrationAppApiClient.put
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:212

patch

patch(uri: string, data?: any, options?: AxiosRequestConfig<any>): Promise<any>
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<any>
Inherited from IntegrationAppApiClient.patch
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:213

delete

delete(uri: string, data?: any, options?: AxiosRequestConfig<any>): Promise<any>
Parameters
- uri: string
- Optionaldata: any
- Optionaloptions: AxiosRequestConfig<any>
Returns Promise<any>
Inherited from IntegrationAppApiClient.delete
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:214

getEmbedUri

getEmbedUri(page: string, params?: Record<string, any>): Promise<string>
Parameters
- page: string
- Optionalparams: Record<string, any>
Returns Promise<string>
Inherited from IntegrationAppApiClient.getEmbedUri
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:215

open

open(__namedParameters?: OpenIntegrationAppConfigurationOptions): Promise<void>
Parameters
- Optional__namedParameters: OpenIntegrationAppConfigurationOptions
Returns Promise<void>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4908

action

action(selector: string | ActionSelector): ActionAccessor
Parameters
- selector: string | ActionSelector
Returns ActionAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4909

screen

screen(selector: string | ScreenSelector): ScreenAccessor
Parameters
- selector: string | ScreenSelector
Returns ScreenAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4911

actionInstance

actionInstance(
selector: string | ActionInstanceSelector,
): ActionInstanceAccessor
Parameters
- selector: string | ActionInstanceSelector
Returns ActionInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4913

flow

flow(selector: string | FlowSelector): FlowAccessor
Parameters
- selector: string | FlowSelector
Returns FlowAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4915

flowInstance

flowInstance(selector: string | FlowInstanceSelector): FlowInstanceAccessor
Parameters
- selector: string | FlowInstanceSelector
Returns FlowInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4917

dataSource

dataSource(selector: string | DataSourceSelector): DataSourceAccessor
Parameters
- selector: string | DataSourceSelector
Returns DataSourceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4920

dataSourceInstance

dataSourceInstance(
selector: string | DataSourceInstanceSelector,
): DataSourceInstanceAccessor
Parameters
- selector: string | DataSourceInstanceSelector
Returns DataSourceInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4921

fieldMapping

fieldMapping(selector: string | FieldMappingSelector): FieldMappingAccessor
Parameters
- selector: string | FieldMappingSelector
Returns FieldMappingAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4923

fieldMappingInstance

fieldMappingInstance(
selector: string | FieldMappingInstanceSelector,
): FieldMappingInstanceAccessor
Parameters
- selector: string | FieldMappingInstanceSelector
Returns FieldMappingInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4925

dataLinkTable

dataLinkTable(idOrKey: string): DataLinkTableAccessor
Parameters
- idOrKey: string
Returns DataLinkTableAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4927

dataLinkTableInstance

dataLinkTableInstance(
selector: string | DataLinkTableInstanceSelector,
): DataLinkTableInstanceAccessor
Parameters
- selector: string | DataLinkTableInstanceSelector
Returns DataLinkTableInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4929

externalEventSubscriptions

externalEventSubscriptions(): ExternalEventSubscriptionsAccessor
Returns ExternalEventSubscriptionsAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4931

externalEventSubscription

externalEventSubscription(id: string): ExternalEventSubscriptionAccessor
Parameters
- id: string
Returns ExternalEventSubscriptionAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4932

integration

integration(identifier: string): IntegrationAccessor
Parameters
- identifier: string
Returns IntegrationAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4933

connection

connection(connectionSelector: string): ConnectionAccessor
Parameters
- connectionSelector: string
Returns ConnectionAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4935

appEventType

appEventType(id: string): AppEventTypeAccessor
Parameters
- id: string
Returns AppEventTypeAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4937

appEventSubscription

appEventSubscription(
selector: string | AppEventSubscriptionSelector,
): AppEventSubscriptionAccessor
Parameters
- selector: string | AppEventSubscriptionSelector
Returns AppEventSubscriptionAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4939

flowRun

flowRun(id: string): FlowRunAccessor
Parameters
- id: string
Returns FlowRunAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4942

appDataSchema

appDataSchema(id: string): AppDataSchemaAccessor
Parameters
- id: string
Returns AppDataSchemaAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4944

appDataSchemaInstance

appDataSchemaInstance(
selector: string | AppDataSchemaInstanceSelector,
): AppDataSchemaInstanceAccessor
Parameters
- selector: string | AppDataSchemaInstanceSelector
Returns AppDataSchemaInstanceAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4946

customer

customer(selector: string | CustomerSelector): CustomerAccessor
Parameters
- selector: string | CustomerSelector
Returns CustomerAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4947

scenario

scenario(selector: string): ScenarioAccessor
Parameters
- selector: string
Returns ScenarioAccessor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4949

connectionRequest

connectionRequest(connectionId: string, uri: string, data?: any): Promise<any>
Parameters
- connectionId: string
- uri: string
- Optionaldata: any
Returns Promise<any>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4951

Properties

apiUri

apiUri: string

uiUri

uiUri: string

`Optional`token

token?: string

`Protected` `Optional`fetchToken

fetchToken?: () => Promise<string>