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

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "@greensecurity/javascript-sdk",
-      "version": "0.40.8-beta.21",
+      "version": "0.40.8-beta.22",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.21",
+  "version": "0.40.8-beta.22",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@greensecurity/javascript-sdk",
-  "version": "0.40.8-beta.22",
+  "version": "0.40.8-beta.23",
   "author": "Green Security LLC",
   "type": "module",
   "tshy": {

package/src/__tests__/vendors.test.ts

@@ -954,3 +954,35 @@ test("Vendors Get Vendor Invoice Receipt", async () => {
     base64Pdf: "<value>",
   });
 });
+
+test("Vendors Get Next Unanswered Screening Question", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "getNextUnansweredScreeningQuestion",
+  );
+
+  const greenSecurity = new GreenSecurity({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
+    httpClient: testHttpClient,
+    security: {
+      token: process.env["GREEN_SECURITY_TOKEN"] ?? "value",
+    },
+  });
+
+  const result = await greenSecurity.vendors.getNextUnansweredScreeningQuestion(
+    {
+      vendorIdOrMe: "<value>",
+      expand: [
+        "facility.system",
+      ],
+    },
+  );
+  expect(result).toBeDefined();
+  expect(result).toEqual({
+    screeningQuestion: {
+      id: 395343,
+      screeningQuestionSeriesId: 238185,
+    },
+    screeningResponse: {},
+    success: false,
+  });
+});

package/src/__tests__/webhooks.test.ts

@@ -20,7 +20,7 @@ test("Webhooks List All Webhook Endpoints", async () => {
   const testWebhookListForVendorUserResult = await greenSecurity.webhooks
     .listAllWebhookEndpoints({
       itemsPerPage: 25,
-      desc: true,
+      desc: 0,
       sort: "",
     });
   expect(testWebhookListForVendorUserResult).toBeDefined();

package/src/__tests__/zones.test.ts

@@ -57,9 +57,8 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    longitude: "89.6981",
-    latitude: "68.5943",
-    zoneId: 456404,
+    qrCode: "<value>",
+    zoneId: 544883,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/vendorsGetNextUnansweredScreeningQuestion.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * 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 vendorsGetNextUnansweredScreeningQuestion(
+  client: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetNextUnansweredScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetNextUnansweredScreeningQuestionResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetNextUnansweredScreeningQuestionRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    vendor_id_or_me: encodeSimple("vendor_id_or_me", payload.vendor_id_or_me, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/vendors/{vendor_id_or_me}/screening-questions/next-unanswered-question",
+  )(pathParams);
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getNextUnansweredScreeningQuestion",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetNextUnansweredScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetNextUnansweredScreeningQuestionResponseBody$inboundSchema,
+    ),
+    M.jsonErr([403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -79,9 +79,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.0.4",
-  sdkVersion: "0.40.8-beta.21",
-  genVersion: "2.701.8",
+  openapiDocVersion: "0.0.5",
+  sdkVersion: "0.40.8-beta.22",
+  genVersion: "2.702.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.40.8-beta.21 2.701.8 0.0.4 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.40.8-beta.22 2.702.0 0.0.5 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -89,6 +89,7 @@ export const Expand = {
   SubscriptionExpeditedOffer: "subscription.expedited_offer",
   DepartmentMembershipContact: "department_membership.contact",
   DepartmentMembershipDepartment: "department_membership.department",
+  ScreeningQuestionScreeningAnswers: "screening_question.screening_answers",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.

package/src/models/components/index.ts

@@ -47,6 +47,8 @@ export * from "./product.js";
 export * from "./productvariant.js";
 export * from "./samlloginrequiredresponse.js";
 export * from "./scantype.js";
+export * from "./screeninganswer.js";
+export * from "./screeningquestion.js";
 export * from "./screeningresponse.js";
 export * from "./security.js";
 export * from "./standingappointment.js";

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