@greensecurity/javascript-sdk 0.44.0-beta.3 → 0.44.0-beta.31

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

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsDownloadVendorsExport } from "../funcs/vendorsDownloadVendorsExport.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 VendorsDownloadVendorsExportQueryData =
+  | operations.DownloadVendorsExportResponse
+  | undefined;
+
+export function prefetchVendorsDownloadVendorsExport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorsExportRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsDownloadVendorsExportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsDownloadVendorsExportQuery(
+  client$: GreenSecurityCore,
+  request: operations.DownloadVendorsExportRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsDownloadVendorsExportQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsDownloadVendorsExport(request.id),
+    queryFn: async function vendorsDownloadVendorsExportQueryFn(
+      ctx,
+    ): Promise<VendorsDownloadVendorsExportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsDownloadVendorsExport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsDownloadVendorsExport(id: string): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "downloadVendorsExport",
+    id,
+  ];
+}

package/src/react-query/vendorsDownloadVendorsExport.ts

@@ -0,0 +1,151 @@
+/*
+ * 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 {
+  buildVendorsDownloadVendorsExportQuery,
+  prefetchVendorsDownloadVendorsExport,
+  queryKeyVendorsDownloadVendorsExport,
+  VendorsDownloadVendorsExportQueryData,
+} from "./vendorsDownloadVendorsExport.core.js";
+export {
+  buildVendorsDownloadVendorsExportQuery,
+  prefetchVendorsDownloadVendorsExport,
+  queryKeyVendorsDownloadVendorsExport,
+  type VendorsDownloadVendorsExportQueryData,
+};
+
+export type VendorsDownloadVendorsExportQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Download vendors CSV
+ *
+ * @remarks
+ * Downloads the exported vendors CSV. When the export is ready the server
+ * responds with a 302 redirect to a short-lived presigned S3 URL. If the
+ * export job is still running, responds with 202.
+ */
+export function useVendorsDownloadVendorsExport(
+  request: operations.DownloadVendorsExportRequest,
+  options?: QueryHookOptions<
+    VendorsDownloadVendorsExportQueryData,
+    VendorsDownloadVendorsExportQueryError
+  >,
+): UseQueryResult<
+  VendorsDownloadVendorsExportQueryData,
+  VendorsDownloadVendorsExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsDownloadVendorsExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download vendors CSV
+ *
+ * @remarks
+ * Downloads the exported vendors CSV. When the export is ready the server
+ * responds with a 302 redirect to a short-lived presigned S3 URL. If the
+ * export job is still running, responds with 202.
+ */
+export function useVendorsDownloadVendorsExportSuspense(
+  request: operations.DownloadVendorsExportRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsDownloadVendorsExportQueryData,
+    VendorsDownloadVendorsExportQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsDownloadVendorsExportQueryData,
+  VendorsDownloadVendorsExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsDownloadVendorsExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorsDownloadVendorsExportData(
+  client: QueryClient,
+  queryKeyBase: [id: string],
+  data: VendorsDownloadVendorsExportQueryData,
+): VendorsDownloadVendorsExportQueryData | undefined {
+  const key = queryKeyVendorsDownloadVendorsExport(...queryKeyBase);
+
+  return client.setQueryData<VendorsDownloadVendorsExportQueryData>(key, data);
+}
+
+export function invalidateVendorsDownloadVendorsExport(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "downloadVendorsExport",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsDownloadVendorsExport(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "downloadVendorsExport",
+    ],
+  });
+}

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetVendorPaymentResponsibility } from "../funcs/vendorsGetVendorPaymentResponsibility.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 VendorsGetVendorPaymentResponsibilityQueryData =
+  operations.GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk;
+
+export function prefetchVendorsGetVendorPaymentResponsibility(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorPaymentResponsibilityRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorPaymentResponsibilityQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsGetVendorPaymentResponsibilityQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorPaymentResponsibilityRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorPaymentResponsibilityQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorPaymentResponsibility(request.vendorId),
+    queryFn: async function vendorsGetVendorPaymentResponsibilityQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorPaymentResponsibilityQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsGetVendorPaymentResponsibility(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorPaymentResponsibility(
+  vendorId: number,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorPaymentResponsibility",
+    vendorId,
+  ];
+}

package/src/react-query/vendorsGetVendorPaymentResponsibility.ts

@@ -0,0 +1,156 @@
+/*
+ * 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 {
+  buildVendorsGetVendorPaymentResponsibilityQuery,
+  prefetchVendorsGetVendorPaymentResponsibility,
+  queryKeyVendorsGetVendorPaymentResponsibility,
+  VendorsGetVendorPaymentResponsibilityQueryData,
+} from "./vendorsGetVendorPaymentResponsibility.core.js";
+export {
+  buildVendorsGetVendorPaymentResponsibilityQuery,
+  prefetchVendorsGetVendorPaymentResponsibility,
+  queryKeyVendorsGetVendorPaymentResponsibility,
+  type VendorsGetVendorPaymentResponsibilityQueryData,
+};
+
+export type VendorsGetVendorPaymentResponsibilityQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get vendor payment responsibility
+ *
+ * @remarks
+ * Returns the payment responsibility record for a vendor managed by the authenticated
+ * company manager's company, or by the vendor themselves. Each `_user_id` field
+ * indicates which party is responsible for that payment category; `null` means
+ * responsibility defaults to the vendor.
+ */
+export function useVendorsGetVendorPaymentResponsibility(
+  request: operations.GetVendorPaymentResponsibilityRequest,
+  options?: QueryHookOptions<
+    VendorsGetVendorPaymentResponsibilityQueryData,
+    VendorsGetVendorPaymentResponsibilityQueryError
+  >,
+): UseQueryResult<
+  VendorsGetVendorPaymentResponsibilityQueryData,
+  VendorsGetVendorPaymentResponsibilityQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorPaymentResponsibilityQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor payment responsibility
+ *
+ * @remarks
+ * Returns the payment responsibility record for a vendor managed by the authenticated
+ * company manager's company, or by the vendor themselves. Each `_user_id` field
+ * indicates which party is responsible for that payment category; `null` means
+ * responsibility defaults to the vendor.
+ */
+export function useVendorsGetVendorPaymentResponsibilitySuspense(
+  request: operations.GetVendorPaymentResponsibilityRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsGetVendorPaymentResponsibilityQueryData,
+    VendorsGetVendorPaymentResponsibilityQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsGetVendorPaymentResponsibilityQueryData,
+  VendorsGetVendorPaymentResponsibilityQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorPaymentResponsibilityQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorsGetVendorPaymentResponsibilityData(
+  client: QueryClient,
+  queryKeyBase: [vendorId: number],
+  data: VendorsGetVendorPaymentResponsibilityQueryData,
+): VendorsGetVendorPaymentResponsibilityQueryData | undefined {
+  const key = queryKeyVendorsGetVendorPaymentResponsibility(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorPaymentResponsibilityQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateVendorsGetVendorPaymentResponsibility(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[vendorId: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorPaymentResponsibility",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorPaymentResponsibility(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorPaymentResponsibility",
+    ],
+  });
+}

package/src/react-query/vendorsGetVendorsExportStatus.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 { vendorsGetVendorsExportStatus } from "../funcs/vendorsGetVendorsExportStatus.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 VendorsGetVendorsExportStatusQueryData =
+  operations.GetVendorsExportStatusResponseBody;
+
+export function prefetchVendorsGetVendorsExportStatus(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorsExportStatusRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorsExportStatusQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsGetVendorsExportStatusQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorsExportStatusRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorsExportStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorsExportStatus(request.id),
+    queryFn: async function vendorsGetVendorsExportStatusQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorsExportStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsGetVendorsExportStatus(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorsExportStatus(id: string): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorsExportStatus",
+    id,
+  ];
+}

package/src/react-query/vendorsGetVendorsExportStatus.ts

@@ -0,0 +1,149 @@
+/*
+ * 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 {
+  buildVendorsGetVendorsExportStatusQuery,
+  prefetchVendorsGetVendorsExportStatus,
+  queryKeyVendorsGetVendorsExportStatus,
+  VendorsGetVendorsExportStatusQueryData,
+} from "./vendorsGetVendorsExportStatus.core.js";
+export {
+  buildVendorsGetVendorsExportStatusQuery,
+  prefetchVendorsGetVendorsExportStatus,
+  queryKeyVendorsGetVendorsExportStatus,
+  type VendorsGetVendorsExportStatusQueryData,
+};
+
+export type VendorsGetVendorsExportStatusQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get vendor export status
+ *
+ * @remarks
+ * Poll the status of an asynchronous vendor export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useVendorsGetVendorsExportStatus(
+  request: operations.GetVendorsExportStatusRequest,
+  options?: QueryHookOptions<
+    VendorsGetVendorsExportStatusQueryData,
+    VendorsGetVendorsExportStatusQueryError
+  >,
+): UseQueryResult<
+  VendorsGetVendorsExportStatusQueryData,
+  VendorsGetVendorsExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorsExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor export status
+ *
+ * @remarks
+ * Poll the status of an asynchronous vendor export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ */
+export function useVendorsGetVendorsExportStatusSuspense(
+  request: operations.GetVendorsExportStatusRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsGetVendorsExportStatusQueryData,
+    VendorsGetVendorsExportStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsGetVendorsExportStatusQueryData,
+  VendorsGetVendorsExportStatusQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorsExportStatusQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorsGetVendorsExportStatusData(
+  client: QueryClient,
+  queryKeyBase: [id: string],
+  data: VendorsGetVendorsExportStatusQueryData,
+): VendorsGetVendorsExportStatusQueryData | undefined {
+  const key = queryKeyVendorsGetVendorsExportStatus(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorsExportStatusQueryData>(key, data);
+}
+
+export function invalidateVendorsGetVendorsExportStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorsExportStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorsExportStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorsExportStatus",
+    ],
+  });
+}

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -49,7 +49,7 @@ export type VendorsUpdateVendorDetailsMutationError =
  * Update vendor details
  *
  * @remarks
- * It will update the vendor details
+ * Update an individual vendor's profile — title, location, supervisor, email preferences, primary department, and primary sales state. A company manager can also remove the vendor from their company by sending `company_id: null`.
  */
 export function useVendorsUpdateVendorDetailsMutation(
   options?: MutationHookOptions<