@greensecurity/javascript-sdk 0.44.0-beta.56 → 0.44.0-beta.58

package/src/models/components/zone.ts

@@ -98,6 +98,11 @@ export type GpsCheckinPolicy = {
   latitude?: string | null | undefined;
   longitude?: string | null | undefined;
   gpsCheckinRadius?: number | null | undefined;
+  allowGpsCheckout?: boolean | null | undefined;
+  /**
+   * Radius in feet around the zone coordinates used for zone-level automatic GPS check-out.
+   */
+  gpsCheckoutRadius?: number | null | undefined;
   geocodeError?: string | null | undefined;
 };
 
@@ -646,10 +651,14 @@ export const GpsCheckinPolicy$inboundSchema: z.ZodType<
   latitude: z.nullable(types.string()).optional(),
   longitude: z.nullable(types.string()).optional(),
   gps_checkin_radius: z.nullable(types.number()).optional(),
+  allow_gps_checkout: z.nullable(types.boolean()).optional(),
+  gps_checkout_radius: z.nullable(types.number()).optional(),
   geocode_error: z.nullable(types.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "gps_checkin_radius": "gpsCheckinRadius",
+    "allow_gps_checkout": "allowGpsCheckout",
+    "gps_checkout_radius": "gpsCheckoutRadius",
     "geocode_error": "geocodeError",
   });
 });
@@ -658,6 +667,8 @@ export type GpsCheckinPolicy$Outbound = {
   latitude?: string | null | undefined;
   longitude?: string | null | undefined;
   gps_checkin_radius?: number | null | undefined;
+  allow_gps_checkout?: boolean | null | undefined;
+  gps_checkout_radius?: number | null | undefined;
   geocode_error?: string | null | undefined;
 };
 
@@ -670,10 +681,14 @@ export const GpsCheckinPolicy$outboundSchema: z.ZodType<
   latitude: z.nullable(z.string()).optional(),
   longitude: z.nullable(z.string()).optional(),
   gpsCheckinRadius: z.nullable(z.number().int()).optional(),
+  allowGpsCheckout: z.nullable(z.boolean()).optional(),
+  gpsCheckoutRadius: z.nullable(z.number().int()).optional(),
   geocodeError: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     gpsCheckinRadius: "gps_checkin_radius",
+    allowGpsCheckout: "allow_gps_checkout",
+    gpsCheckoutRadius: "gps_checkout_radius",
     geocodeError: "geocode_error",
   });
 });

package/src/models/errors/apivalidationerrorresponse.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as types from "../../types/primitives.js";
+import { GreenSecurityError } from "./greensecurityerror.js";
+
+/**
+ * Returned when path, query or body parameters fail validation, which happens before the endpoint's own logic runs. Note that `error` is an array of field-to-messages objects here, not the plain string carried by `ApiErrorResponse` — a client that models the 422 body must handle both shapes.
+ */
+export type ApiValidationErrorResponseData = {
+  /**
+   * One entry per validated section (path/query parameters, then request body). Each entry maps a field name to the list of messages that field failed on.
+   */
+  error: Array<{ [k: string]: Array<string> }>;
+  success?: boolean | undefined;
+  code?: number | null | undefined;
+};
+
+/**
+ * Returned when path, query or body parameters fail validation, which happens before the endpoint's own logic runs. Note that `error` is an array of field-to-messages objects here, not the plain string carried by `ApiErrorResponse` — a client that models the 422 body must handle both shapes.
+ */
+export class ApiValidationErrorResponse extends GreenSecurityError {
+  /**
+   * One entry per validated section (path/query parameters, then request body). Each entry maps a field name to the list of messages that field failed on.
+   */
+  error: Array<{ [k: string]: Array<string> }>;
+  success?: boolean | undefined;
+  code?: number | null | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ApiValidationErrorResponseData;
+
+  constructor(
+    err: ApiValidationErrorResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+    if (err.success != null) this.success = err.success;
+    if (err.code != null) this.code = err.code;
+
+    this.name = "ApiValidationErrorResponse";
+  }
+}
+
+/** @internal */
+export const ApiValidationErrorResponse$inboundSchema: z.ZodType<
+  ApiValidationErrorResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.array(z.record(z.array(types.string()))),
+  success: types.optional(types.boolean()),
+  code: z.nullable(types.number()).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ApiValidationErrorResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/index.ts

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

package/src/models/errors/unprocessableentityorvalidationerror.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import {
+  ApiErrorResponse,
+  ApiErrorResponse$inboundSchema,
+} from "./apierrorresponse.js";
+import {
+  ApiValidationErrorResponse,
+  ApiValidationErrorResponse$inboundSchema,
+} from "./apivalidationerrorresponse.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * The request could not be processed. Carries either the standard error envelope (a string `error`, used when the endpoint's own logic rejects the request) or the validation envelope (an array of field-to-messages objects, used when a parameter fails validation before the endpoint runs).
+ */
+export type UnprocessableEntityOrValidationError =
+  | ApiErrorResponse
+  | ApiValidationErrorResponse;
+
+/** @internal */
+export const UnprocessableEntityOrValidationError$inboundSchema: z.ZodType<
+  UnprocessableEntityOrValidationError,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([
+  ApiErrorResponse$inboundSchema,
+  ApiValidationErrorResponse$inboundSchema,
+]);
+
+export function unprocessableEntityOrValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<UnprocessableEntityOrValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnprocessableEntityOrValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnprocessableEntityOrValidationError' from JSON`,
+  );
+}

package/src/models/operations/getfullreport.ts

@@ -0,0 +1,159 @@
+/*
+ * 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";
+
+export type GetFullReportRequest = {
+  /**
+   * The report run to look up.
+   */
+  fullReportId: number;
+};
+
+/**
+ * Lifecycle status of the run. A `200` only ever carries `completed`; the
+ *
+ * @remarks
+ * other values are the states a run passes through or ends in, which this
+ * endpoint surfaces as `409` (pending, processing) or `422` (canceled).
+ */
+export const GetFullReportStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Canceled: "canceled",
+} as const;
+/**
+ * Lifecycle status of the run. A `200` only ever carries `completed`; the
+ *
+ * @remarks
+ * other values are the states a run passes through or ends in, which this
+ * endpoint surfaces as `409` (pending, processing) or `422` (canceled).
+ */
+export type GetFullReportStatus = OpenEnum<typeof GetFullReportStatus>;
+
+export type FullReport = {
+  id: number;
+  reportClass: string;
+  dataType: string;
+  dateSubmitted: Date | null;
+  userId: number | null;
+  /**
+   * Lifecycle status of the run. A `200` only ever carries `completed`; the
+   *
+   * @remarks
+   * other values are the states a run passes through or ends in, which this
+   * endpoint surfaces as `409` (pending, processing) or `422` (canceled).
+   */
+  status: GetFullReportStatus;
+  /**
+   * Short-lived signed download URL, valid for 5 minutes.
+   */
+  reportUrl: string;
+};
+
+/**
+ * The report exists and has finished generating.
+ */
+export type GetFullReportGetFullReportOk = {
+  fullReport: FullReport;
+  success: boolean;
+};
+
+/** @internal */
+export type GetFullReportRequest$Outbound = {
+  full_report_id: number;
+};
+
+/** @internal */
+export const GetFullReportRequest$outboundSchema: z.ZodType<
+  GetFullReportRequest$Outbound,
+  z.ZodTypeDef,
+  GetFullReportRequest
+> = z.object({
+  fullReportId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    fullReportId: "full_report_id",
+  });
+});
+
+export function getFullReportRequestToJSON(
+  getFullReportRequest: GetFullReportRequest,
+): string {
+  return JSON.stringify(
+    GetFullReportRequest$outboundSchema.parse(getFullReportRequest),
+  );
+}
+
+/** @internal */
+export const GetFullReportStatus$inboundSchema: z.ZodType<
+  GetFullReportStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetFullReportStatus);
+
+/** @internal */
+export const FullReport$inboundSchema: z.ZodType<
+  FullReport,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  report_class: types.string(),
+  data_type: types.string(),
+  date_submitted: types.nullable(types.date()),
+  user_id: types.nullable(types.number()),
+  status: GetFullReportStatus$inboundSchema,
+  report_url: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "report_class": "reportClass",
+    "data_type": "dataType",
+    "date_submitted": "dateSubmitted",
+    "user_id": "userId",
+    "report_url": "reportUrl",
+  });
+});
+
+export function fullReportFromJSON(
+  jsonString: string,
+): SafeParseResult<FullReport, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FullReport$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FullReport' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetFullReportGetFullReportOk$inboundSchema: z.ZodType<
+  GetFullReportGetFullReportOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  full_report: z.lazy(() => FullReport$inboundSchema),
+  success: types.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "full_report": "fullReport",
+  });
+});
+
+export function getFullReportGetFullReportOkFromJSON(
+  jsonString: string,
+): SafeParseResult<GetFullReportGetFullReportOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetFullReportGetFullReportOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetFullReportGetFullReportOk' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -50,6 +50,7 @@ export * from "./getevent.js";
 export * from "./getfacility.js";
 export * from "./getfacilityvendorsexportstatus.js";
 export * from "./getfhirconfig.js";
+export * from "./getfullreport.js";
 export * from "./getinvoice.js";
 export * from "./getinvoicesexportstatus.js";
 export * from "./getlinkedusers.js";
@@ -72,6 +73,7 @@ export * from "./getvendorsexportstatus.js";
 export * from "./getvendortargetfacilities.js";
 export * from "./getvendoruploadhistory.js";
 export * from "./getwebhookendpoint.js";
+export * from "./initiatescheduledreport.js";
 export * from "./invoicesexport.js";
 export * from "./listalerts.js";
 export * from "./listallwebhookendpoints.js";
@@ -141,5 +143,7 @@ export * from "./updatevendorfield.js";
 export * from "./updatevendormanagedbycompany.js";
 export * from "./updatevendorpaymentresponsibility.js";
 export * from "./updatevendorscrubdetails.js";
+export * from "./vendorscangpscheckoutconfig.js";
+export * from "./vendorscangpsscanout.js";
 export * from "./vendorscanout.js";
 export * from "./vendorsexport.js";

package/src/models/operations/initiatescheduledreport.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 InitiateScheduledReportRequest = {
+  /**
+   * The scheduled report to generate a run for.
+   */
+  scheduledReportId: number;
+};
+
+/**
+ * A new report run was queued for generation.
+ */
+export type InitiateScheduledReportInitiateScheduledReportOk = {
+  /**
+   * URL to poll for the generated report's status via `GET /reports/{full_report_id}`.
+   */
+  pollUrl: string;
+  success: boolean;
+};
+
+/** @internal */
+export type InitiateScheduledReportRequest$Outbound = {
+  scheduled_report_id: number;
+};
+
+/** @internal */
+export const InitiateScheduledReportRequest$outboundSchema: z.ZodType<
+  InitiateScheduledReportRequest$Outbound,
+  z.ZodTypeDef,
+  InitiateScheduledReportRequest
+> = z.object({
+  scheduledReportId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    scheduledReportId: "scheduled_report_id",
+  });
+});
+
+export function initiateScheduledReportRequestToJSON(
+  initiateScheduledReportRequest: InitiateScheduledReportRequest,
+): string {
+  return JSON.stringify(
+    InitiateScheduledReportRequest$outboundSchema.parse(
+      initiateScheduledReportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const InitiateScheduledReportInitiateScheduledReportOk$inboundSchema:
+  z.ZodType<
+    InitiateScheduledReportInitiateScheduledReportOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    poll_url: types.string(),
+    success: types.boolean(),
+  }).transform((v) => {
+    return remap$(v, {
+      "poll_url": "pollUrl",
+    });
+  });
+
+export function initiateScheduledReportInitiateScheduledReportOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  InitiateScheduledReportInitiateScheduledReportOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      InitiateScheduledReportInitiateScheduledReportOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'InitiateScheduledReportInitiateScheduledReportOk' from JSON`,
+  );
+}

package/src/models/operations/vendorscangpscheckoutconfig.ts

@@ -0,0 +1,118 @@
+/*
+ * 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";
+
+export type VendorScanGpsCheckoutConfigRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+};
+
+/**
+ * Which level the geofence came from.
+ */
+export const Level = {
+  Facility: "facility",
+  Zone: "zone",
+} as const;
+/**
+ * Which level the geofence came from.
+ */
+export type Level = OpenEnum<typeof Level>;
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk = {
+  /**
+   * Whether automatic GPS check-out is configured for this scan's location. The remaining fields are null when false.
+   */
+  enabled: boolean;
+  /**
+   * Which level the geofence came from.
+   */
+  level: Level | null;
+  latitude: number | null;
+  longitude: number | null;
+  /**
+   * Geofence radius in feet.
+   */
+  radiusFt: number | null;
+  /**
+   * Name of the facility or zone the vendor is checked in to, for display in the check-out notification.
+   */
+  locationName: string | null;
+};
+
+/** @internal */
+export type VendorScanGpsCheckoutConfigRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const VendorScanGpsCheckoutConfigRequest$outboundSchema: z.ZodType<
+  VendorScanGpsCheckoutConfigRequest$Outbound,
+  z.ZodTypeDef,
+  VendorScanGpsCheckoutConfigRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+export function vendorScanGpsCheckoutConfigRequestToJSON(
+  vendorScanGpsCheckoutConfigRequest: VendorScanGpsCheckoutConfigRequest,
+): string {
+  return JSON.stringify(
+    VendorScanGpsCheckoutConfigRequest$outboundSchema.parse(
+      vendorScanGpsCheckoutConfigRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const Level$inboundSchema: z.ZodType<Level, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Level);
+
+/** @internal */
+export const VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk$inboundSchema:
+  z.ZodType<
+    VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    enabled: types.boolean(),
+    level: types.nullable(Level$inboundSchema),
+    latitude: types.nullable(types.number()),
+    longitude: types.nullable(types.number()),
+    radius_ft: types.nullable(types.number()),
+    location_name: types.nullable(types.string()),
+  }).transform((v) => {
+    return remap$(v, {
+      "radius_ft": "radiusFt",
+      "location_name": "locationName",
+    });
+  });
+
+export function vendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk' from JSON`,
+  );
+}