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

package/src/react-query/index.ts

@@ -43,10 +43,13 @@ export * from "./invoicesMakePayment.js";
 export * from "./invoicesUpdateInvoice.js";
 export * from "./lookupsListLookupSystems.js";
 export * from "./mobileDevicesAddMobileDevice.js";
+export * from "./organizationsCreateCompanyTargetFacility.js";
+export * from "./organizationsDeleteCompanyTargetFacility.js";
 export * from "./organizationsDownloadCompanyTargetFacilitiesExport.js";
 export * from "./organizationsExportCompanyTargetFacilities.js";
 export * from "./organizationsGetCompanyTargetFacilitiesExportStatus.js";
 export * from "./organizationsGetFacility.js";
+export * from "./organizationsListCompanyTargetFacilities.js";
 export * from "./organizationsListFacilityVendors.js";
 export * from "./organizationsListOrSearchDepartmentContacts.js";
 export * from "./organizationsListOrSearchDepartments.js";

package/src/react-query/organizationsCreateCompanyTargetFacility.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsCreateCompanyTargetFacility } from "../funcs/organizationsCreateCompanyTargetFacility.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type OrganizationsCreateCompanyTargetFacilityMutationVariables = {
+  request: operations.CreateCompanyTargetFacilityRequest;
+  options?: RequestOptions;
+};
+
+export type OrganizationsCreateCompanyTargetFacilityMutationData =
+  operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk;
+
+export type OrganizationsCreateCompanyTargetFacilityMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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
+ */
+export function useOrganizationsCreateCompanyTargetFacilityMutation(
+  options?: MutationHookOptions<
+    OrganizationsCreateCompanyTargetFacilityMutationData,
+    OrganizationsCreateCompanyTargetFacilityMutationError,
+    OrganizationsCreateCompanyTargetFacilityMutationVariables
+  >,
+): UseMutationResult<
+  OrganizationsCreateCompanyTargetFacilityMutationData,
+  OrganizationsCreateCompanyTargetFacilityMutationError,
+  OrganizationsCreateCompanyTargetFacilityMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildOrganizationsCreateCompanyTargetFacilityMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyOrganizationsCreateCompanyTargetFacility(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "createCompanyTargetFacility",
+  ];
+}
+
+export function buildOrganizationsCreateCompanyTargetFacilityMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: OrganizationsCreateCompanyTargetFacilityMutationVariables,
+  ) => Promise<OrganizationsCreateCompanyTargetFacilityMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyOrganizationsCreateCompanyTargetFacility(),
+    mutationFn: function organizationsCreateCompanyTargetFacilityMutationFn({
+      request,
+      options,
+    }): Promise<OrganizationsCreateCompanyTargetFacilityMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(organizationsCreateCompanyTargetFacility(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/organizationsDeleteCompanyTargetFacility.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsDeleteCompanyTargetFacility } from "../funcs/organizationsDeleteCompanyTargetFacility.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type OrganizationsDeleteCompanyTargetFacilityMutationVariables = {
+  request: operations.DeleteCompanyTargetFacilityRequest;
+  options?: RequestOptions;
+};
+
+export type OrganizationsDeleteCompanyTargetFacilityMutationData = boolean;
+
+export type OrganizationsDeleteCompanyTargetFacilityMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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`.
+ */
+export function useOrganizationsDeleteCompanyTargetFacilityMutation(
+  options?: MutationHookOptions<
+    OrganizationsDeleteCompanyTargetFacilityMutationData,
+    OrganizationsDeleteCompanyTargetFacilityMutationError,
+    OrganizationsDeleteCompanyTargetFacilityMutationVariables
+  >,
+): UseMutationResult<
+  OrganizationsDeleteCompanyTargetFacilityMutationData,
+  OrganizationsDeleteCompanyTargetFacilityMutationError,
+  OrganizationsDeleteCompanyTargetFacilityMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildOrganizationsDeleteCompanyTargetFacilityMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyOrganizationsDeleteCompanyTargetFacility(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "deleteCompanyTargetFacility",
+  ];
+}
+
+export function buildOrganizationsDeleteCompanyTargetFacilityMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: OrganizationsDeleteCompanyTargetFacilityMutationVariables,
+  ) => Promise<OrganizationsDeleteCompanyTargetFacilityMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyOrganizationsDeleteCompanyTargetFacility(),
+    mutationFn: function organizationsDeleteCompanyTargetFacilityMutationFn({
+      request,
+      options,
+    }): Promise<OrganizationsDeleteCompanyTargetFacilityMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(organizationsDeleteCompanyTargetFacility(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -80,13 +80,11 @@ export function buildOrganizationsExportCompanyTargetFacilitiesQuery(
 export function queryKeyOrganizationsExportCompanyTargetFacilities(
   companyId: number,
   parameters: {
-    status?:
-      | operations.ExportCompanyTargetFacilitiesQueryParamStatus
-      | undefined;
-    hasIndividual?: operations.HasIndividual | undefined;
-    hasActiveIndividual?: operations.HasActiveIndividual | undefined;
+    status?: operations.QueryParamStatus | undefined;
+    hasIndividual?: operations.QueryParamHasIndividual | undefined;
+    hasActiveIndividual?: operations.QueryParamHasActiveIndividual | undefined;
     facilityNameLike?: string | undefined;
-    sort?: operations.QueryParamSort | undefined;
+    sort?: operations.ExportCompanyTargetFacilitiesQueryParamSort | undefined;
     desc?: operations.Desc | undefined;
     itemsPerPage?: number | undefined;
   },

package/src/react-query/organizationsExportCompanyTargetFacilities.ts

@@ -125,13 +125,13 @@ export function setOrganizationsExportCompanyTargetFacilitiesData(
   queryKeyBase: [
     companyId: number,
     parameters: {
-      status?:
-        | operations.ExportCompanyTargetFacilitiesQueryParamStatus
+      status?: operations.QueryParamStatus | undefined;
+      hasIndividual?: operations.QueryParamHasIndividual | undefined;
+      hasActiveIndividual?:
+        | operations.QueryParamHasActiveIndividual
         | undefined;
-      hasIndividual?: operations.HasIndividual | undefined;
-      hasActiveIndividual?: operations.HasActiveIndividual | undefined;
       facilityNameLike?: string | undefined;
-      sort?: operations.QueryParamSort | undefined;
+      sort?: operations.ExportCompanyTargetFacilitiesQueryParamSort | undefined;
       desc?: operations.Desc | undefined;
       itemsPerPage?: number | undefined;
     },
@@ -153,13 +153,15 @@ export function invalidateOrganizationsExportCompanyTargetFacilities(
     [
       companyId: number,
       parameters: {
-        status?:
-          | operations.ExportCompanyTargetFacilitiesQueryParamStatus
+        status?: operations.QueryParamStatus | undefined;
+        hasIndividual?: operations.QueryParamHasIndividual | undefined;
+        hasActiveIndividual?:
+          | operations.QueryParamHasActiveIndividual
           | undefined;
-        hasIndividual?: operations.HasIndividual | undefined;
-        hasActiveIndividual?: operations.HasActiveIndividual | undefined;
         facilityNameLike?: string | undefined;
-        sort?: operations.QueryParamSort | undefined;
+        sort?:
+          | operations.ExportCompanyTargetFacilitiesQueryParamSort
+          | undefined;
         desc?: operations.Desc | undefined;
         itemsPerPage?: number | undefined;
       },

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

@@ -0,0 +1,239 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsListCompanyTargetFacilities } from "../funcs/organizationsListCompanyTargetFacilities.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 OrganizationsListCompanyTargetFacilitiesQueryData =
+  operations.ListCompanyTargetFacilitiesResponse;
+
+export type OrganizationsListCompanyTargetFacilitiesInfiniteQueryData =
+  PageIterator<
+    operations.ListCompanyTargetFacilitiesResponse,
+    { page: number }
+  >;
+
+export type OrganizationsListCompanyTargetFacilitiesPageParams = PageIterator<
+  operations.ListCompanyTargetFacilitiesResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchOrganizationsListCompanyTargetFacilities(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsListCompanyTargetFacilitiesQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchOrganizationsListCompanyTargetFacilitiesInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam:
+      undefined as OrganizationsListCompanyTargetFacilitiesPageParams,
+    getNextPageParam: (
+      previousPage: OrganizationsListCompanyTargetFacilitiesInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildOrganizationsListCompanyTargetFacilitiesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsListCompanyTargetFacilitiesQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListCompanyTargetFacilities(
+      request.companyId,
+      {
+        expand: request.expand,
+        status: request.status,
+        hasIndividual: request.hasIndividual,
+        hasActiveIndividual: request.hasActiveIndividual,
+        includePotentialTargets: request.includePotentialTargets,
+        facilityNameLike: request.facilityNameLike,
+        cityLike: request.cityLike,
+        addressLike: request.addressLike,
+        systemNameLike: request.systemNameLike,
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+      },
+    ),
+    queryFn: async function organizationsListCompanyTargetFacilitiesQueryFn(
+      ctx,
+    ): Promise<OrganizationsListCompanyTargetFacilitiesQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(organizationsListCompanyTargetFacilities(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildOrganizationsListCompanyTargetFacilitiesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyTargetFacilitiesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      OrganizationsListCompanyTargetFacilitiesPageParams
+    >,
+  ) => Promise<OrganizationsListCompanyTargetFacilitiesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsListCompanyTargetFacilitiesInfinite(
+      request.companyId,
+      {
+        expand: request.expand,
+        status: request.status,
+        hasIndividual: request.hasIndividual,
+        hasActiveIndividual: request.hasActiveIndividual,
+        includePotentialTargets: request.includePotentialTargets,
+        facilityNameLike: request.facilityNameLike,
+        cityLike: request.cityLike,
+        addressLike: request.addressLike,
+        systemNameLike: request.systemNameLike,
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+      },
+    ),
+    queryFn: async function organizationsListCompanyTargetFacilitiesQuery(
+      ctx,
+    ): Promise<OrganizationsListCompanyTargetFacilitiesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          organizationsListCompanyTargetFacilities(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        organizationsListCompanyTargetFacilities(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyOrganizationsListCompanyTargetFacilities(
+  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;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listCompanyTargetFacilities",
+    companyId,
+    parameters,
+  ];
+}
+
+export function queryKeyOrganizationsListCompanyTargetFacilitiesInfinite(
+  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;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "listCompanyTargetFacilities",
+    "infinite",
+    companyId,
+    parameters,
+  ];
+}