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

package/src/react-query/organizationsGetCompanyTargetFacilitiesExportStatus.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  prefetchOrganizationsGetCompanyTargetFacilitiesExportStatus,
+  queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus,
+} from "./organizationsGetCompanyTargetFacilitiesExportStatus.core.js";
+export {
+  buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery,
+  type OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  prefetchOrganizationsGetCompanyTargetFacilitiesExportStatus,
+  queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus,
+};
+
+export type OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get company target facilities export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: QueryHookOptions<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+  >,
+): UseQueryResult<
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get company target facilities export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetCompanyTargetFacilitiesExportStatusSuspense(
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+  OrganizationsGetCompanyTargetFacilitiesExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setOrganizationsGetCompanyTargetFacilitiesExportStatusData(
+  client: QueryClient,
+  queryKeyBase: [companyId: number, id: string],
+  data: OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData,
+): OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData | undefined {
+  const key = queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData
+  >(key, data);
+}
+
+export function invalidateOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[companyId: number, id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getCompanyTargetFacilitiesExportStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getCompanyTargetFacilitiesExportStatus",
+    ],
+  });
+}

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

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsGetFacilityVendorsExportStatus } from "../funcs/organizationsGetFacilityVendorsExportStatus.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";
+export type OrganizationsGetFacilityVendorsExportStatusQueryData =
+  components.CsvExportStatusResponse;
+
+export function prefetchOrganizationsGetFacilityVendorsExportStatus(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsGetFacilityVendorsExportStatusQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildOrganizationsGetFacilityVendorsExportStatusQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsGetFacilityVendorsExportStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsGetFacilityVendorsExportStatus(
+      request.id,
+      request.exportId,
+    ),
+    queryFn: async function organizationsGetFacilityVendorsExportStatusQueryFn(
+      ctx,
+    ): Promise<OrganizationsGetFacilityVendorsExportStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(organizationsGetFacilityVendorsExportStatus(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyOrganizationsGetFacilityVendorsExportStatus(
+  id: number,
+  exportId: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "getFacilityVendorsExportStatus",
+    id,
+    exportId,
+  ];
+}

package/src/react-query/organizationsGetFacilityVendorsExportStatus.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  buildOrganizationsGetFacilityVendorsExportStatusQuery,
+  OrganizationsGetFacilityVendorsExportStatusQueryData,
+  prefetchOrganizationsGetFacilityVendorsExportStatus,
+  queryKeyOrganizationsGetFacilityVendorsExportStatus,
+} from "./organizationsGetFacilityVendorsExportStatus.core.js";
+export {
+  buildOrganizationsGetFacilityVendorsExportStatusQuery,
+  type OrganizationsGetFacilityVendorsExportStatusQueryData,
+  prefetchOrganizationsGetFacilityVendorsExportStatus,
+  queryKeyOrganizationsGetFacilityVendorsExportStatus,
+};
+
+export type OrganizationsGetFacilityVendorsExportStatusQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get facility vendors export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetFacilityVendorsExportStatus(
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: QueryHookOptions<
+    OrganizationsGetFacilityVendorsExportStatusQueryData,
+    OrganizationsGetFacilityVendorsExportStatusQueryError
+  >,
+): UseQueryResult<
+  OrganizationsGetFacilityVendorsExportStatusQueryData,
+  OrganizationsGetFacilityVendorsExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsGetFacilityVendorsExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get facility vendors export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useOrganizationsGetFacilityVendorsExportStatusSuspense(
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsGetFacilityVendorsExportStatusQueryData,
+    OrganizationsGetFacilityVendorsExportStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsGetFacilityVendorsExportStatusQueryData,
+  OrganizationsGetFacilityVendorsExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsGetFacilityVendorsExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setOrganizationsGetFacilityVendorsExportStatusData(
+  client: QueryClient,
+  queryKeyBase: [id: number, exportId: string],
+  data: OrganizationsGetFacilityVendorsExportStatusQueryData,
+): OrganizationsGetFacilityVendorsExportStatusQueryData | undefined {
+  const key = queryKeyOrganizationsGetFacilityVendorsExportStatus(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    OrganizationsGetFacilityVendorsExportStatusQueryData
+  >(key, data);
+}
+
+export function invalidateOrganizationsGetFacilityVendorsExportStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: number, exportId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getFacilityVendorsExportStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsGetFacilityVendorsExportStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "getFacilityVendorsExportStatus",
+    ],
+  });
+}

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

@@ -83,7 +83,13 @@ export function buildOrganizationsListCompanyTargetFacilitiesQuery(
         status: request.status,
         hasIndividual: request.hasIndividual,
         hasActiveIndividual: request.hasActiveIndividual,
+        includePotentialTargets: request.includePotentialTargets,
         facilityNameLike: request.facilityNameLike,
+        cityLike: request.cityLike,
+        stateLike: request.stateLike,
+        addressLike: request.addressLike,
+        systemNameLike: request.systemNameLike,
+        searchLike: request.searchLike,
         sort: request.sort,
         desc: request.desc,
         page: request.page,
@@ -134,7 +140,13 @@ export function buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery(
         status: request.status,
         hasIndividual: request.hasIndividual,
         hasActiveIndividual: request.hasActiveIndividual,
+        includePotentialTargets: request.includePotentialTargets,
         facilityNameLike: request.facilityNameLike,
+        cityLike: request.cityLike,
+        stateLike: request.stateLike,
+        addressLike: request.addressLike,
+        systemNameLike: request.systemNameLike,
+        searchLike: request.searchLike,
         sort: request.sort,
         desc: request.desc,
         page: request.page,
@@ -179,10 +191,16 @@ export function queryKeyOrganizationsListCompanyTargetFacilities(
   companyId: number,
   parameters: {
     expand?: Array<components.Expand> | undefined;
-    status?: operations.QueryParamStatus | undefined;
+    status?: operations.ListCompanyTargetFacilitiesQueryParamStatus | undefined;
     hasIndividual?: operations.HasIndividual | undefined;
     hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+    includePotentialTargets?: operations.IncludePotentialTargets | undefined;
     facilityNameLike?: string | undefined;
+    cityLike?: string | undefined;
+    stateLike?: string | undefined;
+    addressLike?: string | undefined;
+    systemNameLike?: string | undefined;
+    searchLike?: string | undefined;
     sort?: operations.QueryParamSort | undefined;
     desc?: components.Desc | undefined;
     page?: number | undefined;
@@ -202,10 +220,16 @@ export function queryKeyOrganizationsListCompanyTargetFacilitiesInfinite(
   companyId: number,
   parameters: {
     expand?: Array<components.Expand> | undefined;
-    status?: operations.QueryParamStatus | undefined;
+    status?: operations.ListCompanyTargetFacilitiesQueryParamStatus | undefined;
     hasIndividual?: operations.HasIndividual | undefined;
     hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+    includePotentialTargets?: operations.IncludePotentialTargets | undefined;
     facilityNameLike?: string | undefined;
+    cityLike?: string | undefined;
+    stateLike?: string | undefined;
+    addressLike?: string | undefined;
+    systemNameLike?: string | undefined;
+    searchLike?: string | undefined;
     sort?: operations.QueryParamSort | undefined;
     desc?: components.Desc | undefined;
     page?: number | undefined;

package/src/react-query/organizationsListCompanyTargetFacilities.ts

@@ -80,6 +80,10 @@ export type OrganizationsListCompanyTargetFacilitiesQueryError =
  * and parent system), the link status, and per-facility counts of the
  * company's individuals targeting it.
  *
+ * When `include_potential_targets=true`, returns ALL non-deleted facilities
+ * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+ * rows have `id: null` and `status: "Not Targeted"`.
+ *
  * Access control: the URL's `company_id` must be in the caller's read scope
  * for Company (a company manager's or vendor's own company, or a company
  * whose app is activated for the API user). Callers outside that scope
@@ -122,6 +126,10 @@ export function useOrganizationsListCompanyTargetFacilities(
  * and parent system), the link status, and per-facility counts of the
  * company's individuals targeting it.
  *
+ * When `include_potential_targets=true`, returns ALL non-deleted facilities
+ * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+ * rows have `id: null` and `status: "Not Targeted"`.
+ *
  * Access control: the URL's `company_id` must be in the caller's read scope
  * for Company (a company manager's or vendor's own company, or a company
  * whose app is activated for the API user). Callers outside that scope
@@ -164,6 +172,10 @@ export function useOrganizationsListCompanyTargetFacilitiesSuspense(
  * and parent system), the link status, and per-facility counts of the
  * company's individuals targeting it.
  *
+ * When `include_potential_targets=true`, returns ALL non-deleted facilities
+ * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+ * rows have `id: null` and `status: "Not Targeted"`.
+ *
  * Access control: the URL's `company_id` must be in the caller's read scope
  * for Company (a company manager's or vendor's own company, or a company
  * whose app is activated for the API user). Callers outside that scope
@@ -220,6 +232,10 @@ export function useOrganizationsListCompanyTargetFacilitiesInfinite(
  * and parent system), the link status, and per-facility counts of the
  * company's individuals targeting it.
  *
+ * When `include_potential_targets=true`, returns ALL non-deleted facilities
+ * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+ * rows have `id: null` and `status: "Not Targeted"`.
+ *
  * Access control: the URL's `company_id` must be in the caller's read scope
  * for Company (a company manager's or vendor's own company, or a company
  * whose app is activated for the API user). Callers outside that scope
@@ -273,10 +289,18 @@ export function setOrganizationsListCompanyTargetFacilitiesData(
     companyId: number,
     parameters: {
       expand?: Array<components.Expand> | undefined;
-      status?: operations.QueryParamStatus | undefined;
+      status?:
+        | operations.ListCompanyTargetFacilitiesQueryParamStatus
+        | undefined;
       hasIndividual?: operations.HasIndividual | undefined;
       hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+      includePotentialTargets?: operations.IncludePotentialTargets | undefined;
       facilityNameLike?: string | undefined;
+      cityLike?: string | undefined;
+      stateLike?: string | undefined;
+      addressLike?: string | undefined;
+      systemNameLike?: string | undefined;
+      searchLike?: string | undefined;
       sort?: operations.QueryParamSort | undefined;
       desc?: components.Desc | undefined;
       page?: number | undefined;
@@ -300,10 +324,20 @@ export function invalidateOrganizationsListCompanyTargetFacilities(
       companyId: number,
       parameters: {
         expand?: Array<components.Expand> | undefined;
-        status?: operations.QueryParamStatus | undefined;
+        status?:
+          | operations.ListCompanyTargetFacilitiesQueryParamStatus
+          | undefined;
         hasIndividual?: operations.HasIndividual | undefined;
         hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+        includePotentialTargets?:
+          | operations.IncludePotentialTargets
+          | undefined;
         facilityNameLike?: string | undefined;
+        cityLike?: string | undefined;
+        stateLike?: string | undefined;
+        addressLike?: string | undefined;
+        systemNameLike?: string | undefined;
+        searchLike?: string | undefined;
         sort?: operations.QueryParamSort | undefined;
         desc?: components.Desc | undefined;
         page?: number | undefined;