@greensecurity/javascript-sdk 0.44.0-beta.3 → 0.44.0-beta.5

package/src/funcs/vendorsVendorsExport.ts

@@ -0,0 +1,207 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } 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 { 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";
+
+/**
+ * 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`.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function vendorsVendorsExport(
+  client: GreenSecurityCore,
+  request: operations.VendorsExportRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.VendorsExportResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.VendorsExportRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.VendorsExportResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.VendorsExportRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/vendors/export")();
+
+  const query = encodeFormQuery({
+    "address_like": payload.address_like,
+    "address2_like": payload.address2_like,
+    "city_like": payload.city_like,
+    "company_id": payload.company_id,
+    "company_name_like": payload.company_name_like,
+    "credentialing_subscription_id_null":
+      payload.credentialing_subscription_id_null,
+    "credentialing_subscription_status":
+      payload.credentialing_subscription_status,
+    "date_ends_gte": payload.date_ends_gte,
+    "date_ends_lte": payload.date_ends_lte,
+    "date_scanned_gte": payload.date_scanned_gte,
+    "date_scanned_lte": payload.date_scanned_lte,
+    "desc": payload.desc,
+    "email_like": payload.email_like,
+    "expand": payload.expand,
+    "first_name_like": payload.first_name_like,
+    "full_name_like": payload.full_name_like,
+    "items_per_page": payload.items_per_page,
+    "last_name_like": payload.last_name_like,
+    "phone_like": payload.phone_like,
+    "scrubs_subscription_id_null": payload.scrubs_subscription_id_null,
+    "scrubs_subscription_status": payload.scrubs_subscription_status,
+    "sort": payload.sort,
+    "state_like": payload.state_like,
+    "status": payload.status,
+    "vendor_field_value_like": payload.vendor_field_value_like,
+    "vendor_type_like": payload.vendor_type_like,
+    "zip_like": payload.zip_like,
+  });
+
+  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: "vendorsExport",
+    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,
+    query: query,
+    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<
+    operations.VendorsExportResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.VendorsExportResponseBody$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], 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.1",
-  sdkVersion: "0.44.0-beta.3",
+  sdkVersion: "0.44.0-beta.4",
   genVersion: "2.884.7",
   userAgent:
-    "speakeasy-sdk/typescript 0.44.0-beta.3 2.884.7 0.43.1 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.44.0-beta.4 2.884.7 0.43.1 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/appointmentsummary.ts

@@ -0,0 +1,59 @@
+/*
+ * 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";
+
+/**
+ * A reduced Event object returned when the `vendor_scan.appointment` expand scope is requested.
+ */
+export type AppointmentSummary = {
+  id: number;
+  title?: string | null | undefined;
+  /**
+   * Event start datetime (ISO 8601).
+   */
+  start?: string | null | undefined;
+  /**
+   * Event end datetime (ISO 8601).
+   */
+  end?: string | null | undefined;
+  allDay?: boolean | null | undefined;
+  standingAppt?: boolean | null | undefined;
+  status?: string | null | undefined;
+};
+
+/** @internal */
+export const AppointmentSummary$inboundSchema: z.ZodType<
+  AppointmentSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  title: z.nullable(types.string()).optional(),
+  start: z.nullable(types.string()).optional(),
+  end: z.nullable(types.string()).optional(),
+  all_day: z.nullable(types.boolean()).optional(),
+  standing_appt: z.nullable(types.boolean()).optional(),
+  status: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "all_day": "allDay",
+    "standing_appt": "standingAppt",
+  });
+});
+
+export function appointmentSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<AppointmentSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AppointmentSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AppointmentSummary' from JSON`,
+  );
+}

package/src/models/components/companycredentiallistitem.ts

@@ -0,0 +1,110 @@
+/*
+ * 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";
+import {
+  VendorCredentialSummary,
+  VendorCredentialSummary$inboundSchema,
+} from "./vendorcredentialsummary.js";
+
+export type CompanyCredentialListItemCredential = {
+  id: number;
+  name: string;
+};
+
+export type VendorCredentialLast = {
+  id: number;
+  status: string;
+  version: number;
+  dateExpires?: string | null | undefined;
+};
+
+export type CompanyCredentialListItem = {
+  credential: CompanyCredentialListItemCredential;
+  /**
+   * Reduced list of attributes of Vendor Credential record
+   */
+  vendorCredential: VendorCredentialSummary | null;
+  vendorCredentialLast?: VendorCredentialLast | null | undefined;
+};
+
+/** @internal */
+export const CompanyCredentialListItemCredential$inboundSchema: z.ZodType<
+  CompanyCredentialListItemCredential,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.string(),
+});
+
+export function companyCredentialListItemCredentialFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyCredentialListItemCredential, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompanyCredentialListItemCredential$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyCredentialListItemCredential' from JSON`,
+  );
+}
+
+/** @internal */
+export const VendorCredentialLast$inboundSchema: z.ZodType<
+  VendorCredentialLast,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  status: types.string(),
+  version: types.number(),
+  date_expires: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_expires": "dateExpires",
+  });
+});
+
+export function vendorCredentialLastFromJSON(
+  jsonString: string,
+): SafeParseResult<VendorCredentialLast, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VendorCredentialLast$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VendorCredentialLast' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompanyCredentialListItem$inboundSchema: z.ZodType<
+  CompanyCredentialListItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  credential: z.lazy(() => CompanyCredentialListItemCredential$inboundSchema),
+  vendor_credential: types.nullable(VendorCredentialSummary$inboundSchema),
+  vendor_credential_last: z.nullable(
+    z.lazy(() => VendorCredentialLast$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_credential": "vendorCredential",
+    "vendor_credential_last": "vendorCredentialLast",
+  });
+});
+
+export function companyCredentialListItemFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyCredentialListItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyCredentialListItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyCredentialListItem' from JSON`,
+  );
+}

package/src/models/components/companytargetfacility.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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Facility, Facility$inboundSchema } from "./facility.js";
+
+/**
+ * The linked facility. Returns the facility ID by default; pass `company_target_facility.facility` to `expand` to receive the full facility object.
+ */
+export type CompanyTargetFacilityFacility = Facility | number;
+
+/**
+ * Per-facility counts of the company's individuals (vendors) currently targeting this facility.
+ */
+export type IndividualCounts = {
+  /**
+   * Total individuals from the company targeting this facility.
+   */
+  total?: number | undefined;
+  /**
+   * Individuals targeting this facility whose credentialing subscription is active.
+   */
+  active?: number | undefined;
+};
+
+/**
+ * Describes the facilities that a company would like to do business with. These are called "target facilities" for the company. A company may target/untarget any number of facilities which will kick off the process of becoming compliant with that facility's vendor policies.
+ */
+export type CompanyTargetFacility = {
+  /**
+   * CompanyTargetFacility row ID.
+   */
+  id: number;
+  /**
+   * The linked facility. Returns the facility ID by default; pass `company_target_facility.facility` to `expand` to receive the full facility object.
+   */
+  facility: Facility | number | null;
+  /**
+   * Link status (Approved, Pending, or Denied). This value is computed by the daily background job from the company's credential state — it is not directly settable through the API.
+   */
+  status: string | null;
+  contracted?: boolean | undefined;
+  dateCreated?: Date | null | undefined;
+  /**
+   * Per-facility counts of the company's individuals (vendors) currently targeting this facility.
+   */
+  individualCounts?: IndividualCounts | null | undefined;
+};
+
+/** @internal */
+export const CompanyTargetFacilityFacility$inboundSchema: z.ZodType<
+  CompanyTargetFacilityFacility,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([Facility$inboundSchema, types.number()]);
+
+export function companyTargetFacilityFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyTargetFacilityFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyTargetFacilityFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyTargetFacilityFacility' from JSON`,
+  );
+}
+
+/** @internal */
+export const IndividualCounts$inboundSchema: z.ZodType<
+  IndividualCounts,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  total: types.optional(types.number()),
+  active: types.optional(types.number()),
+});
+
+export function individualCountsFromJSON(
+  jsonString: string,
+): SafeParseResult<IndividualCounts, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IndividualCounts$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IndividualCounts' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompanyTargetFacility$inboundSchema: z.ZodType<
+  CompanyTargetFacility,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  facility: types.nullable(
+    smartUnion([Facility$inboundSchema, types.number()]),
+  ),
+  status: types.nullable(types.string()),
+  contracted: types.optional(types.boolean()),
+  date_created: z.nullable(types.date()).optional(),
+  individual_counts: z.nullable(z.lazy(() => IndividualCounts$inboundSchema))
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_created": "dateCreated",
+    "individual_counts": "individualCounts",
+  });
+});
+
+export function companyTargetFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyTargetFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyTargetFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyTargetFacility' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -15,6 +15,7 @@ export const Expand = {
   CompanyLocation: "company.location",
   CompanyVendorFields: "company.vendor_fields",
   CompanyVendorTypeRestrictions: "company.vendor_type_restrictions",
+  CompanyTargetFacilityFacility: "company_target_facility.facility",
   ContactFacility: "contact.facility",
   ContactSystem: "contact.system",
   ContactDepartment: "contact.department",
@@ -105,6 +106,10 @@ export const Expand = {
   VendorScanBadgeData: "vendor_scan.badge_data",
   VendorScanVendor: "vendor_scan.vendor",
   VendorScanZone: "vendor_scan.zone",
+  VendorScanDepartment: "vendor_scan.department",
+  VendorScanCompany: "vendor_scan.company",
+  VendorScanAppointment: "vendor_scan.appointment",
+  VendorScanScreeningResponses: "vendor_scan.screening_responses",
   ZoneFacility: "zone.facility",
   ZoneDepartment: "zone.department",
   ZoneRules: "zone.rules",

package/src/models/components/index.ts

@@ -4,10 +4,13 @@
 
 export * from "./activestatus.js";
 export * from "./alert.js";
+export * from "./appointmentsummary.js";
 export * from "./backgroundcheckresult.js";
 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";
@@ -87,6 +90,7 @@ export * from "./vendorrequiredcredential.js";
 export * from "./vendorscan.js";
 export * from "./vendorscanscreeninganswer.js";
 export * from "./vendorscanscreeningquestion.js";
+export * from "./vendorscanscreeningresponse.js";
 export * from "./vendorscrubdetails.js";
 export * from "./vendorscrubpurchase.js";
 export * from "./vendortype.js";

package/src/models/components/vendorcredentialsummary.ts

@@ -14,6 +14,7 @@ import {
   BackgroundCheckResult$inboundSchema,
 } from "./backgroundcheckresult.js";
 import { Company, Company$inboundSchema } from "./company.js";
+import { CompanyLookup, CompanyLookup$inboundSchema } from "./companylookup.js";
 import { Credential, Credential$inboundSchema } from "./credential.js";
 import { Invoice, Invoice$inboundSchema } from "./invoice.js";
 import { Vendor, Vendor$inboundSchema } from "./vendor.js";
@@ -109,6 +110,7 @@ export type VendorCredentialSummary = {
   totalPendingCredentials?: number | null | undefined;
   backgroundCheckProviderId?: number | null | undefined;
   requiresAdminReview?: boolean | null | undefined;
+  systems?: Array<CompanyLookup> | null | undefined;
 };
 
 /** @internal */
@@ -326,6 +328,7 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
   total_pending_credentials: z.nullable(types.number()).optional(),
   background_check_provider_id: z.nullable(types.number()).optional(),
   requires_admin_review: z.nullable(types.boolean()).optional(),
+  systems: z.nullable(z.array(CompanyLookup$inboundSchema)).optional(),
 }).transform((v) => {
   return remap$(v, {
     "date_due": "dateDue",