@greensecurity/javascript-sdk 0.44.0-beta.1 → 0.44.0-beta.11

package/src/react-query/vendorsVendorsExport.ts

@@ -0,0 +1,209 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildVendorsVendorsExportQuery,
+  prefetchVendorsVendorsExport,
+  queryKeyVendorsVendorsExport,
+  VendorsVendorsExportQueryData,
+} from "./vendorsVendorsExport.core.js";
+export {
+  buildVendorsVendorsExportQuery,
+  prefetchVendorsVendorsExport,
+  queryKeyVendorsVendorsExport,
+  type VendorsVendorsExportQueryData,
+};
+
+export type VendorsVendorsExportQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Export vendors to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of vendors based on the
+ * provided filters (the same filters supported by the vendors list endpoint).
+ * Returns a `status_url` to poll until the export is ready, plus a
+ * `download_url` and `status_id`.
+ */
+export function useVendorsVendorsExport(
+  request: operations.VendorsExportRequest,
+  options?: QueryHookOptions<
+    VendorsVendorsExportQueryData,
+    VendorsVendorsExportQueryError
+  >,
+): UseQueryResult<
+  VendorsVendorsExportQueryData,
+  VendorsVendorsExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildVendorsVendorsExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Export vendors to CSV (async)
+ *
+ * @remarks
+ * Enqueues an asynchronous job to generate a CSV export of vendors based on the
+ * provided filters (the same filters supported by the vendors list endpoint).
+ * Returns a `status_url` to poll until the export is ready, plus a
+ * `download_url` and `status_id`.
+ */
+export function useVendorsVendorsExportSuspense(
+  request: operations.VendorsExportRequest,
+  options?: SuspenseQueryHookOptions<
+    VendorsVendorsExportQueryData,
+    VendorsVendorsExportQueryError
+  >,
+): UseSuspenseQueryResult<
+  VendorsVendorsExportQueryData,
+  VendorsVendorsExportQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildVendorsVendorsExportQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setVendorsVendorsExportData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      companyNameLike?: string | undefined;
+      firstNameLike?: string | undefined;
+      lastNameLike?: string | undefined;
+      fullNameLike?: string | undefined;
+      emailLike?: string | undefined;
+      phoneLike?: string | undefined;
+      addressLike?: string | undefined;
+      address2Like?: string | undefined;
+      cityLike?: string | undefined;
+      stateLike?: string | undefined;
+      zipLike?: string | undefined;
+      status?: string | undefined;
+      companyId?: number | undefined;
+      credentialingSubscriptionIdNull?: string | undefined;
+      scrubsSubscriptionIdNull?: string | undefined;
+      credentialingSubscriptionStatus?: string | undefined;
+      scrubsSubscriptionStatus?: string | undefined;
+      vendorTypeLike?: string | undefined;
+      vendorFieldValueLike?: string | undefined;
+      dateScannedGte?: Date | undefined;
+      dateScannedLte?: Date | undefined;
+      dateEndsGte?: Date | undefined;
+      dateEndsLte?: Date | undefined;
+      sort?: string | undefined;
+      desc?: operations.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: string | undefined;
+    },
+  ],
+  data: VendorsVendorsExportQueryData,
+): VendorsVendorsExportQueryData | undefined {
+  const key = queryKeyVendorsVendorsExport(...queryKeyBase);
+
+  return client.setQueryData<VendorsVendorsExportQueryData>(key, data);
+}
+
+export function invalidateVendorsVendorsExport(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      companyNameLike?: string | undefined;
+      firstNameLike?: string | undefined;
+      lastNameLike?: string | undefined;
+      fullNameLike?: string | undefined;
+      emailLike?: string | undefined;
+      phoneLike?: string | undefined;
+      addressLike?: string | undefined;
+      address2Like?: string | undefined;
+      cityLike?: string | undefined;
+      stateLike?: string | undefined;
+      zipLike?: string | undefined;
+      status?: string | undefined;
+      companyId?: number | undefined;
+      credentialingSubscriptionIdNull?: string | undefined;
+      scrubsSubscriptionIdNull?: string | undefined;
+      credentialingSubscriptionStatus?: string | undefined;
+      scrubsSubscriptionStatus?: string | undefined;
+      vendorTypeLike?: string | undefined;
+      vendorFieldValueLike?: string | undefined;
+      dateScannedGte?: Date | undefined;
+      dateScannedLte?: Date | undefined;
+      dateEndsGte?: Date | undefined;
+      dateEndsLte?: Date | undefined;
+      sort?: string | undefined;
+      desc?: operations.Desc | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "vendors",
+      "vendorsExport",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllVendorsVendorsExport(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@greensecurity/javascript-sdk", "vendors", "vendorsExport"],
+  });
+}

package/src/sdk/companies.ts

@@ -4,6 +4,8 @@
 
 import { companiesAddCompanyManager } from "../funcs/companiesAddCompanyManager.js";
 import { companiesGetCompany } from "../funcs/companiesGetCompany.js";
+import { companiesListCompanyCredentials } from "../funcs/companiesListCompanyCredentials.js";
+import { companiesListCompanyCredits } from "../funcs/companiesListCompanyCredits.js";
 import { companiesListCompanyManagers } from "../funcs/companiesListCompanyManagers.js";
 import { companiesListOrSearchCompanies } from "../funcs/companiesListOrSearchCompanies.js";
 import { companiesLookupCompanies } from "../funcs/companiesLookupCompanies.js";
@@ -112,4 +114,42 @@ export class Companies extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * List Company Credentials
+   *
+   * @remarks
+   * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+   */
+  async listCompanyCredentials(
+    request: operations.ListCompanyCredentialsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListCompanyCredentialsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(companiesListCompanyCredentials(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List credits related to a company
+   *
+   * @remarks
+   * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+   */
+  async listCompanyCredits(
+    request: operations.ListCompanyCreditsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListCompanyCreditsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(companiesListCompanyCredits(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/organizations.ts

@@ -2,7 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { organizationsCreateCompanyTargetFacility } from "../funcs/organizationsCreateCompanyTargetFacility.js";
+import { organizationsDeleteCompanyTargetFacility } from "../funcs/organizationsDeleteCompanyTargetFacility.js";
 import { organizationsGetFacility } from "../funcs/organizationsGetFacility.js";
+import { organizationsListCompanyTargetFacilities } from "../funcs/organizationsListCompanyTargetFacilities.js";
 import { organizationsListOrSearchDepartmentContacts } from "../funcs/organizationsListOrSearchDepartmentContacts.js";
 import { organizationsListOrSearchDepartments } from "../funcs/organizationsListOrSearchDepartments.js";
 import { organizationsListOrSearchFacilities } from "../funcs/organizationsListOrSearchFacilities.js";
@@ -81,6 +84,105 @@ export class Organizations extends ClientSDK {
     ));
   }
 
+  /**
+   * List company target facilities
+   *
+   * @remarks
+   * Lists the CompanyTargetFacility links for a company — the facilities the
+   * company is targeting. Each row carries the linked facility (with location
+   * and parent system), the link status, and per-facility counts of the
+   * company's individuals targeting it.
+   *
+   * When `include_potential_targets=true`, returns ALL non-deleted facilities
+   * via a LEFT JOIN. Targeted rows carry their CTF `id` and `status`; non-targeted
+   * rows have `id: null` and `status: "Not Targeted"`.
+   *
+   * Access control: the URL's `company_id` must be in the caller's read scope
+   * for Company (a company manager's or vendor's own company, or a company
+   * whose app is activated for the API user). Callers outside that scope
+   * receive `404 Company not found`.
+   *
+   * Filter with `has_individual` / `has_active_individual` to drive the
+   * facility roster views.
+   *
+   * Available `expand` scopes are:
+   *
+   * - company_target_facility.facility
+   */
+  async listCompanyTargetFacilities(
+    request: operations.ListCompanyTargetFacilitiesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListCompanyTargetFacilitiesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(organizationsListCompanyTargetFacilities(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add a company target facility
+   *
+   * @remarks
+   * Links the URL's company to an existing facility. The link is created with
+   * status `Pending`. Only the link row is created — the Facility entity
+   * itself is never created or modified by this endpoint.
+   *
+   * Access control: the URL's `company_id` must be in the caller's update
+   * scope for Company, AND the `facility_id` must be in the caller's create
+   * scope for Facility (a facility on the company's site, or a facility
+   * reachable via the API user's site/system/facility-scoped activation).
+   * Either being out of scope returns `404 Company not found` /
+   * `404 Facility not found` respectively. Deleted facilities also return
+   * `404 Facility not found`.
+   *
+   * Available `expand` scopes are:
+   *
+   * - company_target_facility.facility
+   */
+  async createCompanyTargetFacility(
+    request: operations.CreateCompanyTargetFacilityRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk
+  > {
+    return unwrapAsync(organizationsCreateCompanyTargetFacility(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Remove a company target facility
+   *
+   * @remarks
+   * Removes a CompanyTargetFacility link. Blocked when any of the company's
+   * individuals still target the same facility (to avoid orphaning their
+   * vendor-scoped target rows). Only the link row is removed — the Facility
+   * entity itself is never touched.
+   *
+   * Access control: the URL's `company_id` must be in the caller's update
+   * scope for Company (a company manager's or vendor's own company, or a
+   * company whose app is activated for the API user). Callers outside that
+   * scope receive `404 Company not found`.
+   */
+  async deleteCompanyTargetFacility(
+    request: operations.DeleteCompanyTargetFacilityRequest,
+    options?: RequestOptions,
+  ): Promise<boolean> {
+    return unwrapAsync(organizationsDeleteCompanyTargetFacility(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List or search department contacts
    *

package/src/sdk/users.ts

@@ -32,6 +32,7 @@ export class Users extends ClientSDK {
    * Supported `expand` values:
    * - `user` — return the full user record, including all profile fields stored against the user (sensitive columns such as passwords, MFA codes, and payment-provider IDs are always omitted)
    * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+   * - `user.payment_profile` — include the user's `payment_profile` block (card type, last four digits, validity flags) when expanded; if no payment profile is associated with the user, the response returns `payment_profile: null`
    * - `company.location`, `company.vendor_type_restrictions`, `company.vendor_fields` — only valid for Company Manager users; embed extra fields on the user's company
    *
    * Multiple values can be combined with commas, e.g.

package/src/sdk/vendors.ts

@@ -18,6 +18,7 @@ import { vendorsCreateVendorRegistration } from "../funcs/vendorsCreateVendorReg
 import { vendorsDeclineVendorCredential } from "../funcs/vendorsDeclineVendorCredential.js";
 import { vendorsDeleteVendorCredentialFile } from "../funcs/vendorsDeleteVendorCredentialFile.js";
 import { vendorsDeleteVendorManagedByCompany } from "../funcs/vendorsDeleteVendorManagedByCompany.js";
+import { vendorsDownloadVendorsExport } from "../funcs/vendorsDownloadVendorsExport.js";
 import { vendorsExpediteTimeRemaining } from "../funcs/vendorsExpediteTimeRemaining.js";
 import { vendorsGetNextUnansweredScreeningQuestion } from "../funcs/vendorsGetNextUnansweredScreeningQuestion.js";
 import { vendorsGetSubscription } from "../funcs/vendorsGetSubscription.js";
@@ -27,6 +28,7 @@ import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoice
 import { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
 import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
+import { vendorsGetVendorsExportStatus } from "../funcs/vendorsGetVendorsExportStatus.js";
 import { vendorsGetVendorUploadHistory } from "../funcs/vendorsGetVendorUploadHistory.js";
 import { vendorsListVendorAdditionalFacilityFields } from "../funcs/vendorsListVendorAdditionalFacilityFields.js";
 import { vendorsListVendorCredentialDataRequests } from "../funcs/vendorsListVendorCredentialDataRequests.js";
@@ -53,6 +55,7 @@ import { vendorsUpdateVendorCustomField } from "../funcs/vendorsUpdateVendorCust
 import { vendorsUpdateVendorDetails } from "../funcs/vendorsUpdateVendorDetails.js";
 import { vendorsUpdateVendorManagedByCompany } from "../funcs/vendorsUpdateVendorManagedByCompany.js";
 import { vendorsUpdateVendorScrubDetails } from "../funcs/vendorsUpdateVendorScrubDetails.js";
+import { vendorsVendorsExport } from "../funcs/vendorsVendorsExport.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 import * as operations from "../models/operations/index.js";
@@ -1004,6 +1007,63 @@ export class Vendors extends ClientSDK {
     ));
   }
 
+  /**
+   * Export vendors to CSV (async)
+   *
+   * @remarks
+   * Enqueues an asynchronous job to generate a CSV export of vendors based on the
+   * provided filters (the same filters supported by the vendors list endpoint).
+   * Returns a `status_url` to poll until the export is ready, plus a
+   * `download_url` and `status_id`.
+   */
+  async vendorsExport(
+    request: operations.VendorsExportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.VendorsExportResponseBody> {
+    return unwrapAsync(vendorsVendorsExport(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get vendor export status
+   *
+   * @remarks
+   * Poll the status of an asynchronous vendor export job. When `ready` is true,
+   * the export is complete and can be downloaded via the download endpoint.
+   */
+  async getVendorsExportStatus(
+    request: operations.GetVendorsExportStatusRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetVendorsExportStatusResponseBody> {
+    return unwrapAsync(vendorsGetVendorsExportStatus(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Download vendors CSV
+   *
+   * @remarks
+   * Downloads the exported vendors CSV. When the export is ready the server
+   * responds with a 302 redirect to a short-lived presigned S3 URL. If the
+   * export job is still running, responds with 202.
+   */
+  async downloadVendorsExport(
+    request: operations.DownloadVendorsExportRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DownloadVendorsExportResponse | undefined> {
+    return unwrapAsync(vendorsDownloadVendorsExport(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Purchase scrub credits
    *

package/src/sdk/vendorscans.ts

@@ -50,6 +50,9 @@ export class VendorScans extends ClientSDK {
    * - vendor_scan.zone
    * - vendor_scan.department
    * - vendor_scan.badge_data
+   * - vendor_scan.company
+   * - vendor_scan.appointment
+   * - vendor_scan.screening_responses
    */
   async getVendorScan(
     request: operations.GetVendorScanRequest,

package/src/types/async.ts

@@ -21,16 +21,17 @@ export type APICall =
 
 export class APIPromise<T> implements Promise<T> {
   readonly #promise: Promise<[T, APICall]>;
-  readonly #unwrapped: Promise<T>;
+  #unwrapped: Promise<T> | null;
 
   readonly [Symbol.toStringTag] = "APIPromise";
 
   constructor(p: [T, APICall] | Promise<[T, APICall]>) {
     this.#promise = p instanceof Promise ? p : Promise.resolve(p);
-    this.#unwrapped =
-      p instanceof Promise
-        ? this.#promise.then(([value]) => value)
-        : Promise.resolve(p[0]);
+    this.#unwrapped = p instanceof Promise ? null : Promise.resolve(p[0]);
+  }
+
+  #getUnwrapped(): Promise<T> {
+    return (this.#unwrapped ??= this.#promise.then(([value]) => value));
   }
 
   then<TResult1 = T, TResult2 = never>(
@@ -55,11 +56,11 @@ export class APIPromise<T> implements Promise<T> {
       | null
       | undefined,
   ): Promise<T | TResult> {
-    return this.#unwrapped.catch(onrejected);
+    return this.#getUnwrapped().catch(onrejected);
   }
 
   finally(onfinally?: (() => void) | null | undefined): Promise<T> {
-    return this.#unwrapped.finally(onfinally);
+    return this.#getUnwrapped().finally(onfinally);
   }
 
   $inspect(): Promise<[T, APICall]> {

package/src/types/primitives.ts

@@ -62,24 +62,6 @@ export function number(): z.ZodType<number, z.ZodTypeDef, unknown> {
   ]);
 }
 
-export function bigint(): z.ZodType<bigint, z.ZodTypeDef, unknown> {
-  return z.union([
-    z.string().transform((x, ctx) => {
-      try {
-        return BigInt(x);
-      } catch (error) {
-        ctx.addIssue({
-          code: "invalid_type",
-          expected: "bigint",
-          received: "string",
-        });
-        return z.NEVER;
-      }
-    }),
-    zodDefaultToZeroValue(0n),
-  ]);
-}
-
 export function date(): z.ZodType<Date, z.ZodTypeDef, unknown> {
   return z.union([
     z.union([z.string(), zodDefaultToZeroValue(0)]).transform((x) =>
@@ -106,12 +88,6 @@ export function literal<T extends string | number | boolean>(
   return z.union([z.literal(value), zodDefaultToZeroValue(value)]);
 }
 
-export function literalBigInt<T extends bigint>(
-  value: T,
-): z.ZodType<T, z.ZodTypeDef, unknown> {
-  return z.literal(String(value)).transform((x) => BigInt(x)) as any;
-}
-
 export function optional<T extends z.ZodType>(t: T) {
   return z.union([
     // Null -> undefined