@greensecurity/javascript-sdk 0.43.1-beta.120 → 0.43.1-beta.123

package/src/react-query/vendorScansListVendorScans.ts

@@ -0,0 +1,273 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2957e8d72047
+ */
+
+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 {
+  buildVendorScansListVendorScansInfiniteQuery,
+  buildVendorScansListVendorScansQuery,
+  prefetchVendorScansListVendorScans,
+  prefetchVendorScansListVendorScansInfinite,
+  queryKeyVendorScansListVendorScans,
+  queryKeyVendorScansListVendorScansInfinite,
+  VendorScansListVendorScansInfiniteQueryData,
+  VendorScansListVendorScansPageParams,
+  VendorScansListVendorScansQueryData,
+} from "./vendorScansListVendorScans.core.js";
+export {
+  buildVendorScansListVendorScansInfiniteQuery,
+  buildVendorScansListVendorScansQuery,
+  prefetchVendorScansListVendorScans,
+  prefetchVendorScansListVendorScansInfinite,
+  queryKeyVendorScansListVendorScans,
+  queryKeyVendorScansListVendorScansInfinite,
+  type VendorScansListVendorScansInfiniteQueryData,
+  type VendorScansListVendorScansPageParams,
+  type VendorScansListVendorScansQueryData,
+};
+
+export type VendorScansListVendorScansQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List vendor scans
+ *
+ * @remarks
+ * List or search vendor scans.
+ */
+export function useVendorScansListVendorScans(
+  request: operations.ListVendorScansRequest,
+  options?: QueryHookOptions<
+    VendorScansListVendorScansQueryData,
+    VendorScansListVendorScansQueryError
+  >,
+): UseQueryResult<
+  VendorScansListVendorScansQueryData,
+  VendorScansListVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansListVendorScansQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor scans
+ *
+ * @remarks
+ * List or search vendor scans.
+ */
+export function useVendorScansListVendorScansSuspense(
+  request: operations.ListVendorScansRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansListVendorScansQueryData,
+    VendorScansListVendorScansQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansListVendorScansQueryData,
+  VendorScansListVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansListVendorScansQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor scans
+ *
+ * @remarks
+ * List or search vendor scans.
+ */
+export function useVendorScansListVendorScansInfinite(
+  request: operations.ListVendorScansRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansPageParams
+  >,
+  VendorScansListVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansQueryError,
+    InfiniteData<
+      VendorScansListVendorScansInfiniteQueryData,
+      VendorScansListVendorScansPageParams
+    >,
+    QueryKey,
+    VendorScansListVendorScansPageParams
+  >({
+    ...buildVendorScansListVendorScansInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendor scans
+ *
+ * @remarks
+ * List or search vendor scans.
+ */
+export function useVendorScansListVendorScansInfiniteSuspense(
+  request: operations.ListVendorScansRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansPageParams
+  >,
+  VendorScansListVendorScansQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorScansListVendorScansInfiniteQueryData,
+    VendorScansListVendorScansQueryError,
+    InfiniteData<
+      VendorScansListVendorScansInfiniteQueryData,
+      VendorScansListVendorScansPageParams
+    >,
+    QueryKey,
+    VendorScansListVendorScansPageParams
+  >({
+    ...buildVendorScansListVendorScansInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setVendorScansListVendorScansData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+      companyId?: number | undefined;
+      vendorId?: string | undefined;
+      scanType?: operations.ScanType | undefined;
+    },
+  ],
+  data: VendorScansListVendorScansQueryData,
+): VendorScansListVendorScansQueryData | undefined {
+  const key = queryKeyVendorScansListVendorScans(...queryKeyBase);
+
+  return client.setQueryData<VendorScansListVendorScansQueryData>(key, data);
+}
+
+export function invalidateVendorScansListVendorScans(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+      companyId?: number | undefined;
+      vendorId?: string | undefined;
+      scanType?: operations.ScanType | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "listVendorScans",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansListVendorScans(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "listVendorScans",
+    ],
+  });
+}

package/src/react-query/vendorsAiClassifyCreate.ts

@@ -0,0 +1,116 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4ec27fda7583
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsAiClassifyCreate } from "../funcs/vendorsAiClassifyCreate.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsAiClassifyCreateMutationVariables = {
+  request: components.AiClassifyCreateRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsAiClassifyCreateMutationData =
+  components.AiClassifyCreateResponse;
+
+export type VendorsAiClassifyCreateMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create AI-classification record + presigned upload URL
+ *
+ * @remarks
+ * Creates a placeholder VendorCredential (credential_id: nil,
+ * status: PENDING_CLASSIFICATION) plus a paired VendorCredentialFile,
+ * then returns a short-lived presigned S3 PUT URL targeting the
+ * canonical VCF key. The client uploads to that URL; the S3 PUT
+ * triggers Lambda which fires AiCredentialClassificationJob.
+ */
+export function useVendorsAiClassifyCreateMutation(
+  options?: MutationHookOptions<
+    VendorsAiClassifyCreateMutationData,
+    VendorsAiClassifyCreateMutationError,
+    VendorsAiClassifyCreateMutationVariables
+  >,
+): UseMutationResult<
+  VendorsAiClassifyCreateMutationData,
+  VendorsAiClassifyCreateMutationError,
+  VendorsAiClassifyCreateMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsAiClassifyCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsAiClassifyCreate(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "vendors", "aiClassifyCreate"];
+}
+
+export function buildVendorsAiClassifyCreateMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsAiClassifyCreateMutationVariables,
+  ) => Promise<VendorsAiClassifyCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsAiClassifyCreate(),
+    mutationFn: function vendorsAiClassifyCreateMutationFn({
+      request,
+      options,
+    }): Promise<VendorsAiClassifyCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsAiClassifyCreate(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorsAiClassifyNotifyUploaded.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f7be72de0aef
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsAiClassifyNotifyUploaded } from "../funcs/vendorsAiClassifyNotifyUploaded.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsAiClassifyNotifyUploadedMutationVariables = {
+  request: components.AiClassifyNotifyUploadedRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsAiClassifyNotifyUploadedMutationData =
+  components.AiClassifyNotifyUploadedResponse;
+
+export type VendorsAiClassifyNotifyUploadedMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Notify server that the S3 PUT succeeded
+ *
+ * @remarks
+ * Client-initiated notify so AiCredentialClassificationJob enqueues
+ * even when the S3 Lambda webhook isn't reachable (e.g., local dev).
+ * Idempotent — the job's guard short-circuits if Lambda also fires.
+ */
+export function useVendorsAiClassifyNotifyUploadedMutation(
+  options?: MutationHookOptions<
+    VendorsAiClassifyNotifyUploadedMutationData,
+    VendorsAiClassifyNotifyUploadedMutationError,
+    VendorsAiClassifyNotifyUploadedMutationVariables
+  >,
+): UseMutationResult<
+  VendorsAiClassifyNotifyUploadedMutationData,
+  VendorsAiClassifyNotifyUploadedMutationError,
+  VendorsAiClassifyNotifyUploadedMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsAiClassifyNotifyUploadedMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsAiClassifyNotifyUploaded(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "aiClassifyNotifyUploaded",
+  ];
+}
+
+export function buildVendorsAiClassifyNotifyUploadedMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsAiClassifyNotifyUploadedMutationVariables,
+  ) => Promise<VendorsAiClassifyNotifyUploadedMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsAiClassifyNotifyUploaded(),
+    mutationFn: function vendorsAiClassifyNotifyUploadedMutationFn({
+      request,
+      options,
+    }): Promise<VendorsAiClassifyNotifyUploadedMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsAiClassifyNotifyUploaded(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e3ca8c943345
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetVendorUploadHistory } from "../funcs/vendorsGetVendorUploadHistory.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 VendorsGetVendorUploadHistoryQueryData = Array<
+  components.UploadHistoryItem
+>;
+
+export function prefetchVendorsGetVendorUploadHistory(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorUploadHistoryQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsGetVendorUploadHistoryQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorUploadHistoryQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorUploadHistory(request.vendorIdOrMe, {
+      limit: request.limit,
+    }),
+    queryFn: async function vendorsGetVendorUploadHistoryQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorUploadHistoryQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsGetVendorUploadHistory(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorUploadHistory(
+  vendorIdOrMe: string,
+  parameters: { limit?: number | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorUploadHistory",
+    vendorIdOrMe,
+    parameters,
+  ];
+}