@greensecurity/javascript-sdk 0.30.25 → 0.30.27

package/src/models/operations/listvendorinvoices.ts

@@ -11,20 +11,30 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Filter invoices by status
+ * Filter invoices by financial_status
  */
-export const InvoiceStatus = {
-  Cart: "cart",
+export const InvoiceFinancialStatus = {
   Pending: "pending",
-  Canceled: "canceled",
-  ReadyToShip: "ready to ship",
-  Processed: "processed",
-  UnderReview: "under review",
+  Authorized: "authorized",
+  Captured: "captured",
+  Refunded: "refunded",
+  RefundedToCredits: "refunded to credits",
+  Voided: "voided",
+  Waived: "waived",
+  Overdue: "overdue",
+  Paid: "paid",
+  PaidByCredits: "paid by credits",
+  PaidByCreditCard: "paid by credit card",
+  PaidByCheck: "paid by check",
+  PaidByShareback: "paid by shareback",
+  PaidByPo: "paid by po",
+  PaidByOtherMeans: "paid by other means",
+  Credited: "credited",
 } as const;
 /**
- * Filter invoices by status
+ * Filter invoices by financial_status
  */
-export type InvoiceStatus = ClosedEnum<typeof InvoiceStatus>;
+export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
 
 export type ListVendorInvoicesRequest = {
   /**
@@ -56,9 +66,9 @@ export type ListVendorInvoicesRequest = {
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter invoices by status
+   * Filter invoices by financial_status
    */
-  invoiceStatus?: InvoiceStatus | undefined;
+  invoiceFinancialStatus?: InvoiceFinancialStatus | undefined;
 };
 
 /**
@@ -77,24 +87,24 @@ export type ListVendorInvoicesResponse = {
 };
 
 /** @internal */
-export const InvoiceStatus$inboundSchema: z.ZodNativeEnum<
-  typeof InvoiceStatus
-> = z.nativeEnum(InvoiceStatus);
+export const InvoiceFinancialStatus$inboundSchema: z.ZodNativeEnum<
+  typeof InvoiceFinancialStatus
+> = z.nativeEnum(InvoiceFinancialStatus);
 
 /** @internal */
-export const InvoiceStatus$outboundSchema: z.ZodNativeEnum<
-  typeof InvoiceStatus
-> = InvoiceStatus$inboundSchema;
+export const InvoiceFinancialStatus$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceFinancialStatus
+> = InvoiceFinancialStatus$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace InvoiceStatus$ {
-  /** @deprecated use `InvoiceStatus$inboundSchema` instead. */
-  export const inboundSchema = InvoiceStatus$inboundSchema;
-  /** @deprecated use `InvoiceStatus$outboundSchema` instead. */
-  export const outboundSchema = InvoiceStatus$outboundSchema;
+export namespace InvoiceFinancialStatus$ {
+  /** @deprecated use `InvoiceFinancialStatus$inboundSchema` instead. */
+  export const inboundSchema = InvoiceFinancialStatus$inboundSchema;
+  /** @deprecated use `InvoiceFinancialStatus$outboundSchema` instead. */
+  export const outboundSchema = InvoiceFinancialStatus$outboundSchema;
 }
 
 /** @internal */
@@ -110,13 +120,13 @@ export const ListVendorInvoicesRequest$inboundSchema: z.ZodType<
   expand: z.array(components.Expand$inboundSchema).optional(),
   vendor_id_or_me: z.string(),
   invoice_number: z.string().optional(),
-  invoice_status: InvoiceStatus$inboundSchema.optional(),
+  invoice_financial_status: InvoiceFinancialStatus$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "items_per_page": "itemsPerPage",
     "vendor_id_or_me": "vendorIdOrMe",
     "invoice_number": "invoiceNumber",
-    "invoice_status": "invoiceStatus",
+    "invoice_financial_status": "invoiceFinancialStatus",
   });
 });
 
@@ -129,7 +139,7 @@ export type ListVendorInvoicesRequest$Outbound = {
   expand?: Array<string> | undefined;
   vendor_id_or_me: string;
   invoice_number?: string | undefined;
-  invoice_status?: string | undefined;
+  invoice_financial_status?: string | undefined;
 };
 
 /** @internal */
@@ -145,13 +155,13 @@ export const ListVendorInvoicesRequest$outboundSchema: z.ZodType<
   expand: z.array(components.Expand$outboundSchema).optional(),
   vendorIdOrMe: z.string(),
   invoiceNumber: z.string().optional(),
-  invoiceStatus: InvoiceStatus$outboundSchema.optional(),
+  invoiceFinancialStatus: InvoiceFinancialStatus$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
     vendorIdOrMe: "vendor_id_or_me",
     invoiceNumber: "invoice_number",
-    invoiceStatus: "invoice_status",
+    invoiceFinancialStatus: "invoice_financial_status",
   });
 });
 

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