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

package/src/funcs/vendorsVendorsExport.ts

@@ -11,6 +11,7 @@ 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,
@@ -43,7 +44,7 @@ export function vendorsVendorsExport(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.VendorsExportResponseBody,
+    components.CsvExportEnqueuedResponse,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -69,7 +70,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.VendorsExportResponseBody,
+      components.CsvExportEnqueuedResponse,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -183,7 +184,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.VendorsExportResponseBody,
+    components.CsvExportEnqueuedResponse,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -194,7 +195,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.VendorsExportResponseBody$inboundSchema),
+    M.json(200, components.CsvExportEnqueuedResponse$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),

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.1",
-  sdkVersion: "0.44.0-beta.11",
+  sdkVersion: "0.44.0-beta.12",
   genVersion: "2.893.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.11 2.893.0 0.43.1 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.12 2.893.0 0.43.1 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/csvexportenqueuedresponse.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 an asynchronous CSV export job is enqueued. Poll `status_url` until the export is ready,
+ *
+ * @remarks
+ * then retrieve the file from `download_url`.
+ */
+export type CsvExportEnqueuedResponse = {
+  /**
+   * URL to poll for the status of the export job.
+   */
+  statusUrl: string;
+  /**
+   * URL to download the exported CSV file once the job is ready.
+   */
+  downloadUrl: string;
+  /**
+   * Token identifying the export job, used to check its status.
+   */
+  statusId: string;
+};
+
+/** @internal */
+export const CsvExportEnqueuedResponse$inboundSchema: z.ZodType<
+  CsvExportEnqueuedResponse,
+  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 csvExportEnqueuedResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CsvExportEnqueuedResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CsvExportEnqueuedResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CsvExportEnqueuedResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -10,7 +10,6 @@ export * from "./company.js";
 export * from "./companycredentiallistitem.js";
 export * from "./companylookup.js";
 export * from "./companymanager.js";
-export * from "./companytargetfacility.js";
 export * from "./companyvendorfield.js";
 export * from "./companyvendortyperestriction.js";
 export * from "./contact.js";
@@ -19,6 +18,7 @@ export * from "./credential.js";
 export * from "./credentialdocument.js";
 export * from "./credentialstatus.js";
 export * from "./credit.js";
+export * from "./csvexportenqueuedresponse.js";
 export * from "./datarequest.js";
 export * from "./deleteapiresponse.js";
 export * from "./department.js";

package/src/models/operations/downloadcompanytargetfacilitiesexport.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 DownloadCompanyTargetFacilitiesExportRequest = {
+  /**
+   * The company whose export is being downloaded.
+   */
+  companyId: number;
+  /**
+   * Export id returned by the export endpoint (e.g. `ctf_export_42`).
+   */
+  id: string;
+};
+
+/**
+ * Export is still being generated
+ */
+export type DownloadCompanyTargetFacilitiesExportResponseBody = {
+  /**
+   * Always `false` when returned by this endpoint.
+   */
+  ready?: boolean | undefined;
+  /**
+   * Human-readable message about the export status.
+   */
+  message?: string | undefined;
+};
+
+export type DownloadCompanyTargetFacilitiesExportResponse = {
+  headers: { [k: string]: Array<string> };
+  result?: DownloadCompanyTargetFacilitiesExportResponseBody | undefined;
+};
+
+/** @internal */
+export type DownloadCompanyTargetFacilitiesExportRequest$Outbound = {
+  company_id: number;
+  id: string;
+};
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportRequest$outboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportRequest$Outbound,
+    z.ZodTypeDef,
+    DownloadCompanyTargetFacilitiesExportRequest
+  > = z.object({
+    companyId: z.number().int(),
+    id: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      companyId: "company_id",
+    });
+  });
+
+export function downloadCompanyTargetFacilitiesExportRequestToJSON(
+  downloadCompanyTargetFacilitiesExportRequest:
+    DownloadCompanyTargetFacilitiesExportRequest,
+): string {
+  return JSON.stringify(
+    DownloadCompanyTargetFacilitiesExportRequest$outboundSchema.parse(
+      downloadCompanyTargetFacilitiesExportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    ready: types.optional(types.boolean()),
+    message: types.optional(types.string()),
+  });
+
+export function downloadCompanyTargetFacilitiesExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadCompanyTargetFacilitiesExportResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadCompanyTargetFacilitiesExportResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadCompanyTargetFacilitiesExportResponse$inboundSchema:
+  z.ZodType<
+    DownloadCompanyTargetFacilitiesExportResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())).default({}),
+    Result: types.optional(
+      z.lazy(() =>
+        DownloadCompanyTargetFacilitiesExportResponseBody$inboundSchema
+      ),
+    ),
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+export function downloadCompanyTargetFacilitiesExportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadCompanyTargetFacilitiesExportResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadCompanyTargetFacilitiesExportResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadCompanyTargetFacilitiesExportResponse' from JSON`,
+  );
+}

package/src/models/operations/downloadvendorscansexport.ts

@@ -0,0 +1,145 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type DownloadVendorScansExportRequest = {
+  /**
+   * Export id returned by the export vendor scans endpoint.
+   */
+  id: string;
+};
+
+/**
+ * Export is still being generated
+ */
+export type DownloadVendorScansExportResponseBody = {
+  /**
+   * Always `false` when returned by this endpoint.
+   */
+  ready?: boolean | undefined;
+  /**
+   * Human-readable message about the export status.
+   */
+  message?: string | undefined;
+};
+
+export type DownloadVendorScansExportResponseResult =
+  | ReadableStream<Uint8Array>
+  | DownloadVendorScansExportResponseBody;
+
+export type DownloadVendorScansExportResponse = {
+  headers: { [k: string]: Array<string> };
+  result?:
+    | ReadableStream<Uint8Array>
+    | DownloadVendorScansExportResponseBody
+    | undefined;
+};
+
+/** @internal */
+export type DownloadVendorScansExportRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DownloadVendorScansExportRequest$outboundSchema: z.ZodType<
+  DownloadVendorScansExportRequest$Outbound,
+  z.ZodTypeDef,
+  DownloadVendorScansExportRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function downloadVendorScansExportRequestToJSON(
+  downloadVendorScansExportRequest: DownloadVendorScansExportRequest,
+): string {
+  return JSON.stringify(
+    DownloadVendorScansExportRequest$outboundSchema.parse(
+      downloadVendorScansExportRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadVendorScansExportResponseBody$inboundSchema: z.ZodType<
+  DownloadVendorScansExportResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  ready: types.optional(types.boolean()),
+  message: types.optional(types.string()),
+});
+
+export function downloadVendorScansExportResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadVendorScansExportResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadVendorScansExportResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadVendorScansExportResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadVendorScansExportResponseResult$inboundSchema: z.ZodType<
+  DownloadVendorScansExportResponseResult,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.lazy(() => DownloadVendorScansExportResponseBody$inboundSchema),
+]);
+
+export function downloadVendorScansExportResponseResultFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  DownloadVendorScansExportResponseResult,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      DownloadVendorScansExportResponseResult$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'DownloadVendorScansExportResponseResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadVendorScansExportResponse$inboundSchema: z.ZodType<
+  DownloadVendorScansExportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: types.optional(
+    smartUnion([
+      z.instanceof(ReadableStream<Uint8Array>),
+      z.lazy(() => DownloadVendorScansExportResponseBody$inboundSchema),
+    ]),
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function downloadVendorScansExportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadVendorScansExportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DownloadVendorScansExportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadVendorScansExportResponse' from JSON`,
+  );
+}

package/src/models/operations/exportcompanytargetfacilities.ts

@@ -0,0 +1,242 @@
+/*
+ * 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 by link status.
+ */
+export const QueryParamStatus = {
+  Pending: "pending",
+  Approved: "approved",
+  Denied: "denied",
+} as const;
+/**
+ * Filter by link status.
+ */
+export type QueryParamStatus = ClosedEnum<typeof QueryParamStatus>;
+
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export const HasIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+ */
+export type HasIndividual = ClosedEnum<typeof HasIndividual>;
+
+/**
+ * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+ */
+export const HasActiveIndividual = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+ */
+export type HasActiveIndividual = ClosedEnum<typeof HasActiveIndividual>;
+
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+ */
+export const QueryParamSort = {
+  Id: "id",
+  FacilityName: "facility_name",
+  Status: "status",
+  DateCreated: "date_created",
+} as const;
+/**
+ * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+ */
+export type QueryParamSort = ClosedEnum<typeof QueryParamSort>;
+
+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 ExportCompanyTargetFacilitiesRequest = {
+  /**
+   * The company whose target facilities to export.
+   */
+  companyId: number;
+  /**
+   * Filter by link status.
+   */
+  status?: QueryParamStatus | undefined;
+  /**
+   * `true` returns only facilities the company has at least one individual targeting; `false` returns only those with none.
+   */
+  hasIndividual?: HasIndividual | undefined;
+  /**
+   * `true` returns only facilities the company has at least one *active* individual targeting (active = vendor's credentialing subscription is active); `false` returns only those with none.
+   */
+  hasActiveIndividual?: HasActiveIndividual | undefined;
+  /**
+   * Case-insensitive partial match on facility name.
+   */
+  facilityNameLike?: string | undefined;
+  /**
+   * Sort field used by the exporter when ordering rows in the CSV. Defaults to `facility_name`.
+   */
+  sort?: QueryParamSort | undefined;
+  /**
+   * Sort descending flag.
+   */
+  desc?: boolean | Two | 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 ExportCompanyTargetFacilitiesResponseBody = {
+  /**
+   * 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 QueryParamStatus$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamStatus
+> = z.nativeEnum(QueryParamStatus);
+
+/** @internal */
+export const HasIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof HasIndividual
+> = z.nativeEnum(HasIndividual);
+
+/** @internal */
+export const HasActiveIndividual$outboundSchema: z.ZodNativeEnum<
+  typeof HasActiveIndividual
+> = z.nativeEnum(HasActiveIndividual);
+
+/** @internal */
+export const QueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamSort
+> = z.nativeEnum(QueryParamSort);
+
+/** @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 ExportCompanyTargetFacilitiesRequest$Outbound = {
+  company_id: number;
+  status?: string | undefined;
+  has_individual?: string | undefined;
+  has_active_individual?: string | undefined;
+  facility_name_like?: string | undefined;
+  sort?: string | undefined;
+  desc?: boolean | number | undefined;
+  items_per_page?: number | undefined;
+};
+
+/** @internal */
+export const ExportCompanyTargetFacilitiesRequest$outboundSchema: z.ZodType<
+  ExportCompanyTargetFacilitiesRequest$Outbound,
+  z.ZodTypeDef,
+  ExportCompanyTargetFacilitiesRequest
+> = z.object({
+  companyId: z.number().int(),
+  status: QueryParamStatus$outboundSchema.optional(),
+  hasIndividual: HasIndividual$outboundSchema.optional(),
+  hasActiveIndividual: HasActiveIndividual$outboundSchema.optional(),
+  facilityNameLike: z.string().optional(),
+  sort: QueryParamSort$outboundSchema.optional(),
+  desc: smartUnion([z.boolean(), Two$outboundSchema]).optional(),
+  itemsPerPage: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    companyId: "company_id",
+    hasIndividual: "has_individual",
+    hasActiveIndividual: "has_active_individual",
+    facilityNameLike: "facility_name_like",
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function exportCompanyTargetFacilitiesRequestToJSON(
+  exportCompanyTargetFacilitiesRequest: ExportCompanyTargetFacilitiesRequest,
+): string {
+  return JSON.stringify(
+    ExportCompanyTargetFacilitiesRequest$outboundSchema.parse(
+      exportCompanyTargetFacilitiesRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const ExportCompanyTargetFacilitiesResponseBody$inboundSchema: z.ZodType<
+  ExportCompanyTargetFacilitiesResponseBody,
+  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 exportCompanyTargetFacilitiesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ExportCompanyTargetFacilitiesResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ExportCompanyTargetFacilitiesResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ExportCompanyTargetFacilitiesResponseBody' from JSON`,
+  );
+}