roboto.domain.layouts

Submodules

• roboto.domain.layouts.operations
• roboto.domain.layouts.record

Package Contents

class roboto.domain.layouts.CreateLayoutRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to create a layout

Parameters:

data (Any)

accessibility: roboto.domain.layouts.record.LayoutAccessibility = None

layout_definition: dict[str, Any] = None

name: str = None

schema_version: int = None

tags: list[str] = None

class roboto.domain.layouts.LayoutAccessibility

Bases: str, enum.Enum

Controls who can view a layout.

Organization = 'organization'

All members of the organization owning the layout can view the layout.

User = 'user'

Just the user who created the layout can view it.

class roboto.domain.layouts.LayoutRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of a layout

Parameters:

data (Any)

accessibility: LayoutAccessibility

created: datetime.datetime

created_by: str

layout_definition: dict[str, Any]

layout_id: str

modified: datetime.datetime

modified_by: str

name: str

org_id: str

schema_version: int

tags: list[str] = None

class roboto.domain.layouts.UpdateLayoutRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to update a layout

Parameters:

data (Any)

accessibility: roboto.domain.layouts.record.LayoutAccessibility | roboto.sentinels.NotSetType = None

layout_definition: dict[str, Any] | roboto.sentinels.NotSetType = None

name: str | roboto.sentinels.NotSetType = None

schema_version: int | roboto.sentinels.NotSetType = None

tags: list[str] | roboto.sentinels.NotSetType = None

validate_schema_version_with_definition()

Return type:

UpdateLayoutRequest