Class StylesheetService

Index

Constructors

Methods

deleteStylesheetByPath deleteStylesheetFolderByPath getItemStylesheet getStylesheetByPath getStylesheetFolderByPath getTreeStylesheetAncestors getTreeStylesheetChildren getTreeStylesheetRoot getTreeStylesheetSiblings postStylesheet postStylesheetFolder putStylesheetByPath putStylesheetByPathRename

Constructors

constructor

new StylesheetService(): StylesheetService
Returns StylesheetService

Methods

`Static`deleteStylesheetByPath

deleteStylesheetByPath<ThrowOnError extends boolean = true>(
    options: Options<DeleteStylesheetByPathData, ThrowOnError>,
): RequestResult<
    DeleteStylesheetByPathResponses,
    DeleteStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a stylesheet.

Deletes a stylesheet identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteStylesheetByPathData, ThrowOnError>
Returns RequestResult<
    DeleteStylesheetByPathResponses,
    DeleteStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5868

`Static`deleteStylesheetFolderByPath

deleteStylesheetFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<DeleteStylesheetFolderByPathData, ThrowOnError>,
): RequestResult<
    DeleteStylesheetFolderByPathResponses,
    DeleteStylesheetFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a stylesheet folder.

Deletes a stylesheet folder identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteStylesheetFolderByPathData, ThrowOnError>
Returns RequestResult<
    DeleteStylesheetFolderByPathResponses,
    DeleteStylesheetFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5945

`Static`getItemStylesheet

getItemStylesheet<ThrowOnError extends boolean = true>(
    options?: Options<GetItemStylesheetData, ThrowOnError, unknown>,
): RequestResult<
    GetItemStylesheetResponses,
    GetItemStylesheetErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of stylesheet items.

Gets a collection of stylesheet items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemStylesheetData, ThrowOnError, unknown>
Returns RequestResult<
    GetItemStylesheetResponses,
    GetItemStylesheetErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5838

`Static`getStylesheetByPath

getStylesheetByPath<ThrowOnError extends boolean = true>(
    options: Options<GetStylesheetByPathData, ThrowOnError>,
): RequestResult<
    GetStylesheetByPathResponses,
    GetStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a stylesheet by path.

Gets a stylesheet identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetStylesheetByPathData, ThrowOnError>
Returns RequestResult<
    GetStylesheetByPathResponses,
    GetStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5881

`Static`getStylesheetFolderByPath

getStylesheetFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<GetStylesheetFolderByPathData, ThrowOnError>,
): RequestResult<
    GetStylesheetFolderByPathResponses,
    GetStylesheetFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a stylesheet folder by path.

Gets a stylesheet folder identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetStylesheetFolderByPathData, ThrowOnError>
Returns RequestResult<
    GetStylesheetFolderByPathResponses,
    GetStylesheetFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5958

`Static`getTreeStylesheetAncestors

getTreeStylesheetAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStylesheetAncestorsData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeStylesheetAncestorsResponses,
    GetTreeStylesheetAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor stylesheet items.

Gets a collection of stylesheet items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStylesheetAncestorsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeStylesheetAncestorsResponses,
    GetTreeStylesheetAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5971

`Static`getTreeStylesheetChildren

getTreeStylesheetChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStylesheetChildrenData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeStylesheetChildrenResponses,
    GetTreeStylesheetChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of stylesheet tree child items.

Gets a paginated collection of stylesheet tree items that are children of the provided parent Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStylesheetChildrenData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeStylesheetChildrenResponses,
    GetTreeStylesheetChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5984

`Static`getTreeStylesheetRoot

getTreeStylesheetRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStylesheetRootData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeStylesheetRootResponses,
    GetTreeStylesheetRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of stylesheet items from the root of the tree.

Gets a paginated collection of stylesheet items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStylesheetRootData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeStylesheetRootResponses,
    GetTreeStylesheetRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5997

`Static`getTreeStylesheetSiblings

getTreeStylesheetSiblings<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStylesheetSiblingsData, ThrowOnError, unknown>,
): RequestResult<
    GetTreeStylesheetSiblingsResponses,
    GetTreeStylesheetSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of stylesheet tree sibling items.

Gets a collection of stylesheet tree items that are siblings of the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStylesheetSiblingsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreeStylesheetSiblingsResponses,
    GetTreeStylesheetSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6010

`Static`postStylesheet

postStylesheet<ThrowOnError extends boolean = true>(
    options: Options<PostStylesheetData, ThrowOnError>,
): RequestResult<
    PostStylesheetResponses,
    PostStylesheetErrors,
    ThrowOnError,
    "fields",
>
Creates a new stylesheet.

Creates a new stylesheet with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostStylesheetData, ThrowOnError>
Returns RequestResult<
    PostStylesheetResponses,
    PostStylesheetErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5851

`Static`postStylesheetFolder

postStylesheetFolder<ThrowOnError extends boolean = true>(
    options: Options<PostStylesheetFolderData, ThrowOnError>,
): RequestResult<
    PostStylesheetFolderResponses,
    PostStylesheetFolderErrors,
    ThrowOnError,
    "fields",
>
Creates a stylesheet folder.

Creates a new stylesheet folder with the provided name and parent location.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostStylesheetFolderData, ThrowOnError>
Returns RequestResult<
    PostStylesheetFolderResponses,
    PostStylesheetFolderErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5928

`Static`putStylesheetByPath

putStylesheetByPath<ThrowOnError extends boolean = true>(
    options: Options<PutStylesheetByPathData, ThrowOnError>,
): RequestResult<
    PutStylesheetByPathResponses,
    PutStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
Updates a stylesheet.

Updates a stylesheet identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutStylesheetByPathData, ThrowOnError>
Returns RequestResult<
    PutStylesheetByPathResponses,
    PutStylesheetByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5894

`Static`putStylesheetByPathRename

putStylesheetByPathRename<ThrowOnError extends boolean = true>(
    options: Options<PutStylesheetByPathRenameData, ThrowOnError>,
): RequestResult<
    PutStylesheetByPathRenameResponses,
    PutStylesheetByPathRenameErrors,
    ThrowOnError,
    "fields",
>
Renames a stylesheet.

Renames a stylesheet file to the specified new name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutStylesheetByPathRenameData, ThrowOnError>
Returns RequestResult<
    PutStylesheetByPathRenameResponses,
    PutStylesheetByPathRenameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5911

Class StylesheetService

Index

Constructors

Methods

Constructors

constructor

Returns StylesheetService

Methods

StaticdeleteStylesheetByPath

Type Parameters

Parameters

Returns RequestResult< DeleteStylesheetByPathResponses, DeleteStylesheetByPathErrors, ThrowOnError, "fields",>

StaticdeleteStylesheetFolderByPath

Type Parameters

Parameters

Returns RequestResult< DeleteStylesheetFolderByPathResponses, DeleteStylesheetFolderByPathErrors, ThrowOnError, "fields",>

StaticgetItemStylesheet

Type Parameters

Parameters

Returns RequestResult< GetItemStylesheetResponses, GetItemStylesheetErrors, ThrowOnError, "fields",>

StaticgetStylesheetByPath

Type Parameters

Parameters

Returns RequestResult< GetStylesheetByPathResponses, GetStylesheetByPathErrors, ThrowOnError, "fields",>

StaticgetStylesheetFolderByPath

Type Parameters

Parameters

Returns RequestResult< GetStylesheetFolderByPathResponses, GetStylesheetFolderByPathErrors, ThrowOnError, "fields",>

StaticgetTreeStylesheetAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreeStylesheetAncestorsResponses, GetTreeStylesheetAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreeStylesheetChildren

Type Parameters

Parameters

Returns RequestResult< GetTreeStylesheetChildrenResponses, GetTreeStylesheetChildrenErrors, ThrowOnError, "fields",>

StaticgetTreeStylesheetRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeStylesheetRootResponses, GetTreeStylesheetRootErrors, ThrowOnError, "fields",>

StaticgetTreeStylesheetSiblings

Type Parameters

Parameters

Returns RequestResult< GetTreeStylesheetSiblingsResponses, GetTreeStylesheetSiblingsErrors, ThrowOnError, "fields",>

StaticpostStylesheet

Type Parameters

Parameters

Returns RequestResult< PostStylesheetResponses, PostStylesheetErrors, ThrowOnError, "fields",>

StaticpostStylesheetFolder

Type Parameters

Parameters

Returns RequestResult< PostStylesheetFolderResponses, PostStylesheetFolderErrors, ThrowOnError, "fields",>

StaticputStylesheetByPath

Type Parameters

Parameters

Returns RequestResult< PutStylesheetByPathResponses, PutStylesheetByPathErrors, ThrowOnError, "fields",>

StaticputStylesheetByPathRename

Type Parameters

Parameters

Returns RequestResult< PutStylesheetByPathRenameResponses, PutStylesheetByPathRenameErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteStylesheetByPath

Returns RequestResult<
DeleteStylesheetByPathResponses,
DeleteStylesheetByPathErrors,
ThrowOnError,
"fields",
>

`Static`deleteStylesheetFolderByPath

Returns RequestResult<
DeleteStylesheetFolderByPathResponses,
DeleteStylesheetFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getItemStylesheet

Returns RequestResult<
GetItemStylesheetResponses,
GetItemStylesheetErrors,
ThrowOnError,
"fields",
>

`Static`getStylesheetByPath

Returns RequestResult<
GetStylesheetByPathResponses,
GetStylesheetByPathErrors,
ThrowOnError,
"fields",
>

`Static`getStylesheetFolderByPath

Returns RequestResult<
GetStylesheetFolderByPathResponses,
GetStylesheetFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStylesheetAncestors

Returns RequestResult<
GetTreeStylesheetAncestorsResponses,
GetTreeStylesheetAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStylesheetChildren

Returns RequestResult<
GetTreeStylesheetChildrenResponses,
GetTreeStylesheetChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStylesheetRoot

Returns RequestResult<
GetTreeStylesheetRootResponses,
GetTreeStylesheetRootErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStylesheetSiblings

Returns RequestResult<
GetTreeStylesheetSiblingsResponses,
GetTreeStylesheetSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`postStylesheet

Returns RequestResult<
PostStylesheetResponses,
PostStylesheetErrors,
ThrowOnError,
"fields",
>

`Static`postStylesheetFolder

Returns RequestResult<
PostStylesheetFolderResponses,
PostStylesheetFolderErrors,
ThrowOnError,
"fields",
>

`Static`putStylesheetByPath

Returns RequestResult<
PutStylesheetByPathResponses,
PutStylesheetByPathErrors,
ThrowOnError,
"fields",
>

`Static`putStylesheetByPathRename

Returns RequestResult<
PutStylesheetByPathRenameResponses,
PutStylesheetByPathRenameErrors,
ThrowOnError,
"fields",
>