@greensecurity/javascript-sdk 0.43.1-beta.120 → 0.43.1-beta.123

package/src/models/components/aiclassifycreaterequest.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 41063021ea66
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type AiClassifyCreateRequest = {
+  /**
+   * Vendor that owns the credential being classified.
+   */
+  vendorId: number;
+  /**
+   * 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 AiClassifyCreateRequest$Outbound = {
+  vendor_id: number;
+  filename: string;
+  content_type?: string | undefined;
+};
+
+/** @internal */
+export const AiClassifyCreateRequest$outboundSchema: z.ZodType<
+  AiClassifyCreateRequest$Outbound,
+  z.ZodTypeDef,
+  AiClassifyCreateRequest
+> = z.object({
+  vendorId: z.number().int(),
+  filename: z.string(),
+  contentType: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    vendorId: "vendor_id",
+    contentType: "content_type",
+  });
+});
+
+export function aiClassifyCreateRequestToJSON(
+  aiClassifyCreateRequest: AiClassifyCreateRequest,
+): string {
+  return JSON.stringify(
+    AiClassifyCreateRequest$outboundSchema.parse(aiClassifyCreateRequest),
+  );
+}

package/src/models/components/aiclassifycreateresponse.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f978213835cb
+ */
+
+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 AiClassifyCreateResponse = {
+  success: boolean;
+  /**
+   * ID of the placeholder VendorCredential row.
+   */
+  vcId: number;
+  /**
+   * ID of the paired VendorCredentialFile row.
+   */
+  vcfId: number;
+  /**
+   * S3 object key the presigned URL targets.
+   */
+  s3Key: string;
+  /**
+   * Short-lived presigned PUT URL. Client uploads file body here.
+   */
+  presignedUrl: string;
+};
+
+/** @internal */
+export const AiClassifyCreateResponse$inboundSchema: z.ZodType<
+  AiClassifyCreateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.boolean(),
+  vc_id: types.number(),
+  vcf_id: types.number(),
+  s3_key: types.string(),
+  presigned_url: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "vc_id": "vcId",
+    "vcf_id": "vcfId",
+    "s3_key": "s3Key",
+    "presigned_url": "presignedUrl",
+  });
+});
+
+export function aiClassifyCreateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AiClassifyCreateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AiClassifyCreateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AiClassifyCreateResponse' from JSON`,
+  );
+}

package/src/models/components/aiclassifynotifyuploadedrequest.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 241f78803cca
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type AiClassifyNotifyUploadedRequest = {
+  /**
+   * ID of the VendorCredentialFile that was just uploaded to S3.
+   */
+  vcfId: number;
+};
+
+/** @internal */
+export type AiClassifyNotifyUploadedRequest$Outbound = {
+  vcf_id: number;
+};
+
+/** @internal */
+export const AiClassifyNotifyUploadedRequest$outboundSchema: z.ZodType<
+  AiClassifyNotifyUploadedRequest$Outbound,
+  z.ZodTypeDef,
+  AiClassifyNotifyUploadedRequest
+> = z.object({
+  vcfId: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    vcfId: "vcf_id",
+  });
+});
+
+export function aiClassifyNotifyUploadedRequestToJSON(
+  aiClassifyNotifyUploadedRequest: AiClassifyNotifyUploadedRequest,
+): string {
+  return JSON.stringify(
+    AiClassifyNotifyUploadedRequest$outboundSchema.parse(
+      aiClassifyNotifyUploadedRequest,
+    ),
+  );
+}

package/src/models/components/aiclassifynotifyuploadedresponse.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0acafb543ca3
+ */
+
+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 AiClassifyNotifyUploadedResponse = {
+  success: boolean;
+  /**
+   * True when classification was already routed (idempotency hit).
+   */
+  already?: boolean | undefined;
+  vcId: number;
+  vcfId: number;
+};
+
+/** @internal */
+export const AiClassifyNotifyUploadedResponse$inboundSchema: z.ZodType<
+  AiClassifyNotifyUploadedResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: types.boolean(),
+  already: types.optional(types.boolean()),
+  vc_id: types.number(),
+  vcf_id: types.number(),
+}).transform((v) => {
+  return remap$(v, {
+    "vc_id": "vcId",
+    "vcf_id": "vcfId",
+  });
+});
+
+export function aiClassifyNotifyUploadedResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AiClassifyNotifyUploadedResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AiClassifyNotifyUploadedResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AiClassifyNotifyUploadedResponse' from JSON`,
+  );
+}

package/src/models/components/fhirconfig.ts

@@ -100,6 +100,14 @@ export type FhirConfig = {
    * See [JMESPath](https://jmespath.org/)
    */
   projection: string;
+  /**
+   * Whether to automatically create Room records for unmapped FHIR encounter locations
+   */
+  autoCreateRooms: boolean;
+  /**
+   * JMESPath template to transform FHIR location object to Room attributes. Used when auto_create_rooms is enabled.
+   */
+  roomCreationJmespath?: string | undefined;
 };
 
 /** @internal */
@@ -218,12 +226,16 @@ export const FhirConfig$inboundSchema: z.ZodType<
   notes: types.optional(types.string()),
   entities: FhirExtraEntities$inboundSchema,
   projection: types.string(),
+  auto_create_rooms: types.boolean().default(false),
+  room_creation_jmespath: types.optional(types.string()),
 }).transform((v) => {
   return remap$(v, {
     "production_profile": "productionProfile",
     "non_production_profile": "nonProductionProfile",
     "applies_to": "appliesTo",
     "active_profile": "activeProfile",
+    "auto_create_rooms": "autoCreateRooms",
+    "room_creation_jmespath": "roomCreationJmespath",
   });
 });
 

package/src/models/components/fhirconfigpartialupdate.ts

@@ -49,6 +49,14 @@ export type FhirConfigPartialUpdate = {
    * Flags indicating which FHIR entities should be queried for a visitor lookup. The default patient and encounter entities are always enabled. Extra entities should be enabled when additional data needs to be queried to decide whether a visitor should be allowed in.
    */
   entities?: FhirExtraEntities | undefined;
+  /**
+   * Whether to automatically create Room records for unmapped FHIR encounter locations
+   */
+  autoCreateRooms?: boolean | undefined;
+  /**
+   * JMESPath template to transform FHIR location object to Room attributes. Used when auto_create_rooms is enabled.
+   */
+  roomCreationJmespath?: string | undefined;
 };
 
 /** @internal */
@@ -183,6 +191,8 @@ export type FhirConfigPartialUpdate$Outbound = {
   active_profile?: string | undefined;
   notes?: string | undefined;
   entities?: FhirExtraEntities$Outbound | undefined;
+  auto_create_rooms: boolean;
+  room_creation_jmespath?: string | undefined;
 };
 
 /** @internal */
@@ -202,12 +212,16 @@ export const FhirConfigPartialUpdate$outboundSchema: z.ZodType<
   activeProfile: z.string().optional(),
   notes: z.string().optional(),
   entities: FhirExtraEntities$outboundSchema.optional(),
+  autoCreateRooms: z.boolean().default(false),
+  roomCreationJmespath: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     productionProfile: "production_profile",
     nonProductionProfile: "non_production_profile",
     appliesTo: "applies_to",
     activeProfile: "active_profile",
+    autoCreateRooms: "auto_create_rooms",
+    roomCreationJmespath: "room_creation_jmespath",
   });
 });
 

package/src/models/components/index.ts

@@ -4,6 +4,10 @@
  */
 
 export * from "./activestatus.js";
+export * from "./aiclassifycreaterequest.js";
+export * from "./aiclassifycreateresponse.js";
+export * from "./aiclassifynotifyuploadedrequest.js";
+export * from "./aiclassifynotifyuploadedresponse.js";
 export * from "./alert.js";
 export * from "./backgroundcheckresult.js";
 export * from "./company.js";
@@ -65,6 +69,7 @@ export * from "./subscription.js";
 export * from "./supervisor.js";
 export * from "./supportarticle.js";
 export * from "./systemsummary.js";
+export * from "./uploadhistoryitem.js";
 export * from "./user.js";
 export * from "./userlocation.js";
 export * from "./usersummary.js";

package/src/models/components/uploadhistoryitem.ts

@@ -0,0 +1,60 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a1eae6e10877
+ */
+
+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 UploadHistoryItem = {
+  /**
+   * VendorCredentialFile ID.
+   */
+  id: number;
+  /**
+   * Original filename.
+   */
+  filename: string;
+  /**
+   * ISO-8601 timestamp.
+   */
+  dateUploaded: Date;
+  vendorCredentialId: number;
+  /**
+   * Name of the matched Credential, or null if unmatched.
+   */
+  credentialName?: string | null | undefined;
+};
+
+/** @internal */
+export const UploadHistoryItem$inboundSchema: z.ZodType<
+  UploadHistoryItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  filename: types.string(),
+  date_uploaded: types.date(),
+  vendor_credential_id: types.number(),
+  credential_name: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_uploaded": "dateUploaded",
+    "vendor_credential_id": "vendorCredentialId",
+    "credential_name": "credentialName",
+  });
+});
+
+export function uploadHistoryItemFromJSON(
+  jsonString: string,
+): SafeParseResult<UploadHistoryItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UploadHistoryItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UploadHistoryItem' from JSON`,
+  );
+}

package/src/models/components/vendor.ts

@@ -26,6 +26,10 @@ import { Invoice, Invoice$inboundSchema } from "./invoice.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,
@@ -189,6 +193,10 @@ 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;
 };
 
 /** @internal */
@@ -586,6 +594,8 @@ 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(),
   }).transform((v) => {
     return remap$(v, {
       "email_recepient": "emailRecepient",
@@ -613,6 +623,7 @@ 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",
     });
   });
 

package/src/models/components/vendorcustomfields.ts

@@ -4,19 +4,119 @@
  */
 
 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";
 
+/**
+ * The type of the custom field
+ */
+export const FieldType = {
+  Text: "text",
+  Date: "date",
+  Select: "select",
+} as const;
+/**
+ * The type of the custom field
+ */
+export type FieldType = OpenEnum<typeof FieldType>;
+
+export const ForType = {
+  Company: "company",
+  Facility: "facility",
+} as const;
+export type ForType = OpenEnum<typeof ForType>;
+
+/**
+ * Indicates whether this field belongs to a company or facility
+ */
+export type FieldFor = {
+  forType?: ForType | undefined;
+  /**
+   * Company name (present when for_type is company)
+   */
+  company?: string | null | undefined;
+  /**
+   * Company ID (present when for_type is company)
+   */
+  companyId?: number | null | undefined;
+  /**
+   * Facility name (present when for_type is facility)
+   */
+  facility?: string | null | undefined;
+  /**
+   * Facility ID (present when for_type is facility)
+   */
+  facilityId?: number | null | undefined;
+};
+
 export type VendorCustomFields = {
+  /**
+   * The vendor field ID
+   */
   id?: number | undefined;
-  system?: string | null | undefined;
-  facility?: string | null | undefined;
-  field?: string | null | undefined;
+  /**
+   * Display name of the custom field
+   */
+  name?: string | null | undefined;
+  /**
+   * The type of the custom field
+   */
+  fieldType?: FieldType | null | undefined;
+  /**
+   * The current value for this vendor
+   */
   value?: string | null | undefined;
+  /**
+   * Indicates whether this field belongs to a company or facility
+   */
+  fieldFor?: FieldFor | null | undefined;
 };
 
+/** @internal */
+export const FieldType$inboundSchema: z.ZodType<
+  FieldType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(FieldType);
+
+/** @internal */
+export const ForType$inboundSchema: z.ZodType<ForType, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(ForType);
+
+/** @internal */
+export const FieldFor$inboundSchema: z.ZodType<
+  FieldFor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  for_type: types.optional(ForType$inboundSchema),
+  company: z.nullable(types.string()).optional(),
+  company_id: z.nullable(types.number()).optional(),
+  facility: z.nullable(types.string()).optional(),
+  facility_id: z.nullable(types.number()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "for_type": "forType",
+    "company_id": "companyId",
+    "facility_id": "facilityId",
+  });
+});
+
+export function fieldForFromJSON(
+  jsonString: string,
+): SafeParseResult<FieldFor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FieldFor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FieldFor' from JSON`,
+  );
+}
+
 /** @internal */
 export const VendorCustomFields$inboundSchema: z.ZodType<
   VendorCustomFields,
@@ -24,10 +124,15 @@ export const VendorCustomFields$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: types.optional(types.number()),
-  system: z.nullable(types.string()).optional(),
-  facility: z.nullable(types.string()).optional(),
-  field: z.nullable(types.string()).optional(),
+  name: z.nullable(types.string()).optional(),
+  field_type: z.nullable(FieldType$inboundSchema).optional(),
   value: z.nullable(types.string()).optional(),
+  field_for: z.nullable(z.lazy(() => FieldFor$inboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "field_type": "fieldType",
+    "field_for": "fieldFor",
+  });
 });
 
 export function vendorCustomFieldsFromJSON(

package/src/models/components/vendorscan.ts

@@ -29,12 +29,17 @@ export type VendorScan = {
   vendor?: any | undefined;
   zone?: any | undefined;
   department?: Department | number | null | undefined;
+  departmentEventId?: number | null | undefined;
+  facilityEventId?: number | null | undefined;
   scanInVendorScanId?: number | null | undefined;
   scanOutVendorScanId?: number | null | undefined;
   autoScanOut?: boolean | undefined;
   finishedScreeningQuestions?: boolean | undefined;
   requiresScreeningQuestions?: boolean | undefined;
   recheck?: boolean | undefined;
+  /**
+   * Smart badge LED payload data. Only present when requested via the `vendor_scan.badge_data` expand scope.
+   */
   badgeData?: string | null | undefined;
 };
 
@@ -73,6 +78,8 @@ export const VendorScan$inboundSchema: z.ZodType<
   zone: types.optional(z.any()),
   department: z.nullable(smartUnion([Department$inboundSchema, types.number()]))
     .optional(),
+  department_event_id: z.nullable(types.number()).optional(),
+  facility_event_id: z.nullable(types.number()).optional(),
   scan_in_vendor_scan_id: z.nullable(types.number()).optional(),
   scan_out_vendor_scan_id: z.nullable(types.number()).optional(),
   auto_scan_out: types.optional(types.boolean()),
@@ -87,6 +94,8 @@ export const VendorScan$inboundSchema: z.ZodType<
     "scan_error": "scanError",
     "scan_success": "scanSuccess",
     "scan_type": "scanType",
+    "department_event_id": "departmentEventId",
+    "facility_event_id": "facilityEventId",
     "scan_in_vendor_scan_id": "scanInVendorScanId",
     "scan_out_vendor_scan_id": "scanOutVendorScanId",
     "auto_scan_out": "autoScanOut",

package/src/models/operations/addvendormanagedbycompany.ts

@@ -19,7 +19,13 @@ export type AddVendorManagedByCompanyRequestBody = {
 
 export type AddVendorManagedByCompanyRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: AddVendorManagedByCompanyRequestBody;

package/src/models/operations/calculatesubscriptionprice.ts

@@ -17,7 +17,13 @@ export type CalculateSubscriptionPriceRequestBody = {
 
 export type CalculateSubscriptionPriceRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: CalculateSubscriptionPriceRequestBody;

package/src/models/operations/changesubscription.ts

@@ -17,7 +17,13 @@ export type ChangeSubscriptionRequestBody = {
 
 export type ChangeSubscriptionRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: ChangeSubscriptionRequestBody;

package/src/models/operations/createvendorcompany.ts

@@ -40,7 +40,13 @@ export type CreateVendorCompanyRequestBody = {
 
 export type CreateVendorCompanyRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: CreateVendorCompanyRequestBody;

package/src/models/operations/deletevendormanagedbycompany.ts

@@ -15,7 +15,13 @@ export type DeleteVendorManagedByCompanyRequestBody = {
 
 export type DeleteVendorManagedByCompanyRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   requestBody: DeleteVendorManagedByCompanyRequestBody;

package/src/models/operations/expeditetimeremaining.ts

@@ -12,7 +12,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ExpediteTimeRemainingRequest = {
   /**
-   * Either the ID of the vendor rep or the keyword "me" to represent the current vendor.
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
 };