emnify.modules.device.models¶

Classes¶

`SimDevice`
`Device`	Renamed generated model
`CreateDevice`	Custom class for validation of Device on creation
`SmsCreateModel`	Inherited generated model of SubmitMTSMSrequest for extra fields
`ListSms`	Renamed generated model
`TariffProfile`	Renamed generated model
`ServiceProfile`	Renamed generated model
`DeviceStatus`	Renamed generated model
`DeviceIdRequired`	Changed renamed model of Device for id validation
`FilterDeviceModel`	Model for validation of filter query params
`ListQFilterDeviceListModel`
`GetDeviceFilterSet`	Model for device list query params
`DeviceEvent`	class inherited from generated Event
`RetrieveDevice`	class inherited from generated model for retrieve device response
`UpdateDevice`	Model for update Device request with field-type validation
`DeviceConnectivityStatus`	Device connectivity status can be 'ATTACHED'/'ONLINE'/'OFFLINE'/'BLOCKED'

Module Contents¶

class emnify.modules.device.models.SimDevice¶

Bases: pydantic.BaseModel

id: int¶

status: emnify.modules.api.models.Status | None = None¶

class emnify.modules.device.models.Device¶

Bases: emnify.modules.api.models.Endpoint

Renamed generated model

status: emnify.modules.api.models.Status¶

sim: SimDevice | None = None¶

class emnify.modules.device.models.CreateDevice¶

Bases: Device

Custom class for validation of Device on creation

classmethod validate_status(field_value, values, field, config)¶

class emnify.modules.device.models.SmsCreateModel¶

Bases: emnify.modules.api.models.SubmitMTSMSrequest

Inherited generated model of SubmitMTSMSrequest for extra fields

source_address: str | None = None¶

source_address_type: Dict[str, Any] | None = None¶

expiry_date: str | None = None¶

udh: str | None = None¶

dcs: int | None = None¶

class emnify.modules.device.models.ListSms¶

Bases: emnify.modules.api.models.ListofSMSresponse

Renamed generated model

class emnify.modules.device.models.TariffProfile¶

Bases: emnify.modules.api.models.TariffProfile1

Renamed generated model

class emnify.modules.device.models.ServiceProfile¶

Bases: emnify.modules.api.models.ServiceProfile1

Renamed generated model

class emnify.modules.device.models.DeviceStatus¶

Bases: emnify.modules.api.models.Status

Renamed generated model

class emnify.modules.device.models.DeviceIdRequired¶

Bases: Device

Changed renamed model of Device for id validation

id: int¶

class emnify.modules.device.models.FilterDeviceModel¶

Bases: pydantic.BaseModel

Model for validation of filter query params

status: int | None = None¶

last_updated: datetime.datetime | None = None¶

created: datetime.datetime | None = None¶

name: str | None = None¶

tags: str | None = None¶

ip_address: str | None = None¶

imei: int | None = None¶

sim_status: int | None = None¶

class emnify.modules.device.models.ListQFilterDeviceListModel¶

Bases: pydantic.BaseModel

__root__: List[FilterDeviceModel]¶

class emnify.modules.device.models.GetDeviceFilterSet¶

Bases: pydantic.BaseModel

Model for device list query params

sort: emnify.constants.DeviceSort | None = None¶

q: ListQFilterDeviceListModel | None = None¶

class Config¶

use_enum_values = True¶

class emnify.modules.device.models.DeviceEvent¶

Bases: emnify.modules.api.models.Event

class inherited from generated Event

class emnify.modules.device.models.RetrieveDevice¶

Bases: Device

class inherited from generated model for retrieve device response

runtime_data: Dict[str, Any] | None = None¶

sim: emnify.modules.sim.models.SimList = None¶

class emnify.modules.device.models.UpdateDevice¶

Bases: emnify.modules.api.models.UpdateEndpointrequest

Model for update Device request with field-type validation

name: str = None¶

tags: str = None¶

status: emnify.modules.api.models.Status = None¶

service_profile: emnify.modules.api.models.ServiceProfile1 = None¶

tariff_profile: Dict[str, Any] = None¶

ip_address: str = None¶

ip_address_space: Dict[str, Any] = None¶

sim: Dict[str, Any] = None¶

imei: str = None¶

imei_lock: bool = None¶

class emnify.modules.device.models.DeviceConnectivityStatus¶

Bases: pydantic.BaseModel

Device connectivity status can be ‘ATTACHED’/’ONLINE’/’OFFLINE’/’BLOCKED’

status: emnify.modules.api.models.Status = None¶

location: Dict[str, Any] = None¶

services: Any = None¶