@greensecurity/javascript-sdk 0.44.0-beta.2 → 0.44.0-beta.21

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

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsExportFacilityVendors } from "../funcs/organizationsExportFacilityVendors.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type OrganizationsExportFacilityVendorsQueryData =
+  operations.ExportFacilityVendorsResponseBody;
+
+export function prefetchOrganizationsExportFacilityVendors(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ExportFacilityVendorsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsExportFacilityVendorsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildOrganizationsExportFacilityVendorsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ExportFacilityVendorsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsExportFacilityVendorsQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsExportFacilityVendors(request.id, {
+      companyId: request.companyId,
+      status: request.status,
+      search: request.search,
+      sort: request.sort,
+      desc: request.desc,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function organizationsExportFacilityVendorsQueryFn(
+      ctx,
+    ): Promise<OrganizationsExportFacilityVendorsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(organizationsExportFacilityVendors(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyOrganizationsExportFacilityVendors(
+  id: number,
+  parameters: {
+    companyId?: number | undefined;
+    status?: operations.ExportFacilityVendorsQueryParamStatus | undefined;
+    search?: string | undefined;
+    sort?: operations.ExportFacilityVendorsQueryParamSort | undefined;
+    desc?: operations.QueryParamDesc | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "exportFacilityVendors",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/organizationsExportFacilityVendors.ts

@@ -0,0 +1,200 @@
+/*
+ * 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 {
+  buildOrganizationsExportFacilityVendorsQuery,
+  OrganizationsExportFacilityVendorsQueryData,
+  prefetchOrganizationsExportFacilityVendors,
+  queryKeyOrganizationsExportFacilityVendors,
+} from "./organizationsExportFacilityVendors.core.js";
+export {
+  buildOrganizationsExportFacilityVendorsQuery,
+  type OrganizationsExportFacilityVendorsQueryData,
+  prefetchOrganizationsExportFacilityVendors,
+  queryKeyOrganizationsExportFacilityVendors,
+};
+
+export type OrganizationsExportFacilityVendorsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Export facility vendors to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of the vendors (vendor reps)
+ * targeting the given facility, applying the same access scope and filter parameters as
+ * the listing endpoint. The CSV contains: Name, Email, one column per company custom field
+ * flagged `show_to_vendor` (e.g. Employee ID), Last Visit, and Status.
+ *
+ * Returns a `status_url` for polling until the export is ready, along with a `download_url`
+ * and `status_id`.
+ *
+ * Access control mirrors the list endpoint:
+ *   * Regular users — facility must be in the caller's read scope (via
+ *     `has_facility_access_policy`); company resolved from the session. Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users — `company_id` required; both the company AND the facility must be
+ *     activated for the caller's marketplace app via the join-scoped
+ *     `MarketplaceAppActivation` check.
+ */
+export function useOrganizationsExportFacilityVendors(
+  request: operations.ExportFacilityVendorsRequest,
+  options?: QueryHookOptions<
+    OrganizationsExportFacilityVendorsQueryData,
+    OrganizationsExportFacilityVendorsQueryError
+  >,
+): UseQueryResult<
+  OrganizationsExportFacilityVendorsQueryData,
+  OrganizationsExportFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildOrganizationsExportFacilityVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Export facility vendors to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of the vendors (vendor reps)
+ * targeting the given facility, applying the same access scope and filter parameters as
+ * the listing endpoint. The CSV contains: Name, Email, one column per company custom field
+ * flagged `show_to_vendor` (e.g. Employee ID), Last Visit, and Status.
+ *
+ * Returns a `status_url` for polling until the export is ready, along with a `download_url`
+ * and `status_id`.
+ *
+ * Access control mirrors the list endpoint:
+ *   * Regular users — facility must be in the caller's read scope (via
+ *     `has_facility_access_policy`); company resolved from the session. Out-of-scope or
+ *     soft-deleted facilities return `404 Facility not found`.
+ *   * API users — `company_id` required; both the company AND the facility must be
+ *     activated for the caller's marketplace app via the join-scoped
+ *     `MarketplaceAppActivation` check.
+ */
+export function useOrganizationsExportFacilityVendorsSuspense(
+  request: operations.ExportFacilityVendorsRequest,
+  options?: SuspenseQueryHookOptions<
+    OrganizationsExportFacilityVendorsQueryData,
+    OrganizationsExportFacilityVendorsQueryError
+  >,
+): UseSuspenseQueryResult<
+  OrganizationsExportFacilityVendorsQueryData,
+  OrganizationsExportFacilityVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildOrganizationsExportFacilityVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setOrganizationsExportFacilityVendorsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      companyId?: number | undefined;
+      status?: operations.ExportFacilityVendorsQueryParamStatus | undefined;
+      search?: string | undefined;
+      sort?: operations.ExportFacilityVendorsQueryParamSort | undefined;
+      desc?: operations.QueryParamDesc | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: OrganizationsExportFacilityVendorsQueryData,
+): OrganizationsExportFacilityVendorsQueryData | undefined {
+  const key = queryKeyOrganizationsExportFacilityVendors(...queryKeyBase);
+
+  return client.setQueryData<OrganizationsExportFacilityVendorsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateOrganizationsExportFacilityVendors(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        companyId?: number | undefined;
+        status?: operations.ExportFacilityVendorsQueryParamStatus | undefined;
+        search?: string | undefined;
+        sort?: operations.ExportFacilityVendorsQueryParamSort | undefined;
+        desc?: operations.QueryParamDesc | undefined;
+        itemsPerPage?: number | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "exportFacilityVendors",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllOrganizationsExportFacilityVendors(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "organizations",
+      "exportFacilityVendors",
+    ],
+  });
+}

package/src/react-query/organizationsGetCompanyTargetFacilitiesExportStatus.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 { organizationsGetCompanyTargetFacilitiesExportStatus } from "../funcs/organizationsGetCompanyTargetFacilitiesExportStatus.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData =
+  operations.GetCompanyTargetFacilitiesExportStatusResponseBody;
+
+export function prefetchOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildOrganizationsGetCompanyTargetFacilitiesExportStatusQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetCompanyTargetFacilitiesExportStatusRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus(
+      request.companyId,
+      request.id,
+    ),
+    queryFn:
+      async function organizationsGetCompanyTargetFacilitiesExportStatusQueryFn(
+        ctx,
+      ): Promise<OrganizationsGetCompanyTargetFacilitiesExportStatusQueryData> {
+        const sig = combineSignals(
+          ctx.signal,
+          options?.signal,
+          options?.fetchOptions?.signal,
+        );
+        const mergedOptions = {
+          ...options?.fetchOptions,
+          ...options,
+          signal: sig,
+        };
+
+        return unwrapAsync(organizationsGetCompanyTargetFacilitiesExportStatus(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      },
+  };
+}
+
+export function queryKeyOrganizationsGetCompanyTargetFacilitiesExportStatus(
+  companyId: number,
+  id: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "getCompanyTargetFacilitiesExportStatus",
+    companyId,
+    id,
+  ];
+}

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