@homeflare/distilled-unifi-network 0.2.0

package/src/services/switching.ts

@@ -0,0 +1,496 @@
+// 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 GetLagRequest {
+  siteId: string;
+  lagId: string;
+}
+export const GetLagRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    lagId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/switching/lags/{lagId}",
+      code: 200,
+    }),
+  ),
+).annotate({ identifier: "GetLagRequest" }) as any as S.Schema<GetLagRequest>;
+
+export type IntegrationLagMemberDtoPortIdxsList = Array<number>;
+export const IntegrationLagMemberDtoPortIdxsList = /*@__PURE__*/ S.Array(
+  S.Number,
+) as any as S.Schema<IntegrationLagMemberDtoPortIdxsList>;
+
+export interface IntegrationLagMemberDto {
+  deviceId: string;
+  portIdxs: IntegrationLagMemberDtoPortIdxsList;
+}
+export const IntegrationLagMemberDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    deviceId: S.String,
+    portIdxs: IntegrationLagMemberDtoPortIdxsList,
+  }),
+).annotate({
+  identifier: "IntegrationLagMemberDto",
+}) as any as S.Schema<IntegrationLagMemberDto>;
+
+export type LAGDetailsMembersList = Array<IntegrationLagMemberDto>;
+export const LAGDetailsMembersList = /*@__PURE__*/ S.Array(
+  IntegrationLagMemberDto,
+) as any as S.Schema<LAGDetailsMembersList>;
+
+export type UserDefinedEntityMetadataSource = "SDWAN";
+export const UserDefinedEntityMetadataSource = S.String;
+
+export interface UserDefinedEntityMetadata {
+  origin: string;
+  source?: UserDefinedEntityMetadataSource;
+}
+export const UserDefinedEntityMetadata = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    origin: S.String,
+    source: S.optional(UserDefinedEntityMetadataSource),
+  }),
+).annotate({
+  identifier: "UserDefinedEntityMetadata",
+}) as any as S.Schema<UserDefinedEntityMetadata>;
+
+export interface LAGDetails {
+  id: string;
+  members: LAGDetailsMembersList;
+  metadata: UserDefinedEntityMetadata;
+  type: string;
+  mcLagDomainId?: string;
+  switchStackId?: string;
+}
+export const LAGDetails = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    members: LAGDetailsMembersList,
+    metadata: UserDefinedEntityMetadata,
+    type: S.String,
+    mcLagDomainId: S.optional(S.String),
+    switchStackId: S.optional(S.String),
+  }),
+).annotate({ identifier: "LAGDetails" }) as any as S.Schema<LAGDetails>;
+
+export interface GetLagPageRequest {
+  siteId: string;
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetLagPageRequest = /*@__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}/switching/lags",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetLagPageRequest",
+}) as any as S.Schema<GetLagPageRequest>;
+
+export type IntegrationLagPageDtoDataList = Array<LAGDetails>;
+export const IntegrationLagPageDtoDataList = /*@__PURE__*/ S.Array(
+  LAGDetails,
+) as any as S.Schema<IntegrationLagPageDtoDataList>;
+
+export interface IntegrationLagPageDto {
+  count: number;
+  data: IntegrationLagPageDtoDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const IntegrationLagPageDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: IntegrationLagPageDtoDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "IntegrationLagPageDto",
+}) as any as S.Schema<IntegrationLagPageDto>;
+
+export interface GetMcLagDomainRequest {
+  siteId: string;
+  mcLagDomainId: string;
+}
+export const GetMcLagDomainRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    mcLagDomainId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/switching/mc-lag-domains/{mcLagDomainId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetMcLagDomainRequest",
+}) as any as S.Schema<GetMcLagDomainRequest>;
+
+export type IntegrationMcLagLocalDtoMembersList =
+  Array<IntegrationLagMemberDto>;
+export const IntegrationMcLagLocalDtoMembersList = /*@__PURE__*/ S.Array(
+  IntegrationLagMemberDto,
+) as any as S.Schema<IntegrationMcLagLocalDtoMembersList>;
+
+export interface IntegrationMcLagLocalDto {
+  id: string;
+  members: IntegrationMcLagLocalDtoMembersList;
+  metadata: UserDefinedEntityMetadata;
+}
+export const IntegrationMcLagLocalDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    members: IntegrationMcLagLocalDtoMembersList,
+    metadata: UserDefinedEntityMetadata,
+  }),
+).annotate({
+  identifier: "IntegrationMcLagLocalDto",
+}) as any as S.Schema<IntegrationMcLagLocalDto>;
+
+export type IntegrationMcLagDomainDtoLagsList = Array<IntegrationMcLagLocalDto>;
+export const IntegrationMcLagDomainDtoLagsList = /*@__PURE__*/ S.Array(
+  IntegrationMcLagLocalDto,
+) as any as S.Schema<IntegrationMcLagDomainDtoLagsList>;
+
+export type IntegrationMcLagPeerDtoLinkPortIdxsList = Array<number>;
+export const IntegrationMcLagPeerDtoLinkPortIdxsList = /*@__PURE__*/ S.Array(
+  S.Number,
+) as any as S.Schema<IntegrationMcLagPeerDtoLinkPortIdxsList>;
+
+export type IntegrationMcLagPeerDtoRole = "TOP" | "BOTTOM";
+export const IntegrationMcLagPeerDtoRole = S.String;
+
+export interface IntegrationMcLagPeerDto {
+  deviceId: string;
+  linkPortIdxs: IntegrationMcLagPeerDtoLinkPortIdxsList;
+  role: IntegrationMcLagPeerDtoRole;
+}
+export const IntegrationMcLagPeerDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    deviceId: S.String,
+    linkPortIdxs: IntegrationMcLagPeerDtoLinkPortIdxsList,
+    role: IntegrationMcLagPeerDtoRole,
+  }),
+).annotate({
+  identifier: "IntegrationMcLagPeerDto",
+}) as any as S.Schema<IntegrationMcLagPeerDto>;
+
+export type IntegrationMcLagDomainDtoPeersList = Array<IntegrationMcLagPeerDto>;
+export const IntegrationMcLagDomainDtoPeersList = /*@__PURE__*/ S.Array(
+  IntegrationMcLagPeerDto,
+) as any as S.Schema<IntegrationMcLagDomainDtoPeersList>;
+
+export interface IntegrationMcLagDomainDto {
+  id: string;
+  lags: IntegrationMcLagDomainDtoLagsList;
+  metadata: UserDefinedEntityMetadata;
+  name: string;
+  peers: IntegrationMcLagDomainDtoPeersList;
+}
+export const IntegrationMcLagDomainDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    lags: IntegrationMcLagDomainDtoLagsList,
+    metadata: UserDefinedEntityMetadata,
+    name: S.String,
+    peers: IntegrationMcLagDomainDtoPeersList,
+  }),
+).annotate({
+  identifier: "IntegrationMcLagDomainDto",
+}) as any as S.Schema<IntegrationMcLagDomainDto>;
+
+export interface GetMcLagDomainPageRequest {
+  siteId: string;
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetMcLagDomainPageRequest = /*@__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}/switching/mc-lag-domains",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetMcLagDomainPageRequest",
+}) as any as S.Schema<GetMcLagDomainPageRequest>;
+
+export type IntegrationMcLagDomainDtoPageDtoDataList =
+  Array<IntegrationMcLagDomainDto>;
+export const IntegrationMcLagDomainDtoPageDtoDataList = /*@__PURE__*/ S.Array(
+  IntegrationMcLagDomainDto,
+) as any as S.Schema<IntegrationMcLagDomainDtoPageDtoDataList>;
+
+export interface IntegrationMcLagDomainDtoPageDto {
+  count: number;
+  data: IntegrationMcLagDomainDtoPageDtoDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const IntegrationMcLagDomainDtoPageDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: IntegrationMcLagDomainDtoPageDtoDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "IntegrationMcLagDomainDtoPageDto",
+}) as any as S.Schema<IntegrationMcLagDomainDtoPageDto>;
+
+export interface GetSwitchStackRequest {
+  siteId: string;
+  switchStackId: string;
+}
+export const GetSwitchStackRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    switchStackId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/switching/switch-stacks/{switchStackId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetSwitchStackRequest",
+}) as any as S.Schema<GetSwitchStackRequest>;
+
+export type IntegrationSwitchStackLagLocalDtoMembersList =
+  Array<IntegrationLagMemberDto>;
+export const IntegrationSwitchStackLagLocalDtoMembersList =
+  /*@__PURE__*/ S.Array(
+    IntegrationLagMemberDto,
+  ) as any as S.Schema<IntegrationSwitchStackLagLocalDtoMembersList>;
+
+export interface IntegrationSwitchStackLagLocalDto {
+  id: string;
+  members: IntegrationSwitchStackLagLocalDtoMembersList;
+  metadata: UserDefinedEntityMetadata;
+}
+export const IntegrationSwitchStackLagLocalDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    members: IntegrationSwitchStackLagLocalDtoMembersList,
+    metadata: UserDefinedEntityMetadata,
+  }),
+).annotate({
+  identifier: "IntegrationSwitchStackLagLocalDto",
+}) as any as S.Schema<IntegrationSwitchStackLagLocalDto>;
+
+export type IntegrationSwitchStackDtoLagsList =
+  Array<IntegrationSwitchStackLagLocalDto>;
+export const IntegrationSwitchStackDtoLagsList = /*@__PURE__*/ S.Array(
+  IntegrationSwitchStackLagLocalDto,
+) as any as S.Schema<IntegrationSwitchStackDtoLagsList>;
+
+export interface IntegrationSwitchStackMemberDto {
+  deviceId: string;
+}
+export const IntegrationSwitchStackMemberDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    deviceId: S.String,
+  }),
+).annotate({
+  identifier: "IntegrationSwitchStackMemberDto",
+}) as any as S.Schema<IntegrationSwitchStackMemberDto>;
+
+export type IntegrationSwitchStackDtoMembersList =
+  Array<IntegrationSwitchStackMemberDto>;
+export const IntegrationSwitchStackDtoMembersList = /*@__PURE__*/ S.Array(
+  IntegrationSwitchStackMemberDto,
+) as any as S.Schema<IntegrationSwitchStackDtoMembersList>;
+
+export interface IntegrationSwitchStackDto {
+  id: string;
+  lags: IntegrationSwitchStackDtoLagsList;
+  members: IntegrationSwitchStackDtoMembersList;
+  metadata: UserDefinedEntityMetadata;
+  name: string;
+}
+export const IntegrationSwitchStackDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    id: S.String,
+    lags: IntegrationSwitchStackDtoLagsList,
+    members: IntegrationSwitchStackDtoMembersList,
+    metadata: UserDefinedEntityMetadata,
+    name: S.String,
+  }),
+).annotate({
+  identifier: "IntegrationSwitchStackDto",
+}) as any as S.Schema<IntegrationSwitchStackDto>;
+
+export interface GetSwitchStackPageRequest {
+  siteId: string;
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetSwitchStackPageRequest = /*@__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}/switching/switch-stacks",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetSwitchStackPageRequest",
+}) as any as S.Schema<GetSwitchStackPageRequest>;
+
+export type IntegrationSwitchStackDtoPageDtoDataList =
+  Array<IntegrationSwitchStackDto>;
+export const IntegrationSwitchStackDtoPageDtoDataList = /*@__PURE__*/ S.Array(
+  IntegrationSwitchStackDto,
+) as any as S.Schema<IntegrationSwitchStackDtoPageDtoDataList>;
+
+export interface IntegrationSwitchStackDtoPageDto {
+  count: number;
+  data: IntegrationSwitchStackDtoPageDtoDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const IntegrationSwitchStackDtoPageDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: IntegrationSwitchStackDtoPageDtoDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "IntegrationSwitchStackDtoPageDto",
+}) as any as S.Schema<IntegrationSwitchStackDtoPageDto>;
+
+export type GetLagError = UnifiNetworkOpError;
+/** Get LAG Details Retrieve LAG details. */
+export const getLag: API.OperationMethod<
+  GetLagRequest,
+  LAGDetails,
+  GetLagError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetLagRequest,
+  output: LAGDetails,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetLagPageError = UnifiNetworkOpError;
+/** List LAGs Retrieve a paginated list of all LAGs (Link Aggregation Groups) on a site. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getLagPage: API.OperationMethod<
+  GetLagPageRequest,
+  IntegrationLagPageDto,
+  GetLagPageError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetLagPageRequest,
+  output: IntegrationLagPageDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetMcLagDomainError = UnifiNetworkOpError;
+/** Get MC-LAG Domain Retrieve MC-LAG Domain details. */
+export const getMcLagDomain: API.OperationMethod<
+  GetMcLagDomainRequest,
+  IntegrationMcLagDomainDto,
+  GetMcLagDomainError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetMcLagDomainRequest,
+  output: IntegrationMcLagDomainDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetMcLagDomainPageError = UnifiNetworkOpError;
+/** List MC-LAG Domains Retrieve a paginated list of all MC-LAG Domains on a site. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getMcLagDomainPage: API.OperationMethod<
+  GetMcLagDomainPageRequest,
+  IntegrationMcLagDomainDtoPageDto,
+  GetMcLagDomainPageError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetMcLagDomainPageRequest,
+  output: IntegrationMcLagDomainDtoPageDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetSwitchStackError = UnifiNetworkOpError;
+/** Get Switch Stack Retrieve Switch Stack details. */
+export const getSwitchStack: API.OperationMethod<
+  GetSwitchStackRequest,
+  IntegrationSwitchStackDto,
+  GetSwitchStackError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetSwitchStackRequest,
+  output: IntegrationSwitchStackDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetSwitchStackPageError = UnifiNetworkOpError;
+/** List Switch Stacks Retrieve a paginated list of all Switch Stacks on a site. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getSwitchStackPage: API.OperationMethod<
+  GetSwitchStackPageRequest,
+  IntegrationSwitchStackDtoPageDto,
+  GetSwitchStackPageError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetSwitchStackPageRequest,
+  output: IntegrationSwitchStackDtoPageDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));