@greensecurity/javascript-sdk 0.40.8-beta.3 → 0.40.8-beta.31

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/components/userlocation.ts

@@ -8,7 +8,6 @@ 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 { State, State$inboundSchema, State$outboundSchema } from "./state.js";
 
 export const Timezone = {
   InternationalDateLineWest: "International Date Line West",
@@ -173,10 +172,7 @@ export type UserLocation = {
   address1?: string | null | undefined;
   address2?: string | null | undefined;
   city?: string | null | undefined;
-  /**
-   * The list of states
-   */
-  state?: State | null | undefined;
+  state?: string | null | undefined;
   zip?: string | null | undefined;
   phone?: string | null | undefined;
   mobilePhone?: string | null | undefined;
@@ -214,7 +210,7 @@ export const UserLocation$inboundSchema: z.ZodType<
   address1: z.nullable(z.string()).optional(),
   address2: z.nullable(z.string()).optional(),
   city: z.nullable(z.string()).optional(),
-  state: z.nullable(State$inboundSchema).optional(),
+  state: z.nullable(z.string()).optional(),
   zip: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   mobile_phone: z.nullable(z.string()).optional(),
@@ -252,7 +248,7 @@ export const UserLocation$outboundSchema: z.ZodType<
   address1: z.nullable(z.string()).optional(),
   address2: z.nullable(z.string()).optional(),
   city: z.nullable(z.string()).optional(),
-  state: z.nullable(State$outboundSchema).optional(),
+  state: z.nullable(z.string()).optional(),
   zip: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   mobilePhone: z.nullable(z.string()).optional(),

package/src/models/components/vendor.ts

@@ -25,6 +25,12 @@ import {
   Facility$Outbound,
   Facility$outboundSchema,
 } from "./facility.js";
+import {
+  FacilityCalendarSummary,
+  FacilityCalendarSummary$inboundSchema,
+  FacilityCalendarSummary$Outbound,
+  FacilityCalendarSummary$outboundSchema,
+} from "./facilitycalendarsummary.js";
 import {
   FacilitySummary,
   FacilitySummary$inboundSchema,
@@ -170,6 +176,7 @@ export type Vendor = {
   emailRecepient?: string | null | undefined;
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
+  hasEmeraldStatus?: boolean | null | undefined;
   user?: One | number | undefined;
   registrationData?: { [k: string]: any } | null | undefined;
   registrationFinished?: boolean | null | undefined;
@@ -220,10 +227,14 @@ export type Vendor = {
   backgroundCheckDateExpires?: string | null | undefined;
   creditBalance?: number | null | undefined;
   targetFacilities?: Array<FacilitySummary> | null | undefined;
-  approvedCalendaringFacilities?: Array<FacilitySummary> | null | undefined;
+  approvedCalendaringFacilities?:
+    | Array<FacilityCalendarSummary>
+    | null
+    | undefined;
   pendingInvoice?: Invoice | number | null | undefined;
   vendorGroups?: Array<VendorGroup | null> | null | undefined;
   hasCredentialedFacilities?: boolean | null | undefined;
+  targetFacilitiesUpdated?: string | null | undefined;
 };
 
 /** @internal */
@@ -1046,6 +1057,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     email_recepient: z.nullable(z.string()).optional(),
     send_weekly_summary_email: z.nullable(z.boolean()).optional(),
     title: z.nullable(z.string()).optional(),
+    has_emerald_status: z.nullable(z.boolean()).optional(),
     user: z.union([z.lazy(() => One$inboundSchema), z.number().int()])
       .optional(),
     registration_data: z.nullable(z.record(z.any())).optional(),
@@ -1089,7 +1101,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     target_facilities: z.nullable(z.array(FacilitySummary$inboundSchema))
       .optional(),
     approved_calendaring_facilities: z.nullable(
-      z.array(FacilitySummary$inboundSchema),
+      z.array(FacilityCalendarSummary$inboundSchema),
     ).optional(),
     pending_invoice: z.nullable(
       z.union([Invoice$inboundSchema, z.number().int()]),
@@ -1097,10 +1109,12 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     vendor_groups: z.nullable(z.array(z.nullable(VendorGroup$inboundSchema)))
       .optional(),
     has_credentialed_facilities: z.nullable(z.boolean()).optional(),
+    target_facilities_updated: z.nullable(z.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "email_recepient": "emailRecepient",
       "send_weekly_summary_email": "sendWeeklySummaryEmail",
+      "has_emerald_status": "hasEmeraldStatus",
       "registration_data": "registrationData",
       "registration_finished": "registrationFinished",
       "vendor_job": "vendorJob",
@@ -1122,6 +1136,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
       "pending_invoice": "pendingInvoice",
       "vendor_groups": "vendorGroups",
       "has_credentialed_facilities": "hasCredentialedFacilities",
+      "target_facilities_updated": "targetFacilitiesUpdated",
     });
   });
 
@@ -1131,6 +1146,7 @@ export type Vendor$Outbound = {
   email_recepient?: string | null | undefined;
   send_weekly_summary_email?: boolean | null | undefined;
   title?: string | null | undefined;
+  has_emerald_status?: boolean | null | undefined;
   user?: One$Outbound | number | undefined;
   registration_data?: { [k: string]: any } | null | undefined;
   registration_finished?: boolean | null | undefined;
@@ -1158,12 +1174,13 @@ export type Vendor$Outbound = {
   credit_balance?: number | null | undefined;
   target_facilities?: Array<FacilitySummary$Outbound> | null | undefined;
   approved_calendaring_facilities?:
-    | Array<FacilitySummary$Outbound>
+    | Array<FacilityCalendarSummary$Outbound>
     | null
     | undefined;
   pending_invoice?: Invoice$Outbound | number | null | undefined;
   vendor_groups?: Array<VendorGroup$Outbound | null> | null | undefined;
   has_credentialed_facilities?: boolean | null | undefined;
+  target_facilities_updated?: string | null | undefined;
 };
 
 /** @internal */
@@ -1176,6 +1193,7 @@ export const Vendor$outboundSchema: z.ZodType<
   emailRecepient: z.nullable(z.string()).optional(),
   sendWeeklySummaryEmail: z.nullable(z.boolean()).optional(),
   title: z.nullable(z.string()).optional(),
+  hasEmeraldStatus: z.nullable(z.boolean()).optional(),
   user: z.union([z.lazy(() => One$outboundSchema), z.number().int()])
     .optional(),
   registrationData: z.nullable(z.record(z.any())).optional(),
@@ -1217,7 +1235,7 @@ export const Vendor$outboundSchema: z.ZodType<
   targetFacilities: z.nullable(z.array(FacilitySummary$outboundSchema))
     .optional(),
   approvedCalendaringFacilities: z.nullable(
-    z.array(FacilitySummary$outboundSchema),
+    z.array(FacilityCalendarSummary$outboundSchema),
   ).optional(),
   pendingInvoice: z.nullable(
     z.union([Invoice$outboundSchema, z.number().int()]),
@@ -1225,10 +1243,12 @@ export const Vendor$outboundSchema: z.ZodType<
   vendorGroups: z.nullable(z.array(z.nullable(VendorGroup$outboundSchema)))
     .optional(),
   hasCredentialedFacilities: z.nullable(z.boolean()).optional(),
+  targetFacilitiesUpdated: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     emailRecepient: "email_recepient",
     sendWeeklySummaryEmail: "send_weekly_summary_email",
+    hasEmeraldStatus: "has_emerald_status",
     registrationData: "registration_data",
     registrationFinished: "registration_finished",
     vendorJob: "vendor_job",
@@ -1250,6 +1270,7 @@ export const Vendor$outboundSchema: z.ZodType<
     pendingInvoice: "pending_invoice",
     vendorGroups: "vendor_groups",
     hasCredentialedFacilities: "has_credentialed_facilities",
+    targetFacilitiesUpdated: "target_facilities_updated",
   });
 });
 

package/src/models/errors/index.ts

@@ -4,6 +4,7 @@
 
 export * from "./apierror.js";
 export * from "./apierrorresponse.js";
+export * from "./greensecurityerror.js";
 export * from "./httpclienterrors.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";