Class DataLinkTableInstanceAccessor

Hierarchy (View Summary)

ElementInstanceAccessor<
    DataLinkTableApiResponse,
    DataLinkTableInstanceSelector,
    UpdateDataLinkTableInstanceRequest,
    UpdateDataLinkTableInstanceRequest,
>
- DataLinkTableInstanceAccessor

Index

Constructors

constructor

new DataLinkTableInstanceAccessor(
client: MembraneApiClient,
selector: string | DataLinkTableInstanceSelector,
): DataLinkTableInstanceAccessor
Parameters
- client: MembraneApiClient
- selector: string | DataLinkTableInstanceSelector
Returns DataLinkTableInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in accessors/data-link-table-instances-accessors.ts:31

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors/base-accessors.ts:152

get

get(): Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Returns Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.get
- Defined in accessors/base-accessors.ts:156

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in accessors/base-accessors.ts:160

create

create(
    data?: UpdateDataLinkTableInstanceRequest,
): Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- Optionaldata: UpdateDataLinkTableInstanceRequest
Returns Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.create
- Defined in accessors/base-accessors.ts:175

put

put(
    data: UpdateDataLinkTableInstanceRequest,
): Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- data: UpdateDataLinkTableInstanceRequest
Returns Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.put
- Defined in accessors/base-accessors.ts:195

patch

patch(
    data: UpdateDataLinkTableInstanceRequest,
): Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- data: UpdateDataLinkTableInstanceRequest
Returns Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors/base-accessors.ts:206

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
Inherited from ElementInstanceAccessor.delete
- Defined in accessors/base-accessors.ts:224

restore

restore(): Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Returns Promise<
    {
        user?: any;
        connection?: any;
        integration?: any;
        dataLinkTable?: any;
        connectionId?: string;
        instanceKey?: string;
        dataLinkTableId?: string;
        integrationId?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.restore
- Defined in accessors/base-accessors.ts:228

`Protected`getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in accessors/base-accessors.ts:232

findLinks

findLinks(
    query?: {
        limit?: number;
        cursor?: string;
        direction?: IMPORT | EXPORT | BOTH;
        appRecordId?: string;
        externalRecordId?: string;
    },
): Promise<
    {
        items: {
            id: string;
            dataLinkTableInstanceId: string;
            externalRecordId: string;
            appRecordId: string;
            direction: DataLinkDirection;
        }[];
        cursor?: string;
    },
>
Parameters
- Optionalquery: {
      limit?: number;
      cursor?: string;
      direction?: IMPORT | EXPORT | BOTH;
      appRecordId?: string;
      externalRecordId?: string;
  }
Returns Promise<
    {
        items: {
            id: string;
            dataLinkTableInstanceId: string;
            externalRecordId: string;
            appRecordId: string;
            direction: DataLinkDirection;
        }[];
        cursor?: string;
    },
>
- Defined in accessors/data-link-table-instances-accessors.ts:42

createLink

createLink(data: CreateDataLinkRequest): Promise<void>
Parameters
- data: CreateDataLinkRequest
Returns Promise<void>
- Defined in accessors/data-link-table-instances-accessors.ts:47

deleteLink

deleteLink(data: DeleteDataLinkRequest): Promise<void>
Parameters
- data: DeleteDataLinkRequest
Returns Promise<void>
- Defined in accessors/data-link-table-instances-accessors.ts:51

Class DataLinkTableInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DataLinkTableInstanceAccessor

Properties

Protectedoptions

Methods

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

Deprecated

restore

ProtectedgetPath

Parameters

Returns string

findLinks

Parameters

Returns Promise< { items: { id: string; dataLinkTableInstanceId: string; externalRecordId: string; appRecordId: string; direction: DataLinkDirection; }[]; cursor?: string; },>

createLink

Parameters

Returns Promise<void>

deleteLink

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`options

`Protected`getPath

Returns Promise<
{
items: {
id: string;
dataLinkTableInstanceId: string;
externalRecordId: string;
appRecordId: string;
direction: DataLinkDirection;
}[];
cursor?: string;
},
>