@greensecurity/javascript-sdk 0.43.1-beta.119 → 0.43.1-beta.122

package/src/react-query/eventsGetEvent.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5b32ff345463
+ */
+
+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 {
+  buildEventsGetEventQuery,
+  EventsGetEventQueryData,
+  prefetchEventsGetEvent,
+  queryKeyEventsGetEvent,
+} from "./eventsGetEvent.core.js";
+export {
+  buildEventsGetEventQuery,
+  type EventsGetEventQueryData,
+  prefetchEventsGetEvent,
+  queryKeyEventsGetEvent,
+};
+
+export type EventsGetEventQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get event
+ *
+ * @remarks
+ * Retrieve a single event by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - event.facility
+ * - event.department
+ * - event.invitees
+ */
+export function useEventsGetEvent(
+  request: operations.GetEventRequest,
+  options?: QueryHookOptions<EventsGetEventQueryData, EventsGetEventQueryError>,
+): UseQueryResult<EventsGetEventQueryData, EventsGetEventQueryError> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildEventsGetEventQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get event
+ *
+ * @remarks
+ * Retrieve a single event by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - event.facility
+ * - event.department
+ * - event.invitees
+ */
+export function useEventsGetEventSuspense(
+  request: operations.GetEventRequest,
+  options?: SuspenseQueryHookOptions<
+    EventsGetEventQueryData,
+    EventsGetEventQueryError
+  >,
+): UseSuspenseQueryResult<EventsGetEventQueryData, EventsGetEventQueryError> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildEventsGetEventQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setEventsGetEventData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: EventsGetEventQueryData,
+): EventsGetEventQueryData | undefined {
+  const key = queryKeyEventsGetEvent(...queryKeyBase);
+
+  return client.setQueryData<EventsGetEventQueryData>(key, data);
+}
+
+export function invalidateEventsGetEvent(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "events",
+      "getEvent",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllEventsGetEvent(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "events", "getEvent"],
+  });
+}

package/src/react-query/index.ts

@@ -20,6 +20,7 @@ export * from "./eventsAcceptInvitation.js";
 export * from "./eventsCreateEvent.js";
 export * from "./eventsDeclineInvitation.js";
 export * from "./eventsDeleteEvent.js";
+export * from "./eventsGetEvent.js";
 export * from "./eventsListFeed.js";
 export * from "./eventsListLocations.js";
 export * from "./eventsListOrSearchVendorInvitees.js";
@@ -68,6 +69,8 @@ export * from "./vendorsAddVendorManagedByCompany.js";
 export * from "./vendorsCalculateSubscriptionPrice.js";
 export * from "./vendorsCancelHandoff.js";
 export * from "./vendorScansGetNextScreeningQuestion.js";
+export * from "./vendorScansGetVendorScan.js";
+export * from "./vendorScansListVendorScans.js";
 export * from "./vendorScansSubmitScreeningResponse.js";
 export * from "./vendorScansVendorScanOut.js";
 export * from "./vendorsChangeSubscription.js";

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

@@ -80,6 +80,8 @@ export function buildSystemsListSystemsQuery(
       itemsPerPage: request.itemsPerPage,
       nameLike: request.nameLike,
       expand: request.expand,
+      startDateGte: request.startDateGte,
+      startDateLte: request.startDateLte,
     }),
     queryFn: async function systemsListSystemsQueryFn(
       ctx,
@@ -122,6 +124,8 @@ export function buildSystemsListSystemsInfiniteQuery(
       itemsPerPage: request.itemsPerPage,
       nameLike: request.nameLike,
       expand: request.expand,
+      startDateGte: request.startDateGte,
+      startDateLte: request.startDateLte,
     }),
     queryFn: async function systemsListSystemsQuery(
       ctx,
@@ -161,6 +165,8 @@ export function queryKeySystemsListSystems(
     itemsPerPage?: number | undefined;
     nameLike?: string | undefined;
     expand?: Array<components.Expand> | undefined;
+    startDateGte?: string | undefined;
+    startDateLte?: string | undefined;
   },
 ): QueryKey {
   return [
@@ -179,6 +185,8 @@ export function queryKeySystemsListSystemsInfinite(
     itemsPerPage?: number | undefined;
     nameLike?: string | undefined;
     expand?: Array<components.Expand> | undefined;
+    startDateGte?: string | undefined;
+    startDateLte?: string | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/systemsListSystems.ts

@@ -231,6 +231,8 @@ export function setSystemsListSystemsData(
       itemsPerPage?: number | undefined;
       nameLike?: string | undefined;
       expand?: Array<components.Expand> | undefined;
+      startDateGte?: string | undefined;
+      startDateLte?: string | undefined;
     },
   ],
   data: SystemsListSystemsQueryData,
@@ -250,6 +252,8 @@ export function invalidateSystemsListSystems(
       itemsPerPage?: number | undefined;
       nameLike?: string | undefined;
       expand?: Array<components.Expand> | undefined;
+      startDateGte?: string | undefined;
+      startDateLte?: string | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

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

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 86c2889722f7
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansGetVendorScan } from "../funcs/vendorScansGetVendorScan.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 VendorScansGetVendorScanQueryData = components.VendorScan;
+
+export function prefetchVendorScansGetVendorScan(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScanRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansGetVendorScanQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScanRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansGetVendorScanQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansGetVendorScan(request.id, {
+      expand: request.expand,
+    }),
+    queryFn: async function vendorScansGetVendorScanQueryFn(
+      ctx,
+    ): Promise<VendorScansGetVendorScanQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansGetVendorScan(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansGetVendorScan(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "getVendorScan",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/vendorScansGetVendorScan.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 605598a08f54
+ */
+
+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 {
+  buildVendorScansGetVendorScanQuery,
+  prefetchVendorScansGetVendorScan,
+  queryKeyVendorScansGetVendorScan,
+  VendorScansGetVendorScanQueryData,
+} from "./vendorScansGetVendorScan.core.js";
+export {
+  buildVendorScansGetVendorScanQuery,
+  prefetchVendorScansGetVendorScan,
+  queryKeyVendorScansGetVendorScan,
+  type VendorScansGetVendorScanQueryData,
+};
+
+export type VendorScansGetVendorScanQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get a vendor scan by ID
+ *
+ * @remarks
+ * Retrieve a single vendor scan by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_scan.vendor
+ * - vendor_scan.zone
+ * - vendor_scan.department
+ * - vendor_scan.badge_data
+ */
+export function useVendorScansGetVendorScan(
+  request: operations.GetVendorScanRequest,
+  options?: QueryHookOptions<
+    VendorScansGetVendorScanQueryData,
+    VendorScansGetVendorScanQueryError
+  >,
+): UseQueryResult<
+  VendorScansGetVendorScanQueryData,
+  VendorScansGetVendorScanQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get a vendor scan by ID
+ *
+ * @remarks
+ * Retrieve a single vendor scan by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_scan.vendor
+ * - vendor_scan.zone
+ * - vendor_scan.department
+ * - vendor_scan.badge_data
+ */
+export function useVendorScansGetVendorScanSuspense(
+  request: operations.GetVendorScanRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansGetVendorScanQueryData,
+    VendorScansGetVendorScanQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansGetVendorScanQueryData,
+  VendorScansGetVendorScanQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansGetVendorScanData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: VendorScansGetVendorScanQueryData,
+): VendorScansGetVendorScanQueryData | undefined {
+  const key = queryKeyVendorScansGetVendorScan(...queryKeyBase);
+
+  return client.setQueryData<VendorScansGetVendorScanQueryData>(key, data);
+}
+
+export function invalidateVendorScansGetVendorScan(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScan",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansGetVendorScan(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScan",
+    ],
+  });
+}

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

@@ -0,0 +1,210 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 438a410aa637
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansListVendorScans } from "../funcs/vendorScansListVendorScans.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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { pageIteratorToJSON } from "./_types.js";
+export type VendorScansListVendorScansQueryData =
+  operations.ListVendorScansResponse;
+
+export type VendorScansListVendorScansInfiniteQueryData = PageIterator<
+  operations.ListVendorScansResponse,
+  { page: number }
+>;
+
+export type VendorScansListVendorScansPageParams = PageIterator<
+  operations.ListVendorScansResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchVendorScansListVendorScans(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorScansRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansListVendorScansQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchVendorScansListVendorScansInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorScansRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildVendorScansListVendorScansInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as VendorScansListVendorScansPageParams,
+    getNextPageParam: (
+      previousPage: VendorScansListVendorScansInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildVendorScansListVendorScansQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorScansRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansListVendorScansQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansListVendorScans({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      facilityId: request.facilityId,
+      systemId: request.systemId,
+      companyId: request.companyId,
+      vendorId: request.vendorId,
+      scanType: request.scanType,
+    }),
+    queryFn: async function vendorScansListVendorScansQueryFn(
+      ctx,
+    ): Promise<VendorScansListVendorScansQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansListVendorScans(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorScansListVendorScansInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorScansRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorScansListVendorScansPageParams
+    >,
+  ) => Promise<VendorScansListVendorScansInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansListVendorScansInfinite({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      facilityId: request.facilityId,
+      systemId: request.systemId,
+      companyId: request.companyId,
+      vendorId: request.vendorId,
+      scanType: request.scanType,
+    }),
+    queryFn: async function vendorScansListVendorScansQuery(
+      ctx,
+    ): Promise<VendorScansListVendorScansInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          vendorScansListVendorScans(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(vendorScansListVendorScans(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyVendorScansListVendorScans(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    facilityId?: number | undefined;
+    systemId?: number | undefined;
+    companyId?: number | undefined;
+    vendorId?: string | undefined;
+    scanType?: operations.ScanType | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "listVendorScans",
+    parameters,
+  ];
+}
+
+export function queryKeyVendorScansListVendorScansInfinite(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    facilityId?: number | undefined;
+    systemId?: number | undefined;
+    companyId?: number | undefined;
+    vendorId?: string | undefined;
+    scanType?: operations.ScanType | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "listVendorScans",
+    "infinite",
+    parameters,
+  ];
+}