@greensecurity/javascript-sdk 0.43.1-beta.98 → 0.44.0-beta.1

package/src/react-query/vendorsGetVendorUploadHistory.ts

@@ -0,0 +1,266 @@
+/*
+ * 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 {
+  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/react-query/vendorsGetVendorsDetails.ts

@@ -57,7 +57,7 @@ export type VendorsGetVendorsDetailsQueryError =
  * Get vendors details
  *
  * @remarks
- * Retrieve an individual vendor detais.
+ * Retrieve an individual vendor details.
  *
  * Available `expand` scopes are:
  *
@@ -82,6 +82,8 @@ export type VendorsGetVendorsDetailsQueryError =
  * vendor.vendor_groups
  * vendor.has_credentialed_facilities
  * vendor.has_emerald_status
+ * vendor.has_target_facility_questions
+ * vendor.custom_fields
  */
 export function useVendorsGetVendorsDetails(
   request: operations.GetVendorsDetailsRequest,
@@ -108,7 +110,7 @@ export function useVendorsGetVendorsDetails(
  * Get vendors details
  *
  * @remarks
- * Retrieve an individual vendor detais.
+ * Retrieve an individual vendor details.
  *
  * Available `expand` scopes are:
  *
@@ -133,6 +135,8 @@ export function useVendorsGetVendorsDetails(
  * vendor.vendor_groups
  * vendor.has_credentialed_facilities
  * vendor.has_emerald_status
+ * vendor.has_target_facility_questions
+ * vendor.custom_fields
  */
 export function useVendorsGetVendorsDetailsSuspense(
   request: operations.GetVendorsDetailsRequest,

package/src/react-query/vendorsListVendorAdditionalFacilityFields.ts

@@ -75,7 +75,14 @@ export type VendorsListVendorAdditionalFacilityFieldsQueryError =
  * List of vendor's additional facility fields
  *
  * @remarks
- * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ * Deprecated. Use `GET /vendors/{vendor_id_or_me}/custom-fields` instead.
+ *
+ * Backward-compatible shape preserved: this endpoint continues to return
+ * the legacy paginated envelope (`items` + `pager`) with the original
+ * `system` / `facility` / `field` / `value` keys per item. New consumers
+ * should migrate to `/custom-fields`, which returns an unpaginated array
+ * with the `field_for` discriminator. Scheduled for removal after SDK
+ * consumers migrate.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -104,7 +111,14 @@ export function useVendorsListVendorAdditionalFacilityFields(
  * List of vendor's additional facility fields
  *
  * @remarks
- * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ * Deprecated. Use `GET /vendors/{vendor_id_or_me}/custom-fields` instead.
+ *
+ * Backward-compatible shape preserved: this endpoint continues to return
+ * the legacy paginated envelope (`items` + `pager`) with the original
+ * `system` / `facility` / `field` / `value` keys per item. New consumers
+ * should migrate to `/custom-fields`, which returns an unpaginated array
+ * with the `field_for` discriminator. Scheduled for removal after SDK
+ * consumers migrate.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -133,7 +147,14 @@ export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
  * List of vendor's additional facility fields
  *
  * @remarks
- * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ * Deprecated. Use `GET /vendors/{vendor_id_or_me}/custom-fields` instead.
+ *
+ * Backward-compatible shape preserved: this endpoint continues to return
+ * the legacy paginated envelope (`items` + `pager`) with the original
+ * `system` / `facility` / `field` / `value` keys per item. New consumers
+ * should migrate to `/custom-fields`, which returns an unpaginated array
+ * with the `field_for` discriminator. Scheduled for removal after SDK
+ * consumers migrate.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -176,7 +197,14 @@ export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
  * List of vendor's additional facility fields
  *
  * @remarks
- * Deprecated. Use /vendors/{vendor_id_or_me}/custom-fields.
+ * Deprecated. Use `GET /vendors/{vendor_id_or_me}/custom-fields` instead.
+ *
+ * Backward-compatible shape preserved: this endpoint continues to return
+ * the legacy paginated envelope (`items` + `pager`) with the original
+ * `system` / `facility` / `field` / `value` keys per item. New consumers
+ * should migrate to `/custom-fields`, which returns an unpaginated array
+ * with the `field_for` discriminator. Scheduled for removal after SDK
+ * consumers migrate.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */

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

@@ -11,23 +11,10 @@ import { GreenSecurityCore } from "../core.js";
 import { vendorsListVendorCustomFields } from "../funcs/vendorsListVendorCustomFields.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 VendorsListVendorCustomFieldsQueryData =
-  operations.ListVendorCustomFieldsResponse;
-
-export type VendorsListVendorCustomFieldsInfiniteQueryData = PageIterator<
-  operations.ListVendorCustomFieldsResponse,
-  { page: number }
->;
-
-export type VendorsListVendorCustomFieldsPageParams = PageIterator<
-  operations.ListVendorCustomFieldsResponse,
-  { page: number }
->["~next"];
+  operations.ListVendorCustomFieldsListVendorCustomFieldsOk;
 
 export function prefetchVendorsListVendorCustomFields(
   queryClient: QueryClient,
@@ -44,25 +31,6 @@ export function prefetchVendorsListVendorCustomFields(
   });
 }
 
-export function prefetchVendorsListVendorCustomFieldsInfinite(
-  queryClient: QueryClient,
-  client$: GreenSecurityCore,
-  request: operations.ListVendorCustomFieldsRequest,
-  options?: RequestOptions,
-): Promise<void> {
-  return queryClient.prefetchInfiniteQuery({
-    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
-      client$,
-      request,
-      options,
-    ),
-    initialPageParam: undefined as VendorsListVendorCustomFieldsPageParams,
-    getNextPageParam: (
-      previousPage: VendorsListVendorCustomFieldsInfiniteQueryData,
-    ) => previousPage["~next"],
-  });
-}
-
 export function buildVendorsListVendorCustomFieldsQuery(
   client$: GreenSecurityCore,
   request: operations.ListVendorCustomFieldsRequest,
@@ -74,12 +42,7 @@ export function buildVendorsListVendorCustomFieldsQuery(
   ) => Promise<VendorsListVendorCustomFieldsQueryData>;
 } {
   return {
-    queryKey: queryKeyVendorsListVendorCustomFields(request.vendorIdOrMe, {
-      sort: request.sort,
-      desc: request.desc,
-      page: request.page,
-      itemsPerPage: request.itemsPerPage,
-    }),
+    queryKey: queryKeyVendorsListVendorCustomFields(request.vendorIdOrMe),
     queryFn: async function vendorsListVendorCustomFieldsQueryFn(
       ctx,
     ): Promise<VendorsListVendorCustomFieldsQueryData> {
@@ -103,96 +66,13 @@ export function buildVendorsListVendorCustomFieldsQuery(
   };
 }
 
-export function buildVendorsListVendorCustomFieldsInfiniteQuery(
-  client$: GreenSecurityCore,
-  request: operations.ListVendorCustomFieldsRequest,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext<
-      QueryKey,
-      VendorsListVendorCustomFieldsPageParams
-    >,
-  ) => Promise<VendorsListVendorCustomFieldsInfiniteQueryData>;
-} {
-  return {
-    queryKey: queryKeyVendorsListVendorCustomFieldsInfinite(
-      request.vendorIdOrMe,
-      {
-        sort: request.sort,
-        desc: request.desc,
-        page: request.page,
-        itemsPerPage: request.itemsPerPage,
-      },
-    ),
-    queryFn: async function vendorsListVendorCustomFieldsQuery(
-      ctx,
-    ): Promise<VendorsListVendorCustomFieldsInfiniteQueryData> {
-      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
-      const mergedOptions = {
-        ...options,
-        fetchOptions: { ...options?.fetchOptions, signal: sig },
-      };
-
-      if (!ctx.pageParam) {
-        const pageResult = await unwrapResultIterator(
-          vendorsListVendorCustomFields(
-            client$,
-            request,
-            mergedOptions,
-          ),
-        );
-        return pageIteratorToJSON(pageResult);
-      }
-      const pageResult = await unwrapResultIterator(
-        vendorsListVendorCustomFields(
-          client$,
-          {
-            ...request,
-            page: ctx.pageParam.page,
-          },
-          mergedOptions,
-        ),
-      );
-      return pageIteratorToJSON(pageResult);
-    },
-  };
-}
-
 export function queryKeyVendorsListVendorCustomFields(
   vendorIdOrMe: string,
-  parameters: {
-    sort?: string | null | undefined;
-    desc?: components.Desc | undefined;
-    page?: number | undefined;
-    itemsPerPage?: number | undefined;
-  },
-): QueryKey {
-  return [
-    "@greensecurity/javascript-sdk",
-    "vendors",
-    "listVendorCustomFields",
-    vendorIdOrMe,
-    parameters,
-  ];
-}
-
-export function queryKeyVendorsListVendorCustomFieldsInfinite(
-  vendorIdOrMe: string,
-  parameters: {
-    sort?: string | null | undefined;
-    desc?: components.Desc | undefined;
-    page?: number | undefined;
-    itemsPerPage?: number | undefined;
-  },
 ): QueryKey {
   return [
     "@greensecurity/javascript-sdk",
     "vendors",
     "listVendorCustomFields",
-    "infinite",
     vendorIdOrMe,
-    parameters,
   ];
 }