Class ScenarioAccessor

Hierarchy (View Summary)

ElementAccessor<Scenario, UpdateScenarioRequest>
- ScenarioAccessor

Index

Constructors

Methods

getUniqueIdentifier get put patch archive getPath

Properties

Constructors

constructor

new ScenarioAccessor(
client: IntegrationAppApiClient,
selector: string,
): ScenarioAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string
Returns ScenarioAccessor
Overrides ElementAccessor.constructor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:4775

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:276

get

get(): Promise<Scenario>
Returns Promise<Scenario>
Inherited from ElementAccessor.get
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:277

put

put(data: UpdateScenarioRequest): Promise<Scenario>
Parameters
- data: UpdateScenarioRequest
Returns Promise<Scenario>
Inherited from ElementAccessor.put
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:278

patch

patch(data: Partial<UpdateScenarioRequest>): Promise<Scenario>
Parameters
- data: Partial<UpdateScenarioRequest>
Returns Promise<Scenario>
Inherited from ElementAccessor.patch
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:279

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementAccessor.archive
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:280

getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from ElementAccessor.getPath
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:281

Properties

`Protected`options

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