@greensecurity/javascript-sdk 0.44.0-beta.11 → 0.44.0-beta.13

package/src/react-query/organizationsGetCompanyTargetFacilitiesExportStatus.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 {
+  buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  prefetchOrganizationsGetCompanyTargetFacilitiesExportStatus,
+  queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus,
+} from "./organizationsGetCompanyTargetFacilitiesExportStatus.core.js";
+export {
+  buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery,
+  type OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  prefetchOrganizationsGetCompanyTargetFacilitiesExportStatus,
+  queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus,
+};
+
+export type OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get company target facilities export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: QueryHookOptions<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+  >,
+): UseQueryResult<
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get company target facilities export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetCompanyTargetFacilitiesExportStatusSuspense(
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setOrganizationsGetCompanyTargetFacilitiesExportStatusData(
+  client: QueryClient,
+  queryKeyBase: [companyId: number, id: string],
+  data: OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+): OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData | undefined {
+  const key = queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData
+  >(key, data);
+}
+
+export function invalidateOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[companyId: number, id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getCompanyTargetFacilitiesExportStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getCompanyTargetFacilitiesExportStatus",
+    ],
+  });
+}

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

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import {
+  DownloadVendorScansExportAcceptEnum,
+  vendorScansDownloadVendorScansExport,
+} from "../funcs/vendorScansDownloadVendorScansExport.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 VendorScansDownloadVendorScansExportQueryData =
+  | operations.DownloadVendorScansExportResponse
+  | undefined;
+
+export function prefetchVendorScansDownloadVendorScansExport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorScansExportRequest,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: DownloadVendorScansExportAcceptEnum;
+  },
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansDownloadVendorScansExportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansDownloadVendorScansExportQuery(
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorScansExportRequest,
+  options?: RequestOptions & {
+    acceptHeaderOverride?: DownloadVendorScansExportAcceptEnum;
+  },
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansDownloadVendorScansExportQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansDownloadVendorScansExport(request.id),
+    queryFn: async function vendorScansDownloadVendorScansExportQueryFn(
+      ctx,
+    ): Promise<VendorScansDownloadVendorScansExportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansDownloadVendorScansExport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansDownloadVendorScansExport(
+  id: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "downloadVendorScansExport",
+    id,
+  ];
+}

package/src/react-query/vendorScansDownloadVendorScansExport.ts

@@ -0,0 +1,154 @@
+/*
+ * 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 {
+  buildVendorScansDownloadVendorScansExportQuery,
+  prefetchVendorScansDownloadVendorScansExport,
+  queryKeyVendorScansDownloadVendorScansExport,
+  VendorScansDownloadVendorScansExportQueryData,
+} from "./vendorScansDownloadVendorScansExport.core.js";
+export {
+  buildVendorScansDownloadVendorScansExportQuery,
+  prefetchVendorScansDownloadVendorScansExport,
+  queryKeyVendorScansDownloadVendorScansExport,
+  type VendorScansDownloadVendorScansExportQueryData,
+};
+
+export type VendorScansDownloadVendorScansExportQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+export { DownloadVendorScansExportAcceptEnum } from "../funcs/vendorScansDownloadVendorScansExport.js";
+
+/**
+ * Download vendor scans CSV
+ *
+ * @remarks
+ * Returns the exported vendor scans CSV via a 302 redirect to a short-lived presigned S3 URL.
+ * If the export is still being generated, returns 202 with a JSON `{ ready: false }` payload.
+ */
+export function useVendorScansDownloadVendorScansExport(
+  request: operations.DownloadVendorScansExportRequest,
+  options?: QueryHookOptions<
+    VendorScansDownloadVendorScansExportQueryData,
+    VendorScansDownloadVendorScansExportQueryError
+  >,
+): UseQueryResult<
+  VendorScansDownloadVendorScansExportQueryData,
+  VendorScansDownloadVendorScansExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansDownloadVendorScansExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download vendor scans CSV
+ *
+ * @remarks
+ * Returns the exported vendor scans CSV via a 302 redirect to a short-lived presigned S3 URL.
+ * If the export is still being generated, returns 202 with a JSON `{ ready: false }` payload.
+ */
+export function useVendorScansDownloadVendorScansExportSuspense(
+  request: operations.DownloadVendorScansExportRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansDownloadVendorScansExportQueryData,
+    VendorScansDownloadVendorScansExportQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansDownloadVendorScansExportQueryData,
+  VendorScansDownloadVendorScansExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansDownloadVendorScansExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansDownloadVendorScansExportData(
+  client: QueryClient,
+  queryKeyBase: [id: string],
+  data: VendorScansDownloadVendorScansExportQueryData,
+): VendorScansDownloadVendorScansExportQueryData | undefined {
+  const key = queryKeyVendorScansDownloadVendorScansExport(...queryKeyBase);
+
+  return client.setQueryData<VendorScansDownloadVendorScansExportQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorScansDownloadVendorScansExport(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "downloadVendorScansExport",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansDownloadVendorScansExport(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "downloadVendorScansExport",
+    ],
+  });
+}

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