Class Setup

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

The complete home setup as returned by the setup endpoint. Contains all gateways, devices, zones, places and location metadata.

public sealed class Setup

Inheritance

object

Setup

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

CreationTime

Unix epoch millisecond timestamp when the setup was created.

[JsonPropertyName("creationTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
public long CreationTime { get; init; }

Property Value

long

Devices

All devices registered across all gateways in this setup.

[JsonPropertyName("devices")]
public IReadOnlyList<Device> Devices { get; init; }

Property Value

IReadOnlyList<Device>

Features

Feature flags / subscriptions active on this setup.

[JsonPropertyName("features")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<Feature>? Features { get; init; }

Property Value

IReadOnlyList<Feature>

Gateways

All gateways (hubs) registered in this setup.

[JsonPropertyName("gateways")]
public IReadOnlyList<Gateway> Gateways { get; init; }

Property Value

IReadOnlyList<Gateway>

Id

Unique identifier of the setup.

[JsonPropertyName("id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Id { get; init; }

Property Value

string

LastUpdateTime

Unix epoch millisecond timestamp of the most recent change, or null if unchanged.

[JsonPropertyName("lastUpdateTime")]
[JsonNumberHandling(JsonNumberHandling.AllowReadingFromString)]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public long? LastUpdateTime { get; init; }

Property Value

long?

Location

Geographical location and twilight settings for the home.

[JsonPropertyName("location")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Location? Location { get; init; }

Property Value

Location

Oid

Opaque OID of the setup.

[JsonPropertyName("oid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Oid { get; init; }

Property Value

string

ResellerDelegationType

Reseller delegation type string, or null if not applicable.

[JsonPropertyName("resellerDelegationType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ResellerDelegationType { get; init; }

Property Value

string

RootPlace

Root of the place hierarchy (house → floors → rooms).

[JsonPropertyName("rootPlace")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Place? RootPlace { get; init; }

Property Value

Place

Zones

Logical zones grouping devices, or null if the server does not return zones.

[JsonPropertyName("zones")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<Zone>? Zones { get; init; }

Property Value

IReadOnlyList<Zone>