@greensecurity/javascript-sdk 0.44.0-beta.6 → 0.44.0-beta.60

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/reportsGetFullReport.core.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { reportsGetFullReport } from "../funcs/reportsGetFullReport.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 ReportsGetFullReportQueryData =
+  operations.GetFullReportGetFullReportOk;
+
+export function prefetchReportsGetFullReport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetFullReportRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildReportsGetFullReportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildReportsGetFullReportQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetFullReportRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<ReportsGetFullReportQueryData>;
+} {
+  return {
+    queryKey: queryKeyReportsGetFullReport(request.fullReportId),
+    queryFn: async function reportsGetFullReportQueryFn(
+      ctx,
+    ): Promise<ReportsGetFullReportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(reportsGetFullReport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyReportsGetFullReport(fullReportId: number): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "reports",
+    "getFullReport",
+    fullReportId,
+  ];
+}

package/src/react-query/reportsGetFullReport.ts

@@ -0,0 +1,190 @@
+/*
+ * 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 {
+  buildReportsGetFullReportQuery,
+  prefetchReportsGetFullReport,
+  queryKeyReportsGetFullReport,
+  ReportsGetFullReportQueryData,
+} from "./reportsGetFullReport.core.js";
+export {
+  buildReportsGetFullReportQuery,
+  prefetchReportsGetFullReport,
+  queryKeyReportsGetFullReport,
+  type ReportsGetFullReportQueryData,
+};
+
+export type ReportsGetFullReportQueryError =
+  | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get a generated report's status and download URL
+ *
+ * @remarks
+ * Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
+ *
+ * Only a completed run returns the `full_report` payload. A run that has not finished does
+ * **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
+ * the status code alone; `409` is the only retryable outcome, so no error-message matching is
+ * needed:
+ *
+ * | Status | Meaning | What to do |
+ * | --- | --- | --- |
+ * | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
+ * | `409` | Still pending or processing. | Retry, but bound it — see below. |
+ * | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
+ * | `404` | No such run, or it is outside your access scope. | Stop. |
+ * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
+ *
+ * **Bound your polling.** A `409` is not a promise that the run will finish. Report
+ * generation has no terminal failure state today, so a run whose generation crashed part way
+ * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+ * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
+ *
+ * Access control: the URL's `full_report_id` must be in the caller's read scope for
+ * `FullReport` — the facility or system it was run for, a recipient of the schedule that
+ * produced it, or a report whose app is activated for the API user. Callers outside that
+ * scope receive `404 Full report not found`.
+ */
+export function useReportsGetFullReport(
+  request: operations.GetFullReportRequest,
+  options?: QueryHookOptions<
+    ReportsGetFullReportQueryData,
+    ReportsGetFullReportQueryError
+  >,
+): UseQueryResult<
+  ReportsGetFullReportQueryData,
+  ReportsGetFullReportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildReportsGetFullReportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get a generated report's status and download URL
+ *
+ * @remarks
+ * Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
+ *
+ * Only a completed run returns the `full_report` payload. A run that has not finished does
+ * **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
+ * the status code alone; `409` is the only retryable outcome, so no error-message matching is
+ * needed:
+ *
+ * | Status | Meaning | What to do |
+ * | --- | --- | --- |
+ * | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
+ * | `409` | Still pending or processing. | Retry, but bound it — see below. |
+ * | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
+ * | `404` | No such run, or it is outside your access scope. | Stop. |
+ * | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
+ *
+ * **Bound your polling.** A `409` is not a promise that the run will finish. Report
+ * generation has no terminal failure state today, so a run whose generation crashed part way
+ * through stays in `processing` and keeps answering `409` indefinitely. Apply your own
+ * timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
+ *
+ * Access control: the URL's `full_report_id` must be in the caller's read scope for
+ * `FullReport` — the facility or system it was run for, a recipient of the schedule that
+ * produced it, or a report whose app is activated for the API user. Callers outside that
+ * scope receive `404 Full report not found`.
+ */
+export function useReportsGetFullReportSuspense(
+  request: operations.GetFullReportRequest,
+  options?: SuspenseQueryHookOptions<
+    ReportsGetFullReportQueryData,
+    ReportsGetFullReportQueryError
+  >,
+): UseSuspenseQueryResult<
+  ReportsGetFullReportQueryData,
+  ReportsGetFullReportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildReportsGetFullReportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setReportsGetFullReportData(
+  client: QueryClient,
+  queryKeyBase: [fullReportId: number],
+  data: ReportsGetFullReportQueryData,
+): ReportsGetFullReportQueryData | undefined {
+  const key = queryKeyReportsGetFullReport(...queryKeyBase);
+
+  return client.setQueryData<ReportsGetFullReportQueryData>(key, data);
+}
+
+export function invalidateReportsGetFullReport(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[fullReportId: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "reports",
+      "getFullReport",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllReportsGetFullReport(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "reports", "getFullReport"],
+  });
+}