@greensecurity/javascript-sdk 0.43.1-beta.28 → 0.43.1-beta.30

package/src/models/components/vendorscanscreeningquestion.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VendorScanScreeningAnswer,
+  VendorScanScreeningAnswer$inboundSchema,
+} from "./vendorscanscreeninganswer.js";
+
+/**
+ * The display format for presenting this question.
+ */
+export const PresetDisplayAs = {
+  FloatingButtons: "floating buttons",
+  LineButtons: "line buttons",
+  Radio: "radio",
+  Select: "select",
+  Checkbox: "checkbox",
+  Checkbox2Column: "checkbox (2-column)",
+} as const;
+/**
+ * The display format for presenting this question.
+ */
+export type PresetDisplayAs = OpenEnum<typeof PresetDisplayAs>;
+
+/**
+ * Reduced set of attributes for a screening question, used in vendor_scan context. Contains only the fields required for rendering the next question in the vendor screening workflow.
+ *
+ * @remarks
+ */
+export type VendorScanScreeningQuestion = {
+  /**
+   * The unique ID of the screening question.
+   */
+  id: number;
+  /**
+   * The text of the screening question.
+   */
+  question?: string | null | undefined;
+  /**
+   * The display format for presenting this question.
+   */
+  presetDisplayAs?: PresetDisplayAs | null | undefined;
+  /**
+   * The ID of the screening answer selected by default, if any.
+   *
+   * @remarks
+   */
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * The list of possible answers for this question.
+   */
+  screeningAnswers?: Array<VendorScanScreeningAnswer> | undefined;
+};
+
+/** @internal */
+export const PresetDisplayAs$inboundSchema: z.ZodType<
+  PresetDisplayAs,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PresetDisplayAs);
+
+/** @internal */
+export const VendorScanScreeningQuestion$inboundSchema: z.ZodType<
+  VendorScanScreeningQuestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  question: z.nullable(types.string()).optional(),
+  preset_display_as: z.nullable(PresetDisplayAs$inboundSchema).optional(),
+  screening_answer_id: z.nullable(types.number()).optional(),
+  screening_answers: types.optional(
+    z.array(VendorScanScreeningAnswer$inboundSchema),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "preset_display_as": "presetDisplayAs",
+    "screening_answer_id": "screeningAnswerId",
+    "screening_answers": "screeningAnswers",
+  });
+});
+
+export function vendorScanScreeningQuestionFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorScanScreeningQuestion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorScanScreeningQuestion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanScreeningQuestion' from JSON`,
+  );
+}

package/src/models/operations/getnextscreeningquestion.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetNextScreeningQuestionRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * 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;
+  /**
+   * Vendor ID to use when a company manager is making the request.
+   *
+   * @remarks
+   * If omitted, the system falls back to the logged-in vendor.
+   */
+  vendorId?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetNextScreeningQuestionResponseBody = {
+  success?: boolean | undefined;
+  question?: components.VendorScanScreeningQuestion | null | undefined;
+};
+
+/** @internal */
+export type GetNextScreeningQuestionRequest$Outbound = {
+  id: number;
+  expand?: Array<string> | undefined;
+  vendor_id?: number | undefined;
+};
+
+/** @internal */
+export const GetNextScreeningQuestionRequest$outboundSchema: z.ZodType<
+  GetNextScreeningQuestionRequest$Outbound,
+  z.ZodTypeDef,
+  GetNextScreeningQuestionRequest
+> = z.object({
+  id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  vendorId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    vendorId: "vendor_id",
+  });
+});
+
+export function getNextScreeningQuestionRequestToJSON(
+  getNextScreeningQuestionRequest: GetNextScreeningQuestionRequest,
+): string {
+  return JSON.stringify(
+    GetNextScreeningQuestionRequest$outboundSchema.parse(
+      getNextScreeningQuestionRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetNextScreeningQuestionResponseBody$inboundSchema: z.ZodType<
+  GetNextScreeningQuestionResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.optional(types.boolean()),
+  question: z.nullable(components.VendorScanScreeningQuestion$inboundSchema)
+    .optional(),
+});
+
+export function getNextScreeningQuestionResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetNextScreeningQuestionResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetNextScreeningQuestionResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetNextScreeningQuestionResponseBody' 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 "./getnextscreeningquestion.js";
 export * from "./getnextunansweredscreeningquestion.js";
 export * from "./getsecurityzone.js";
 export * from "./getsubscription.js";
@@ -78,6 +79,7 @@ export * from "./purchasescrubcredits.js";
 export * from "./rotateapikey.js";
 export * from "./securityzonecheckin.js";
 export * from "./senddownloadcode.js";
+export * from "./submitscreeningresponse.js";
 export * from "./submitvendorcredential.js";
 export * from "./updatedatarequest.js";
 export * from "./updateevent.js";

package/src/models/operations/securityzonecheckin.ts

@@ -81,6 +81,25 @@ export const Requires = {
 } as const;
 export type Requires = ClosedEnum<typeof Requires>;
 
+/**
+ * Reduced list of attributes of Handoff record
+ */
+export type HandoffHandoff = {
+  id?: number | undefined;
+  /**
+   * Reduced list of attributes of Zone record
+   */
+  zone?: components.Zone | undefined;
+  qrCode?: string | null | undefined;
+  dateCreated?: string | null | undefined;
+  dateReceived?: string | null | undefined;
+  dateCompleted?: string | null | undefined;
+  status?: string | null | undefined;
+  gpsCheckin?: boolean | undefined;
+};
+
+export type Handoff = HandoffHandoff | number;
+
 export type Results = {
   hasValidPaymentProfile?: boolean | undefined;
   subscriptionExpires?: string | null | undefined;
@@ -110,10 +129,7 @@ export type Results = {
 export type SecurityZoneCheckinSecurityZoneCheckinOk = {
   success?: boolean | undefined;
   requires?: Requires | undefined;
-  /**
-   * Reduced list of attributes of Handoff record
-   */
-  handoff?: components.Handoff | null | undefined;
+  handoff?: HandoffHandoff | number | null | undefined;
   results?: Results | undefined;
 };
 
@@ -278,6 +294,54 @@ export function securityZoneCheckinRequestBodyToJSON(
 export const Requires$inboundSchema: z.ZodNativeEnum<typeof Requires> = z
   .nativeEnum(Requires);
 
+/** @internal */
+export const HandoffHandoff$inboundSchema: z.ZodType<
+  HandoffHandoff,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  zone: types.optional(components.Zone$inboundSchema),
+  qr_code: z.nullable(types.string()).optional(),
+  date_created: z.nullable(types.string()).optional(),
+  date_received: z.nullable(types.string()).optional(),
+  date_completed: z.nullable(types.string()).optional(),
+  status: z.nullable(types.string()).optional(),
+  gps_checkin: types.optional(types.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "qr_code": "qrCode",
+    "date_created": "dateCreated",
+    "date_received": "dateReceived",
+    "date_completed": "dateCompleted",
+    "gps_checkin": "gpsCheckin",
+  });
+});
+
+export function handoffHandoffFromJSON(
+  jsonString: string,
+): SafeParseResult<HandoffHandoff, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HandoffHandoff$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HandoffHandoff' from JSON`,
+  );
+}
+
+/** @internal */
+export const Handoff$inboundSchema: z.ZodType<Handoff, z.ZodTypeDef, unknown> =
+  smartUnion([z.lazy(() => HandoffHandoff$inboundSchema), types.number()]);
+
+export function handoffFromJSON(
+  jsonString: string,
+): SafeParseResult<Handoff, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Handoff$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Handoff' from JSON`,
+  );
+}
+
 /** @internal */
 export const Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown> =
   z.object({
@@ -334,7 +398,9 @@ export const SecurityZoneCheckinSecurityZoneCheckinOk$inboundSchema: z.ZodType<
 > = z.object({
   success: types.optional(types.boolean()),
   requires: types.optional(Requires$inboundSchema),
-  handoff: z.nullable(components.Handoff$inboundSchema).optional(),
+  handoff: z.nullable(
+    smartUnion([z.lazy(() => HandoffHandoff$inboundSchema), types.number()]),
+  ).optional(),
   results: types.optional(z.lazy(() => Results$inboundSchema)),
 });
 

package/src/models/operations/submitscreeningresponse.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SubmitScreeningResponseRequestBody = {
+  /**
+   * ID of the screening question being answered.
+   */
+  screeningQuestionId: number;
+  /**
+   * ID of the selected screening answer for single-select questions.
+   */
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * IDs of the selected screening answers for multi-select questions.
+   *
+   * @remarks
+   */
+  multipleScreeningAnswerIds?: Array<number> | null | undefined;
+  /**
+   * Optional vendor ID. Used when the authenticated user is a company manager submitting a response on behalf of a vendor
+   *
+   * @remarks
+   */
+  vendorId?: number | null | undefined;
+  /**
+   * Custom free-text answer for questions that accept typed input.
+   */
+  customAnswer?: string | null | undefined;
+};
+
+export type SubmitScreeningResponseRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  requestBody: SubmitScreeningResponseRequestBody;
+};
+
+/**
+ * Response returned after a screening question answer is submitted.
+ *
+ * @remarks
+ */
+export type SubmitScreeningResponseResponseBody = {
+  success?: boolean | undefined;
+  /**
+   * Indicates whether there is another unanswered screening question available, assuming triggered actions do not stop the flow.
+   *
+   * @remarks
+   */
+  hasNextQuestion?: boolean | undefined;
+  /**
+   * List of actions triggered by this screening response. Present only when there is no next question (i.e., `has_next_question` is false).
+   *
+   * @remarks
+   */
+  triggeredActions?:
+    | Array<components.ScreeningAnswerActionSummary>
+    | null
+    | undefined;
+};
+
+/** @internal */
+export type SubmitScreeningResponseRequestBody$Outbound = {
+  screening_question_id: number;
+  screening_answer_id?: number | null | undefined;
+  multiple_screening_answer_ids?: Array<number> | null | undefined;
+  vendor_id?: number | null | undefined;
+  custom_answer?: string | null | undefined;
+};
+
+/** @internal */
+export const SubmitScreeningResponseRequestBody$outboundSchema: z.ZodType<
+  SubmitScreeningResponseRequestBody$Outbound,
+  z.ZodTypeDef,
+  SubmitScreeningResponseRequestBody
+> = z.object({
+  screeningQuestionId: z.number().int(),
+  screeningAnswerId: z.nullable(z.number().int()).optional(),
+  multipleScreeningAnswerIds: z.nullable(z.array(z.number().int())).optional(),
+  vendorId: z.nullable(z.number().int()).optional(),
+  customAnswer: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    screeningQuestionId: "screening_question_id",
+    screeningAnswerId: "screening_answer_id",
+    multipleScreeningAnswerIds: "multiple_screening_answer_ids",
+    vendorId: "vendor_id",
+    customAnswer: "custom_answer",
+  });
+});
+
+export function submitScreeningResponseRequestBodyToJSON(
+  submitScreeningResponseRequestBody: SubmitScreeningResponseRequestBody,
+): string {
+  return JSON.stringify(
+    SubmitScreeningResponseRequestBody$outboundSchema.parse(
+      submitScreeningResponseRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type SubmitScreeningResponseRequest$Outbound = {
+  id: number;
+  RequestBody: SubmitScreeningResponseRequestBody$Outbound;
+};
+
+/** @internal */
+export const SubmitScreeningResponseRequest$outboundSchema: z.ZodType<
+  SubmitScreeningResponseRequest$Outbound,
+  z.ZodTypeDef,
+  SubmitScreeningResponseRequest
+> = z.object({
+  id: z.number().int(),
+  requestBody: z.lazy(() => SubmitScreeningResponseRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+export function submitScreeningResponseRequestToJSON(
+  submitScreeningResponseRequest: SubmitScreeningResponseRequest,
+): string {
+  return JSON.stringify(
+    SubmitScreeningResponseRequest$outboundSchema.parse(
+      submitScreeningResponseRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const SubmitScreeningResponseResponseBody$inboundSchema: z.ZodType<
+  SubmitScreeningResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.optional(types.boolean()),
+  has_next_question: types.optional(types.boolean()),
+  triggered_actions: z.nullable(
+    z.array(components.ScreeningAnswerActionSummary$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_next_question": "hasNextQuestion",
+    "triggered_actions": "triggeredActions",
+  });
+});
+
+export function submitScreeningResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SubmitScreeningResponseResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubmitScreeningResponseResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubmitScreeningResponseResponseBody' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -49,6 +49,8 @@ export * from "./vendorsAcceptVendorCredential.js";
 export * from "./vendorsAddVendorCredentialFile.js";
 export * from "./vendorsAddVendorManagedByCompany.js";
 export * from "./vendorsCalculateSubscriptionPrice.js";
+export * from "./vendorScansGetNextScreeningQuestion.js";
+export * from "./vendorScansSubmitScreeningResponse.js";
 export * from "./vendorScansVendorScanOut.js";
 export * from "./vendorsChangeSubscription.js";
 export * from "./vendorsCheckDownloadCode.js";

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

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansGetNextScreeningQuestion } from "../funcs/vendorScansGetNextScreeningQuestion.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";
+export type VendorScansGetNextScreeningQuestionQueryData =
+  operations.GetNextScreeningQuestionResponseBody;
+
+export function prefetchVendorScansGetNextScreeningQuestion(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansGetNextScreeningQuestionQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansGetNextScreeningQuestionQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansGetNextScreeningQuestionQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansGetNextScreeningQuestion(request.id, {
+      expand: request.expand,
+      vendorId: request.vendorId,
+    }),
+    queryFn: async function vendorScansGetNextScreeningQuestionQueryFn(
+      ctx,
+    ): Promise<VendorScansGetNextScreeningQuestionQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansGetNextScreeningQuestion(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansGetNextScreeningQuestion(
+  id: number,
+  parameters: {
+    expand?: Array<components.Expand> | undefined;
+    vendorId?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "getNextScreeningQuestion",
+    id,
+    parameters,
+  ];
+}