Type Alias ScriptType

Type declaration

• createScriptTypeExportTemplate:function

  • createScriptTypeExportTemplate(): ScriptTypeExportInterface

    Create an empty scriptType export template

    Returns ScriptTypeExportInterface

    an empty scriptType export template

• exportScriptTypes:function

  • exportScriptTypes(): Promise<ScriptTypeExportInterface>

    Export all scriptTypes. The response can be saved to file as is.

    Returns Promise<ScriptTypeExportInterface>

    Promise resolving to a ScriptTypeExportInterface object.

• importScriptTypes:function

  • importScriptTypes(
        importData: ScriptTypeExportInterface,
        scriptTypeId?: string,
    ): Promise<ScriptTypeSkeleton[]>

    Import script types

    Parameters

    • importData: ScriptTypeExportInterface

      script type import data
    • OptionalscriptTypeId: string

      Optional script type id. If supplied, only the script type of that id is imported. Takes priority over scriptTypeUrl if both are provided.

    Returns Promise<ScriptTypeSkeleton[]>

    the imported script types

• readScriptType:function

  • readScriptType(scriptTypeId: string): Promise<ScriptTypeSkeleton>

    Read scriptType by id

    Parameters

    • scriptTypeId: string

      ScriptType id

    Returns Promise<ScriptTypeSkeleton>

    a promise that resolves to a scriptType object

• readScriptTypes:function

  • readScriptTypes(): Promise<ScriptTypeSkeleton[]>

    Read all scriptTypes.

    Returns Promise<ScriptTypeSkeleton[]>

    a promise that resolves to an array of scriptType objects

• updateScriptType:function

  • updateScriptType(
        scriptTypeId: string,
        scriptTypeData: ScriptTypeSkeleton,
    ): Promise<ScriptTypeSkeleton>

    Update script type

    Parameters

    • scriptTypeId: string

      script type id
    • scriptTypeData: ScriptTypeSkeleton

      script type data

    Returns Promise<ScriptTypeSkeleton>

    a promise resolving to a script type object