@greensecurity/javascript-sdk 0.44.0-beta.17 → 0.44.0-beta.19

package/src/lib/sdks.ts

@@ -133,27 +133,55 @@ export class ClientSDK {
     if (path) {
       baseURL.pathname = baseURL.pathname.replace(/\/+$/, "") + "/";
       reqURL = new URL(path, baseURL);
+      if (!reqURL.search && baseURL.search) {
+        reqURL.search = baseURL.search;
+      }
     } else {
       reqURL = baseURL;
     }
     reqURL.hash = "";
 
-    let finalQuery = query || "";
-
-    const secQuery: string[] = [];
-    for (const [k, v] of Object.entries(security?.queryParams || {})) {
-      const q = encodeForm(k, v, { charEncoding: "percent" });
-      if (typeof q !== "undefined") {
-        secQuery.push(q);
+    // Appends already-encoded query pairs to a query string, replacing any
+    // existing pairs with the same key so later sources take precedence.
+    const mergeQuery = (current: string, additions: string): string => {
+      if (!additions) {
+        return current;
       }
-    }
-    if (secQuery.length) {
-      finalQuery += `&${secQuery.join("&")}`;
-    }
+      const additionKeys = new Set(
+        additions
+          .split("&")
+          .filter((pair) => pair !== "")
+          .map((pair) => pair.split("=")[0] ?? ""),
+      );
+      const kept = current.split("&").filter((pair) => {
+        return pair !== "" && !additionKeys.has(pair.split("=")[0] ?? "");
+      });
+      return [...kept, additions].join("&");
+    };
+
+    const encodeQueryRecord = (record: Record<string, unknown>): string => {
+      return Object.entries(record)
+        .map(([k, v]) => {
+          if (v == null) {
+            return undefined;
+          }
+          const value = v;
+          return encodeForm(k, value, {
+            explode: Array.isArray(value),
+            charEncoding: "percent",
+          });
+        })
+        .filter((pair): pair is string => typeof pair !== "undefined")
+        .join("&");
+    };
+
+    const finalQuery = [
+      query || "",
+      encodeQueryRecord(security?.queryParams || {}),
+    ].reduce(mergeQuery, reqURL.search.slice(1));
 
     if (finalQuery) {
-      const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery;
-      reqURL.search = `?${q}`;
+      reqURL.search = `?${finalQuery}`;
     }
 
     const headers = new Headers(opHeaders);

package/src/models/components/csvexportstatusresponse.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Returned when polling the status of an asynchronous CSV export job. When `ready` is true,
+ *
+ * @remarks
+ * the export is complete and can be downloaded via the URL in `download_url`.
+ */
+export type CsvExportStatusResponse = {
+  /**
+   * When true, the export is ready for download.
+   */
+  ready: boolean;
+  /**
+   * The export job identifier.
+   */
+  statusId: string;
+  /**
+   * URL to download the CSV (present only when `ready` is true).
+   */
+  downloadUrl?: string | undefined;
+  /**
+   * When the export job completed.
+   */
+  finishedAt?: string | undefined;
+  /**
+   * When the export job started.
+   */
+  startedAt?: string | undefined;
+  /**
+   * Timestamp of the last progress heartbeat from the background job. Updated on each pagination loop while the job is running; on completion or failure it equals `finished_at`.
+   */
+  heartbeat?: string | undefined;
+  /**
+   * Error message if the export failed.
+   */
+  error?: string | undefined;
+};
+
+/** @internal */
+export const CsvExportStatusResponse$inboundSchema: z.ZodType<
+  CsvExportStatusResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ready: types.boolean(),
+  status_id: types.string(),
+  download_url: types.optional(types.string()),
+  finished_at: types.optional(types.string()),
+  started_at: types.optional(types.string()),
+  heartbeat: types.optional(types.string()),
+  error: types.optional(types.string()),
+}).transform((v) => {
+  return remap$(v, {
+    "status_id": "statusId",
+    "download_url": "downloadUrl",
+    "finished_at": "finishedAt",
+    "started_at": "startedAt",
+  });
+});
+
+export function csvExportStatusResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CsvExportStatusResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CsvExportStatusResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CsvExportStatusResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -20,6 +20,7 @@ export * from "./credentialdocument.js";
 export * from "./credentialstatus.js";
 export * from "./credit.js";
 export * from "./csvexportenqueuedresponse.js";
+export * from "./csvexportstatusresponse.js";
 export * from "./datarequest.js";
 export * from "./deleteapiresponse.js";
 export * from "./department.js";

package/src/models/components/productvariant.ts

@@ -10,11 +10,18 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Subscription interval of variant, if any.
+ */
 export const Recurrence = {
   Monthly: "monthly",
   Yearly: "yearly",
+  NinetyDays: "90_days",
   Once: "once",
 } as const;
+/**
+ * Subscription interval of variant, if any.
+ */
 export type Recurrence = OpenEnum<typeof Recurrence>;
 
 /**
@@ -24,6 +31,9 @@ export type ProductVariant = {
   id?: number | undefined;
   price?: number | undefined;
   title?: string | null | undefined;
+  /**
+   * Subscription interval of variant, if any.
+   */
   recurrence?: Recurrence | null | undefined;
 };
 

package/src/models/operations/downloadfacilityvendorsexport.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DownloadFacilityVendorsExportRequest = {
+  /**
+   * The facility whose export is being downloaded.
+   */
+  id: number;
+  /**
+   * Export id returned by the export endpoint (e.g. `fv_export_42`).
+   */
+  exportId: string;
+};
+
+/**
+ * Export is still being generated
+ */
+export type DownloadFacilityVendorsExportResponseBody = {
+  /**
+   * Always `false` when returned by this endpoint.
+   */
+  ready?: boolean | undefined;
+  /**
+   * Human-readable message about the export status.
+   */
+  message?: string | undefined;
+};
+
+export type DownloadFacilityVendorsExportResponse = {
+  headers: { [k: string]: Array<string> };
+  result?: DownloadFacilityVendorsExportResponseBody | undefined;
+};
+
+/** @internal */
+export type DownloadFacilityVendorsExportRequest$Outbound = {
+  id: number;
+  export_id: string;
+};
+
+/** @internal */
+export const DownloadFacilityVendorsExportRequest$outboundSchema: z.ZodType<
+  DownloadFacilityVendorsExportRequest$Outbound,
+  z.ZodTypeDef,
+  DownloadFacilityVendorsExportRequest
+> = z.object({
+  id: z.number().int(),
+  exportId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    exportId: "export_id",
+  });
+});
+
+export function downloadFacilityVendorsExportRequestToJSON(
+  downloadFacilityVendorsExportRequest: DownloadFacilityVendorsExportRequest,
+): string {
+  return JSON.stringify(
+    DownloadFacilityVendorsExportRequest$outboundSchema.parse(
+      downloadFacilityVendorsExportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadFacilityVendorsExportResponseBody$inboundSchema: z.ZodType<
+  DownloadFacilityVendorsExportResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ready: types.optional(types.boolean()),
+  message: types.optional(types.string()),
+});
+
+export function downloadFacilityVendorsExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadFacilityVendorsExportResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadFacilityVendorsExportResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadFacilityVendorsExportResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadFacilityVendorsExportResponse$inboundSchema: z.ZodType<
+  DownloadFacilityVendorsExportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: types.optional(
+    z.lazy(() => DownloadFacilityVendorsExportResponseBody$inboundSchema),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function downloadFacilityVendorsExportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadFacilityVendorsExportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadFacilityVendorsExportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadFacilityVendorsExportResponse' from JSON`,
+  );
+}

package/src/models/operations/exportfacilityvendors.ts

@@ -0,0 +1,206 @@
+/*
+ * 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";
+
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export const ExportFacilityVendorsQueryParamStatus = {
+  Approved: "approved",
+  Pending: "pending",
+  Denied: "denied",
+} as const;
+/**
+ * Filter rows to a single facility access status. Omit for "All".
+ */
+export type ExportFacilityVendorsQueryParamStatus = ClosedEnum<
+  typeof ExportFacilityVendorsQueryParamStatus
+>;
+
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+ */
+export const ExportFacilityVendorsQueryParamSort = {
+  Id: "id",
+  Name: "name",
+  LastName: "last_name",
+  Email: "email",
+  Status: "status",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+ */
+export type ExportFacilityVendorsQueryParamSort = ClosedEnum<
+  typeof ExportFacilityVendorsQueryParamSort
+>;
+
+export const QueryParam2 = {
+  Zero: 0,
+  One: 1,
+} as const;
+export type QueryParam2 = ClosedEnum<typeof QueryParam2>;
+
+/**
+ * Sort descending flag.
+ */
+export type QueryParamDesc = boolean | QueryParam2;
+
+export type ExportFacilityVendorsRequest = {
+  /**
+   * The facility whose vendors to export.
+   */
+  id: number;
+  /**
+   * API users only — the company whose vendors to export. Ignored for company managers / vendors (resolved from the session).
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter rows to a single facility access status. Omit for "All".
+   */
+  status?: ExportFacilityVendorsQueryParamStatus | undefined;
+  /**
+   * Single search term applied case-insensitively across first name, last name, full
+   *
+   * @remarks
+   * name, email, and any company custom-field value the vendor has set for a field
+   * flagged `show_to_vendor`.
+   */
+  search?: string | undefined;
+  /**
+   * Sort field used by the exporter when ordering rows in the CSV. Defaults to `name`.
+   */
+  sort?: ExportFacilityVendorsQueryParamSort | undefined;
+  /**
+   * Sort descending flag.
+   */
+  desc?: boolean | QueryParam2 | undefined;
+  /**
+   * Page size used by the exporter while paginating results server-side. Does not affect the size of the CSV (all matching rows are included).
+   */
+  itemsPerPage?: number | undefined;
+};
+
+/**
+ * Export request accepted and job enqueued.
+ */
+export type ExportFacilityVendorsResponseBody = {
+  /**
+   * URL to poll for export status.
+   */
+  statusUrl: string;
+  /**
+   * URL to download the exported file when ready.
+   */
+  downloadUrl: string;
+  /**
+   * Status token used to check the export status.
+   */
+  statusId: string;
+};
+
+/** @internal */
+export const ExportFacilityVendorsQueryParamStatus$outboundSchema:
+  z.ZodNativeEnum<typeof ExportFacilityVendorsQueryParamStatus> = z.nativeEnum(
+    ExportFacilityVendorsQueryParamStatus,
+  );
+
+/** @internal */
+export const ExportFacilityVendorsQueryParamSort$outboundSchema:
+  z.ZodNativeEnum<typeof ExportFacilityVendorsQueryParamSort> = z.nativeEnum(
+    ExportFacilityVendorsQueryParamSort,
+  );
+
+/** @internal */
+export const QueryParam2$outboundSchema: z.ZodNativeEnum<typeof QueryParam2> = z
+  .nativeEnum(QueryParam2);
+
+/** @internal */
+export type QueryParamDesc$Outbound = boolean | number;
+
+/** @internal */
+export const QueryParamDesc$outboundSchema: z.ZodType<
+  QueryParamDesc$Outbound,
+  z.ZodTypeDef,
+  QueryParamDesc
+> = smartUnion([z.boolean(), QueryParam2$outboundSchema]);
+
+export function queryParamDescToJSON(queryParamDesc: QueryParamDesc): string {
+  return JSON.stringify(QueryParamDesc$outboundSchema.parse(queryParamDesc));
+}
+
+/** @internal */
+export type ExportFacilityVendorsRequest$Outbound = {
+  id: number;
+  company_id?: number | undefined;
+  status?: string | undefined;
+  search?: string | undefined;
+  sort?: string | undefined;
+  desc?: boolean | number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ExportFacilityVendorsRequest$outboundSchema: z.ZodType<
+  ExportFacilityVendorsRequest$Outbound,
+  z.ZodTypeDef,
+  ExportFacilityVendorsRequest
+> = z.object({
+  id: z.number().int(),
+  companyId: z.number().int().optional(),
+  status: ExportFacilityVendorsQueryParamStatus$outboundSchema.optional(),
+  search: z.string().optional(),
+  sort: ExportFacilityVendorsQueryParamSort$outboundSchema.optional(),
+  desc: smartUnion([z.boolean(), QueryParam2$outboundSchema]).optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function exportFacilityVendorsRequestToJSON(
+  exportFacilityVendorsRequest: ExportFacilityVendorsRequest,
+): string {
+  return JSON.stringify(
+    ExportFacilityVendorsRequest$outboundSchema.parse(
+      exportFacilityVendorsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ExportFacilityVendorsResponseBody$inboundSchema: z.ZodType<
+  ExportFacilityVendorsResponseBody,
+  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 exportFacilityVendorsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ExportFacilityVendorsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExportFacilityVendorsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExportFacilityVendorsResponseBody' from JSON`,
+  );
+}

package/src/models/operations/getfacilityvendorsexportstatus.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetFacilityVendorsExportStatusRequest = {
+  /**
+   * The facility whose export is being polled.
+   */
+  id: number;
+  /**
+   * Export status id returned by the export endpoint (e.g. `fv_export_42`).
+   */
+  exportId: string;
+};
+
+/** @internal */
+export type GetFacilityVendorsExportStatusRequest$Outbound = {
+  id: number;
+  export_id: string;
+};
+
+/** @internal */
+export const GetFacilityVendorsExportStatusRequest$outboundSchema: z.ZodType<
+  GetFacilityVendorsExportStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetFacilityVendorsExportStatusRequest
+> = z.object({
+  id: z.number().int(),
+  exportId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    exportId: "export_id",
+  });
+});
+
+export function getFacilityVendorsExportStatusRequestToJSON(
+  getFacilityVendorsExportStatusRequest: GetFacilityVendorsExportStatusRequest,
+): string {
+  return JSON.stringify(
+    GetFacilityVendorsExportStatusRequest$outboundSchema.parse(
+      getFacilityVendorsExportStatusRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -34,17 +34,20 @@ export * from "./deletepaymentprofile.js";
 export * from "./deletevendorcredentialfile.js";
 export * from "./deletevendormanagedbycompany.js";
 export * from "./downloadcompanytargetfacilitiesexport.js";
+export * from "./downloadfacilityvendorsexport.js";
 export * from "./downloadinvoicesexport.js";
 export * from "./downloadvendorscansexport.js";
 export * from "./downloadvendorsexport.js";
 export * from "./expeditetimeremaining.js";
 export * from "./exportcompanytargetfacilities.js";
+export * from "./exportfacilityvendors.js";
 export * from "./exportvendorscans.js";
 export * from "./getcompany.js";
 export * from "./getcompanytargetfacilitiesexportstatus.js";
 export * from "./getcurrentuser.js";
 export * from "./getevent.js";
 export * from "./getfacility.js";
+export * from "./getfacilityvendorsexportstatus.js";
 export * from "./getfhirconfig.js";
 export * from "./getinvoice.js";
 export * from "./getinvoicesexportstatus.js";

package/src/react-query/index.ts

@@ -46,9 +46,12 @@ export * from "./mobileDevicesAddMobileDevice.js";
 export * from "./organizationsCreateCompanyTargetFacility.js";
 export * from "./organizationsDeleteCompanyTargetFacility.js";
 export * from "./organizationsDownloadCompanyTargetFacilitiesExport.js";
+export * from "./organizationsDownloadFacilityVendorsExport.js";
 export * from "./organizationsExportCompanyTargetFacilities.js";
+export * from "./organizationsExportFacilityVendors.js";
 export * from "./organizationsGetCompanyTargetFacilitiesExportStatus.js";
 export * from "./organizationsGetFacility.js";
+export * from "./organizationsGetFacilityVendorsExportStatus.js";
 export * from "./organizationsListCompanyTargetFacilities.js";
 export * from "./organizationsListFacilityVendors.js";
 export * from "./organizationsListOrSearchDepartmentContacts.js";

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

@@ -0,0 +1,84 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { organizationsDownloadFacilityVendorsExport } from "../funcs/organizationsDownloadFacilityVendorsExport.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 OrganizationsDownloadFacilityVendorsExportQueryData =
+  | operations.DownloadFacilityVendorsExportResponse
+  | undefined;
+
+export function prefetchOrganizationsDownloadFacilityVendorsExport(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.DownloadFacilityVendorsExportRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildOrganizationsDownloadFacilityVendorsExportQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildOrganizationsDownloadFacilityVendorsExportQuery(
+  client$: GreenSecurityCore,
+  request: operations.DownloadFacilityVendorsExportRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<OrganizationsDownloadFacilityVendorsExportQueryData>;
+} {
+  return {
+    queryKey: queryKeyOrganizationsDownloadFacilityVendorsExport(
+      request.id,
+      request.exportId,
+    ),
+    queryFn: async function organizationsDownloadFacilityVendorsExportQueryFn(
+      ctx,
+    ): Promise<OrganizationsDownloadFacilityVendorsExportQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(organizationsDownloadFacilityVendorsExport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyOrganizationsDownloadFacilityVendorsExport(
+  id: number,
+  exportId: string,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "organizations",
+    "downloadFacilityVendorsExport",
+    id,
+    exportId,
+  ];
+}