@greensecurity/javascript-sdk 0.44.0-beta.2 → 0.44.0-beta.21

package/src/models/operations/exportcompanytargetfacilities.ts

@@ -0,0 +1,248 @@
+/*
+ * 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 by link status.
+ */
+export const QueryParamStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Denied: "denied",
+} as const;
+/**
+ * Filter by link status.
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export const QueryParamHasIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export type QueryParamHasIndividual = ClosedEnum<
+  typeof QueryParamHasIndividual
+>;
+
+/**
+ * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+ */
+export const QueryParamHasActiveIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+ */
+export type QueryParamHasActiveIndividual = ClosedEnum<
+  typeof QueryParamHasActiveIndividual
+>;
+
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+ */
+export const ExportCompanyTargetFacilitiesQueryParamSort = {
+  Id: "id",
+  FacilityName: "facility_name",
+  Status: "status",
+  DateCreated: "date_created",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+ */
+export type ExportCompanyTargetFacilitiesQueryParamSort = ClosedEnum<
+  typeof ExportCompanyTargetFacilitiesQueryParamSort
+>;
+
+export const Two = {
+  Zero: 0,
+  One: 1,
+} as const;
+export type Two = ClosedEnum<typeof Two>;
+
+/**
+ * Sort descending flag.
+ */
+export type Desc = boolean | Two;
+
+export type ExportCompanyTargetFacilitiesRequest = {
+  /**
+   * The company whose target facilities to export.
+   */
+  companyId: number;
+  /**
+   * Filter by link status.
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+   */
+  hasIndividual?: QueryParamHasIndividual | undefined;
+  /**
+   * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+   */
+  hasActiveIndividual?: QueryParamHasActiveIndividual | undefined;
+  /**
+   * Case-insensitive partial match on facility name.
+   */
+  facilityNameLike?: string | undefined;
+  /**
+   * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+   */
+  sort?: ExportCompanyTargetFacilitiesQueryParamSort | undefined;
+  /**
+   * Sort descending flag.
+   */
+  desc?: boolean | Two | 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 ExportCompanyTargetFacilitiesResponseBody = {
+  /**
+   * 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 QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const QueryParamHasIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamHasIndividual
+> = z.nativeEnum(QueryParamHasIndividual);
+
+/** @internal */
+export const QueryParamHasActiveIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamHasActiveIndividual
+> = z.nativeEnum(QueryParamHasActiveIndividual);
+
+/** @internal */
+export const ExportCompanyTargetFacilitiesQueryParamSort$outboundSchema:
+  z.ZodNativeEnum<typeof ExportCompanyTargetFacilitiesQueryParamSort> = z
+    .nativeEnum(ExportCompanyTargetFacilitiesQueryParamSort);
+
+/** @internal */
+export const Two$outboundSchema: z.ZodNativeEnum<typeof Two> = z.nativeEnum(
+  Two,
+);
+
+/** @internal */
+export type Desc$Outbound = boolean | number;
+
+/** @internal */
+export const Desc$outboundSchema: z.ZodType<Desc$Outbound, z.ZodTypeDef, Desc> =
+  smartUnion([z.boolean(), Two$outboundSchema]);
+
+export function descToJSON(desc: Desc): string {
+  return JSON.stringify(Desc$outboundSchema.parse(desc));
+}
+
+/** @internal */
+export type ExportCompanyTargetFacilitiesRequest$Outbound = {
+  company_id: number;
+  status?: string | undefined;
+  has_individual?: string | undefined;
+  has_active_individual?: string | undefined;
+  facility_name_like?: string | undefined;
+  sort?: string | undefined;
+  desc?: boolean | number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ExportCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
+  ExportCompanyTargetFacilitiesRequest$Outbound,
+  z.ZodTypeDef,
+  ExportCompanyTargetFacilitiesRequest
+> = z.object({
+  companyId: z.number().int(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  hasIndividual: QueryParamHasIndividual$outboundSchema.optional(),
+  hasActiveIndividual: QueryParamHasActiveIndividual$outboundSchema.optional(),
+  facilityNameLike: z.string().optional(),
+  sort: ExportCompanyTargetFacilitiesQueryParamSort$outboundSchema.optional(),
+  desc: smartUnion([z.boolean(), Two$outboundSchema]).optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    hasIndividual: "has_individual",
+    hasActiveIndividual: "has_active_individual",
+    facilityNameLike: "facility_name_like",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function exportCompanyTargetFacilitiesRequestToJSON(
+  exportCompanyTargetFacilitiesRequest: ExportCompanyTargetFacilitiesRequest,
+): string {
+  return JSON.stringify(
+    ExportCompanyTargetFacilitiesRequest$outboundSchema.parse(
+      exportCompanyTargetFacilitiesRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ExportCompanyTargetFacilitiesResponseBody$inboundSchema: z.ZodType<
+  ExportCompanyTargetFacilitiesResponseBody,
+  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 exportCompanyTargetFacilitiesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ExportCompanyTargetFacilitiesResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ExportCompanyTargetFacilitiesResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ExportCompanyTargetFacilitiesResponseBody' from JSON`,
+  );
+}

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