@homeflare/distilled-opnsense 0.2.0

package/src/services/firewall_alias.ts

@@ -0,0 +1,572 @@
+// AUTO-GENERATED by scripts/generate.ts from .generated-specs (specs/spec-mirror-opnsense). 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 {
+  OpnsenseProtocol,
+  type OpnsenseOpError,
+  type OpnsenseOpContext,
+} from "../protocol.ts";
+import * as Retry from "../retry.ts";
+
+export type { OpnsenseOpError, OpnsenseOpContext };
+
+export type AliasItemType =
+  | "host"
+  | "network"
+  | "port"
+  | "url"
+  | "urltable"
+  | "urljson"
+  | "geoip"
+  | "networkgroup"
+  | "mac"
+  | "asn"
+  | "dynipv6host"
+  | "authgroup"
+  | "internal"
+  | "external";
+export const AliasItemType = S.String;
+
+export type AliasItemProto = "IPv4" | "IPv6";
+export const AliasItemProto = S.String;
+
+export type AliasItemAuthtype = "Basic" | "Bearer" | "Header";
+export const AliasItemAuthtype = S.String;
+
+export interface AliasItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: BooleanField */
+  enabled: string;
+  /** OPNsense FieldType: .\AliasNameField */
+  name: string;
+  /** OPNsense FieldType: OptionField */
+  type: AliasItemType | (string & {});
+  /** OPNsense FieldType: TextField */
+  path_expression?: string;
+  /** OPNsense FieldType: OptionField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  proto?: AliasItemProto | (string & {});
+  /** OPNsense FieldType: InterfaceField */
+  interface?: string;
+  /** OPNsense FieldType: BooleanField */
+  counters?: string;
+  /** OPNsense FieldType: NumericField */
+  updatefreq?: string;
+  /** OPNsense FieldType: .\AliasContentField */
+  content?: string;
+  /** OPNsense FieldType: TextField */
+  password?: string;
+  /** OPNsense FieldType: TextField */
+  username?: string;
+  /** OPNsense FieldType: OptionField */
+  authtype?: AliasItemAuthtype | (string & {});
+  /** OPNsense FieldType: IntegerField; range 60..999999999 (as text) */
+  expire?: string;
+  /** OPNsense FieldType: ModelRelationField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  categories?: string;
+  /** OPNsense FieldType: IntegerField */
+  current_items?: string;
+  /** OPNsense FieldType: TextField */
+  last_updated?: string;
+  /** OPNsense FieldType: IntegerField */
+  eval_nomatch?: string;
+  /** OPNsense FieldType: IntegerField */
+  eval_match?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_block_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_block_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_pass_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_pass_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_block_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_block_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_pass_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_pass_b?: string;
+  /** OPNsense FieldType: DescriptionField */
+  description?: string;
+}
+export const AliasItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    enabled: S.String,
+    name: S.String,
+    type: AliasItemType,
+    path_expression: S.optional(S.String),
+    proto: S.optional(AliasItemProto),
+    interface: S.optional(S.String),
+    counters: S.optional(S.String),
+    updatefreq: S.optional(S.String),
+    content: S.optional(S.String),
+    password: S.optional(S.String),
+    username: S.optional(S.String),
+    authtype: S.optional(AliasItemAuthtype),
+    expire: S.optional(S.String),
+    categories: S.optional(S.String),
+    current_items: S.optional(S.String),
+    last_updated: S.optional(S.String),
+    eval_nomatch: S.optional(S.String),
+    eval_match: S.optional(S.String),
+    in_block_p: S.optional(S.String),
+    in_block_b: S.optional(S.String),
+    in_pass_p: S.optional(S.String),
+    in_pass_b: S.optional(S.String),
+    out_block_p: S.optional(S.String),
+    out_block_b: S.optional(S.String),
+    out_pass_p: S.optional(S.String),
+    out_pass_b: S.optional(S.String),
+    description: S.optional(S.String),
+  }),
+).annotate({ identifier: "AliasItem" }) as any as S.Schema<AliasItem>;
+
+export interface AddAliasRequest {
+  alias?: AliasItem;
+}
+export const AddAliasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    alias: S.optional(AliasItem),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/firewall/alias/addItem", code: 200 }),
+  ),
+).annotate({
+  identifier: "AddAliasRequest",
+}) as any as S.Schema<AddAliasRequest>;
+
+export type AddAliasResult = "saved";
+export const AddAliasResult = S.String;
+
+export interface AddAliasResponse {
+  result?: AddAliasResult;
+  /** The new item's uuid. */
+  uuid?: string;
+}
+export const AddAliasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(AddAliasResult),
+    uuid: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "AddAliasResponse",
+}) as any as S.Schema<AddAliasResponse>;
+
+export interface DelAliasRequest {
+  uuids: string;
+}
+export const DelAliasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuids: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/alias/delItem/{uuids}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DelAliasRequest",
+}) as any as S.Schema<DelAliasRequest>;
+
+export type DelAliasResult = "deleted" | "not found";
+export const DelAliasResult = S.String;
+
+export interface DelAliasResponse {
+  result?: DelAliasResult;
+}
+export const DelAliasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(DelAliasResult),
+  }),
+).annotate({
+  identifier: "DelAliasResponse",
+}) as any as S.Schema<DelAliasResponse>;
+
+export interface GetRequest {}
+export const GetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/firewall/alias/get", code: 200 }),
+  ),
+).annotate({ identifier: "GetRequest" }) as any as S.Schema<GetRequest>;
+
+export type ModelAliasItemType =
+  | "host"
+  | "network"
+  | "port"
+  | "url"
+  | "urltable"
+  | "urljson"
+  | "geoip"
+  | "networkgroup"
+  | "mac"
+  | "asn"
+  | "dynipv6host"
+  | "authgroup"
+  | "internal"
+  | "external";
+export const ModelAliasItemType = S.String;
+
+export type ModelAliasItemProto = "IPv4" | "IPv6";
+export const ModelAliasItemProto = S.String;
+
+export type ModelAliasItemAuthtype = "Basic" | "Bearer" | "Header";
+export const ModelAliasItemAuthtype = S.String;
+
+export interface ModelAliasItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: BooleanField */
+  enabled: string;
+  /** OPNsense FieldType: .\AliasNameField */
+  name: string;
+  /** OPNsense FieldType: OptionField */
+  type: ModelAliasItemType | (string & {});
+  /** OPNsense FieldType: TextField */
+  path_expression?: string;
+  /** OPNsense FieldType: OptionField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  proto?: ModelAliasItemProto | (string & {});
+  /** OPNsense FieldType: InterfaceField */
+  interface?: string;
+  /** OPNsense FieldType: BooleanField */
+  counters?: string;
+  /** OPNsense FieldType: NumericField */
+  updatefreq?: string;
+  /** OPNsense FieldType: .\AliasContentField */
+  content?: string;
+  /** OPNsense FieldType: TextField */
+  password?: string;
+  /** OPNsense FieldType: TextField */
+  username?: string;
+  /** OPNsense FieldType: OptionField */
+  authtype?: ModelAliasItemAuthtype | (string & {});
+  /** OPNsense FieldType: IntegerField; range 60..999999999 (as text) */
+  expire?: string;
+  /** OPNsense FieldType: ModelRelationField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  categories?: string;
+  /** OPNsense FieldType: IntegerField */
+  current_items?: string;
+  /** OPNsense FieldType: TextField */
+  last_updated?: string;
+  /** OPNsense FieldType: IntegerField */
+  eval_nomatch?: string;
+  /** OPNsense FieldType: IntegerField */
+  eval_match?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_block_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_block_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_pass_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  in_pass_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_block_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_block_b?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_pass_p?: string;
+  /** OPNsense FieldType: IntegerField */
+  out_pass_b?: string;
+  /** OPNsense FieldType: DescriptionField */
+  description?: string;
+}
+export const ModelAliasItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    enabled: S.String,
+    name: S.String,
+    type: ModelAliasItemType,
+    path_expression: S.optional(S.String),
+    proto: S.optional(ModelAliasItemProto),
+    interface: S.optional(S.String),
+    counters: S.optional(S.String),
+    updatefreq: S.optional(S.String),
+    content: S.optional(S.String),
+    password: S.optional(S.String),
+    username: S.optional(S.String),
+    authtype: S.optional(ModelAliasItemAuthtype),
+    expire: S.optional(S.String),
+    categories: S.optional(S.String),
+    current_items: S.optional(S.String),
+    last_updated: S.optional(S.String),
+    eval_nomatch: S.optional(S.String),
+    eval_match: S.optional(S.String),
+    in_block_p: S.optional(S.String),
+    in_block_b: S.optional(S.String),
+    in_pass_p: S.optional(S.String),
+    in_pass_b: S.optional(S.String),
+    out_block_p: S.optional(S.String),
+    out_block_b: S.optional(S.String),
+    out_pass_p: S.optional(S.String),
+    out_pass_b: S.optional(S.String),
+    description: S.optional(S.String),
+  }),
+).annotate({ identifier: "ModelAliasItem" }) as any as S.Schema<ModelAliasItem>;
+
+export type ModelAliasItemMap = { [key: string]: ModelAliasItem | undefined };
+export const ModelAliasItemMap = /*@__PURE__*/ S.Record(
+  S.String,
+  ModelAliasItem,
+) as any as S.Schema<ModelAliasItemMap>;
+
+export interface ModelAliases {
+  alias?: ModelAliasItemMap;
+}
+export const ModelAliases = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    alias: S.optional(ModelAliasItemMap),
+  }),
+).annotate({ identifier: "ModelAliases" }) as any as S.Schema<ModelAliases>;
+
+export interface Model {
+  aliases?: ModelAliases;
+}
+export const Model = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    aliases: S.optional(ModelAliases),
+  }),
+).annotate({ identifier: "Model" }) as any as S.Schema<Model>;
+
+export interface GetResponse {
+  alias?: Model;
+}
+export const GetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    alias: S.optional(Model),
+  }),
+).annotate({ identifier: "GetResponse" }) as any as S.Schema<GetResponse>;
+
+export interface SearchAliasRequest {}
+export const SearchAliasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/alias/searchItem",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SearchAliasRequest",
+}) as any as S.Schema<SearchAliasRequest>;
+
+export type AliasList = Array<AliasItem>;
+export const AliasList = /*@__PURE__*/ S.Array(
+  AliasItem,
+) as any as S.Schema<AliasList>;
+
+export interface SearchAliasResponse {
+  /** Total matching items before pagination. */
+  total?: number;
+  rowCount?: number;
+  /** Current page number. */
+  current?: number;
+  rows?: AliasList;
+}
+export const SearchAliasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    total: S.optional(S.Number),
+    rowCount: S.optional(S.Number),
+    current: S.optional(S.Number),
+    rows: S.optional(AliasList),
+  }),
+).annotate({
+  identifier: "SearchAliasResponse",
+}) as any as S.Schema<SearchAliasResponse>;
+
+export interface SetRequest {
+  alias?: Model;
+}
+export const SetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    alias: S.optional(Model),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/firewall/alias/set", code: 200 }),
+  ),
+).annotate({ identifier: "SetRequest" }) as any as S.Schema<SetRequest>;
+
+export type SetResult = "saved";
+export const SetResult = S.String;
+
+export interface SetResponse {
+  result?: SetResult;
+}
+export const SetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetResult),
+  }),
+).annotate({ identifier: "SetResponse" }) as any as S.Schema<SetResponse>;
+
+export interface SetAliasRequest {
+  uuid: string;
+  alias?: AliasItem;
+}
+export const SetAliasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+    alias: S.optional(AliasItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/alias/setItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SetAliasRequest",
+}) as any as S.Schema<SetAliasRequest>;
+
+export type SetAliasResult = "saved";
+export const SetAliasResult = S.String;
+
+export interface SetAliasResponse {
+  result?: SetAliasResult;
+}
+export const SetAliasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetAliasResult),
+  }),
+).annotate({
+  identifier: "SetAliasResponse",
+}) as any as S.Schema<SetAliasResponse>;
+
+export interface ToggleAliasRequest {
+  uuid: string;
+}
+export const ToggleAliasRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/alias/toggleItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "ToggleAliasRequest",
+}) as any as S.Schema<ToggleAliasRequest>;
+
+export type ToggleAliasResult = "Enabled" | "Disabled" | "failed";
+export const ToggleAliasResult = S.String;
+
+export interface ToggleAliasResponse {
+  result?: ToggleAliasResult;
+  changed?: boolean;
+}
+export const ToggleAliasResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(ToggleAliasResult),
+    changed: S.optional(S.Boolean),
+  }),
+).annotate({
+  identifier: "ToggleAliasResponse",
+}) as any as S.Schema<ToggleAliasResponse>;
+
+export type AddAliasError = OpnsenseOpError;
+/** Add a new aliases.alias item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const addAlias: API.OperationMethod<
+  AddAliasRequest,
+  AddAliasResponse,
+  AddAliasError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AddAliasRequest,
+  output: AddAliasResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DelAliasError = OpnsenseOpError;
+/** Delete a aliases.alias item by uuid. */
+export const delAlias: API.OperationMethod<
+  DelAliasRequest,
+  DelAliasResponse,
+  DelAliasError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DelAliasRequest,
+  output: DelAliasResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type GetError = OpnsenseOpError;
+/** Fetch the entire model tree (every section and array collection). */
+export const get: API.OperationMethod<
+  GetRequest,
+  GetResponse,
+  GetError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetRequest,
+  output: GetResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchAliasError = OpnsenseOpError;
+/** Search aliases.alias items (paginated). */
+export const searchAlias: API.OperationMethod<
+  SearchAliasRequest,
+  SearchAliasResponse,
+  SearchAliasError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchAliasRequest,
+  output: SearchAliasResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SetError = OpnsenseOpError;
+/** Replace the entire model tree in one call. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const set: API.OperationMethod<
+  SetRequest,
+  SetResponse,
+  SetError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetRequest,
+  output: SetResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SetAliasError = OpnsenseOpError;
+/** Update an existing aliases.alias item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const setAlias: API.OperationMethod<
+  SetAliasRequest,
+  SetAliasResponse,
+  SetAliasError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetAliasRequest,
+  output: SetAliasResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type ToggleAliasError = OpnsenseOpError;
+/** Flip a aliases.alias item's enabled flag by uuid. */
+export const toggleAlias: API.OperationMethod<
+  ToggleAliasRequest,
+  ToggleAliasResponse,
+  ToggleAliasError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: ToggleAliasRequest,
+  output: ToggleAliasResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));