Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

ElementInstanceAccessor<
    AppDataSchemaInstance,
    AppDataSchemaInstanceSelector,
    UpdateAppDataSchemaInstanceRequest,
    CreateAppDataSchemaInstanceRequest,
>
- AppDataSchemaInstanceAccessor

Index

Constructors

Methods

getUniqueIdentifier get getId create put patch archive delete restore getPath setup

Properties

Constructors

constructor

new AppDataSchemaInstanceAccessor(
client: IntegrationAppApiClient,
selector: string | AppDataSchemaInstanceSelector,
): AppDataSchemaInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | AppDataSchemaInstanceSelector
Returns AppDataSchemaInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:3247

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:317

get

get(): Promise<AppDataSchemaInstance>
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.get
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:318

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:319

create

create(
data?: UpdateAppDataSchemaInstanceRequest,
): Promise<AppDataSchemaInstance>
Parameters
- Optionaldata: UpdateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.create
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:320

put

put(data: UpdateAppDataSchemaInstanceRequest): Promise<AppDataSchemaInstance>
Parameters
- data: UpdateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.put
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:321

patch

patch(data: CreateAppDataSchemaInstanceRequest): Promise<AppDataSchemaInstance>
Parameters
- data: CreateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:322

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.archive
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:323

delete

delete(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.delete
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:324

restore

restore(): Promise<AppDataSchemaInstance>
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.restore
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:325

`Protected`getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:326

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:3248

Properties

`Protected`options

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