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

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. Null when returned via `include_potential_targets=true` for a facility not yet targeted by the company.
+   */
+  id: number | null;
+  /**
+   * 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.nullable(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/emailpreferences.ts

@@ -11,30 +11,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Who receives vendor-related notification emails:
- *
- * @remarks
- * - `none` — no recipients
- * - `self` — the user (vendor) themselves
- * - `company_manager` — the vendor's company manager only
- * - `self_and_company_manager` — both
- */
 export const NotificationRecipients = {
   None: "none",
   Self: "self",
   CompanyManager: "company_manager",
   SelfAndCompanyManager: "self_and_company_manager",
 } as const;
-/**
- * Who receives vendor-related notification emails:
- *
- * @remarks
- * - `none` — no recipients
- * - `self` — the user (vendor) themselves
- * - `company_manager` — the vendor's company manager only
- * - `self_and_company_manager` — both
- */
 export type NotificationRecipients = OpenEnum<typeof NotificationRecipients>;
 
 /**

package/src/models/components/expand.ts

@@ -10,9 +10,12 @@ import { ClosedEnum } from "../../types/enums.js";
  */
 export const Expand = {
   User: "user",
+  UserEmailPreferences: "user.email_preferences",
+  UserPaymentProfile: "user.payment_profile",
   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",
@@ -103,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/paymentprofile.ts

@@ -10,11 +10,11 @@ import * as types from "../../types/primitives.js";
 import { smartUnion } from "../../types/smartUnion.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type Two2 = {};
+export type PaymentProfile22 = {};
 
-export type PaymentProfile2 = number | Two2;
+export type PaymentProfile2 = number | PaymentProfile22;
 
-export type PaymentProfile1 = {
+export type PaymentProfile3 = {
   id?: number | undefined;
   isValid?: boolean | null | undefined;
   cardType?: string | null | undefined;
@@ -26,19 +26,22 @@ export type PaymentProfile1 = {
 /**
  * Reduced list of attributes of the Payment Profile record
  */
-export type PaymentProfile = PaymentProfile1 | number | Two2;
+export type PaymentProfile = PaymentProfile3 | number | PaymentProfile22;
 
 /** @internal */
-export const Two2$inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown> = z
-  .object({});
+export const PaymentProfile22$inboundSchema: z.ZodType<
+  PaymentProfile22,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
 
-export function two2FromJSON(
+export function paymentProfile22FromJSON(
   jsonString: string,
-): SafeParseResult<Two2, SDKValidationError> {
+): SafeParseResult<PaymentProfile22, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Two2$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Two2' from JSON`,
+    (x) => PaymentProfile22$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile22' from JSON`,
   );
 }
 
@@ -47,7 +50,7 @@ export const PaymentProfile2$inboundSchema: z.ZodType<
   PaymentProfile2,
   z.ZodTypeDef,
   unknown
-> = smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]);
+> = smartUnion([types.number(), z.lazy(() => PaymentProfile22$inboundSchema)]);
 
 export function paymentProfile2FromJSON(
   jsonString: string,
@@ -60,8 +63,8 @@ export function paymentProfile2FromJSON(
 }
 
 /** @internal */
-export const PaymentProfile1$inboundSchema: z.ZodType<
-  PaymentProfile1,
+export const PaymentProfile3$inboundSchema: z.ZodType<
+  PaymentProfile3,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -81,13 +84,13 @@ export const PaymentProfile1$inboundSchema: z.ZodType<
   });
 });
 
-export function paymentProfile1FromJSON(
+export function paymentProfile3FromJSON(
   jsonString: string,
-): SafeParseResult<PaymentProfile1, SDKValidationError> {
+): SafeParseResult<PaymentProfile3, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => PaymentProfile1$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentProfile1' from JSON`,
+    (x) => PaymentProfile3$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile3' from JSON`,
   );
 }
 
@@ -97,8 +100,8 @@ export const PaymentProfile$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = smartUnion([
-  z.lazy(() => PaymentProfile1$inboundSchema),
-  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+  z.lazy(() => PaymentProfile3$inboundSchema),
+  smartUnion([types.number(), z.lazy(() => PaymentProfile22$inboundSchema)]),
 ]);
 
 export function paymentProfileFromJSON(

package/src/models/components/userdetails.ts

@@ -9,6 +9,7 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } 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";
 import {
   EmailPreferences,
@@ -36,6 +37,24 @@ export const UserType = {
  */
 export type UserType = OpenEnum<typeof UserType>;
 
+export type Two2 = {};
+
+export type Two = number | Two2;
+
+export type PaymentProfile1 = {
+  id?: number | undefined;
+  isValid?: boolean | null | undefined;
+  cardType?: string | null | undefined;
+  cardLast4?: string | null | undefined;
+  isDummy?: boolean | null | undefined;
+  profileType?: string | null | undefined;
+};
+
+/**
+ * Reduced list of attributes of the Payment Profile record
+ */
+export type UserDetailsPaymentProfile = PaymentProfile1 | number | Two2;
+
 /**
  * Core user profile fields returned by user detail and update endpoints.
  */
@@ -90,6 +109,16 @@ export type UserDetails = {
    * the migration window but are deprecated.
    */
   emailPreferences?: EmailPreferences | undefined;
+  /**
+   * The user's payment profile. Returned only when the request
+   *
+   * @remarks
+   * includes `expand=user.payment_profile` on `GET /users/me`.
+   * When expanded, this property is `null` if the user has no
+   * payment profile on file, or a populated `PaymentProfile`
+   * object if one exists. When not expanded, this property is omitted.
+   */
+  paymentProfile?: PaymentProfile1 | number | Two2 | null | undefined;
 };
 
 /** @internal */
@@ -99,6 +128,86 @@ export const UserType$inboundSchema: z.ZodType<
   unknown
 > = openEnums.inboundSchema(UserType);
 
+/** @internal */
+export const Two2$inboundSchema: z.ZodType<Two2, z.ZodTypeDef, unknown> = z
+  .object({});
+
+export function two2FromJSON(
+  jsonString: string,
+): SafeParseResult<Two2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two2' from JSON`,
+  );
+}
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> =
+  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]);
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaymentProfile1$inboundSchema: z.ZodType<
+  PaymentProfile1,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  is_valid: z.nullable(types.boolean()).optional(),
+  card_type: z.nullable(types.string()).optional(),
+  card_last4: z.nullable(types.string()).optional(),
+  is_dummy: z.nullable(types.boolean()).optional(),
+  profile_type: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "is_valid": "isValid",
+    "card_type": "cardType",
+    "card_last4": "cardLast4",
+    "is_dummy": "isDummy",
+    "profile_type": "profileType",
+  });
+});
+
+export function paymentProfile1FromJSON(
+  jsonString: string,
+): SafeParseResult<PaymentProfile1, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PaymentProfile1$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaymentProfile1' from JSON`,
+  );
+}
+
+/** @internal */
+export const UserDetailsPaymentProfile$inboundSchema: z.ZodType<
+  UserDetailsPaymentProfile,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([
+  z.lazy(() => PaymentProfile1$inboundSchema),
+  smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+]);
+
+export function userDetailsPaymentProfileFromJSON(
+  jsonString: string,
+): SafeParseResult<UserDetailsPaymentProfile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserDetailsPaymentProfile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserDetailsPaymentProfile' from JSON`,
+  );
+}
+
 /** @internal */
 export const UserDetails$inboundSchema: z.ZodType<
   UserDetails,
@@ -119,6 +228,12 @@ export const UserDetails$inboundSchema: z.ZodType<
   image_urls: z.nullable(ImageSet$inboundSchema).optional(),
   location: z.nullable(UserLocation$inboundSchema).optional(),
   email_preferences: types.optional(EmailPreferences$inboundSchema),
+  payment_profile: z.nullable(
+    smartUnion([
+      z.lazy(() => PaymentProfile1$inboundSchema),
+      smartUnion([types.number(), z.lazy(() => Two2$inboundSchema)]),
+    ]),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
@@ -129,6 +244,7 @@ export const UserDetails$inboundSchema: z.ZodType<
     "user_type": "userType",
     "image_urls": "imageUrls",
     "email_preferences": "emailPreferences",
+    "payment_profile": "paymentProfile",
   });
 });
 

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",