Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

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

Index

Constructors

constructor

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

Methods

getUniqueIdentifier

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

get

get(): Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Returns Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Inherited from ElementInstanceAccessor.get
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:666

getId

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

create

create(
    data?: UpdateAppDataSchemaInstanceRequest,
): Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Parameters
- Optionaldata: UpdateAppDataSchemaInstanceRequest
Returns Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Inherited from ElementInstanceAccessor.create
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:668

put

put(
    data: UpdateAppDataSchemaInstanceRequest,
): Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Parameters
- data: UpdateAppDataSchemaInstanceRequest
Returns Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Inherited from ElementInstanceAccessor.put
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:669

patch

patch(
    data: CreateAppDataSchemaInstanceRequest,
): Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Parameters
- data: CreateAppDataSchemaInstanceRequest
Returns Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Inherited from ElementInstanceAccessor.patch
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:670

delete

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

restore

restore(): Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Returns Promise<
    {
        id: string;
        key?: string;
        uuid?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        appId: string;
        userId: string;
        appDataSchemaId: string;
        appDataSchemaRevision: string;
        instanceKey?: string;
        schema?: any;
        error?: ErrorDataSchema;
        archivedAt?: string;
        user?: {
            id: string;
            name: string;
            meta?: Record<string, any>;
            internalId: string;
            fields?: Record<string, any>;
            credentials?: any;
            lastActiveAt?: string;
            isTest?: boolean;
            isBillable?: boolean;
            createdAt?: string;
            archivedAt?: string;
        };
        appDataSchema?: {
            id: string;
            key?: string;
            uuid?: string;
            description?: string;
            meta?: Record<string, any>;
            name: string;
            state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
            errors?: ErrorDataSchema[];
            createdAt?: string;
            updatedAt?: string;
            isDeactivated?: boolean;
            schema: any;
            code?: string;
            archivedAt?: string;
            revision?: string;
        };
    },
>
Inherited from ElementInstanceAccessor.restore
- Defined in ../../node_modules/@membranehq/sdk/dist/index.browser.d.mts:673

`Protected`getPath

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

setup

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

Properties

`Protected`options

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

Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns AppDataSchemaInstanceAccessor

Methods

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

restore

`Protected`getPath

Parameters

Returns string

setup

Returns Promise<void>

Properties

`Protected`options

Settings

On This Page

Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns AppDataSchemaInstanceAccessor

Methods

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

restore

ProtectedgetPath

Parameters

Returns string

setup

Returns Promise<void>

Properties

Protectedoptions

Settings

On This Page

`Protected`getPath

`Protected`options