@greensecurity/javascript-sdk 0.44.0-beta.65 → 0.44.0-beta.66

package/src/react-query/medicalProductsListAllMedicalProductFamilies.core.ts

@@ -0,0 +1,211 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { medicalProductsListAllMedicalProductFamilies } from "../funcs/medicalProductsListAllMedicalProductFamilies.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 { pageIteratorToJSON } from "./_types.js";
+export type MedicalProductsListAllMedicalProductFamiliesQueryData =
+  operations.ListAllMedicalProductFamiliesResponse;
+
+export type MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData =
+  PageIterator<
+    operations.ListAllMedicalProductFamiliesResponse,
+    { page: number }
+  >;
+
+export type MedicalProductsListAllMedicalProductFamiliesPageParams =
+  PageIterator<
+    operations.ListAllMedicalProductFamiliesResponse,
+    { page: number }
+  >["~next"];
+
+export function prefetchMedicalProductsListAllMedicalProductFamilies(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildMedicalProductsListAllMedicalProductFamiliesQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchMedicalProductsListAllMedicalProductFamiliesInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam:
+      undefined as MedicalProductsListAllMedicalProductFamiliesPageParams,
+    getNextPageParam: (
+      previousPage:
+        MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildMedicalProductsListAllMedicalProductFamiliesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<MedicalProductsListAllMedicalProductFamiliesQueryData>;
+} {
+  return {
+    queryKey: queryKeyMedicalProductsListAllMedicalProductFamilies({
+      page: request.page,
+      desc: request.desc,
+      itemsPerPage: request.itemsPerPage,
+      sort: request.sort,
+      nameLike: request.nameLike,
+      basicUdiDi: request.basicUdiDi,
+      status: request.status,
+    }),
+    queryFn: async function medicalProductsListAllMedicalProductFamiliesQueryFn(
+      ctx,
+    ): Promise<MedicalProductsListAllMedicalProductFamiliesQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(medicalProductsListAllMedicalProductFamilies(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      MedicalProductsListAllMedicalProductFamiliesPageParams
+    >,
+  ) => Promise<MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyMedicalProductsListAllMedicalProductFamiliesInfinite({
+      page: request.page,
+      desc: request.desc,
+      itemsPerPage: request.itemsPerPage,
+      sort: request.sort,
+      nameLike: request.nameLike,
+      basicUdiDi: request.basicUdiDi,
+      status: request.status,
+    }),
+    queryFn: async function medicalProductsListAllMedicalProductFamiliesQuery(
+      ctx,
+    ): Promise<MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          medicalProductsListAllMedicalProductFamilies(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        medicalProductsListAllMedicalProductFamilies(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyMedicalProductsListAllMedicalProductFamilies(
+  parameters: {
+    page?: number | undefined;
+    desc?: components.Desc | undefined;
+    itemsPerPage?: number | undefined;
+    sort?: operations.ListAllMedicalProductFamiliesQueryParamSort | undefined;
+    nameLike?: string | undefined;
+    basicUdiDi?: string | undefined;
+    status?:
+      | operations.ListAllMedicalProductFamiliesQueryParamStatus
+      | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "medical_products",
+    "listAllMedicalProductFamilies",
+    parameters,
+  ];
+}
+
+export function queryKeyMedicalProductsListAllMedicalProductFamiliesInfinite(
+  parameters: {
+    page?: number | undefined;
+    desc?: components.Desc | undefined;
+    itemsPerPage?: number | undefined;
+    sort?: operations.ListAllMedicalProductFamiliesQueryParamSort | undefined;
+    nameLike?: string | undefined;
+    basicUdiDi?: string | undefined;
+    status?:
+      | operations.ListAllMedicalProductFamiliesQueryParamStatus
+      | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "medical_products",
+    "listAllMedicalProductFamilies",
+    "infinite",
+    parameters,
+  ];
+}

package/src/react-query/medicalProductsListAllMedicalProductFamilies.ts

@@ -0,0 +1,320 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery,
+  buildMedicalProductsListAllMedicalProductFamiliesQuery,
+  MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+  MedicalProductsListAllMedicalProductFamiliesPageParams,
+  MedicalProductsListAllMedicalProductFamiliesQueryData,
+  prefetchMedicalProductsListAllMedicalProductFamilies,
+  prefetchMedicalProductsListAllMedicalProductFamiliesInfinite,
+  queryKeyMedicalProductsListAllMedicalProductFamilies,
+  queryKeyMedicalProductsListAllMedicalProductFamiliesInfinite,
+} from "./medicalProductsListAllMedicalProductFamilies.core.js";
+export {
+  buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery,
+  buildMedicalProductsListAllMedicalProductFamiliesQuery,
+  type MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+  type MedicalProductsListAllMedicalProductFamiliesPageParams,
+  type MedicalProductsListAllMedicalProductFamiliesQueryData,
+  prefetchMedicalProductsListAllMedicalProductFamilies,
+  prefetchMedicalProductsListAllMedicalProductFamiliesInfinite,
+  queryKeyMedicalProductsListAllMedicalProductFamilies,
+  queryKeyMedicalProductsListAllMedicalProductFamiliesInfinite,
+};
+
+export type MedicalProductsListAllMedicalProductFamiliesQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List all product families
+ *
+ * @remarks
+ * Returns the product families in the medical product catalog. Retired records are excluded
+ * unless `status` asks for them.
+ *
+ * A family groups the SKUs that share an intended purpose, risk class and essential design,
+ * which EU MDR Article 27 identifies with a Basic UDI-DI.
+ *
+ * Families share the `medical_products` permission rather than having one of their own,
+ * since a family has no meaning apart from the SKUs in it.
+ *
+ * Sortable by id, name, brand_name, status, created_at and updated_at.
+ *
+ * Requires the `medical_products` / `view` permission.
+ */
+export function useMedicalProductsListAllMedicalProductFamilies(
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: QueryHookOptions<
+    MedicalProductsListAllMedicalProductFamiliesQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError
+  >,
+): UseQueryResult<
+  MedicalProductsListAllMedicalProductFamiliesQueryData,
+  MedicalProductsListAllMedicalProductFamiliesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildMedicalProductsListAllMedicalProductFamiliesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List all product families
+ *
+ * @remarks
+ * Returns the product families in the medical product catalog. Retired records are excluded
+ * unless `status` asks for them.
+ *
+ * A family groups the SKUs that share an intended purpose, risk class and essential design,
+ * which EU MDR Article 27 identifies with a Basic UDI-DI.
+ *
+ * Families share the `medical_products` permission rather than having one of their own,
+ * since a family has no meaning apart from the SKUs in it.
+ *
+ * Sortable by id, name, brand_name, status, created_at and updated_at.
+ *
+ * Requires the `medical_products` / `view` permission.
+ */
+export function useMedicalProductsListAllMedicalProductFamiliesSuspense(
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: SuspenseQueryHookOptions<
+    MedicalProductsListAllMedicalProductFamiliesQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError
+  >,
+): UseSuspenseQueryResult<
+  MedicalProductsListAllMedicalProductFamiliesQueryData,
+  MedicalProductsListAllMedicalProductFamiliesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildMedicalProductsListAllMedicalProductFamiliesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List all product families
+ *
+ * @remarks
+ * Returns the product families in the medical product catalog. Retired records are excluded
+ * unless `status` asks for them.
+ *
+ * A family groups the SKUs that share an intended purpose, risk class and essential design,
+ * which EU MDR Article 27 identifies with a Basic UDI-DI.
+ *
+ * Families share the `medical_products` permission rather than having one of their own,
+ * since a family has no meaning apart from the SKUs in it.
+ *
+ * Sortable by id, name, brand_name, status, created_at and updated_at.
+ *
+ * Requires the `medical_products` / `view` permission.
+ */
+export function useMedicalProductsListAllMedicalProductFamiliesInfinite(
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: InfiniteQueryHookOptions<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesPageParams
+  >,
+  MedicalProductsListAllMedicalProductFamiliesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError,
+    InfiniteData<
+      MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+      MedicalProductsListAllMedicalProductFamiliesPageParams
+    >,
+    QueryKey,
+    MedicalProductsListAllMedicalProductFamiliesPageParams
+  >({
+    ...buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List all product families
+ *
+ * @remarks
+ * Returns the product families in the medical product catalog. Retired records are excluded
+ * unless `status` asks for them.
+ *
+ * A family groups the SKUs that share an intended purpose, risk class and essential design,
+ * which EU MDR Article 27 identifies with a Basic UDI-DI.
+ *
+ * Families share the `medical_products` permission rather than having one of their own,
+ * since a family has no meaning apart from the SKUs in it.
+ *
+ * Sortable by id, name, brand_name, status, created_at and updated_at.
+ *
+ * Requires the `medical_products` / `view` permission.
+ */
+export function useMedicalProductsListAllMedicalProductFamiliesInfiniteSuspense(
+  request: operations.ListAllMedicalProductFamiliesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesPageParams
+  >,
+  MedicalProductsListAllMedicalProductFamiliesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+    MedicalProductsListAllMedicalProductFamiliesQueryError,
+    InfiniteData<
+      MedicalProductsListAllMedicalProductFamiliesInfiniteQueryData,
+      MedicalProductsListAllMedicalProductFamiliesPageParams
+    >,
+    QueryKey,
+    MedicalProductsListAllMedicalProductFamiliesPageParams
+  >({
+    ...buildMedicalProductsListAllMedicalProductFamiliesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setMedicalProductsListAllMedicalProductFamiliesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      page?: number | undefined;
+      desc?: components.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      sort?: operations.ListAllMedicalProductFamiliesQueryParamSort | undefined;
+      nameLike?: string | undefined;
+      basicUdiDi?: string | undefined;
+      status?:
+        | operations.ListAllMedicalProductFamiliesQueryParamStatus
+        | undefined;
+    },
+  ],
+  data: MedicalProductsListAllMedicalProductFamiliesQueryData,
+): MedicalProductsListAllMedicalProductFamiliesQueryData | undefined {
+  const key = queryKeyMedicalProductsListAllMedicalProductFamilies(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    MedicalProductsListAllMedicalProductFamiliesQueryData
+  >(key, data);
+}
+
+export function invalidateMedicalProductsListAllMedicalProductFamilies(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      page?: number | undefined;
+      desc?: components.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      sort?: operations.ListAllMedicalProductFamiliesQueryParamSort | undefined;
+      nameLike?: string | undefined;
+      basicUdiDi?: string | undefined;
+      status?:
+        | operations.ListAllMedicalProductFamiliesQueryParamStatus
+        | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "medical_products",
+      "listAllMedicalProductFamilies",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllMedicalProductsListAllMedicalProductFamilies(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "medical_products",
+      "listAllMedicalProductFamilies",
+    ],
+  });
+}