@greensecurity/javascript-sdk 0.35.1 → 0.35.3

package/src/models/operations/senddownloadcode.ts

@@ -0,0 +1,169 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Via = {
+  Text: "text",
+  Email: "email",
+} as const;
+export type Via = ClosedEnum<typeof Via>;
+
+export type SendDownloadCodeRequestBody = {
+  via: Via;
+};
+
+export type SendDownloadCodeRequest = {
+  /**
+   * ID of the vendor credential rep.
+   */
+  vendorCredentialId: number;
+  requestBody: SendDownloadCodeRequestBody;
+};
+
+/** @internal */
+export const Via$inboundSchema: z.ZodNativeEnum<typeof Via> = z.nativeEnum(Via);
+
+/** @internal */
+export const Via$outboundSchema: z.ZodNativeEnum<typeof Via> =
+  Via$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Via$ {
+  /** @deprecated use `Via$inboundSchema` instead. */
+  export const inboundSchema = Via$inboundSchema;
+  /** @deprecated use `Via$outboundSchema` instead. */
+  export const outboundSchema = Via$outboundSchema;
+}
+
+/** @internal */
+export const SendDownloadCodeRequestBody$inboundSchema: z.ZodType<
+  SendDownloadCodeRequestBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  via: Via$inboundSchema,
+});
+
+/** @internal */
+export type SendDownloadCodeRequestBody$Outbound = {
+  via: string;
+};
+
+/** @internal */
+export const SendDownloadCodeRequestBody$outboundSchema: z.ZodType<
+  SendDownloadCodeRequestBody$Outbound,
+  z.ZodTypeDef,
+  SendDownloadCodeRequestBody
+> = z.object({
+  via: Via$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SendDownloadCodeRequestBody$ {
+  /** @deprecated use `SendDownloadCodeRequestBody$inboundSchema` instead. */
+  export const inboundSchema = SendDownloadCodeRequestBody$inboundSchema;
+  /** @deprecated use `SendDownloadCodeRequestBody$outboundSchema` instead. */
+  export const outboundSchema = SendDownloadCodeRequestBody$outboundSchema;
+  /** @deprecated use `SendDownloadCodeRequestBody$Outbound` instead. */
+  export type Outbound = SendDownloadCodeRequestBody$Outbound;
+}
+
+export function sendDownloadCodeRequestBodyToJSON(
+  sendDownloadCodeRequestBody: SendDownloadCodeRequestBody,
+): string {
+  return JSON.stringify(
+    SendDownloadCodeRequestBody$outboundSchema.parse(
+      sendDownloadCodeRequestBody,
+    ),
+  );
+}
+
+export function sendDownloadCodeRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SendDownloadCodeRequestBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendDownloadCodeRequestBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendDownloadCodeRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SendDownloadCodeRequest$inboundSchema: z.ZodType<
+  SendDownloadCodeRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  vendor_credential_id: z.number().int(),
+  RequestBody: z.lazy(() => SendDownloadCodeRequestBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_credential_id": "vendorCredentialId",
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type SendDownloadCodeRequest$Outbound = {
+  vendor_credential_id: number;
+  RequestBody: SendDownloadCodeRequestBody$Outbound;
+};
+
+/** @internal */
+export const SendDownloadCodeRequest$outboundSchema: z.ZodType<
+  SendDownloadCodeRequest$Outbound,
+  z.ZodTypeDef,
+  SendDownloadCodeRequest
+> = z.object({
+  vendorCredentialId: z.number().int(),
+  requestBody: z.lazy(() => SendDownloadCodeRequestBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    vendorCredentialId: "vendor_credential_id",
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SendDownloadCodeRequest$ {
+  /** @deprecated use `SendDownloadCodeRequest$inboundSchema` instead. */
+  export const inboundSchema = SendDownloadCodeRequest$inboundSchema;
+  /** @deprecated use `SendDownloadCodeRequest$outboundSchema` instead. */
+  export const outboundSchema = SendDownloadCodeRequest$outboundSchema;
+  /** @deprecated use `SendDownloadCodeRequest$Outbound` instead. */
+  export type Outbound = SendDownloadCodeRequest$Outbound;
+}
+
+export function sendDownloadCodeRequestToJSON(
+  sendDownloadCodeRequest: SendDownloadCodeRequest,
+): string {
+  return JSON.stringify(
+    SendDownloadCodeRequest$outboundSchema.parse(sendDownloadCodeRequest),
+  );
+}
+
+export function sendDownloadCodeRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendDownloadCodeRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendDownloadCodeRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendDownloadCodeRequest' from JSON`,
+  );
+}

package/src/react-query/_types.ts

@@ -6,15 +6,88 @@ import { RequestOptions } from "../lib/sdks.js";
 import { PageIterator } from "../types/operations.js";
 
 import type {
+  DefaultError,
   InfiniteData,
+  InfiniteQueryPageParamsOptions,
+  OmitKeyof,
   QueryKey,
-  UseInfiniteQueryOptions,
+  QueryObserverOptions,
+  SkipToken,
   UseMutationOptions,
   UseQueryOptions,
-  UseSuspenseInfiniteQueryOptions,
   UseSuspenseQueryOptions,
 } from "@tanstack/react-query";
 
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface UseInfiniteQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  OmitKeyof<
+    InfiniteQueryObserverOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey,
+      TPageParam
+    >,
+    "suspense"
+  >
+{
+  /**
+   * Set this to `false` to unsubscribe this observer from updates to the query cache.
+   * Defaults to `true`.
+   */
+  subscribed?: boolean;
+}
+
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface InfiniteQueryObserverOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  QueryObserverOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    InfiniteData<TQueryFnData, TPageParam>,
+    TQueryKey,
+    TPageParam
+  >,
+  InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam>
+{
+}
+
+// Reaction to breaking change in 5.80.0 https://github.com/TanStack/query/pull/9224#issuecomment-2934835936
+interface UseSuspenseInfiniteQueryOptions<
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+  TQueryKey extends QueryKey = QueryKey,
+  TPageParam = unknown,
+> extends
+  OmitKeyof<
+    UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
+    "queryFn" | "enabled" | "throwOnError" | "placeholderData"
+  >
+{
+  queryFn?: Exclude<
+    UseInfiniteQueryOptions<
+      TQueryFnData,
+      TError,
+      TData,
+      TQueryKey,
+      TPageParam
+    >["queryFn"],
+    SkipToken
+  >;
+}
 export type TupleToPrefixes<T extends any[]> = T extends [...infer Prefix, any]
   ? TupleToPrefixes<Prefix> | T
   : never;
@@ -41,7 +114,6 @@ export type InfiniteQueryHookOptions<
       Data,
       Error,
       InfiniteData<Data, Data["~next"]>,
-      Data,
       QueryKey,
       Data["~next"]
     >,
@@ -64,7 +136,6 @@ export type SuspenseInfiniteQueryHookOptions<
       Data,
       Error,
       InfiniteData<Data, Data["~next"]>,
-      Data,
       QueryKey,
       Data["~next"]
     >,

package/src/react-query/index.ts

@@ -23,6 +23,7 @@ export * from "./usersPostAuthenticate.js";
 export * from "./vendorsAddVendorCredentialFile.js";
 export * from "./vendorsAddVendorManagedByCompany.js";
 export * from "./vendorScansVendorScanOut.js";
+export * from "./vendorsCheckDownloadCode.js";
 export * from "./vendorsCreateNewVendorCredentialVersion.js";
 export * from "./vendorsCreateOrUpdateBcr.js";
 export * from "./vendorsCreateVendorCompany.js";
@@ -50,6 +51,7 @@ export * from "./vendorsListVendorScrubDetails.js";
 export * from "./vendorsListVendorScrubPackages.js";
 export * from "./vendorsListVendorScrubPurchases.js";
 export * from "./vendorsPurchaseScrubCredits.js";
+export * from "./vendorsSendDownloadCode.js";
 export * from "./vendorsSubmitVendorCredential.js";
 export * from "./vendorsUpdateVendorCredentialFile.js";
 export * from "./vendorsUpdateVendorDetails.js";

package/src/react-query/vendorsCheckDownloadCode.ts

@@ -0,0 +1,170 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsCheckDownloadCode } from "../funcs/vendorsCheckDownloadCode.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsCheckDownloadCodeQueryData =
+  operations.CheckDownloadCodeResponseBody;
+
+/**
+ * Check download code for vendor credential
+ *
+ * @remarks
+ * It will check download code for vendor credential
+ */
+export function useVendorsCheckDownloadCode(
+  request: operations.CheckDownloadCodeRequest,
+  options?: QueryHookOptions<VendorsCheckDownloadCodeQueryData>,
+): UseQueryResult<VendorsCheckDownloadCodeQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsCheckDownloadCodeQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Check download code for vendor credential
+ *
+ * @remarks
+ * It will check download code for vendor credential
+ */
+export function useVendorsCheckDownloadCodeSuspense(
+  request: operations.CheckDownloadCodeRequest,
+  options?: SuspenseQueryHookOptions<VendorsCheckDownloadCodeQueryData>,
+): UseSuspenseQueryResult<VendorsCheckDownloadCodeQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsCheckDownloadCodeQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchVendorsCheckDownloadCode(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.CheckDownloadCodeRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsCheckDownloadCodeQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsCheckDownloadCodeData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorCredentialId: number,
+    parameters: { code?: string | undefined },
+  ],
+  data: VendorsCheckDownloadCodeQueryData,
+): VendorsCheckDownloadCodeQueryData | undefined {
+  const key = queryKeyVendorsCheckDownloadCode(...queryKeyBase);
+
+  return client.setQueryData<VendorsCheckDownloadCodeQueryData>(key, data);
+}
+
+export function invalidateVendorsCheckDownloadCode(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [vendorCredentialId: number, parameters: { code?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "checkDownloadCode",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsCheckDownloadCode(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "vendors", "checkDownloadCode"],
+  });
+}
+
+export function buildVendorsCheckDownloadCodeQuery(
+  client$: GreenSecurityCore,
+  request: operations.CheckDownloadCodeRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsCheckDownloadCodeQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsCheckDownloadCode(request.vendorCredentialId, {
+      code: request.code,
+    }),
+    queryFn: async function vendorsCheckDownloadCodeQueryFn(
+      ctx,
+    ): Promise<VendorsCheckDownloadCodeQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsCheckDownloadCode(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsCheckDownloadCode(
+  vendorCredentialId: number,
+  parameters: { code?: string | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "checkDownloadCode",
+    vendorCredentialId,
+    parameters,
+  ];
+}

package/src/react-query/vendorsSendDownloadCode.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsSendDownloadCode } from "../funcs/vendorsSendDownloadCode.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 VendorsSendDownloadCodeMutationVariables = {
+  request: operations.SendDownloadCodeRequest;
+  options?: RequestOptions;
+};
+
+export type VendorsSendDownloadCodeMutationData = boolean;
+
+/**
+ * Send download code for vendor credential
+ *
+ * @remarks
+ * It will send download code for vendor credential
+ */
+export function useVendorsSendDownloadCodeMutation(
+  options?: MutationHookOptions<
+    VendorsSendDownloadCodeMutationData,
+    Error,
+    VendorsSendDownloadCodeMutationVariables
+  >,
+): UseMutationResult<
+  VendorsSendDownloadCodeMutationData,
+  Error,
+  VendorsSendDownloadCodeMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildVendorsSendDownloadCodeMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyVendorsSendDownloadCode(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "vendors", "sendDownloadCode"];
+}
+
+export function buildVendorsSendDownloadCodeMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: VendorsSendDownloadCodeMutationVariables,
+  ) => Promise<VendorsSendDownloadCodeMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyVendorsSendDownloadCode(),
+    mutationFn: function vendorsSendDownloadCodeMutationFn({
+      request,
+      options,
+    }): Promise<VendorsSendDownloadCodeMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(vendorsSendDownloadCode(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/sdk/vendors.ts

@@ -4,6 +4,7 @@
 
 import { vendorsAddVendorCredentialFile } from "../funcs/vendorsAddVendorCredentialFile.js";
 import { vendorsAddVendorManagedByCompany } from "../funcs/vendorsAddVendorManagedByCompany.js";
+import { vendorsCheckDownloadCode } from "../funcs/vendorsCheckDownloadCode.js";
 import { vendorsCreateNewVendorCredentialVersion } from "../funcs/vendorsCreateNewVendorCredentialVersion.js";
 import { vendorsCreateOrUpdateBcr } from "../funcs/vendorsCreateOrUpdateBcr.js";
 import { vendorsCreateVendorCompany } from "../funcs/vendorsCreateVendorCompany.js";
@@ -31,6 +32,7 @@ import { vendorsListVendorScrubDetails } from "../funcs/vendorsListVendorScrubDe
 import { vendorsListVendorScrubPackages } from "../funcs/vendorsListVendorScrubPackages.js";
 import { vendorsListVendorScrubPurchases } from "../funcs/vendorsListVendorScrubPurchases.js";
 import { vendorsPurchaseScrubCredits } from "../funcs/vendorsPurchaseScrubCredits.js";
+import { vendorsSendDownloadCode } from "../funcs/vendorsSendDownloadCode.js";
 import { vendorsSubmitVendorCredential } from "../funcs/vendorsSubmitVendorCredential.js";
 import { vendorsUpdateVendorCredentialFile } from "../funcs/vendorsUpdateVendorCredentialFile.js";
 import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.js";
@@ -222,6 +224,40 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Check download code for vendor credential
+   *
+   * @remarks
+   * It will check download code for vendor credential
+   */
+  async checkDownloadCode(
+    request: operations.CheckDownloadCodeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.CheckDownloadCodeResponseBody> {
+    return unwrapAsync(vendorsCheckDownloadCode(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Send download code for vendor credential
+   *
+   * @remarks
+   * It will send download code for vendor credential
+   */
+  async sendDownloadCode(
+    request: operations.SendDownloadCodeRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(vendorsSendDownloadCode(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List Vendor Credential files
    *