@greensecurity/javascript-sdk 0.36.0 → 0.36.5

package/src/mcp-server/tools/zonesGetSecurityZone.ts

@@ -14,7 +14,13 @@ export const tool$zonesGetSecurityZone: ToolDefinition<typeof args> = {
   name: "zones-get-security-zone",
   description: `Get security zone details
 
-Get security zone details`,
+Get security zone details
+
+Available \`expand\` scopes are:
+
+- zone.facility
+- zone.department
+- zone.rules`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await zonesGetSecurityZone(

package/src/models/components/expand.ts

@@ -76,6 +76,9 @@ export const Expand = {
     "vendor_credential_data_request.vendor_credential",
   VendorCredentialDataRequestDataRequest:
     "vendor_credential_data_request.data_request",
+  ZoneFacility: "zone.facility",
+  ZoneDepartment: "zone.department",
+  ZoneRules: "zone.rules",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.

package/src/models/components/vendorfacilitystatusview.ts

@@ -18,6 +18,7 @@ export type VendorFacilityStatusView = {
   facilityStatus?: string | null | undefined;
   vendorScanId?: number | null | undefined;
   vendorScanType?: number | null | undefined;
+  dateScanned?: string | null | undefined;
 };
 
 /** @internal */
@@ -32,6 +33,7 @@ export const VendorFacilityStatusView$inboundSchema: z.ZodType<
   facility_status: z.nullable(z.string()).optional(),
   vendor_scan_id: z.nullable(z.number().int()).optional(),
   vendor_scan_type: z.nullable(z.number().int()).optional(),
+  date_scanned: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "vendor_id": "vendorId",
@@ -40,6 +42,7 @@ export const VendorFacilityStatusView$inboundSchema: z.ZodType<
     "facility_status": "facilityStatus",
     "vendor_scan_id": "vendorScanId",
     "vendor_scan_type": "vendorScanType",
+    "date_scanned": "dateScanned",
   });
 });
 
@@ -51,6 +54,7 @@ export type VendorFacilityStatusView$Outbound = {
   facility_status?: string | null | undefined;
   vendor_scan_id?: number | null | undefined;
   vendor_scan_type?: number | null | undefined;
+  date_scanned?: string | null | undefined;
 };
 
 /** @internal */
@@ -65,6 +69,7 @@ export const VendorFacilityStatusView$outboundSchema: z.ZodType<
   facilityStatus: z.nullable(z.string()).optional(),
   vendorScanId: z.nullable(z.number().int()).optional(),
   vendorScanType: z.nullable(z.number().int()).optional(),
+  dateScanned: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     vendorId: "vendor_id",
@@ -73,6 +78,7 @@ export const VendorFacilityStatusView$outboundSchema: z.ZodType<
     facilityStatus: "facility_status",
     vendorScanId: "vendor_scan_id",
     vendorScanType: "vendor_scan_type",
+    dateScanned: "date_scanned",
   });
 });
 

package/src/models/operations/getsecurityzone.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetSecurityZoneRequest = {
@@ -12,6 +13,10 @@ export type GetSecurityZoneRequest = {
    * The identifier of the object
    */
   id: number;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
 };
 
 /** @internal */
@@ -21,11 +26,13 @@ export const GetSecurityZoneRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.number().int(),
+  expand: z.array(components.Expand$inboundSchema).optional(),
 });
 
 /** @internal */
 export type GetSecurityZoneRequest$Outbound = {
   id: number;
+  expand?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -35,6 +42,7 @@ export const GetSecurityZoneRequest$outboundSchema: z.ZodType<
   GetSecurityZoneRequest
 > = z.object({
   id: z.number().int(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
 });
 
 /**

package/src/models/operations/index.ts

@@ -52,6 +52,7 @@ export * from "./password.js";
 export * from "./passwordresetrequest.js";
 export * from "./postauthenticate.js";
 export * from "./purchasescrubcredits.js";
+export * from "./rotateapikey.js";
 export * from "./securityzonecheckin.js";
 export * from "./senddownloadcode.js";
 export * from "./submitvendorcredential.js";

package/src/models/operations/listvendorfacilitystatuses.ts

@@ -10,6 +10,10 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListVendorFacilityStatusesRequest = {
+  /**
+   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   */
+  vendorIdOrMe: string;
   /**
    * A comma-separated list of object attributes to sort on.
    */
@@ -34,6 +38,10 @@ export type ListVendorFacilityStatusesRequest = {
    * A partial string to search in the facility name. Do not include any wildcard characters. Searches are not case-sensitive by default.
    */
   facilityNameLike?: string | undefined;
+  /**
+   * An ID representing a Hospital
+   */
+  facilityId?: number | undefined;
 };
 
 /**
@@ -57,28 +65,34 @@ export const ListVendorFacilityStatusesRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  vendor_id_or_me: z.string(),
   sort: z.nullable(z.string()).optional(),
   desc: components.Desc$inboundSchema.optional(),
   page: z.number().int().optional(),
   items_per_page: z.number().int().optional(),
   scan_type: components.ScanType$inboundSchema.optional(),
   facility_name_like: z.string().optional(),
+  facility_id: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
+    "vendor_id_or_me": "vendorIdOrMe",
     "items_per_page": "itemsPerPage",
     "scan_type": "scanType",
     "facility_name_like": "facilityNameLike",
+    "facility_id": "facilityId",
   });
 });
 
 /** @internal */
 export type ListVendorFacilityStatusesRequest$Outbound = {
+  vendor_id_or_me: string;
   sort?: string | null | undefined;
   desc?: components.Desc$Outbound | undefined;
   page?: number | undefined;
   items_per_page?: number | undefined;
   scan_type?: string | undefined;
   facility_name_like?: string | undefined;
+  facility_id?: number | undefined;
 };
 
 /** @internal */
@@ -87,17 +101,21 @@ export const ListVendorFacilityStatusesRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListVendorFacilityStatusesRequest
 > = z.object({
+  vendorIdOrMe: z.string(),
   sort: z.nullable(z.string()).optional(),
   desc: components.Desc$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
   scanType: components.ScanType$outboundSchema.optional(),
   facilityNameLike: z.string().optional(),
+  facilityId: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
+    vendorIdOrMe: "vendor_id_or_me",
     itemsPerPage: "items_per_page",
     scanType: "scan_type",
     facilityNameLike: "facility_name_like",
+    facilityId: "facility_id",
   });
 });
 

package/src/models/operations/rotateapikey.ts

@@ -0,0 +1,82 @@
+/*
+ * 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";
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type RotateApiKeyRotateApiKeyOk = {
+  success: boolean;
+  apiKey?: string | undefined;
+};
+
+/** @internal */
+export const RotateApiKeyRotateApiKeyOk$inboundSchema: z.ZodType<
+  RotateApiKeyRotateApiKeyOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+  api_key: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "api_key": "apiKey",
+  });
+});
+
+/** @internal */
+export type RotateApiKeyRotateApiKeyOk$Outbound = {
+  success: boolean;
+  api_key?: string | undefined;
+};
+
+/** @internal */
+export const RotateApiKeyRotateApiKeyOk$outboundSchema: z.ZodType<
+  RotateApiKeyRotateApiKeyOk$Outbound,
+  z.ZodTypeDef,
+  RotateApiKeyRotateApiKeyOk
+> = z.object({
+  success: z.boolean(),
+  apiKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    apiKey: "api_key",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RotateApiKeyRotateApiKeyOk$ {
+  /** @deprecated use `RotateApiKeyRotateApiKeyOk$inboundSchema` instead. */
+  export const inboundSchema = RotateApiKeyRotateApiKeyOk$inboundSchema;
+  /** @deprecated use `RotateApiKeyRotateApiKeyOk$outboundSchema` instead. */
+  export const outboundSchema = RotateApiKeyRotateApiKeyOk$outboundSchema;
+  /** @deprecated use `RotateApiKeyRotateApiKeyOk$Outbound` instead. */
+  export type Outbound = RotateApiKeyRotateApiKeyOk$Outbound;
+}
+
+export function rotateApiKeyRotateApiKeyOkToJSON(
+  rotateApiKeyRotateApiKeyOk: RotateApiKeyRotateApiKeyOk,
+): string {
+  return JSON.stringify(
+    RotateApiKeyRotateApiKeyOk$outboundSchema.parse(rotateApiKeyRotateApiKeyOk),
+  );
+}
+
+export function rotateApiKeyRotateApiKeyOkFromJSON(
+  jsonString: string,
+): SafeParseResult<RotateApiKeyRotateApiKeyOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RotateApiKeyRotateApiKeyOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RotateApiKeyRotateApiKeyOk' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -23,6 +23,7 @@ export * from "./usersMagiclink.js";
 export * from "./usersPassword.js";
 export * from "./usersPasswordResetRequest.js";
 export * from "./usersPostAuthenticate.js";
+export * from "./usersRotateApiKey.js";
 export * from "./vendorsAcceptVendorCredential.js";
 export * from "./vendorsAddVendorCredentialFile.js";
 export * from "./vendorsAddVendorManagedByCompany.js";

package/src/react-query/usersRotateApiKey.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { usersRotateApiKey } from "../funcs/usersRotateApiKey.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";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type UsersRotateApiKeyMutationVariables = {
+  options?: RequestOptions;
+};
+
+export type UsersRotateApiKeyMutationData =
+  operations.RotateApiKeyRotateApiKeyOk;
+
+/**
+ * Rotate API key
+ *
+ * @remarks
+ * Allows an API user to rotate their own API key. Note, the key rotation happens immediately so the user should be prepared to update their API key in their application for all subsequent requests.
+ */
+export function useUsersRotateApiKeyMutation(
+  options?: MutationHookOptions<
+    UsersRotateApiKeyMutationData,
+    Error,
+    UsersRotateApiKeyMutationVariables
+  >,
+): UseMutationResult<
+  UsersRotateApiKeyMutationData,
+  Error,
+  UsersRotateApiKeyMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildUsersRotateApiKeyMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyUsersRotateApiKey(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "users", "rotateApiKey"];
+}
+
+export function buildUsersRotateApiKeyMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: UsersRotateApiKeyMutationVariables,
+  ) => Promise<UsersRotateApiKeyMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyUsersRotateApiKey(),
+    mutationFn: function usersRotateApiKeyMutationFn({
+      options,
+    }): Promise<UsersRotateApiKeyMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(usersRotateApiKey(
+        client$,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsListVendorFacilityStatuses.ts

@@ -187,6 +187,7 @@ export function prefetchVendorsListVendorFacilityStatuses(
 export function setVendorsListVendorFacilityStatusesData(
   client: QueryClient,
   queryKeyBase: [
+    vendorIdOrMe: string,
     parameters: {
       sort?: string | null | undefined;
       desc?: components.Desc | undefined;
@@ -194,6 +195,7 @@ export function setVendorsListVendorFacilityStatusesData(
       itemsPerPage?: number | undefined;
       scanType?: components.ScanType | undefined;
       facilityNameLike?: string | undefined;
+      facilityId?: number | undefined;
     },
   ],
   data: VendorsListVendorFacilityStatusesQueryData,
@@ -209,14 +211,18 @@ export function setVendorsListVendorFacilityStatusesData(
 export function invalidateVendorsListVendorFacilityStatuses(
   client: QueryClient,
   queryKeyBase: TupleToPrefixes<
-    [parameters: {
-      sort?: string | null | undefined;
-      desc?: components.Desc | undefined;
-      page?: number | undefined;
-      itemsPerPage?: number | undefined;
-      scanType?: components.ScanType | undefined;
-      facilityNameLike?: string | undefined;
-    }]
+    [
+      vendorIdOrMe: string,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        scanType?: components.ScanType | undefined;
+        facilityNameLike?: string | undefined;
+        facilityId?: number | undefined;
+      },
+    ]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
@@ -256,13 +262,14 @@ export function buildVendorsListVendorFacilityStatusesQuery(
   ) => Promise<VendorsListVendorFacilityStatusesQueryData>;
 } {
   return {
-    queryKey: queryKeyVendorsListVendorFacilityStatuses({
+    queryKey: queryKeyVendorsListVendorFacilityStatuses(request.vendorIdOrMe, {
       sort: request.sort,
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       scanType: request.scanType,
       facilityNameLike: request.facilityNameLike,
+      facilityId: request.facilityId,
     }),
     queryFn: async function vendorsListVendorFacilityStatusesQueryFn(
       ctx,
@@ -296,13 +303,14 @@ export function buildVendorsListVendorFacilityStatusesInfiniteQuery(
   ) => Promise<VendorsListVendorFacilityStatusesInfiniteQueryData>;
 } {
   return {
-    queryKey: queryKeyVendorsListVendorFacilityStatuses({
+    queryKey: queryKeyVendorsListVendorFacilityStatuses(request.vendorIdOrMe, {
       sort: request.sort,
       desc: request.desc,
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       scanType: request.scanType,
       facilityNameLike: request.facilityNameLike,
+      facilityId: request.facilityId,
     }),
     queryFn: async function vendorsListVendorFacilityStatusesQuery(
       ctx,
@@ -334,6 +342,7 @@ export function buildVendorsListVendorFacilityStatusesInfiniteQuery(
 }
 
 export function queryKeyVendorsListVendorFacilityStatuses(
+  vendorIdOrMe: string,
   parameters: {
     sort?: string | null | undefined;
     desc?: components.Desc | undefined;
@@ -341,12 +350,14 @@ export function queryKeyVendorsListVendorFacilityStatuses(
     itemsPerPage?: number | undefined;
     scanType?: components.ScanType | undefined;
     facilityNameLike?: string | undefined;
+    facilityId?: number | undefined;
   },
 ): QueryKey {
   return [
     "@greensecurity/javascript-sdk",
     "vendors",
     "listVendorFacilityStatuses",
+    vendorIdOrMe,
     parameters,
   ];
 }

package/src/react-query/zonesGetSecurityZone.ts

@@ -33,6 +33,12 @@ export type ZonesGetSecurityZoneQueryData = components.Zone;
  *
  * @remarks
  * Get security zone details
+ *
+ * Available `expand` scopes are:
+ *
+ * - zone.facility
+ * - zone.department
+ * - zone.rules
  */
 export function useZonesGetSecurityZone(
   request: operations.GetSecurityZoneRequest,
@@ -54,6 +60,12 @@ export function useZonesGetSecurityZone(
  *
  * @remarks
  * Get security zone details
+ *
+ * Available `expand` scopes are:
+ *
+ * - zone.facility
+ * - zone.department
+ * - zone.rules
  */
 export function useZonesGetSecurityZoneSuspense(
   request: operations.GetSecurityZoneRequest,
@@ -85,7 +97,10 @@ export function prefetchZonesGetSecurityZone(
 
 export function setZonesGetSecurityZoneData(
   client: QueryClient,
-  queryKeyBase: [id: number],
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
   data: ZonesGetSecurityZoneQueryData,
 ): ZonesGetSecurityZoneQueryData | undefined {
   const key = queryKeyZonesGetSecurityZone(...queryKeyBase);
@@ -95,7 +110,9 @@ export function setZonesGetSecurityZoneData(
 
 export function invalidateZonesGetSecurityZone(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[id: number]>,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({
@@ -130,7 +147,9 @@ export function buildZonesGetSecurityZoneQuery(
   ) => Promise<ZonesGetSecurityZoneQueryData>;
 } {
   return {
-    queryKey: queryKeyZonesGetSecurityZone(request.id),
+    queryKey: queryKeyZonesGetSecurityZone(request.id, {
+      expand: request.expand,
+    }),
     queryFn: async function zonesGetSecurityZoneQueryFn(
       ctx,
     ): Promise<ZonesGetSecurityZoneQueryData> {
@@ -149,6 +168,15 @@ export function buildZonesGetSecurityZoneQuery(
   };
 }
 
-export function queryKeyZonesGetSecurityZone(id: number): QueryKey {
-  return ["@greensecurity/javascript-sdk", "zones", "getSecurityZone", id];
+export function queryKeyZonesGetSecurityZone(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "zones",
+    "getSecurityZone",
+    id,
+    parameters,
+  ];
 }

package/src/sdk/users.ts

@@ -9,6 +9,7 @@ import { usersMagiclink } from "../funcs/usersMagiclink.js";
 import { usersPassword } from "../funcs/usersPassword.js";
 import { usersPasswordResetRequest } from "../funcs/usersPasswordResetRequest.js";
 import { usersPostAuthenticate } from "../funcs/usersPostAuthenticate.js";
+import { usersRotateApiKey } from "../funcs/usersRotateApiKey.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -94,6 +95,21 @@ export class Users extends ClientSDK {
     ));
   }
 
+  /**
+   * Rotate API key
+   *
+   * @remarks
+   * Allows an API user to rotate their own API key. Note, the key rotation happens immediately so the user should be prepared to update their API key in their application for all subsequent requests.
+   */
+  async rotateApiKey(
+    options?: RequestOptions,
+  ): Promise<operations.RotateApiKeyRotateApiKeyOk> {
+    return unwrapAsync(usersRotateApiKey(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Magic link
    *

package/src/sdk/zones.ts

@@ -36,6 +36,12 @@ export class Zones extends ClientSDK {
    *
    * @remarks
    * Get security zone details
+   *
+   * Available `expand` scopes are:
+   *
+   * - zone.facility
+   * - zone.department
+   * - zone.rules
    */
   async getSecurityZone(
     request: operations.GetSecurityZoneRequest,