roboto.domain.layouts

Submodules

Package Contents

CreateLayoutRequest

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

Bases: pydantic.BaseModel

Request payload to create a layout

Parameters

data Any

Attributes

CreateLayoutRequest.accessibility

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

CreateLayoutRequest.folder

folder str | None = None #

CreateLayoutRequest.layout_definition

layout_definition dict[str, Any] = None #

CreateLayoutRequest.name

name str = None #

CreateLayoutRequest.schema_version

schema_version int = None #

CreateLayoutRequest.tags

tags list[str] = None #

LayoutAccessibility

class roboto.domain.layouts.LayoutAccessibility#

Bases: roboto.compat.StrEnum

Controls who can view a layout.

Attributes

LayoutAccessibility.Organization

Organization = 'organization' #

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

LayoutAccessibility.User

User = 'user' #

Just the user who created the layout can view it.

LayoutRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of a layout

Parameters

data Any

Attributes

LayoutRecord.accessibility

accessibility LayoutAccessibility #

LayoutRecord.created

created datetime.datetime #

LayoutRecord.created_by

created_by str #

LayoutRecord.folder

folder str | None = None #

LayoutRecord.layout_definition

layout_definition dict[str, Any] #

LayoutRecord.layout_id

layout_id str #

LayoutRecord.modified

modified datetime.datetime #

LayoutRecord.modified_by

modified_by str #

LayoutRecord.name

name str #

LayoutRecord.org_id

org_id str #

LayoutRecord.schema_version

schema_version int #

LayoutRecord.tags

tags list[str] = None #

UpdateLayoutRequest

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

Bases: pydantic.BaseModel

Request payload to update a layout

Parameters

data Any

Attributes

UpdateLayoutRequest.accessibility

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

UpdateLayoutRequest.folder

folder str | None | roboto.sentinels.NotSetType = None #

UpdateLayoutRequest.layout_definition

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

UpdateLayoutRequest.model_config

model_config #

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

UpdateLayoutRequest.name

name str | roboto.sentinels.NotSetType = None #

UpdateLayoutRequest.schema_version

schema_version int | roboto.sentinels.NotSetType = None #

UpdateLayoutRequest.tags

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

UpdateLayoutRequest.validate_schema_version_with_definition()

validate_schema_version_with_definition()#

Return type

UpdateLayoutRequest