Class ElementAccessor<Element, UpdateRequest, Selector>

Type Parameters

Element
UpdateRequest
Selector extends SelectorType = string

Hierarchy (View Summary)

ElementAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get put patch archive restore getPath

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 accessors.ts:32

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
- Defined in accessors.ts:40

get

get(): Promise<Element>
Returns Promise<Element>
- Defined in accessors.ts:44

put

put(data: UpdateRequest): Promise<Element>
Parameters
- data: UpdateRequest
Returns Promise<Element>
- Defined in accessors.ts:48

patch

patch(data: Partial<UpdateRequest>): Promise<Element>
Parameters
- data: Partial<UpdateRequest>
Returns Promise<Element>
- Defined in accessors.ts:52

archive

archive(): Promise<void>
Returns Promise<void>
- Defined in accessors.ts:56

restore

restore(): Promise<Element>
Returns Promise<Element>
- Defined in accessors.ts:60

getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
- Defined in accessors.ts:64