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

package/src/models/operations/getnextunansweredscreeningquestion.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 GetNextUnansweredScreeningQuestionRequest = {
+  /**
+   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   */
+  vendorIdOrMe: string;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetNextUnansweredScreeningQuestionResponseBody = {
+  screeningQuestion: components.ScreeningQuestion | null;
+  screeningResponse: components.ScreeningResponse | null;
+  success: boolean;
+};
+
+/** @internal */
+export const GetNextUnansweredScreeningQuestionRequest$inboundSchema: z.ZodType<
+  GetNextUnansweredScreeningQuestionRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vendor_id_or_me: z.string(),
+  expand: z.array(components.Expand$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id_or_me": "vendorIdOrMe",
+  });
+});
+
+/** @internal */
+export type GetNextUnansweredScreeningQuestionRequest$Outbound = {
+  vendor_id_or_me: string;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetNextUnansweredScreeningQuestionRequest$outboundSchema:
+  z.ZodType<
+    GetNextUnansweredScreeningQuestionRequest$Outbound,
+    z.ZodTypeDef,
+    GetNextUnansweredScreeningQuestionRequest
+  > = z.object({
+    vendorIdOrMe: z.string(),
+    expand: z.array(components.Expand$outboundSchema).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      vendorIdOrMe: "vendor_id_or_me",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetNextUnansweredScreeningQuestionRequest$ {
+  /** @deprecated use `GetNextUnansweredScreeningQuestionRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    GetNextUnansweredScreeningQuestionRequest$inboundSchema;
+  /** @deprecated use `GetNextUnansweredScreeningQuestionRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    GetNextUnansweredScreeningQuestionRequest$outboundSchema;
+  /** @deprecated use `GetNextUnansweredScreeningQuestionRequest$Outbound` instead. */
+  export type Outbound = GetNextUnansweredScreeningQuestionRequest$Outbound;
+}
+
+export function getNextUnansweredScreeningQuestionRequestToJSON(
+  getNextUnansweredScreeningQuestionRequest:
+    GetNextUnansweredScreeningQuestionRequest,
+): string {
+  return JSON.stringify(
+    GetNextUnansweredScreeningQuestionRequest$outboundSchema.parse(
+      getNextUnansweredScreeningQuestionRequest,
+    ),
+  );
+}
+
+export function getNextUnansweredScreeningQuestionRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetNextUnansweredScreeningQuestionRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetNextUnansweredScreeningQuestionRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetNextUnansweredScreeningQuestionRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetNextUnansweredScreeningQuestionResponseBody$inboundSchema:
+  z.ZodType<
+    GetNextUnansweredScreeningQuestionResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    screening_question: z.nullable(components.ScreeningQuestion$inboundSchema),
+    screening_response: z.nullable(components.ScreeningResponse$inboundSchema),
+    success: z.boolean(),
+  }).transform((v) => {
+    return remap$(v, {
+      "screening_question": "screeningQuestion",
+      "screening_response": "screeningResponse",
+    });
+  });
+
+/** @internal */
+export type GetNextUnansweredScreeningQuestionResponseBody$Outbound = {
+  screening_question: components.ScreeningQuestion$Outbound | null;
+  screening_response: components.ScreeningResponse$Outbound | null;
+  success: boolean;
+};
+
+/** @internal */
+export const GetNextUnansweredScreeningQuestionResponseBody$outboundSchema:
+  z.ZodType<
+    GetNextUnansweredScreeningQuestionResponseBody$Outbound,
+    z.ZodTypeDef,
+    GetNextUnansweredScreeningQuestionResponseBody
+  > = z.object({
+    screeningQuestion: z.nullable(components.ScreeningQuestion$outboundSchema),
+    screeningResponse: z.nullable(components.ScreeningResponse$outboundSchema),
+    success: z.boolean(),
+  }).transform((v) => {
+    return remap$(v, {
+      screeningQuestion: "screening_question",
+      screeningResponse: "screening_response",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetNextUnansweredScreeningQuestionResponseBody$ {
+  /** @deprecated use `GetNextUnansweredScreeningQuestionResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetNextUnansweredScreeningQuestionResponseBody$inboundSchema;
+  /** @deprecated use `GetNextUnansweredScreeningQuestionResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetNextUnansweredScreeningQuestionResponseBody$outboundSchema;
+  /** @deprecated use `GetNextUnansweredScreeningQuestionResponseBody$Outbound` instead. */
+  export type Outbound =
+    GetNextUnansweredScreeningQuestionResponseBody$Outbound;
+}
+
+export function getNextUnansweredScreeningQuestionResponseBodyToJSON(
+  getNextUnansweredScreeningQuestionResponseBody:
+    GetNextUnansweredScreeningQuestionResponseBody,
+): string {
+  return JSON.stringify(
+    GetNextUnansweredScreeningQuestionResponseBody$outboundSchema.parse(
+      getNextUnansweredScreeningQuestionResponseBody,
+    ),
+  );
+}
+
+export function getNextUnansweredScreeningQuestionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetNextUnansweredScreeningQuestionResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetNextUnansweredScreeningQuestionResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetNextUnansweredScreeningQuestionResponseBody' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -28,6 +28,7 @@ export * from "./deletevendormanagedbycompany.js";
 export * from "./expeditetimeremaining.js";
 export * from "./getfacility.js";
 export * from "./getfhirconfig.js";
+export * from "./getnextunansweredscreeningquestion.js";
 export * from "./getsecurityzone.js";
 export * from "./getsubscription.js";
 export * from "./getsupportarticle.js";

package/src/react-query/index.ts

@@ -60,6 +60,7 @@ export * from "./vendorsDeclineVendorCredential.js";
 export * from "./vendorsDeleteVendorCredentialFile.js";
 export * from "./vendorsDeleteVendorManagedByCompany.js";
 export * from "./vendorsExpediteTimeRemaining.js";
+export * from "./vendorsGetNextUnansweredScreeningQuestion.js";
 export * from "./vendorsGetSubscription.js";
 export * from "./vendorsGetVendorCredentialDetails.js";
 export * from "./vendorsGetVendorCredentialFile.js";

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,
+    ));
+  }
 }