@greensecurity/javascript-sdk 0.21.3 → 0.21.6

package/src/react-query/vendorsListVendorCredits.ts

@@ -0,0 +1,334 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsListVendorCredits } from "../funcs/vendorsListVendorCredits.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 { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type VendorsListVendorCreditsQueryData =
+  operations.ListVendorCreditsResponse;
+
+export type VendorsListVendorCreditsInfiniteQueryData = PageIterator<
+  operations.ListVendorCreditsResponse,
+  { page: number }
+>;
+
+export type VendorsListVendorCreditsPageParams = PageIterator<
+  operations.ListVendorCreditsResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List vendor credits
+ *
+ * @remarks
+ * List the credits for the vendor
+ */
+export function useVendorsListVendorCredits(
+  request: operations.ListVendorCreditsRequest,
+  options?: QueryHookOptions<VendorsListVendorCreditsQueryData>,
+): UseQueryResult<VendorsListVendorCreditsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorCreditsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor credits
+ *
+ * @remarks
+ * List the credits for the vendor
+ */
+export function useVendorsListVendorCreditsSuspense(
+  request: operations.ListVendorCreditsRequest,
+  options?: SuspenseQueryHookOptions<VendorsListVendorCreditsQueryData>,
+): UseSuspenseQueryResult<VendorsListVendorCreditsQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorCreditsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor credits
+ *
+ * @remarks
+ * List the credits for the vendor
+ */
+export function useVendorsListVendorCreditsInfinite(
+  request: operations.ListVendorCreditsRequest,
+  options?: InfiniteQueryHookOptions<VendorsListVendorCreditsInfiniteQueryData>,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorCreditsInfiniteQueryData,
+    VendorsListVendorCreditsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsListVendorCreditsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorCreditsInfiniteQueryData,
+      VendorsListVendorCreditsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorCreditsPageParams
+  >({
+    ...buildVendorsListVendorCreditsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendor credits
+ *
+ * @remarks
+ * List the credits for the vendor
+ */
+export function useVendorsListVendorCreditsInfiniteSuspense(
+  request: operations.ListVendorCreditsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsListVendorCreditsInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorCreditsInfiniteQueryData,
+    VendorsListVendorCreditsPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsListVendorCreditsInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorCreditsInfiniteQueryData,
+      VendorsListVendorCreditsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorCreditsPageParams
+  >({
+    ...buildVendorsListVendorCreditsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchVendorsListVendorCredits(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCreditsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorCreditsQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsListVendorCreditsData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorIdOrMe: string,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+    },
+  ],
+  data: VendorsListVendorCreditsQueryData,
+): VendorsListVendorCreditsQueryData | undefined {
+  const key = queryKeyVendorsListVendorCredits(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorCreditsQueryData>(key, data);
+}
+
+export function invalidateVendorsListVendorCredits(
+  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",
+      "listVendorCredits",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendorCredits(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "vendors", "listVendorCredits"],
+  });
+}
+
+export function buildVendorsListVendorCreditsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorCreditsQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorCredits(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function vendorsListVendorCreditsQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorCreditsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsListVendorCredits(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorsListVendorCreditsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<QueryKey, VendorsListVendorCreditsPageParams>,
+  ) => Promise<VendorsListVendorCreditsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorCredits(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function vendorsListVendorCreditsQuery(
+      ctx,
+    ): Promise<VendorsListVendorCreditsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(vendorsListVendorCredits(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(vendorsListVendorCredits(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsListVendorCredits(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorCredits",
+    vendorIdOrMe,
+    parameters,
+  ];
+}

package/src/sdk/vendors.ts

@@ -7,6 +7,7 @@ import { vendorsExpediteTimeRemaining } from "../funcs/vendorsExpediteTimeRemain
 import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoiceDetails.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
 import { vendorsListVendorCredentials } from "../funcs/vendorsListVendorCredentials.js";
+import { vendorsListVendorCredits } from "../funcs/vendorsListVendorCredits.js";
 import { vendorsListVendorFacilityStatuses } from "../funcs/vendorsListVendorFacilityStatuses.js";
 import { vendorsListVendorInvoices } from "../funcs/vendorsListVendorInvoices.js";
 import { vendorsListVendorJobTitles } from "../funcs/vendorsListVendorJobTitles.js";
@@ -228,4 +229,23 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List vendor credits
+   *
+   * @remarks
+   * List the credits for the vendor
+   */
+  async listVendorCredits(
+    request: operations.ListVendorCreditsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListVendorCreditsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(vendorsListVendorCredits(
+      this,
+      request,
+      options,
+    ));
+  }
 }