Class FlowAccessor

Hierarchy (view full)

ElementAccessor<Flow, UpdateFlowRequest, FlowSelector>
- FlowAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get put patch archive getPath apply reset

Constructors

constructor

new FlowAccessor(client, selector): FlowAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | FlowSelector
Returns FlowAccessor
Overrides ElementAccessor.constructor
- Defined in flows/accessors.ts:65

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    path: string;
    selector: string | FlowSelector;
}

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors.ts:44

get

get(): Promise<Flow>
Returns Promise<Flow>
Inherited from ElementAccessor.get
- Defined in accessors.ts:48

put

put(data): Promise<Flow>
Parameters
- data: UpdateFlowRequest
Returns Promise<Flow>
Inherited from ElementAccessor.put
- Defined in accessors.ts:52

patch

patch(data): Promise<Flow>
Parameters
- data: Partial<UpdateFlowRequest>
Returns Promise<Flow>
Inherited from ElementAccessor.patch
- Defined in accessors.ts:56

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementAccessor.archive
- Defined in accessors.ts:60

getPath

getPath(operation?): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementAccessor.getPath
- Defined in accessors.ts:64

apply

apply(integrationKeys): Promise<Flow[]>
Parameters
- integrationKeys: string[]
Returns Promise<Flow[]>
- Defined in flows/accessors.ts:76

reset

reset(): Promise<Flow>
Returns Promise<Flow>
- Defined in flows/accessors.ts:82