@greensecurity/javascript-sdk 0.37.10 → 0.37.14

package/src/react-query/organizationsListOrSearchDepartmentContacts.ts

@@ -0,0 +1,386 @@
+/*
+ * 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 { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.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 OrganizationsListOrSearchDepartmentContactsQueryData =
+  operations.ListOrSearchDepartmentContactsResponse;
+
+export type OrganizationsListOrSearchDepartmentContactsInfiniteQueryData =
+  PageIterator<
+    operations.ListOrSearchDepartmentContactsResponse,
+    { page: number }
+  >;
+
+export type OrganizationsListOrSearchDepartmentContactsPageParams =
+  PageIterator<
+    operations.ListOrSearchDepartmentContactsResponse,
+    { page: number }
+  >["~next"];
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContacts(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: QueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >,
+): UseQueryResult<OrganizationsListOrSearchDepartmentContactsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsSuspense(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsListOrSearchDepartmentContactsQueryData,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsInfinite(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: InfiniteQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+    QueryKey,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >({
+    ...buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search department contacts
+ *
+ * @remarks
+ * List or search department contacts.
+ *
+ * Available `expand` scopes are:
+ *
+ * - department_membership.contact
+ * - department_membership.department
+ */
+export function useOrganizationsListOrSearchDepartmentContactsInfiniteSuspense(
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      OrganizationsListOrSearchDepartmentContactsInfiniteQueryData,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+    QueryKey,
+    OrganizationsListOrSearchDepartmentContactsPageParams
+  >({
+    ...buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchOrganizationsListOrSearchDepartmentContacts(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsListOrSearchDepartmentContactsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setOrganizationsListOrSearchDepartmentContactsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      search?: string | undefined;
+      expand?: Array<components.Expand> | undefined;
+    },
+  ],
+  data: OrganizationsListOrSearchDepartmentContactsQueryData,
+): OrganizationsListOrSearchDepartmentContactsQueryData | undefined {
+  const key = queryKeyOrganizationsListOrSearchDepartmentContacts(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    OrganizationsListOrSearchDepartmentContactsQueryData
+  >(key, data);
+}
+
+export function invalidateOrganizationsListOrSearchDepartmentContacts(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        search?: string | undefined;
+        expand?: Array<components.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listOrSearchDepartmentContacts",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsListOrSearchDepartmentContacts(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listOrSearchDepartmentContacts",
+    ],
+  });
+}
+
+export function buildOrganizationsListOrSearchDepartmentContactsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsListOrSearchDepartmentContactsQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListOrSearchDepartmentContacts(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      search: request.search,
+      expand: request.expand,
+    }),
+    queryFn: async function organizationsListOrSearchDepartmentContactsQueryFn(
+      ctx,
+    ): Promise<OrganizationsListOrSearchDepartmentContactsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(organizationsListOrSearchDepartmentContacts(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildOrganizationsListOrSearchDepartmentContactsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchDepartmentContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      OrganizationsListOrSearchDepartmentContactsPageParams
+    >,
+  ) => Promise<OrganizationsListOrSearchDepartmentContactsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListOrSearchDepartmentContacts(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      search: request.search,
+      expand: request.expand,
+    }),
+    queryFn: async function organizationsListOrSearchDepartmentContactsQuery(
+      ctx,
+    ): Promise<OrganizationsListOrSearchDepartmentContactsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(organizationsListOrSearchDepartmentContacts(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(organizationsListOrSearchDepartmentContacts(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyOrganizationsListOrSearchDepartmentContacts(
+  id: number,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    search?: string | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listOrSearchDepartmentContacts",
+    id,
+    parameters,
+  ];
+}