@greensecurity/javascript-sdk 0.43.1-beta.137 → 0.43.1-beta.138

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

@@ -0,0 +1,199 @@
+/*
+ * 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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { pageIteratorToJSON } from "./_types.js";
+export type VendorsGetVendorUploadHistoryQueryData =
+  operations.GetVendorUploadHistoryResponse;
+
+export type VendorsGetVendorUploadHistoryInfiniteQueryData = PageIterator<
+  operations.GetVendorUploadHistoryResponse,
+  { page: number }
+>;
+
+export type VendorsGetVendorUploadHistoryPageParams = PageIterator<
+  operations.GetVendorUploadHistoryResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchVendorsGetVendorUploadHistory(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorUploadHistoryQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchVendorsGetVendorUploadHistoryInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildVendorsGetVendorUploadHistoryInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as VendorsGetVendorUploadHistoryPageParams,
+    getNextPageParam: (
+      previousPage: VendorsGetVendorUploadHistoryInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildVendorsGetVendorUploadHistoryQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorUploadHistoryQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorUploadHistory(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    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 buildVendorsGetVendorUploadHistoryInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorsGetVendorUploadHistoryPageParams
+    >,
+  ) => Promise<VendorsGetVendorUploadHistoryInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorUploadHistoryInfinite(
+      request.vendorIdOrMe,
+      {
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+      },
+    ),
+    queryFn: async function vendorsGetVendorUploadHistoryQuery(
+      ctx,
+    ): Promise<VendorsGetVendorUploadHistoryInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          vendorsGetVendorUploadHistory(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        vendorsGetVendorUploadHistory(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorUploadHistory(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorUploadHistory",
+    vendorIdOrMe,
+    parameters,
+  ];
+}
+
+export function queryKeyVendorsGetVendorUploadHistoryInfinite(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorUploadHistory",
+    "infinite",
+    vendorIdOrMe,
+    parameters,
+  ];
+}

package/src/react-query/vendorsGetVendorUploadHistory.ts

@@ -0,0 +1,267 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d5ed03adbdf5
+ */
+
+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 {
+  buildVendorsGetVendorUploadHistoryInfiniteQuery,
+  buildVendorsGetVendorUploadHistoryQuery,
+  prefetchVendorsGetVendorUploadHistory,
+  prefetchVendorsGetVendorUploadHistoryInfinite,
+  queryKeyVendorsGetVendorUploadHistory,
+  queryKeyVendorsGetVendorUploadHistoryInfinite,
+  VendorsGetVendorUploadHistoryInfiniteQueryData,
+  VendorsGetVendorUploadHistoryPageParams,
+  VendorsGetVendorUploadHistoryQueryData,
+} from "./vendorsGetVendorUploadHistory.core.js";
+export {
+  buildVendorsGetVendorUploadHistoryInfiniteQuery,
+  buildVendorsGetVendorUploadHistoryQuery,
+  prefetchVendorsGetVendorUploadHistory,
+  prefetchVendorsGetVendorUploadHistoryInfinite,
+  queryKeyVendorsGetVendorUploadHistory,
+  queryKeyVendorsGetVendorUploadHistoryInfinite,
+  type VendorsGetVendorUploadHistoryInfiniteQueryData,
+  type VendorsGetVendorUploadHistoryPageParams,
+  type VendorsGetVendorUploadHistoryQueryData,
+};
+
+export type VendorsGetVendorUploadHistoryQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get vendor upload history
+ *
+ * @remarks
+ * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+ */
+export function useVendorsGetVendorUploadHistory(
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: QueryHookOptions<
+    VendorsGetVendorUploadHistoryQueryData,
+    VendorsGetVendorUploadHistoryQueryError
+  >,
+): UseQueryResult<
+  VendorsGetVendorUploadHistoryQueryData,
+  VendorsGetVendorUploadHistoryQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsGetVendorUploadHistoryQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor upload history
+ *
+ * @remarks
+ * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+ */
+export function useVendorsGetVendorUploadHistorySuspense(
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsGetVendorUploadHistoryQueryData,
+    VendorsGetVendorUploadHistoryQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsGetVendorUploadHistoryQueryData,
+  VendorsGetVendorUploadHistoryQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsGetVendorUploadHistoryQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get vendor upload history
+ *
+ * @remarks
+ * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+ */
+export function useVendorsGetVendorUploadHistoryInfinite(
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryPageParams
+  >,
+  VendorsGetVendorUploadHistoryQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryQueryError,
+    InfiniteData<
+      VendorsGetVendorUploadHistoryInfiniteQueryData,
+      VendorsGetVendorUploadHistoryPageParams
+    >,
+    QueryKey,
+    VendorsGetVendorUploadHistoryPageParams
+  >({
+    ...buildVendorsGetVendorUploadHistoryInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * Get vendor upload history
+ *
+ * @remarks
+ * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+ */
+export function useVendorsGetVendorUploadHistoryInfiniteSuspense(
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryPageParams
+  >,
+  VendorsGetVendorUploadHistoryQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsGetVendorUploadHistoryInfiniteQueryData,
+    VendorsGetVendorUploadHistoryQueryError,
+    InfiniteData<
+      VendorsGetVendorUploadHistoryInfiniteQueryData,
+      VendorsGetVendorUploadHistoryPageParams
+    >,
+    QueryKey,
+    VendorsGetVendorUploadHistoryPageParams
+  >({
+    ...buildVendorsGetVendorUploadHistoryInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setVendorsGetVendorUploadHistoryData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorIdOrMe: string,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: VendorsGetVendorUploadHistoryQueryData,
+): VendorsGetVendorUploadHistoryQueryData | undefined {
+  const key = queryKeyVendorsGetVendorUploadHistory(...queryKeyBase);
+
+  return client.setQueryData<VendorsGetVendorUploadHistoryQueryData>(key, data);
+}
+
+export function invalidateVendorsGetVendorUploadHistory(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      vendorIdOrMe: string,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorUploadHistory",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsGetVendorUploadHistory(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "getVendorUploadHistory",
+    ],
+  });
+}

package/src/sdk/vendors.ts

@@ -28,6 +28,7 @@ import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoice
 import { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
 import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
+import { vendorsGetVendorUploadHistory } from "../funcs/vendorsGetVendorUploadHistory.js";
 import { vendorsListVendorAdditionalFacilityFields } from "../funcs/vendorsListVendorAdditionalFacilityFields.js";
 import { vendorsListVendorCredentialDataRequests } from "../funcs/vendorsListVendorCredentialDataRequests.js";
 import { vendorsListVendorCredentialFiles } from "../funcs/vendorsListVendorCredentialFiles.js";
@@ -1086,6 +1087,25 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Get vendor upload history
+   *
+   * @remarks
+   * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+   */
+  async getVendorUploadHistory(
+    request: operations.GetVendorUploadHistoryRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.GetVendorUploadHistoryResponse, { page: number }>
+  > {
+    return unwrapResultIterator(vendorsGetVendorUploadHistory(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get a one-time URL for uploading a credential file for automatic classification (Emerald vendors only)
    *