@greensecurity/javascript-sdk 0.43.1 → 0.44.0-beta.10

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

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsVendorsExport } from "../funcs/vendorsVendorsExport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type VendorsVendorsExportQueryData =
+  operations.VendorsExportResponseBody;
+
+export function prefetchVendorsVendorsExport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.VendorsExportRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsVendorsExportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildVendorsVendorsExportQuery(
+  client$: GreenSecurityCore,
+  request: operations.VendorsExportRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsVendorsExportQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsVendorsExport({
+      companyNameLike: request.companyNameLike,
+      firstNameLike: request.firstNameLike,
+      lastNameLike: request.lastNameLike,
+      fullNameLike: request.fullNameLike,
+      emailLike: request.emailLike,
+      phoneLike: request.phoneLike,
+      addressLike: request.addressLike,
+      address2Like: request.address2Like,
+      cityLike: request.cityLike,
+      stateLike: request.stateLike,
+      zipLike: request.zipLike,
+      status: request.status,
+      companyId: request.companyId,
+      credentialingSubscriptionIdNull: request.credentialingSubscriptionIdNull,
+      scrubsSubscriptionIdNull: request.scrubsSubscriptionIdNull,
+      credentialingSubscriptionStatus: request.credentialingSubscriptionStatus,
+      scrubsSubscriptionStatus: request.scrubsSubscriptionStatus,
+      vendorTypeLike: request.vendorTypeLike,
+      vendorFieldValueLike: request.vendorFieldValueLike,
+      dateScannedGte: request.dateScannedGte,
+      dateScannedLte: request.dateScannedLte,
+      dateEndsGte: request.dateEndsGte,
+      dateEndsLte: request.dateEndsLte,
+      sort: request.sort,
+      desc: request.desc,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function vendorsVendorsExportQueryFn(
+      ctx,
+    ): Promise<VendorsVendorsExportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsVendorsExport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyVendorsVendorsExport(
+  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;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "vendorsExport",
+    parameters,
+  ];
+}

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/react-query/webhooksGetWebhookEndpoint.core.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: e6483b118ca9
  */
 
 import {

package/src/react-query/webhooksGetWebhookEndpoint.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: d3c7bf56af7d
  */
 
 import {

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

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: e447d8f6578e
  */
 
 import {

package/src/react-query/webhooksListAllWebhookEndpoints.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: cfc460f51964
  */
 
 import {

package/src/react-query/webhooksUpdatesTheWebhookEndpointWithTheGivenId.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: e2294bbe4dd9
  */
 
 import {

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

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: cd07c6e6de76
  */
 
 import {

package/src/react-query/zonesGetSecurityZone.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: fb0c2763eed7
  */
 
 import {

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

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: c9208ebe7bfe
  */
 
 import {

package/src/react-query/zonesListOrSearchSecurityZones.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 0e7e750d4640
  */
 
 import {

package/src/react-query/zonesSecurityZoneCheckin.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 3c20a02b7490
  */
 
 import {

package/src/sdk/alerts.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 15cd78f1b670
  */
 
 import { alertsListAlerts } from "../funcs/alertsListAlerts.js";

package/src/sdk/companies.ts

@@ -1,10 +1,11 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: a3b41ac0cc1b
  */
 
 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";
@@ -113,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/datarequests.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: fe09c2429176
  */
 
 import { dataRequestsAddDataRequestFile } from "../funcs/dataRequestsAddDataRequestFile.js";

package/src/sdk/events.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: abe84150ba66
  */
 
 import { eventsAcceptInvitation } from "../funcs/eventsAcceptInvitation.js";

package/src/sdk/fhirconfigs.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 8b1d649ffe34
  */
 
 import { fhirConfigsCreateAFhirConfig } from "../funcs/fhirConfigsCreateAFhirConfig.js";

package/src/sdk/index.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 1b67a268bf09
  */
 
 export * from "./sdk.js";

package/src/sdk/invoices.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: ea948a122c6d
  */
 
 import { invoicesCreateInvoice } from "../funcs/invoicesCreateInvoice.js";

package/src/sdk/lookups.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: dbd41af78da6
  */
 
 import { lookupsListLookupSystems } from "../funcs/lookupsListLookupSystems.js";

package/src/sdk/mobiledevices.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 302f829fc2a6
  */
 
 import { mobileDevicesAddMobileDevice } from "../funcs/mobileDevicesAddMobileDevice.js";

package/src/sdk/organizations.ts

@@ -1,9 +1,11 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 90407ec49f20
  */
 
+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";
@@ -82,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/paymentprofile.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: c9415d097806
  */
 
 import { paymentProfileDeletePaymentProfile } from "../funcs/paymentProfileDeletePaymentProfile.js";

package/src/sdk/sdk.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 939bd094c742
  */
 
 import { ClientSDK } from "../lib/sdks.js";

package/src/sdk/supportarticles.ts

@@ -1,6 +1,5 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: b6969e31416b
  */
 
 import { supportArticlesGetSupportArticle } from "../funcs/supportArticlesGetSupportArticle.js";