@greensecurity/javascript-sdk 0.46.0-beta.5 → 0.46.0-beta.7

package/src/models/operations/passwordresetrequest.ts

@@ -8,15 +8,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Email address of the user who requests the password reset.
+ */
 export type PasswordResetRequestRequestBody = {
   email: string;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns `success` set to `true` when the server queued the password reset email. The response doesn't confirm delivery. If the email is missing or no user has that email address, the response is still `200` and contains an `error` message instead of `success`.
  */
 export type PasswordResetRequestPasswordResetRequestOk = {
-  success: boolean;
+  /**
+   * Whether the server queued the password reset email. Present only on success.
+   */
+  success?: boolean | undefined;
+  /**
+   * Why the server did not queue the email. Present only when the request failed.
+   */
+  error?: string | undefined;
 };
 
 /** @internal */
@@ -47,7 +57,8 @@ export function passwordResetRequestRequestBodyToJSON(
 export const PasswordResetRequestPasswordResetRequestOk$inboundSchema:
   z.ZodType<PasswordResetRequestPasswordResetRequestOk, z.ZodTypeDef, unknown> =
     z.object({
-      success: types.boolean(),
+      success: types.optional(types.boolean()),
+      error: types.optional(types.string()),
     });
 
 export function passwordResetRequestPasswordResetRequestOkFromJSON(

package/src/models/operations/patchdistributor.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type PatchDistributorRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The distributor attributes to change. Omitted keys keep their current values.
+   */
   distributorUpdate: components.DistributorUpdate;
 };
 

package/src/models/operations/patchmanufacturer.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type PatchManufacturerRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to change on the manufacturer. Omitted keys stay unchanged.
+   */
   manufacturerUpdate: components.ManufacturerUpdate;
 };
 

package/src/models/operations/patchmedicalproduct.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type PatchMedicalProductRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to change on the medical product. Omitted keys stay unchanged.
+   */
   medicalProductUpdate: components.MedicalProductUpdate;
 };
 

package/src/models/operations/patchmedicalproductcategory.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type PatchMedicalProductCategoryRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to change on the product category. Omitted keys stay unchanged.
+   */
   medicalProductCategoryUpdate: components.MedicalProductCategoryUpdate;
 };
 

package/src/models/operations/patchmedicalproductfamily.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type PatchMedicalProductFamilyRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to change on the product family. Omitted keys stay unchanged.
+   */
   medicalProductFamilyUpdate: components.MedicalProductFamilyUpdate;
 };
 

package/src/models/operations/postauthenticate.ts

@@ -17,7 +17,7 @@ export type PostAuthenticateRequestBody =
   | components.LoginRequirementsFromEmail;
 
 /**
- * The request has been accepted for processing, but the processing has not been completed. The request might be processed later.
+ * Returned when authentication needs another step. Contains a `requires` value that says which step comes next: a password, a password setup, a multi-factor code or a SAML sign-in.
  */
 export type PostAuthenticateResponseBody =
   | components.MfaRequiredResponse

package/src/models/operations/purchasescrubcredits.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Whether to pay later and the ID of the scrub credit variant to purchase.
+ */
 export type PurchaseScrubCreditsRequestBody = {
   payLater: boolean;
   variantId: number;
@@ -19,17 +22,20 @@ export type PurchaseScrubCreditsRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
+  /**
+   * Whether to pay later and the ID of the scrub credit variant to purchase.
+   */
   requestBody: PurchaseScrubCreditsRequestBody;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the ID of the purchase invoice and the vendor's updated credit balance.
  */
 export type PurchaseScrubCreditsPurchaseScrubCreditsOk = {
   invoiceId?: number | undefined;

package/src/models/operations/rotateapikey.ts

@@ -10,7 +10,7 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the replacement API key. The previous key stops working immediately.
  */
 export type RotateApiKeyRotateApiKeyOk = {
   success: boolean;

package/src/models/operations/securityzonecheckin.ts

@@ -59,7 +59,7 @@ export type RequestBody2 = {
   visitContact?: string | undefined;
   token?: string | undefined;
   /**
-   * Search for objects in the same scan_type as the search string
+   * Search for objects in the same `scan_type` as the search string
    */
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
@@ -111,7 +111,7 @@ export type One = {
   visitContact?: string | undefined;
   token?: string | undefined;
   /**
-   * Search for objects in the same scan_type as the search string
+   * Search for objects in the same `scan_type` as the search string
    */
   scanType?: components.ScanType | undefined;
   recheckVendorScanId?: number | undefined;
@@ -119,6 +119,9 @@ export type One = {
   expand?: Array<RequestBodyExpand> | undefined;
 };
 
+/**
+ * Location or QR code details for the security zone check-in.
+ */
 export type SecurityZoneCheckinRequestBody = One | RequestBody2;
 
 export const Requires = {
@@ -142,18 +145,18 @@ export type Results = {
   eyeColor?: string | null | undefined;
   isScannedIn?: boolean | undefined;
   /**
-   * Reduced list of attributes of VendorScan record
+   * Reduced list of attributes of the `VendorScan` record
    */
   scanInVendorScan?: components.VendorScan | null | undefined;
   screeningResponses?: Array<components.ScreeningResponse | null> | undefined;
   /**
-   * Reduced list of attributes of VendorScan record
+   * Reduced list of attributes of the `VendorScan` record
    */
   vendorScan?: components.VendorScan | null | undefined;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns whether the check-in request succeeded and what, if anything, is still required to complete the check-in.
  */
 export type SecurityZoneCheckinSecurityZoneCheckinOk = {
   success?: boolean | undefined;

package/src/models/operations/senddownloadcode.ts

@@ -12,6 +12,9 @@ export const Via = {
 } as const;
 export type Via = ClosedEnum<typeof Via>;
 
+/**
+ * The delivery method for the download code.
+ */
 export type SendDownloadCodeRequestBody = {
   via: Via;
 };
@@ -21,6 +24,9 @@ export type SendDownloadCodeRequest = {
    * ID of the vendor credential rep.
    */
   vendorCredentialId: number;
+  /**
+   * The delivery method for the download code.
+   */
   requestBody: SendDownloadCodeRequestBody;
 };
 

package/src/models/operations/submitscreeningresponse.ts

@@ -10,9 +10,12 @@ import * as types from "../../types/primitives.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The answer to submit for a screening question.
+ */
 export type SubmitScreeningResponseRequestBody = {
   /**
-   * ID of the screening question being answered.
+   * ID of the screening question to answer.
    */
   screeningQuestionId: number;
   /**
@@ -39,14 +42,17 @@ export type SubmitScreeningResponseRequestBody = {
 
 export type SubmitScreeningResponseRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The answer to submit for a screening question.
+   */
   requestBody: SubmitScreeningResponseRequestBody;
 };
 
 /**
- * Response returned after a screening question answer is submitted.
+ * Response the server returns after a vendor submits a screening question answer.
  *
  * @remarks
  */
@@ -59,7 +65,7 @@ export type SubmitScreeningResponseResponseBody = {
    */
   hasNextQuestion?: boolean | undefined;
   /**
-   * List of actions triggered by this screening response. Present only when there is no next question (i.e., `has_next_question` is false).
+   * List of actions triggered by this screening response. Present only when there is no next question (that is, `has_next_question` is false).
    *
    * @remarks
    */

package/src/models/operations/submitvendorcredential.ts

@@ -5,6 +5,9 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
+/**
+ * Notes and JSON data to submit with the vendor credential.
+ */
 export type SubmitVendorCredentialRequestBody = {
   notes?: string | undefined;
   jsonData?: string | undefined;
@@ -15,6 +18,9 @@ export type SubmitVendorCredentialRequest = {
    * ID of the vendor credential rep.
    */
   vendorCredentialId: number;
+  /**
+   * Notes and JSON data to submit with the vendor credential.
+   */
   requestBody: SubmitVendorCredentialRequestBody;
 };
 

package/src/models/operations/switchaccount.ts

@@ -10,13 +10,16 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The linked user to switch to and, for API integrations, the user whose session to switch.
+ */
 export type SwitchAccountRequestBody = {
   /**
    * ID of the linked user to switch to
    */
   targetUserId: number;
   /**
-   * Required for API integrations. The ID of the user whose session will be switched. The API user must have an app activation for this user.
+   * Required for API integrations. The ID of the user whose session the server switches. The API user must have an app activation for this user.
    *
    * @remarks
    */
@@ -34,7 +37,7 @@ export type UserToken = {
 };
 
 /**
- * Successfully switched. Use the returned token with GET /users/:id to fetch full user data.
+ * Successfully switched. Use the returned token with `GET /users/:id` to fetch full user data.
  */
 export type SwitchAccountResponseBody = {
   userToken: UserToken;

package/src/models/operations/updatedatarequest.ts

@@ -5,15 +5,21 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 
+/**
+ * Attributes to update on the vendor credential data request.
+ */
 export type UpdateDataRequestRequestBody = {
   value?: string | undefined;
 };
 
 export type UpdateDataRequestRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Attributes to update on the vendor credential data request.
+   */
   requestBody: UpdateDataRequestRequestBody;
 };
 

package/src/models/operations/updatedistributor.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdateDistributorRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The distributor attributes to change. Omitted keys keep their current values.
+   */
   distributorUpdate: components.DistributorUpdate;
 };
 

package/src/models/operations/updateevent.ts

@@ -9,9 +9,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The appointment details to change, such as the reason, dates, and notes.
+ */
 export type UpdateEventRequestBody = {
   /**
-   * The reason for the appointment, shown as its title. Send it already trimmed and no longer than 255 characters; leading and trailing whitespace is stripped before the value is stored. An over-long reason is rejected with a `400` whose `error` reads `The reason for appointment must be 255 characters or fewer.` The server applies that limit to the trimmed value, so the `maxLength` declared here is the marginally stricter bound a client can always rely on.
+   * The reason for the appointment, shown as its title. Send it already trimmed and no longer than 255 characters; the server strips leading and trailing whitespace before it stores the value. The server rejects an over-long reason with a `400` whose `error` reads `The reason for appointment must be 255 characters or fewer.` The server applies that limit to the trimmed value, so the `maxLength` declared here is the marginally stricter bound a client can always rely on.
    */
   name?: string | undefined;
   bringingFood?: boolean | undefined;
@@ -19,7 +22,7 @@ export type UpdateEventRequestBody = {
    * Date and time in 12-hour format with 15-minute precision.
    *
    * @remarks
-   * Format: MM/DD/YYYY h:mm am/pm (e.g., "07/18/2025 12:15 pm" or "7:15 pm").
+   * Format: MM/DD/YYYY h:mm am/pm (for example, "07/18/2025 12:15 PM" or "7:15 PM").
    * - Hours: 1 to 12 (zero-padded or not)
    * - Minutes: 00, 15, 30, or 45
    * - AM/PM in lowercase
@@ -29,7 +32,7 @@ export type UpdateEventRequestBody = {
    * Date and time in 12-hour format with 15-minute precision.
    *
    * @remarks
-   * Format: MM/DD/YYYY h:mm am/pm (e.g., "07/18/2025 12:15 pm" or "7:15 pm").
+   * Format: MM/DD/YYYY h:mm am/pm (for example, "07/18/2025 12:15 PM" or "7:15 PM").
    * - Hours: 1 to 12 (zero-padded or not)
    * - Minutes: 00, 15, 30, or 45
    * - AM/PM in lowercase
@@ -40,14 +43,17 @@ export type UpdateEventRequestBody = {
 
 export type UpdateEventRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The appointment details to change, such as the reason, dates, and notes.
+   */
   requestBody: UpdateEventRequestBody;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns `success` set to `true` when the update succeeds.
  */
 export type UpdateEventUpdateEventOk = {
   success?: boolean | undefined;

package/src/models/operations/updatefhirconfigbyid.ts

@@ -8,11 +8,11 @@ import * as components from "../components/index.js";
 
 export type UpdateFhirConfigByIdRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
-   * Any key/value pair of a FHIR config
+   * Any key-value pair of a FHIR configuration
    */
   fhirConfigPartialUpdate: components.FhirConfigPartialUpdate;
 };

package/src/models/operations/updateinvoice.ts

@@ -143,6 +143,9 @@ export type UpdateInvoiceRequestBody1 = {
   credentialPricingIds?: Array<number> | null | undefined;
 };
 
+/**
+ * The lines that replace all existing lines on the invoice.
+ */
 export type UpdateInvoiceRequestBody =
   | UpdateInvoiceRequestBody1
   | UpdateInvoiceRequestBody2
@@ -152,9 +155,12 @@ export type UpdateInvoiceRequestBody =
 
 export type UpdateInvoiceRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The lines that replace all existing lines on the invoice.
+   */
   requestBody:
     | UpdateInvoiceRequestBody1
     | UpdateInvoiceRequestBody2

package/src/models/operations/updatemanufacturer.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdateManufacturerRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to set on the manufacturer. Omitted keys stay unchanged.
+   */
   manufacturerUpdate: components.ManufacturerUpdate;
 };
 

package/src/models/operations/updatemedicalproduct.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdateMedicalProductRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to set on the medical product. Omitted keys stay unchanged.
+   */
   medicalProductUpdate: components.MedicalProductUpdate;
 };
 

package/src/models/operations/updatemedicalproductcategory.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdateMedicalProductCategoryRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to set on the product category. Omitted keys stay unchanged.
+   */
   medicalProductCategoryUpdate: components.MedicalProductCategoryUpdate;
 };
 

package/src/models/operations/updatemedicalproductfamily.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdateMedicalProductFamilyRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * Fields to set on the product family. Omitted keys stay unchanged.
+   */
   medicalProductFamilyUpdate: components.MedicalProductFamilyUpdate;
 };
 

package/src/models/operations/updatesthewebhookendpointwiththegivenid.ts

@@ -8,9 +8,12 @@ import * as components from "../components/index.js";
 
 export type UpdatesTheWebhookEndpointWithTheGivenIdRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
+  /**
+   * The fields to change on the webhook endpoint. Omitted fields keep their current values.
+   */
   webhookEndpointUpdate: components.WebhookEndpointUpdate;
 };
 

package/src/models/operations/updateuser.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Fields to update on the user profile. Send only the fields you want to change.
+ */
 export type UpdateUserRequestBody = {
   firstName?: string | undefined;
   lastName?: string | undefined;
@@ -37,10 +40,10 @@ export type UpdateUserRequestBody = {
    *
    * 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?: components.EmailPreferences | undefined;
@@ -51,10 +54,13 @@ export type UpdateUserRequest = {
    * Either `me` for the authenticated user, or a positive integer user ID.
    *
    * @remarks
-   * Other values (including `0` and non-numeric strings) are rejected with
+   * Other values (including `0` and non-numeric strings) cause the server to return
    * a `422 Unprocessable Entity`.
    */
   id: string;
+  /**
+   * Fields to update on the user profile. Send only the fields you want to change.
+   */
   requestBody: UpdateUserRequestBody;
 };
 

package/src/models/operations/updateuseralerts.ts

@@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * The alerts and alert targets to update for the user.
+ */
 export type UpdateUserAlertsRequestBody = {
   alertIds?: Array<number> | undefined;
   alertTargetIds?: Array<number> | undefined;
@@ -21,7 +24,7 @@ export type UpdateUserAlertsRequestBody = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns `success` to confirm that the server updated the user's alerts.
  */
 export type UpdateUserAlertsUpdateUserAlertsOk = {
   success?: boolean | undefined;

package/src/models/operations/updateuserprofilepicture.ts

@@ -11,7 +11,7 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * MIME type of the image
+ * Multipurpose Internet Mail Extensions (MIME) type of the image
  */
 export const ImageContentType = {
   ImageJpeg: "image/jpeg",
@@ -20,17 +20,20 @@ export const ImageContentType = {
   ImageWebp: "image/webp",
 } as const;
 /**
- * MIME type of the image
+ * Multipurpose Internet Mail Extensions (MIME) type of the image
  */
 export type ImageContentType = ClosedEnum<typeof ImageContentType>;
 
+/**
+ * The image filename, content type, and size in bytes.
+ */
 export type UpdateUserProfilePictureRequestBody = {
   /**
-   * Original file name of the image
+   * Original filename of the image
    */
   imageFileName: string;
   /**
-   * MIME type of the image
+   * Multipurpose Internet Mail Extensions (MIME) type of the image
    */
   imageContentType: ImageContentType;
   /**
@@ -41,14 +44,17 @@ export type UpdateUserProfilePictureRequestBody = {
 
 export type UpdateUserProfilePictureRequest = {
   /**
-   * Either the ID of the user rep or the keyword "me" to represent the current user.
+   * Either the ID of the user rep or the keyword `me` to represent the current user.
    */
   idOrMe: string;
+  /**
+   * The image filename, content type, and size in bytes.
+   */
   requestBody: UpdateUserProfilePictureRequestBody;
 };
 
 /**
- * Metadata registered. Upload the file to the returned presigned S3 URL using HTTP PUT with the same Content-Type as image_content_type.
+ * Metadata registered. Upload the file to the returned presigned S3 URL using an HTTP `PUT` request with the same `Content-Type` header as `image_content_type`.
  */
 export type UpdateUserProfilePictureUpdateUserProfilePictureOk = {
   /**
@@ -56,7 +62,7 @@ export type UpdateUserProfilePictureUpdateUserProfilePictureOk = {
    */
   id: number;
   /**
-   * Presigned S3 URL for uploading the image file via HTTP PUT. The URL is short-lived and tied to the image_content_type submitted in the request.
+   * Presigned S3 URL for uploading the image file using an HTTP `PUT` request. The URL is short-lived and tied to the image_content_type submitted in the request.
    */
   uploadUrl: string;
 };