Class Automation

Hierarchy

Automation

Index

Constructors

Properties

accessTokenFn? baseURL? headers

Methods

api eventTypesList eventTypesListEndpoint functionList functionListEndpoint permissionsDelete permissionsDeleteEndpoint permissionsEffective permissionsEffectiveEndpoint permissionsList permissionsListEndpoint permissionsRead permissionsReadEndpoint permissionsTrace permissionsTraceEndpoint permissionsUpdate permissionsUpdateEndpoint sessionCancel sessionCancelEndpoint sessionList sessionListEndpoint sessionListPrompts sessionListPromptsEndpoint sessionRead sessionReadEndpoint sessionResumeState sessionResumeStateEndpoint setAccessTokenFn setHeader setHeaders triggerCreate triggerCreateEndpoint triggerDelete triggerDeleteEndpoint triggerList triggerListEndpoint triggerRead triggerReadEndpoint triggerUndelete triggerUndeleteEndpoint triggerUpdate triggerUpdateEndpoint typeList typeListEndpoint workflowCreate workflowCreateEndpoint workflowDelete workflowDeleteEndpoint workflowExec workflowExecEndpoint workflowList workflowListEndpoint workflowRead workflowReadEndpoint workflowTest workflowTestEndpoint workflowUndelete workflowUndeleteEndpoint workflowUpdate workflowUpdateEndpoint

Constructors

constructor

new Automation(__namedParameters: Ctor): Automation
Parameters
- __namedParameters: Ctor
Returns Automation
- Defined in automation.ts:44

Properties

`Protected` `Optional` accessTokenFn

accessTokenFn?: (() => undefined | string)

Type declaration

- (): undefined | string
- Returns undefined | string

`Protected` `Optional` baseURL

baseURL?: string

`Protected` headers

headers: Headers = {}

Methods

api

api(): AxiosInstance
Returns AxiosInstance
- Defined in automation.ts:80

eventTypesList

eventTypesList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:796

eventTypesListEndpoint

eventTypesListEndpoint(): string
Returns string
- Defined in automation.ts:807

functionList

functionList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:764

functionListEndpoint

functionListEndpoint(): string
Returns string
- Defined in automation.ts:775

permissionsDelete

permissionsDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:904

permissionsDeleteEndpoint

permissionsDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:922

permissionsEffective

permissionsEffective(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:828

permissionsEffectiveEndpoint

permissionsEffectiveEndpoint(): string
Returns string
- Defined in automation.ts:844

permissionsList

permissionsList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:812

permissionsListEndpoint

permissionsListEndpoint(): string
Returns string
- Defined in automation.ts:823

permissionsRead

permissionsRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:874

permissionsReadEndpoint

permissionsReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:896

permissionsTrace

permissionsTrace(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:849

permissionsTraceEndpoint

permissionsTraceEndpoint(): string
Returns string
- Defined in automation.ts:869

permissionsUpdate

permissionsUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:930

permissionsUpdateEndpoint

permissionsUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:954

sessionCancel

sessionCancel(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:688

sessionCancelEndpoint

sessionCancelEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:706

sessionList

sessionList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:621

sessionListEndpoint

sessionListEndpoint(): string
Returns string
- Defined in automation.ts:657

sessionListPrompts

sessionListPrompts(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:714

sessionListPromptsEndpoint

sessionListPromptsEndpoint(): string
Returns string
- Defined in automation.ts:725

sessionRead

sessionRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:662

sessionReadEndpoint

sessionReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:680

sessionResumeState

sessionResumeState(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:730

sessionResumeStateEndpoint

sessionResumeStateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:755

setAccessTokenFn

setAccessTokenFn(fn: (() => undefined | string)): Automation
Parameters
- fn: (() => undefined | string)
  - - (): undefined | string
    - Returns undefined | string
Returns Automation
- Defined in automation.ts:57

setHeader

setHeader(name: string, value: undefined | string): Automation
Parameters
- name: string
- value: undefined | string
Returns Automation
- Defined in automation.ts:70

setHeaders

setHeaders(headers?: Headers): Automation
Parameters
- Optional headers: Headers
Returns Automation
- Defined in automation.ts:62

triggerCreate

triggerCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:428

triggerCreateEndpoint

triggerCreateEndpoint(): string
Returns string
- Defined in automation.ts:476

triggerDelete

triggerDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:569

triggerDeleteEndpoint

triggerDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:587

triggerList

triggerList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:387

triggerListEndpoint

triggerListEndpoint(): string
Returns string
- Defined in automation.ts:423

triggerRead

triggerRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:543

triggerReadEndpoint

triggerReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:561

triggerUndelete

triggerUndelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:595

triggerUndeleteEndpoint

triggerUndeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:613

triggerUpdate

triggerUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:481

triggerUpdateEndpoint

triggerUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:535

typeList

typeList(extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:780

typeListEndpoint

typeListEndpoint(): string
Returns string
- Defined in automation.ts:791

workflowCreate

workflowCreate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:134

workflowCreateEndpoint

workflowCreateEndpoint(): string
Returns string
- Defined in automation.ts:175

workflowDelete

workflowDelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:261

workflowDeleteEndpoint

workflowDeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:279

workflowExec

workflowExec(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:347

workflowExecEndpoint

workflowExecEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:379

workflowList

workflowList(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:95

workflowListEndpoint

workflowListEndpoint(): string
Returns string
- Defined in automation.ts:129

workflowRead

workflowRead(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:235

workflowReadEndpoint

workflowReadEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:253

workflowTest

workflowTest(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:313

workflowTestEndpoint

workflowTestEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:339

workflowUndelete

workflowUndelete(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:287

workflowUndeleteEndpoint

workflowUndeleteEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:305

workflowUpdate

workflowUpdate(a: KV, extra?: AxiosRequestConfig<any>): Promise<KV>
Parameters
- a: KV
- extra: AxiosRequestConfig<any> = {}
Returns Promise<KV>
- Defined in automation.ts:180

workflowUpdateEndpoint

workflowUpdateEndpoint(a: KV): string
Parameters
- a: KV
Returns string
- Defined in automation.ts:227