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

package/src/react-query/vendorFieldsCreateVendorField.ts

@@ -0,0 +1,121 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorFieldsCreateVendorField } from "../funcs/vendorFieldsCreateVendorField.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 VendorFieldsCreateVendorFieldMutationVariables = {
+  request: operations.CreateVendorFieldRequestBody;
+  options?: RequestOptions;
+};
+
+export type VendorFieldsCreateVendorFieldMutationData =
+  operations.CreateVendorFieldResponseBody;
+
+export type VendorFieldsCreateVendorFieldMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create vendor field
+ *
+ * @remarks
+ * Create a new vendor field for a company. Each company may have at most one custom
+ * vendor field; if one already exists, the request fails with 422. The name can only
+ * be set on creation; once created, only the show_to_vendor flag can be updated via PATCH.
+ * Requires access to the company (company manager, admin, or API user with company scope).
+ *
+ * For API users: source_user_id is required. The API user acts on behalf of that user
+ * (e.g. a company manager). The app must be activated for that user via MarketplaceAppActivation.
+ */
+export function useVendorFieldsCreateVendorFieldMutation(
+  options?: MutationHookOptions<
+    VendorFieldsCreateVendorFieldMutationData,
+    VendorFieldsCreateVendorFieldMutationError,
+    VendorFieldsCreateVendorFieldMutationVariables
+  >,
+): UseMutationResult<
+  VendorFieldsCreateVendorFieldMutationData,
+  VendorFieldsCreateVendorFieldMutationError,
+  VendorFieldsCreateVendorFieldMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorFieldsCreateVendorFieldMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorFieldsCreateVendorField(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor-fields",
+    "createVendorField",
+  ];
+}
+
+export function buildVendorFieldsCreateVendorFieldMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorFieldsCreateVendorFieldMutationVariables,
+  ) => Promise<VendorFieldsCreateVendorFieldMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorFieldsCreateVendorField(),
+    mutationFn: function vendorFieldsCreateVendorFieldMutationFn({
+      request,
+      options,
+    }): Promise<VendorFieldsCreateVendorFieldMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorFieldsCreateVendorField(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/vendorFieldsUpdateVendorField.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorFieldsUpdateVendorField } from "../funcs/vendorFieldsUpdateVendorField.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 VendorFieldsUpdateVendorFieldMutationVariables = {
+  request: operations.UpdateVendorFieldRequest;
+  options?: RequestOptions;
+};
+
+export type VendorFieldsUpdateVendorFieldMutationData =
+  operations.UpdateVendorFieldResponseBody;
+
+export type VendorFieldsUpdateVendorFieldMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Update vendor field
+ *
+ * @remarks
+ * Update a vendor field. Only the show_to_vendor flag can be changed;
+ * the name cannot be modified after creation.
+ *
+ * For API users: source_user_id is required. The API user acts on behalf of that user.
+ */
+export function useVendorFieldsUpdateVendorFieldMutation(
+  options?: MutationHookOptions<
+    VendorFieldsUpdateVendorFieldMutationData,
+    VendorFieldsUpdateVendorFieldMutationError,
+    VendorFieldsUpdateVendorFieldMutationVariables
+  >,
+): UseMutationResult<
+  VendorFieldsUpdateVendorFieldMutationData,
+  VendorFieldsUpdateVendorFieldMutationError,
+  VendorFieldsUpdateVendorFieldMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorFieldsUpdateVendorFieldMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorFieldsUpdateVendorField(): MutationKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor-fields",
+    "updateVendorField",
+  ];
+}
+
+export function buildVendorFieldsUpdateVendorFieldMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorFieldsUpdateVendorFieldMutationVariables,
+  ) => Promise<VendorFieldsUpdateVendorFieldMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorFieldsUpdateVendorField(),
+    mutationFn: function vendorFieldsUpdateVendorFieldMutationFn({
+      request,
+      options,
+    }): Promise<VendorFieldsUpdateVendorFieldMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorFieldsUpdateVendorField(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

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

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorScansGetVendorScan } from "../funcs/vendorScansGetVendorScan.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 VendorScansGetVendorScanQueryData = components.VendorScan;
+
+export function prefetchVendorScansGetVendorScan(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScanRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorScansGetVendorScanQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorScanRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorScansGetVendorScanQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorScansGetVendorScan(request.id, {
+      expand: request.expand,
+    }),
+    queryFn: async function vendorScansGetVendorScanQueryFn(
+      ctx,
+    ): Promise<VendorScansGetVendorScanQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorScansGetVendorScan(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorScansGetVendorScan(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendor_scans",
+    "getVendorScan",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/vendorScansGetVendorScan.ts

@@ -0,0 +1,167 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  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 {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorScansGetVendorScanQuery,
+  prefetchVendorScansGetVendorScan,
+  queryKeyVendorScansGetVendorScan,
+  VendorScansGetVendorScanQueryData,
+} from "./vendorScansGetVendorScan.core.js";
+export {
+  buildVendorScansGetVendorScanQuery,
+  prefetchVendorScansGetVendorScan,
+  queryKeyVendorScansGetVendorScan,
+  type VendorScansGetVendorScanQueryData,
+};
+
+export type VendorScansGetVendorScanQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get a vendor scan by ID
+ *
+ * @remarks
+ * Retrieve a single vendor scan by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_scan.vendor
+ * - vendor_scan.zone
+ * - vendor_scan.department
+ * - vendor_scan.badge_data
+ */
+export function useVendorScansGetVendorScan(
+  request: operations.GetVendorScanRequest,
+  options?: QueryHookOptions<
+    VendorScansGetVendorScanQueryData,
+    VendorScansGetVendorScanQueryError
+  >,
+): UseQueryResult<
+  VendorScansGetVendorScanQueryData,
+  VendorScansGetVendorScanQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get a vendor scan by ID
+ *
+ * @remarks
+ * Retrieve a single vendor scan by ID.
+ *
+ * Available `expand` scopes are:
+ *
+ * - vendor_scan.vendor
+ * - vendor_scan.zone
+ * - vendor_scan.department
+ * - vendor_scan.badge_data
+ */
+export function useVendorScansGetVendorScanSuspense(
+  request: operations.GetVendorScanRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorScansGetVendorScanQueryData,
+    VendorScansGetVendorScanQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorScansGetVendorScanQueryData,
+  VendorScansGetVendorScanQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorScansGetVendorScanQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorScansGetVendorScanData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
+  data: VendorScansGetVendorScanQueryData,
+): VendorScansGetVendorScanQueryData | undefined {
+  const key = queryKeyVendorScansGetVendorScan(...queryKeyBase);
+
+  return client.setQueryData<VendorScansGetVendorScanQueryData>(key, data);
+}
+
+export function invalidateVendorScansGetVendorScan(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScan",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorScansGetVendorScan(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendor_scans",
+      "getVendorScan",
+    ],
+  });
+}