iots.models package๏ƒ

Submodules๏ƒ

iots.models.anythingdb module๏ƒ

class iots.models.models.Acl(*, publish: Optional[List[PublishItem]] = None, subscribe: Optional[List[SubscribeItem]] = None)๏ƒ

Bases: APIBaseModel

publish: Optional[List[PublishItem]]๏ƒ
subscribe: Optional[List[SubscribeItem]]๏ƒ
class iots.models.models.ActionAffordance(*, description: Optional[str] = None, title: Optional[str] = None, idempotent: Optional[bool] = None, input: Optional[DataSchema] = None, output: Optional[DataSchema] = None, safe: Optional[bool] = None, **data)๏ƒ

Bases: InteractionAffordance

idempotent: Optional[bool]๏ƒ
input: Optional[DataSchema]๏ƒ
output: Optional[DataSchema]๏ƒ
safe: Optional[bool]๏ƒ
class iots.models.models.ActionCreateRequest(*, __root__: Optional[Dict[str, ActionCreateRequest1]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.ActionCreateRequest1(*, input: Optional[AnyValue] = None)๏ƒ

Bases: APIBaseModel

input: Optional[AnyValue]๏ƒ
class iots.models.models.ActionListResponse(*, data: Optional[List[ActionResponse]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[ActionResponse]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.ActionResponse(*, __root__: Optional[Dict[str, ActionValue]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.ActionUpdateRequest(*, __root__: Optional[Dict[str, ActionUpdateRequest1]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.ActionUpdateRequest1(*, output: Optional[AnyValue] = None, status: Optional[str] = None)๏ƒ

Bases: APIBaseModel

output: Optional[AnyValue]๏ƒ
status: Optional[str]๏ƒ
class iots.models.models.ActionValue(*, href: Optional[str] = None, input: Optional[AnyValue] = None, status: Optional[str] = None, timeCompleted: Optional[datetime] = None, timeRequested: Optional[datetime] = None)๏ƒ

Bases: APIBaseModel

href: Optional[str]๏ƒ
input: Optional[AnyValue]๏ƒ
status: Optional[str]๏ƒ
timeCompleted: Optional[datetime]๏ƒ
timeRequested: Optional[datetime]๏ƒ
class iots.models.models.AnyValue(*, __root__: Optional[Union[List, bool, int, float, Dict[str, Any], str]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.Category(*, description: Optional[str] = None, model: Optional[ModelDescriptionCategory] = None, name: Optional[ConstrainedStrValue] = None, created: Optional[datetime] = None, modified: Optional[datetime] = None)๏ƒ

Bases: CategoryBase

created: Optional[datetime]๏ƒ
modified: Optional[datetime]๏ƒ
class iots.models.models.CategoryBase(*, description: Optional[str] = None, model: Optional[ModelDescriptionCategory] = None, name: Optional[ConstrainedStrValue] = None)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
model: Optional[ModelDescriptionCategory]๏ƒ
name: Optional[constr(regex='^[a-zA-Z0-9_:-]{1,26}$')]๏ƒ
class iots.models.models.CategoryCreate(*, description: Optional[str] = None, model: Optional[ModelDescriptionCategory] = None, name: ConstrainedStrValue)๏ƒ

Bases: CategoryBase

name: constr(regex='^[a-zA-Z0-9_:-]{1,26}$')๏ƒ
class iots.models.models.CategoryList(*, data: Optional[List[Category]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[Category]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.CategoryUpdate(*, description: Optional[str] = None, model: Optional[ModelDescriptionCategory] = None, name: ConstrainedStrValue)๏ƒ

Bases: CategoryBase

name: constr(regex='^[a-zA-Z0-9_:-]{1,26}$')๏ƒ
class iots.models.models.CreateCategoryPropertiesHistoryValuesRequest(*, __root__: Union[PropertyHistoryValue, PropertyHistoryValues])๏ƒ

Bases: APIBaseModel

class iots.models.models.CreateCategoryPropertyHistoryValuesRequest(*, __root__: Union[PropertyHistoryValue, PropertyHistoryValues])๏ƒ

Bases: APIBaseModel

class iots.models.models.CreatePropertiesHistoryValuesRequest(*, __root__: Union[PropertyHistoryValue, PropertyHistoryValues])๏ƒ

Bases: APIBaseModel

class iots.models.models.CreatePropertyHistoryValuesRequest(*, __root__: Union[PropertyHistoryValue, PropertyHistoryValues])๏ƒ

Bases: APIBaseModel

class iots.models.models.DataSchema(*, const: Optional[Any] = None, description: Optional[str] = None, enum: Optional[ConstrainedListValue[Any]] = None, items: Optional[Union[DataSchema, List[DataSchema]]] = None, maxItems: Optional[ConstrainedIntValue] = None, maximum: Optional[float] = None, minItems: Optional[ConstrainedIntValue] = None, minimum: Optional[float] = None, oneOf: Optional[List[DataSchema]] = None, properties: Optional[Any] = None, readOnly: Optional[bool] = None, required: Optional[List[str]] = None, title: Optional[str] = None, type: Optional[Type] = None, unit: Optional[str] = None, **data)๏ƒ

Bases: APIBaseModel

class Config๏ƒ

Bases: object

extra = 'forbid'๏ƒ
const: Optional[Any]๏ƒ
description: Optional[str]๏ƒ
enum: Optional[List]๏ƒ
field_type: Optional[Union[str, List[str]]]๏ƒ
items: Optional[Union[DataSchema, List[DataSchema]]]๏ƒ
maxItems: Optional[conint(ge=0)]๏ƒ
maximum: Optional[float]๏ƒ
minItems: Optional[conint(ge=0)]๏ƒ
minimum: Optional[float]๏ƒ
oneOf: Optional[List[DataSchema]]๏ƒ
properties: Optional[Any]๏ƒ
readOnly: Optional[bool]๏ƒ
required: Optional[List[str]]๏ƒ
title: Optional[str]๏ƒ
type: Optional[Type]๏ƒ
unit: Optional[str]๏ƒ
class iots.models.models.Email(*, bcc: Optional[List[str]] = None, body: Optional[EmailBody] = None, cc: Optional[List[str]] = None, subject: Optional[str] = None, to: List[str])๏ƒ

Bases: APIBaseModel

bcc: Optional[List[str]]๏ƒ
body: Optional[EmailBody]๏ƒ
cc: Optional[List[str]]๏ƒ
subject: Optional[str]๏ƒ
to: List[str]๏ƒ
class iots.models.models.EmailBody(*, html: Optional[str] = None, text: Optional[str] = None)๏ƒ

Bases: APIBaseModel

html: Optional[str]๏ƒ
text: Optional[str]๏ƒ
class iots.models.models.Error(*, details: Optional[Dict[str, Any]] = None, message: str, status: int)๏ƒ

Bases: APIBaseModel

details: Optional[Dict[str, Any]]๏ƒ
message: str๏ƒ
status: int๏ƒ
class iots.models.models.ErrorResponse(*, error: Optional[Error] = None)๏ƒ

Bases: APIBaseModel

error: Optional[Error]๏ƒ
class iots.models.models.EventAffordance(*, description: Optional[str] = None, title: Optional[str] = None, cancellation: Optional[DataSchema] = None, data: Optional[DataSchema] = None, subscription: Optional[DataSchema] = None, **data_)๏ƒ

Bases: InteractionAffordance

cancellation: Optional[DataSchema]๏ƒ
data: Optional[DataSchema]๏ƒ
subscription: Optional[DataSchema]๏ƒ
class iots.models.models.EventCreateRequest(*, __root__: Optional[Dict[str, EventCreateRequest1]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.EventCreateRequest1(*, data: Optional[AnyValue] = None)๏ƒ

Bases: APIBaseModel

data: Optional[AnyValue]๏ƒ
class iots.models.models.EventListResponse(*, data: Optional[List[EventResponse]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[EventResponse]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.EventResponse(*, __root__: Optional[Dict[str, EventValue]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.EventValue(*, data: Optional[AnyValue] = None, href: Optional[str] = None, timestamp: Optional[datetime] = None)๏ƒ

Bases: APIBaseModel

data: Optional[AnyValue]๏ƒ
href: Optional[str]๏ƒ
timestamp: Optional[datetime]๏ƒ
class iots.models.models.Forbidden(*, __root__: Any)๏ƒ

Bases: APIBaseModel

class iots.models.models.ID(*, __root__: str)๏ƒ

Bases: APIBaseModel

class iots.models.models.InteractionAffordance(*, description: Optional[str] = None, title: Optional[str] = None, **data)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
field_type: Optional[Union[str, List[str]]]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.JsonPatchOperation(*, op: Op, path: str, value: Optional[AnyValue] = None, **data)๏ƒ

Bases: APIBaseModel

from_: Optional[str]๏ƒ
op: Op๏ƒ
path: str๏ƒ
value: Optional[AnyValue]๏ƒ

Bases: APIBaseModel

href: Optional[str]๏ƒ
rel: Optional[str]๏ƒ
class iots.models.models.MQTTCategoryDocument(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None, collection_name: Optional[str] = None, created: Optional[str] = None, id: Optional[ID] = None)๏ƒ

Bases: MQTTCategoryForm

created: Optional[str]๏ƒ
id: Optional[ID]๏ƒ
class iots.models.models.MQTTCategoryForm(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None, collection_name: Optional[str] = None)๏ƒ

Bases: MQTTForm

collection_name: Optional[str]๏ƒ
class iots.models.models.MQTTForm(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
enabled: Optional[bool]๏ƒ
password: Optional[str]๏ƒ
username: Optional[str]๏ƒ
class iots.models.models.MQTTFormGet(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
enabled: Optional[bool]๏ƒ
password: Optional[str]๏ƒ
username: Optional[str]๏ƒ
class iots.models.models.MQTTThingDocument(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None, created: Optional[str] = None, id: Optional[ID] = None, topics: Optional[MQTTThingDocumentACL] = None)๏ƒ

Bases: MQTTThingForm

created: Optional[str]๏ƒ
id: Optional[ID]๏ƒ
topics: Optional[MQTTThingDocumentACL]๏ƒ
class iots.models.models.MQTTThingDocumentACL(*, acl: Optional[Acl] = None)๏ƒ

Bases: APIBaseModel

acl: Optional[Acl]๏ƒ
class iots.models.models.MQTTThingDocumentGet(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None, created: Optional[str] = None, id: Optional[ID] = None, topics: Optional[MQTTThingDocumentACL] = None)๏ƒ

Bases: MQTTThingFormGet

created: Optional[str]๏ƒ
id: Optional[ID]๏ƒ
topics: Optional[MQTTThingDocumentACL]๏ƒ
class iots.models.models.MQTTThingForm(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None)๏ƒ

Bases: MQTTForm

description: Optional[str]๏ƒ
enabled: Optional[bool]๏ƒ
password: Optional[str]๏ƒ
username: Optional[str]๏ƒ
class iots.models.models.MQTTThingFormGet(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None)๏ƒ

Bases: MQTTFormGet

description: Optional[str]๏ƒ
enabled: Optional[bool]๏ƒ
password: Optional[str]๏ƒ
username: Optional[str]๏ƒ
class iots.models.models.MQTTThingsDocument(*, description: Optional[str] = None, enabled: Optional[bool] = None, password: Optional[str] = None, username: Optional[str] = None, created: Optional[str] = None, id: Optional[ID] = None)๏ƒ

Bases: MQTTThingForm

created: Optional[str]๏ƒ
id: Optional[ID]๏ƒ
class iots.models.models.MQTTThingsDocumentList(*, data: Optional[List[MQTTThingDocument]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[MQTTThingDocument]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.Model(*, description: Optional[str] = None, name: ConstrainedStrValue, id: Optional[str] = None, created: Optional[datetime] = None, modified: Optional[datetime] = None)๏ƒ

Bases: ModelBase

created: Optional[datetime]๏ƒ
id: Optional[str]๏ƒ
modified: Optional[datetime]๏ƒ
class iots.models.models.ModelBase(*, description: Optional[str] = None, name: ConstrainedStrValue)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
name: constr(regex='^[a-zA-Z0-9_:-]{1,26}$')๏ƒ
class iots.models.models.ModelCreate(*, description: Optional[str] = None, name: ConstrainedStrValue)๏ƒ

Bases: ModelBase

name: constr(regex='^[a-zA-Z0-9_:-]{1,26}$')๏ƒ
class iots.models.models.ModelDescription(*, name: Optional[str] = None, version: Optional[int] = None)๏ƒ

Bases: APIBaseModel

name: Optional[str]๏ƒ
version: Optional[int]๏ƒ
class iots.models.models.ModelDescriptionCategory(*, name: str, version: Optional[int] = None)๏ƒ

Bases: APIBaseModel

name: str๏ƒ
version: Optional[int]๏ƒ
class iots.models.models.ModelList(*, data: Optional[List[Model]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[Model]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.ModelUpdate(*, description: Optional[str] = None, name: ConstrainedStrValue)๏ƒ

Bases: ModelBase

name: constr(regex='^[a-zA-Z0-9_:-]{1,26}$')๏ƒ
class iots.models.models.ModelVersion(*, description: Optional[str] = None, template: Optional[Template] = None, title: Optional[str] = None, version: Optional[int] = None, created: Optional[datetime] = None)๏ƒ

Bases: ModelVersionBase

created: Optional[datetime]๏ƒ
version: Optional[int]๏ƒ
class iots.models.models.ModelVersionBase(*, description: Optional[str] = None, template: Optional[Template] = None, title: Optional[str] = None)๏ƒ

Bases: APIBaseModel

description: Optional[str]๏ƒ
template: Optional[Template]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.ModelVersionCreate(*, description: Optional[str] = None, template: Optional[Template] = None, title: Optional[str] = None)๏ƒ

Bases: ModelVersionBase

description: Optional[str]๏ƒ
template: Optional[Template]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.ModelVersionList(*, data: Optional[List[ModelVersion]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[ModelVersion]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.Op(value)๏ƒ

Bases: Enum

An enumeration.

add = 'add'๏ƒ
copy = 'copy'๏ƒ
move = 'move'๏ƒ
remove = 'remove'๏ƒ
replace = 'replace'๏ƒ
test = 'test'๏ƒ
class iots.models.models.Paging(*, next_cursor: Optional[str] = None, previous_cursor: Optional[str] = None)๏ƒ

Bases: APIBaseModel

next_cursor: Optional[str]๏ƒ
previous_cursor: Optional[str]๏ƒ
class iots.models.models.PostAPICursor(*, batchSize: Optional[int] = None, bindVars: Optional[List[Dict[str, Any]]] = None, cache: Optional[bool] = None, count: Optional[bool] = None, memoryLimit: Optional[int] = None, options: Optional[Dict[str, Any]] = None, query: str, then: Optional[ThenOperation] = None, ttl: Optional[int] = None)๏ƒ

Bases: APIBaseModel

batchSize: Optional[int]๏ƒ
bindVars: Optional[List[Dict[str, Any]]]๏ƒ
cache: Optional[bool]๏ƒ
count: Optional[bool]๏ƒ
memoryLimit: Optional[int]๏ƒ
options: Optional[Dict[str, Any]]๏ƒ
query: str๏ƒ
then: Optional[ThenOperation]๏ƒ
ttl: Optional[int]๏ƒ
class iots.models.models.PostAPICursorResponse(*, cached: Optional[bool] = None, code: Optional[int] = None, count: Optional[int] = None, error: bool, extra: Optional[Dict[str, Any]] = None, hasMore: Optional[bool] = None, id: Optional[str] = None, result: Optional[List] = None, then: Optional[Then] = None)๏ƒ

Bases: APIBaseModel

cached: Optional[bool]๏ƒ
code: Optional[int]๏ƒ
count: Optional[int]๏ƒ
error: bool๏ƒ
extra: Optional[Dict[str, Any]]๏ƒ
hasMore: Optional[bool]๏ƒ
id: Optional[str]๏ƒ
result: Optional[List]๏ƒ
then: Optional[Then]๏ƒ
class iots.models.models.Properties(*, __root__: Optional[Dict[str, Any]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.Property(*, __root__: Optional[Dict[str, Any]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.PropertyAffordance(*, description: Optional[str] = None, title: Optional[str] = None, observable: Optional[bool] = None, **data)๏ƒ

Bases: InteractionAffordance

observable: Optional[bool]๏ƒ
class iots.models.models.PropertyHistoryValue(*, at: datetime, properties: PropertyValues)๏ƒ

Bases: APIBaseModel

at: datetime๏ƒ
properties: PropertyValues๏ƒ
class iots.models.models.PropertyHistoryValueList(*, data: Optional[List[PropertyHistoryValue]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[PropertyHistoryValue]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.PropertyHistoryValues(*, __root__: List[PropertyHistoryValue])๏ƒ

Bases: APIBaseModel

class iots.models.models.PropertyValues(*, __root__: Optional[Dict[str, Any]] = None)๏ƒ

Bases: APIBaseModel

class iots.models.models.PublishItem(*, pattern: Optional[str] = None)๏ƒ

Bases: APIBaseModel

pattern: Optional[str]๏ƒ
class iots.models.models.Resource(*, data: Optional[Union[ActionResponse, EventResponse, PropertyHistoryValues]] = None, thing_id: Optional[str] = None)๏ƒ

Bases: APIBaseModel

data: Optional[Union[ActionResponse, EventResponse, PropertyHistoryValues]]๏ƒ
thing_id: Optional[str]๏ƒ
class iots.models.models.ResourceList(*, data: Optional[List[Resource]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[Resource]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.Results(*, response: Optional[Dict[str, Any]] = None, status: Optional[int] = None)๏ƒ

Bases: APIBaseModel

response: Optional[Dict[str, Any]]๏ƒ
status: Optional[int]๏ƒ
class iots.models.models.SubscribeItem(*, pattern: Optional[str] = None)๏ƒ

Bases: APIBaseModel

pattern: Optional[str]๏ƒ
class iots.models.models.Template(*, actions: Optional[Dict[str, Any]] = None, description: Optional[str] = None, events: Optional[Dict[str, Any]] = None, links: Optional[List[Dict[str, Any]]] = None, properties: Optional[Dict[str, Any]] = None, title: Optional[str] = None)๏ƒ

Bases: APIBaseModel

actions: Optional[Dict[str, Any]]๏ƒ
description: Optional[str]๏ƒ
events: Optional[Dict[str, Any]]๏ƒ
properties: Optional[Dict[str, Any]]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.Then(*, error_count: Optional[bool] = None, success_count: Optional[bool] = None)๏ƒ

Bases: APIBaseModel

error_count: Optional[bool]๏ƒ
success_count: Optional[bool]๏ƒ
class iots.models.models.ThenOperation(*, data: Optional[Any] = None, op: Optional[str] = None, resource: Optional[str] = None)๏ƒ

Bases: APIBaseModel

data: Optional[Any]๏ƒ
op: Optional[str]๏ƒ
resource: Optional[str]๏ƒ
class iots.models.models.ThenQueryRequest(*, then: Optional[ThenOperation] = None)๏ƒ

Bases: APIBaseModel

then: Optional[ThenOperation]๏ƒ
class iots.models.models.Thing(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, categories: Optional[List[str]] = None, client_id: Optional[str] = None, id: Optional[str] = None, uid: Optional[str] = None, created: Optional[datetime] = None, modified: Optional[datetime] = None, **data)๏ƒ

Bases: ThingBase

categories: Optional[List[str]]๏ƒ
client_id: Optional[str]๏ƒ
created: Optional[datetime]๏ƒ
id: Optional[str]๏ƒ
modified: Optional[datetime]๏ƒ
uid: Optional[str]๏ƒ
class iots.models.models.ThingBase(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, **data)๏ƒ

Bases: APIBaseModel

actions: Optional[Dict[str, ActionAffordance]]๏ƒ
description: Optional[str]๏ƒ
events: Optional[Dict[str, EventAffordance]]๏ƒ
field_context: Optional[str]๏ƒ
field_type: Optional[Union[str, List[str]]]๏ƒ
model: Optional[ModelDescription]๏ƒ
properties: Optional[Dict[str, PropertyAffordance]]๏ƒ
status: Optional[PropertyValues]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.ThingCategory(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, client_id: Optional[str] = None, id: Optional[str] = None, uid: Optional[str] = None, created: Optional[datetime] = None, modified: Optional[datetime] = None, **data)๏ƒ

Bases: ThingBase

client_id: Optional[str]๏ƒ
created: Optional[datetime]๏ƒ
id: Optional[str]๏ƒ
modified: Optional[datetime]๏ƒ
uid: Optional[str]๏ƒ
class iots.models.models.ThingCategoryCreate(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, **data)๏ƒ

Bases: ThingBase

actions: Optional[Dict[str, ActionAffordance]]๏ƒ
description: Optional[str]๏ƒ
events: Optional[Dict[str, EventAffordance]]๏ƒ
field_context: Optional[str]๏ƒ
field_type: Optional[Union[str, List[str]]]๏ƒ
model: Optional[ModelDescription]๏ƒ
properties: Optional[Dict[str, PropertyAffordance]]๏ƒ
status: Optional[PropertyValues]๏ƒ
title: Optional[str]๏ƒ
class iots.models.models.ThingCategoryList(*, data: Optional[List[ThingCategory]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[ThingCategory]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.ThingCategoryUpdate(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, id: Optional[str] = None, uid: Optional[str] = None, **data)๏ƒ

Bases: ThingBase

id: Optional[str]๏ƒ
uid: Optional[str]๏ƒ
class iots.models.models.ThingCreate(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, categories: Optional[List[str]] = None, **data)๏ƒ

Bases: ThingBase

categories: Optional[List[str]]๏ƒ
class iots.models.models.ThingList(*, data: Optional[List[Thing]] = None, paging: Optional[Paging] = None)๏ƒ

Bases: APIBaseModel

data: Optional[List[Thing]]๏ƒ
paging: Optional[Paging]๏ƒ
class iots.models.models.ThingOAuth2Credentials(*, client_id: Optional[str] = None, client_secret: Optional[str] = None)๏ƒ

Bases: APIBaseModel

client_id: Optional[str]๏ƒ
client_secret: Optional[str]๏ƒ
class iots.models.models.ThingPatch(*, __root__: List[JsonPatchOperation])๏ƒ

Bases: APIBaseModel

class iots.models.models.ThingUpdate(*, actions: Optional[Dict[str, ActionAffordance]] = None, description: Optional[str] = None, events: Optional[Dict[str, EventAffordance]] = None, links: Optional[List[Link]] = None, model: Optional[ModelDescription] = None, properties: Optional[Dict[str, PropertyAffordance]] = None, status: Optional[PropertyValues] = None, title: Optional[str] = None, id: Optional[str] = None, uid: Optional[str] = None, categories: Optional[List[str]] = None, **data)๏ƒ

Bases: ThingBase

categories: Optional[List[str]]๏ƒ
id: Optional[str]๏ƒ
uid: Optional[str]๏ƒ
class iots.models.models.ThingsDeleted(*, __root__: List[str])๏ƒ

Bases: APIBaseModel

class iots.models.models.ThingsPatch(*, __root__: List[ThingsPatchItem])๏ƒ

Bases: APIBaseModel

class iots.models.models.ThingsPatchItem(*, id: Optional[str] = None, patch: Optional[List[ThingPatch]] = None)๏ƒ

Bases: APIBaseModel

id: Optional[str]๏ƒ
patch: Optional[List[ThingPatch]]๏ƒ
class iots.models.models.ThingsPatchMultiStatus(*, has_errors: Optional[List[int]] = None, results: Optional[Results] = None)๏ƒ

Bases: APIBaseModel

has_errors: Optional[List[int]]๏ƒ
results: Optional[Results]๏ƒ
class iots.models.models.Type(value)๏ƒ

Bases: Enum

An enumeration.

array = 'array'๏ƒ
boolean = 'boolean'๏ƒ
integer = 'integer'๏ƒ
null = 'null'๏ƒ
number = 'number'๏ƒ
object = 'object'๏ƒ
string = 'string'๏ƒ

iots.models.basemodel module๏ƒ

class iots.models.basemodel.APIBaseModel๏ƒ

Bases: PaginatorBaseModel

The Pydantic base model used for API schema models.

class iots.models.basemodel.HTTPResponseModel๏ƒ

Bases: BaseModel

Extends pydantic.BaseModel to allow embedding a requests.Response instance. The method http_response() returns this instance.

http_response()๏ƒ

Returns the HTTP response of this model instance.

class iots.models.basemodel.IterBaseModel๏ƒ

Bases: BaseModel

Extends pydantic.BaseModel to allow accessing attributes using dot and square-bracket notation, even when the root element is a dictionary or a list.

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny๏ƒ

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

class iots.models.basemodel.PaginatorBaseModel๏ƒ

Bases: IterBaseModel, HTTPResponseModel, Paginator

This class allows to paginate the results of an API response instance.

Module contents๏ƒ