@greensecurity/javascript-sdk 0.43.1-beta.9 → 0.43.1-beta.90

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/errors/apierrorresponse.ts

@@ -15,7 +15,7 @@ import { GreenSecurityError } from "./greensecurityerror.js";
  */
 export type ApiErrorResponseData = {
   error: string;
-  success: boolean;
+  success?: boolean | undefined;
   code?: number | null | undefined;
 };
 
@@ -28,7 +28,7 @@ export type ApiErrorResponseData = {
  */
 export class ApiErrorResponse extends GreenSecurityError {
   error: string;
-  success: boolean;
+  success?: boolean | undefined;
   code?: number | null | undefined;
 
   /** The original data that was passed to this error instance. */
@@ -44,7 +44,7 @@ export class ApiErrorResponse extends GreenSecurityError {
     super(message, httpMeta);
     this.data$ = err;
     this.error = err.error;
-    this.success = err.success;
+    if (err.success != null) this.success = err.success;
     if (err.code != null) this.code = err.code;
 
     this.name = "ApiErrorResponse";
@@ -58,7 +58,7 @@ export const ApiErrorResponse$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   error: types.string(),
-  success: types.boolean(),
+  success: types.optional(types.boolean()),
   code: z.nullable(types.number()).optional(),
   request$: z.instanceof(Request),
   response$: z.instanceof(Response),

package/src/models/operations/getcompany.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+
+export type GetCompanyRequest = {
+  /**
+   * 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;
+};
+
+/** @internal */
+export type GetCompanyRequest$Outbound = {
+  id: number;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const GetCompanyRequest$outboundSchema: z.ZodType<
+  GetCompanyRequest$Outbound,
+  z.ZodTypeDef,
+  GetCompanyRequest
+> = z.object({
+  id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+});
+
+export function getCompanyRequestToJSON(
+  getCompanyRequest: GetCompanyRequest,
+): string {
+  return JSON.stringify(
+    GetCompanyRequest$outboundSchema.parse(getCompanyRequest),
+  );
+}

package/src/models/operations/getfacility.ts

@@ -3,17 +3,23 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 
 export type GetFacilityRequest = {
   /**
    * 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;
 };
 
 /** @internal */
 export type GetFacilityRequest$Outbound = {
   id: number;
+  expand?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -23,6 +29,7 @@ export const GetFacilityRequest$outboundSchema: z.ZodType<
   GetFacilityRequest
 > = z.object({
   id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
 });
 
 export function getFacilityRequestToJSON(

package/src/models/operations/getlinkedusers.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetLinkedUsersRequest = {
+  /**
+   * The ID of the user to fetch linked users for. Required for API users.
+   */
+  userId?: number | undefined;
+};
+
+export type LinkedUsers = {
+  id: number;
+  firstName?: string | null | undefined;
+  lastName?: string | null | undefined;
+  email: string;
+  userType: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetLinkedUsersGetLinkedUsersOk = {
+  linkedUsers: Array<LinkedUsers>;
+};
+
+/** @internal */
+export type GetLinkedUsersRequest$Outbound = {
+  user_id?: number | undefined;
+};
+
+/** @internal */
+export const GetLinkedUsersRequest$outboundSchema: z.ZodType<
+  GetLinkedUsersRequest$Outbound,
+  z.ZodTypeDef,
+  GetLinkedUsersRequest
+> = z.object({
+  userId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    userId: "user_id",
+  });
+});
+
+export function getLinkedUsersRequestToJSON(
+  getLinkedUsersRequest: GetLinkedUsersRequest,
+): string {
+  return JSON.stringify(
+    GetLinkedUsersRequest$outboundSchema.parse(getLinkedUsersRequest),
+  );
+}
+
+/** @internal */
+export const LinkedUsers$inboundSchema: z.ZodType<
+  LinkedUsers,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  first_name: z.nullable(types.string()).optional(),
+  last_name: z.nullable(types.string()).optional(),
+  email: types.string(),
+  user_type: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "user_type": "userType",
+  });
+});
+
+export function linkedUsersFromJSON(
+  jsonString: string,
+): SafeParseResult<LinkedUsers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LinkedUsers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LinkedUsers' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetLinkedUsersGetLinkedUsersOk$inboundSchema: z.ZodType<
+  GetLinkedUsersGetLinkedUsersOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  linked_users: z.array(z.lazy(() => LinkedUsers$inboundSchema)),
+}).transform((v) => {
+  return remap$(v, {
+    "linked_users": "linkedUsers",
+  });
+});
+
+export function getLinkedUsersGetLinkedUsersOkFromJSON(
+  jsonString: string,
+): SafeParseResult<GetLinkedUsersGetLinkedUsersOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetLinkedUsersGetLinkedUsersOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetLinkedUsersGetLinkedUsersOk' 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

@@ -26,8 +26,11 @@ export * from "./deletefhirconfigbyid.js";
 export * from "./deletevendorcredentialfile.js";
 export * from "./deletevendormanagedbycompany.js";
 export * from "./expeditetimeremaining.js";
+export * from "./getcompany.js";
 export * from "./getfacility.js";
 export * from "./getfhirconfig.js";
+export * from "./getlinkedusers.js";
+export * from "./getnextscreeningquestion.js";
 export * from "./getnextunansweredscreeningquestion.js";
 export * from "./getsecurityzone.js";
 export * from "./getsubscription.js";
@@ -42,7 +45,9 @@ export * from "./getvendorsdetails.js";
 export * from "./getwebhookendpoint.js";
 export * from "./listalerts.js";
 export * from "./listallwebhookendpoints.js";
+export * from "./listcompanymanagers.js";
 export * from "./listfeed.js";
+export * from "./listinvoices.js";
 export * from "./listlocations.js";
 export * from "./listoffhirconfigurations.js";
 export * from "./listorsearchcompanies.js";
@@ -61,6 +66,7 @@ export * from "./listvendorcredentialfiles.js";
 export * from "./listvendorcredentialhistory.js";
 export * from "./listvendorcredentials.js";
 export * from "./listvendorcredits.js";
+export * from "./listvendorcustomfields.js";
 export * from "./listvendorfacilitystatuses.js";
 export * from "./listvendorinvoices.js";
 export * from "./listvendorjobtitles.js";
@@ -78,6 +84,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/listalerts.ts

@@ -26,6 +26,10 @@ export type ListAlertsRequest = {
    * Number of items to show in a given page
    */
   itemsPerPage?: number | undefined;
+  /**
+   * Either the ID of the user rep or the keyword "me" to represent the current user.
+   */
+  userIdOrMe?: string | undefined;
 };
 
 /**
@@ -49,6 +53,7 @@ export type ListAlertsRequest$Outbound = {
   desc?: components.Desc$Outbound | undefined;
   page?: number | undefined;
   items_per_page?: number | undefined;
+  user_id_or_me?: string | undefined;
 };
 
 /** @internal */
@@ -61,9 +66,11 @@ export const ListAlertsRequest$outboundSchema: z.ZodType<
   desc: components.Desc$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
+  userIdOrMe: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
+    userIdOrMe: "user_id_or_me",
   });
 });
 

package/src/models/operations/listcompanymanagers.ts

@@ -0,0 +1,132 @@
+/*
+ * 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 ListCompanyManagersRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListCompanyManagersListCompanyManagersOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.CompanyManager | null>;
+};
+
+export type ListCompanyManagersResponse = {
+  result: ListCompanyManagersListCompanyManagersOk;
+};
+
+/** @internal */
+export type ListCompanyManagersRequest$Outbound = {
+  id: number;
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ListCompanyManagersRequest$outboundSchema: z.ZodType<
+  ListCompanyManagersRequest$Outbound,
+  z.ZodTypeDef,
+  ListCompanyManagersRequest
+> = z.object({
+  id: z.number().int(),
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listCompanyManagersRequestToJSON(
+  listCompanyManagersRequest: ListCompanyManagersRequest,
+): string {
+  return JSON.stringify(
+    ListCompanyManagersRequest$outboundSchema.parse(listCompanyManagersRequest),
+  );
+}
+
+/** @internal */
+export const ListCompanyManagersListCompanyManagersOk$inboundSchema: z.ZodType<
+  ListCompanyManagersListCompanyManagersOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(types.nullable(components.CompanyManager$inboundSchema)),
+});
+
+export function listCompanyManagersListCompanyManagersOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListCompanyManagersListCompanyManagersOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyManagersListCompanyManagersOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListCompanyManagersListCompanyManagersOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCompanyManagersResponse$inboundSchema: z.ZodType<
+  ListCompanyManagersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListCompanyManagersListCompanyManagersOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listCompanyManagersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyManagersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCompanyManagersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyManagersResponse' from JSON`,
+  );
+}