@greensecurity/javascript-sdk 0.30.23 → 0.30.27

package/src/react-query/companiesListOrSearchCompanies.ts

@@ -0,0 +1,345 @@
+/*
+ * 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 { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.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 CompaniesListOrSearchCompaniesQueryData =
+  operations.ListOrSearchCompaniesResponse;
+
+export type CompaniesListOrSearchCompaniesInfiniteQueryData = PageIterator<
+  operations.ListOrSearchCompaniesResponse,
+  { page: number }
+>;
+
+export type CompaniesListOrSearchCompaniesPageParams = PageIterator<
+  operations.ListOrSearchCompaniesResponse,
+  { page: number }
+>["~next"];
+
+/**
+ * List or search companies
+ *
+ * @remarks
+ * List or search companies.
+ */
+export function useCompaniesListOrSearchCompanies(
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: QueryHookOptions<CompaniesListOrSearchCompaniesQueryData>,
+): UseQueryResult<CompaniesListOrSearchCompaniesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesListOrSearchCompaniesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search companies
+ *
+ * @remarks
+ * List or search companies.
+ */
+export function useCompaniesListOrSearchCompaniesSuspense(
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: SuspenseQueryHookOptions<CompaniesListOrSearchCompaniesQueryData>,
+): UseSuspenseQueryResult<CompaniesListOrSearchCompaniesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesListOrSearchCompaniesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List or search companies
+ *
+ * @remarks
+ * List or search companies.
+ */
+export function useCompaniesListOrSearchCompaniesInfinite(
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: InfiniteQueryHookOptions<
+    CompaniesListOrSearchCompaniesInfiniteQueryData
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListOrSearchCompaniesInfiniteQueryData,
+    CompaniesListOrSearchCompaniesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    CompaniesListOrSearchCompaniesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      CompaniesListOrSearchCompaniesInfiniteQueryData,
+      CompaniesListOrSearchCompaniesPageParams
+    >,
+    QueryKey,
+    CompaniesListOrSearchCompaniesPageParams
+  >({
+    ...buildCompaniesListOrSearchCompaniesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List or search companies
+ *
+ * @remarks
+ * List or search companies.
+ */
+export function useCompaniesListOrSearchCompaniesInfiniteSuspense(
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    CompaniesListOrSearchCompaniesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListOrSearchCompaniesInfiniteQueryData,
+    CompaniesListOrSearchCompaniesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    CompaniesListOrSearchCompaniesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      CompaniesListOrSearchCompaniesInfiniteQueryData,
+      CompaniesListOrSearchCompaniesPageParams
+    >,
+    QueryKey,
+    CompaniesListOrSearchCompaniesPageParams
+  >({
+    ...buildCompaniesListOrSearchCompaniesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function prefetchCompaniesListOrSearchCompanies(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchCompaniesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListOrSearchCompaniesQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setCompaniesListOrSearchCompaniesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      nameLike?: string | undefined;
+    },
+  ],
+  data: CompaniesListOrSearchCompaniesQueryData,
+): CompaniesListOrSearchCompaniesQueryData | undefined {
+  const key = queryKeyCompaniesListOrSearchCompanies(...queryKeyBase);
+
+  return client.setQueryData<CompaniesListOrSearchCompaniesQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateCompaniesListOrSearchCompanies(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      nameLike?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listOrSearchCompanies",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesListOrSearchCompanies(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listOrSearchCompanies",
+    ],
+  });
+}
+
+export function buildCompaniesListOrSearchCompaniesQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListOrSearchCompaniesQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListOrSearchCompanies({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      nameLike: request.nameLike,
+    }),
+    queryFn: async function companiesListOrSearchCompaniesQueryFn(
+      ctx,
+    ): Promise<CompaniesListOrSearchCompaniesQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(companiesListOrSearchCompanies(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesListOrSearchCompaniesInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListOrSearchCompaniesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      CompaniesListOrSearchCompaniesPageParams
+    >,
+  ) => Promise<CompaniesListOrSearchCompaniesInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListOrSearchCompanies({
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      nameLike: request.nameLike,
+    }),
+    queryFn: async function companiesListOrSearchCompaniesQuery(
+      ctx,
+    ): Promise<CompaniesListOrSearchCompaniesInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        return unwrapResultIterator(companiesListOrSearchCompanies(
+          client$,
+          request,
+          mergedOptions,
+        ));
+      }
+
+      return unwrapResultIterator(companiesListOrSearchCompanies(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyCompaniesListOrSearchCompanies(
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    nameLike?: string | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listOrSearchCompanies",
+    parameters,
+  ];
+}

package/src/react-query/index.ts

@@ -5,6 +5,7 @@
 export { GreenSecurityProvider, useGreenSecurityContext } from "./_context.js";
 export * from "./_types.js";
 
+export * from "./companiesListOrSearchCompanies.js";
 export * from "./organizationsGetFacility.js";
 export * from "./organizationsListOrSearchFacilities.js";
 export * from "./supportArticlesGetSupportArticle.js";

package/src/react-query/vendorsListVendorFacilityStatuses.ts

@@ -193,6 +193,7 @@ export function setVendorsListVendorFacilityStatusesData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       scanType?: components.ScanType | undefined;
+      facilityNameLike?: string | undefined;
     },
   ],
   data: VendorsListVendorFacilityStatusesQueryData,
@@ -214,6 +215,7 @@ export function invalidateVendorsListVendorFacilityStatuses(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       scanType?: components.ScanType | undefined;
+      facilityNameLike?: string | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
@@ -260,6 +262,7 @@ export function buildVendorsListVendorFacilityStatusesQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       scanType: request.scanType,
+      facilityNameLike: request.facilityNameLike,
     }),
     queryFn: async function vendorsListVendorFacilityStatusesQueryFn(
       ctx,
@@ -299,6 +302,7 @@ export function buildVendorsListVendorFacilityStatusesInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       scanType: request.scanType,
+      facilityNameLike: request.facilityNameLike,
     }),
     queryFn: async function vendorsListVendorFacilityStatusesQuery(
       ctx,
@@ -336,6 +340,7 @@ export function queryKeyVendorsListVendorFacilityStatuses(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     scanType?: components.ScanType | undefined;
+    facilityNameLike?: string | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/vendorsListVendorInvoices.ts

@@ -209,7 +209,7 @@ export function setVendorsListVendorInvoicesData(
       itemsPerPage?: number | undefined;
       expand?: Array<components.Expand> | undefined;
       invoiceNumber?: string | undefined;
-      invoiceStatus?: operations.InvoiceStatus | undefined;
+      invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
     },
   ],
   data: VendorsListVendorInvoicesQueryData,
@@ -231,7 +231,7 @@ export function invalidateVendorsListVendorInvoices(
         itemsPerPage?: number | undefined;
         expand?: Array<components.Expand> | undefined;
         invoiceNumber?: string | undefined;
-        invoiceStatus?: operations.InvoiceStatus | undefined;
+        invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
       },
     ]
   >,
@@ -280,7 +280,7 @@ export function buildVendorsListVendorInvoicesQuery(
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
       invoiceNumber: request.invoiceNumber,
-      invoiceStatus: request.invoiceStatus,
+      invoiceFinancialStatus: request.invoiceFinancialStatus,
     }),
     queryFn: async function vendorsListVendorInvoicesQueryFn(
       ctx,
@@ -321,7 +321,7 @@ export function buildVendorsListVendorInvoicesInfiniteQuery(
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
       invoiceNumber: request.invoiceNumber,
-      invoiceStatus: request.invoiceStatus,
+      invoiceFinancialStatus: request.invoiceFinancialStatus,
     }),
     queryFn: async function vendorsListVendorInvoicesQuery(
       ctx,
@@ -361,7 +361,7 @@ export function queryKeyVendorsListVendorInvoices(
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
     invoiceNumber?: string | undefined;
-    invoiceStatus?: operations.InvoiceStatus | undefined;
+    invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
   },
 ): QueryKey {
   return [

package/src/sdk/companies.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class Companies extends ClientSDK {
+  /**
+   * List or search companies
+   *
+   * @remarks
+   * List or search companies.
+   */
+  async listOrSearchCompanies(
+    request: operations.ListOrSearchCompaniesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListOrSearchCompaniesResponse, { page: number }>
+  > {
+    return unwrapResultIterator(companiesListOrSearchCompanies(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,6 +3,7 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Companies } from "./companies.js";
 import { Organizations } from "./organizations.js";
 import { SupportArticles } from "./supportarticles.js";
 import { Users } from "./users.js";
@@ -40,4 +41,9 @@ export class GreenSecurity extends ClientSDK {
   get vendorScans(): VendorScans {
     return (this._vendorScans ??= new VendorScans(this._options));
   }
+
+  private _companies?: Companies;
+  get companies(): Companies {
+    return (this._companies ??= new Companies(this._options));
+  }
 }