Schema

Index

Properties

createField

Function

Type declaration

Signature

(object: string, field: FieldDefinition): Promise<HttpResponse<FieldDefinition>>;

Parameters

Name	Type
`object`	`string`
`field`	`FieldDefinition`

Returns

Promise<HttpResponse<FieldDefinition>>

Defined in: src/Api/Schema/index.ts:19

createIdentifier

Function

Type declaration

Signature

(identifier: IdentifierDefinition): Promise<HttpResponse<CreateIdentifierResponse>>;

Parameters

Name	Type
`identifier`	`IdentifierDefinition`

Returns

Promise<HttpResponse<CreateIdentifierResponse>>

Defined in: src/Api/Schema/index.ts:20

createObject

Function

Type declaration

Signature

(object: ObjectDefinition): Promise<HttpResponse<ObjectDefinition>>;

Parameters

Name	Type
`object`	`ObjectDefinition`

Returns

Promise<HttpResponse<ObjectDefinition>>

Defined in: src/Api/Schema/index.ts:25

createRelation

Function

Type declaration

Signature

(object: string, relation: RelationDefinition): Promise<HttpResponse<RelationDefinition>>;

Parameters

Name	Type
`object`	`string`
`relation`	`RelationDefinition`

Returns

Promise<HttpResponse<RelationDefinition>>

Defined in: src/Api/Schema/index.ts:26

enableModule

Function

Type declaration

Signature

(module: string): Promise<HttpResponse<ModulesResponse>>;

Parameters

Name	Type
`module`	`string`

Returns

Promise<HttpResponse<ModulesResponse>>

Defined in: src/Api/Schema/index.ts:21

getAllObjects

Function

Type declaration

Signature

(): Promise<HttpResponse<ObjectDefinition[]>>;

Returns

Promise<HttpResponse<ObjectDefinition[]>>

Defined in: src/Api/Schema/index.ts:24

getEnabledModules

Function

Type declaration

Signature

(): Promise<HttpResponse<ModulesResponse>>;

Returns

Promise<HttpResponse<ModulesResponse>>

Defined in: src/Api/Schema/index.ts:22

getObject

Function

Type declaration

Signature

(name: string): Promise<HttpResponse<ObjectDefinition>>;

Parameters

Name	Type
`name`	`string`

Returns

Promise<HttpResponse<ObjectDefinition>>

Defined in: src/Api/Schema/index.ts:23