@greensecurity/javascript-sdk 0.44.0-beta.1 → 0.44.0-beta.10

package/src/react-query/companiesListCompanyCredentials.ts

@@ -0,0 +1,277 @@
+/*
+ * 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 {
+  buildCompaniesListCompanyCredentialsInfiniteQuery,
+  buildCompaniesListCompanyCredentialsQuery,
+  CompaniesListCompanyCredentialsInfiniteQueryData,
+  CompaniesListCompanyCredentialsPageParams,
+  CompaniesListCompanyCredentialsQueryData,
+  prefetchCompaniesListCompanyCredentials,
+  prefetchCompaniesListCompanyCredentialsInfinite,
+  queryKeyCompaniesListCompanyCredentials,
+  queryKeyCompaniesListCompanyCredentialsInfinite,
+} from "./companiesListCompanyCredentials.core.js";
+export {
+  buildCompaniesListCompanyCredentialsInfiniteQuery,
+  buildCompaniesListCompanyCredentialsQuery,
+  type CompaniesListCompanyCredentialsInfiniteQueryData,
+  type CompaniesListCompanyCredentialsPageParams,
+  type CompaniesListCompanyCredentialsQueryData,
+  prefetchCompaniesListCompanyCredentials,
+  prefetchCompaniesListCompanyCredentialsInfinite,
+  queryKeyCompaniesListCompanyCredentials,
+  queryKeyCompaniesListCompanyCredentialsInfinite,
+};
+
+export type CompaniesListCompanyCredentialsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List Company Credentials
+ *
+ * @remarks
+ * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ */
+export function useCompaniesListCompanyCredentials(
+  request: operations.ListCompanyCredentialsRequest,
+  options?: QueryHookOptions<
+    CompaniesListCompanyCredentialsQueryData,
+    CompaniesListCompanyCredentialsQueryError
+  >,
+): UseQueryResult<
+  CompaniesListCompanyCredentialsQueryData,
+  CompaniesListCompanyCredentialsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesListCompanyCredentialsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List Company Credentials
+ *
+ * @remarks
+ * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ */
+export function useCompaniesListCompanyCredentialsSuspense(
+  request: operations.ListCompanyCredentialsRequest,
+  options?: SuspenseQueryHookOptions<
+    CompaniesListCompanyCredentialsQueryData,
+    CompaniesListCompanyCredentialsQueryError
+  >,
+): UseSuspenseQueryResult<
+  CompaniesListCompanyCredentialsQueryData,
+  CompaniesListCompanyCredentialsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesListCompanyCredentialsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List Company Credentials
+ *
+ * @remarks
+ * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ */
+export function useCompaniesListCompanyCredentialsInfinite(
+  request: operations.ListCompanyCredentialsRequest,
+  options?: InfiniteQueryHookOptions<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsPageParams
+  >,
+  CompaniesListCompanyCredentialsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsQueryError,
+    InfiniteData<
+      CompaniesListCompanyCredentialsInfiniteQueryData,
+      CompaniesListCompanyCredentialsPageParams
+    >,
+    QueryKey,
+    CompaniesListCompanyCredentialsPageParams
+  >({
+    ...buildCompaniesListCompanyCredentialsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List Company Credentials
+ *
+ * @remarks
+ * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ */
+export function useCompaniesListCompanyCredentialsInfiniteSuspense(
+  request: operations.ListCompanyCredentialsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsPageParams
+  >,
+  CompaniesListCompanyCredentialsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    CompaniesListCompanyCredentialsInfiniteQueryData,
+    CompaniesListCompanyCredentialsQueryError,
+    InfiniteData<
+      CompaniesListCompanyCredentialsInfiniteQueryData,
+      CompaniesListCompanyCredentialsPageParams
+    >,
+    QueryKey,
+    CompaniesListCompanyCredentialsPageParams
+  >({
+    ...buildCompaniesListCompanyCredentialsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setCompaniesListCompanyCredentialsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      desc?: components.Desc | undefined;
+      sort?: operations.ListCompanyCredentialsQueryParamSort | undefined;
+      credentialNameLike?: string | undefined;
+      status?: operations.ListCompanyCredentialsQueryParamStatus | undefined;
+      dateExpiresLte?: string | undefined;
+      expand?: Array<operations.Expand> | undefined;
+    },
+  ],
+  data: CompaniesListCompanyCredentialsQueryData,
+): CompaniesListCompanyCredentialsQueryData | undefined {
+  const key = queryKeyCompaniesListCompanyCredentials(...queryKeyBase);
+
+  return client.setQueryData<CompaniesListCompanyCredentialsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateCompaniesListCompanyCredentials(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        desc?: components.Desc | undefined;
+        sort?: operations.ListCompanyCredentialsQueryParamSort | undefined;
+        credentialNameLike?: string | undefined;
+        status?: operations.ListCompanyCredentialsQueryParamStatus | undefined;
+        dateExpiresLte?: string | undefined;
+        expand?: Array<operations.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyCredentials",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesListCompanyCredentials(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyCredentials",
+    ],
+  });
+}

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

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyCredits } from "../funcs/companiesListCompanyCredits.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 CompaniesListCompanyCreditsQueryData =
+  operations.ListCompanyCreditsResponse;
+
+export type CompaniesListCompanyCreditsInfiniteQueryData = PageIterator<
+  operations.ListCompanyCreditsResponse,
+  { page: number }
+>;
+
+export type CompaniesListCompanyCreditsPageParams = PageIterator<
+  operations.ListCompanyCreditsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchCompaniesListCompanyCredits(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyCreditsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchCompaniesListCompanyCreditsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildCompaniesListCompanyCreditsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as CompaniesListCompanyCreditsPageParams,
+    getNextPageParam: (
+      previousPage: CompaniesListCompanyCreditsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildCompaniesListCompanyCreditsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyCreditsQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCredits(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCreditsQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyCreditsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyCredits(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesListCompanyCreditsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      CompaniesListCompanyCreditsPageParams
+    >,
+  ) => Promise<CompaniesListCompanyCreditsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCreditsInfinite(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCreditsQuery(
+      ctx,
+    ): Promise<CompaniesListCompanyCreditsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          companiesListCompanyCredits(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(companiesListCompanyCredits(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyCredits(
+  id: number,
+  parameters: {
+    sort?: operations.ListCompanyCreditsQueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredits",
+    id,
+    parameters,
+  ];
+}
+
+export function queryKeyCompaniesListCompanyCreditsInfinite(
+  id: number,
+  parameters: {
+    sort?: operations.ListCompanyCreditsQueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredits",
+    "infinite",
+    id,
+    parameters,
+  ];
+}