@greensecurity/javascript-sdk 0.44.0-beta.15 → 0.44.0-beta.17

package/src/react-query/organizationsListCompanyTargetFacilities.ts

@@ -0,0 +1,369 @@
+/*
+ * 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 {
+  buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery,
+  buildOrganizationsListCompanyTargetFacilitiesQuery,
+  OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+  OrganizationsListCompanyTargetFacilitiesPageParams,
+  OrganizationsListCompanyTargetFacilitiesQueryData,
+  prefetchOrganizationsListCompanyTargetFacilities,
+  prefetchOrganizationsListCompanyTargetFacilitiesInfinite,
+  queryKeyOrganizationsListCompanyTargetFacilities,
+  queryKeyOrganizationsListCompanyTargetFacilitiesInfinite,
+} from "./organizationsListCompanyTargetFacilities.core.js";
+export {
+  buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery,
+  buildOrganizationsListCompanyTargetFacilitiesQuery,
+  type OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+  type OrganizationsListCompanyTargetFacilitiesPageParams,
+  type OrganizationsListCompanyTargetFacilitiesQueryData,
+  prefetchOrganizationsListCompanyTargetFacilities,
+  prefetchOrganizationsListCompanyTargetFacilitiesInfinite,
+  queryKeyOrganizationsListCompanyTargetFacilities,
+  queryKeyOrganizationsListCompanyTargetFacilitiesInfinite,
+};
+
+export type OrganizationsListCompanyTargetFacilitiesQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List company target facilities
+ *
+ * @remarks
+ * Lists the CompanyTargetFacility links for a company — the facilities the
+ * company is targeting. Each row carries the linked facility (with location
+ * 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
+ * receive `404 Company not found`.
+ *
+ * Filter with `has_individual` / `has_active_individual` to drive the
+ * facility roster views.
+ *
+ * Available `expand` scopes are:
+ *
+ * - company_target_facility.facility
+ */
+export function useOrganizationsListCompanyTargetFacilities(
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: QueryHookOptions<
+    OrganizationsListCompanyTargetFacilitiesQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError
+  >,
+): UseQueryResult<
+  OrganizationsListCompanyTargetFacilitiesQueryData,
+  OrganizationsListCompanyTargetFacilitiesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsListCompanyTargetFacilitiesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List company target facilities
+ *
+ * @remarks
+ * Lists the CompanyTargetFacility links for a company — the facilities the
+ * company is targeting. Each row carries the linked facility (with location
+ * 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
+ * receive `404 Company not found`.
+ *
+ * Filter with `has_individual` / `has_active_individual` to drive the
+ * facility roster views.
+ *
+ * Available `expand` scopes are:
+ *
+ * - company_target_facility.facility
+ */
+export function useOrganizationsListCompanyTargetFacilitiesSuspense(
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsListCompanyTargetFacilitiesQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsListCompanyTargetFacilitiesQueryData,
+  OrganizationsListCompanyTargetFacilitiesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsListCompanyTargetFacilitiesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List company target facilities
+ *
+ * @remarks
+ * Lists the CompanyTargetFacility links for a company — the facilities the
+ * company is targeting. Each row carries the linked facility (with location
+ * 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
+ * receive `404 Company not found`.
+ *
+ * Filter with `has_individual` / `has_active_individual` to drive the
+ * facility roster views.
+ *
+ * Available `expand` scopes are:
+ *
+ * - company_target_facility.facility
+ */
+export function useOrganizationsListCompanyTargetFacilitiesInfinite(
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: InfiniteQueryHookOptions<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesPageParams
+  >,
+  OrganizationsListCompanyTargetFacilitiesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError,
+    InfiniteData<
+      OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+      OrganizationsListCompanyTargetFacilitiesPageParams
+    >,
+    QueryKey,
+    OrganizationsListCompanyTargetFacilitiesPageParams
+  >({
+    ...buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List company target facilities
+ *
+ * @remarks
+ * Lists the CompanyTargetFacility links for a company — the facilities the
+ * company is targeting. Each row carries the linked facility (with location
+ * 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
+ * receive `404 Company not found`.
+ *
+ * Filter with `has_individual` / `has_active_individual` to drive the
+ * facility roster views.
+ *
+ * Available `expand` scopes are:
+ *
+ * - company_target_facility.facility
+ */
+export function useOrganizationsListCompanyTargetFacilitiesInfiniteSuspense(
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesPageParams
+  >,
+  OrganizationsListCompanyTargetFacilitiesQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    OrganizationsListCompanyTargetFacilitiesQueryError,
+    InfiniteData<
+      OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+      OrganizationsListCompanyTargetFacilitiesPageParams
+    >,
+    QueryKey,
+    OrganizationsListCompanyTargetFacilitiesPageParams
+  >({
+    ...buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setOrganizationsListCompanyTargetFacilitiesData(
+  client: QueryClient,
+  queryKeyBase: [
+    companyId: number,
+    parameters: {
+      expand?: Array<components.Expand> | undefined;
+      status?:
+        | operations.ListCompanyTargetFacilitiesQueryParamStatus
+        | undefined;
+      hasIndividual?: operations.HasIndividual | undefined;
+      hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+      includePotentialTargets?: operations.IncludePotentialTargets | undefined;
+      facilityNameLike?: string | undefined;
+      cityLike?: string | undefined;
+      addressLike?: string | undefined;
+      systemNameLike?: string | undefined;
+      sort?: operations.QueryParamSort | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: OrganizationsListCompanyTargetFacilitiesQueryData,
+): OrganizationsListCompanyTargetFacilitiesQueryData | undefined {
+  const key = queryKeyOrganizationsListCompanyTargetFacilities(...queryKeyBase);
+
+  return client.setQueryData<OrganizationsListCompanyTargetFacilitiesQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateOrganizationsListCompanyTargetFacilities(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      companyId: number,
+      parameters: {
+        expand?: Array<components.Expand> | undefined;
+        status?:
+          | operations.ListCompanyTargetFacilitiesQueryParamStatus
+          | undefined;
+        hasIndividual?: operations.HasIndividual | undefined;
+        hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+        includePotentialTargets?:
+          | operations.IncludePotentialTargets
+          | undefined;
+        facilityNameLike?: string | undefined;
+        cityLike?: string | undefined;
+        addressLike?: string | undefined;
+        systemNameLike?: string | undefined;
+        sort?: operations.QueryParamSort | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listCompanyTargetFacilities",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsListCompanyTargetFacilities(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "listCompanyTargetFacilities",
+    ],
+  });
+}

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

@@ -167,7 +167,7 @@ export function queryKeyOrganizationsListFacilityVendors(
   id: number,
   parameters: {
     companyId?: number | undefined;
-    status?: operations.QueryParamStatus | undefined;
+    status?: operations.ListFacilityVendorsQueryParamStatus | undefined;
     search?: string | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;
@@ -188,7 +188,7 @@ export function queryKeyOrganizationsListFacilityVendorsInfinite(
   id: number,
   parameters: {
     companyId?: number | undefined;
-    status?: operations.QueryParamStatus | undefined;
+    status?: operations.ListFacilityVendorsQueryParamStatus | undefined;
     search?: string | undefined;
     page?: number | undefined;
     itemsPerPage?: number | undefined;

package/src/react-query/organizationsListFacilityVendors.ts

@@ -289,7 +289,7 @@ export function setOrganizationsListFacilityVendorsData(
     id: number,
     parameters: {
       companyId?: number | undefined;
-      status?: operations.QueryParamStatus | undefined;
+      status?: operations.ListFacilityVendorsQueryParamStatus | undefined;
       search?: string | undefined;
       page?: number | undefined;
       itemsPerPage?: number | undefined;
@@ -314,7 +314,7 @@ export function invalidateOrganizationsListFacilityVendors(
       id: number,
       parameters: {
         companyId?: number | undefined;
-        status?: operations.QueryParamStatus | undefined;
+        status?: operations.ListFacilityVendorsQueryParamStatus | undefined;
         search?: string | undefined;
         page?: number | undefined;
         itemsPerPage?: number | undefined;

package/src/sdk/organizations.ts

@@ -2,10 +2,13 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { organizationsCreateCompanyTargetFacility } from "../funcs/organizationsCreateCompanyTargetFacility.js";
+import { organizationsDeleteCompanyTargetFacility } from "../funcs/organizationsDeleteCompanyTargetFacility.js";
 import { organizationsDownloadCompanyTargetFacilitiesExport } from "../funcs/organizationsDownloadCompanyTargetFacilitiesExport.js";
 import { organizationsExportCompanyTargetFacilities } from "../funcs/organizationsExportCompanyTargetFacilities.js";
 import { organizationsGetCompanyTargetFacilitiesExportStatus } from "../funcs/organizationsGetCompanyTargetFacilitiesExportStatus.js";
 import { organizationsGetFacility } from "../funcs/organizationsGetFacility.js";
+import { organizationsListCompanyTargetFacilities } from "../funcs/organizationsListCompanyTargetFacilities.js";
 import { organizationsListFacilityVendors } from "../funcs/organizationsListFacilityVendors.js";
 import { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.js";
 import { organizationsListOrSearchDepartments } from "../funcs/organizationsListOrSearchDepartments.js";
@@ -85,6 +88,105 @@ export class Organizations extends ClientSDK {
     ));
   }
 
+  /**
+   * List company target facilities
+   *
+   * @remarks
+   * Lists the CompanyTargetFacility links for a company — the facilities the
+   * company is targeting. Each row carries the linked facility (with location
+   * 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
+   * receive `404 Company not found`.
+   *
+   * Filter with `has_individual` / `has_active_individual` to drive the
+   * facility roster views.
+   *
+   * Available `expand` scopes are:
+   *
+   * - company_target_facility.facility
+   */
+  async listCompanyTargetFacilities(
+    request: operations.ListCompanyTargetFacilitiesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListCompanyTargetFacilitiesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(organizationsListCompanyTargetFacilities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add a company target facility
+   *
+   * @remarks
+   * Links the URL's company to an existing facility. The link is created with
+   * status `Pending`. Only the link row is created — the Facility entity
+   * itself is never created or modified by this endpoint.
+   *
+   * Access control: the URL's `company_id` must be in the caller's update
+   * scope for Company, AND the `facility_id` must be in the caller's create
+   * scope for Facility (a facility on the company's site, or a facility
+   * reachable via the API user's site/system/facility-scoped activation).
+   * Either being out of scope returns `404 Company not found` /
+   * `404 Facility not found` respectively. Deleted facilities also return
+   * `404 Facility not found`.
+   *
+   * Available `expand` scopes are:
+   *
+   * - company_target_facility.facility
+   */
+  async createCompanyTargetFacility(
+    request: operations.CreateCompanyTargetFacilityRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk
+  > {
+    return unwrapAsync(organizationsCreateCompanyTargetFacility(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a company target facility
+   *
+   * @remarks
+   * Removes a CompanyTargetFacility link. Blocked when any of the company's
+   * individuals still target the same facility (to avoid orphaning their
+   * vendor-scoped target rows). Only the link row is removed — the Facility
+   * entity itself is never touched.
+   *
+   * Access control: the URL's `company_id` must be in the caller's update
+   * 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 receive `404 Company not found`.
+   */
+  async deleteCompanyTargetFacility(
+    request: operations.DeleteCompanyTargetFacilityRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(organizationsDeleteCompanyTargetFacility(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Export company target facilities to CSV (async)
    *