@greensecurity/javascript-sdk 0.44.0-beta.4 → 0.44.0-beta.40

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.ListFacilityVendorsQueryParamStatus | 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.ListFacilityVendorsQueryParamStatus | 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,
+  ];
+}

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.ListFacilityVendorsQueryParamStatus | 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.ListFacilityVendorsQueryParamStatus | 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/react-query/usersGetLinkedUsers.core.ts

@@ -67,7 +67,7 @@ export function buildUsersGetLinkedUsersQuery(
 }
 
 export function queryKeyUsersGetLinkedUsers(
-  parameters: { userId?: number | undefined },
+  parameters: { userId: string },
 ): QueryKey {
   return [
     "@greensecurity/javascript-sdk",

package/src/react-query/usersGetLinkedUsers.ts

@@ -56,12 +56,14 @@ export type UsersGetLinkedUsersQueryError =
  * Get linked users
  *
  * @remarks
- * Returns a list of users linked to the authenticated user.
+ * Returns a list of users linked to the requested user.
  *
- * For regular users, returns their own linked users.
+ * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+ * is allowed for any authenticated user type.
  *
- * For API users, the `user_id` parameter is required. The API user must
- * have an active app activation for the requested user.
+ * API users may additionally pass a numeric `user_id` to fetch another user's
+ * linked users, provided they have an active app activation for that user.
+ * Non-API users may only pass `me`.
  */
 export function useUsersGetLinkedUsers(
   request: operations.GetLinkedUsersRequest,
@@ -85,12 +87,14 @@ export function useUsersGetLinkedUsers(
  * Get linked users
  *
  * @remarks
- * Returns a list of users linked to the authenticated user.
+ * Returns a list of users linked to the requested user.
  *
- * For regular users, returns their own linked users.
+ * Pass `user_id=me` to fetch the linked users of the authenticated user. This
+ * is allowed for any authenticated user type.
  *
- * For API users, the `user_id` parameter is required. The API user must
- * have an active app activation for the requested user.
+ * API users may additionally pass a numeric `user_id` to fetch another user's
+ * linked users, provided they have an active app activation for that user.
+ * Non-API users may only pass `me`.
  */
 export function useUsersGetLinkedUsersSuspense(
   request: operations.GetLinkedUsersRequest,
@@ -115,7 +119,7 @@ export function useUsersGetLinkedUsersSuspense(
 
 export function setUsersGetLinkedUsersData(
   client: QueryClient,
-  queryKeyBase: [parameters: { userId?: number | undefined }],
+  queryKeyBase: [parameters: { userId: string }],
   data: UsersGetLinkedUsersQueryData,
 ): UsersGetLinkedUsersQueryData | undefined {
   const key = queryKeyUsersGetLinkedUsers(...queryKeyBase);
@@ -125,7 +129,7 @@ export function setUsersGetLinkedUsersData(
 
 export function invalidateUsersGetLinkedUsers(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[parameters: { userId?: number | undefined }]>,
+  queryKeyBase: TupleToPrefixes<[parameters: { userId: string }]>,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({