@greensecurity/javascript-sdk 0.44.0-beta.6 → 0.44.0-beta.60

package/src/models/operations/exportfacilityvendors.ts

@@ -0,0 +1,206 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+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";
+
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export const ExportFacilityVendorsQueryParamStatus = {
+  Approved: "approved",
+  Pending: "pending",
+  Denied: "denied",
+} as const;
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export type ExportFacilityVendorsQueryParamStatus = ClosedEnum<
+  typeof ExportFacilityVendorsQueryParamStatus
+>;
+
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+ */
+export const ExportFacilityVendorsQueryParamSort = {
+  Id: "id",
+  Name: "name",
+  LastName: "last_name",
+  Email: "email",
+  Status: "status",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+ */
+export type ExportFacilityVendorsQueryParamSort = ClosedEnum<
+  typeof ExportFacilityVendorsQueryParamSort
+>;
+
+export const QueryParam2 = {
+  Zero: 0,
+  One: 1,
+} as const;
+export type QueryParam2 = ClosedEnum<typeof QueryParam2>;
+
+/**
+ * Sort descending flag.
+ */
+export type QueryParamDesc = boolean | QueryParam2;
+
+export type ExportFacilityVendorsRequest = {
+  /**
+   * The facility whose vendors to export.
+   */
+  id: number;
+  /**
+   * API users only — the company whose vendors to export. Ignored for company managers / vendors (resolved from the session).
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter rows to a single facility access status. Omit for "All".
+   */
+  status?: ExportFacilityVendorsQueryParamStatus | undefined;
+  /**
+   * Single search term applied case-insensitively across first name, last name, full
+   *
+   * @remarks
+   * name, email, and any company custom-field value the vendor has set for a field
+   * flagged `show_to_vendor`.
+   */
+  search?: string | undefined;
+  /**
+   * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+   */
+  sort?: ExportFacilityVendorsQueryParamSort | undefined;
+  /**
+   * Sort descending flag.
+   */
+  desc?: boolean | QueryParam2 | undefined;
+  /**
+   * Page size used by the exporter while paginating results server-side. Does not affect the size of the CSV (all matching rows are included).
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * Export request accepted and job enqueued.
+ */
+export type ExportFacilityVendorsResponseBody = {
+  /**
+   * URL to poll for export status.
+   */
+  statusUrl: string;
+  /**
+   * URL to download the exported file when ready.
+   */
+  downloadUrl: string;
+  /**
+   * Status token used to check the export status.
+   */
+  statusId: string;
+};
+
+/** @internal */
+export const ExportFacilityVendorsQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ExportFacilityVendorsQueryParamStatus> = z.nativeEnum(
+    ExportFacilityVendorsQueryParamStatus,
+  );
+
+/** @internal */
+export const ExportFacilityVendorsQueryParamSort$outboundSchema:
+  z.ZodNativeEnum<typeof ExportFacilityVendorsQueryParamSort> = z.nativeEnum(
+    ExportFacilityVendorsQueryParamSort,
+  );
+
+/** @internal */
+export const QueryParam2$outboundSchema: z.ZodNativeEnum<typeof QueryParam2> = z
+  .nativeEnum(QueryParam2);
+
+/** @internal */
+export type QueryParamDesc$Outbound = boolean | number;
+
+/** @internal */
+export const QueryParamDesc$outboundSchema: z.ZodType<
+  QueryParamDesc$Outbound,
+  z.ZodTypeDef,
+  QueryParamDesc
+> = smartUnion([z.boolean(), QueryParam2$outboundSchema]);
+
+export function queryParamDescToJSON(queryParamDesc: QueryParamDesc): string {
+  return JSON.stringify(QueryParamDesc$outboundSchema.parse(queryParamDesc));
+}
+
+/** @internal */
+export type ExportFacilityVendorsRequest$Outbound = {
+  id: number;
+  company_id?: number | undefined;
+  status?: string | undefined;
+  search?: string | undefined;
+  sort?: string | undefined;
+  desc?: boolean | number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ExportFacilityVendorsRequest$outboundSchema: z.ZodType<
+  ExportFacilityVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ExportFacilityVendorsRequest
+> = z.object({
+  id: z.number().int(),
+  companyId: z.number().int().optional(),
+  status: ExportFacilityVendorsQueryParamStatus$outboundSchema.optional(),
+  search: z.string().optional(),
+  sort: ExportFacilityVendorsQueryParamSort$outboundSchema.optional(),
+  desc: smartUnion([z.boolean(), QueryParam2$outboundSchema]).optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function exportFacilityVendorsRequestToJSON(
+  exportFacilityVendorsRequest: ExportFacilityVendorsRequest,
+): string {
+  return JSON.stringify(
+    ExportFacilityVendorsRequest$outboundSchema.parse(
+      exportFacilityVendorsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ExportFacilityVendorsResponseBody$inboundSchema: z.ZodType<
+  ExportFacilityVendorsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_url: types.string(),
+  download_url: types.string(),
+  status_id: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_url": "statusUrl",
+    "download_url": "downloadUrl",
+    "status_id": "statusId",
+  });
+});
+
+export function exportFacilityVendorsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ExportFacilityVendorsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExportFacilityVendorsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExportFacilityVendorsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/exportvendorscans.ts

@@ -0,0 +1,163 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import * as components from "../components/index.js";
+
+/**
+ * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+ *
+ * @remarks
+ * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+ */
+export const ExportVendorScansQueryParamSort = {
+  FullName: "full_name",
+  DateScanned: "date_scanned",
+  Result: "result",
+  ScanType: "scan_type",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+ *
+ * @remarks
+ * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+ */
+export type ExportVendorScansQueryParamSort = ClosedEnum<
+  typeof ExportVendorScansQueryParamSort
+>;
+
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export const QueryParamScanType = {
+  In: "in",
+  Out: "out",
+  SpotCheck: "spot_check",
+} as const;
+/**
+ * Filter by scan type. One of: `in`, `out`, `spot_check`.
+ */
+export type QueryParamScanType = ClosedEnum<typeof QueryParamScanType>;
+
+export type ExportVendorScansRequest = {
+  /**
+   * Sort field used by the exporter when ordering rows in the generated CSV. One of:
+   *
+   * @remarks
+   * `full_name`, `date_scanned`, `result`, `scan_type`. Defaults to `date_scanned`.
+   */
+  sort?: ExportVendorScansQueryParamSort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * Page size used by the exporter while paginating results server-side. Does not affect the size of the CSV (all matching rows are included).
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * An ID representing a Hospital
+   */
+  facilityId?: number | undefined;
+  /**
+   * An ID representing a Hospital System
+   */
+  systemId?: number | undefined;
+  /**
+   * Filter scans by company ID.
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter scans by vendor ID, or pass `me` to use the currently authenticated vendor.
+   */
+  vendorId?: string | undefined;
+  /**
+   * Filter by scan type. One of: `in`, `out`, `spot_check`.
+   */
+  scanType?: QueryParamScanType | undefined;
+  /**
+   * Filter by individual full name (case-insensitive, partial match).
+   */
+  fullNameLike?: string | undefined;
+  /**
+   * Filter scans on or after this date. Format: YYYY-MM-DD.
+   */
+  dateScannedGte?: string | undefined;
+  /**
+   * Filter scans on or before this date. Format: YYYY-MM-DD.
+   */
+  dateScannedLte?: string | undefined;
+  /**
+   * Filter by scan result. `true` for successful scans, `false` for failed.
+   */
+  result?: boolean | undefined;
+};
+
+/** @internal */
+export const ExportVendorScansQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ExportVendorScansQueryParamSort
+> = z.nativeEnum(ExportVendorScansQueryParamSort);
+
+/** @internal */
+export const QueryParamScanType$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamScanType
+> = z.nativeEnum(QueryParamScanType);
+
+/** @internal */
+export type ExportVendorScansRequest$Outbound = {
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  items_per_page?: number | undefined;
+  facility_id?: number | undefined;
+  system_id?: number | undefined;
+  company_id?: number | undefined;
+  vendor_id?: string | undefined;
+  scan_type?: string | undefined;
+  full_name_like?: string | undefined;
+  date_scanned_gte?: string | undefined;
+  date_scanned_lte?: string | undefined;
+  result?: boolean | undefined;
+};
+
+/** @internal */
+export const ExportVendorScansRequest$outboundSchema: z.ZodType<
+  ExportVendorScansRequest$Outbound,
+  z.ZodTypeDef,
+  ExportVendorScansRequest
+> = z.object({
+  sort: ExportVendorScansQueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  itemsPerPage: z.number().int().optional(),
+  facilityId: z.number().int().optional(),
+  systemId: z.number().int().optional(),
+  companyId: z.number().int().optional(),
+  vendorId: z.string().optional(),
+  scanType: QueryParamScanType$outboundSchema.optional(),
+  fullNameLike: z.string().optional(),
+  dateScannedGte: z.string().optional(),
+  dateScannedLte: z.string().optional(),
+  result: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    facilityId: "facility_id",
+    systemId: "system_id",
+    companyId: "company_id",
+    vendorId: "vendor_id",
+    scanType: "scan_type",
+    fullNameLike: "full_name_like",
+    dateScannedGte: "date_scanned_gte",
+    dateScannedLte: "date_scanned_lte",
+  });
+});
+
+export function exportVendorScansRequestToJSON(
+  exportVendorScansRequest: ExportVendorScansRequest,
+): string {
+  return JSON.stringify(
+    ExportVendorScansRequest$outboundSchema.parse(exportVendorScansRequest),
+  );
+}

package/src/models/operations/getcompanytargetfacilitiesexportstatus.ts

@@ -0,0 +1,126 @@
+/*
+ * 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 GetCompanyTargetFacilitiesExportStatusRequest = {
+  /**
+   * The company whose export is being polled.
+   */
+  companyId: number;
+  /**
+   * Export status id returned by the export endpoint (e.g. `ctf_export_42`).
+   */
+  id: string;
+};
+
+/**
+ * Export status
+ */
+export type GetCompanyTargetFacilitiesExportStatusResponseBody = {
+  /**
+   * When true, the export is ready for download.
+   */
+  ready: boolean;
+  /**
+   * The export job identifier.
+   */
+  statusId: string;
+  /**
+   * URL to download the CSV (present only when `ready` is true).
+   */
+  downloadUrl?: string | undefined;
+  /**
+   * When the export job completed.
+   */
+  finishedAt?: string | undefined;
+  /**
+   * When the export job started.
+   */
+  startedAt?: string | undefined;
+  /**
+   * Timestamp of the last progress heartbeat from the background job. Updated on each pagination loop while the job is running; on completion or failure it equals `finished_at`.
+   */
+  heartbeat?: string | undefined;
+  /**
+   * Error message if the export failed.
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export type GetCompanyTargetFacilitiesExportStatusRequest$Outbound = {
+  company_id: number;
+  id: string;
+};
+
+/** @internal */
+export const GetCompanyTargetFacilitiesExportStatusRequest$outboundSchema:
+  z.ZodType<
+    GetCompanyTargetFacilitiesExportStatusRequest$Outbound,
+    z.ZodTypeDef,
+    GetCompanyTargetFacilitiesExportStatusRequest
+  > = z.object({
+    companyId: z.number().int(),
+    id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      companyId: "company_id",
+    });
+  });
+
+export function getCompanyTargetFacilitiesExportStatusRequestToJSON(
+  getCompanyTargetFacilitiesExportStatusRequest:
+    GetCompanyTargetFacilitiesExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetCompanyTargetFacilitiesExportStatusRequest$outboundSchema.parse(
+      getCompanyTargetFacilitiesExportStatusRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetCompanyTargetFacilitiesExportStatusResponseBody$inboundSchema:
+  z.ZodType<
+    GetCompanyTargetFacilitiesExportStatusResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    ready: types.boolean(),
+    status_id: types.string(),
+    download_url: types.optional(types.string()),
+    finished_at: types.optional(types.string()),
+    started_at: types.optional(types.string()),
+    heartbeat: types.optional(types.string()),
+    error: types.optional(types.string()),
+  }).transform((v) => {
+    return remap$(v, {
+      "status_id": "statusId",
+      "download_url": "downloadUrl",
+      "finished_at": "finishedAt",
+      "started_at": "startedAt",
+    });
+  });
+
+export function getCompanyTargetFacilitiesExportStatusResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCompanyTargetFacilitiesExportStatusResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCompanyTargetFacilitiesExportStatusResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCompanyTargetFacilitiesExportStatusResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getfacilityvendorsexportstatus.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 GetFacilityVendorsExportStatusRequest = {
+  /**
+   * The facility whose export is being polled.
+   */
+  id: number;
+  /**
+   * Export status id returned by the export endpoint (e.g. `fv_export_42`).
+   */
+  exportId: string;
+};
+
+/** @internal */
+export type GetFacilityVendorsExportStatusRequest$Outbound = {
+  id: number;
+  export_id: string;
+};
+
+/** @internal */
+export const GetFacilityVendorsExportStatusRequest$outboundSchema: z.ZodType<
+  GetFacilityVendorsExportStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetFacilityVendorsExportStatusRequest
+> = z.object({
+  id: z.number().int(),
+  exportId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    exportId: "export_id",
+  });
+});
+
+export function getFacilityVendorsExportStatusRequestToJSON(
+  getFacilityVendorsExportStatusRequest: GetFacilityVendorsExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetFacilityVendorsExportStatusRequest$outboundSchema.parse(
+      getFacilityVendorsExportStatusRequest,
+    ),
+  );
+}

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