Skip to content

AdminSettings.md

Latest commit

 

History

History
36 lines (22 loc) · 2 KB

AdminSettings.md

File metadata and controls

36 lines (22 loc) · 2 KB

AdminSettings

tb_ce_client.models.AdminSettings

A JSON value representing the Mail Settings.

Properties

Name Type Description Notes
id AdminSettingsId The Id of the Administration Settings, auto-generated, UUID [optional]
created_time int Timestamp of the settings creation, in milliseconds [optional] [readonly]
tenant_id TenantId JSON object with Tenant Id. [optional] [readonly]
key str The Administration Settings key, (e.g. 'general' or 'mail') [optional]
json_value object JSON representation of the Administration Settings value [optional]

Referenced Types

EntityId types (AdminSettingsId, AiModelId, AlarmId, ApiKeyId, ApiUsageStateId, AssetId, AssetProfileId, CalculatedFieldId, CustomerId, DashboardId, DeviceId, DeviceProfileId, DomainId, EdgeId, EntityViewId, JobId, MobileAppBundleId, MobileAppId, NotificationId, NotificationRequestId, NotificationRuleId, NotificationTargetId, NotificationTemplateId, OAuth2ClientId, OtaPackageId, QueueId, QueueStatsId, RpcId, RuleChainId, RuleNodeId, TbResourceId, TenantId, TenantProfileId, UserId, WidgetTypeId, WidgetsBundleId, etc.): {entity_type: EntityType, id: UUID} — all EntityId subtypes share this structure.

EntityType (enum)

TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | RULE_CHAIN | RULE_NODE | ENTITY_VIEW | … (36 values total)

Conventions

  • Package: tb_ce_client.models
  • Attribute access: obj.id, obj.name, etc.
  • Serialize: obj.model_dump() or obj.model_dump(by_alias=True) for camelCase JSON
  • Deserialize: AdminSettings.model_validate(data) or AdminSettings.model_validate_json(json_str)
  • None fields: Optional attributes default to None; accessing them never raises exceptions