@homeflare/distilled-opnsense 0.2.0

package/src/services/firewall_category.ts

@@ -0,0 +1,359 @@
+// 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 CategoryItem {
+  /** Item id, assigned by OPNsense on creation. */
+  uuid?: string;
+  /** OPNsense FieldType: TextField; pattern /[^,]+/ */
+  name: string;
+  /** OPNsense FieldType: BooleanField */
+  auto?: string;
+  /** OPNsense FieldType: TextField; pattern /^([0-9a-fA-F]){6,6}$/u */
+  color?: string;
+}
+export const CategoryItem = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.optional(S.String),
+    name: S.String,
+    auto: S.optional(S.String),
+    color: S.optional(S.String),
+  }),
+).annotate({ identifier: "CategoryItem" }) as any as S.Schema<CategoryItem>;
+
+export interface AddCategoryRequest {
+  category?: CategoryItem;
+}
+export const AddCategoryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    category: S.optional(CategoryItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/category/addItem",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "AddCategoryRequest",
+}) as any as S.Schema<AddCategoryRequest>;
+
+export type AddCategoryResult = "saved";
+export const AddCategoryResult = S.String;
+
+export interface AddCategoryResponse {
+  result?: AddCategoryResult;
+  /** The new item's uuid. */
+  uuid?: string;
+}
+export const AddCategoryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(AddCategoryResult),
+    uuid: S.optional(S.String),
+  }),
+).annotate({
+  identifier: "AddCategoryResponse",
+}) as any as S.Schema<AddCategoryResponse>;
+
+export interface DelCategoryRequest {
+  uuid: string;
+}
+export const DelCategoryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/category/delItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "DelCategoryRequest",
+}) as any as S.Schema<DelCategoryRequest>;
+
+export type DelCategoryResult = "deleted" | "not found";
+export const DelCategoryResult = S.String;
+
+export interface DelCategoryResponse {
+  result?: DelCategoryResult;
+}
+export const DelCategoryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(DelCategoryResult),
+  }),
+).annotate({
+  identifier: "DelCategoryResponse",
+}) as any as S.Schema<DelCategoryResponse>;
+
+export interface GetRequest {}
+export const GetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/firewall/category/get", code: 200 }),
+  ),
+).annotate({ identifier: "GetRequest" }) as any as S.Schema<GetRequest>;
+
+export type ModelCategoryItem = CategoryItem;
+export const ModelCategoryItem = CategoryItem;
+
+export type ModelCategoryItemMap = { [key: string]: CategoryItem | undefined };
+export const ModelCategoryItemMap = /*@__PURE__*/ S.Record(
+  S.String,
+  CategoryItem,
+) as any as S.Schema<ModelCategoryItemMap>;
+
+export interface ModelCategories {
+  category?: ModelCategoryItemMap;
+}
+export const ModelCategories = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    category: S.optional(ModelCategoryItemMap),
+  }),
+).annotate({
+  identifier: "ModelCategories",
+}) as any as S.Schema<ModelCategories>;
+
+export interface Model {
+  categories?: ModelCategories;
+}
+export const Model = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    categories: S.optional(ModelCategories),
+  }),
+).annotate({ identifier: "Model" }) as any as S.Schema<Model>;
+
+export interface GetResponse {
+  category?: Model;
+}
+export const GetResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    category: S.optional(Model),
+  }),
+).annotate({ identifier: "GetResponse" }) as any as S.Schema<GetResponse>;
+
+export interface GetCategoryRequest {}
+export const GetCategoryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({ method: "GET", uri: "/api/firewall/category/getItem", code: 200 }),
+  ),
+).annotate({
+  identifier: "GetCategoryRequest",
+}) as any as S.Schema<GetCategoryRequest>;
+
+export interface GetCategoryResponse {
+  category?: CategoryItem;
+}
+export const GetCategoryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    category: S.optional(CategoryItem),
+  }),
+).annotate({
+  identifier: "GetCategoryResponse",
+}) as any as S.Schema<GetCategoryResponse>;
+
+export interface SearchCategoryRequest {}
+export const SearchCategoryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({}).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/category/searchItem",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SearchCategoryRequest",
+}) as any as S.Schema<SearchCategoryRequest>;
+
+export type CategoryList = Array<CategoryItem>;
+export const CategoryList = /*@__PURE__*/ S.Array(
+  CategoryItem,
+) as any as S.Schema<CategoryList>;
+
+export interface SearchCategoryResponse {
+  /** Total matching items before pagination. */
+  total?: number;
+  rowCount?: number;
+  /** Current page number. */
+  current?: number;
+  rows?: CategoryList;
+}
+export const SearchCategoryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    total: S.optional(S.Number),
+    rowCount: S.optional(S.Number),
+    current: S.optional(S.Number),
+    rows: S.optional(CategoryList),
+  }),
+).annotate({
+  identifier: "SearchCategoryResponse",
+}) as any as S.Schema<SearchCategoryResponse>;
+
+export interface SetRequest {
+  category?: Model;
+}
+export const SetRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    category: S.optional(Model),
+  }).pipe(
+    T.Http({ method: "POST", uri: "/api/firewall/category/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 SetCategoryRequest {
+  uuid: string;
+  category?: CategoryItem;
+}
+export const SetCategoryRequest = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    uuid: S.String.pipe(T.Label()),
+    category: S.optional(CategoryItem),
+  }).pipe(
+    T.Http({
+      method: "POST",
+      uri: "/api/firewall/category/setItem/{uuid}",
+      code: 200,
+    }),
+  ),
+).annotate({
+  identifier: "SetCategoryRequest",
+}) as any as S.Schema<SetCategoryRequest>;
+
+export type SetCategoryResult = "saved";
+export const SetCategoryResult = S.String;
+
+export interface SetCategoryResponse {
+  result?: SetCategoryResult;
+}
+export const SetCategoryResponse = /*@__PURE__*/ S.suspend(() =>
+  S.Struct({
+    result: S.optional(SetCategoryResult),
+  }),
+).annotate({
+  identifier: "SetCategoryResponse",
+}) as any as S.Schema<SetCategoryResponse>;
+
+export type AddCategoryError = OpnsenseOpError;
+/** Add a new categories.category item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const addCategory: API.OperationMethod<
+  AddCategoryRequest,
+  AddCategoryResponse,
+  AddCategoryError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: AddCategoryRequest,
+  output: AddCategoryResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type DelCategoryError = OpnsenseOpError;
+/** Delete a categories.category item by uuid. */
+export const delCategory: API.OperationMethod<
+  DelCategoryRequest,
+  DelCategoryResponse,
+  DelCategoryError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: DelCategoryRequest,
+  output: DelCategoryResponse,
+  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 GetCategoryError = OpnsenseOpError;
+/** Fetch one categories.category item by uuid. */
+export const getCategory: API.OperationMethod<
+  GetCategoryRequest,
+  GetCategoryResponse,
+  GetCategoryError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: GetCategoryRequest,
+  output: GetCategoryResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));
+
+export type SearchCategoryError = OpnsenseOpError;
+/** Search categories.category items (paginated). */
+export const searchCategory: API.OperationMethod<
+  SearchCategoryRequest,
+  SearchCategoryResponse,
+  SearchCategoryError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SearchCategoryRequest,
+  output: SearchCategoryResponse,
+  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 SetCategoryError = OpnsenseOpError;
+/** Update an existing categories.category item. On a validation failure the call fails with ValidationFailed instead of decoding this response. */
+export const setCategory: API.OperationMethod<
+  SetCategoryRequest,
+  SetCategoryResponse,
+  SetCategoryError,
+  OpnsenseOpContext
+> = /*@__PURE__*/ API.make(() => ({
+  input: SetCategoryRequest,
+  output: SetCategoryResponse,
+  errors: [],
+  protocol: OpnsenseProtocol,
+  retry: Retry.Retry,
+}));