Class ScriptService

Index

Constructors

Methods

deleteScriptByPath deleteScriptFolderByPath getItemScript getScriptByPath getScriptFolderByPath getTreeScriptAncestors getTreeScriptChildren getTreeScriptRoot getTreeScriptSiblings postScript postScriptFolder putScriptByPath putScriptByPathRename

Constructors

constructor

new ScriptService(): ScriptService
Returns ScriptService

Methods

`Static`deleteScriptByPath

deleteScriptByPath<ThrowOnError extends boolean = true>(
    options: Options<DeleteScriptByPathData, ThrowOnError>,
): RequestResult<
    DeleteScriptByPathResponses,
    DeleteScriptByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a script.

Deletes a script identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteScriptByPathData, ThrowOnError>
Returns RequestResult<
    DeleteScriptByPathResponses,
    DeleteScriptByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6317

`Static`deleteScriptFolderByPath

deleteScriptFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<DeleteScriptFolderByPathData, ThrowOnError>,
): RequestResult<
    DeleteScriptFolderByPathResponses,
    DeleteScriptFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a script folder.

Deletes a script folder identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteScriptFolderByPathData, ThrowOnError>
Returns RequestResult<
    DeleteScriptFolderByPathResponses,
    DeleteScriptFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6419

`Static`getItemScript

getItemScript<ThrowOnError extends boolean = true>(
    options?: Options<GetItemScriptData, ThrowOnError>,
): RequestResult<
    GetItemScriptResponses,
    GetItemScriptErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of script items.

Gets a collection of script items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemScriptData, ThrowOnError>
Returns RequestResult<
    GetItemScriptResponses,
    GetItemScriptErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6277

`Static`getScriptByPath

getScriptByPath<ThrowOnError extends boolean = true>(
    options: Options<GetScriptByPathData, ThrowOnError>,
): RequestResult<
    GetScriptByPathResponses,
    GetScriptByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a script by path.

Gets a script identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetScriptByPathData, ThrowOnError>
Returns RequestResult<
    GetScriptByPathResponses,
    GetScriptByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6335

`Static`getScriptFolderByPath

getScriptFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<GetScriptFolderByPathData, ThrowOnError>,
): RequestResult<
    GetScriptFolderByPathResponses,
    GetScriptFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a script folder by path.

Gets a script folder identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetScriptFolderByPathData, ThrowOnError>
Returns RequestResult<
    GetScriptFolderByPathResponses,
    GetScriptFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6437

`Static`getTreeScriptAncestors

getTreeScriptAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeScriptAncestorsData, ThrowOnError>,
): RequestResult<
    GetTreeScriptAncestorsResponses,
    GetTreeScriptAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor script items.

Gets a collection of script items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeScriptAncestorsData, ThrowOnError>
Returns RequestResult<
    GetTreeScriptAncestorsResponses,
    GetTreeScriptAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6455

`Static`getTreeScriptChildren

getTreeScriptChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeScriptChildrenData, ThrowOnError>,
): RequestResult<
    GetTreeScriptChildrenResponses,
    GetTreeScriptChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of script tree child items.

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

`Static`getTreeScriptRoot

getTreeScriptRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeScriptRootData, ThrowOnError>,
): RequestResult<
    GetTreeScriptRootResponses,
    GetTreeScriptRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of script items from the root of the tree.

Gets a paginated collection of script items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeScriptRootData, ThrowOnError>
Returns RequestResult<
    GetTreeScriptRootResponses,
    GetTreeScriptRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6491

`Static`getTreeScriptSiblings

getTreeScriptSiblings<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeScriptSiblingsData, ThrowOnError>,
): RequestResult<
    GetTreeScriptSiblingsResponses,
    GetTreeScriptSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of script tree sibling items.

Gets a collection of script tree items that are siblings of the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeScriptSiblingsData, ThrowOnError>
Returns RequestResult<
    GetTreeScriptSiblingsResponses,
    GetTreeScriptSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6509

`Static`postScript

postScript<ThrowOnError extends boolean = true>(
    options?: Options<PostScriptData, ThrowOnError>,
): RequestResult<
    PostScriptResponses,
    PostScriptErrors,
    ThrowOnError,
    "fields",
>
Creates a new script.

Creates a new script with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostScriptData, ThrowOnError>
Returns RequestResult<PostScriptResponses, PostScriptErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:6295

`Static`postScriptFolder

postScriptFolder<ThrowOnError extends boolean = true>(
    options?: Options<PostScriptFolderData, ThrowOnError>,
): RequestResult<
    PostScriptFolderResponses,
    PostScriptFolderErrors,
    ThrowOnError,
    "fields",
>
Creates a script folder.

Creates a new script folder with the provided name and parent location.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostScriptFolderData, ThrowOnError>
Returns RequestResult<
    PostScriptFolderResponses,
    PostScriptFolderErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6397

`Static`putScriptByPath

putScriptByPath<ThrowOnError extends boolean = true>(
    options: Options<PutScriptByPathData, ThrowOnError>,
): RequestResult<
    PutScriptByPathResponses,
    PutScriptByPathErrors,
    ThrowOnError,
    "fields",
>
Updates a script.

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

`Static`putScriptByPathRename

putScriptByPathRename<ThrowOnError extends boolean = true>(
    options: Options<PutScriptByPathRenameData, ThrowOnError>,
): RequestResult<
    PutScriptByPathRenameResponses,
    PutScriptByPathRenameErrors,
    ThrowOnError,
    "fields",
>
Renames a script.

Renames a script file to the specified new name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutScriptByPathRenameData, ThrowOnError>
Returns RequestResult<
    PutScriptByPathRenameResponses,
    PutScriptByPathRenameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6375

Class ScriptService

Index

Constructors

Methods

Constructors

constructor

Returns ScriptService

Methods

StaticdeleteScriptByPath

Type Parameters

Parameters

Returns RequestResult< DeleteScriptByPathResponses, DeleteScriptByPathErrors, ThrowOnError, "fields",>

StaticdeleteScriptFolderByPath

Type Parameters

Parameters

Returns RequestResult< DeleteScriptFolderByPathResponses, DeleteScriptFolderByPathErrors, ThrowOnError, "fields",>

StaticgetItemScript

Type Parameters

Parameters

Returns RequestResult< GetItemScriptResponses, GetItemScriptErrors, ThrowOnError, "fields",>

StaticgetScriptByPath

Type Parameters

Parameters

Returns RequestResult< GetScriptByPathResponses, GetScriptByPathErrors, ThrowOnError, "fields",>

StaticgetScriptFolderByPath

Type Parameters

Parameters

Returns RequestResult< GetScriptFolderByPathResponses, GetScriptFolderByPathErrors, ThrowOnError, "fields",>

StaticgetTreeScriptAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreeScriptAncestorsResponses, GetTreeScriptAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreeScriptChildren

Type Parameters

Parameters

Returns RequestResult< GetTreeScriptChildrenResponses, GetTreeScriptChildrenErrors, ThrowOnError, "fields",>

StaticgetTreeScriptRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeScriptRootResponses, GetTreeScriptRootErrors, ThrowOnError, "fields",>

StaticgetTreeScriptSiblings

Type Parameters

Parameters

Returns RequestResult< GetTreeScriptSiblingsResponses, GetTreeScriptSiblingsErrors, ThrowOnError, "fields",>

StaticpostScript

Type Parameters

Parameters

Returns RequestResult<PostScriptResponses, PostScriptErrors, ThrowOnError, "fields">

StaticpostScriptFolder

Type Parameters

Parameters

Returns RequestResult< PostScriptFolderResponses, PostScriptFolderErrors, ThrowOnError, "fields",>

StaticputScriptByPath

Type Parameters

Parameters

Returns RequestResult< PutScriptByPathResponses, PutScriptByPathErrors, ThrowOnError, "fields",>

StaticputScriptByPathRename

Type Parameters

Parameters

Returns RequestResult< PutScriptByPathRenameResponses, PutScriptByPathRenameErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteScriptByPath

Returns RequestResult<
DeleteScriptByPathResponses,
DeleteScriptByPathErrors,
ThrowOnError,
"fields",
>

`Static`deleteScriptFolderByPath

Returns RequestResult<
DeleteScriptFolderByPathResponses,
DeleteScriptFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getItemScript

Returns RequestResult<
GetItemScriptResponses,
GetItemScriptErrors,
ThrowOnError,
"fields",
>

`Static`getScriptByPath

Returns RequestResult<
GetScriptByPathResponses,
GetScriptByPathErrors,
ThrowOnError,
"fields",
>

`Static`getScriptFolderByPath

Returns RequestResult<
GetScriptFolderByPathResponses,
GetScriptFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getTreeScriptAncestors

Returns RequestResult<
GetTreeScriptAncestorsResponses,
GetTreeScriptAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeScriptChildren

Returns RequestResult<
GetTreeScriptChildrenResponses,
GetTreeScriptChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeScriptRoot

Returns RequestResult<
GetTreeScriptRootResponses,
GetTreeScriptRootErrors,
ThrowOnError,
"fields",
>

`Static`getTreeScriptSiblings

Returns RequestResult<
GetTreeScriptSiblingsResponses,
GetTreeScriptSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`postScript

`Static`postScriptFolder

Returns RequestResult<
PostScriptFolderResponses,
PostScriptFolderErrors,
ThrowOnError,
"fields",
>

`Static`putScriptByPath

Returns RequestResult<
PutScriptByPathResponses,
PutScriptByPathErrors,
ThrowOnError,
"fields",
>

`Static`putScriptByPathRename

Returns RequestResult<
PutScriptByPathRenameResponses,
PutScriptByPathRenameErrors,
ThrowOnError,
"fields",
>