@greensecurity/javascript-sdk 0.44.0-beta.12 → 0.44.0-beta.14

package/src/models/operations/listfacilityvendors.ts

@@ -0,0 +1,307 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export const QueryParamStatus = {
+  Approved: "approved",
+  Pending: "pending",
+  Denied: "denied",
+} as const;
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * Sort field. Defaults to `name`.
+ */
+export const ListFacilityVendorsQueryParamSort = {
+  Id: "id",
+  Name: "name",
+  LastName: "last_name",
+  Email: "email",
+  Status: "status",
+} as const;
+/**
+ * Sort field. Defaults to `name`.
+ */
+export type ListFacilityVendorsQueryParamSort = ClosedEnum<
+  typeof ListFacilityVendorsQueryParamSort
+>;
+
+export type ListFacilityVendorsRequest = {
+  /**
+   * The facility whose vendor roster to list.
+   */
+  id: number;
+  /**
+   * API users only — the company whose vendors to list. Ignored for company managers / vendors (resolved from the session).
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter rows to a single facility access status. Omit for "All".
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * Single search term applied case-insensitively across first name,
+   *
+   * @remarks
+   * last name, full name, email, and any company custom-field value the
+   * vendor has set for a field flagged `show_to_vendor`.
+   */
+  search?: string | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Sort field. Defaults to `name`.
+   */
+  sort?: ListFacilityVendorsQueryParamSort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+};
+
+/**
+ * Facility access status from `target_facilities.status`.
+ */
+export const ListFacilityVendorsStatus = {
+  Approved: "Approved",
+  Pending: "Pending",
+  Denied: "Denied",
+} as const;
+/**
+ * Facility access status from `target_facilities.status`.
+ */
+export type ListFacilityVendorsStatus = OpenEnum<
+  typeof ListFacilityVendorsStatus
+>;
+
+export type CustomFields = {
+  id?: number | undefined;
+  name?: string | undefined;
+  value?: string | null | undefined;
+};
+
+export type Items = {
+  /**
+   * Vendor ID.
+   */
+  id?: number | undefined;
+  /**
+   * Vendor's full name (`first_name + last_name`).
+   */
+  name?: string | null | undefined;
+  /**
+   * Vendor's email.
+   */
+  email?: string | null | undefined;
+  /**
+   * Thumbnail URL for the vendor's head shot.
+   */
+  imageUrl?: string | null | undefined;
+  /**
+   * ISO8601 timestamp of the vendor's most recent scan at this facility, or null if they have never visited.
+   */
+  lastVisit?: string | null | undefined;
+  /**
+   * Facility access status from `target_facilities.status`.
+   */
+  status?: ListFacilityVendorsStatus | null | undefined;
+  /**
+   * Company custom fields flagged `show_to_vendor`. One entry per enabled field; `value` is null when the vendor has no value set.
+   */
+  customFields?: Array<CustomFields> | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListFacilityVendorsListFacilityVendorsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<Items>;
+};
+
+export type ListFacilityVendorsResponse = {
+  result: ListFacilityVendorsListFacilityVendorsOk;
+};
+
+/** @internal */
+export const QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const ListFacilityVendorsQueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof ListFacilityVendorsQueryParamSort
+> = z.nativeEnum(ListFacilityVendorsQueryParamSort);
+
+/** @internal */
+export type ListFacilityVendorsRequest$Outbound = {
+  id: number;
+  company_id?: number | undefined;
+  status?: string | undefined;
+  search?: string | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+};
+
+/** @internal */
+export const ListFacilityVendorsRequest$outboundSchema: z.ZodType<
+  ListFacilityVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListFacilityVendorsRequest
+> = z.object({
+  id: z.number().int(),
+  companyId: z.number().int().optional(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  search: z.string().optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  sort: ListFacilityVendorsQueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listFacilityVendorsRequestToJSON(
+  listFacilityVendorsRequest: ListFacilityVendorsRequest,
+): string {
+  return JSON.stringify(
+    ListFacilityVendorsRequest$outboundSchema.parse(listFacilityVendorsRequest),
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsStatus$inboundSchema: z.ZodType<
+  ListFacilityVendorsStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListFacilityVendorsStatus);
+
+/** @internal */
+export const CustomFields$inboundSchema: z.ZodType<
+  CustomFields,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  name: types.optional(types.string()),
+  value: z.nullable(types.string()).optional(),
+});
+
+export function customFieldsFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomFields, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomFields$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomFields' from JSON`,
+  );
+}
+
+/** @internal */
+export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    name: z.nullable(types.string()).optional(),
+    email: z.nullable(types.string()).optional(),
+    image_url: z.nullable(types.string()).optional(),
+    last_visit: z.nullable(types.string()).optional(),
+    status: z.nullable(ListFacilityVendorsStatus$inboundSchema).optional(),
+    custom_fields: types.optional(
+      z.array(z.lazy(() => CustomFields$inboundSchema)),
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "image_url": "imageUrl",
+      "last_visit": "lastVisit",
+      "custom_fields": "customFields",
+    });
+  });
+
+export function itemsFromJSON(
+  jsonString: string,
+): SafeParseResult<Items, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Items$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Items' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsListFacilityVendorsOk$inboundSchema: z.ZodType<
+  ListFacilityVendorsListFacilityVendorsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(z.lazy(() => Items$inboundSchema)),
+});
+
+export function listFacilityVendorsListFacilityVendorsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListFacilityVendorsListFacilityVendorsOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListFacilityVendorsListFacilityVendorsOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListFacilityVendorsListFacilityVendorsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListFacilityVendorsResponse$inboundSchema: z.ZodType<
+  ListFacilityVendorsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListFacilityVendorsListFacilityVendorsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listFacilityVendorsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListFacilityVendorsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListFacilityVendorsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListFacilityVendorsResponse' from JSON`,
+  );
+}

package/src/models/operations/listvendoradditionalfacilityfields.ts

@@ -42,7 +42,7 @@ export type ListVendorAdditionalFacilityFieldsRequest = {
 /**
  * Legacy VendorFieldValue row (deprecated shape).
  */
-export type Items = {
+export type ListVendorAdditionalFacilityFieldsItems = {
   /**
    * VendorFieldValue id
    */
@@ -61,7 +61,7 @@ export type Items = {
  */
 export type ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk =
   {
-    items: Array<Items>;
+    items: Array<ListVendorAdditionalFacilityFieldsItems>;
     /**
      * Pagination information for a pageable list
      */
@@ -113,22 +113,31 @@ export function listVendorAdditionalFacilityFieldsRequestToJSON(
 }
 
 /** @internal */
-export const Items$inboundSchema: z.ZodType<Items, z.ZodTypeDef, unknown> = z
-  .object({
-    id: types.optional(types.number()),
-    system: z.nullable(types.string()).optional(),
-    facility: z.nullable(types.string()).optional(),
-    field: z.nullable(types.string()).optional(),
-    value: z.nullable(types.string()).optional(),
-  });
+export const ListVendorAdditionalFacilityFieldsItems$inboundSchema: z.ZodType<
+  ListVendorAdditionalFacilityFieldsItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  system: z.nullable(types.string()).optional(),
+  facility: z.nullable(types.string()).optional(),
+  field: z.nullable(types.string()).optional(),
+  value: z.nullable(types.string()).optional(),
+});
 
-export function itemsFromJSON(
+export function listVendorAdditionalFacilityFieldsItemsFromJSON(
   jsonString: string,
-): SafeParseResult<Items, SDKValidationError> {
+): SafeParseResult<
+  ListVendorAdditionalFacilityFieldsItems,
+  SDKValidationError
+> {
   return safeParse(
     jsonString,
-    (x) => Items$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Items' from JSON`,
+    (x) =>
+      ListVendorAdditionalFacilityFieldsItems$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListVendorAdditionalFacilityFieldsItems' from JSON`,
   );
 }
 
@@ -139,7 +148,9 @@ export const ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityField
     z.ZodTypeDef,
     unknown
   > = z.object({
-    items: z.array(z.lazy(() => Items$inboundSchema)),
+    items: z.array(
+      z.lazy(() => ListVendorAdditionalFacilityFieldsItems$inboundSchema),
+    ),
     pager: components.Pager$inboundSchema,
   });
 

package/src/react-query/index.ts

@@ -47,6 +47,7 @@ export * from "./organizationsDownloadCompanyTargetFacilitiesExport.js";
 export * from "./organizationsExportCompanyTargetFacilities.js";
 export * from "./organizationsGetCompanyTargetFacilitiesExportStatus.js";
 export * from "./organizationsGetFacility.js";
+export * from "./organizationsListFacilityVendors.js";
 export * from "./organizationsListOrSearchDepartmentContacts.js";
 export * from "./organizationsListOrSearchDepartments.js";
 export * from "./organizationsListOrSearchFacilities.js";

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

@@ -80,7 +80,9 @@ export function buildOrganizationsExportCompanyTargetFacilitiesQuery(
 export function queryKeyOrganizationsExportCompanyTargetFacilities(
   companyId: number,
   parameters: {
-    status?: operations.QueryParamStatus | undefined;
+    status?:
+      | operations.ExportCompanyTargetFacilitiesQueryParamStatus
+      | undefined;
     hasIndividual?: operations.HasIndividual | undefined;
     hasActiveIndividual?: operations.HasActiveIndividual | undefined;
     facilityNameLike?: string | undefined;

package/src/react-query/organizationsExportCompanyTargetFacilities.ts

@@ -125,7 +125,9 @@ export function setOrganizationsExportCompanyTargetFacilitiesData(
   queryKeyBase: [
     companyId: number,
     parameters: {
-      status?: operations.QueryParamStatus | undefined;
+      status?:
+        | operations.ExportCompanyTargetFacilitiesQueryParamStatus
+        | undefined;
       hasIndividual?: operations.HasIndividual | undefined;
       hasActiveIndividual?: operations.HasActiveIndividual | undefined;
       facilityNameLike?: string | undefined;
@@ -151,7 +153,9 @@ export function invalidateOrganizationsExportCompanyTargetFacilities(
     [
       companyId: number,
       parameters: {
-        status?: operations.QueryParamStatus | undefined;
+        status?:
+          | operations.ExportCompanyTargetFacilitiesQueryParamStatus
+          | undefined;
         hasIndividual?: operations.HasIndividual | undefined;
         hasActiveIndividual?: operations.HasActiveIndividual | undefined;
         facilityNameLike?: string | undefined;

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

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsListFacilityVendors } from "../funcs/organizationsListFacilityVendors.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 OrganizationsListFacilityVendorsQueryData =
+  operations.ListFacilityVendorsResponse;
+
+export type OrganizationsListFacilityVendorsInfiniteQueryData = PageIterator<
+  operations.ListFacilityVendorsResponse,
+  { page: number }
+>;
+
+export type OrganizationsListFacilityVendorsPageParams = PageIterator<
+  operations.ListFacilityVendorsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchOrganizationsListFacilityVendors(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsListFacilityVendorsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchOrganizationsListFacilityVendorsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildOrganizationsListFacilityVendorsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as OrganizationsListFacilityVendorsPageParams,
+    getNextPageParam: (
+      previousPage: OrganizationsListFacilityVendorsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildOrganizationsListFacilityVendorsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsListFacilityVendorsQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListFacilityVendors(request.id, {
+      companyId: request.companyId,
+      status: request.status,
+      search: request.search,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      sort: request.sort,
+      desc: request.desc,
+    }),
+    queryFn: async function organizationsListFacilityVendorsQueryFn(
+      ctx,
+    ): Promise<OrganizationsListFacilityVendorsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(organizationsListFacilityVendors(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildOrganizationsListFacilityVendorsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListFacilityVendorsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      OrganizationsListFacilityVendorsPageParams
+    >,
+  ) => Promise<OrganizationsListFacilityVendorsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListFacilityVendorsInfinite(request.id, {
+      companyId: request.companyId,
+      status: request.status,
+      search: request.search,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      sort: request.sort,
+      desc: request.desc,
+    }),
+    queryFn: async function organizationsListFacilityVendorsQuery(
+      ctx,
+    ): Promise<OrganizationsListFacilityVendorsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          organizationsListFacilityVendors(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        organizationsListFacilityVendors(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyOrganizationsListFacilityVendors(
+  id: number,
+  parameters: {
+    companyId?: number | undefined;
+    status?: operations.QueryParamStatus | undefined;
+    search?: string | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    sort?: operations.ListFacilityVendorsQueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listFacilityVendors",
+    id,
+    parameters,
+  ];
+}
+
+export function queryKeyOrganizationsListFacilityVendorsInfinite(
+  id: number,
+  parameters: {
+    companyId?: number | undefined;
+    status?: operations.QueryParamStatus | undefined;
+    search?: string | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    sort?: operations.ListFacilityVendorsQueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listFacilityVendors",
+    "infinite",
+    id,
+    parameters,
+  ];
+}