Class ModelsBuilderService

Index

Constructors

Methods

getModelsBuilderDashboard getModelsBuilderStatus postModelsBuilderBuild

Constructors

constructor

new ModelsBuilderService(): ModelsBuilderService
Returns ModelsBuilderService

Methods

`Static`getModelsBuilderDashboard

getModelsBuilderDashboard<ThrowOnError extends boolean = true>(
    options?: Options<GetModelsBuilderDashboardData, ThrowOnError>,
): RequestResult<
    GetModelsBuilderDashboardResponses,
    GetModelsBuilderDashboardErrors,
    ThrowOnError,
    "fields",
>
Gets models builder dashboard data.

Gets the dashboard data and current state of the models builder.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetModelsBuilderDashboardData, ThrowOnError>
Returns RequestResult<
    GetModelsBuilderDashboardResponses,
    GetModelsBuilderDashboardErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5399

`Static`getModelsBuilderStatus

getModelsBuilderStatus<ThrowOnError extends boolean = true>(
    options?: Options<GetModelsBuilderStatusData, ThrowOnError>,
): RequestResult<
    GetModelsBuilderStatusResponses,
    GetModelsBuilderStatusErrors,
    ThrowOnError,
    "fields",
>
Gets models builder status.

Gets the current status and configuration of the models builder.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetModelsBuilderStatusData, ThrowOnError>
Returns RequestResult<
    GetModelsBuilderStatusResponses,
    GetModelsBuilderStatusErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5417

`Static`postModelsBuilderBuild

postModelsBuilderBuild<ThrowOnError extends boolean = true>(
    options?: Options<PostModelsBuilderBuildData, ThrowOnError>,
): RequestResult<
    PostModelsBuilderBuildResponses,
    PostModelsBuilderBuildErrors,
    ThrowOnError,
    "fields",
>
Builds models.

Triggers the models builder to generate strongly-typed models for content types.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostModelsBuilderBuildData, ThrowOnError>
Returns RequestResult<
    PostModelsBuilderBuildResponses,
    PostModelsBuilderBuildErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5381