Type Alias ScriptType

type ScriptType = {
    createScriptTypeExportTemplate(): ScriptTypeExportInterface;
    exportScriptTypes(): Promise<ScriptTypeExportInterface>;
    importScriptTypes(
        importData: ScriptTypeExportInterface,
        scriptTypeId?: string,
    ): Promise<ScriptTypeSkeleton[]>;
    readScriptType(scriptTypeId: string): Promise<ScriptTypeSkeleton>;
    readScriptTypes(): Promise<ScriptTypeSkeleton[]>;
    updateScriptType(
        scriptTypeId: string,
        scriptTypeData: ScriptTypeSkeleton,
    ): Promise<ScriptTypeSkeleton>;
}

Index

Methods

createScriptTypeExportTemplate exportScriptTypes importScriptTypes readScriptType readScriptTypes updateScriptType

Methods

createScriptTypeExportTemplate

createScriptTypeExportTemplate(): ScriptTypeExportInterface
Create an empty scriptType export template

Returns ScriptTypeExportInterface
an empty scriptType export template
- Defined in ops/ScriptTypeOps.ts:29

exportScriptTypes

exportScriptTypes(): Promise<ScriptTypeExportInterface>
Export all scriptTypes. The response can be saved to file as is.

Returns Promise<ScriptTypeExportInterface>
Promise resolving to a ScriptTypeExportInterface object.
- Defined in ops/ScriptTypeOps.ts:45

importScriptTypes

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
- Defined in ops/ScriptTypeOps.ts:62

readScriptType

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
- Defined in ops/ScriptTypeOps.ts:35

readScriptTypes

readScriptTypes(): Promise<ScriptTypeSkeleton[]>
Read all scriptTypes.

Returns Promise<ScriptTypeSkeleton[]>
a promise that resolves to an array of scriptType objects
- Defined in ops/ScriptTypeOps.ts:40

updateScriptType

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
- Defined in ops/ScriptTypeOps.ts:52