Class DocumentBlueprintService

Index

Constructors

Methods

deleteDocumentBlueprintById deleteDocumentBlueprintFolderById getDocumentBlueprintById getDocumentBlueprintByIdScaffold getDocumentBlueprintFolderById getItemDocumentBlueprint getTreeDocumentBlueprintAncestors getTreeDocumentBlueprintChildren getTreeDocumentBlueprintRoot postDocumentBlueprint postDocumentBlueprintFolder postDocumentBlueprintFromDocument putDocumentBlueprintById putDocumentBlueprintByIdMove putDocumentBlueprintFolderById

Constructors

constructor

new DocumentBlueprintService(): DocumentBlueprintService
Returns DocumentBlueprintService

Methods

`Static`deleteDocumentBlueprintById

deleteDocumentBlueprintById<ThrowOnError extends boolean = true>(
options: Options<DeleteDocumentBlueprintByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDocumentBlueprintByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:520

`Static`deleteDocumentBlueprintFolderById

deleteDocumentBlueprintFolderById<ThrowOnError extends boolean = true>(
options: Options<DeleteDocumentBlueprintFolderByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDocumentBlueprintFolderByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:610

`Static`getDocumentBlueprintById

getDocumentBlueprintById<ThrowOnError extends boolean = true>(
options: Options<GetDocumentBlueprintByIdData, ThrowOnError>,
): RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentBlueprintByIdData, ThrowOnError>
Returns RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:533

`Static`getDocumentBlueprintByIdScaffold

getDocumentBlueprintByIdScaffold<ThrowOnError extends boolean = true>(
options: Options<GetDocumentBlueprintByIdScaffoldData, ThrowOnError>,
): RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentBlueprintByIdScaffoldData, ThrowOnError>
Returns RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:580

`Static`getDocumentBlueprintFolderById

getDocumentBlueprintFolderById<ThrowOnError extends boolean = true>(
options: Options<GetDocumentBlueprintFolderByIdData, ThrowOnError>,
): RequestResult<FolderResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetDocumentBlueprintFolderByIdData, ThrowOnError>
Returns RequestResult<FolderResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:623

`Static`getItemDocumentBlueprint

getItemDocumentBlueprint<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDocumentBlueprintData, ThrowOnError>,
): RequestResult<
    DocumentBlueprintItemResponseModel[],
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDocumentBlueprintData, ThrowOnError>
Returns RequestResult<DocumentBlueprintItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:670

`Static`postDocumentBlueprint

postDocumentBlueprint<ThrowOnError extends boolean = true>(
options?: Options<PostDocumentBlueprintData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDocumentBlueprintData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:503

`Static`postDocumentBlueprintFolder

postDocumentBlueprintFolder<ThrowOnError extends boolean = true>(
options?: Options<PostDocumentBlueprintFolderData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDocumentBlueprintFolderData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:593

`Static`postDocumentBlueprintFromDocument

postDocumentBlueprintFromDocument<ThrowOnError extends boolean = true>(
options?: Options<PostDocumentBlueprintFromDocumentData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostDocumentBlueprintFromDocumentData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:653

`Static`putDocumentBlueprintById

putDocumentBlueprintById<ThrowOnError extends boolean = true>(
options: Options<PutDocumentBlueprintByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentBlueprintByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:546

`Static`putDocumentBlueprintByIdMove

putDocumentBlueprintByIdMove<ThrowOnError extends boolean = true>(
options: Options<PutDocumentBlueprintByIdMoveData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentBlueprintByIdMoveData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:563

`Static`putDocumentBlueprintFolderById

putDocumentBlueprintFolderById<ThrowOnError extends boolean = true>(
options: Options<PutDocumentBlueprintFolderByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutDocumentBlueprintFolderByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:636

Class DocumentBlueprintService

Index

Constructors

Methods

Constructors

constructor

Returns DocumentBlueprintService

Methods

StaticdeleteDocumentBlueprintById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteDocumentBlueprintFolderById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticgetDocumentBlueprintById

Type Parameters

Parameters

Returns RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>

StaticgetDocumentBlueprintByIdScaffold

Type Parameters

Parameters

Returns RequestResult<DocumentBlueprintResponseModel, unknown, ThrowOnError>

StaticgetDocumentBlueprintFolderById

Type Parameters

Parameters

Returns RequestResult<FolderResponseModel, unknown, ThrowOnError>

StaticgetItemDocumentBlueprint

Type Parameters

Parameters

Returns RequestResult<DocumentBlueprintItemResponseModel[], unknown, ThrowOnError>

StaticgetTreeDocumentBlueprintAncestors

Type Parameters

Parameters

Returns RequestResult<DocumentBlueprintTreeItemResponseModel[], unknown, ThrowOnError>

StaticgetTreeDocumentBlueprintChildren

Type Parameters

Parameters

Returns RequestResult< PagedDocumentBlueprintTreeItemResponseModel, unknown, ThrowOnError,>

StaticgetTreeDocumentBlueprintRoot

Type Parameters

Parameters

Returns RequestResult< PagedDocumentBlueprintTreeItemResponseModel, unknown, ThrowOnError,>

StaticpostDocumentBlueprint

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticpostDocumentBlueprintFolder

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticpostDocumentBlueprintFromDocument

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputDocumentBlueprintById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputDocumentBlueprintByIdMove

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputDocumentBlueprintFolderById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

Settings

On This Page

`Static`deleteDocumentBlueprintById

`Static`deleteDocumentBlueprintFolderById

`Static`getDocumentBlueprintById

`Static`getDocumentBlueprintByIdScaffold

`Static`getDocumentBlueprintFolderById

`Static`getItemDocumentBlueprint

`Static`getTreeDocumentBlueprintAncestors

`Static`getTreeDocumentBlueprintChildren

Returns RequestResult<
PagedDocumentBlueprintTreeItemResponseModel,
unknown,
ThrowOnError,
>

`Static`getTreeDocumentBlueprintRoot

Returns RequestResult<
PagedDocumentBlueprintTreeItemResponseModel,
unknown,
ThrowOnError,
>

`Static`postDocumentBlueprint

`Static`postDocumentBlueprintFolder

`Static`postDocumentBlueprintFromDocument

`Static`putDocumentBlueprintById

`Static`putDocumentBlueprintByIdMove

`Static`putDocumentBlueprintFolderById