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<
    DeleteDocumentBlueprintByIdResponses,
    DeleteDocumentBlueprintByIdErrors,
    ThrowOnError,
    "fields",
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteDocumentBlueprintByIdData, ThrowOnError>
Returns RequestResult<
    DeleteDocumentBlueprintByIdResponses,
    DeleteDocumentBlueprintByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:517

`Static`deleteDocumentBlueprintFolderById

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

`Static`getDocumentBlueprintById

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

`Static`getDocumentBlueprintByIdScaffold

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

`Static`getDocumentBlueprintFolderById

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

`Static`getItemDocumentBlueprint

getItemDocumentBlueprint<ThrowOnError extends boolean = true>(
    options?: Options<GetItemDocumentBlueprintData, ThrowOnError>,
): RequestResult<
    GetItemDocumentBlueprintResponses,
    GetItemDocumentBlueprintErrors,
    ThrowOnError,
    "fields",
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemDocumentBlueprintData, ThrowOnError>
Returns RequestResult<
    GetItemDocumentBlueprintResponses,
    GetItemDocumentBlueprintErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:667

`Static`getTreeDocumentBlueprintAncestors

getTreeDocumentBlueprintAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentBlueprintAncestorsData, ThrowOnError>,
): RequestResult<
    GetTreeDocumentBlueprintAncestorsResponses,
    GetTreeDocumentBlueprintAncestorsErrors,
    ThrowOnError,
    "fields",
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentBlueprintAncestorsData, ThrowOnError>
Returns RequestResult<
    GetTreeDocumentBlueprintAncestorsResponses,
    GetTreeDocumentBlueprintAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:680

`Static`getTreeDocumentBlueprintChildren

getTreeDocumentBlueprintChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentBlueprintChildrenData, ThrowOnError>,
): RequestResult<
    GetTreeDocumentBlueprintChildrenResponses,
    GetTreeDocumentBlueprintChildrenErrors,
    ThrowOnError,
    "fields",
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentBlueprintChildrenData, ThrowOnError>
Returns RequestResult<
    GetTreeDocumentBlueprintChildrenResponses,
    GetTreeDocumentBlueprintChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:693

`Static`getTreeDocumentBlueprintRoot

getTreeDocumentBlueprintRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeDocumentBlueprintRootData, ThrowOnError>,
): RequestResult<
    GetTreeDocumentBlueprintRootResponses,
    GetTreeDocumentBlueprintRootErrors,
    ThrowOnError,
    "fields",
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeDocumentBlueprintRootData, ThrowOnError>
Returns RequestResult<
    GetTreeDocumentBlueprintRootResponses,
    GetTreeDocumentBlueprintRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:706

`Static`postDocumentBlueprint

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

`Static`postDocumentBlueprintFolder

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

`Static`postDocumentBlueprintFromDocument

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

`Static`putDocumentBlueprintById

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

`Static`putDocumentBlueprintByIdMove

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

`Static`putDocumentBlueprintFolderById

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