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

package/src/models/components/screeninganswer.ts

@@ -0,0 +1,195 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ScreeningQuestion,
+  ScreeningQuestion$inboundSchema,
+  ScreeningQuestion$Outbound,
+  ScreeningQuestion$outboundSchema,
+} from "./screeningquestion.js";
+
+/**
+ * The type of answer option.
+ */
+export const AnswerType = {
+  Preset: "preset",
+  Date: "date",
+  ShortAnswer: "short answer",
+  LongAnswer: "long answer",
+} as const;
+/**
+ * The type of answer option.
+ */
+export type AnswerType = ClosedEnum<typeof AnswerType>;
+
+/**
+ * Reduced list of attributes of ScreeningAnswer records
+ */
+export type ScreeningAnswer = {
+  id: number;
+  screeningQuestionId?: number | null | undefined;
+  /**
+   * The content of the screening answer option.
+   */
+  answer?: string | null | undefined;
+  /**
+   * The type of answer option.
+   */
+  answerType?: AnswerType | null | undefined;
+  /**
+   * The title or label for the answer input field.
+   */
+  answerTitle?: string | null | undefined;
+  /**
+   * Whether or not to allow an empty answer for this option.
+   */
+  allowEmptyAnswer: boolean;
+  /**
+   * The error message to display if an empty answer is submitted when not allowed.
+   */
+  emptyAnswerErrorMessage?: string | null | undefined;
+  /**
+   * Whether or not to show a confirmation prompt when this answer is selected.
+   */
+  showConfirmation: boolean;
+  /**
+   * The text to display in the confirmation prompt.
+   */
+  confirmationText?: string | null | undefined;
+  priority?: number | null | undefined;
+  screeningQuestions?: Array<ScreeningQuestion> | null | undefined;
+};
+
+/** @internal */
+export const AnswerType$inboundSchema: z.ZodNativeEnum<typeof AnswerType> = z
+  .nativeEnum(AnswerType);
+
+/** @internal */
+export const AnswerType$outboundSchema: z.ZodNativeEnum<typeof AnswerType> =
+  AnswerType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AnswerType$ {
+  /** @deprecated use `AnswerType$inboundSchema` instead. */
+  export const inboundSchema = AnswerType$inboundSchema;
+  /** @deprecated use `AnswerType$outboundSchema` instead. */
+  export const outboundSchema = AnswerType$outboundSchema;
+}
+
+/** @internal */
+export const ScreeningAnswer$inboundSchema: z.ZodType<
+  ScreeningAnswer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  screening_question_id: z.nullable(z.number().int()).optional(),
+  answer: z.nullable(z.string()).optional(),
+  answer_type: z.nullable(AnswerType$inboundSchema).optional(),
+  answer_title: z.nullable(z.string()).optional(),
+  allow_empty_answer: z.boolean(),
+  empty_answer_error_message: z.nullable(z.string()).optional(),
+  show_confirmation: z.boolean(),
+  confirmation_text: z.nullable(z.string()).optional(),
+  priority: z.nullable(z.number().int()).optional(),
+  screening_questions: z.nullable(
+    z.array(z.lazy(() => ScreeningQuestion$inboundSchema)),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "screening_question_id": "screeningQuestionId",
+    "answer_type": "answerType",
+    "answer_title": "answerTitle",
+    "allow_empty_answer": "allowEmptyAnswer",
+    "empty_answer_error_message": "emptyAnswerErrorMessage",
+    "show_confirmation": "showConfirmation",
+    "confirmation_text": "confirmationText",
+    "screening_questions": "screeningQuestions",
+  });
+});
+
+/** @internal */
+export type ScreeningAnswer$Outbound = {
+  id: number;
+  screening_question_id?: number | null | undefined;
+  answer?: string | null | undefined;
+  answer_type?: string | null | undefined;
+  answer_title?: string | null | undefined;
+  allow_empty_answer: boolean;
+  empty_answer_error_message?: string | null | undefined;
+  show_confirmation: boolean;
+  confirmation_text?: string | null | undefined;
+  priority?: number | null | undefined;
+  screening_questions?: Array<ScreeningQuestion$Outbound> | null | undefined;
+};
+
+/** @internal */
+export const ScreeningAnswer$outboundSchema: z.ZodType<
+  ScreeningAnswer$Outbound,
+  z.ZodTypeDef,
+  ScreeningAnswer
+> = z.object({
+  id: z.number().int(),
+  screeningQuestionId: z.nullable(z.number().int()).optional(),
+  answer: z.nullable(z.string()).optional(),
+  answerType: z.nullable(AnswerType$outboundSchema).optional(),
+  answerTitle: z.nullable(z.string()).optional(),
+  allowEmptyAnswer: z.boolean(),
+  emptyAnswerErrorMessage: z.nullable(z.string()).optional(),
+  showConfirmation: z.boolean(),
+  confirmationText: z.nullable(z.string()).optional(),
+  priority: z.nullable(z.number().int()).optional(),
+  screeningQuestions: z.nullable(
+    z.array(z.lazy(() => ScreeningQuestion$outboundSchema)),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    screeningQuestionId: "screening_question_id",
+    answerType: "answer_type",
+    answerTitle: "answer_title",
+    allowEmptyAnswer: "allow_empty_answer",
+    emptyAnswerErrorMessage: "empty_answer_error_message",
+    showConfirmation: "show_confirmation",
+    confirmationText: "confirmation_text",
+    screeningQuestions: "screening_questions",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ScreeningAnswer$ {
+  /** @deprecated use `ScreeningAnswer$inboundSchema` instead. */
+  export const inboundSchema = ScreeningAnswer$inboundSchema;
+  /** @deprecated use `ScreeningAnswer$outboundSchema` instead. */
+  export const outboundSchema = ScreeningAnswer$outboundSchema;
+  /** @deprecated use `ScreeningAnswer$Outbound` instead. */
+  export type Outbound = ScreeningAnswer$Outbound;
+}
+
+export function screeningAnswerToJSON(
+  screeningAnswer: ScreeningAnswer,
+): string {
+  return JSON.stringify(ScreeningAnswer$outboundSchema.parse(screeningAnswer));
+}
+
+export function screeningAnswerFromJSON(
+  jsonString: string,
+): SafeParseResult<ScreeningAnswer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScreeningAnswer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScreeningAnswer' from JSON`,
+  );
+}

package/src/models/components/screeningquestion.ts

@@ -0,0 +1,163 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ScreeningAnswer,
+  ScreeningAnswer$inboundSchema,
+  ScreeningAnswer$Outbound,
+  ScreeningAnswer$outboundSchema,
+} from "./screeninganswer.js";
+
+/**
+ * The display format for the 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 the question.
+ */
+export type PresetDisplayAs = ClosedEnum<typeof PresetDisplayAs>;
+
+/**
+ * Reduced list of attributes of ScreeningQuestion record
+ */
+export type ScreeningQuestion = {
+  id: number;
+  screeningQuestionSeriesId: number;
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * The order for displaying the question relative to other questions in the same series. Questions with lower priority values should be shown first.
+   */
+  priority?: number | null | undefined;
+  /**
+   * The content of the screening question to be presented.
+   */
+  question?: string | null | undefined;
+  /**
+   * The display format for the question.
+   */
+  presetDisplayAs?: PresetDisplayAs | null | undefined;
+  screeningAnswers?: Array<ScreeningAnswer> | undefined;
+};
+
+/** @internal */
+export const PresetDisplayAs$inboundSchema: z.ZodNativeEnum<
+  typeof PresetDisplayAs
+> = z.nativeEnum(PresetDisplayAs);
+
+/** @internal */
+export const PresetDisplayAs$outboundSchema: z.ZodNativeEnum<
+  typeof PresetDisplayAs
+> = PresetDisplayAs$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PresetDisplayAs$ {
+  /** @deprecated use `PresetDisplayAs$inboundSchema` instead. */
+  export const inboundSchema = PresetDisplayAs$inboundSchema;
+  /** @deprecated use `PresetDisplayAs$outboundSchema` instead. */
+  export const outboundSchema = PresetDisplayAs$outboundSchema;
+}
+
+/** @internal */
+export const ScreeningQuestion$inboundSchema: z.ZodType<
+  ScreeningQuestion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  screening_question_series_id: z.number().int(),
+  screening_answer_id: z.nullable(z.number().int()).optional(),
+  priority: z.nullable(z.number().int()).optional(),
+  question: z.nullable(z.string()).optional(),
+  preset_display_as: z.nullable(PresetDisplayAs$inboundSchema).optional(),
+  screening_answers: z.array(z.lazy(() => ScreeningAnswer$inboundSchema))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "screening_question_series_id": "screeningQuestionSeriesId",
+    "screening_answer_id": "screeningAnswerId",
+    "preset_display_as": "presetDisplayAs",
+    "screening_answers": "screeningAnswers",
+  });
+});
+
+/** @internal */
+export type ScreeningQuestion$Outbound = {
+  id: number;
+  screening_question_series_id: number;
+  screening_answer_id?: number | null | undefined;
+  priority?: number | null | undefined;
+  question?: string | null | undefined;
+  preset_display_as?: string | null | undefined;
+  screening_answers?: Array<ScreeningAnswer$Outbound> | undefined;
+};
+
+/** @internal */
+export const ScreeningQuestion$outboundSchema: z.ZodType<
+  ScreeningQuestion$Outbound,
+  z.ZodTypeDef,
+  ScreeningQuestion
+> = z.object({
+  id: z.number().int(),
+  screeningQuestionSeriesId: z.number().int(),
+  screeningAnswerId: z.nullable(z.number().int()).optional(),
+  priority: z.nullable(z.number().int()).optional(),
+  question: z.nullable(z.string()).optional(),
+  presetDisplayAs: z.nullable(PresetDisplayAs$outboundSchema).optional(),
+  screeningAnswers: z.array(z.lazy(() => ScreeningAnswer$outboundSchema))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    screeningQuestionSeriesId: "screening_question_series_id",
+    screeningAnswerId: "screening_answer_id",
+    presetDisplayAs: "preset_display_as",
+    screeningAnswers: "screening_answers",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ScreeningQuestion$ {
+  /** @deprecated use `ScreeningQuestion$inboundSchema` instead. */
+  export const inboundSchema = ScreeningQuestion$inboundSchema;
+  /** @deprecated use `ScreeningQuestion$outboundSchema` instead. */
+  export const outboundSchema = ScreeningQuestion$outboundSchema;
+  /** @deprecated use `ScreeningQuestion$Outbound` instead. */
+  export type Outbound = ScreeningQuestion$Outbound;
+}
+
+export function screeningQuestionToJSON(
+  screeningQuestion: ScreeningQuestion,
+): string {
+  return JSON.stringify(
+    ScreeningQuestion$outboundSchema.parse(screeningQuestion),
+  );
+}
+
+export function screeningQuestionFromJSON(
+  jsonString: string,
+): SafeParseResult<ScreeningQuestion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScreeningQuestion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScreeningQuestion' from JSON`,
+  );
+}

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";