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

package/src/models/components/vendorscan.ts

@@ -9,8 +9,17 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { smartUnion } from "../../types/smartUnion.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AppointmentSummary,
+  AppointmentSummary$inboundSchema,
+} from "./appointmentsummary.js";
+import { Company, Company$inboundSchema } from "./company.js";
 import { Department, Department$inboundSchema } from "./department.js";
 import { Vendor, Vendor$inboundSchema } from "./vendor.js";
+import {
+  VendorScanScreeningResponse,
+  VendorScanScreeningResponse$inboundSchema,
+} from "./vendorscanscreeningresponse.js";
 import { Zone, Zone$inboundSchema } from "./zone.js";
 
 export type VendorScanVendor = Vendor | number;
@@ -19,6 +28,16 @@ export type VendorScanZone = Zone | number;
 
 export type VendorScanDepartment = Department | number;
 
+/**
+ * The company captured at scan time. Returns the full Company object when requested via the `vendor_scan.company` expand scope, otherwise returns the company ID.
+ */
+export type VendorScanCompany = Company | number;
+
+/**
+ * The appointment associated with this scan. Returns a reduced Event object when requested via the `vendor_scan.appointment` expand scope, otherwise returns the event ID.
+ */
+export type Appointment = AppointmentSummary | number;
+
 /**
  * Reduced list of attributes of VendorScan record
  */
@@ -31,9 +50,35 @@ export type VendorScan = {
   scanSuccess?: boolean | undefined;
   scanType?: number | null | undefined;
   notes?: string | null | undefined;
+  /**
+   * Free-text department name entered by the vendor when no department was selected. Displayed as "Other: <value>" in the legacy UI.
+   */
+  departmentOther?: string | null | undefined;
+  /**
+   * Whether the scan result was overridden.
+   */
+  override?: boolean | undefined;
+  /**
+   * Whether the scan is marked as ignored.
+   */
+  ignore?: boolean | undefined;
+  visitPurpose?: string | null | undefined;
+  visitContact?: string | null | undefined;
+  /**
+   * Estimated checkout time (ISO 8601 datetime).
+   */
+  checkoutTime?: string | null | undefined;
   vendor?: Vendor | number | undefined;
   zone?: Zone | number | undefined;
   department?: Department | number | null | undefined;
+  /**
+   * The company captured at scan time. Returns the full Company object when requested via the `vendor_scan.company` expand scope, otherwise returns the company ID.
+   */
+  company?: Company | number | null | undefined;
+  /**
+   * The appointment associated with this scan. Returns a reduced Event object when requested via the `vendor_scan.appointment` expand scope, otherwise returns the event ID.
+   */
+  appointment?: AppointmentSummary | number | null | undefined;
   departmentEventId?: number | null | undefined;
   facilityEventId?: number | null | undefined;
   scanInVendorScanId?: number | null | undefined;
@@ -46,6 +91,10 @@ export type VendorScan = {
    * Smart badge LED payload data. Only present when requested via the `vendor_scan.badge_data` expand scope.
    */
   badgeData?: string | null | undefined;
+  /**
+   * Screening question responses for this scan. Only present when requested via the `vendor_scan.screening_responses` expand scope.
+   */
+  screeningResponses?: Array<VendorScanScreeningResponse> | null | undefined;
 };
 
 /** @internal */
@@ -99,6 +148,40 @@ export function vendorScanDepartmentFromJSON(
   );
 }
 
+/** @internal */
+export const VendorScanCompany$inboundSchema: z.ZodType<
+  VendorScanCompany,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([Company$inboundSchema, types.number()]);
+
+export function vendorScanCompanyFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorScanCompany, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorScanCompany$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanCompany' from JSON`,
+  );
+}
+
+/** @internal */
+export const Appointment$inboundSchema: z.ZodType<
+  Appointment,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([AppointmentSummary$inboundSchema, types.number()]);
+
+export function appointmentFromJSON(
+  jsonString: string,
+): SafeParseResult<Appointment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Appointment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Appointment' from JSON`,
+  );
+}
+
 /** @internal */
 export const VendorScan$inboundSchema: z.ZodType<
   VendorScan,
@@ -113,10 +196,21 @@ export const VendorScan$inboundSchema: z.ZodType<
   scan_success: types.optional(types.boolean()),
   scan_type: z.nullable(types.number()).optional(),
   notes: z.nullable(types.string()).optional(),
+  department_other: z.nullable(types.string()).optional(),
+  override: types.optional(types.boolean()),
+  ignore: types.optional(types.boolean()),
+  visit_purpose: z.nullable(types.string()).optional(),
+  visit_contact: z.nullable(types.string()).optional(),
+  checkout_time: z.nullable(types.string()).optional(),
   vendor: types.optional(smartUnion([Vendor$inboundSchema, types.number()])),
   zone: types.optional(smartUnion([Zone$inboundSchema, types.number()])),
   department: z.nullable(smartUnion([Department$inboundSchema, types.number()]))
     .optional(),
+  company: z.nullable(smartUnion([Company$inboundSchema, types.number()]))
+    .optional(),
+  appointment: z.nullable(
+    smartUnion([AppointmentSummary$inboundSchema, types.number()]),
+  ).optional(),
   department_event_id: z.nullable(types.number()).optional(),
   facility_event_id: z.nullable(types.number()).optional(),
   scan_in_vendor_scan_id: z.nullable(types.number()).optional(),
@@ -126,6 +220,9 @@ export const VendorScan$inboundSchema: z.ZodType<
   requires_screening_questions: types.optional(types.boolean()),
   recheck: types.optional(types.boolean()),
   badge_data: z.nullable(types.string()).optional(),
+  screening_responses: z.nullable(
+    z.array(VendorScanScreeningResponse$inboundSchema),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "qr_code": "qrCode",
@@ -133,6 +230,10 @@ export const VendorScan$inboundSchema: z.ZodType<
     "scan_error": "scanError",
     "scan_success": "scanSuccess",
     "scan_type": "scanType",
+    "department_other": "departmentOther",
+    "visit_purpose": "visitPurpose",
+    "visit_contact": "visitContact",
+    "checkout_time": "checkoutTime",
     "department_event_id": "departmentEventId",
     "facility_event_id": "facilityEventId",
     "scan_in_vendor_scan_id": "scanInVendorScanId",
@@ -141,6 +242,7 @@ export const VendorScan$inboundSchema: z.ZodType<
     "finished_screening_questions": "finishedScreeningQuestions",
     "requires_screening_questions": "requiresScreeningQuestions",
     "badge_data": "badgeData",
+    "screening_responses": "screeningResponses",
   });
 });
 

package/src/models/components/vendorscanscreeningresponse.ts

@@ -0,0 +1,61 @@
+/*
+ * 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";
+
+/**
+ * A screening question response associated with a vendor scan.
+ */
+export type VendorScanScreeningResponse = {
+  id: number;
+  screeningQuestionId?: number | null | undefined;
+  /**
+   * The text of the screening question.
+   */
+  question?: string | null | undefined;
+  screeningAnswerId?: number | null | undefined;
+  /**
+   * The selected or entered answer. Returns custom_answer if provided, otherwise the preset answer text.
+   */
+  answer?: string | null | undefined;
+  /**
+   * Free-text answer entered by the vendor, if applicable.
+   */
+  customAnswer?: string | null | undefined;
+};
+
+/** @internal */
+export const VendorScanScreeningResponse$inboundSchema: z.ZodType<
+  VendorScanScreeningResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  screening_question_id: z.nullable(types.number()).optional(),
+  question: z.nullable(types.string()).optional(),
+  screening_answer_id: z.nullable(types.number()).optional(),
+  answer: z.nullable(types.string()).optional(),
+  custom_answer: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "screening_question_id": "screeningQuestionId",
+    "screening_answer_id": "screeningAnswerId",
+    "custom_answer": "customAnswer",
+  });
+});
+
+export function vendorScanScreeningResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorScanScreeningResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorScanScreeningResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanScreeningResponse' from JSON`,
+  );
+}

package/src/models/operations/createcompanytargetfacility.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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateCompanyTargetFacilityRequestBody = {
+  /**
+   * The existing facility to target.
+   */
+  facilityId: number;
+};
+
+export type CreateCompanyTargetFacilityRequest = {
+  /**
+   * The company that will target the facility.
+   */
+  companyId: 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;
+  requestBody: CreateCompanyTargetFacilityRequestBody;
+};
+
+/**
+ * The CompanyTargetFacility link was created.
+ */
+export type CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk = {
+  /**
+   * Describes the facilities that a company would like to do business with. These are called "target facilities" for the company. A company may target/untarget any number of facilities which will kick off the process of becoming compliant with that facility's vendor policies.
+   */
+  companyTargetFacility: components.CompanyTargetFacility;
+};
+
+/** @internal */
+export type CreateCompanyTargetFacilityRequestBody$Outbound = {
+  facility_id: number;
+};
+
+/** @internal */
+export const CreateCompanyTargetFacilityRequestBody$outboundSchema: z.ZodType<
+  CreateCompanyTargetFacilityRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateCompanyTargetFacilityRequestBody
+> = z.object({
+  facilityId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    facilityId: "facility_id",
+  });
+});
+
+export function createCompanyTargetFacilityRequestBodyToJSON(
+  createCompanyTargetFacilityRequestBody:
+    CreateCompanyTargetFacilityRequestBody,
+): string {
+  return JSON.stringify(
+    CreateCompanyTargetFacilityRequestBody$outboundSchema.parse(
+      createCompanyTargetFacilityRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateCompanyTargetFacilityRequest$Outbound = {
+  company_id: number;
+  expand?: Array<string> | undefined;
+  RequestBody: CreateCompanyTargetFacilityRequestBody$Outbound;
+};
+
+/** @internal */
+export const CreateCompanyTargetFacilityRequest$outboundSchema: z.ZodType<
+  CreateCompanyTargetFacilityRequest$Outbound,
+  z.ZodTypeDef,
+  CreateCompanyTargetFacilityRequest
+> = z.object({
+  companyId: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  requestBody: z.lazy(() =>
+    CreateCompanyTargetFacilityRequestBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    requestBody: "RequestBody",
+  });
+});
+
+export function createCompanyTargetFacilityRequestToJSON(
+  createCompanyTargetFacilityRequest: CreateCompanyTargetFacilityRequest,
+): string {
+  return JSON.stringify(
+    CreateCompanyTargetFacilityRequest$outboundSchema.parse(
+      createCompanyTargetFacilityRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk$inboundSchema:
+  z.ZodType<
+    CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    company_target_facility: components.CompanyTargetFacility$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "company_target_facility": "companyTargetFacility",
+    });
+  });
+
+export function createCompanyTargetFacilityCreateCompanyTargetFacilityOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk' from JSON`,
+  );
+}

package/src/models/operations/createinvoice.ts

@@ -111,7 +111,7 @@ export type RequestBodyLines = {
   paymentHandlerData?: string | undefined;
 };
 
-export type RequestBody2 = {
+export type CreateInvoiceRequestBody2 = {
   companyId: number;
   lines?: Array<RequestBodyLines> | undefined;
   credentialPricingIds?: Array<number> | null | undefined;
@@ -143,7 +143,7 @@ export type RequestBody1 = {
 
 export type CreateInvoiceRequestBody =
   | RequestBody1
-  | RequestBody2
+  | CreateInvoiceRequestBody2
   | Three
   | Four
   | Five;
@@ -473,17 +473,17 @@ export function requestBodyLinesToJSON(
 }
 
 /** @internal */
-export type RequestBody2$Outbound = {
+export type CreateInvoiceRequestBody2$Outbound = {
   company_id: number;
   lines?: Array<RequestBodyLines$Outbound> | undefined;
   credential_pricing_ids?: Array<number> | null | undefined;
 };
 
 /** @internal */
-export const RequestBody2$outboundSchema: z.ZodType<
-  RequestBody2$Outbound,
+export const CreateInvoiceRequestBody2$outboundSchema: z.ZodType<
+  CreateInvoiceRequestBody2$Outbound,
   z.ZodTypeDef,
-  RequestBody2
+  CreateInvoiceRequestBody2
 > = z.object({
   companyId: z.number().int(),
   lines: z.array(z.lazy(() => RequestBodyLines$outboundSchema)).optional(),
@@ -495,8 +495,12 @@ export const RequestBody2$outboundSchema: z.ZodType<
   });
 });
 
-export function requestBody2ToJSON(requestBody2: RequestBody2): string {
-  return JSON.stringify(RequestBody2$outboundSchema.parse(requestBody2));
+export function createInvoiceRequestBody2ToJSON(
+  createInvoiceRequestBody2: CreateInvoiceRequestBody2,
+): string {
+  return JSON.stringify(
+    CreateInvoiceRequestBody2$outboundSchema.parse(createInvoiceRequestBody2),
+  );
 }
 
 /** @internal */
@@ -580,7 +584,7 @@ export function requestBody1ToJSON(requestBody1: RequestBody1): string {
 /** @internal */
 export type CreateInvoiceRequestBody$Outbound =
   | RequestBody1$Outbound
-  | RequestBody2$Outbound
+  | CreateInvoiceRequestBody2$Outbound
   | Three$Outbound
   | Four$Outbound
   | Five$Outbound;
@@ -592,7 +596,7 @@ export const CreateInvoiceRequestBody$outboundSchema: z.ZodType<
   CreateInvoiceRequestBody
 > = smartUnion([
   z.lazy(() => RequestBody1$outboundSchema),
-  z.lazy(() => RequestBody2$outboundSchema),
+  z.lazy(() => CreateInvoiceRequestBody2$outboundSchema),
   z.lazy(() => Three$outboundSchema),
   z.lazy(() => Four$outboundSchema),
   z.lazy(() => Five$outboundSchema),

package/src/models/operations/deletecompanytargetfacility.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type DeleteCompanyTargetFacilityRequest = {
+  /**
+   * The company that owns the CompanyTargetFacility link.
+   */
+  companyId: number;
+  /**
+   * CompanyTargetFacility id
+   */
+  id: number;
+};
+
+/** @internal */
+export type DeleteCompanyTargetFacilityRequest$Outbound = {
+  company_id: number;
+  id: number;
+};
+
+/** @internal */
+export const DeleteCompanyTargetFacilityRequest$outboundSchema: z.ZodType<
+  DeleteCompanyTargetFacilityRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteCompanyTargetFacilityRequest
+> = z.object({
+  companyId: z.number().int(),
+  id: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+  });
+});
+
+export function deleteCompanyTargetFacilityRequestToJSON(
+  deleteCompanyTargetFacilityRequest: DeleteCompanyTargetFacilityRequest,
+): string {
+  return JSON.stringify(
+    DeleteCompanyTargetFacilityRequest$outboundSchema.parse(
+      deleteCompanyTargetFacilityRequest,
+    ),
+  );
+}

package/src/models/operations/downloadcompanytargetfacilitiesexport.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 DownloadCompanyTargetFacilitiesExportRequest = {
+  /**
+   * The company whose export is being downloaded.
+   */
+  companyId: number;
+  /**
+   * Export id returned by the export endpoint (e.g. `ctf_export_42`).
+   */
+  id: string;
+};
+
+/**
+ * Export is still being generated
+ */
+export type DownloadCompanyTargetFacilitiesExportResponseBody = {
+  /**
+   * Always `false` when returned by this endpoint.
+   */
+  ready?: boolean | undefined;
+  /**
+   * Human-readable message about the export status.
+   */
+  message?: string | undefined;
+};
+
+export type DownloadCompanyTargetFacilitiesExportResponse = {
+  headers: { [k: string]: Array<string> };
+  result?: DownloadCompanyTargetFacilitiesExportResponseBody | undefined;
+};
+
+/** @internal */
+export type DownloadCompanyTargetFacilitiesExportRequest$Outbound = {
+  company_id: number;
+  id: string;
+};
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportRequest$outboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportRequest$Outbound,
+    z.ZodTypeDef,
+    DownloadCompanyTargetFacilitiesExportRequest
+  > = z.object({
+    companyId: z.number().int(),
+    id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      companyId: "company_id",
+    });
+  });
+
+export function downloadCompanyTargetFacilitiesExportRequestToJSON(
+  downloadCompanyTargetFacilitiesExportRequest:
+    DownloadCompanyTargetFacilitiesExportRequest,
+): string {
+  return JSON.stringify(
+    DownloadCompanyTargetFacilitiesExportRequest$outboundSchema.parse(
+      downloadCompanyTargetFacilitiesExportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    ready: types.optional(types.boolean()),
+    message: types.optional(types.string()),
+  });
+
+export function downloadCompanyTargetFacilitiesExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadCompanyTargetFacilitiesExportResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadCompanyTargetFacilitiesExportResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportResponse$inboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: types.optional(
+      z.lazy(() =>
+        DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema
+      ),
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function downloadCompanyTargetFacilitiesExportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadCompanyTargetFacilitiesExportResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadCompanyTargetFacilitiesExportResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadCompanyTargetFacilitiesExportResponse' from JSON`,
+  );
+}