@greensecurity/javascript-sdk 0.43.1-beta.133 → 0.43.1-beta.135

package/src/react-query/vendorsListVendors.ts

@@ -0,0 +1,432 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5cf376eac850
+ */
+
+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 { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorsListVendorsInfiniteQuery,
+  buildVendorsListVendorsQuery,
+  prefetchVendorsListVendors,
+  prefetchVendorsListVendorsInfinite,
+  queryKeyVendorsListVendors,
+  queryKeyVendorsListVendorsInfinite,
+  VendorsListVendorsInfiniteQueryData,
+  VendorsListVendorsPageParams,
+  VendorsListVendorsQueryData,
+} from "./vendorsListVendors.core.js";
+export {
+  buildVendorsListVendorsInfiniteQuery,
+  buildVendorsListVendorsQuery,
+  prefetchVendorsListVendors,
+  prefetchVendorsListVendorsInfinite,
+  queryKeyVendorsListVendors,
+  queryKeyVendorsListVendorsInfinite,
+  type VendorsListVendorsInfiniteQueryData,
+  type VendorsListVendorsPageParams,
+  type VendorsListVendorsQueryData,
+};
+
+export type VendorsListVendorsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List vendors
+ *
+ * @remarks
+ * Returns a paginated list of vendors.
+ *
+ * Available `expand` scopes are:
+ *
+ * vendor.user
+ * vendor.vendor_type
+ * vendor.vendor_job
+ * vendor.image_urls
+ * vendor.payment_profile
+ * vendor.primary_facility
+ * vendor.primary_department
+ * vendor.company
+ * vendor.credentialing_subscription
+ * vendor.scrubs_subscription
+ * vendor.payment_responsibility
+ * vendor.background_check_date_expires
+ * vendor.credit_balance
+ * vendor.registration_data
+ * vendor.registration_finished
+ * vendor.target_facilities
+ * vendor.approved_calendaring_facilities
+ * vendor.pending_invoice
+ * vendor.vendor_groups
+ * vendor.has_credentialed_facilities
+ * vendor.has_emerald_status
+ * vendor.custom_fields
+ * vendor.last_scanned
+ *
+ * Subscription expand scopes (require vendor.credentialing_subscription):
+ *
+ * subscription.date_ends
+ * subscription.variant_title
+ * subscription.current_line_item
+ * subscription.next_line_item
+ * subscription.current_financial_status
+ * subscription.next_financial_status
+ * subscription.expedited_offers
+ */
+export function useVendorsListVendors(
+  request: operations.ListVendorsRequest,
+  options?: QueryHookOptions<
+    VendorsListVendorsQueryData,
+    VendorsListVendorsQueryError
+  >,
+): UseQueryResult<VendorsListVendorsQueryData, VendorsListVendorsQueryError> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsListVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendors
+ *
+ * @remarks
+ * Returns a paginated list of vendors.
+ *
+ * Available `expand` scopes are:
+ *
+ * vendor.user
+ * vendor.vendor_type
+ * vendor.vendor_job
+ * vendor.image_urls
+ * vendor.payment_profile
+ * vendor.primary_facility
+ * vendor.primary_department
+ * vendor.company
+ * vendor.credentialing_subscription
+ * vendor.scrubs_subscription
+ * vendor.payment_responsibility
+ * vendor.background_check_date_expires
+ * vendor.credit_balance
+ * vendor.registration_data
+ * vendor.registration_finished
+ * vendor.target_facilities
+ * vendor.approved_calendaring_facilities
+ * vendor.pending_invoice
+ * vendor.vendor_groups
+ * vendor.has_credentialed_facilities
+ * vendor.has_emerald_status
+ * vendor.custom_fields
+ * vendor.last_scanned
+ *
+ * Subscription expand scopes (require vendor.credentialing_subscription):
+ *
+ * subscription.date_ends
+ * subscription.variant_title
+ * subscription.current_line_item
+ * subscription.next_line_item
+ * subscription.current_financial_status
+ * subscription.next_financial_status
+ * subscription.expedited_offers
+ */
+export function useVendorsListVendorsSuspense(
+  request: operations.ListVendorsRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsListVendorsQueryData,
+    VendorsListVendorsQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsListVendorsQueryData,
+  VendorsListVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsListVendorsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List vendors
+ *
+ * @remarks
+ * Returns a paginated list of vendors.
+ *
+ * Available `expand` scopes are:
+ *
+ * vendor.user
+ * vendor.vendor_type
+ * vendor.vendor_job
+ * vendor.image_urls
+ * vendor.payment_profile
+ * vendor.primary_facility
+ * vendor.primary_department
+ * vendor.company
+ * vendor.credentialing_subscription
+ * vendor.scrubs_subscription
+ * vendor.payment_responsibility
+ * vendor.background_check_date_expires
+ * vendor.credit_balance
+ * vendor.registration_data
+ * vendor.registration_finished
+ * vendor.target_facilities
+ * vendor.approved_calendaring_facilities
+ * vendor.pending_invoice
+ * vendor.vendor_groups
+ * vendor.has_credentialed_facilities
+ * vendor.has_emerald_status
+ * vendor.custom_fields
+ * vendor.last_scanned
+ *
+ * Subscription expand scopes (require vendor.credentialing_subscription):
+ *
+ * subscription.date_ends
+ * subscription.variant_title
+ * subscription.current_line_item
+ * subscription.next_line_item
+ * subscription.current_financial_status
+ * subscription.next_financial_status
+ * subscription.expedited_offers
+ */
+export function useVendorsListVendorsInfinite(
+  request: operations.ListVendorsRequest,
+  options?: InfiniteQueryHookOptions<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsPageParams
+  >,
+  VendorsListVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsQueryError,
+    InfiniteData<
+      VendorsListVendorsInfiniteQueryData,
+      VendorsListVendorsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorsPageParams
+  >({
+    ...buildVendorsListVendorsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List vendors
+ *
+ * @remarks
+ * Returns a paginated list of vendors.
+ *
+ * Available `expand` scopes are:
+ *
+ * vendor.user
+ * vendor.vendor_type
+ * vendor.vendor_job
+ * vendor.image_urls
+ * vendor.payment_profile
+ * vendor.primary_facility
+ * vendor.primary_department
+ * vendor.company
+ * vendor.credentialing_subscription
+ * vendor.scrubs_subscription
+ * vendor.payment_responsibility
+ * vendor.background_check_date_expires
+ * vendor.credit_balance
+ * vendor.registration_data
+ * vendor.registration_finished
+ * vendor.target_facilities
+ * vendor.approved_calendaring_facilities
+ * vendor.pending_invoice
+ * vendor.vendor_groups
+ * vendor.has_credentialed_facilities
+ * vendor.has_emerald_status
+ * vendor.custom_fields
+ * vendor.last_scanned
+ *
+ * Subscription expand scopes (require vendor.credentialing_subscription):
+ *
+ * subscription.date_ends
+ * subscription.variant_title
+ * subscription.current_line_item
+ * subscription.next_line_item
+ * subscription.current_financial_status
+ * subscription.next_financial_status
+ * subscription.expedited_offers
+ */
+export function useVendorsListVendorsInfiniteSuspense(
+  request: operations.ListVendorsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsPageParams
+  >,
+  VendorsListVendorsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    VendorsListVendorsInfiniteQueryData,
+    VendorsListVendorsQueryError,
+    InfiniteData<
+      VendorsListVendorsInfiniteQueryData,
+      VendorsListVendorsPageParams
+    >,
+    QueryKey,
+    VendorsListVendorsPageParams
+  >({
+    ...buildVendorsListVendorsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setVendorsListVendorsData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      expand?: Array<components.Expand> | undefined;
+      sort?: operations.Sort | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      companyId?: number | undefined;
+      fullNameLike?: string | undefined;
+      companyNameLike?: string | undefined;
+      firstNameLike?: string | undefined;
+      lastNameLike?: string | undefined;
+      emailLike?: string | undefined;
+      status?: string | undefined;
+      credentialingSubscriptionStatus?: string | undefined;
+      scrubsSubscriptionStatus?: string | undefined;
+      vendorTypeLike?: string | undefined;
+      vendorFieldValueLike?: string | undefined;
+      dateScannedGte?: string | undefined;
+      dateScannedLte?: string | undefined;
+      dateEndsGte?: string | undefined;
+      dateEndsLte?: string | undefined;
+    },
+  ],
+  data: VendorsListVendorsQueryData,
+): VendorsListVendorsQueryData | undefined {
+  const key = queryKeyVendorsListVendors(...queryKeyBase);
+
+  return client.setQueryData<VendorsListVendorsQueryData>(key, data);
+}
+
+export function invalidateVendorsListVendors(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      expand?: Array<components.Expand> | undefined;
+      sort?: operations.Sort | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      companyId?: number | undefined;
+      fullNameLike?: string | undefined;
+      companyNameLike?: string | undefined;
+      firstNameLike?: string | undefined;
+      lastNameLike?: string | undefined;
+      emailLike?: string | undefined;
+      status?: string | undefined;
+      credentialingSubscriptionStatus?: string | undefined;
+      scrubsSubscriptionStatus?: string | undefined;
+      vendorTypeLike?: string | undefined;
+      vendorFieldValueLike?: string | undefined;
+      dateScannedGte?: string | undefined;
+      dateScannedLte?: string | undefined;
+      dateEndsGte?: string | undefined;
+      dateEndsLte?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "listVendors",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsListVendors(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "vendors", "listVendors"],
+  });
+}

package/src/sdk/vendors.ts

@@ -38,6 +38,7 @@ import { vendorsListVendorFacilityStatuses } from "../funcs/vendorsListVendorFac
 import { vendorsListVendorInvoices } from "../funcs/vendorsListVendorInvoices.js";
 import { vendorsListVendorJobTitles } from "../funcs/vendorsListVendorJobTitles.js";
 import { vendorsListVendorManagedByCompanies } from "../funcs/vendorsListVendorManagedByCompanies.js";
+import { vendorsListVendors } from "../funcs/vendorsListVendors.js";
 import { vendorsListVendorScrubDetails } from "../funcs/vendorsListVendorScrubDetails.js";
 import { vendorsListVendorScrubPackages } from "../funcs/vendorsListVendorScrubPackages.js";
 import { vendorsListVendorScrubPurchases } from "../funcs/vendorsListVendorScrubPurchases.js";
@@ -58,6 +59,80 @@ import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Vendors extends ClientSDK {
+  /**
+   * List vendors
+   *
+   * @remarks
+   * Returns a paginated list of vendors.
+   *
+   * Available `expand` scopes are:
+   *
+   * vendor.user
+   * vendor.vendor_type
+   * vendor.vendor_job
+   * vendor.image_urls
+   * vendor.payment_profile
+   * vendor.primary_facility
+   * vendor.primary_department
+   * vendor.company
+   * vendor.credentialing_subscription
+   * vendor.scrubs_subscription
+   * vendor.payment_responsibility
+   * vendor.background_check_date_expires
+   * vendor.credit_balance
+   * vendor.registration_data
+   * vendor.registration_finished
+   * vendor.target_facilities
+   * vendor.approved_calendaring_facilities
+   * vendor.pending_invoice
+   * vendor.vendor_groups
+   * vendor.has_credentialed_facilities
+   * vendor.has_emerald_status
+   * vendor.custom_fields
+   * vendor.last_scanned
+   *
+   * Subscription expand scopes (require vendor.credentialing_subscription):
+   *
+   * subscription.date_ends
+   * subscription.variant_title
+   * subscription.current_line_item
+   * subscription.next_line_item
+   * subscription.current_financial_status
+   * subscription.next_financial_status
+   * subscription.expedited_offers
+   */
+  async listVendors(
+    request: operations.ListVendorsRequest,
+    options?: RequestOptions,
+  ): Promise<PageIterator<operations.ListVendorsResponse, { page: number }>> {
+    return unwrapResultIterator(vendorsListVendors(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a new vendor
+   *
+   * @remarks
+   * Creates a new vendor account linked to the specified company.
+   *
+   * `company_id` is optional for company managers — it defaults to their own company.
+   * All other callers must provide `company_id`. The caller must have access to the
+   * specified company (verified via scoped access policy) and the `vendors:add` permission.
+   */
+  async createVendor(
+    request: operations.CreateVendorRequestBody,
+    options?: RequestOptions,
+  ): Promise<operations.CreateVendorResponseBody> {
+    return unwrapAsync(vendorsCreateVendor(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Create vendor registration
    *
@@ -1008,25 +1083,4 @@ export class Vendors extends ClientSDK {
       options,
     ));
   }
-
-  /**
-   * Create a new vendor
-   *
-   * @remarks
-   * Creates a new vendor account linked to the specified company.
-   *
-   * `company_id` is optional for company managers — it defaults to their own company.
-   * All other callers must provide `company_id`. The caller must have access to the
-   * specified company (verified via scoped access policy) and the `vendors:add` permission.
-   */
-  async createVendor(
-    request: operations.CreateVendorRequestBody,
-    options?: RequestOptions,
-  ): Promise<operations.CreateVendorResponseBody> {
-    return unwrapAsync(vendorsCreateVendor(
-      this,
-      request,
-      options,
-    ));
-  }
 }