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

package/src/react-query/vendorScansExportVendorScans.core.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansExportVendorScans } from "../funcs/vendorScansExportVendorScans.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type VendorScansExportVendorScansQueryData =
+  components.CsvExportEnqueuedResponse;
+
+export function prefetchVendorScansExportVendorScans(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ExportVendorScansRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansExportVendorScansQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansExportVendorScansQuery(
+  client$: GreenSecurityCore,
+  request: operations.ExportVendorScansRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansExportVendorScansQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansExportVendorScans({
+      sort: request.sort,
+      desc: request.desc,
+      itemsPerPage: request.itemsPerPage,
+      facilityId: request.facilityId,
+      systemId: request.systemId,
+      companyId: request.companyId,
+      vendorId: request.vendorId,
+      scanType: request.scanType,
+      fullNameLike: request.fullNameLike,
+      dateScannedGte: request.dateScannedGte,
+      dateScannedLte: request.dateScannedLte,
+      result: request.result,
+    }),
+    queryFn: async function vendorScansExportVendorScansQueryFn(
+      ctx,
+    ): Promise<VendorScansExportVendorScansQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansExportVendorScans(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansExportVendorScans(
+  parameters: {
+    sort?: operations.ExportVendorScansQueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+    itemsPerPage?: number | undefined;
+    facilityId?: number | undefined;
+    systemId?: number | undefined;
+    companyId?: number | undefined;
+    vendorId?: string | undefined;
+    scanType?: operations.QueryParamScanType | undefined;
+    fullNameLike?: string | undefined;
+    dateScannedGte?: string | undefined;
+    dateScannedLte?: string | undefined;
+    result?: boolean | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "exportVendorScans",
+    parameters,
+  ];
+}

package/src/react-query/vendorScansExportVendorScans.ts

@@ -0,0 +1,190 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorScansExportVendorScansQuery,
+  prefetchVendorScansExportVendorScans,
+  queryKeyVendorScansExportVendorScans,
+  VendorScansExportVendorScansQueryData,
+} from "./vendorScansExportVendorScans.core.js";
+export {
+  buildVendorScansExportVendorScansQuery,
+  prefetchVendorScansExportVendorScans,
+  queryKeyVendorScansExportVendorScans,
+  type VendorScansExportVendorScansQueryData,
+};
+
+export type VendorScansExportVendorScansQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Export vendor scans to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of vendor scans, applying the same access scope and filter
+ * parameters as the list endpoint. The CSV contains every column shown on the Scan Details page: date,
+ * facility, system, zone, individual, company, scan type, recheck-after-screening, code, overridden, result,
+ * error, appointment, department, visit purpose, visit contact, estimated checkout time, notes, and the
+ * screening-required / screening-finished flags.
+ *
+ * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
+ */
+export function useVendorScansExportVendorScans(
+  request: operations.ExportVendorScansRequest,
+  options?: QueryHookOptions<
+    VendorScansExportVendorScansQueryData,
+    VendorScansExportVendorScansQueryError
+  >,
+): UseQueryResult<
+  VendorScansExportVendorScansQueryData,
+  VendorScansExportVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansExportVendorScansQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Export vendor scans to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of vendor scans, applying the same access scope and filter
+ * parameters as the list endpoint. The CSV contains every column shown on the Scan Details page: date,
+ * facility, system, zone, individual, company, scan type, recheck-after-screening, code, overridden, result,
+ * error, appointment, department, visit purpose, visit contact, estimated checkout time, notes, and the
+ * screening-required / screening-finished flags.
+ *
+ * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
+ */
+export function useVendorScansExportVendorScansSuspense(
+  request: operations.ExportVendorScansRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansExportVendorScansQueryData,
+    VendorScansExportVendorScansQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansExportVendorScansQueryData,
+  VendorScansExportVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansExportVendorScansQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansExportVendorScansData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: operations.ExportVendorScansQueryParamSort | undefined;
+      desc?: components.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+      companyId?: number | undefined;
+      vendorId?: string | undefined;
+      scanType?: operations.QueryParamScanType | undefined;
+      fullNameLike?: string | undefined;
+      dateScannedGte?: string | undefined;
+      dateScannedLte?: string | undefined;
+      result?: boolean | undefined;
+    },
+  ],
+  data: VendorScansExportVendorScansQueryData,
+): VendorScansExportVendorScansQueryData | undefined {
+  const key = queryKeyVendorScansExportVendorScans(...queryKeyBase);
+
+  return client.setQueryData<VendorScansExportVendorScansQueryData>(key, data);
+}
+
+export function invalidateVendorScansExportVendorScans(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: operations.ExportVendorScansQueryParamSort | undefined;
+      desc?: components.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+      companyId?: number | undefined;
+      vendorId?: string | undefined;
+      scanType?: operations.QueryParamScanType | undefined;
+      fullNameLike?: string | undefined;
+      dateScannedGte?: string | undefined;
+      dateScannedLte?: string | undefined;
+      result?: boolean | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "exportVendorScans",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansExportVendorScans(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "exportVendorScans",
+    ],
+  });
+}

package/src/react-query/vendorScansGetVendorScan.ts

@@ -65,6 +65,9 @@ export type VendorScansGetVendorScanQueryError =
  * - vendor_scan.zone
  * - vendor_scan.department
  * - vendor_scan.badge_data
+ * - vendor_scan.company
+ * - vendor_scan.appointment
+ * - vendor_scan.screening_responses
  */
 export function useVendorScansGetVendorScan(
   request: operations.GetVendorScanRequest,
@@ -99,6 +102,9 @@ export function useVendorScansGetVendorScan(
  * - vendor_scan.zone
  * - vendor_scan.department
  * - vendor_scan.badge_data
+ * - vendor_scan.company
+ * - vendor_scan.appointment
+ * - vendor_scan.screening_responses
  */
 export function useVendorScansGetVendorScanSuspense(
   request: operations.GetVendorScanRequest,

package/src/react-query/vendorScansGetVendorScansExportStatus.core.ts

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansGetVendorScansExportStatus } from "../funcs/vendorScansGetVendorScansExportStatus.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type VendorScansGetVendorScansExportStatusQueryData =
+  operations.GetVendorScansExportStatusResponseBody;
+
+export function prefetchVendorScansGetVendorScansExportStatus(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScansExportStatusRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansGetVendorScansExportStatusQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansGetVendorScansExportStatusQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScansExportStatusRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansGetVendorScansExportStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansGetVendorScansExportStatus(request.id),
+    queryFn: async function vendorScansGetVendorScansExportStatusQueryFn(
+      ctx,
+    ): Promise<VendorScansGetVendorScansExportStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansGetVendorScansExportStatus(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansGetVendorScansExportStatus(
+  id: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "getVendorScansExportStatus",
+    id,
+  ];
+}

package/src/react-query/vendorScansGetVendorScansExportStatus.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorScansGetVendorScansExportStatusQuery,
+  prefetchVendorScansGetVendorScansExportStatus,
+  queryKeyVendorScansGetVendorScansExportStatus,
+  VendorScansGetVendorScansExportStatusQueryData,
+} from "./vendorScansGetVendorScansExportStatus.core.js";
+export {
+  buildVendorScansGetVendorScansExportStatusQuery,
+  prefetchVendorScansGetVendorScansExportStatus,
+  queryKeyVendorScansGetVendorScansExportStatus,
+  type VendorScansGetVendorScansExportStatusQueryData,
+};
+
+export type VendorScansGetVendorScansExportStatusQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get vendor scans export status
+ *
+ * @remarks
+ * Poll the status of an asynchronous vendor scans export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useVendorScansGetVendorScansExportStatus(
+  request: operations.GetVendorScansExportStatusRequest,
+  options?: QueryHookOptions<
+    VendorScansGetVendorScansExportStatusQueryData,
+    VendorScansGetVendorScansExportStatusQueryError
+  >,
+): UseQueryResult<
+  VendorScansGetVendorScansExportStatusQueryData,
+  VendorScansGetVendorScansExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansGetVendorScansExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor scans export status
+ *
+ * @remarks
+ * Poll the status of an asynchronous vendor scans export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useVendorScansGetVendorScansExportStatusSuspense(
+  request: operations.GetVendorScansExportStatusRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansGetVendorScansExportStatusQueryData,
+    VendorScansGetVendorScansExportStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansGetVendorScansExportStatusQueryData,
+  VendorScansGetVendorScansExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansGetVendorScansExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansGetVendorScansExportStatusData(
+  client: QueryClient,
+  queryKeyBase: [id: string],
+  data: VendorScansGetVendorScansExportStatusQueryData,
+): VendorScansGetVendorScansExportStatusQueryData | undefined {
+  const key = queryKeyVendorScansGetVendorScansExportStatus(...queryKeyBase);
+
+  return client.setQueryData<VendorScansGetVendorScansExportStatusQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorScansGetVendorScansExportStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScansExportStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansGetVendorScansExportStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScansExportStatus",
+    ],
+  });
+}

package/src/react-query/vendorsDownloadVendorsExport.core.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsDownloadVendorsExport } from "../funcs/vendorsDownloadVendorsExport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type VendorsDownloadVendorsExportQueryData =
+  | operations.DownloadVendorsExportResponse
+  | undefined;
+
+export function prefetchVendorsDownloadVendorsExport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorsExportRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsDownloadVendorsExportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsDownloadVendorsExportQuery(
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorsExportRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsDownloadVendorsExportQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsDownloadVendorsExport(request.id),
+    queryFn: async function vendorsDownloadVendorsExportQueryFn(
+      ctx,
+    ): Promise<VendorsDownloadVendorsExportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsDownloadVendorsExport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsDownloadVendorsExport(id: string): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "downloadVendorsExport",
+    id,
+  ];
+}