@homeflare/distilled-unifi-network 0.2.0

package/src/services/hotspot.ts

@@ -0,0 +1,305 @@
+// 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 CreateVouchersRequest {
+  siteId: string;
+  /** (Optional) limit for how many different guests can use the same voucher to authorize network access */
+  authorizedGuestLimit?: number;
+  /** Number of vouchers to generate */
+  count?: number;
+  /** (Optional) data usage limit in megabytes */
+  dataUsageLimitMBytes?: number;
+  /** Voucher note, duplicated across all generated vouchers */
+  name: string;
+  /** (Optional) download rate limit in kilobits per second */
+  rxRateLimitKbps?: number;
+  /** How long (in minutes) the voucher will provide access to the network since authorization of the first guest. Subsequently connected guests, if allowed, will share the same expiration time. */
+  timeLimitMinutes: number;
+  /** (Optional) upload rate limit in kilobits per second */
+  txRateLimitKbps?: number;
+}
+export const CreateVouchersRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    authorizedGuestLimit: S.optional(S.Number),
+    count: S.optional(S.Number),
+    dataUsageLimitMBytes: S.optional(S.Number),
+    name: S.String,
+    rxRateLimitKbps: S.optional(S.Number),
+    timeLimitMinutes: S.Number,
+    txRateLimitKbps: S.optional(S.Number),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/v1/sites/{siteId}/hotspot/vouchers",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "CreateVouchersRequest",
+}) as any as S.Schema<CreateVouchersRequest>;
+
+export interface HotspotVoucherDetails {
+  /** (Optional) timestamp when the voucher has been activated (authorization time of the first guest) */
+  activatedAt?: string;
+  /** For how many guests the voucher has been used to authorize network access */
+  authorizedGuestCount: number;
+  /** (Optional) limit for how many different guests can use the same voucher to authorize network access */
+  authorizedGuestLimit?: number;
+  /** Secret code to active the voucher using the Hotspot portal */
+  code: string;
+  createdAt: string;
+  /** (Optional) data usage limit in megabytes */
+  dataUsageLimitMBytes?: number;
+  /** Whether the voucher has been expired and can no longer be used to authorize network access */
+  expired: boolean;
+  /** (Optional) timestamp when the voucher will become expired. All guests using the voucher will be unauthorized from network access */
+  expiresAt?: string;
+  id: string;
+  /** Voucher note, may contain duplicate values across multiple vouchers */
+  name: string;
+  /** (Optional) download rate limit in kilobits per second */
+  rxRateLimitKbps?: number;
+  /** How long (in minutes) the voucher will provide access to the network since authorization of the first guest. Subsequently connected guests, if allowed, will share the same expiration time. */
+  timeLimitMinutes: number;
+  /** (Optional) upload rate limit in kilobits per second */
+  txRateLimitKbps?: number;
+}
+export const HotspotVoucherDetails = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    activatedAt: S.optional(S.String),
+    authorizedGuestCount: S.Number,
+    authorizedGuestLimit: S.optional(S.Number),
+    code: S.String,
+    createdAt: S.String,
+    dataUsageLimitMBytes: S.optional(S.Number),
+    expired: S.Boolean,
+    expiresAt: S.optional(S.String),
+    id: S.String,
+    name: S.String,
+    rxRateLimitKbps: S.optional(S.Number),
+    timeLimitMinutes: S.Number,
+    txRateLimitKbps: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "HotspotVoucherDetails",
+}) as any as S.Schema<HotspotVoucherDetails>;
+
+export type IntegrationVoucherCreationResultDtoVouchersList =
+  Array<HotspotVoucherDetails>;
+export const IntegrationVoucherCreationResultDtoVouchersList =
+  /*@__PURE__*/ S.Array(
+    HotspotVoucherDetails,
+  ) as any as S.Schema<IntegrationVoucherCreationResultDtoVouchersList>;
+
+export interface IntegrationVoucherCreationResultDto {
+  vouchers?: IntegrationVoucherCreationResultDtoVouchersList;
+}
+export const IntegrationVoucherCreationResultDto = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    vouchers: S.optional(IntegrationVoucherCreationResultDtoVouchersList),
+  }),
+).annotate({
+  identifier: "IntegrationVoucherCreationResultDto",
+}) as any as S.Schema<IntegrationVoucherCreationResultDto>;
+
+export interface DeleteVoucherRequest {
+  siteId: string;
+  voucherId: string;
+}
+export const DeleteVoucherRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    voucherId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v1/sites/{siteId}/hotspot/vouchers/{voucherId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DeleteVoucherRequest",
+}) as any as S.Schema<DeleteVoucherRequest>;
+
+export interface VoucherDeletionResults {
+  vouchersDeleted?: number;
+}
+export const VoucherDeletionResults = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    vouchersDeleted: S.optional(S.Number),
+  }),
+).annotate({
+  identifier: "VoucherDeletionResults",
+}) as any as S.Schema<VoucherDeletionResults>;
+
+export interface DeleteVouchersRequest {
+  siteId: string;
+  filter: string;
+}
+export const DeleteVouchersRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    filter: S.String.pipe(T.Query()),
+  }).pipe(
+    T.Http({
+      method: "DELETE",
+      uri: "/v1/sites/{siteId}/hotspot/vouchers",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DeleteVouchersRequest",
+}) as any as S.Schema<DeleteVouchersRequest>;
+
+export interface GetVoucherRequest {
+  siteId: string;
+  voucherId: string;
+}
+export const GetVoucherRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    siteId: S.String.pipe(T.Label()),
+    voucherId: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "GET",
+      uri: "/v1/sites/{siteId}/hotspot/vouchers/{voucherId}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetVoucherRequest",
+}) as any as S.Schema<GetVoucherRequest>;
+
+export interface GetVouchersRequest {
+  siteId: string;
+  offset?: number;
+  limit?: number;
+  filter?: string;
+}
+export const GetVouchersRequest = /*@__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}/hotspot/vouchers",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "GetVouchersRequest",
+}) as any as S.Schema<GetVouchersRequest>;
+
+export type HotspotVoucherDetailPageDataList = Array<HotspotVoucherDetails>;
+export const HotspotVoucherDetailPageDataList = /*@__PURE__*/ S.Array(
+  HotspotVoucherDetails,
+) as any as S.Schema<HotspotVoucherDetailPageDataList>;
+
+export interface HotspotVoucherDetailPage {
+  count: number;
+  data: HotspotVoucherDetailPageDataList;
+  limit: number;
+  offset: number;
+  totalCount: number;
+}
+export const HotspotVoucherDetailPage = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    count: S.Number,
+    data: HotspotVoucherDetailPageDataList,
+    limit: S.Number,
+    offset: S.Number,
+    totalCount: S.Number,
+  }),
+).annotate({
+  identifier: "HotspotVoucherDetailPage",
+}) as any as S.Schema<HotspotVoucherDetailPage>;
+
+export type CreateVouchersError = UnifiNetworkOpError;
+/** Generate Vouchers Create one or more Hotspot vouchers. */
+export const createVouchers: API.OperationMethod<
+  CreateVouchersRequest,
+  IntegrationVoucherCreationResultDto,
+  CreateVouchersError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: CreateVouchersRequest,
+  output: IntegrationVoucherCreationResultDto,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeleteVoucherError = UnifiNetworkOpError;
+/** Delete Voucher Remove a specific Hotspot voucher. */
+export const deleteVoucher: API.OperationMethod<
+  DeleteVoucherRequest,
+  VoucherDeletionResults,
+  DeleteVoucherError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteVoucherRequest,
+  output: VoucherDeletionResults,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DeleteVouchersError = UnifiNetworkOpError;
+/** Delete Vouchers Remove Hotspot vouchers based on the specified filter criteria. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const deleteVouchers: API.OperationMethod<
+  DeleteVouchersRequest,
+  VoucherDeletionResults,
+  DeleteVouchersError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DeleteVouchersRequest,
+  output: VoucherDeletionResults,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetVoucherError = UnifiNetworkOpError;
+/** Get Voucher Details Retrieve details of a specific Hotspot voucher. */
+export const getVoucher: API.OperationMethod<
+  GetVoucherRequest,
+  HotspotVoucherDetails,
+  GetVoucherError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetVoucherRequest,
+  output: HotspotVoucherDetails,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetVouchersError = UnifiNetworkOpError;
+/** List Vouchers Retrieve a paginated list of Hotspot vouchers. <details> <summary>Filterable properties (click to expand)</summary> </details> */
+export const getVouchers: API.OperationMethod<
+  GetVouchersRequest,
+  HotspotVoucherDetailPage,
+  GetVouchersError,
+  UnifiNetworkOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetVouchersRequest,
+  output: HotspotVoucherDetailPage,
+  errors: [UnknownUnifiNetworkError],
+  protocol: UnifiNetworkProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/index.ts

@@ -0,0 +1,14 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as accessControlAclRules from "./access_control_acl_rules.ts";
+export * as applicationInfo from "./application_info.ts";
+export * as clients from "./clients.ts";
+export * as dnsPolicies from "./dns_policies.ts";
+export * as firewall from "./firewall.ts";
+export * as hotspot from "./hotspot.ts";
+export * as networks from "./networks.ts";
+export * as sites from "./sites.ts";
+export * as supportingResources from "./supporting_resources.ts";
+export * as switching from "./switching.ts";
+export * as trafficMatchingLists from "./traffic_matching_lists.ts";
+export * as unifiDevices from "./unifi_devices.ts";
+export * as wifiBroadcasts from "./wifi_broadcasts.ts";