@greensecurity/javascript-sdk 0.40.8-beta.3 → 0.40.8-beta.5

package/src/models/operations/listalerts.ts

@@ -0,0 +1,234 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListAlertsRequest = {
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListAlertsResponseBody = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.Alert>;
+};
+
+export type ListAlertsResponse = {
+  result: ListAlertsResponseBody;
+};
+
+/** @internal */
+export const ListAlertsRequest$inboundSchema: z.ZodType<
+  ListAlertsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$inboundSchema.optional(),
+  page: z.number().int().optional(),
+  items_per_page: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_per_page": "itemsPerPage",
+  });
+});
+
+/** @internal */
+export type ListAlertsRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ListAlertsRequest$outboundSchema: z.ZodType<
+  ListAlertsRequest$Outbound,
+  z.ZodTypeDef,
+  ListAlertsRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsRequest$ {
+  /** @deprecated use `ListAlertsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsRequest$inboundSchema;
+  /** @deprecated use `ListAlertsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsRequest$outboundSchema;
+  /** @deprecated use `ListAlertsRequest$Outbound` instead. */
+  export type Outbound = ListAlertsRequest$Outbound;
+}
+
+export function listAlertsRequestToJSON(
+  listAlertsRequest: ListAlertsRequest,
+): string {
+  return JSON.stringify(
+    ListAlertsRequest$outboundSchema.parse(listAlertsRequest),
+  );
+}
+
+export function listAlertsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAlertsResponseBody$inboundSchema: z.ZodType<
+  ListAlertsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.Alert$inboundSchema),
+});
+
+/** @internal */
+export type ListAlertsResponseBody$Outbound = {
+  pager: components.Pager$Outbound;
+  items: Array<components.Alert$Outbound>;
+};
+
+/** @internal */
+export const ListAlertsResponseBody$outboundSchema: z.ZodType<
+  ListAlertsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListAlertsResponseBody
+> = z.object({
+  pager: components.Pager$outboundSchema,
+  items: z.array(components.Alert$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsResponseBody$ {
+  /** @deprecated use `ListAlertsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsResponseBody$inboundSchema;
+  /** @deprecated use `ListAlertsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsResponseBody$outboundSchema;
+  /** @deprecated use `ListAlertsResponseBody$Outbound` instead. */
+  export type Outbound = ListAlertsResponseBody$Outbound;
+}
+
+export function listAlertsResponseBodyToJSON(
+  listAlertsResponseBody: ListAlertsResponseBody,
+): string {
+  return JSON.stringify(
+    ListAlertsResponseBody$outboundSchema.parse(listAlertsResponseBody),
+  );
+}
+
+export function listAlertsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListAlertsResponse$inboundSchema: z.ZodType<
+  ListAlertsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListAlertsResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListAlertsResponse$Outbound = {
+  Result: ListAlertsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListAlertsResponse$outboundSchema: z.ZodType<
+  ListAlertsResponse$Outbound,
+  z.ZodTypeDef,
+  ListAlertsResponse
+> = z.object({
+  result: z.lazy(() => ListAlertsResponseBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListAlertsResponse$ {
+  /** @deprecated use `ListAlertsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListAlertsResponse$inboundSchema;
+  /** @deprecated use `ListAlertsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListAlertsResponse$outboundSchema;
+  /** @deprecated use `ListAlertsResponse$Outbound` instead. */
+  export type Outbound = ListAlertsResponse$Outbound;
+}
+
+export function listAlertsResponseToJSON(
+  listAlertsResponse: ListAlertsResponse,
+): string {
+  return JSON.stringify(
+    ListAlertsResponse$outboundSchema.parse(listAlertsResponse),
+  );
+}
+
+export function listAlertsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListAlertsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListAlertsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListAlertsResponse' from JSON`,
+  );
+}

package/src/models/operations/updateuseralerts.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UpdateUserAlertsRequestBody = {
+  alertIds?: Array<number> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type UpdateUserAlertsResponseBody = {
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsRequestBody$inboundSchema: z.ZodType<
+  UpdateUserAlertsRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alert_ids: z.array(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "alert_ids": "alertIds",
+  });
+});
+
+/** @internal */
+export type UpdateUserAlertsRequestBody$Outbound = {
+  alert_ids?: Array<number> | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsRequestBody$outboundSchema: z.ZodType<
+  UpdateUserAlertsRequestBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserAlertsRequestBody
+> = z.object({
+  alertIds: z.array(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    alertIds: "alert_ids",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateUserAlertsRequestBody$ {
+  /** @deprecated use `UpdateUserAlertsRequestBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateUserAlertsRequestBody$inboundSchema;
+  /** @deprecated use `UpdateUserAlertsRequestBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateUserAlertsRequestBody$outboundSchema;
+  /** @deprecated use `UpdateUserAlertsRequestBody$Outbound` instead. */
+  export type Outbound = UpdateUserAlertsRequestBody$Outbound;
+}
+
+export function updateUserAlertsRequestBodyToJSON(
+  updateUserAlertsRequestBody: UpdateUserAlertsRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateUserAlertsRequestBody$outboundSchema.parse(
+      updateUserAlertsRequestBody,
+    ),
+  );
+}
+
+export function updateUserAlertsRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateUserAlertsRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateUserAlertsRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateUserAlertsRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateUserAlertsResponseBody$inboundSchema: z.ZodType<
+  UpdateUserAlertsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean().optional(),
+});
+
+/** @internal */
+export type UpdateUserAlertsResponseBody$Outbound = {
+  success?: boolean | undefined;
+};
+
+/** @internal */
+export const UpdateUserAlertsResponseBody$outboundSchema: z.ZodType<
+  UpdateUserAlertsResponseBody$Outbound,
+  z.ZodTypeDef,
+  UpdateUserAlertsResponseBody
+> = z.object({
+  success: z.boolean().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace UpdateUserAlertsResponseBody$ {
+  /** @deprecated use `UpdateUserAlertsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = UpdateUserAlertsResponseBody$inboundSchema;
+  /** @deprecated use `UpdateUserAlertsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = UpdateUserAlertsResponseBody$outboundSchema;
+  /** @deprecated use `UpdateUserAlertsResponseBody$Outbound` instead. */
+  export type Outbound = UpdateUserAlertsResponseBody$Outbound;
+}
+
+export function updateUserAlertsResponseBodyToJSON(
+  updateUserAlertsResponseBody: UpdateUserAlertsResponseBody,
+): string {
+  return JSON.stringify(
+    UpdateUserAlertsResponseBody$outboundSchema.parse(
+      updateUserAlertsResponseBody,
+    ),
+  );
+}
+
+export function updateUserAlertsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateUserAlertsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateUserAlertsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateUserAlertsResponseBody' from JSON`,
+  );
+}

package/src/react-query/alertsListAlerts.ts

@@ -0,0 +1,308 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { alertsListAlerts } from "../funcs/alertsListAlerts.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type AlertsListAlertsQueryData = operations.ListAlertsResponse;
+
+export type AlertsListAlertsInfiniteQueryData = PageIterator<
+  operations.ListAlertsResponse,
+  { page: number }
+>;
+
+export type AlertsListAlertsPageParams = PageIterator<
+  operations.ListAlertsResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List alerts
+ *
+ * @remarks
+ * List alerts for user.
+ */
+export function useAlertsListAlerts(
+  request: operations.ListAlertsRequest,
+  options?: QueryHookOptions<AlertsListAlertsQueryData>,
+): UseQueryResult<AlertsListAlertsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildAlertsListAlertsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List alerts
+ *
+ * @remarks
+ * List alerts for user.
+ */
+export function useAlertsListAlertsSuspense(
+  request: operations.ListAlertsRequest,
+  options?: SuspenseQueryHookOptions<AlertsListAlertsQueryData>,
+): UseSuspenseQueryResult<AlertsListAlertsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildAlertsListAlertsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List alerts
+ *
+ * @remarks
+ * List alerts for user.
+ */
+export function useAlertsListAlertsInfinite(
+  request: operations.ListAlertsRequest,
+  options?: InfiniteQueryHookOptions<AlertsListAlertsInfiniteQueryData>,
+): UseInfiniteQueryResult<
+  InfiniteData<AlertsListAlertsInfiniteQueryData, AlertsListAlertsPageParams>,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    AlertsListAlertsInfiniteQueryData,
+    Error,
+    InfiniteData<AlertsListAlertsInfiniteQueryData, AlertsListAlertsPageParams>,
+    QueryKey,
+    AlertsListAlertsPageParams
+  >({
+    ...buildAlertsListAlertsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List alerts
+ *
+ * @remarks
+ * List alerts for user.
+ */
+export function useAlertsListAlertsInfiniteSuspense(
+  request: operations.ListAlertsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<AlertsListAlertsInfiniteQueryData>,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<AlertsListAlertsInfiniteQueryData, AlertsListAlertsPageParams>,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    AlertsListAlertsInfiniteQueryData,
+    Error,
+    InfiniteData<AlertsListAlertsInfiniteQueryData, AlertsListAlertsPageParams>,
+    QueryKey,
+    AlertsListAlertsPageParams
+  >({
+    ...buildAlertsListAlertsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchAlertsListAlerts(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListAlertsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildAlertsListAlertsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setAlertsListAlertsData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: AlertsListAlertsQueryData,
+): AlertsListAlertsQueryData | undefined {
+  const key = queryKeyAlertsListAlerts(...queryKeyBase);
+
+  return client.setQueryData<AlertsListAlertsQueryData>(key, data);
+}
+
+export function invalidateAlertsListAlerts(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "alerts",
+      "listAlerts",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllAlertsListAlerts(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "alerts", "listAlerts"],
+  });
+}
+
+export function buildAlertsListAlertsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListAlertsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<AlertsListAlertsQueryData>;
+} {
+  return {
+    queryKey: queryKeyAlertsListAlerts({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function alertsListAlertsQueryFn(
+      ctx,
+    ): Promise<AlertsListAlertsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(alertsListAlerts(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildAlertsListAlertsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListAlertsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<QueryKey, AlertsListAlertsPageParams>,
+  ) => Promise<AlertsListAlertsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyAlertsListAlerts({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function alertsListAlertsQuery(
+      ctx,
+    ): Promise<AlertsListAlertsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(alertsListAlerts(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(alertsListAlerts(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyAlertsListAlerts(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return ["@greensecurity/javascript-sdk", "alerts", "listAlerts", parameters];
+}