@greensecurity/javascript-sdk 0.40.8-beta.22 → 0.40.8-beta.24

package/src/react-query/vendorsGetNextUnansweredScreeningQuestion.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetNextUnansweredScreeningQuestion } from "../funcs/vendorsGetNextUnansweredScreeningQuestion.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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsGetNextUnansweredScreeningQuestionQueryData =
+  operations.GetNextUnansweredScreeningQuestionResponseBody;
+
+/**
+ * Get the next unanswered screening question
+ *
+ * @remarks
+ * Returns the next unanswered screening question for the vendor specified by the vendor_id_or_me path parameter.
+ */
+export function useVendorsGetNextUnansweredScreeningQuestion(
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: QueryHookOptions<
+    VendorsGetNextUnansweredScreeningQuestionQueryData
+  >,
+): UseQueryResult<VendorsGetNextUnansweredScreeningQuestionQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetNextUnansweredScreeningQuestionQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get the next unanswered screening question
+ *
+ * @remarks
+ * Returns the next unanswered screening question for the vendor specified by the vendor_id_or_me path parameter.
+ */
+export function useVendorsGetNextUnansweredScreeningQuestionSuspense(
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsGetNextUnansweredScreeningQuestionQueryData
+  >,
+): UseSuspenseQueryResult<
+  VendorsGetNextUnansweredScreeningQuestionQueryData,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetNextUnansweredScreeningQuestionQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsGetNextUnansweredScreeningQuestion(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetNextUnansweredScreeningQuestionQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsGetNextUnansweredScreeningQuestionData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorIdOrMe: string,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: VendorsGetNextUnansweredScreeningQuestionQueryData,
+): VendorsGetNextUnansweredScreeningQuestionQueryData | undefined {
+  const key = queryKeyVendorsGetNextUnansweredScreeningQuestion(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    VendorsGetNextUnansweredScreeningQuestionQueryData
+  >(key, data);
+}
+
+export function invalidateVendorsGetNextUnansweredScreeningQuestion(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      vendorIdOrMe: string,
+      parameters: { expand?: Array<components.Expand> | undefined },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getNextUnansweredScreeningQuestion",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetNextUnansweredScreeningQuestion(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getNextUnansweredScreeningQuestion",
+    ],
+  });
+}
+
+export function buildVendorsGetNextUnansweredScreeningQuestionQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetNextUnansweredScreeningQuestionQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetNextUnansweredScreeningQuestion(
+      request.vendorIdOrMe,
+      { expand: request.expand },
+    ),
+    queryFn: async function vendorsGetNextUnansweredScreeningQuestionQueryFn(
+      ctx,
+    ): Promise<VendorsGetNextUnansweredScreeningQuestionQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsGetNextUnansweredScreeningQuestion(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetNextUnansweredScreeningQuestion(
+  vendorIdOrMe: string,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getNextUnansweredScreeningQuestion",
+    vendorIdOrMe,
+    parameters,
+  ];
+}

package/src/sdk/vendors.ts

@@ -16,6 +16,7 @@ import { vendorsDeclineVendorCredential } from "../funcs/vendorsDeclineVendorCre
 import { vendorsDeleteVendorCredentialFile } from "../funcs/vendorsDeleteVendorCredentialFile.js";
 import { vendorsDeleteVendorManagedByCompany } from "../funcs/vendorsDeleteVendorManagedByCompany.js";
 import { vendorsExpediteTimeRemaining } from "../funcs/vendorsExpediteTimeRemaining.js";
+import { vendorsGetNextUnansweredScreeningQuestion } from "../funcs/vendorsGetNextUnansweredScreeningQuestion.js";
 import { vendorsGetSubscription } from "../funcs/vendorsGetSubscription.js";
 import { vendorsGetVendorCredentialDetails } from "../funcs/vendorsGetVendorCredentialDetails.js";
 import { vendorsGetVendorCredentialFile } from "../funcs/vendorsGetVendorCredentialFile.js";
@@ -887,4 +888,21 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get the next unanswered screening question
+   *
+   * @remarks
+   * Returns the next unanswered screening question for the vendor specified by the vendor_id_or_me path parameter.
+   */
+  async getNextUnansweredScreeningQuestion(
+    request: operations.GetNextUnansweredScreeningQuestionRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetNextUnansweredScreeningQuestionResponseBody> {
+    return unwrapAsync(vendorsGetNextUnansweredScreeningQuestion(
+      this,
+      request,
+      options,
+    ));
+  }
 }