@homeflare/distilled-unifi-network 0.2.0

package/src/services/networks.ts

@@ -0,0 +1,613 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-unifi-network/specs/openapi.json). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  UnifiNetworkProtocol,
+  type UnifiNetworkOpError,
+  type UnifiNetworkOpContext,
+} from "../protocol.ts";
+import { UnknownUnifiNetworkError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { UnifiNetworkOpError, UnifiNetworkOpContext };
+
+/** List of trusted DHCP server IP addresses. */
+export type NetworkDHCPGuardingTrustedDhcpServerIpAddressesList = Array<string>;
+export const NetworkDHCPGuardingTrustedDhcpServerIpAddressesList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<NetworkDHCPGuardingTrustedDhcpServerIpAddressesList>;
+
+/** Details about DHCP Guarding settings for this Network. */
+export interface NetworkDHCPGuarding {
+  /** List of trusted DHCP server IP addresses. */
+  trustedDhcpServerIpAddresses: NetworkDHCPGuardingTrustedDhcpServerIpAddressesList;
+}
+export const NetworkDHCPGuarding = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    trustedDhcpServerIpAddresses:
+      NetworkDHCPGuardingTrustedDhcpServerIpAddressesList,
+  }),
+).annotate({
+  identifier: "NetworkDHCPGuarding",
+}) as any as S.Schema<NetworkDHCPGuarding>;
+
+/** Additional host IP subnets assigned to this VLAN. */
+export type NetworkIPv6ConfigurationAdditionalHostIpSubnetsList = Array<string>;
+export const NetworkIPv6ConfigurationAdditionalHostIpSubnetsList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<NetworkIPv6ConfigurationAdditionalHostIpSubnetsList>;
+
+export interface IntegrationIpv6AddressSuffixRangeSelectorDto {
+  /** Start suffix of the DHCPv6 address pool. */
+  start: string;
+  /** End suffix of the DHCPv6 address pool. */
+  stop: string;
+}
+export const IntegrationIpv6AddressSuffixRangeSelectorDto =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      start: S.String,
+      stop: S.String,
+    }),
+  ).annotate({
+    identifier: "IntegrationIpv6AddressSuffixRangeSelectorDto",
+  }) as any as S.Schema<IntegrationIpv6AddressSuffixRangeSelectorDto>;
+
+export interface DHCPConfigurationForIPv6Network {
+  ipAddressSuffixRange: IntegrationIpv6AddressSuffixRangeSelectorDto;
+  /** The lease time in seconds for IP addresses in this range. */
+  leaseTimeSeconds: number;
+}
+export const DHCPConfigurationForIPv6Network = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ipAddressSuffixRange: IntegrationIpv6AddressSuffixRangeSelectorDto,
+    leaseTimeSeconds: S.Number,
+  }),
+).annotate({
+  identifier: "DHCPConfigurationForIPv6Network",
+}) as any as S.Schema<DHCPConfigurationForIPv6Network>;
+
+export interface IPv6ClientAddressAssignment {
+  /** IPv6 DHCP configuration for this network. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. If this field is null, SLAAC must be enabled. */
+  dhcpConfiguration?: DHCPConfigurationForIPv6Network;
+  /** Allows devices to obtain IPv6 addresses via SLAAC (Stateless Address Autoconfiguration) without DHCPv6. At least one addressing method must be active: either enable SLAAC or provide DHCP configuration. */
+  slaacEnabled: boolean;
+}
+export const IPv6ClientAddressAssignment = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    dhcpConfiguration: S.optional(DHCPConfigurationForIPv6Network),
+    slaacEnabled: S.Boolean,
+  }),
+).annotate({
+  identifier: "IPv6ClientAddressAssignment",
+}) as any as S.Schema<IPv6ClientAddressAssignment>;
+
+/** The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically. */
+export type NetworkIPv6ConfigurationDnsServerIpAddressesOverrideList =
+  Array<string>;
+export const NetworkIPv6ConfigurationDnsServerIpAddressesOverrideList =
+  /*@__PURE__*/ S.Array(
+    S.String,
+  ) as any as S.Schema<NetworkIPv6ConfigurationDnsServerIpAddressesOverrideList>;
+
+/** Router advertisement priority. */
+export type RouterAdvertisementConfigurationPriority =
+  | "LOW"
+  | "MEDIUM"
+  | "HIGH";
+export const RouterAdvertisementConfigurationPriority = S.String;
+
+export interface RouterAdvertisementConfiguration {
+  /** Router advertisement priority. */
+  priority: RouterAdvertisementConfigurationPriority | (string & {});
+}
+export const RouterAdvertisementConfiguration = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    priority: RouterAdvertisementConfigurationPriority,
+  }),
+).annotate({
+  identifier: "RouterAdvertisementConfiguration",
+}) as any as S.Schema<RouterAdvertisementConfiguration>;
+
+export interface NetworkIPv6Configuration {
+  /** Additional host IP subnets assigned to this VLAN. */
+  additionalHostIpSubnets?: NetworkIPv6ConfigurationAdditionalHostIpSubnetsList;
+  /** Client Address Assignment */
+  clientAddressAssignment: IPv6ClientAddressAssignment;
+  /** The IPv6 DNS server addresses assigned to this Network. If none are specified, they will be selected automatically. */
+  dnsServerIpAddressesOverride?: NetworkIPv6ConfigurationDnsServerIpAddressesOverrideList;
+  interfaceType: string;
+  /** Router advertisement. Without it, hosts will not autoconfigure addresses and will lack a default route even with DHCPv6. */
+  routerAdvertisement?: RouterAdvertisementConfiguration;
+  /** ID of the WAN interface from which the prefix is delegated. */
+  prefixDelegationWanInterfaceId?: string;
+  /** The static IPv6 address assigned to this Network. */
+  hostIpAddress?: string;
+  prefixLength?: number;
+}
+export const NetworkIPv6Configuration = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    additionalHostIpSubnets: S.optional(
+      NetworkIPv6ConfigurationAdditionalHostIpSubnetsList,
+    ),
+    clientAddressAssignment: IPv6ClientAddressAssignment,
+    dnsServerIpAddressesOverride: S.optional(
+      NetworkIPv6ConfigurationDnsServerIpAddressesOverrideList,
+    ),
+    interfaceType: S.String,
+    routerAdvertisement: S.optional(RouterAdvertisementConfiguration),
+    prefixDelegationWanInterfaceId: S.optional(S.String),
+    hostIpAddress: S.optional(S.String),
+    prefixLength: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "NetworkIPv6Configuration",
+}) as any as S.Schema<NetworkIPv6Configuration>;
+
+export interface CreateNetworkRequest {
+  siteId: string;
+  /** DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled */
+  dhcpGuarding?: NetworkDHCPGuarding;
+  enabled: boolean;
+  management: string;
+  name: string;
+  /** VLAN ID. Must be 1 for the default network and >= 2 for additional networks. */
+  vlanId: number;
+  /** Whether this network is allowed to use cellular data when WAN connection(s) are down. */
+  cellularBackupEnabled?: boolean;
+  /** Whether the internet access is allowed for the device on this network. */
+  internetAccessEnabled?: boolean;
+  /** Shape varies by variant — widened by scripts/convert.ts; see README. */
+  ipv4Configuration?: unknown;
+  /** Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network. */
+  ipv6Configuration?: NetworkIPv6Configuration;
+  /** Whether this network is isolated from all other networks. */
+  isolationEnabled?: boolean;
+  /** Whether this network should participate in mDNS traffic forwarding. If null, the default from the site mDNS setting is used. */
+  mdnsForwardingEnabled?: boolean;
+  /** Firewall zone ID associated with this Network. */
+  zoneId?: string;
+  /** ID of the L3 switching capable device that manages this network. */
+  deviceId?: string;
+}
+export const CreateNetworkRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    dhcpGuarding: S.optional(NetworkDHCPGuarding),
+    enabled: S.Boolean,
+    management: S.String,
+    name: S.String,
+    vlanId: S.Number,
+    cellularBackupEnabled: S.optional(S.Boolean),
+    internetAccessEnabled: S.optional(S.Boolean),
+    ipv4Configuration: S.optional(S.Unknown),
+    ipv6Configuration: S.optional(NetworkIPv6Configuration),
+    isolationEnabled: S.optional(S.Boolean),
+    mdnsForwardingEnabled: S.optional(S.Boolean),
+    zoneId: S.optional(S.String),
+    deviceId: S.optional(S.String),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/v1/sites/{siteId}/networks", code: 200 }),
+  ),
+).annotate({
+  identifier: "CreateNetworkRequest",
+}) as any as S.Schema<CreateNetworkRequest>;
+
+export type UserOrSystemDefinedOrOrchestratedEntityMetadataSource = "SDWAN";
+export const UserOrSystemDefinedOrOrchestratedEntityMetadataSource = S.String;
+
+export interface UserOrSystemDefinedOrOrchestratedEntityMetadata {
+  origin: string;
+  source?: UserOrSystemDefinedOrOrchestratedEntityMetadataSource;
+}
+export const UserOrSystemDefinedOrOrchestratedEntityMetadata =
+  /*@__PURE__*/ S.suspend(() =>
+    S.Struct({
+      origin: S.String,
+      source: S.optional(UserOrSystemDefinedOrOrchestratedEntityMetadataSource),
+    }),
+  ).annotate({
+    identifier: "UserOrSystemDefinedOrOrchestratedEntityMetadata",
+  }) as any as S.Schema<UserOrSystemDefinedOrOrchestratedEntityMetadata>;
+
+export interface NetworkDetails {
+  default: boolean;
+  /** DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled */
+  dhcpGuarding?: NetworkDHCPGuarding;
+  enabled: boolean;
+  id: string;
+  management: string;
+  /** Orchestrated or System-defined configurable network support */
+  metadata: UserOrSystemDefinedOrOrchestratedEntityMetadata;
+  name: string;
+  /** VLAN ID. Must be 1 for the default network and >= 2 for additional networks. */
+  vlanId: number;
+  /** Whether this network is allowed to use cellular data when WAN connection(s) are down. */
+  cellularBackupEnabled?: boolean;
+  /** Whether the internet access is allowed for the device on this network. */
+  internetAccessEnabled?: boolean;
+  /** Shape varies by variant — widened by scripts/convert.ts; see README. */
+  ipv4Configuration?: unknown;
+  /** Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network. */
+  ipv6Configuration?: NetworkIPv6Configuration;
+  /** Whether this network is isolated from all other networks. */
+  isolationEnabled?: boolean;
+  /** Whether this network should participate in mDNS traffic forwarding. */
+  mdnsForwardingEnabled?: boolean;
+  /** Firewall zone ID associated with this Network. */
+  zoneId?: string;
+  /** ID of the L3 switching capable device that manages this network. */
+  deviceId?: string;
+}
+export const NetworkDetails = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    default: S.Boolean,
+    dhcpGuarding: S.optional(NetworkDHCPGuarding),
+    enabled: S.Boolean,
+    id: S.String,
+    management: S.String,
+    metadata: UserOrSystemDefinedOrOrchestratedEntityMetadata,
+    name: S.String,
+    vlanId: S.Number,
+    cellularBackupEnabled: S.optional(S.Boolean),
+    internetAccessEnabled: S.optional(S.Boolean),
+    ipv4Configuration: S.optional(S.Unknown),
+    ipv6Configuration: S.optional(NetworkIPv6Configuration),
+    isolationEnabled: S.optional(S.Boolean),
+    mdnsForwardingEnabled: S.optional(S.Boolean),
+    zoneId: S.optional(S.String),
+    deviceId: S.optional(S.String),
+  }),
+).annotate({ identifier: "NetworkDetails" }) as any as S.Schema<NetworkDetails>;
+
+export interface DeleteNetworkRequest {
+  siteId: string;
+  networkId: string;
+  force?: boolean;
+}
+export const DeleteNetworkRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    networkId: S.String.pipe(T.Label()),
+    force: S.optional(S.Boolean.pipe(T.Query())),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v1/sites/{siteId}/networks/{networkId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DeleteNetworkRequest",
+}) as any as S.Schema<DeleteNetworkRequest>;
+
+export interface DeleteNetworkResponse {}
+export const DeleteNetworkResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}),
+).annotate({
+  identifier: "DeleteNetworkResponse",
+}) as any as S.Schema<DeleteNetworkResponse>;
+
+export interface GetNetworkDetailsRequest {
+  siteId: string;
+  networkId: string;
+}
+export const GetNetworkDetailsRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    networkId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/networks/{networkId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetNetworkDetailsRequest",
+}) as any as S.Schema<GetNetworkDetailsRequest>;
+
+export interface GetNetworkReferencesRequest {
+  siteId: string;
+  networkId: string;
+}
+export const GetNetworkReferencesRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    networkId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/networks/{networkId}/references",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetNetworkReferencesRequest",
+}) as any as S.Schema<GetNetworkReferencesRequest>;
+
+export interface NetworkReferenceDetail {
+  referenceId: string;
+}
+export const NetworkReferenceDetail = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    referenceId: S.String,
+  }),
+).annotate({
+  identifier: "NetworkReferenceDetail",
+}) as any as S.Schema<NetworkReferenceDetail>;
+
+/** List of references, present only if resourceType has API model defined */
+export type NetworkReferenceResourceReferencesList =
+  Array<NetworkReferenceDetail>;
+export const NetworkReferenceResourceReferencesList = /*@__PURE__*/ S.Array(
+  NetworkReferenceDetail,
+) as any as S.Schema<NetworkReferenceResourceReferencesList>;
+
+export type NetworkReferenceResourceResourceType =
+  | "CLIENT"
+  | "DEVICE"
+  | "STATIC_ROUTE"
+  | "OSPF_ROUTE"
+  | "NEXT_AI"
+  | "WIFI"
+  | "NAT_RULE"
+  | "SD_WAN";
+export const NetworkReferenceResourceResourceType = S.String;
+
+export interface NetworkReferenceResource {
+  /** Number of references of this type */
+  referenceCount: number;
+  /** List of references, present only if resourceType has API model defined */
+  references?: NetworkReferenceResourceReferencesList;
+  resourceType: NetworkReferenceResourceResourceType;
+}
+export const NetworkReferenceResource = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    referenceCount: S.Number,
+    references: S.optional(NetworkReferenceResourceReferencesList),
+    resourceType: NetworkReferenceResourceResourceType,
+  }),
+).annotate({
+  identifier: "NetworkReferenceResource",
+}) as any as S.Schema<NetworkReferenceResource>;
+
+/** List of network reference resources */
+export type NetworkReferencesReferenceResourcesList =
+  Array<NetworkReferenceResource>;
+export const NetworkReferencesReferenceResourcesList = /*@__PURE__*/ S.Array(
+  NetworkReferenceResource,
+) as any as S.Schema<NetworkReferencesReferenceResourcesList>;
+
+export interface NetworkReferences {
+  /** List of network reference resources */
+  referenceResources: NetworkReferencesReferenceResourcesList;
+}
+export const NetworkReferences = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    referenceResources: NetworkReferencesReferenceResourcesList,
+  }),
+).annotate({
+  identifier: "NetworkReferences",
+}) as any as S.Schema<NetworkReferences>;
+
+export interface GetNetworksOverviewPageRequest {
+  siteId: string;
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetNetworksOverviewPageRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    offset: S.optional(S.Number.pipe(T.Query())),
+    limit: S.optional(S.Number.pipe(T.Query())),
+    filter: S.optional(S.String.pipe(T.Query())),
+  }).pipe(
+    T.Http({ method: "GET", uri: "/v1/sites/{siteId}/networks", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetNetworksOverviewPageRequest",
+}) as any as S.Schema<GetNetworksOverviewPageRequest>;
+
+export interface NetworkOverview {
+  default: boolean;
+  enabled: boolean;
+  id: string;
+  management: string;
+  /** Orchestrated or System-defined configurable network support */
+  metadata: UserOrSystemDefinedOrOrchestratedEntityMetadata;
+  name: string;
+  /** VLAN ID. Must be 1 for the default network and >= 2 for additional networks. */
+  vlanId: number;
+  zoneId?: string;
+  /** ID of the switch this Network is managed by. */
+  deviceId?: string;
+}
+export const NetworkOverview = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    default: S.Boolean,
+    enabled: S.Boolean,
+    id: S.String,
+    management: S.String,
+    metadata: UserOrSystemDefinedOrOrchestratedEntityMetadata,
+    name: S.String,
+    vlanId: S.Number,
+    zoneId: S.optional(S.String),
+    deviceId: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "NetworkOverview",
+}) as any as S.Schema<NetworkOverview>;
+
+export type NetworkOverviewPageDataList = Array<NetworkOverview>;
+export const NetworkOverviewPageDataList = /*@__PURE__*/ S.Array(
+  NetworkOverview,
+) as any as S.Schema<NetworkOverviewPageDataList>;
+
+export interface NetworkOverviewPage {
+  count: number;
+  data: NetworkOverviewPageDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const NetworkOverviewPage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: NetworkOverviewPageDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "NetworkOverviewPage",
+}) as any as S.Schema<NetworkOverviewPage>;
+
+export interface UpdateNetworkRequest {
+  siteId: string;
+  networkId: string;
+  /** DHCP Guarding settings for this Network. If this field is omitted or null, the feature is disabled */
+  dhcpGuarding?: NetworkDHCPGuarding;
+  enabled: boolean;
+  management: string;
+  name: string;
+  /** VLAN ID. Must be 1 for the default network and >= 2 for additional networks. */
+  vlanId: number;
+  /** Whether this network is allowed to use cellular data when WAN connection(s) are down. */
+  cellularBackupEnabled?: boolean;
+  /** Whether the internet access is allowed for the device on this network. */
+  internetAccessEnabled?: boolean;
+  /** Shape varies by variant — widened by scripts/convert.ts; see README. */
+  ipv4Configuration?: unknown;
+  /** Details about IPv6 configuration for this Network. If this field is omitted or null then IPv6 is not configured on this Network. */
+  ipv6Configuration?: NetworkIPv6Configuration;
+  /** Whether this network is isolated from all other networks. */
+  isolationEnabled?: boolean;
+  /** Whether this network should participate in mDNS traffic forwarding. If null, the default from the site mDNS setting is used. */
+  mdnsForwardingEnabled?: boolean;
+  /** Firewall zone ID associated with this Network. */
+  zoneId?: string;
+  /** ID of the L3 switching capable device that manages this network. */
+  deviceId?: string;
+}
+export const UpdateNetworkRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    networkId: S.String.pipe(T.Label()),
+    dhcpGuarding: S.optional(NetworkDHCPGuarding),
+    enabled: S.Boolean,
+    management: S.String,
+    name: S.String,
+    vlanId: S.Number,
+    cellularBackupEnabled: S.optional(S.Boolean),
+    internetAccessEnabled: S.optional(S.Boolean),
+    ipv4Configuration: S.optional(S.Unknown),
+    ipv6Configuration: S.optional(NetworkIPv6Configuration),
+    isolationEnabled: S.optional(S.Boolean),
+    mdnsForwardingEnabled: S.optional(S.Boolean),
+    zoneId: S.optional(S.String),
+    deviceId: S.optional(S.String),
+  }).pipe(
+    T.Http({
+      method: "PUT",
+      uri: "/v1/sites/{siteId}/networks/{networkId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "UpdateNetworkRequest",
+}) as any as S.Schema<UpdateNetworkRequest>;
+
+export type CreateNetworkError = UnifiNetworkOpError;
+/** Create Network Create a new network on a site. */
+export const createNetwork: API.OperationMethod<
+  CreateNetworkRequest,
+  NetworkDetails,
+  CreateNetworkError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateNetworkRequest,
+  output: NetworkDetails,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeleteNetworkError = UnifiNetworkOpError;
+/** Delete Network Delete an existing network on a site. */
+export const deleteNetwork: API.OperationMethod<
+  DeleteNetworkRequest,
+  DeleteNetworkResponse,
+  DeleteNetworkError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteNetworkRequest,
+  output: DeleteNetworkResponse,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetNetworkDetailsError = UnifiNetworkOpError;
+/** Get Network Details Retrieve detailed information about a specific network. */
+export const getNetworkDetails: API.OperationMethod<
+  GetNetworkDetailsRequest,
+  NetworkDetails,
+  GetNetworkDetailsError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetNetworkDetailsRequest,
+  output: NetworkDetails,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetNetworkReferencesError = UnifiNetworkOpError;
+/** Get Network References Retrieve references to a specific network. */
+export const getNetworkReferences: API.OperationMethod<
+  GetNetworkReferencesRequest,
+  NetworkReferences,
+  GetNetworkReferencesError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetNetworkReferencesRequest,
+  output: NetworkReferences,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetNetworksOverviewPageError = UnifiNetworkOpError;
+/** List Networks Retrieve a paginated list of all Networks on a site. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getNetworksOverviewPage: API.OperationMethod<
+  GetNetworksOverviewPageRequest,
+  NetworkOverviewPage,
+  GetNetworksOverviewPageError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetNetworksOverviewPageRequest,
+  output: NetworkOverviewPage,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type UpdateNetworkError = UnifiNetworkOpError;
+/** Update Network Update an existing network on a site. */
+export const updateNetwork: API.OperationMethod<
+  UpdateNetworkRequest,
+  NetworkDetails,
+  UpdateNetworkError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: UpdateNetworkRequest,
+  output: NetworkDetails,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/sites.ts

@@ -0,0 +1,81 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-unifi-network/specs/openapi.json). Do not edit.
+import * as S from "@distilled.cloud/core/schema";
+import * as API from "@distilled.cloud/core/api";
+import * as T from "../traits.ts";
+import {
+  UnifiNetworkProtocol,
+  type UnifiNetworkOpError,
+  type UnifiNetworkOpContext,
+} from "../protocol.ts";
+import { UnknownUnifiNetworkError } from "../errors.ts";
+import * as Retry from "../retry.ts";
+
+export type { UnifiNetworkOpError, UnifiNetworkOpContext };
+
+export interface GetSiteOverviewPageRequest {
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetSiteOverviewPageRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    offset: S.optional(S.Number.pipe(T.Query())),
+    limit: S.optional(S.Number.pipe(T.Query())),
+    filter: S.optional(S.String.pipe(T.Query())),
+  }).pipe(T.Http({ method: "GET", uri: "/v1/sites", code: 200 })),
+).annotate({
+  identifier: "GetSiteOverviewPageRequest",
+}) as any as S.Schema<GetSiteOverviewPageRequest>;
+
+export interface SiteOverview {
+  id: string;
+  /** Internal unique name of the site used in older APIs */
+  internalReference: string;
+  name: string;
+}
+export const SiteOverview = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    internalReference: S.String,
+    name: S.String,
+  }),
+).annotate({ identifier: "SiteOverview" }) as any as S.Schema<SiteOverview>;
+
+export type SiteOverviewPageDataList = Array<SiteOverview>;
+export const SiteOverviewPageDataList = /*@__PURE__*/ S.Array(
+  SiteOverview,
+) as any as S.Schema<SiteOverviewPageDataList>;
+
+export interface SiteOverviewPage {
+  count: number;
+  data: SiteOverviewPageDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const SiteOverviewPage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: SiteOverviewPageDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "SiteOverviewPage",
+}) as any as S.Schema<SiteOverviewPage>;
+
+export type GetSiteOverviewPageError = UnifiNetworkOpError;
+/** List Local Sites Retrieve a paginated list of local sites managed by this Network application. Site ID is required for other UniFi Network API calls. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getSiteOverviewPage: API.OperationMethod<
+  GetSiteOverviewPageRequest,
+  SiteOverviewPage,
+  GetSiteOverviewPageError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetSiteOverviewPageRequest,
+  output: SiteOverviewPage,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));