@homeflare/distilled-opnsense 0.2.0

package/src/services/firewall_group.ts

@@ -0,0 +1,350 @@
+// 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 interface GroupItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: .\GroupNameField */
+  ifname: string;
+  /** OPNsense FieldType: .\InterfaceField; multi-select: wire value is a single comma-joined string, not a JSON array */
+  members: string;
+  /** OPNsense FieldType: BooleanField */
+  nogroup?: string;
+  /** OPNsense FieldType: IntegerField; range 0..9999 (as text) */
+  sequence: string;
+  /** OPNsense FieldType: DescriptionField */
+  descr?: string;
+}
+export const GroupItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    ifname: S.String,
+    members: S.String,
+    nogroup: S.optional(S.String),
+    sequence: S.String,
+    descr: S.optional(S.String),
+  }),
+).annotate({ identifier: "GroupItem" }) as any as S.Schema<GroupItem>;
+
+export interface AddGroupRequest {
+  group?: GroupItem;
+}
+export const AddGroupRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    group: S.optional(GroupItem),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/firewall/group/addItem", code: 200 }),
+  ),
+).annotate({
+  identifier: "AddGroupRequest",
+}) as any as S.Schema<AddGroupRequest>;
+
+export type AddGroupResult = "saved";
+export const AddGroupResult = S.String;
+
+export interface AddGroupResponse {
+  result?: AddGroupResult;
+  /** The new item's uuid. */
+  uuid?: string;
+}
+export const AddGroupResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(AddGroupResult),
+    uuid: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "AddGroupResponse",
+}) as any as S.Schema<AddGroupResponse>;
+
+export interface DelGroupRequest {
+  uuid: string;
+}
+export const DelGroupRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/group/delItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DelGroupRequest",
+}) as any as S.Schema<DelGroupRequest>;
+
+export type DelGroupResult = "deleted" | "not found";
+export const DelGroupResult = S.String;
+
+export interface DelGroupResponse {
+  result?: DelGroupResult;
+}
+export const DelGroupResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(DelGroupResult),
+  }),
+).annotate({
+  identifier: "DelGroupResponse",
+}) as any as S.Schema<DelGroupResponse>;
+
+export interface GetRequest {}
+export const GetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/firewall/group/get", code: 200 }),
+  ),
+).annotate({ identifier: "GetRequest" }) as any as S.Schema<GetRequest>;
+
+export type ModelIfgroupentryItem = GroupItem;
+export const ModelIfgroupentryItem = GroupItem;
+
+export type ModelIfgroupentryItemMap = { [key: string]: GroupItem | undefined };
+export const ModelIfgroupentryItemMap = /*@__PURE__*/ S.Record(
+  S.String,
+  GroupItem,
+) as any as S.Schema<ModelIfgroupentryItemMap>;
+
+export interface Model {
+  ifgroupentry?: ModelIfgroupentryItemMap;
+}
+export const Model = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    ifgroupentry: S.optional(ModelIfgroupentryItemMap),
+  }),
+).annotate({ identifier: "Model" }) as any as S.Schema<Model>;
+
+export interface GetResponse {
+  group?: Model;
+}
+export const GetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    group: S.optional(Model),
+  }),
+).annotate({ identifier: "GetResponse" }) as any as S.Schema<GetResponse>;
+
+export interface GetGroupRequest {}
+export const GetGroupRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/firewall/group/getItem", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetGroupRequest",
+}) as any as S.Schema<GetGroupRequest>;
+
+export interface GetGroupResponse {
+  group?: GroupItem;
+}
+export const GetGroupResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    group: S.optional(GroupItem),
+  }),
+).annotate({
+  identifier: "GetGroupResponse",
+}) as any as S.Schema<GetGroupResponse>;
+
+export interface SearchGroupRequest {}
+export const SearchGroupRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/group/searchItem",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SearchGroupRequest",
+}) as any as S.Schema<SearchGroupRequest>;
+
+export type GroupList = Array<GroupItem>;
+export const GroupList = /*@__PURE__*/ S.Array(
+  GroupItem,
+) as any as S.Schema<GroupList>;
+
+export interface SearchGroupResponse {
+  /** Total matching items before pagination. */
+  total?: number;
+  rowCount?: number;
+  /** Current page number. */
+  current?: number;
+  rows?: GroupList;
+}
+export const SearchGroupResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    total: S.optional(S.Number),
+    rowCount: S.optional(S.Number),
+    current: S.optional(S.Number),
+    rows: S.optional(GroupList),
+  }),
+).annotate({
+  identifier: "SearchGroupResponse",
+}) as any as S.Schema<SearchGroupResponse>;
+
+export interface SetRequest {
+  group?: Model;
+}
+export const SetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    group: S.optional(Model),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/firewall/group/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 SetGroupRequest {
+  uuid: string;
+  group?: GroupItem;
+}
+export const SetGroupRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+    group: S.optional(GroupItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/group/setItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SetGroupRequest",
+}) as any as S.Schema<SetGroupRequest>;
+
+export type SetGroupResult = "saved";
+export const SetGroupResult = S.String;
+
+export interface SetGroupResponse {
+  result?: SetGroupResult;
+}
+export const SetGroupResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetGroupResult),
+  }),
+).annotate({
+  identifier: "SetGroupResponse",
+}) as any as S.Schema<SetGroupResponse>;
+
+export type AddGroupError = OpnsenseOpError;
+/** Add a new ifgroupentry item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const addGroup: API.OperationMethod<
+  AddGroupRequest,
+  AddGroupResponse,
+  AddGroupError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AddGroupRequest,
+  output: AddGroupResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DelGroupError = OpnsenseOpError;
+/** Delete a ifgroupentry item by uuid. */
+export const delGroup: API.OperationMethod<
+  DelGroupRequest,
+  DelGroupResponse,
+  DelGroupError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DelGroupRequest,
+  output: DelGroupResponse,
+  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 GetGroupError = OpnsenseOpError;
+/** Fetch one ifgroupentry item by uuid. */
+export const getGroup: API.OperationMethod<
+  GetGroupRequest,
+  GetGroupResponse,
+  GetGroupError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetGroupRequest,
+  output: GetGroupResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchGroupError = OpnsenseOpError;
+/** Search ifgroupentry items (paginated). */
+export const searchGroup: API.OperationMethod<
+  SearchGroupRequest,
+  SearchGroupResponse,
+  SearchGroupError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchGroupRequest,
+  output: SearchGroupResponse,
+  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 SetGroupError = OpnsenseOpError;
+/** Update an existing ifgroupentry item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const setGroup: API.OperationMethod<
+  SetGroupRequest,
+  SetGroupResponse,
+  SetGroupError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetGroupRequest,
+  output: SetGroupResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));

package/src/services/index.ts

@@ -0,0 +1,9 @@
+// AUTO-GENERATED by scripts/generate.ts. Do not edit.
+export * as firewall_alias from "./firewall_alias.ts";
+export * as firewall_category from "./firewall_category.ts";
+export * as firewall_filter from "./firewall_filter.ts";
+export * as firewall_group from "./firewall_group.ts";
+export * as quagga_bgp from "./quagga_bgp.ts";
+export * as quagga_general from "./quagga_general.ts";
+export * as quagga_service from "./quagga_service.ts";
+export * as routing_settings from "./routing_settings.ts";