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

package/src/react-query/organizationsListFacilityVendors.ts

@@ -0,0 +1,351 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+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 {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildOrganizationsListFacilityVendorsInfiniteQuery,
+  buildOrganizationsListFacilityVendorsQuery,
+  OrganizationsListFacilityVendorsInfiniteQueryData,
+  OrganizationsListFacilityVendorsPageParams,
+  OrganizationsListFacilityVendorsQueryData,
+  prefetchOrganizationsListFacilityVendors,
+  prefetchOrganizationsListFacilityVendorsInfinite,
+  queryKeyOrganizationsListFacilityVendors,
+  queryKeyOrganizationsListFacilityVendorsInfinite,
+} from "./organizationsListFacilityVendors.core.js";
+export {
+  buildOrganizationsListFacilityVendorsInfiniteQuery,
+  buildOrganizationsListFacilityVendorsQuery,
+  type OrganizationsListFacilityVendorsInfiniteQueryData,
+  type OrganizationsListFacilityVendorsPageParams,
+  type OrganizationsListFacilityVendorsQueryData,
+  prefetchOrganizationsListFacilityVendors,
+  prefetchOrganizationsListFacilityVendorsInfinite,
+  queryKeyOrganizationsListFacilityVendors,
+  queryKeyOrganizationsListFacilityVendorsInfinite,
+};
+
+export type OrganizationsListFacilityVendorsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ */
+export function useOrganizationsListFacilityVendors(
+  request: operations.ListFacilityVendorsRequest,
+  options?: QueryHookOptions<
+    OrganizationsListFacilityVendorsQueryData,
+    OrganizationsListFacilityVendorsQueryError
+  >,
+): UseQueryResult<
+  OrganizationsListFacilityVendorsQueryData,
+  OrganizationsListFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsListFacilityVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ */
+export function useOrganizationsListFacilityVendorsSuspense(
+  request: operations.ListFacilityVendorsRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsListFacilityVendorsQueryData,
+    OrganizationsListFacilityVendorsQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsListFacilityVendorsQueryData,
+  OrganizationsListFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsListFacilityVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ */
+export function useOrganizationsListFacilityVendorsInfinite(
+  request: operations.ListFacilityVendorsRequest,
+  options?: InfiniteQueryHookOptions<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsPageParams
+  >,
+  OrganizationsListFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsQueryError,
+    InfiniteData<
+      OrganizationsListFacilityVendorsInfiniteQueryData,
+      OrganizationsListFacilityVendorsPageParams
+    >,
+    QueryKey,
+    OrganizationsListFacilityVendorsPageParams
+  >({
+    ...buildOrganizationsListFacilityVendorsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendors targeting a facility
+ *
+ * @remarks
+ * Powers the Company Portal → Facility Details page. Returns the
+ * paginated list of company-scoped vendor reps that are targeting the
+ * given facility, with each row carrying the rep's name + email, their
+ * last visit to this facility, their facility access status, and any
+ * company custom fields the company has flagged `show_to_vendor` (which
+ * is where the "Employee ID" column on the UI lives).
+ *
+ * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+ * single status tab. Pass `search=<term>` for a single search box that
+ * matches first name, last name, full name, email, OR any visible custom
+ * field value (covering the "search by name / email / Employee ID"
+ * requirement).
+ *
+ * Access control:
+ *   * Regular users: the URL's `:id` must be in the caller's read scope for
+ *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users: must pass `company_id`. Both the company and the facility
+ *     must be activated for the caller's marketplace app
+ *     (`MarketplaceAppActivation`).
+ */
+export function useOrganizationsListFacilityVendorsInfiniteSuspense(
+  request: operations.ListFacilityVendorsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsPageParams
+  >,
+  OrganizationsListFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    OrganizationsListFacilityVendorsInfiniteQueryData,
+    OrganizationsListFacilityVendorsQueryError,
+    InfiniteData<
+      OrganizationsListFacilityVendorsInfiniteQueryData,
+      OrganizationsListFacilityVendorsPageParams
+    >,
+    QueryKey,
+    OrganizationsListFacilityVendorsPageParams
+  >({
+    ...buildOrganizationsListFacilityVendorsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setOrganizationsListFacilityVendorsData(
+  client: QueryClient,
+  queryKeyBase: [
+    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;
+    },
+  ],
+  data: OrganizationsListFacilityVendorsQueryData,
+): OrganizationsListFacilityVendorsQueryData | undefined {
+  const key = queryKeyOrganizationsListFacilityVendors(...queryKeyBase);
+
+  return client.setQueryData<OrganizationsListFacilityVendorsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateOrganizationsListFacilityVendors(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      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;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listFacilityVendors",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsListFacilityVendors(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listFacilityVendors",
+    ],
+  });
+}

package/src/sdk/organizations.ts

@@ -6,6 +6,7 @@ import { organizationsDownloadCompanyTargetFacilitiesExport } from "../funcs/org
 import { organizationsExportCompanyTargetFacilities } from "../funcs/organizationsExportCompanyTargetFacilities.js";
 import { organizationsGetCompanyTargetFacilitiesExportStatus } from "../funcs/organizationsGetCompanyTargetFacilitiesExportStatus.js";
 import { organizationsGetFacility } from "../funcs/organizationsGetFacility.js";
+import { organizationsListFacilityVendors } from "../funcs/organizationsListFacilityVendors.js";
 import { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.js";
 import { organizationsListOrSearchDepartments } from "../funcs/organizationsListOrSearchDepartments.js";
 import { organizationsListOrSearchFacilities } from "../funcs/organizationsListOrSearchFacilities.js";
@@ -146,6 +147,44 @@ export class Organizations extends ClientSDK {
     ));
   }
 
+  /**
+   * List vendors targeting a facility
+   *
+   * @remarks
+   * Powers the Company Portal → Facility Details page. Returns the
+   * paginated list of company-scoped vendor reps that are targeting the
+   * given facility, with each row carrying the rep's name + email, their
+   * last visit to this facility, their facility access status, and any
+   * company custom fields the company has flagged `show_to_vendor` (which
+   * is where the "Employee ID" column on the UI lives).
+   *
+   * Filtering: pass `status=approved|pending|denied` to scope the rows to a
+   * single status tab. Pass `search=<term>` for a single search box that
+   * matches first name, last name, full name, email, OR any visible custom
+   * field value (covering the "search by name / email / Employee ID"
+   * requirement).
+   *
+   * Access control:
+   *   * Regular users: the URL's `:id` must be in the caller's read scope for
+   *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+   *     soft-deleted facilities return `404 Facility not found`.
+   *   * API users: must pass `company_id`. Both the company and the facility
+   *     must be activated for the caller's marketplace app
+   *     (`MarketplaceAppActivation`).
+   */
+  async listFacilityVendors(
+    request: operations.ListFacilityVendorsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListFacilityVendorsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(organizationsListFacilityVendors(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List or search department contacts
    *