Class ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>

Type Parameters

ElementInstance extends BaseElementInstance
Selector extends { id?: string }
CreateRequest
UpdateRequest

Hierarchy (View Summary)

ElementInstanceAccessor

Index

Constructors

Methods

getUniqueIdentifier get getId create put patch archive delete getPath

Properties

Constructors

constructor

new ElementInstanceAccessor<
    ElementInstance extends BaseElementInstance,
    Selector extends { id?: string },
    CreateRequest,
    UpdateRequest,
>(
    options: {
        client: IntegrationAppApiClient;
        instancePath: string;
        selector: string | Selector;
        type?: WorkspaceElementType;
    },
): ElementInstanceAccessor<
    ElementInstance,
    Selector,
    CreateRequest,
    UpdateRequest,
>
Type Parameters
- ElementInstance extends BaseElementInstance
- Selector extends { id?: string }
- CreateRequest
- UpdateRequest
Parameters
- options: {
      client: IntegrationAppApiClient;
      instancePath: string;
      selector: string | Selector;
      type?: WorkspaceElementType;
  }
Returns ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:307

Methods

getUniqueIdentifier

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

get

get(): Promise<ElementInstance>
Returns Promise<ElementInstance>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:314

getId

getId(): Promise<string>
Returns Promise<string>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:315

create

create(data?: CreateRequest): Promise<ElementInstance>
Parameters
- Optionaldata: CreateRequest
Returns Promise<ElementInstance>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:316

put

put(data: CreateRequest): Promise<ElementInstance>
Parameters
- data: CreateRequest
Returns Promise<ElementInstance>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:317

patch

patch(data: UpdateRequest): Promise<ElementInstance>
Parameters
- data: UpdateRequest
Returns Promise<ElementInstance>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:318

archive

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

delete

delete(): Promise<void>
Returns Promise<void>
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:320

`Protected`getPath

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

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    instancePath: string;
    selector: string | Selector;
    type?: WorkspaceElementType;
}