@greensecurity/javascript-sdk 0.43.1-beta.124 → 0.43.1-beta.125

package/src/models/operations/createvendorbycompanymanager.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4813c9f81c74
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreateVendorByCompanyManagerRequestBody = {
+  /**
+   * The vendor's email address
+   */
+  email: string;
+  /**
+   * Vendor's first name
+   */
+  firstName: string;
+  /**
+   * Vendor's last name
+   */
+  lastName: string;
+  /**
+   * Vendor's job title (free text)
+   */
+  title: string;
+  /**
+   * Vendor's phone number
+   */
+  phone: string;
+  /**
+   * Vendor's fax number (optional)
+   */
+  fax?: string | undefined;
+  /**
+   * Rails timezone name (e.g. Eastern Time (US & Canada))
+   */
+  timezone?: string | undefined;
+  /**
+   * Whether the vendor has been listed by a federal agency as disbarred or excluded
+   */
+  federal?: boolean | undefined;
+  /**
+   * ID of the vendor's primary facility
+   */
+  primaryFacilityId: number;
+  /**
+   * Vendor's supervisor name
+   */
+  supervisorName: string;
+  /**
+   * Vendor's supervisor email
+   */
+  supervisorEmail: string;
+  /**
+   * Vendor's supervisor phone
+   */
+  supervisorPhone: string;
+  /**
+   * Country code (e.g. US, CA)
+   */
+  country: string;
+  /**
+   * Street address line 1
+   */
+  address1: string;
+  /**
+   * Street address line 2 (optional)
+   */
+  address2?: string | undefined;
+  /**
+   * City
+   */
+  city: string;
+  /**
+   * State or province code
+   */
+  state: string;
+  /**
+   * Zip or postal code
+   */
+  zip: string;
+  /**
+   * Required for API users. The company manager user ID to act on behalf of.
+   *
+   * @remarks
+   * The marketplace app must be activated for this user.
+   */
+  sourceUserId?: number | undefined;
+};
+
+/**
+ * Vendor created successfully.
+ */
+export type CreateVendorByCompanyManagerResponseBody = {
+  /**
+   * ID of the newly created vendor
+   */
+  vendorId: number;
+};
+
+/** @internal */
+export type CreateVendorByCompanyManagerRequestBody$Outbound = {
+  email: string;
+  first_name: string;
+  last_name: string;
+  title: string;
+  phone: string;
+  fax?: string | undefined;
+  timezone?: string | undefined;
+  federal?: boolean | undefined;
+  primary_facility_id: number;
+  supervisor_name: string;
+  supervisor_email: string;
+  supervisor_phone: string;
+  country: string;
+  address1: string;
+  address2?: string | undefined;
+  city: string;
+  state: string;
+  zip: string;
+  source_user_id?: number | undefined;
+};
+
+/** @internal */
+export const CreateVendorByCompanyManagerRequestBody$outboundSchema: z.ZodType<
+  CreateVendorByCompanyManagerRequestBody$Outbound,
+  z.ZodTypeDef,
+  CreateVendorByCompanyManagerRequestBody
+> = z.object({
+  email: z.string(),
+  firstName: z.string(),
+  lastName: z.string(),
+  title: z.string(),
+  phone: z.string(),
+  fax: z.string().optional(),
+  timezone: z.string().optional(),
+  federal: z.boolean().optional(),
+  primaryFacilityId: z.number().int(),
+  supervisorName: z.string(),
+  supervisorEmail: z.string(),
+  supervisorPhone: z.string(),
+  country: z.string(),
+  address1: z.string(),
+  address2: z.string().optional(),
+  city: z.string(),
+  state: z.string(),
+  zip: z.string(),
+  sourceUserId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    firstName: "first_name",
+    lastName: "last_name",
+    primaryFacilityId: "primary_facility_id",
+    supervisorName: "supervisor_name",
+    supervisorEmail: "supervisor_email",
+    supervisorPhone: "supervisor_phone",
+    sourceUserId: "source_user_id",
+  });
+});
+
+export function createVendorByCompanyManagerRequestBodyToJSON(
+  createVendorByCompanyManagerRequestBody:
+    CreateVendorByCompanyManagerRequestBody,
+): string {
+  return JSON.stringify(
+    CreateVendorByCompanyManagerRequestBody$outboundSchema.parse(
+      createVendorByCompanyManagerRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export const CreateVendorByCompanyManagerResponseBody$inboundSchema: z.ZodType<
+  CreateVendorByCompanyManagerResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vendor_id: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id": "vendorId",
+  });
+});
+
+export function createVendorByCompanyManagerResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CreateVendorByCompanyManagerResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CreateVendorByCompanyManagerResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CreateVendorByCompanyManagerResponseBody' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -19,6 +19,7 @@ export * from "./createevent.js";
 export * from "./createinvoice.js";
 export * from "./createnewvendorcredentialversion.js";
 export * from "./createorupdatebcr.js";
+export * from "./createvendorbycompanymanager.js";
 export * from "./createvendorcompany.js";
 export * from "./createvendorfield.js";
 export * from "./createvendorregistration.js";
@@ -60,6 +61,7 @@ export * from "./listcompanymanagers.js";
 export * from "./listfeed.js";
 export * from "./listinvoices.js";
 export * from "./listlocations.js";
+export * from "./listlookupsystems.js";
 export * from "./listoffhirconfigurations.js";
 export * from "./listorsearchcompanies.js";
 export * from "./listorsearchdepartmentcontacts.js";

package/src/models/operations/listlookupsystems.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d2e563b6fe83
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Expand = {
+  SystemFacilities: "system.facilities",
+} as const;
+export type Expand = ClosedEnum<typeof Expand>;
+
+/**
+ * Filter systems to those with facilities of the given use type.
+ */
+export const Use = {
+  Credentialing: "credentialing",
+  VisitorManagement: "visitor_management",
+} as const;
+/**
+ * Filter systems to those with facilities of the given use type.
+ */
+export type Use = ClosedEnum<typeof Use>;
+
+export type ListLookupSystemsRequest = {
+  /**
+   * Expand values to include in the response. Allowed: `system.facilities`
+   */
+  expand?: Array<Expand> | undefined;
+  /**
+   * Filter systems to those with facilities of the given use type.
+   */
+  use?: Use | undefined;
+};
+
+/**
+ * The request was successful.
+ */
+export type ListLookupSystemsResponseBody = {
+  systems: Array<components.SystemSummary>;
+};
+
+/** @internal */
+export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
+  .nativeEnum(Expand);
+
+/** @internal */
+export const Use$outboundSchema: z.ZodNativeEnum<typeof Use> = z.nativeEnum(
+  Use,
+);
+
+/** @internal */
+export type ListLookupSystemsRequest$Outbound = {
+  expand?: Array<string> | undefined;
+  use?: string | undefined;
+};
+
+/** @internal */
+export const ListLookupSystemsRequest$outboundSchema: z.ZodType<
+  ListLookupSystemsRequest$Outbound,
+  z.ZodTypeDef,
+  ListLookupSystemsRequest
+> = z.object({
+  expand: z.array(Expand$outboundSchema).optional(),
+  use: Use$outboundSchema.optional(),
+});
+
+export function listLookupSystemsRequestToJSON(
+  listLookupSystemsRequest: ListLookupSystemsRequest,
+): string {
+  return JSON.stringify(
+    ListLookupSystemsRequest$outboundSchema.parse(listLookupSystemsRequest),
+  );
+}
+
+/** @internal */
+export const ListLookupSystemsResponseBody$inboundSchema: z.ZodType<
+  ListLookupSystemsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  systems: z.array(components.SystemSummary$inboundSchema),
+});
+
+export function listLookupSystemsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListLookupSystemsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListLookupSystemsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListLookupSystemsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/securityzonecheckin.ts

@@ -50,10 +50,12 @@ export type SecurityZoneCheckinRequestBody2 = {
   expand?: Array<RequestBodyExpand> | undefined;
 };
 
-export const Expand = {
+export const SecurityZoneCheckinRequestBodyExpand = {
   VendorScanBadgeData: "vendor_scan.badge_data",
 } as const;
-export type Expand = ClosedEnum<typeof Expand>;
+export type SecurityZoneCheckinRequestBodyExpand = ClosedEnum<
+  typeof SecurityZoneCheckinRequestBodyExpand
+>;
 
 export type One = {
   /**
@@ -84,7 +86,7 @@ export type One = {
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
   temperature?: number | undefined;
-  expand?: Array<Expand> | undefined;
+  expand?: Array<SecurityZoneCheckinRequestBodyExpand> | undefined;
 };
 
 export type SecurityZoneCheckinRequestBody =
@@ -231,8 +233,10 @@ export function securityZoneCheckinRequestBody2ToJSON(
 }
 
 /** @internal */
-export const Expand$outboundSchema: z.ZodNativeEnum<typeof Expand> = z
-  .nativeEnum(Expand);
+export const SecurityZoneCheckinRequestBodyExpand$outboundSchema:
+  z.ZodNativeEnum<typeof SecurityZoneCheckinRequestBodyExpand> = z.nativeEnum(
+    SecurityZoneCheckinRequestBodyExpand,
+  );
 
 /** @internal */
 export type One$Outbound = {
@@ -280,7 +284,8 @@ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
     scanType: components.ScanType$outboundSchema.optional(),
     recheckVendorScanId: z.number().int().optional(),
     temperature: z.number().optional(),
-    expand: z.array(Expand$outboundSchema).optional(),
+    expand: z.array(SecurityZoneCheckinRequestBodyExpand$outboundSchema)
+      .optional(),
   }).transform((v) => {
     return remap$(v, {
       qrCode: "qr_code",

package/src/react-query/index.ts

@@ -40,6 +40,7 @@ export * from "./invoicesInvoicesExport.js";
 export * from "./invoicesListInvoices.js";
 export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";
+export * from "./lookupsListLookupSystems.js";
 export * from "./mobileDevicesAddMobileDevice.js";
 export * from "./organizationsGetFacility.js";
 export * from "./organizationsListOrSearchDepartmentContacts.js";
@@ -77,6 +78,7 @@ export * from "./vendorsChangeSubscription.js";
 export * from "./vendorsCheckDownloadCode.js";
 export * from "./vendorsCreateNewVendorCredentialVersion.js";
 export * from "./vendorsCreateOrUpdateBcr.js";
+export * from "./vendorsCreateVendorByCompanyManager.js";
 export * from "./vendorsCreateVendorCompany.js";
 export * from "./vendorsCreateVendorRegistration.js";
 export * from "./vendorsDeclineVendorCredential.js";

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

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: dcc4b9055b7d
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { lookupsListLookupSystems } from "../funcs/lookupsListLookupSystems.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 LookupsListLookupSystemsQueryData =
+  operations.ListLookupSystemsResponseBody;
+
+export function prefetchLookupsListLookupSystems(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListLookupSystemsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildLookupsListLookupSystemsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListLookupSystemsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<LookupsListLookupSystemsQueryData>;
+} {
+  return {
+    queryKey: queryKeyLookupsListLookupSystems({
+      expand: request.expand,
+      use: request.use,
+    }),
+    queryFn: async function lookupsListLookupSystemsQueryFn(
+      ctx,
+    ): Promise<LookupsListLookupSystemsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(lookupsListLookupSystems(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyLookupsListLookupSystems(
+  parameters: {
+    expand?: Array<operations.Expand> | undefined;
+    use?: operations.Use | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "lookups",
+    "listLookupSystems",
+    parameters,
+  ];
+}

package/src/react-query/lookupsListLookupSystems.ts

@@ -0,0 +1,168 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a3c073cb1932
+ */
+
+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 {
+  buildLookupsListLookupSystemsQuery,
+  LookupsListLookupSystemsQueryData,
+  prefetchLookupsListLookupSystems,
+  queryKeyLookupsListLookupSystems,
+} from "./lookupsListLookupSystems.core.js";
+export {
+  buildLookupsListLookupSystemsQuery,
+  type LookupsListLookupSystemsQueryData,
+  prefetchLookupsListLookupSystems,
+  queryKeyLookupsListLookupSystems,
+};
+
+export type LookupsListLookupSystemsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List systems for dropdown/picker use
+ *
+ * @remarks
+ * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
+ * Designed for lightweight dropdown and picker UIs.
+ *
+ * - **Company manager**: returns systems scoped to their site.
+ * - **Vendor**: returns systems available to that vendor.
+ * - **API user**: returns systems scoped to their MarketplaceAppActivation (facility, system, or site level).
+ *
+ * Use `expand=system.facilities` to include the facilities array on each system.
+ */
+export function useLookupsListLookupSystems(
+  request: operations.ListLookupSystemsRequest,
+  options?: QueryHookOptions<
+    LookupsListLookupSystemsQueryData,
+    LookupsListLookupSystemsQueryError
+  >,
+): UseQueryResult<
+  LookupsListLookupSystemsQueryData,
+  LookupsListLookupSystemsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List systems for dropdown/picker use
+ *
+ * @remarks
+ * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
+ * Designed for lightweight dropdown and picker UIs.
+ *
+ * - **Company manager**: returns systems scoped to their site.
+ * - **Vendor**: returns systems available to that vendor.
+ * - **API user**: returns systems scoped to their MarketplaceAppActivation (facility, system, or site level).
+ *
+ * Use `expand=system.facilities` to include the facilities array on each system.
+ */
+export function useLookupsListLookupSystemsSuspense(
+  request: operations.ListLookupSystemsRequest,
+  options?: SuspenseQueryHookOptions<
+    LookupsListLookupSystemsQueryData,
+    LookupsListLookupSystemsQueryError
+  >,
+): UseSuspenseQueryResult<
+  LookupsListLookupSystemsQueryData,
+  LookupsListLookupSystemsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildLookupsListLookupSystemsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setLookupsListLookupSystemsData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      expand?: Array<operations.Expand> | undefined;
+      use?: operations.Use | undefined;
+    },
+  ],
+  data: LookupsListLookupSystemsQueryData,
+): LookupsListLookupSystemsQueryData | undefined {
+  const key = queryKeyLookupsListLookupSystems(...queryKeyBase);
+
+  return client.setQueryData<LookupsListLookupSystemsQueryData>(key, data);
+}
+
+export function invalidateLookupsListLookupSystems(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      expand?: Array<operations.Expand> | undefined;
+      use?: operations.Use | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "lookups",
+      "listLookupSystems",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllLookupsListLookupSystems(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "lookups", "listLookupSystems"],
+  });
+}