@greensecurity/javascript-sdk 0.44.0-beta.3 → 0.44.0-beta.6

package/src/models/operations/vendorsexport.ts

@@ -0,0 +1,303 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 types from "../../types/primitives.js";
+import { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Two = {
+  Zero: 0,
+  One: 1,
+} as const;
+export type Two = ClosedEnum<typeof Two>;
+
+/**
+ * Sort descending flag.
+ */
+export type Desc = boolean | Two;
+
+export type VendorsExportRequest = {
+  /**
+   * Case-insensitive partial match on the vendor's company name.
+   */
+  companyNameLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on first name.
+   */
+  firstNameLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on last name.
+   */
+  lastNameLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on first name, last name, or full name.
+   */
+  fullNameLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on email.
+   */
+  emailLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on phone.
+   */
+  phoneLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on address line 1.
+   */
+  addressLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on address line 2.
+   */
+  address2Like?: string | undefined;
+  /**
+   * Case-insensitive partial match on city.
+   */
+  cityLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on state.
+   */
+  stateLike?: string | undefined;
+  /**
+   * Case-insensitive partial match on ZIP.
+   */
+  zipLike?: string | undefined;
+  /**
+   * Filter by vendor status.
+   */
+  status?: string | undefined;
+  /**
+   * Scope to a specific company (API users must be authorized by MarketplaceAppActivation).
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter to vendors with (or without) a credentialing subscription.
+   */
+  credentialingSubscriptionIdNull?: string | undefined;
+  /**
+   * Filter to vendors with (or without) a scrubs subscription.
+   */
+  scrubsSubscriptionIdNull?: string | undefined;
+  /**
+   * Filter by credentialing subscription status.
+   */
+  credentialingSubscriptionStatus?: string | undefined;
+  /**
+   * Filter by scrubs subscription status.
+   */
+  scrubsSubscriptionStatus?: string | undefined;
+  /**
+   * Comma-separated list of vendor type short names to match (case-insensitive).
+   */
+  vendorTypeLike?: string | undefined;
+  /**
+   * Case-insensitive match on a company-scoped custom field value (requires company_id).
+   */
+  vendorFieldValueLike?: string | undefined;
+  /**
+   * Only vendors whose most recent scan is on or after this date (YYYY-MM-DD).
+   */
+  dateScannedGte?: Date | undefined;
+  /**
+   * Only vendors whose most recent scan is on or before this date (YYYY-MM-DD).
+   */
+  dateScannedLte?: Date | undefined;
+  /**
+   * Only vendors whose latest paid credentialing line item ends on or after this date (YYYY-MM-DD).
+   */
+  dateEndsGte?: Date | undefined;
+  /**
+   * Only vendors whose latest paid credentialing line item ends on or before this date (YYYY-MM-DD).
+   */
+  dateEndsLte?: Date | undefined;
+  /**
+   * Sort field (defaults to `full_name`).
+   */
+  sort?: string | undefined;
+  /**
+   * Sort descending flag.
+   */
+  desc?: boolean | Two | undefined;
+  /**
+   * Page size used by the exporter while paginating results.
+   */
+  itemsPerPage?: number | undefined;
+  /**
+   * Comma-separated list of expansions. The exporter auto-adds required expands.
+   */
+  expand?: string | undefined;
+};
+
+/**
+ * Export request accepted and job enqueued.
+ */
+export type VendorsExportResponseBody = {
+  /**
+   * URL to poll for export status.
+   */
+  statusUrl: string;
+  /**
+   * URL to download the exported file once ready.
+   */
+  downloadUrl: string;
+  /**
+   * Status token used to check export status.
+   */
+  statusId: string;
+};
+
+/** @internal */
+export const Two$outboundSchema: z.ZodNativeEnum<typeof Two> = z.nativeEnum(
+  Two,
+);
+
+/** @internal */
+export type Desc$Outbound = boolean | number;
+
+/** @internal */
+export const Desc$outboundSchema: z.ZodType<Desc$Outbound, z.ZodTypeDef, Desc> =
+  smartUnion([z.boolean(), Two$outboundSchema]);
+
+export function descToJSON(desc: Desc): string {
+  return JSON.stringify(Desc$outboundSchema.parse(desc));
+}
+
+/** @internal */
+export type VendorsExportRequest$Outbound = {
+  company_name_like?: string | undefined;
+  first_name_like?: string | undefined;
+  last_name_like?: string | undefined;
+  full_name_like?: string | undefined;
+  email_like?: string | undefined;
+  phone_like?: string | undefined;
+  address_like?: string | undefined;
+  address2_like?: string | undefined;
+  city_like?: string | undefined;
+  state_like?: string | undefined;
+  zip_like?: string | undefined;
+  status?: string | undefined;
+  company_id?: number | undefined;
+  credentialing_subscription_id_null?: string | undefined;
+  scrubs_subscription_id_null?: 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;
+  sort?: string | undefined;
+  desc?: boolean | number | undefined;
+  items_per_page?: number | undefined;
+  expand?: string | undefined;
+};
+
+/** @internal */
+export const VendorsExportRequest$outboundSchema: z.ZodType<
+  VendorsExportRequest$Outbound,
+  z.ZodTypeDef,
+  VendorsExportRequest
+> = z.object({
+  companyNameLike: z.string().optional(),
+  firstNameLike: z.string().optional(),
+  lastNameLike: z.string().optional(),
+  fullNameLike: z.string().optional(),
+  emailLike: z.string().optional(),
+  phoneLike: z.string().optional(),
+  addressLike: z.string().optional(),
+  address2Like: z.string().optional(),
+  cityLike: z.string().optional(),
+  stateLike: z.string().optional(),
+  zipLike: z.string().optional(),
+  status: z.string().optional(),
+  companyId: z.number().int().optional(),
+  credentialingSubscriptionIdNull: z.string().optional(),
+  scrubsSubscriptionIdNull: z.string().optional(),
+  credentialingSubscriptionStatus: z.string().optional(),
+  scrubsSubscriptionStatus: z.string().optional(),
+  vendorTypeLike: z.string().optional(),
+  vendorFieldValueLike: z.string().optional(),
+  dateScannedGte: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ).optional(),
+  dateScannedLte: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ).optional(),
+  dateEndsGte: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ).optional(),
+  dateEndsLte: z.date().transform(v =>
+    v.toISOString().slice(0, "YYYY-MM-DD".length)
+  ).optional(),
+  sort: z.string().optional(),
+  desc: smartUnion([z.boolean(), Two$outboundSchema]).optional(),
+  itemsPerPage: z.number().int().optional(),
+  expand: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyNameLike: "company_name_like",
+    firstNameLike: "first_name_like",
+    lastNameLike: "last_name_like",
+    fullNameLike: "full_name_like",
+    emailLike: "email_like",
+    phoneLike: "phone_like",
+    addressLike: "address_like",
+    address2Like: "address2_like",
+    cityLike: "city_like",
+    stateLike: "state_like",
+    zipLike: "zip_like",
+    companyId: "company_id",
+    credentialingSubscriptionIdNull: "credentialing_subscription_id_null",
+    scrubsSubscriptionIdNull: "scrubs_subscription_id_null",
+    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",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function vendorsExportRequestToJSON(
+  vendorsExportRequest: VendorsExportRequest,
+): string {
+  return JSON.stringify(
+    VendorsExportRequest$outboundSchema.parse(vendorsExportRequest),
+  );
+}
+
+/** @internal */
+export const VendorsExportResponseBody$inboundSchema: z.ZodType<
+  VendorsExportResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status_url: types.string(),
+  download_url: types.string(),
+  status_id: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "status_url": "statusUrl",
+    "download_url": "downloadUrl",
+    "status_id": "statusId",
+  });
+});
+
+export function vendorsExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorsExportResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorsExportResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorsExportResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,211 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyCredentials } from "../funcs/companiesListCompanyCredentials.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 CompaniesListCompanyCredentialsQueryData =
+  operations.ListCompanyCredentialsResponse;
+
+export type CompaniesListCompanyCredentialsInfiniteQueryData = PageIterator<
+  operations.ListCompanyCredentialsResponse,
+  { page: number }
+>;
+
+export type CompaniesListCompanyCredentialsPageParams = PageIterator<
+  operations.ListCompanyCredentialsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchCompaniesListCompanyCredentials(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCredentialsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyCredentialsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchCompaniesListCompanyCredentialsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCredentialsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildCompaniesListCompanyCredentialsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as CompaniesListCompanyCredentialsPageParams,
+    getNextPageParam: (
+      previousPage: CompaniesListCompanyCredentialsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildCompaniesListCompanyCredentialsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCredentialsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyCredentialsQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCredentials(request.id, {
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      desc: request.desc,
+      sort: request.sort,
+      credentialNameLike: request.credentialNameLike,
+      status: request.status,
+      dateExpiresLte: request.dateExpiresLte,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCredentialsQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyCredentialsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyCredentials(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesListCompanyCredentialsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCredentialsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      CompaniesListCompanyCredentialsPageParams
+    >,
+  ) => Promise<CompaniesListCompanyCredentialsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCredentialsInfinite(request.id, {
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      desc: request.desc,
+      sort: request.sort,
+      credentialNameLike: request.credentialNameLike,
+      status: request.status,
+      dateExpiresLte: request.dateExpiresLte,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCredentialsQuery(
+      ctx,
+    ): Promise<CompaniesListCompanyCredentialsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          companiesListCompanyCredentials(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        companiesListCompanyCredentials(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyCredentials(
+  id: number,
+  parameters: {
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    desc?: components.Desc | undefined;
+    sort?: operations.ListCompanyCredentialsQueryParamSort | undefined;
+    credentialNameLike?: string | undefined;
+    status?: operations.ListCompanyCredentialsQueryParamStatus | undefined;
+    dateExpiresLte?: string | undefined;
+    expand?: Array<operations.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredentials",
+    id,
+    parameters,
+  ];
+}
+
+export function queryKeyCompaniesListCompanyCredentialsInfinite(
+  id: number,
+  parameters: {
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    desc?: components.Desc | undefined;
+    sort?: operations.ListCompanyCredentialsQueryParamSort | undefined;
+    credentialNameLike?: string | undefined;
+    status?: operations.ListCompanyCredentialsQueryParamStatus | undefined;
+    dateExpiresLte?: string | undefined;
+    expand?: Array<operations.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredentials",
+    "infinite",
+    id,
+    parameters,
+  ];
+}