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

package/src/funcs/organizationsGetFacilityVendorsExportStatus.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get facility vendors export status
+ *
+ * @remarks
+ * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
+ * the export is complete and can be downloaded via the download endpoint.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function organizationsGetFacilityVendorsExportStatus(
+  client: GreenSecurityCore,
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.CsvExportStatusResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetFacilityVendorsExportStatusRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.CsvExportStatusResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetFacilityVendorsExportStatusRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    export_id: encodeSimple("export_id", payload.export_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/facilities/{id}/vendors/export/status/{export_id}")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getFacilityVendorsExportStatus",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.CsvExportStatusResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.CsvExportStatusResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.43.5",
-  sdkVersion: "0.44.0-beta.18",
+  sdkVersion: "0.44.0-beta.19",
   genVersion: "2.900.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.18 2.900.1 0.43.5 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.19 2.900.1 0.43.5 @greensecurity/javascript-sdk",
 } as const;

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/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";