@greensecurity/javascript-sdk 0.43.1-beta.9 → 0.43.1-beta.90

package/src/react-query/invoicesListInvoices.ts

@@ -0,0 +1,324 @@
+/*
+ * 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
+ * - invoice.custom_fields
+ * - invoice.invoice_type
+ * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
+ */
+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
+ * - invoice.custom_fields
+ * - invoice.invoice_type
+ * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
+ */
+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
+ * - invoice.custom_fields
+ * - invoice.invoice_type
+ * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
+ */
+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
+ * - invoice.custom_fields
+ * - invoice.invoice_type
+ * - invoice.may_pay_invoice
+ *
+ * Available `sort` values are:
+ * - id (default)
+ * - invoice_number
+ * - date (processed date)
+ * - financial_status
+ * - amount
+ */
+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?: string | 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?: string | 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/organizationsGetFacility.core.ts

@@ -42,7 +42,9 @@ export function buildOrganizationsGetFacilityQuery(
   ) => Promise<OrganizationsGetFacilityQueryData>;
 } {
   return {
-    queryKey: queryKeyOrganizationsGetFacility(request.id),
+    queryKey: queryKeyOrganizationsGetFacility(request.id, {
+      expand: request.expand,
+    }),
     queryFn: async function organizationsGetFacilityQueryFn(
       ctx,
     ): Promise<OrganizationsGetFacilityQueryData> {
@@ -66,6 +68,15 @@ export function buildOrganizationsGetFacilityQuery(
   };
 }
 
-export function queryKeyOrganizationsGetFacility(id: number): QueryKey {
-  return ["@greensecurity/javascript-sdk", "organizations", "getFacility", id];
+export function queryKeyOrganizationsGetFacility(
+  id: number,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "getFacility",
+    id,
+    parameters,
+  ];
 }

package/src/react-query/organizationsGetFacility.ts

@@ -10,6 +10,7 @@ import {
   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 {
@@ -74,7 +75,10 @@ export function useOrganizationsGetFacilitySuspense(
 
 export function setOrganizationsGetFacilityData(
   client: QueryClient,
-  queryKeyBase: [id: number],
+  queryKeyBase: [
+    id: number,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
   data: OrganizationsGetFacilityQueryData,
 ): OrganizationsGetFacilityQueryData | undefined {
   const key = queryKeyOrganizationsGetFacility(...queryKeyBase);
@@ -84,7 +88,9 @@ export function setOrganizationsGetFacilityData(
 
 export function invalidateOrganizationsGetFacility(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[id: number]>,
+  queryKeyBase: TupleToPrefixes<
+    [id: number, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

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

@@ -84,7 +84,7 @@ export function buildOrganizationsListOrSearchFacilitiesQuery(
       systemId: request.systemId,
       nameLike: request.nameLike,
       stateLike: request.stateLike,
-      activeStatus: request.activeStatus,
+      status: request.status,
       latitude: request.latitude,
       longitude: request.longitude,
     }),
@@ -134,7 +134,7 @@ export function buildOrganizationsListOrSearchFacilitiesInfiniteQuery(
       systemId: request.systemId,
       nameLike: request.nameLike,
       stateLike: request.stateLike,
-      activeStatus: request.activeStatus,
+      status: request.status,
       latitude: request.latitude,
       longitude: request.longitude,
     }),
@@ -182,7 +182,7 @@ export function queryKeyOrganizationsListOrSearchFacilities(
     systemId?: number | undefined;
     nameLike?: string | undefined;
     stateLike?: string | undefined;
-    activeStatus?: components.ActiveStatus | undefined;
+    status?: components.ActiveStatus | undefined;
     latitude?: number | undefined;
     longitude?: number | undefined;
   },
@@ -205,7 +205,7 @@ export function queryKeyOrganizationsListOrSearchFacilitiesInfinite(
     systemId?: number | undefined;
     nameLike?: string | undefined;
     stateLike?: string | undefined;
-    activeStatus?: components.ActiveStatus | undefined;
+    status?: components.ActiveStatus | undefined;
     latitude?: number | undefined;
     longitude?: number | undefined;
   },

package/src/react-query/organizationsListOrSearchFacilities.ts

@@ -237,7 +237,7 @@ export function setOrganizationsListOrSearchFacilitiesData(
       systemId?: number | undefined;
       nameLike?: string | undefined;
       stateLike?: string | undefined;
-      activeStatus?: components.ActiveStatus | undefined;
+      status?: components.ActiveStatus | undefined;
       latitude?: number | undefined;
       longitude?: number | undefined;
     },
@@ -264,7 +264,7 @@ export function invalidateOrganizationsListOrSearchFacilities(
       systemId?: number | undefined;
       nameLike?: string | undefined;
       stateLike?: string | undefined;
-      activeStatus?: components.ActiveStatus | undefined;
+      status?: components.ActiveStatus | undefined;
       latitude?: number | undefined;
       longitude?: number | undefined;
     }]

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

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { paymentProfileGetPaymentProfile } from "../funcs/paymentProfileGetPaymentProfile.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type PaymentProfileGetPaymentProfileQueryData =
+  components.PaymentProfileInfo;
+
+export function prefetchPaymentProfileGetPaymentProfile(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildPaymentProfileGetPaymentProfileQuery(
+      client$,
+      options,
+    ),
+  });
+}
+
+export function buildPaymentProfileGetPaymentProfileQuery(
+  client$: GreenSecurityCore,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<PaymentProfileGetPaymentProfileQueryData>;
+} {
+  return {
+    queryKey: queryKeyPaymentProfileGetPaymentProfile(),
+    queryFn: async function paymentProfileGetPaymentProfileQueryFn(
+      ctx,
+    ): Promise<PaymentProfileGetPaymentProfileQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(paymentProfileGetPaymentProfile(
+        client$,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyPaymentProfileGetPaymentProfile(): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "payment-profile",
+    "getPaymentProfile",
+  ];
+}

package/src/react-query/paymentProfileGetPaymentProfile.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { useGreenSecurityContext } from "./_context.js";
+import { QueryHookOptions, SuspenseQueryHookOptions } from "./_types.js";
+import {
+  buildPaymentProfileGetPaymentProfileQuery,
+  PaymentProfileGetPaymentProfileQueryData,
+  prefetchPaymentProfileGetPaymentProfile,
+  queryKeyPaymentProfileGetPaymentProfile,
+} from "./paymentProfileGetPaymentProfile.core.js";
+export {
+  buildPaymentProfileGetPaymentProfileQuery,
+  type PaymentProfileGetPaymentProfileQueryData,
+  prefetchPaymentProfileGetPaymentProfile,
+  queryKeyPaymentProfileGetPaymentProfile,
+};
+
+/**
+ * Get payment profile information
+ *
+ * @remarks
+ * Returns payment profile information for the logged-in user (vendor or company manager).
+ * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
+ *
+ * Only vendors and company managers can access this endpoint.
+ */
+export function usePaymentProfileGetPaymentProfile(
+  options?: QueryHookOptions<PaymentProfileGetPaymentProfileQueryData>,
+): UseQueryResult<PaymentProfileGetPaymentProfileQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildPaymentProfileGetPaymentProfileQuery(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get payment profile information
+ *
+ * @remarks
+ * Returns payment profile information for the logged-in user (vendor or company manager).
+ * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
+ *
+ * Only vendors and company managers can access this endpoint.
+ */
+export function usePaymentProfileGetPaymentProfileSuspense(
+  options?: SuspenseQueryHookOptions<PaymentProfileGetPaymentProfileQueryData>,
+): UseSuspenseQueryResult<PaymentProfileGetPaymentProfileQueryData, Error> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildPaymentProfileGetPaymentProfileQuery(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setPaymentProfileGetPaymentProfileData(
+  client: QueryClient,
+  data: PaymentProfileGetPaymentProfileQueryData,
+): PaymentProfileGetPaymentProfileQueryData | undefined {
+  const key = queryKeyPaymentProfileGetPaymentProfile();
+
+  return client.setQueryData<PaymentProfileGetPaymentProfileQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateAllPaymentProfileGetPaymentProfile(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "payment-profile",
+      "getPaymentProfile",
+    ],
+  });
+}

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { usersGetLinkedUsers } from "../funcs/usersGetLinkedUsers.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type UsersGetLinkedUsersQueryData =
+  operations.GetLinkedUsersGetLinkedUsersOk;
+
+export function prefetchUsersGetLinkedUsers(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildUsersGetLinkedUsersQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildUsersGetLinkedUsersQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<UsersGetLinkedUsersQueryData>;
+} {
+  return {
+    queryKey: queryKeyUsersGetLinkedUsers({ userId: request.userId }),
+    queryFn: async function usersGetLinkedUsersQueryFn(
+      ctx,
+    ): Promise<UsersGetLinkedUsersQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(usersGetLinkedUsers(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyUsersGetLinkedUsers(
+  parameters: { userId?: number | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "users",
+    "getLinkedUsers",
+    parameters,
+  ];
+}