@greensecurity/javascript-sdk 0.30.35 → 0.30.39

package/src/react-query/zonesListOrSearchSecurityZones.ts

@@ -0,0 +1,370 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { zonesListOrSearchSecurityZones } from "../funcs/zonesListOrSearchSecurityZones.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 { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type ZonesListOrSearchSecurityZonesQueryData =
+  operations.ListOrSearchSecurityZonesResponse;
+
+export type ZonesListOrSearchSecurityZonesInfiniteQueryData = PageIterator<
+  operations.ListOrSearchSecurityZonesResponse,
+  { page: number }
+>;
+
+export type ZonesListOrSearchSecurityZonesPageParams = PageIterator<
+  operations.ListOrSearchSecurityZonesResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List or search security zones
+ *
+ * @remarks
+ * List or search security zones
+ */
+export function useZonesListOrSearchSecurityZones(
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: QueryHookOptions<ZonesListOrSearchSecurityZonesQueryData>,
+): UseQueryResult<ZonesListOrSearchSecurityZonesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildZonesListOrSearchSecurityZonesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search security zones
+ *
+ * @remarks
+ * List or search security zones
+ */
+export function useZonesListOrSearchSecurityZonesSuspense(
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: SuspenseQueryHookOptions<ZonesListOrSearchSecurityZonesQueryData>,
+): UseSuspenseQueryResult<ZonesListOrSearchSecurityZonesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildZonesListOrSearchSecurityZonesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search security zones
+ *
+ * @remarks
+ * List or search security zones
+ */
+export function useZonesListOrSearchSecurityZonesInfinite(
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: InfiniteQueryHookOptions<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData,
+    ZonesListOrSearchSecurityZonesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      ZonesListOrSearchSecurityZonesInfiniteQueryData,
+      ZonesListOrSearchSecurityZonesPageParams
+    >,
+    QueryKey,
+    ZonesListOrSearchSecurityZonesPageParams
+  >({
+    ...buildZonesListOrSearchSecurityZonesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search security zones
+ *
+ * @remarks
+ * List or search security zones
+ */
+export function useZonesListOrSearchSecurityZonesInfiniteSuspense(
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData,
+    ZonesListOrSearchSecurityZonesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    ZonesListOrSearchSecurityZonesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      ZonesListOrSearchSecurityZonesInfiniteQueryData,
+      ZonesListOrSearchSecurityZonesPageParams
+    >,
+    QueryKey,
+    ZonesListOrSearchSecurityZonesPageParams
+  >({
+    ...buildZonesListOrSearchSecurityZonesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchZonesListOrSearchSecurityZones(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSecurityZonesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildZonesListOrSearchSecurityZonesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setZonesListOrSearchSecurityZonesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      latitude?: number | undefined;
+      longitude?: number | undefined;
+      nameLike?: string | undefined;
+      contactId?: number | undefined;
+      facilityId?: number | undefined;
+      greenLocationId?: number | undefined;
+    },
+  ],
+  data: ZonesListOrSearchSecurityZonesQueryData,
+): ZonesListOrSearchSecurityZonesQueryData | undefined {
+  const key = queryKeyZonesListOrSearchSecurityZones(...queryKeyBase);
+
+  return client.setQueryData<ZonesListOrSearchSecurityZonesQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateZonesListOrSearchSecurityZones(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      latitude?: number | undefined;
+      longitude?: number | undefined;
+      nameLike?: string | undefined;
+      contactId?: number | undefined;
+      facilityId?: number | undefined;
+      greenLocationId?: number | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "zones",
+      "listOrSearchSecurityZones",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllZonesListOrSearchSecurityZones(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "zones",
+      "listOrSearchSecurityZones",
+    ],
+  });
+}
+
+export function buildZonesListOrSearchSecurityZonesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<ZonesListOrSearchSecurityZonesQueryData>;
+} {
+  return {
+    queryKey: queryKeyZonesListOrSearchSecurityZones({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      latitude: request.latitude,
+      longitude: request.longitude,
+      nameLike: request.nameLike,
+      contactId: request.contactId,
+      facilityId: request.facilityId,
+      greenLocationId: request.greenLocationId,
+    }),
+    queryFn: async function zonesListOrSearchSecurityZonesQueryFn(
+      ctx,
+    ): Promise<ZonesListOrSearchSecurityZonesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(zonesListOrSearchSecurityZones(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildZonesListOrSearchSecurityZonesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchSecurityZonesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      ZonesListOrSearchSecurityZonesPageParams
+    >,
+  ) => Promise<ZonesListOrSearchSecurityZonesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyZonesListOrSearchSecurityZones({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      latitude: request.latitude,
+      longitude: request.longitude,
+      nameLike: request.nameLike,
+      contactId: request.contactId,
+      facilityId: request.facilityId,
+      greenLocationId: request.greenLocationId,
+    }),
+    queryFn: async function zonesListOrSearchSecurityZonesQuery(
+      ctx,
+    ): Promise<ZonesListOrSearchSecurityZonesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(zonesListOrSearchSecurityZones(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(zonesListOrSearchSecurityZones(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyZonesListOrSearchSecurityZones(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    latitude?: number | undefined;
+    longitude?: number | undefined;
+    nameLike?: string | undefined;
+    contactId?: number | undefined;
+    facilityId?: number | undefined;
+    greenLocationId?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "zones",
+    "listOrSearchSecurityZones",
+    parameters,
+  ];
+}

package/src/react-query/zonesSecurityZoneCheckin.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { zonesSecurityZoneCheckin } from "../funcs/zonesSecurityZoneCheckin.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 { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ZonesSecurityZoneCheckinMutationVariables = {
+  request: operations.SecurityZoneCheckinRequestBody;
+  options?: RequestOptions;
+};
+
+export type ZonesSecurityZoneCheckinMutationData = components.Handoff;
+
+/**
+ * Security zone checkin request
+ *
+ * @remarks
+ * It will create a handoff record in the db for security zone check in request
+ */
+export function useZonesSecurityZoneCheckinMutation(
+  options?: MutationHookOptions<
+    ZonesSecurityZoneCheckinMutationData,
+    Error,
+    ZonesSecurityZoneCheckinMutationVariables
+  >,
+): UseMutationResult<
+  ZonesSecurityZoneCheckinMutationData,
+  Error,
+  ZonesSecurityZoneCheckinMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildZonesSecurityZoneCheckinMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyZonesSecurityZoneCheckin(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "zones", "securityZoneCheckin"];
+}
+
+export function buildZonesSecurityZoneCheckinMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ZonesSecurityZoneCheckinMutationVariables,
+  ) => Promise<ZonesSecurityZoneCheckinMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyZonesSecurityZoneCheckin(),
+    mutationFn: function zonesSecurityZoneCheckinMutationFn({
+      request,
+      options,
+    }): Promise<ZonesSecurityZoneCheckinMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(zonesSecurityZoneCheckin(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/sdk.ts

@@ -10,6 +10,7 @@ import { Users } from "./users.js";
 import { Vendors } from "./vendors.js";
 import { VendorScans } from "./vendorscans.js";
 import { Webhooks } from "./webhooks.js";
+import { Zones } from "./zones.js";
 
 export class GreenSecurity extends ClientSDK {
   private _vendors?: Vendors;
@@ -46,4 +47,9 @@ export class GreenSecurity extends ClientSDK {
   get companies(): Companies {
     return (this._companies ??= new Companies(this._options));
   }
+
+  private _zones?: Zones;
+  get zones(): Zones {
+    return (this._zones ??= new Zones(this._options));
+  }
 }

package/src/sdk/zones.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { zonesListOrSearchSecurityZones } from "../funcs/zonesListOrSearchSecurityZones.js";
+import { zonesSecurityZoneCheckin } from "../funcs/zonesSecurityZoneCheckin.js";
+import { ClientSDK, 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";
+
+export class Zones extends ClientSDK {
+  /**
+   * List or search security zones
+   *
+   * @remarks
+   * List or search security zones
+   */
+  async listOrSearchSecurityZones(
+    request: operations.ListOrSearchSecurityZonesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListOrSearchSecurityZonesResponse, { page: number }>
+  > {
+    return unwrapResultIterator(zonesListOrSearchSecurityZones(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Security zone checkin request
+   *
+   * @remarks
+   * It will create a handoff record in the db for security zone check in request
+   */
+  async securityZoneCheckin(
+    request: operations.SecurityZoneCheckinRequestBody,
+    options?: RequestOptions,
+  ): Promise<components.Handoff> {
+    return unwrapAsync(zonesSecurityZoneCheckin(
+      this,
+      request,
+      options,
+    ));
+  }
+}