Class AppDataSchemaAccessor

Hierarchy (view full)

ElementAccessor<AppDataSchema, UpdateAppDataSchemaRequest>
- AppDataSchemaAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get put patch archive getPath

Constructors

constructor

new AppDataSchemaAccessor(client, idOrKey): AppDataSchemaAccessor
Parameters
- client: IntegrationAppApiClient
- idOrKey: string
Returns AppDataSchemaAccessor
Overrides ElementAccessor.constructor
- Defined in app-data-schemas/accessors.ts:37

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in accessors.ts:44

get

get(): Promise<AppDataSchema>
Returns Promise<AppDataSchema>
Inherited from ElementAccessor.get
- Defined in accessors.ts:48

put

put(data): Promise<AppDataSchema>
Parameters
- data: UpdateAppDataSchemaRequest
Returns Promise<AppDataSchema>
Inherited from ElementAccessor.put
- Defined in accessors.ts:52

patch

patch(data): Promise<AppDataSchema>
Parameters
- data: Partial<UpdateAppDataSchemaRequest>
Returns Promise<AppDataSchema>
Inherited from ElementAccessor.patch
- Defined in accessors.ts:56

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementAccessor.archive
- Defined in accessors.ts:60

getPath

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