Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.domain.device_types.operations

Module Contents

CreateDeviceTypeRequest

class roboto.domain.device_types.operations.CreateDeviceTypeRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request body for POST /v1/device-types/create, which creates a device type in the caller’s org.

Parameters

data Any

Attributes

CreateDeviceTypeRequest.description

description str | None = None #

Free-text description of the device type.

CreateDeviceTypeRequest.metadata

metadata dict[str, Any] = None #

Initial key-value metadata pairs to associate with the device type.

CreateDeviceTypeRequest.name

name str #

Name of the device type, unique within the org.

CreateDeviceTypeRequest.tags

tags list[str] = None #

Initial tags to associate with the device type.

UpdateDeviceTypeRequest

class roboto.domain.device_types.operations.UpdateDeviceTypeRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request body for PUT /v1/device-types/id/<device_type_id>.

Fields left at their defaults change nothing.

Parameters

data Any

Attributes

UpdateDeviceTypeRequest.description

description str | roboto.sentinels.NotSetType | None #

New description. None clears it.

UpdateDeviceTypeRequest.metadata_changeset

metadata_changeset roboto.updates.MetadataChangeset | None = None #

Metadata fields and tags to add, change, or remove.

UpdateDeviceTypeRequest.model_config

model_config #

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

UpdateDeviceTypeRequest.name

New name for the device type, unique within its org. Cannot be cleared.

Was this page helpful?