@greensecurity/javascript-sdk 0.30.37 → 0.30.39

package/src/models/operations/securityzonecheckin.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Two = {
+  /**
+   * QR code representing an existing handoff
+   */
+  qrCode: string;
+};
+
+export type One = {
+  /**
+   * The ID of the zone
+   */
+  zoneId: number;
+  longitude?: any | undefined;
+  latitude?: any | undefined;
+};
+
+export type SecurityZoneCheckinRequestBody = Two | One;
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    qr_code: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "qr_code": "qrCode",
+    });
+  });
+
+/** @internal */
+export type Two$Outbound = {
+  qr_code: string;
+};
+
+/** @internal */
+export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
+  .object({
+    qrCode: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      qrCode: "qr_code",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Two$ {
+  /** @deprecated use `Two$inboundSchema` instead. */
+  export const inboundSchema = Two$inboundSchema;
+  /** @deprecated use `Two$outboundSchema` instead. */
+  export const outboundSchema = Two$outboundSchema;
+  /** @deprecated use `Two$Outbound` instead. */
+  export type Outbound = Two$Outbound;
+}
+
+export function twoToJSON(two: Two): string {
+  return JSON.stringify(Two$outboundSchema.parse(two));
+}
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    zone_id: z.number().int(),
+    longitude: z.any().optional(),
+    latitude: z.any().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "zone_id": "zoneId",
+    });
+  });
+
+/** @internal */
+export type One$Outbound = {
+  zone_id: number;
+  longitude?: any | undefined;
+  latitude?: any | undefined;
+};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .object({
+    zoneId: z.number().int(),
+    longitude: z.any().optional(),
+    latitude: z.any().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      zoneId: "zone_id",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace One$ {
+  /** @deprecated use `One$inboundSchema` instead. */
+  export const inboundSchema = One$inboundSchema;
+  /** @deprecated use `One$outboundSchema` instead. */
+  export const outboundSchema = One$outboundSchema;
+  /** @deprecated use `One$Outbound` instead. */
+  export type Outbound = One$Outbound;
+}
+
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
+}
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const SecurityZoneCheckinRequestBody$inboundSchema: z.ZodType<
+  SecurityZoneCheckinRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.lazy(() => Two$inboundSchema), z.lazy(() => One$inboundSchema)]);
+
+/** @internal */
+export type SecurityZoneCheckinRequestBody$Outbound =
+  | Two$Outbound
+  | One$Outbound;
+
+/** @internal */
+export const SecurityZoneCheckinRequestBody$outboundSchema: z.ZodType<
+  SecurityZoneCheckinRequestBody$Outbound,
+  z.ZodTypeDef,
+  SecurityZoneCheckinRequestBody
+> = z.union([
+  z.lazy(() => Two$outboundSchema),
+  z.lazy(() => One$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SecurityZoneCheckinRequestBody$ {
+  /** @deprecated use `SecurityZoneCheckinRequestBody$inboundSchema` instead. */
+  export const inboundSchema = SecurityZoneCheckinRequestBody$inboundSchema;
+  /** @deprecated use `SecurityZoneCheckinRequestBody$outboundSchema` instead. */
+  export const outboundSchema = SecurityZoneCheckinRequestBody$outboundSchema;
+  /** @deprecated use `SecurityZoneCheckinRequestBody$Outbound` instead. */
+  export type Outbound = SecurityZoneCheckinRequestBody$Outbound;
+}
+
+export function securityZoneCheckinRequestBodyToJSON(
+  securityZoneCheckinRequestBody: SecurityZoneCheckinRequestBody,
+): string {
+  return JSON.stringify(
+    SecurityZoneCheckinRequestBody$outboundSchema.parse(
+      securityZoneCheckinRequestBody,
+    ),
+  );
+}
+
+export function securityZoneCheckinRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SecurityZoneCheckinRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SecurityZoneCheckinRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SecurityZoneCheckinRequestBody' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -42,3 +42,4 @@ export * from "./vendorsUpdateVendorScrubDetails.js";
 export * from "./webhooksGetWebhookEndpoint.js";
 export * from "./webhooksListAllWebhookEndpoints.js";
 export * from "./zonesListOrSearchSecurityZones.js";
+export * from "./zonesSecurityZoneCheckin.js";

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/zones.ts

@@ -3,8 +3,11 @@
  */
 
 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 {
@@ -26,4 +29,21 @@ export class Zones extends ClientSDK {
       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,
+    ));
+  }
 }