@greensecurity/javascript-sdk 0.44.0-beta.18 → 0.44.0-beta.19

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/sdk/organizations.ts

@@ -5,9 +5,12 @@
 import { organizationsCreateCompanyTargetFacility } from "../funcs/organizationsCreateCompanyTargetFacility.js";
 import { organizationsDeleteCompanyTargetFacility } from "../funcs/organizationsDeleteCompanyTargetFacility.js";
 import { organizationsDownloadCompanyTargetFacilitiesExport } from "../funcs/organizationsDownloadCompanyTargetFacilitiesExport.js";
+import { organizationsDownloadFacilityVendorsExport } from "../funcs/organizationsDownloadFacilityVendorsExport.js";
 import { organizationsExportCompanyTargetFacilities } from "../funcs/organizationsExportCompanyTargetFacilities.js";
+import { organizationsExportFacilityVendors } from "../funcs/organizationsExportFacilityVendors.js";
 import { organizationsGetCompanyTargetFacilitiesExportStatus } from "../funcs/organizationsGetCompanyTargetFacilitiesExportStatus.js";
 import { organizationsGetFacility } from "../funcs/organizationsGetFacility.js";
+import { organizationsGetFacilityVendorsExportStatus } from "../funcs/organizationsGetFacilityVendorsExportStatus.js";
 import { organizationsListCompanyTargetFacilities } from "../funcs/organizationsListCompanyTargetFacilities.js";
 import { organizationsListFacilityVendors } from "../funcs/organizationsListFacilityVendors.js";
 import { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.js";
@@ -287,6 +290,74 @@ export class Organizations extends ClientSDK {
     ));
   }
 
+  /**
+   * 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.
+   */
+  async exportFacilityVendors(
+    request: operations.ExportFacilityVendorsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.ExportFacilityVendorsResponseBody> {
+    return unwrapAsync(organizationsExportFacilityVendors(
+      this,
+      request,
+      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.
+   */
+  async getFacilityVendorsExportStatus(
+    request: operations.GetFacilityVendorsExportStatusRequest,
+    options?: RequestOptions,
+  ): Promise<components.CsvExportStatusResponse> {
+    return unwrapAsync(organizationsGetFacilityVendorsExportStatus(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Download facility vendors CSV
+   *
+   * @remarks
+   * Returns the exported facility vendors CSV via a 302 redirect to a short-lived
+   * presigned S3 URL. If the export is still being generated, returns 202 with a JSON
+   * `{ ready: false }` payload.
+   */
+  async downloadFacilityVendorsExport(
+    request: operations.DownloadFacilityVendorsExportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DownloadFacilityVendorsExportResponse | undefined> {
+    return unwrapAsync(organizationsDownloadFacilityVendorsExport(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List or search department contacts
    *