@greensecurity/javascript-sdk 0.46.0-beta.4 → 0.46.0-beta.6

package/src/models/components/userdetails.ts

@@ -19,7 +19,7 @@ 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
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions.
  */
 export const UserType = {
   Api: "API",
@@ -33,7 +33,7 @@ export const UserType = {
   Vendor: "Vendor",
 } as const;
 /**
- * The flavor of user will determine the most relevant user experience for this user as well as permissions
+ * The flavor of user will determine the most relevant user experience for this user as well as permissions.
  */
 export type UserType = OpenEnum<typeof UserType>;
 
@@ -42,11 +42,29 @@ export type Two2 = {};
 export type Two = number | Two2;
 
 export type PaymentProfile1 = {
+  /**
+   * The unique ID of the payment profile.
+   */
   id?: number | undefined;
+  /**
+   * Whether the payment profile is valid. `null` when unknown.
+   */
   isValid?: boolean | null | undefined;
+  /**
+   * The card brand, for example, `Visa`. `null` when unknown.
+   */
   cardType?: string | null | undefined;
+  /**
+   * The last four digits of the card number. `null` when unknown.
+   */
   cardLast4?: string | null | undefined;
+  /**
+   * Whether the payment profile is a placeholder that has no real payment method. `null` when unknown.
+   */
   isDummy?: boolean | null | undefined;
+  /**
+   * The type of the payment profile. `null` when unknown.
+   */
   profileType?: string | null | undefined;
 };
 
@@ -60,36 +78,51 @@ export type UserDetailsPaymentProfile = PaymentProfile1 | number | Two2;
  */
 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.
+   * This identifier is only used to reference the underlying user. Based on the `user_type`, you can use a more relevant identifier to get relevant information from other endpoints.
    */
   id: number;
   /**
-   * First name of the user
+   * First name of the user.
    */
   firstName?: string | null | undefined;
   /**
-   * Last name of the user
+   * Last name of the user.
    */
   lastName?: string | null | undefined;
   /**
    * Email address (not always valid)
    */
   email: string;
+  /**
+   * The user's landline phone number, or `null` if not set.
+   */
   phone?: string | null | undefined;
+  /**
+   * The user's mobile phone number, or `null` if not set.
+   */
   mobilePhone?: string | null | undefined;
+  /**
+   * The user's fax number, or `null` if not set.
+   */
   fax?: string | null | undefined;
+  /**
+   * Whether the user has confirmed their phone number.
+   */
   phoneConfirmed?: boolean | undefined;
+  /**
+   * Whether the user has confirmed their email address.
+   */
   emailConfirmed?: boolean | undefined;
   /**
-   * The flavor of user will determine the most relevant user experience for this user as well as permissions
+   * 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.
+   * The timezone of the user. Clients use it 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
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   imageUrls?: ImageSet | null | undefined;
   /**
@@ -106,10 +139,10 @@ export type UserDetails = {
    *
    * 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.
+   * the migration window but Green Security has deprecated them.
    *
-   * `receive_vendor_emails` is company-manager-only and is stored on the
-   * CompanyManager record rather than the User, but is exposed here
+   * `receive_vendor_emails` applies only to company managers. Green Security stores it on the
+   * `CompanyManager` record instead of the user, but this schema exposes it
    * alongside the other preferences for a single read/write shape.
    */
   emailPreferences?: EmailPreferences | undefined;
@@ -120,7 +153,7 @@ export type UserDetails = {
    * 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.
+   * object if one exists. When not expanded, the response omits this property.
    */
   paymentProfile?: PaymentProfile1 | number | Two2 | null | undefined;
 };

package/src/models/components/userlocation.ts

@@ -11,6 +11,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The time zone of the location. `null` if not set.
+ */
 export const Timezone = {
   InternationalDateLineWest: "International Date Line West",
   MidwayIsland: "Midway Island",
@@ -164,22 +167,58 @@ export const Timezone = {
   ChathamIs: "Chatham Is.",
   Samoa: "Samoa",
 } as const;
+/**
+ * The time zone of the location. `null` if not set.
+ */
 export type Timezone = OpenEnum<typeof Timezone>;
 
 /**
  * Reduced list of attributes of the User Location
  */
 export type UserLocation = {
+  /**
+   * The full street address of the location. `null` if not set.
+   */
   address?: string | null | undefined;
+  /**
+   * The first line of the street address. `null` if not set.
+   */
   address1?: string | null | undefined;
+  /**
+   * The second line of the street address, such as a suite or unit number. `null` if not set.
+   */
   address2?: string | null | undefined;
+  /**
+   * The city of the location. `null` if not set.
+   */
   city?: string | null | undefined;
+  /**
+   * The state or province of the location. `null` if not set.
+   */
   state?: string | null | undefined;
+  /**
+   * The postal code of the location. `null` if not set.
+   */
   zip?: string | null | undefined;
+  /**
+   * The phone number of the location. `null` if not set.
+   */
   phone?: string | null | undefined;
+  /**
+   * The mobile phone number of the location. `null` if not set.
+   */
   mobilePhone?: string | null | undefined;
+  /**
+   * The fax number of the location. `null` if not set.
+   */
   fax?: string | null | undefined;
+  /**
+   * The country of the location. `null` if not set.
+   */
   country?: string | null | undefined;
+  /**
+   * The time zone of the location. `null` if not set.
+   */
   timezone?: Timezone | null | undefined;
 };
 

package/src/models/components/usersummary.ts

@@ -9,10 +9,16 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A simplified representation of a User, typically used in list views.
+ * A simplified representation of a user, typically used in list views.
  */
 export type UserSummary = {
+  /**
+   * The unique ID of the user.
+   */
   id: number;
+  /**
+   * The full name of the user.
+   */
   name: string;
 };
 

package/src/models/components/vendor.ts

@@ -100,25 +100,63 @@ import {
   VendorType$outboundSchema,
 } from "./vendortype.js";
 
+/**
+ * The badge assigned to the vendor. `null` if the vendor has no badge.
+ */
 export type Badge = {
+  /**
+   * The type of badge assigned to the vendor.
+   */
   badgeType?: string | undefined;
+  /**
+   * The media access control (MAC) address of the vendor's smart badge. `null` if the badge has no MAC address.
+   */
   badgeMacAddress?: string | null | undefined;
+  /**
+   * The badge type the vendor is required to use. `null` if no badge type is required.
+   */
   requiredBadgeType?: string | null | undefined;
 };
 
 export type One = {
+  /**
+   * The unique ID of the user.
+   */
   id?: number | undefined;
+  /**
+   * The user's first name. `null` if not set.
+   */
   firstName?: string | null | undefined;
+  /**
+   * The user's last name. `null` if not set.
+   */
   lastName?: string | null | undefined;
+  /**
+   * The user's email address. `null` if not set.
+   */
   email?: string | null | undefined;
+  /**
+   * The user's phone number. `null` if not set.
+   */
   phone?: string | null | undefined;
+  /**
+   * The user's mobile phone number. `null` if not set.
+   */
   mobilePhone?: string | null | undefined;
+  /**
+   * The user's fax number. `null` if not set.
+   */
   fax?: string | null | undefined;
+  /**
+   * The type of the user account. `null` if not set.
+   */
   userType?: string | null | undefined;
+  /**
+   * The user's time zone. `null` if not set.
+   */
   timezone?: string | null | undefined;
-  qrCode?: string | null | undefined;
   /**
-   * A set of images in different sizes
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   imageUrls?: ImageSet | null | undefined;
   /**
@@ -127,54 +165,135 @@ export type One = {
   location?: UserLocation | null | undefined;
 };
 
+/**
+ * The user account of the vendor. Returns the full user object when expanded, otherwise the user ID.
+ */
 export type VendorUser = One | number;
 
+/**
+ * The vendor's job title record. Returns the full object when expanded, otherwise the ID. `null` if not set.
+ */
 export type VendorJob = VendorJobTitle | number;
 
+/**
+ * The vendor's type. Returns the full object when expanded, otherwise the ID. `null` if not set.
+ */
 export type VendorVendorType = VendorType | number;
 
+/**
+ * The vendor's payment profile. Returns the full object when expanded, otherwise the ID. `null` if the vendor has none.
+ */
 export type VendorPaymentProfile = PaymentProfile | number;
 
 export type CompanySummary = {
+  /**
+   * The ID of the company.
+   */
   id: string;
+  /**
+   * The name of the company.
+   */
   name?: string | undefined;
 };
 
+/**
+ * The company the vendor represents. Returns the full company or a company summary. `null` if the vendor has no company.
+ */
 export type VendorCompany = Company | CompanySummary;
 
+/**
+ * Which party is responsible for paying each type of charge for the vendor. `null` if no assignments exist.
+ */
 export type PaymentResponsibility = {
+  /**
+   * The unique ID of the payment responsibility assignment. `null` if no assignment exists.
+   */
   id?: number | null | undefined;
+  /**
+   * The ID of the company manager who holds the assignment. `null` if not set.
+   */
   companyManagerId?: number | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's credentialing subscription. `null` if not set.
+   */
   credentialingSubscription?: boolean | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's scrubs subscription. `null` if not set.
+   */
   scrubsSubscription?: boolean | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's scrub credits. `null` if not set.
+   */
   scrubCredits?: boolean | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's initial hard badge. `null` if not set.
+   */
   hardBadgeInitial?: boolean | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's additional hard badges. `null` if not set.
+   */
   hardBadgeExtra?: boolean | null | undefined;
+  /**
+   * Whether the company manager pays for the vendor's other invoices. `null` if not set.
+   */
   otherInvoices?: boolean | null | undefined;
+  /**
+   * The ID of the facility the assignment applies to. `null` if not set.
+   */
   facilityId?: number | null | undefined;
+  /**
+   * The ID of the company the assignment applies to. `null` if not set.
+   */
   companyId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for the credentialing subscription. `null` if the vendor pays.
+   */
   credentialingSubscriptionUserId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for the scrubs subscription. `null` if the vendor pays.
+   */
   scrubsSubscriptionUserId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for scrub credits. `null` if the vendor pays.
+   */
   scrubCreditsUserId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for the initial hard badge. `null` if the vendor pays.
+   */
   hardBadgeInitialUserId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for additional hard badges. `null` if the vendor pays.
+   */
   hardBadgeExtraUserId?: number | null | undefined;
+  /**
+   * The ID of the user who pays for other invoices. `null` if the vendor pays.
+   */
   otherInvoicesUserId?: number | null | undefined;
 };
 
+/**
+ * The vendor's pending invoice. Returns the full invoice when expanded, otherwise the invoice ID. `null` if the vendor has no pending invoice.
+ */
 export type PendingInvoice = Invoice | number;
 
 /**
  * Vendor details
  */
 export type Vendor = {
+  /**
+   * The unique ID of the vendor.
+   */
   id?: number | undefined;
+  /**
+   * The badge assigned to the vendor. `null` if the vendor has no badge.
+   */
   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.
+   * (returned with `expand=user.email_preferences` on `GET /api/users/:id`)
+   * instead. Removal is planned once SDK consumers migrate.
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
@@ -183,79 +302,139 @@ export type Vendor = {
    * **Deprecated.** Use
    *
    * @remarks
-   * `user.email_preferences.send_weekly_summary_email` (returned via
+   * `user.email_preferences.send_weekly_summary_email` (returned with
    * `expand=user.email_preferences` on `GET /api/users/:id`) instead.
-   * Will be removed once SDK consumers migrate.
+   * Removal is planned 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;
+  /**
+   * The vendor's job title. `null` if not set.
+   */
   title?: string | null | undefined;
   /**
-   * The vendor's primary sales state as a 2-letter US state code (e.g. `TX`), sourced from the vendor's `territory` column.
+   * The vendor's primary sales state as a 2-letter US state code (for example, `TX`), sourced from the vendor's `territory` column.
    */
   primarySalesState?: string | null | undefined;
+  /**
+   * Whether the vendor has Emerald status. `null` if not determined.
+   */
   hasEmeraldStatus?: boolean | null | undefined;
+  /**
+   * The user account of the vendor. Returns the full user object when expanded, otherwise the user ID.
+   */
   user?: One | number | undefined;
+  /**
+   * The answers the vendor submitted during registration, as a free-form object. `null` if the vendor submitted none.
+   */
   registrationData?: { [k: string]: any } | null | undefined;
+  /**
+   * Whether the vendor has finished registration. `null` if not determined.
+   */
   registrationFinished?: boolean | null | undefined;
+  /**
+   * The vendor's job title record. Returns the full object when expanded, otherwise the ID. `null` if not set.
+   */
   vendorJob?: VendorJobTitle | number | null | undefined;
+  /**
+   * The vendor's type. Returns the full object when expanded, otherwise the ID. `null` if not set.
+   */
   vendorType?: VendorType | number | null | undefined;
   /**
    * list of the vendor supervisor attributes
    */
   supervisor?: Supervisor | null | undefined;
+  /**
+   * The value encoded in the vendor's QR code. `null` if the vendor has no QR code.
+   */
   qrCode?: string | null | undefined;
   /**
-   * A set of images in different sizes
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   headShot?: ImageSet | null | undefined;
   /**
-   * A set of images in different sizes
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   driversLicense?: ImageSet | null | undefined;
   /**
-   * A set of images in different sizes
+   * A set of images in different sizes. URLs for private images (such as headshots, driver's licenses and visitor faces) are signed and expire after one to two hours. Fetch the record again for fresh URLs instead of storing them.
    */
   imageUrls?: ImageSet | null | undefined;
+  /**
+   * The vendor's payment profile. Returns the full object when expanded, otherwise the ID. `null` if the vendor has none.
+   */
   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.
    */
   primaryFacility?: Facility | null | undefined;
   /**
-   * A simplified representation of a Department, typically used in list views.
+   * A simplified representation of a department, typically used in list views.
    */
   primaryDepartment?: Department | null | undefined;
+  /**
+   * The company the vendor represents. Returns the full company or a company summary. `null` if the vendor has no company.
+   */
   company?: Company | CompanySummary | null | undefined;
   /**
-   * Reduced list of attributes of the Subscription record
+   * Reduced list of attributes of the subscription record
    */
   credentialingSubscription?: Subscription | null | undefined;
   /**
-   * Reduced list of attributes of the Subscription record
+   * Reduced list of attributes of the subscription record
    */
   scrubsSubscription?: Subscription | null | undefined;
+  /**
+   * Which party is responsible for paying each type of charge for the vendor. `null` if no assignments exist.
+   */
   paymentResponsibility?: PaymentResponsibility | null | undefined;
+  /**
+   * The date the vendor's background check expires, in ISO 8601 format. `null` if there is no background check.
+   */
   backgroundCheckDateExpires?: string | null | undefined;
+  /**
+   * The vendor's current credit balance. `null` if not available.
+   */
   creditBalance?: number | null | undefined;
+  /**
+   * The facilities the vendor targets. `null` if not available.
+   */
   targetFacilities?: Array<FacilitySummary> | null | undefined;
+  /**
+   * The facilities that approve the vendor for calendaring. `null` if not available.
+   */
   approvedCalendaringFacilities?:
     | Array<FacilityCalendarSummary>
     | null
     | undefined;
+  /**
+   * The vendor's pending invoice. Returns the full invoice when expanded, otherwise the invoice ID. `null` if the vendor has no pending invoice.
+   */
   pendingInvoice?: Invoice | number | null | undefined;
+  /**
+   * The vendor groups the vendor belongs to. `null` if not available.
+   */
   vendorGroups?: Array<VendorGroup | null> | null | undefined;
+  /**
+   * Whether the vendor is credentialed at one or more facilities. `null` if not determined.
+   */
   hasCredentialedFacilities?: boolean | null | undefined;
+  /**
+   * The date and time the vendor's target facilities were last updated, in ISO 8601 format. `null` if never updated.
+   */
   targetFacilitiesUpdated?: string | null | undefined;
   /**
-   * All custom fields (company-level and facility-level) associated with the vendor. Returned when expand includes vendor.custom_fields.
+   * 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.
+   * Date and time of the vendor's most recent scan. Returned when expand includes vendor.`last_scanned`.
    */
   lastScanned?: string | null | undefined;
+  /**
+   * Whether the vendor's target facilities have screening questions. `null` if not determined.
+   */
   hasTargetFacilityQuestions?: boolean | null | undefined;
 };
 
@@ -321,7 +500,6 @@ export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
     fax: z.nullable(types.string()).optional(),
     user_type: z.nullable(types.string()).optional(),
     timezone: z.nullable(types.string()).optional(),
-    qr_code: z.nullable(types.string()).optional(),
     image_urls: z.nullable(ImageSet$inboundSchema).optional(),
     location: z.nullable(UserLocation$inboundSchema).optional(),
   }).transform((v) => {
@@ -330,7 +508,6 @@ export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
       "last_name": "lastName",
       "mobile_phone": "mobilePhone",
       "user_type": "userType",
-      "qr_code": "qrCode",
       "image_urls": "imageUrls",
     });
   });
@@ -345,7 +522,6 @@ export type One$Outbound = {
   fax?: string | null | undefined;
   user_type?: string | null | undefined;
   timezone?: string | null | undefined;
-  qr_code?: string | null | undefined;
   image_urls?: ImageSet$Outbound | null | undefined;
   location?: UserLocation$Outbound | null | undefined;
 };
@@ -362,7 +538,6 @@ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
     fax: z.nullable(z.string()).optional(),
     userType: z.nullable(z.string()).optional(),
     timezone: z.nullable(z.string()).optional(),
-    qrCode: z.nullable(z.string()).optional(),
     imageUrls: z.nullable(ImageSet$outboundSchema).optional(),
     location: z.nullable(UserLocation$outboundSchema).optional(),
   }).transform((v) => {
@@ -371,7 +546,6 @@ export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
       lastName: "last_name",
       mobilePhone: "mobile_phone",
       userType: "user_type",
-      qrCode: "qr_code",
       imageUrls: "image_urls",
     });
   });