ayon_api.typing module¶

class ActionConfigResponse[source]¶

Bases: TypedDict

entityIds: List[str]¶

entitySubtypes: List[str]¶

entityType: str¶

formData: Dict[str, Any]¶

projectName: str¶

value: Dict[str, Any]¶

class ActionFormPayload[source]¶

Bases: dict

cancel_icon: str¶

cancel_label: str¶

extra_clipboard: str¶

extra_download: str¶

fields: List[Dict[str, Any]]¶

show_cancel_button: bool¶

show_submit_button: bool¶

submit_icon: str¶

submit_label: str¶

title: str¶

class ActionLauncherPayload[source]¶

Bases: dict

extra_clipboard: str¶

extra_download: str¶

uri: str¶

class ActionManifestDict[source]¶

Bases: TypedDict

addonName: str¶

addonVersion: str¶

adminOnly: bool¶

category: str¶

configFields: List[Dict[str, Any]]¶

featured: bool¶

groupLabel: Optional[str]¶

icon: Optional[IconDefType]¶

identifier: str¶

label: str¶

managerOnly: bool¶

order: int¶

variant: str¶

class ActionNavigatePayload[source]¶

Bases: dict

extra_clipboard: str¶

extra_download: str¶

uri: str¶

class ActionQueryPayload[source]¶

Bases: dict

extra_clipboard: str¶

extra_download: str¶

query: str¶

class ActionRedirectPayload[source]¶

Bases: dict

extra_clipboard: str¶

extra_download: str¶

new_tab: bool¶

uri: str¶

class ActionTakeResponse[source]¶

Bases: TypedDict

actionIdentifier: str¶

addonName: str¶

addonVersion: str¶

args: List[str]¶

context: Dict[str, Any]¶

eventId: str¶

userName: str¶

variant: str¶

class ActionTriggerResponse[source]¶

Bases: TypedDict

message: Optional[str]¶

payload: Optional[Union[ActionLauncherPayload, ActionNavigatePayload, ActionRedirectPayload, ActionQueryPayload, ActionFormPayload]]¶

success: bool¶

type: Literal['form', 'launcher', 'navigate', 'query', 'redirect', 'simple']¶

class AddonInfoDict[source]¶

Bases: TypedDict

name: str¶

title: str¶

versions: Dict[str, AddonVersionInfoDict]¶

class AddonVersionInfoDict[source]¶

Bases: TypedDict

clientPyproject: Dict[str, Any]¶

clientSourceInfo: List[Dict[str, Any]]¶

frontendScopes: Dict[str, Any]¶

hasSettings: bool¶

hasSiteSettings: bool¶

isBroken: bool¶

class AddonsInfoDict[source]¶

Bases: TypedDict

addons: List[AddonInfoDict]¶

class AnatomyPresetDict[source]¶

Bases: TypedDict

attributes: Dict[str, Any]¶

folder_types: List[AnatomyPresetSubtypeDict]¶

link_types: List[AnatomyPresetLinkTypeDict]¶

roots: List[AnatomyPresetRootDict]¶

statuses: List[AnatomyPresetStatusDict]¶

tags: List[AnatomyPresetTagDict]¶

task_types: List[AnatomyPresetSubtypeDict]¶

templates: AnatomyPresetTemplatesDict¶

class AnatomyPresetInfoDict[source]¶

Bases: TypedDict

name: str¶

primary: bool¶

version: str¶

class AnatomyPresetLinkTypeDict[source]¶

Bases: TypedDict

color: str¶

input_type: str¶

link_type: str¶

output_type: str¶

style: str¶

class AnatomyPresetRootDict[source]¶

Bases: TypedDict

darwin: str¶

linux: str¶

name: str¶

windows: str¶

class AnatomyPresetStatusDict[source]¶

Bases: TypedDict

color: str¶

icon: str¶

name: str¶

original_name: str¶

scope: List[Literal['folder', 'task', 'product', 'version', 'representation', 'workfile']]¶

shortName: str¶

state: str¶

class AnatomyPresetSubtypeDict[source]¶

Bases: TypedDict

icon: str¶

name: str¶

original_name: str¶

shortName: str¶

class AnatomyPresetTagDict[source]¶

Bases: TypedDict

color: str¶

name: str¶

original_name: str¶

class AnatomyPresetTemplateDict[source]¶

Bases: TypedDict

directory: str¶

file: str¶

name: str¶

class AnatomyPresetTemplatesDict[source]¶

Bases: TypedDict

delivery: List[AnatomyPresetTemplateDict]¶

frame: str¶

frame_padding: int¶

hero: List[AnatomyPresetTemplateDict]¶

others: List[AnatomyPresetTemplateDict]¶

publish: List[AnatomyPresetTemplateDict]¶

staging: List[AnatomyPresetTemplateDict]¶

version: str¶

version_padding: int¶

work: List[AnatomyPresetTemplateDict]¶

class AttributeEnumItemDict[source]¶

Bases: TypedDict

color: Optional[str]¶

icon: Optional[str]¶

label: str¶

value: Union[str, int, float, bool]¶

class AttributeSchemaDataDict[source]¶

Bases: TypedDict

default: Optional[Any]¶

description: Optional[str]¶

enum: Optional[List[AttributeEnumItemDict]]¶

example: Optional[Any]¶

ge: Optional[Union[int, float]]¶

gt: Optional[Union[int, float]]¶

inherit: bool¶

le: Optional[Union[int, float]]¶

lt: Optional[Union[int, float]]¶

maxItems: Optional[int]¶

maxLength: Optional[int]¶

minItems: Optional[int]¶

minLength: Optional[int]¶

regex: Optional[str]¶

title: str¶

type: Literal['string', 'integer', 'float', 'boolean', 'datetime', 'list_of_strings', 'list_of_integers', 'list_of_any', 'list_of_submodels', 'dict']¶

class AttributeSchemaDict[source]¶

Bases: TypedDict

builtin: bool¶

data: AttributeSchemaDataDict¶

name: str¶

position: int¶

scope: List[Literal['project', 'folder', 'task', 'product', 'version', 'representation', 'workfile', 'user']]¶

class AttributesSchemaDict[source]¶

Bases: TypedDict

attributes: List[AttributeSchemaDict]¶

class BaseActionPayload[source]¶

Bases: TypedDict

extra_clipboard: str¶

extra_download: str¶

class BundleInfoDict[source]¶

Bases: TypedDict

activeUser: Optional[str]¶

addonDevelopment: Dict[str, DevBundleAddonInfoDict]¶

addons: Dict[str, str]¶

createdAt: str¶

dependencyPackages: Dict[str, str]¶

installerVersion: str¶

isArchived: bool¶

isDev: bool¶

isProduction: bool¶

isStaging: bool¶

name: str¶

class BundlesInfoDict[source]¶

Bases: TypedDict

bundles: List[BundleInfoDict]¶

devBundles: List[str]¶

productionBundle: str¶

class DependencyPackageDict[source]¶

Bases: TypedDict

checksum: str¶

checksumAlgorithm: str¶

filename: str¶

installerVersion: str¶

platform: str¶

pythonModules: Dict[str, str]¶

size: int¶

sourceAddons: Dict[str, str]¶

sources: List[Dict[str, Any]]¶

class DependencyPackagesDict[source]¶

Bases: TypedDict

packages: List[DependencyPackageDict]¶

class DevBundleAddonInfoDict[source]¶

Bases: TypedDict

enabled: bool¶

path: str¶

class EntityListAttributeDefinitionDict[source]¶

Bases: TypedDict

data: Dict[str, Any]¶

name: str¶

class EventFilter[source]¶

Bases: TypedDict

conditions: List[EventFilterCondition]¶

operator: Literal['and', 'or']¶

class EventFilterCondition[source]¶

Bases: TypedDict

key: str¶

operator: Literal['eq', 'lt', 'gt', 'lte', 'gte', 'ne', 'isnull', 'notnull', 'in', 'notin', 'contains', 'excludes', 'like']¶

value: Union[None, str, int, float, List[str], List[int], List[float]]¶

class FlatFolderDict[source]¶

Bases: TypedDict

attrib: Dict[str, Any]¶

folderType: str¶

hasChildren: bool¶

hasTasks: bool¶

id: str¶

label: Optional[str]¶

name: str¶

ownAttrib: List[str]¶

parentId: Optional[str]¶

parents: List[str]¶

path: str¶

status: str¶

taskNames: List[str]¶

updatedAt: str¶

class IconDefType[source]¶

Bases: TypedDict

color: Optional[str]¶

icon: Optional[str]¶

name: Optional[str]¶

type: Literal['material-symbols', 'url']¶

class InstallerInfoDict[source]¶

Bases: TypedDict

checksum: str¶

checksumAlgorithm: str¶

filename: str¶

platform: str¶

pythonModules: Dict[str, str]¶

pythonVersion: str¶

runtimePythonModules: Dict[str, str]¶

size: int¶

sources: List[Dict[str, Any]]¶

version: str¶

class InstallersInfoDict[source]¶

Bases: TypedDict

installers: List[InstallerInfoDict]¶

class ProductTypeDict[source]¶

Bases: TypedDict

color: Optional[str]¶

icon: Optional[str]¶

name: str¶

class ProjectHierarchyDict[source]¶

Bases: TypedDict

hierarchy: List[ProjectHierarchyItemDict]¶

class ProjectHierarchyItemDict[source]¶

Bases: TypedDict

children: List[ProjectHierarchyItemDict]¶

folderType: str¶

hasTasks: bool¶

id: str¶

label: str¶

name: str¶

parentId: Optional[str]¶

parents: List[str]¶

status: str¶

taskNames: List[str]¶

class SecretDict[source]¶

Bases: TypedDict

name: str¶

value: str¶