@greensecurity/javascript-sdk 0.43.1-beta.98 → 0.44.0-beta.1

package/src/models/components/userdetails.ts

@@ -0,0 +1,143 @@
+/*
+ * 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 * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EmailPreferences,
+  EmailPreferences$inboundSchema,
+} from "./emailpreferences.js";
+import { ImageSet, ImageSet$inboundSchema } from "./imageset.js";
+import { UserLocation, UserLocation$inboundSchema } from "./userlocation.js";
+
+/**
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions
+ */
+export const UserType = {
+  Api: "API",
+  Admin: "Admin",
+  CompanyManager: "Company Manager",
+  FacilityAdmin: "Facility Admin",
+  FacilityUser: "Facility User",
+  InventoryManager: "Inventory Manager",
+  SystemUser: "System User",
+  UserType: "User Type",
+  Vendor: "Vendor",
+} as const;
+/**
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions
+ */
+export type UserType = OpenEnum<typeof UserType>;
+
+/**
+ * Core user profile fields returned by user detail and update endpoints.
+ */
+export type UserDetails = {
+  /**
+   * This identifier is only used to reference the underlying user. Based on the `user_type` a more relevant identifier may be used to get relvant information from other endpoints.
+   */
+  id: number;
+  /**
+   * First name of the user
+   */
+  firstName?: string | null | undefined;
+  /**
+   * Last name of the user
+   */
+  lastName?: string | null | undefined;
+  /**
+   * Email address (not always valid)
+   */
+  email: string;
+  phone?: string | null | undefined;
+  mobilePhone?: string | null | undefined;
+  fax?: string | null | undefined;
+  phoneConfirmed?: boolean | undefined;
+  emailConfirmed?: boolean | undefined;
+  /**
+   * The flavor of user will determine the most relevant user experience for this user as well as permissions
+   */
+  userType: UserType;
+  /**
+   * The timezone of the user. This is used to display times in the user's local time. If not present, use the device's local timezone.
+   */
+  timezone?: string | null | undefined;
+  /**
+   * A set of images in different sizes
+   */
+  imageUrls?: ImageSet | null | undefined;
+  /**
+   * Reduced list of attributes of the User Location
+   */
+  location?: UserLocation | null | undefined;
+  /**
+   * A user's consolidated email preferences. Used by the
+   *
+   * @remarks
+   * `email_preferences` payload section on `PUT /users/:id` and returned
+   * on `GET /users/:id` / `GET /users/me` when the request includes
+   * `expand=user.email_preferences`.
+   *
+   * Replaces the legacy vendor-side fields `email_recepient` and
+   * `send_weekly_summary_email`, which remain on the Vendor object during
+   * the migration window but are deprecated.
+   */
+  emailPreferences?: EmailPreferences | undefined;
+};
+
+/** @internal */
+export const UserType$inboundSchema: z.ZodType<
+  UserType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(UserType);
+
+/** @internal */
+export const UserDetails$inboundSchema: z.ZodType<
+  UserDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  first_name: z.nullable(types.string()).optional(),
+  last_name: z.nullable(types.string()).optional(),
+  email: types.string(),
+  phone: z.nullable(types.string()).optional(),
+  mobile_phone: z.nullable(types.string()).optional(),
+  fax: z.nullable(types.string()).optional(),
+  phone_confirmed: types.optional(types.boolean()),
+  email_confirmed: types.optional(types.boolean()),
+  user_type: UserType$inboundSchema,
+  timezone: z.nullable(types.string()).optional(),
+  image_urls: z.nullable(ImageSet$inboundSchema).optional(),
+  location: z.nullable(UserLocation$inboundSchema).optional(),
+  email_preferences: types.optional(EmailPreferences$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+    "mobile_phone": "mobilePhone",
+    "phone_confirmed": "phoneConfirmed",
+    "email_confirmed": "emailConfirmed",
+    "user_type": "userType",
+    "image_urls": "imageUrls",
+    "email_preferences": "emailPreferences",
+  });
+});
+
+export function userDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<UserDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UserDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UserDetails' from JSON`,
+  );
+}

package/src/models/components/vendor.ts

@@ -22,9 +22,17 @@ import {
 } from "./facilitysummary.js";
 import { ImageSet, ImageSet$inboundSchema } from "./imageset.js";
 import { Invoice, Invoice$inboundSchema } from "./invoice.js";
+import {
+  PaymentProfile,
+  PaymentProfile$inboundSchema,
+} from "./paymentprofile.js";
 import { Subscription, Subscription$inboundSchema } from "./subscription.js";
 import { Supervisor, Supervisor$inboundSchema } from "./supervisor.js";
 import { UserLocation, UserLocation$inboundSchema } from "./userlocation.js";
+import {
+  VendorCustomFields,
+  VendorCustomFields$inboundSchema,
+} from "./vendorcustomfields.js";
 import { VendorGroup, VendorGroup$inboundSchema } from "./vendorgroup.js";
 import {
   VendorJobTitle,
@@ -34,6 +42,7 @@ import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
 
 export type Badge = {
   badgeType?: string | undefined;
+  badgeMacAddress?: string | null | undefined;
   requiredBadgeType?: string | null | undefined;
 };
 
@@ -64,32 +73,7 @@ export type VendorJob = VendorJobTitle | number;
 
 export type VendorVendorType = VendorType | number;
 
-export type Vendor22 = {};
-
-export type VendorPaymentProfile2 = number | Vendor22;
-
-export type VendorPaymentProfile1 = {
-  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 PaymentProfilePaymentProfile =
-  | VendorPaymentProfile1
-  | number
-  | Vendor22;
-
-export type VendorPaymentProfile =
-  | VendorPaymentProfile1
-  | number
-  | Vendor22
-  | number;
+export type VendorPaymentProfile = PaymentProfile | number;
 
 export type CompanySummary = {
   id: string;
@@ -125,7 +109,26 @@ export type PendingInvoice = Invoice | number;
 export type Vendor = {
   id?: number | undefined;
   badge?: Badge | null | undefined;
+  /**
+   * **Deprecated.** Use `user.email_preferences.notification_recipients`
+   *
+   * @remarks
+   * (returned via `expand=user.email_preferences` on `GET /api/users/:id`)
+   * instead. Will be removed once SDK consumers migrate.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   emailRecepient?: string | null | undefined;
+  /**
+   * **Deprecated.** Use
+   *
+   * @remarks
+   * `user.email_preferences.send_weekly_summary_email` (returned via
+   * `expand=user.email_preferences` on `GET /api/users/:id`) instead.
+   * Will be removed once SDK consumers migrate.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   sendWeeklySummaryEmail?: boolean | null | undefined;
   title?: string | null | undefined;
   hasEmeraldStatus?: boolean | null | undefined;
@@ -151,13 +154,7 @@ export type Vendor = {
    * A set of images in different sizes
    */
   imageUrls?: ImageSet | null | undefined;
-  paymentProfile?:
-    | VendorPaymentProfile1
-    | number
-    | Vendor22
-    | number
-    | null
-    | undefined;
+  paymentProfile?: PaymentProfile | number | null | undefined;
   /**
    * Describes a facility which typically represents a physical building or logical grouping of offices which act as a single entity.
    */
@@ -187,16 +184,27 @@ export type Vendor = {
   vendorGroups?: Array<VendorGroup | null> | null | undefined;
   hasCredentialedFacilities?: boolean | null | undefined;
   targetFacilitiesUpdated?: string | null | undefined;
+  /**
+   * All custom fields (company-level and facility-level) associated with the vendor. Returned when expand includes vendor.custom_fields.
+   */
+  customFields?: Array<VendorCustomFields> | null | undefined;
+  /**
+   * Date and time of the vendor's most recent scan. Returned when expand includes vendor.last_scanned.
+   */
+  lastScanned?: string | null | undefined;
+  hasTargetFacilityQuestions?: boolean | null | undefined;
 };
 
 /** @internal */
 export const Badge$inboundSchema: z.ZodType<Badge, z.ZodTypeDef, unknown> = z
   .object({
     badge_type: types.optional(types.string()),
+    badge_mac_address: z.nullable(types.string()).optional(),
     required_badge_type: z.nullable(types.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "badge_type": "badgeType",
+      "badge_mac_address": "badgeMacAddress",
       "required_badge_type": "requiredBadgeType",
     });
   });
@@ -298,104 +306,12 @@ export function vendorVendorTypeFromJSON(
   );
 }
 
-/** @internal */
-export const Vendor22$inboundSchema: z.ZodType<
-  Vendor22,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function vendor22FromJSON(
-  jsonString: string,
-): SafeParseResult<Vendor22, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Vendor22$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Vendor22' from JSON`,
-  );
-}
-
-/** @internal */
-export const VendorPaymentProfile2$inboundSchema: z.ZodType<
-  VendorPaymentProfile2,
-  z.ZodTypeDef,
-  unknown
-> = smartUnion([types.number(), z.lazy(() => Vendor22$inboundSchema)]);
-
-export function vendorPaymentProfile2FromJSON(
-  jsonString: string,
-): SafeParseResult<VendorPaymentProfile2, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => VendorPaymentProfile2$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'VendorPaymentProfile2' from JSON`,
-  );
-}
-
-/** @internal */
-export const VendorPaymentProfile1$inboundSchema: z.ZodType<
-  VendorPaymentProfile1,
-  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 vendorPaymentProfile1FromJSON(
-  jsonString: string,
-): SafeParseResult<VendorPaymentProfile1, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => VendorPaymentProfile1$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'VendorPaymentProfile1' from JSON`,
-  );
-}
-
-/** @internal */
-export const PaymentProfilePaymentProfile$inboundSchema: z.ZodType<
-  PaymentProfilePaymentProfile,
-  z.ZodTypeDef,
-  unknown
-> = smartUnion([
-  z.lazy(() => VendorPaymentProfile1$inboundSchema),
-  smartUnion([types.number(), z.lazy(() => Vendor22$inboundSchema)]),
-]);
-
-export function paymentProfilePaymentProfileFromJSON(
-  jsonString: string,
-): SafeParseResult<PaymentProfilePaymentProfile, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PaymentProfilePaymentProfile$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PaymentProfilePaymentProfile' from JSON`,
-  );
-}
-
 /** @internal */
 export const VendorPaymentProfile$inboundSchema: z.ZodType<
   VendorPaymentProfile,
   z.ZodTypeDef,
   unknown
-> = smartUnion([
-  smartUnion([
-    z.lazy(() => VendorPaymentProfile1$inboundSchema),
-    smartUnion([types.number(), z.lazy(() => Vendor22$inboundSchema)]),
-  ]),
-  types.number(),
-]);
+> = smartUnion([PaymentProfile$inboundSchema, types.number()]);
 
 export function vendorPaymentProfileFromJSON(
   jsonString: string,
@@ -542,16 +458,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     drivers_license: z.nullable(ImageSet$inboundSchema).optional(),
     image_urls: z.nullable(ImageSet$inboundSchema).optional(),
     payment_profile: z.nullable(
-      smartUnion([
-        smartUnion([
-          z.lazy(() => VendorPaymentProfile1$inboundSchema),
-          smartUnion([
-            types.number(),
-            z.lazy(() => Vendor22$inboundSchema),
-          ]),
-        ]),
-        types.number(),
-      ]),
+      smartUnion([PaymentProfile$inboundSchema, types.number()]),
     ).optional(),
     primary_facility: z.nullable(Facility$inboundSchema).optional(),
     primary_department: z.nullable(Department$inboundSchema).optional(),
@@ -582,6 +489,10 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     ).optional(),
     has_credentialed_facilities: z.nullable(types.boolean()).optional(),
     target_facilities_updated: z.nullable(types.string()).optional(),
+    custom_fields: z.nullable(z.array(VendorCustomFields$inboundSchema))
+      .optional(),
+    last_scanned: z.nullable(types.string()).optional(),
+    has_target_facility_questions: z.nullable(types.boolean()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "email_recepient": "emailRecepient",
@@ -609,6 +520,9 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
       "vendor_groups": "vendorGroups",
       "has_credentialed_facilities": "hasCredentialedFacilities",
       "target_facilities_updated": "targetFacilitiesUpdated",
+      "custom_fields": "customFields",
+      "last_scanned": "lastScanned",
+      "has_target_facility_questions": "hasTargetFacilityQuestions",
     });
   });
 

package/src/models/components/vendorcredentialfileforautoclassificationok.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 VendorCredentialFileForAutoClassificationOk = {
+  success: boolean;
+  /**
+   * ID of the placeholder VendorCredential row.
+   */
+  vendorCredentialId: number;
+  /**
+   * ID of the paired VendorCredentialFile row.
+   */
+  vendorCredentialFileId: number;
+  /**
+   * Short-lived presigned PUT URL. Client uploads file body here.
+   */
+  presignedUrl: string;
+};
+
+/** @internal */
+export const VendorCredentialFileForAutoClassificationOk$inboundSchema:
+  z.ZodType<
+    VendorCredentialFileForAutoClassificationOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    success: types.boolean(),
+    vendor_credential_id: types.number(),
+    vendor_credential_file_id: types.number(),
+    presigned_url: types.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "vendor_credential_id": "vendorCredentialId",
+      "vendor_credential_file_id": "vendorCredentialFileId",
+      "presigned_url": "presignedUrl",
+    });
+  });
+
+export function vendorCredentialFileForAutoClassificationOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  VendorCredentialFileForAutoClassificationOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      VendorCredentialFileForAutoClassificationOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'VendorCredentialFileForAutoClassificationOk' from JSON`,
+  );
+}

package/src/models/components/vendorcredentialfileforautoclassificationrequest.ts

@@ -0,0 +1,49 @@
+/*
+ * 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 VendorCredentialFileForAutoClassificationRequest = {
+  /**
+   * Original filename of the file the user is uploading.
+   */
+  filename: string;
+  /**
+   * MIME type. Defaults server-side to application/octet-stream.
+   */
+  contentType?: string | undefined;
+};
+
+/** @internal */
+export type VendorCredentialFileForAutoClassificationRequest$Outbound = {
+  filename: string;
+  content_type?: string | undefined;
+};
+
+/** @internal */
+export const VendorCredentialFileForAutoClassificationRequest$outboundSchema:
+  z.ZodType<
+    VendorCredentialFileForAutoClassificationRequest$Outbound,
+    z.ZodTypeDef,
+    VendorCredentialFileForAutoClassificationRequest
+  > = z.object({
+    filename: z.string(),
+    contentType: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      contentType: "content_type",
+    });
+  });
+
+export function vendorCredentialFileForAutoClassificationRequestToJSON(
+  vendorCredentialFileForAutoClassificationRequest:
+    VendorCredentialFileForAutoClassificationRequest,
+): string {
+  return JSON.stringify(
+    VendorCredentialFileForAutoClassificationRequest$outboundSchema.parse(
+      vendorCredentialFileForAutoClassificationRequest,
+    ),
+  );
+}

package/src/models/components/vendorcredentialsummary.ts

@@ -56,6 +56,13 @@ export type CredentialPricingOptions = {
   note?: string | null | undefined;
 };
 
+export type CredentialVariants = {
+  id?: number | undefined;
+  name?: string | null | undefined;
+  price?: number | null | undefined;
+  note?: string | null | undefined;
+};
+
 /**
  * Reduced list of attributes of Vendor Credential record
  */
@@ -97,7 +104,7 @@ export type VendorCredentialSummary = {
     | Array<VendorCredentialDataRequest | null>
     | null
     | undefined;
-  credentialVariants?: Array<any> | null | undefined;
+  credentialVariants?: Array<CredentialVariants> | null | undefined;
   targetsChop?: boolean | null | undefined;
   totalPendingCredentials?: number | null | undefined;
   backgroundCheckProviderId?: number | null | undefined;
@@ -240,6 +247,28 @@ export function credentialPricingOptionsFromJSON(
   );
 }
 
+/** @internal */
+export const CredentialVariants$inboundSchema: z.ZodType<
+  CredentialVariants,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  name: z.nullable(types.string()).optional(),
+  price: z.nullable(types.number()).optional(),
+  note: z.nullable(types.string()).optional(),
+});
+
+export function credentialVariantsFromJSON(
+  jsonString: string,
+): SafeParseResult<CredentialVariants, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CredentialVariants$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CredentialVariants' from JSON`,
+  );
+}
+
 /** @internal */
 export const VendorCredentialSummary$inboundSchema: z.ZodType<
   VendorCredentialSummary,
@@ -290,7 +319,9 @@ export const VendorCredentialSummary$inboundSchema: z.ZodType<
       VendorCredentialDataRequest$inboundSchema
     ))),
   ).optional(),
-  credential_variants: z.nullable(z.array(z.any())).optional(),
+  credential_variants: z.nullable(
+    z.array(z.lazy(() => CredentialVariants$inboundSchema)),
+  ).optional(),
   targets_chop: z.nullable(types.boolean()).optional(),
   total_pending_credentials: z.nullable(types.number()).optional(),
   background_check_provider_id: z.nullable(types.number()).optional(),