@greensecurity/javascript-sdk 0.21.3 → 0.21.4

package/src/models/operations/listvendorcredits.ts

@@ -0,0 +1,245 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListVendorCreditsRequest = {
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   */
+  vendorIdOrMe: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListVendorCreditsResponseBody = {
+  items: Array<components.Credit>;
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+};
+
+export type ListVendorCreditsResponse = {
+  result: ListVendorCreditsResponseBody;
+};
+
+/** @internal */
+export const ListVendorCreditsRequest$inboundSchema: z.ZodType<
+  ListVendorCreditsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$inboundSchema.optional(),
+  page: z.number().int().optional(),
+  items_per_page: z.number().int().optional(),
+  vendor_id_or_me: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "items_per_page": "itemsPerPage",
+    "vendor_id_or_me": "vendorIdOrMe",
+  });
+});
+
+/** @internal */
+export type ListVendorCreditsRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  vendor_id_or_me: string;
+};
+
+/** @internal */
+export const ListVendorCreditsRequest$outboundSchema: z.ZodType<
+  ListVendorCreditsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVendorCreditsRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  vendorIdOrMe: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    vendorIdOrMe: "vendor_id_or_me",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListVendorCreditsRequest$ {
+  /** @deprecated use `ListVendorCreditsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListVendorCreditsRequest$inboundSchema;
+  /** @deprecated use `ListVendorCreditsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListVendorCreditsRequest$outboundSchema;
+  /** @deprecated use `ListVendorCreditsRequest$Outbound` instead. */
+  export type Outbound = ListVendorCreditsRequest$Outbound;
+}
+
+export function listVendorCreditsRequestToJSON(
+  listVendorCreditsRequest: ListVendorCreditsRequest,
+): string {
+  return JSON.stringify(
+    ListVendorCreditsRequest$outboundSchema.parse(listVendorCreditsRequest),
+  );
+}
+
+export function listVendorCreditsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorCreditsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorCreditsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorCreditsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListVendorCreditsResponseBody$inboundSchema: z.ZodType<
+  ListVendorCreditsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(components.Credit$inboundSchema),
+  pager: components.Pager$inboundSchema,
+});
+
+/** @internal */
+export type ListVendorCreditsResponseBody$Outbound = {
+  items: Array<components.Credit$Outbound>;
+  pager: components.Pager$Outbound;
+};
+
+/** @internal */
+export const ListVendorCreditsResponseBody$outboundSchema: z.ZodType<
+  ListVendorCreditsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListVendorCreditsResponseBody
+> = z.object({
+  items: z.array(components.Credit$outboundSchema),
+  pager: components.Pager$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListVendorCreditsResponseBody$ {
+  /** @deprecated use `ListVendorCreditsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListVendorCreditsResponseBody$inboundSchema;
+  /** @deprecated use `ListVendorCreditsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListVendorCreditsResponseBody$outboundSchema;
+  /** @deprecated use `ListVendorCreditsResponseBody$Outbound` instead. */
+  export type Outbound = ListVendorCreditsResponseBody$Outbound;
+}
+
+export function listVendorCreditsResponseBodyToJSON(
+  listVendorCreditsResponseBody: ListVendorCreditsResponseBody,
+): string {
+  return JSON.stringify(
+    ListVendorCreditsResponseBody$outboundSchema.parse(
+      listVendorCreditsResponseBody,
+    ),
+  );
+}
+
+export function listVendorCreditsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorCreditsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorCreditsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorCreditsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListVendorCreditsResponse$inboundSchema: z.ZodType<
+  ListVendorCreditsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListVendorCreditsResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type ListVendorCreditsResponse$Outbound = {
+  Result: ListVendorCreditsResponseBody$Outbound;
+};
+
+/** @internal */
+export const ListVendorCreditsResponse$outboundSchema: z.ZodType<
+  ListVendorCreditsResponse$Outbound,
+  z.ZodTypeDef,
+  ListVendorCreditsResponse
+> = z.object({
+  result: z.lazy(() => ListVendorCreditsResponseBody$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListVendorCreditsResponse$ {
+  /** @deprecated use `ListVendorCreditsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListVendorCreditsResponse$inboundSchema;
+  /** @deprecated use `ListVendorCreditsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListVendorCreditsResponse$outboundSchema;
+  /** @deprecated use `ListVendorCreditsResponse$Outbound` instead. */
+  export type Outbound = ListVendorCreditsResponse$Outbound;
+}
+
+export function listVendorCreditsResponseToJSON(
+  listVendorCreditsResponse: ListVendorCreditsResponse,
+): string {
+  return JSON.stringify(
+    ListVendorCreditsResponse$outboundSchema.parse(listVendorCreditsResponse),
+  );
+}
+
+export function listVendorCreditsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorCreditsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorCreditsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorCreditsResponse' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -21,6 +21,7 @@ export * from "./vendorsExpediteTimeRemaining.js";
 export * from "./vendorsGetVendorInvoiceDetails.js";
 export * from "./vendorsGetVendorsDetails.js";
 export * from "./vendorsListVendorCredentials.js";
+export * from "./vendorsListVendorCredits.js";
 export * from "./vendorsListVendorFacilityStatuses.js";
 export * from "./vendorsListVendorInvoices.js";
 export * from "./vendorsListVendorJobTitles.js";

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,
+    ));
+  }
 }