@greensecurity/javascript-sdk 0.43.1-beta.122 → 0.43.1-beta.124

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

@@ -12,23 +12,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,
@@ -45,25 +32,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,
@@ -75,12 +43,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> {
@@ -104,96 +67,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,
   ];
 }

package/src/react-query/vendorsListVendorCustomFields.ts

@@ -4,20 +4,13 @@
  */
 
 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,
@@ -32,32 +25,20 @@ 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 {
-  buildVendorsListVendorCustomFieldsInfiniteQuery,
   buildVendorsListVendorCustomFieldsQuery,
   prefetchVendorsListVendorCustomFields,
-  prefetchVendorsListVendorCustomFieldsInfinite,
   queryKeyVendorsListVendorCustomFields,
-  queryKeyVendorsListVendorCustomFieldsInfinite,
-  VendorsListVendorCustomFieldsInfiniteQueryData,
-  VendorsListVendorCustomFieldsPageParams,
   VendorsListVendorCustomFieldsQueryData,
 } from "./vendorsListVendorCustomFields.core.js";
 export {
-  buildVendorsListVendorCustomFieldsInfiniteQuery,
   buildVendorsListVendorCustomFieldsQuery,
   prefetchVendorsListVendorCustomFields,
-  prefetchVendorsListVendorCustomFieldsInfinite,
   queryKeyVendorsListVendorCustomFields,
-  queryKeyVendorsListVendorCustomFieldsInfinite,
-  type VendorsListVendorCustomFieldsInfiniteQueryData,
-  type VendorsListVendorCustomFieldsPageParams,
   type VendorsListVendorCustomFieldsQueryData,
 };
 
@@ -73,10 +54,19 @@ export type VendorsListVendorCustomFieldsQueryError =
   | SDKValidationError;
 
 /**
- * List of vendor custom fields
+ * List vendor custom fields
  *
  * @remarks
- * List of vendor custom fields
+ * Returns all custom fields (company-level and facility-level) for the vendor,
+ * merged into a single array. Each item includes a `field_for` discriminator
+ * indicating whether the field belongs to a company or facility.
+ *
+ * Fields that the vendor has not yet set a value for are returned with
+ * `value: null`, including fields where other vendors in the same company
+ * have set values.
+ *
+ * Accepts a numeric vendor ID, `me` for the authenticated vendor,
+ * or an active QR code (format: contains hyphens).
  */
 export function useVendorsListVendorCustomFields(
   request: operations.ListVendorCustomFieldsRequest,
@@ -100,10 +90,19 @@ export function useVendorsListVendorCustomFields(
 }
 
 /**
- * List of vendor custom fields
+ * List vendor custom fields
  *
  * @remarks
- * List of vendor custom fields
+ * Returns all custom fields (company-level and facility-level) for the vendor,
+ * merged into a single array. Each item includes a `field_for` discriminator
+ * indicating whether the field belongs to a company or facility.
+ *
+ * Fields that the vendor has not yet set a value for are returned with
+ * `value: null`, including fields where other vendors in the same company
+ * have set values.
+ *
+ * Accepts a numeric vendor ID, `me` for the authenticated vendor,
+ * or an active QR code (format: contains hyphens).
  */
 export function useVendorsListVendorCustomFieldsSuspense(
   request: operations.ListVendorCustomFieldsRequest,
@@ -126,99 +125,9 @@ export function useVendorsListVendorCustomFieldsSuspense(
   });
 }
 
-/**
- * List of vendor custom fields
- *
- * @remarks
- * List of vendor custom fields
- */
-export function useVendorsListVendorCustomFieldsInfinite(
-  request: operations.ListVendorCustomFieldsRequest,
-  options?: InfiniteQueryHookOptions<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsQueryError
-  >,
-): UseInfiniteQueryResult<
-  InfiniteData<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsPageParams
-  >,
-  VendorsListVendorCustomFieldsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useInfiniteQuery<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsQueryError,
-    InfiniteData<
-      VendorsListVendorCustomFieldsInfiniteQueryData,
-      VendorsListVendorCustomFieldsPageParams
-    >,
-    QueryKey,
-    VendorsListVendorCustomFieldsPageParams
-  >({
-    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
-      client,
-      request,
-      options,
-    ),
-    initialPageParam: options?.initialPageParam,
-    getNextPageParam: (previousPage) => previousPage["~next"],
-    ...options,
-  });
-}
-
-/**
- * List of vendor custom fields
- *
- * @remarks
- * List of vendor custom fields
- */
-export function useVendorsListVendorCustomFieldsInfiniteSuspense(
-  request: operations.ListVendorCustomFieldsRequest,
-  options?: SuspenseInfiniteQueryHookOptions<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsQueryError
-  >,
-): UseSuspenseInfiniteQueryResult<
-  InfiniteData<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsPageParams
-  >,
-  VendorsListVendorCustomFieldsQueryError
-> {
-  const client = useGreenSecurityContext();
-  return useSuspenseInfiniteQuery<
-    VendorsListVendorCustomFieldsInfiniteQueryData,
-    VendorsListVendorCustomFieldsQueryError,
-    InfiniteData<
-      VendorsListVendorCustomFieldsInfiniteQueryData,
-      VendorsListVendorCustomFieldsPageParams
-    >,
-    QueryKey,
-    VendorsListVendorCustomFieldsPageParams
-  >({
-    ...buildVendorsListVendorCustomFieldsInfiniteQuery(
-      client,
-      request,
-      options,
-    ),
-    initialPageParam: options?.initialPageParam,
-    getNextPageParam: (previousPage) => previousPage["~next"],
-    ...options,
-  });
-}
-
 export function setVendorsListVendorCustomFieldsData(
   client: QueryClient,
-  queryKeyBase: [
-    vendorIdOrMe: string,
-    parameters: {
-      sort?: string | null | undefined;
-      desc?: components.Desc | undefined;
-      page?: number | undefined;
-      itemsPerPage?: number | undefined;
-    },
-  ],
+  queryKeyBase: [vendorIdOrMe: string],
   data: VendorsListVendorCustomFieldsQueryData,
 ): VendorsListVendorCustomFieldsQueryData | undefined {
   const key = queryKeyVendorsListVendorCustomFields(...queryKeyBase);
@@ -228,17 +137,7 @@ export function setVendorsListVendorCustomFieldsData(
 
 export function invalidateVendorsListVendorCustomFields(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<
-    [
-      vendorIdOrMe: string,
-      parameters: {
-        sort?: string | null | undefined;
-        desc?: components.Desc | undefined;
-        page?: number | undefined;
-        itemsPerPage?: number | undefined;
-      },
-    ]
-  >,
+  queryKeyBase: TupleToPrefixes<[vendorIdOrMe: string]>,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

package/src/react-query/vendorsUpdateVendorCustomField.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d2468ce2eefa
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsUpdateVendorCustomField } from "../funcs/vendorsUpdateVendorCustomField.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 * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type VendorsUpdateVendorCustomFieldMutationVariables = {
+  request: operations.UpdateVendorCustomFieldRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsUpdateVendorCustomFieldMutationData =
+  components.VendorCustomFields;
+
+export type VendorsUpdateVendorCustomFieldMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Update a vendor custom field value
+ *
+ * @remarks
+ * Sets or updates a custom field value for the specified vendor. If the value
+ * does not exist it is created; if it already exists it is updated (upsert).
+ *
+ * The vendor field must belong to the vendor's company or to one of the
+ * vendor's targeted facilities, and must have `show_to_vendor` set to `true`.
+ *
+ * Accepts a numeric vendor ID, `me` for the authenticated vendor,
+ * or an active QR code (format: contains hyphens).
+ */
+export function useVendorsUpdateVendorCustomFieldMutation(
+  options?: MutationHookOptions<
+    VendorsUpdateVendorCustomFieldMutationData,
+    VendorsUpdateVendorCustomFieldMutationError,
+    VendorsUpdateVendorCustomFieldMutationVariables
+  >,
+): UseMutationResult<
+  VendorsUpdateVendorCustomFieldMutationData,
+  VendorsUpdateVendorCustomFieldMutationError,
+  VendorsUpdateVendorCustomFieldMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsUpdateVendorCustomFieldMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsUpdateVendorCustomField(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "updateVendorCustomField",
+  ];
+}
+
+export function buildVendorsUpdateVendorCustomFieldMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsUpdateVendorCustomFieldMutationVariables,
+  ) => Promise<VendorsUpdateVendorCustomFieldMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsUpdateVendorCustomField(),
+    mutationFn: function vendorsUpdateVendorCustomFieldMutationFn({
+      request,
+      options,
+    }): Promise<VendorsUpdateVendorCustomFieldMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsUpdateVendorCustomField(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/vendors.ts

@@ -46,6 +46,7 @@ import { vendorsSendDownloadCode } from "../funcs/vendorsSendDownloadCode.js";
 import { vendorsSubmitVendorCredential } from "../funcs/vendorsSubmitVendorCredential.js";
 import { vendorsUpdateVendorCredentialData } from "../funcs/vendorsUpdateVendorCredentialData.js";
 import { vendorsUpdateVendorCredentialFile } from "../funcs/vendorsUpdateVendorCredentialFile.js";
+import { vendorsUpdateVendorCustomField } from "../funcs/vendorsUpdateVendorCustomField.js";
 import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.js";
 import { vendorsUpdateVendorManagedByCompany } from "../funcs/vendorsUpdateVendorManagedByCompany.js";
 import { vendorsUpdateVendorScrubDetails } from "../funcs/vendorsUpdateVendorScrubDetails.js";
@@ -713,6 +714,7 @@ export class Vendors extends ClientSDK {
    * vendor.vendor_groups
    * vendor.has_credentialed_facilities
    * vendor.has_emerald_status
+   * vendor.custom_fields
    */
   async getVendorsDetails(
     request: operations.GetVendorsDetailsRequest,
@@ -765,7 +767,13 @@ export class Vendors extends ClientSDK {
    * 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.
+   *
+   * **Breaking change notice:** The response shape has been realigned with
+   * `/custom-fields`. Legacy keys (`system`, `facility`, `field`) and the
+   * `pager` envelope are no longer returned. The endpoint now returns the
+   * full `items` array with the new `field_for` discriminator and no
+   * pagination. 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.
    */
@@ -773,12 +781,9 @@ export class Vendors extends ClientSDK {
     request: operations.ListVendorAdditionalFacilityFieldsRequest,
     options?: RequestOptions,
   ): Promise<
-    PageIterator<
-      operations.ListVendorAdditionalFacilityFieldsResponse,
-      { page: number }
-    >
+    operations.ListVendorAdditionalFacilityFieldsListVendorAdditionalFacilityFieldsOk
   > {
-    return unwrapResultIterator(vendorsListVendorAdditionalFacilityFields(
+    return unwrapAsync(vendorsListVendorAdditionalFacilityFields(
       this,
       request,
       options,
@@ -786,18 +791,49 @@ export class Vendors extends ClientSDK {
   }
 
   /**
-   * List of vendor custom fields
+   * List vendor custom fields
    *
    * @remarks
-   * List of vendor custom fields
+   * Returns all custom fields (company-level and facility-level) for the vendor,
+   * merged into a single array. Each item includes a `field_for` discriminator
+   * indicating whether the field belongs to a company or facility.
+   *
+   * Fields that the vendor has not yet set a value for are returned with
+   * `value: null`, including fields where other vendors in the same company
+   * have set values.
+   *
+   * Accepts a numeric vendor ID, `me` for the authenticated vendor,
+   * or an active QR code (format: contains hyphens).
    */
   async listVendorCustomFields(
     request: operations.ListVendorCustomFieldsRequest,
     options?: RequestOptions,
-  ): Promise<
-    PageIterator<operations.ListVendorCustomFieldsResponse, { page: number }>
-  > {
-    return unwrapResultIterator(vendorsListVendorCustomFields(
+  ): Promise<operations.ListVendorCustomFieldsListVendorCustomFieldsOk> {
+    return unwrapAsync(vendorsListVendorCustomFields(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update a vendor custom field value
+   *
+   * @remarks
+   * Sets or updates a custom field value for the specified vendor. If the value
+   * does not exist it is created; if it already exists it is updated (upsert).
+   *
+   * The vendor field must belong to the vendor's company or to one of the
+   * vendor's targeted facilities, and must have `show_to_vendor` set to `true`.
+   *
+   * Accepts a numeric vendor ID, `me` for the authenticated vendor,
+   * or an active QR code (format: contains hyphens).
+   */
+  async updateVendorCustomField(
+    request: operations.UpdateVendorCustomFieldRequest,
+    options?: RequestOptions,
+  ): Promise<components.VendorCustomFields> {
+    return unwrapAsync(vendorsUpdateVendorCustomField(
       this,
       request,
       options,