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

package/src/models/operations/listvendors.ts

@@ -0,0 +1,240 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4b7be12fe46e
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Sort column. vendor_field_value requires company_id.
+ *
+ * @remarks
+ * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+ */
+export const Sort = {
+  FullName: "full_name",
+  VendorType: "vendor_type",
+  LastScanned: "last_scanned",
+  VendorFieldValue: "vendor_field_value",
+  SubscriptionStatus: "subscription_status",
+  DateEnds: "date_ends",
+} as const;
+/**
+ * Sort column. vendor_field_value requires company_id.
+ *
+ * @remarks
+ * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+ */
+export type Sort = ClosedEnum<typeof Sort>;
+
+export type ListVendorsRequest = {
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
+  /**
+   * Sort column. vendor_field_value requires company_id.
+   *
+   * @remarks
+   * last_scanned and date_ends use LATERAL JOINs added automatically when the sort key is present.
+   */
+  sort?: Sort | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Filter vendors by company. Required when using vendor_field_value sort or vendor_field_value_like filter.
+   */
+  companyId?: number | undefined;
+  /**
+   * Search by first name, last name, or full name (case-insensitive contains).
+   */
+  fullNameLike?: string | undefined;
+  companyNameLike?: string | undefined;
+  firstNameLike?: string | undefined;
+  lastNameLike?: string | undefined;
+  emailLike?: string | undefined;
+  status?: string | undefined;
+  credentialingSubscriptionStatus?: string | undefined;
+  scrubsSubscriptionStatus?: string | undefined;
+  /**
+   * Filter by vendor_types.short_name (case-insensitive contains). Comma-separated for multiple values.
+   */
+  vendorTypeLike?: string | undefined;
+  /**
+   * Filter by vendor field value (case-insensitive contains). Requires company_id.
+   */
+  vendorFieldValueLike?: string | undefined;
+  /**
+   * Filter vendors with last scan date on or after this date (YYYY-MM-DD).
+   */
+  dateScannedGte?: string | undefined;
+  /**
+   * Filter vendors with last scan date on or before this date (YYYY-MM-DD).
+   */
+  dateScannedLte?: string | undefined;
+  /**
+   * Filter vendors whose credentialing subscription date_ends is on or after this date (YYYY-MM-DD).
+   */
+  dateEndsGte?: string | undefined;
+  /**
+   * Filter vendors whose credentialing subscription date_ends is on or before this date (YYYY-MM-DD).
+   */
+  dateEndsLte?: string | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type ListVendorsListVendorsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.Vendor>;
+};
+
+export type ListVendorsResponse = {
+  result: ListVendorsListVendorsOk;
+};
+
+/** @internal */
+export const Sort$outboundSchema: z.ZodNativeEnum<typeof Sort> = z.nativeEnum(
+  Sort,
+);
+
+/** @internal */
+export type ListVendorsRequest$Outbound = {
+  expand?: Array<string> | undefined;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  company_id?: number | undefined;
+  full_name_like?: string | undefined;
+  company_name_like?: string | undefined;
+  first_name_like?: string | undefined;
+  last_name_like?: string | undefined;
+  email_like?: string | undefined;
+  status?: string | undefined;
+  credentialing_subscription_status?: string | undefined;
+  scrubs_subscription_status?: string | undefined;
+  vendor_type_like?: string | undefined;
+  vendor_field_value_like?: string | undefined;
+  date_scanned_gte?: string | undefined;
+  date_scanned_lte?: string | undefined;
+  date_ends_gte?: string | undefined;
+  date_ends_lte?: string | undefined;
+};
+
+/** @internal */
+export const ListVendorsRequest$outboundSchema: z.ZodType<
+  ListVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ListVendorsRequest
+> = z.object({
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  sort: Sort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  companyId: z.number().int().optional(),
+  fullNameLike: z.string().optional(),
+  companyNameLike: z.string().optional(),
+  firstNameLike: z.string().optional(),
+  lastNameLike: z.string().optional(),
+  emailLike: z.string().optional(),
+  status: z.string().optional(),
+  credentialingSubscriptionStatus: z.string().optional(),
+  scrubsSubscriptionStatus: z.string().optional(),
+  vendorTypeLike: z.string().optional(),
+  vendorFieldValueLike: z.string().optional(),
+  dateScannedGte: z.string().optional(),
+  dateScannedLte: z.string().optional(),
+  dateEndsGte: z.string().optional(),
+  dateEndsLte: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    companyId: "company_id",
+    fullNameLike: "full_name_like",
+    companyNameLike: "company_name_like",
+    firstNameLike: "first_name_like",
+    lastNameLike: "last_name_like",
+    emailLike: "email_like",
+    credentialingSubscriptionStatus: "credentialing_subscription_status",
+    scrubsSubscriptionStatus: "scrubs_subscription_status",
+    vendorTypeLike: "vendor_type_like",
+    vendorFieldValueLike: "vendor_field_value_like",
+    dateScannedGte: "date_scanned_gte",
+    dateScannedLte: "date_scanned_lte",
+    dateEndsGte: "date_ends_gte",
+    dateEndsLte: "date_ends_lte",
+  });
+});
+
+export function listVendorsRequestToJSON(
+  listVendorsRequest: ListVendorsRequest,
+): string {
+  return JSON.stringify(
+    ListVendorsRequest$outboundSchema.parse(listVendorsRequest),
+  );
+}
+
+/** @internal */
+export const ListVendorsListVendorsOk$inboundSchema: z.ZodType<
+  ListVendorsListVendorsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(components.Vendor$inboundSchema),
+});
+
+export function listVendorsListVendorsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorsListVendorsOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorsListVendorsOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorsListVendorsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListVendorsResponse$inboundSchema: z.ZodType<
+  ListVendorsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListVendorsListVendorsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listVendorsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListVendorsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListVendorsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListVendorsResponse' from JSON`,
+  );
+}

package/src/react-query/index.ts

@@ -105,6 +105,7 @@ export * from "./vendorsListVendorFacilityStatuses.js";
 export * from "./vendorsListVendorInvoices.js";
 export * from "./vendorsListVendorJobTitles.js";
 export * from "./vendorsListVendorManagedByCompanies.js";
+export * from "./vendorsListVendors.js";
 export * from "./vendorsListVendorScrubDetails.js";
 export * from "./vendorsListVendorScrubPackages.js";
 export * from "./vendorsListVendorScrubPurchases.js";

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

@@ -0,0 +1,247 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c6c81886813e
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsListVendors } from "../funcs/vendorsListVendors.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 { pageIteratorToJSON } from "./_types.js";
+export type VendorsListVendorsQueryData = operations.ListVendorsResponse;
+
+export type VendorsListVendorsInfiniteQueryData = PageIterator<
+  operations.ListVendorsResponse,
+  { page: number }
+>;
+
+export type VendorsListVendorsPageParams = PageIterator<
+  operations.ListVendorsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchVendorsListVendors(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsListVendorsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchVendorsListVendorsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListVendorsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildVendorsListVendorsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as VendorsListVendorsPageParams,
+    getNextPageParam: (previousPage: VendorsListVendorsInfiniteQueryData) =>
+      previousPage["~next"],
+  });
+}
+
+export function buildVendorsListVendorsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsListVendorsQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendors({
+      expand: request.expand,
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      companyId: request.companyId,
+      fullNameLike: request.fullNameLike,
+      companyNameLike: request.companyNameLike,
+      firstNameLike: request.firstNameLike,
+      lastNameLike: request.lastNameLike,
+      emailLike: request.emailLike,
+      status: request.status,
+      credentialingSubscriptionStatus: request.credentialingSubscriptionStatus,
+      scrubsSubscriptionStatus: request.scrubsSubscriptionStatus,
+      vendorTypeLike: request.vendorTypeLike,
+      vendorFieldValueLike: request.vendorFieldValueLike,
+      dateScannedGte: request.dateScannedGte,
+      dateScannedLte: request.dateScannedLte,
+      dateEndsGte: request.dateEndsGte,
+      dateEndsLte: request.dateEndsLte,
+    }),
+    queryFn: async function vendorsListVendorsQueryFn(
+      ctx,
+    ): Promise<VendorsListVendorsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsListVendors(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorsListVendorsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListVendorsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<QueryKey, VendorsListVendorsPageParams>,
+  ) => Promise<VendorsListVendorsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsListVendorsInfinite({
+      expand: request.expand,
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      companyId: request.companyId,
+      fullNameLike: request.fullNameLike,
+      companyNameLike: request.companyNameLike,
+      firstNameLike: request.firstNameLike,
+      lastNameLike: request.lastNameLike,
+      emailLike: request.emailLike,
+      status: request.status,
+      credentialingSubscriptionStatus: request.credentialingSubscriptionStatus,
+      scrubsSubscriptionStatus: request.scrubsSubscriptionStatus,
+      vendorTypeLike: request.vendorTypeLike,
+      vendorFieldValueLike: request.vendorFieldValueLike,
+      dateScannedGte: request.dateScannedGte,
+      dateScannedLte: request.dateScannedLte,
+      dateEndsGte: request.dateEndsGte,
+      dateEndsLte: request.dateEndsLte,
+    }),
+    queryFn: async function vendorsListVendorsQuery(
+      ctx,
+    ): Promise<VendorsListVendorsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(vendorsListVendors(
+          client$,
+          request,
+          mergedOptions,
+        ));
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(vendorsListVendors(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyVendorsListVendors(
+  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;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendors",
+    parameters,
+  ];
+}
+
+export function queryKeyVendorsListVendorsInfinite(
+  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;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "listVendors",
+    "infinite",
+    parameters,
+  ];
+}