@greensecurity/javascript-sdk 0.15.1 → 0.17.0

package/src/react-query/vendorsListVendorInvoices.ts

@@ -0,0 +1,364 @@
+/*
+ * 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 { vendorsListVendorInvoices } from "../funcs/vendorsListVendorInvoices.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 VendorsListVendorInvoicesQueryData =
+  operations.ListVendorInvoicesResponse;
+
+export type VendorsListVendorInvoicesInfiniteQueryData = PageIterator<
+  operations.ListVendorInvoicesResponse,
+  { page: number }
+>;
+
+export type VendorsListVendorInvoicesPageParams = PageIterator<
+  operations.ListVendorInvoicesResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List vendor invoices
+ *
+ * @remarks
+ * List invoices for Vendors
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ */
+export function useVendorsListVendorInvoices(
+  request: operations.ListVendorInvoicesRequest,
+  options?: QueryHookOptions<VendorsListVendorInvoicesQueryData>,
+): UseQueryResult<VendorsListVendorInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor invoices
+ *
+ * @remarks
+ * List invoices for Vendors
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ */
+export function useVendorsListVendorInvoicesSuspense(
+  request: operations.ListVendorInvoicesRequest,
+  options?: SuspenseQueryHookOptions<VendorsListVendorInvoicesQueryData>,
+): UseSuspenseQueryResult<VendorsListVendorInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendor invoices
+ *
+ * @remarks
+ * List invoices for Vendors
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ */
+export function useVendorsListVendorInvoicesInfinite(
+  request: operations.ListVendorInvoicesRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorsListVendorInvoicesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorInvoicesInfiniteQueryData,
+    VendorsListVendorInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsListVendorInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorInvoicesInfiniteQueryData,
+      VendorsListVendorInvoicesPageParams
+    >,
+    QueryKey,
+    VendorsListVendorInvoicesPageParams
+  >({
+    ...buildVendorsListVendorInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendor invoices
+ *
+ * @remarks
+ * List invoices for Vendors
+ *
+ * Available `expand` scopes are:
+ *
+ * invoice.line_items
+ */
+export function useVendorsListVendorInvoicesInfiniteSuspense(
+  request: operations.ListVendorInvoicesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsListVendorInvoicesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorInvoicesInfiniteQueryData,
+    VendorsListVendorInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsListVendorInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorInvoicesInfiniteQueryData,
+      VendorsListVendorInvoicesPageParams
+    >,
+    QueryKey,
+    VendorsListVendorInvoicesPageParams
+  >({
+    ...buildVendorsListVendorInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchVendorsListVendorInvoices(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorInvoicesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorInvoicesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setVendorsListVendorInvoicesData(
+  client: QueryClient,
+  queryKeyBase: [
+    vendorIdOrMe: string,
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+    },
+  ],
+  data: VendorsListVendorInvoicesQueryData,
+): VendorsListVendorInvoicesQueryData | undefined {
+  const key = queryKeyVendorsListVendorInvoices(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorInvoicesQueryData>(key, data);
+}
+
+export function invalidateVendorsListVendorInvoices(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      vendorIdOrMe: string,
+      parameters: {
+        sort?: string | null | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        expand?: Array<components.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorInvoices",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendorInvoices(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendorInvoices",
+    ],
+  });
+}
+
+export function buildVendorsListVendorInvoicesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorInvoicesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorInvoicesQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorInvoices(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function vendorsListVendorInvoicesQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorInvoicesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(vendorsListVendorInvoices(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorsListVendorInvoicesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorInvoicesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorsListVendorInvoicesPageParams
+    >,
+  ) => Promise<VendorsListVendorInvoicesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorInvoices(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function vendorsListVendorInvoicesQuery(
+      ctx,
+    ): Promise<VendorsListVendorInvoicesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(vendorsListVendorInvoices(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(vendorsListVendorInvoices(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsListVendorInvoices(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendorInvoices",
+    vendorIdOrMe,
+    parameters,
+  ];
+}

package/src/react-query/vendorsListVendorJobTitles.ts

@@ -3,12 +3,17 @@
  */
 
 import {
+  InfiniteData,
   InvalidateQueryFilters,
   QueryClient,
   QueryFunctionContext,
   QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
   useQuery,
   UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
   useSuspenseQuery,
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
@@ -19,15 +24,28 @@ 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 VendorsListVendorJobTitlesQueryData =
-  operations.ListVendorJobTitlesResponseBody;
+  operations.ListVendorJobTitlesResponse;
+
+export type VendorsListVendorJobTitlesInfiniteQueryData = PageIterator<
+  operations.ListVendorJobTitlesResponse,
+  { page: number }
+>;
+
+export type VendorsListVendorJobTitlesPageParams = PageIterator<
+  operations.ListVendorJobTitlesResponse,
+  { page: number }
+>["~next"];
 
 /**
  * List vendor job titles
@@ -71,6 +89,86 @@ export function useVendorsListVendorJobTitlesSuspense(
   });
 }
 
+/**
+ * List vendor job titles
+ *
+ * @remarks
+ * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ */
+export function useVendorsListVendorJobTitlesInfinite(
+  request: operations.ListVendorJobTitlesRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorsListVendorJobTitlesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorJobTitlesInfiniteQueryData,
+    VendorsListVendorJobTitlesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsListVendorJobTitlesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorJobTitlesInfiniteQueryData,
+      VendorsListVendorJobTitlesPageParams
+    >,
+    QueryKey,
+    VendorsListVendorJobTitlesPageParams
+  >({
+    ...buildVendorsListVendorJobTitlesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendor job titles
+ *
+ * @remarks
+ * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ */
+export function useVendorsListVendorJobTitlesInfiniteSuspense(
+  request: operations.ListVendorJobTitlesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsListVendorJobTitlesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorJobTitlesInfiniteQueryData,
+    VendorsListVendorJobTitlesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsListVendorJobTitlesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      VendorsListVendorJobTitlesInfiniteQueryData,
+      VendorsListVendorJobTitlesPageParams
+    >,
+    QueryKey,
+    VendorsListVendorJobTitlesPageParams
+  >({
+    ...buildVendorsListVendorJobTitlesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
 export function prefetchVendorsListVendorJobTitles(
   queryClient: QueryClient,
   client$: GreenSecurityCore,
@@ -176,6 +274,56 @@ export function buildVendorsListVendorJobTitlesQuery(
   };
 }
 
+export function buildVendorsListVendorJobTitlesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorJobTitlesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorsListVendorJobTitlesPageParams
+    >,
+  ) => Promise<VendorsListVendorJobTitlesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorJobTitles({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      jobLike: request.jobLike,
+    }),
+    queryFn: async function vendorsListVendorJobTitlesQuery(
+      ctx,
+    ): Promise<VendorsListVendorJobTitlesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(vendorsListVendorJobTitles(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(vendorsListVendorJobTitles(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
 export function queryKeyVendorsListVendorJobTitles(
   parameters: {
     sort?: string | null | undefined;

package/src/sdk/organizations.ts

@@ -8,6 +8,7 @@ import { ClientSDK, 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";
 
 export class Organizations extends ClientSDK {
   /**
@@ -32,8 +33,10 @@ export class Organizations extends ClientSDK {
   async listOrSearchFacilities(
     request: operations.ListOrSearchFacilitiesRequest,
     options?: RequestOptions,
-  ): Promise<operations.ListOrSearchFacilitiesResponseBody> {
-    return unwrapAsync(organizationsListOrSearchFacilities(
+  ): Promise<
+    PageIterator<operations.ListOrSearchFacilitiesResponse, { page: number }>
+  > {
+    return unwrapResultIterator(organizationsListOrSearchFacilities(
       this,
       request,
       options,

package/src/sdk/sdk.ts

@@ -4,7 +4,8 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Organizations } from "./organizations.js";
-import { User } from "./user.js";
+import { SupportArticles } from "./supportarticles.js";
+import { Users } from "./users.js";
 import { Vendors } from "./vendors.js";
 
 export class GreenSecurity extends ClientSDK {
@@ -13,13 +14,18 @@ export class GreenSecurity extends ClientSDK {
     return (this._vendors ??= new Vendors(this._options));
   }
 
-  private _user?: User;
-  get user(): User {
-    return (this._user ??= new User(this._options));
+  private _users?: Users;
+  get users(): Users {
+    return (this._users ??= new Users(this._options));
   }
 
   private _organizations?: Organizations;
   get organizations(): Organizations {
     return (this._organizations ??= new Organizations(this._options));
   }
+
+  private _supportArticles?: SupportArticles;
+  get supportArticles(): SupportArticles {
+    return (this._supportArticles ??= new SupportArticles(this._options));
+  }
 }

package/src/sdk/supportarticles.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { supportArticlesGetSupportArticle } from "../funcs/supportArticlesGetSupportArticle.js";
+import { supportArticlesListOrSearchSupportArticles } from "../funcs/supportArticlesListOrSearchSupportArticles.js";
+import { ClientSDK, 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";
+
+export class SupportArticles extends ClientSDK {
+  /**
+   * List or search support articles
+   *
+   * @remarks
+   * List or search support articles for FAQ.
+   */
+  async listOrSearchSupportArticles(
+    request: operations.ListOrSearchSupportArticlesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListOrSearchSupportArticlesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(supportArticlesListOrSearchSupportArticles(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get support article
+   *
+   * @remarks
+   * Retrieve an individual support article.
+   *
+   * Available `expand` scopes are:
+   *
+   * - support_article.description
+   * - support_article.published
+   * - support_article.notes
+   * - support_article.support_category
+   */
+  async getSupportArticle(
+    request: operations.GetSupportArticleRequest,
+    options?: RequestOptions,
+  ): Promise<components.SupportArticle> {
+    return unwrapAsync(supportArticlesGetSupportArticle(
+      this,
+      request,
+      options,
+    ));
+  }
+}