Class ElementAccessor<Element, UpdateRequest, Selector>

Type Parameters

Element
UpdateRequest
Selector extends SelectorType = string

Hierarchy (View Summary)

ElementAccessor

Index

Constructors

Methods

getUniqueIdentifier get put patch archive restore getPath

Properties

Constructors

constructor

new ElementAccessor<
    Element,
    UpdateRequest,
    Selector extends SelectorType = string,
>(
    options: {
        client: IntegrationAppApiClient;
        path: string;
        selector: string | Selector;
    },
): ElementAccessor<Element, UpdateRequest, Selector>
Type Parameters
- Element
- UpdateRequest
- Selector extends SelectorType = string
Parameters
- options: { client: IntegrationAppApiClient; path: string; selector: string | Selector }
Returns ElementAccessor<Element, UpdateRequest, Selector>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:274

Methods

getUniqueIdentifier

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

get

get(): Promise<Element>
Returns Promise<Element>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:280

put

put(data: UpdateRequest): Promise<Element>
Parameters
- data: UpdateRequest
Returns Promise<Element>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:281

patch

patch(data: Partial<UpdateRequest>): Promise<Element>
Parameters
- data: Partial<UpdateRequest>
Returns Promise<Element>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:282

archive

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

restore

restore(): Promise<Element>
Returns Promise<Element>
- Defined in ../../node_modules/@membranehq/sdk/dist/index.module.d.mts:284

getPath

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

Properties

`Protected`options

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