@greensecurity/javascript-sdk 0.43.1-beta.42 → 0.43.1-beta.44

package/src/react-query/invoicesListInvoices.ts

@@ -0,0 +1,284 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildInvoicesListInvoicesInfiniteQuery,
+  buildInvoicesListInvoicesQuery,
+  InvoicesListInvoicesInfiniteQueryData,
+  InvoicesListInvoicesPageParams,
+  InvoicesListInvoicesQueryData,
+  prefetchInvoicesListInvoices,
+  prefetchInvoicesListInvoicesInfinite,
+  queryKeyInvoicesListInvoices,
+  queryKeyInvoicesListInvoicesInfinite,
+} from "./invoicesListInvoices.core.js";
+export {
+  buildInvoicesListInvoicesInfiniteQuery,
+  buildInvoicesListInvoicesQuery,
+  type InvoicesListInvoicesInfiniteQueryData,
+  type InvoicesListInvoicesPageParams,
+  type InvoicesListInvoicesQueryData,
+  prefetchInvoicesListInvoices,
+  prefetchInvoicesListInvoicesInfinite,
+  queryKeyInvoicesListInvoices,
+  queryKeyInvoicesListInvoicesInfinite,
+};
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ */
+export function useInvoicesListInvoices(
+  request: operations.ListInvoicesRequest,
+  options?: QueryHookOptions<InvoicesListInvoicesQueryData>,
+): UseQueryResult<InvoicesListInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildInvoicesListInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ */
+export function useInvoicesListInvoicesSuspense(
+  request: operations.ListInvoicesRequest,
+  options?: SuspenseQueryHookOptions<InvoicesListInvoicesQueryData>,
+): UseSuspenseQueryResult<InvoicesListInvoicesQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildInvoicesListInvoicesQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ */
+export function useInvoicesListInvoicesInfinite(
+  request: operations.ListInvoicesRequest,
+  options?: InfiniteQueryHookOptions<InvoicesListInvoicesInfiniteQueryData>,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    InvoicesListInvoicesInfiniteQueryData,
+    InvoicesListInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    InvoicesListInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      InvoicesListInvoicesInfiniteQueryData,
+      InvoicesListInvoicesPageParams
+    >,
+    QueryKey,
+    InvoicesListInvoicesPageParams
+  >({
+    ...buildInvoicesListInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ */
+export function useInvoicesListInvoicesInfiniteSuspense(
+  request: operations.ListInvoicesRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    InvoicesListInvoicesInfiniteQueryData
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    InvoicesListInvoicesInfiniteQueryData,
+    InvoicesListInvoicesPageParams
+  >,
+  Error
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    InvoicesListInvoicesInfiniteQueryData,
+    Error,
+    InfiniteData<
+      InvoicesListInvoicesInfiniteQueryData,
+      InvoicesListInvoicesPageParams
+    >,
+    QueryKey,
+    InvoicesListInvoicesPageParams
+  >({
+    ...buildInvoicesListInvoicesInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setInvoicesListInvoicesData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      invoiceNumber?: string | undefined;
+      invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
+      representative?: string | undefined;
+      vendorId?: number | undefined;
+      companyId?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+    },
+  ],
+  data: InvoicesListInvoicesQueryData,
+): InvoicesListInvoicesQueryData | undefined {
+  const key = queryKeyInvoicesListInvoices(...queryKeyBase);
+
+  return client.setQueryData<InvoicesListInvoicesQueryData>(key, data);
+}
+
+export function invalidateInvoicesListInvoices(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      sort?: string | null | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+      invoiceNumber?: string | undefined;
+      invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
+      representative?: string | undefined;
+      vendorId?: number | undefined;
+      companyId?: number | undefined;
+      facilityId?: number | undefined;
+      systemId?: number | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "invoices",
+      "listInvoices",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllInvoicesListInvoices(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "invoices", "listInvoices"],
+  });
+}

package/src/react-query/vendorsListVendorInvoices.core.ts

@@ -168,7 +168,7 @@ export function queryKeyVendorsListVendorInvoices(
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
     invoiceNumber?: string | undefined;
-    invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
+    invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
   },
 ): QueryKey {
   return [
@@ -189,7 +189,7 @@ export function queryKeyVendorsListVendorInvoicesInfinite(
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
     invoiceNumber?: string | undefined;
-    invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
+    invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/vendorsListVendorInvoices.ts

@@ -198,7 +198,7 @@ export function setVendorsListVendorInvoicesData(
       itemsPerPage?: number | undefined;
       expand?: Array<components.Expand> | undefined;
       invoiceNumber?: string | undefined;
-      invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
+      invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
     },
   ],
   data: VendorsListVendorInvoicesQueryData,
@@ -220,7 +220,7 @@ export function invalidateVendorsListVendorInvoices(
         itemsPerPage?: number | undefined;
         expand?: Array<components.Expand> | undefined;
         invoiceNumber?: string | undefined;
-        invoiceFinancialStatus?: operations.InvoiceFinancialStatus | undefined;
+        invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
       },
     ]
   >,

package/src/sdk/invoices.ts

@@ -3,13 +3,44 @@
  */
 
 import { invoicesCreateInvoice } from "../funcs/invoicesCreateInvoice.js";
+import { invoicesListInvoices } from "../funcs/invoicesListInvoices.js";
 import { invoicesMakePayment } from "../funcs/invoicesMakePayment.js";
 import { invoicesUpdateInvoice } from "../funcs/invoicesUpdateInvoice.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Invoices extends ClientSDK {
+  /**
+   * List invoices
+   *
+   * @remarks
+   * List invoices. The result set is automatically scoped based on the authenticated user's role.
+   * API users may filter results by **only one** of the following query parameters:
+   *   - vendor_id
+   *   - company_id
+   *   - facility_id
+   *   - system_id
+   * Supplying more than one will return `400 Bad Request`.
+   * If none are provided, the request falls back to all authorized resources.
+   *
+   * Available `expand` scopes are:
+   * - invoice.line_items
+   * - invoice.invoice_transactions
+   * - invoice.representative
+   */
+  async listInvoices(
+    request: operations.ListInvoicesRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.ListInvoicesResponse, { page: number }>> {
+    return unwrapResultIterator(invoicesListInvoices(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create invoice
    *