@greensecurity/javascript-sdk 0.43.1-beta.132 → 0.43.1-beta.133

package/src/models/components/userdetails.ts

@@ -11,6 +11,10 @@ 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";
 
@@ -74,6 +78,19 @@ export type UserDetails = {
    * 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 */
@@ -102,6 +119,7 @@ export const UserDetails$inboundSchema: z.ZodType<
   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",
@@ -111,6 +129,7 @@ export const UserDetails$inboundSchema: z.ZodType<
     "email_confirmed": "emailConfirmed",
     "user_type": "userType",
     "image_urls": "imageUrls",
+    "email_preferences": "emailPreferences",
   });
 });
 

package/src/models/components/vendor.ts

@@ -131,7 +131,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;
@@ -197,6 +216,10 @@ export type Vendor = {
    * 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;
 };
 
 /** @internal */
@@ -596,6 +619,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
     target_facilities_updated: z.nullable(types.string()).optional(),
     custom_fields: z.nullable(z.array(VendorCustomFields$inboundSchema))
       .optional(),
+    last_scanned: z.nullable(types.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "email_recepient": "emailRecepient",
@@ -624,6 +648,7 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
       "has_credentialed_facilities": "hasCredentialedFacilities",
       "target_facilities_updated": "targetFacilitiesUpdated",
       "custom_fields": "customFields",
+      "last_scanned": "lastScanned",
     });
   });
 

package/src/models/components/vendortype.ts

@@ -4,6 +4,7 @@
  */
 
 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";
@@ -12,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type VendorType = {
   id?: number | undefined;
   name?: string | undefined;
+  shortName?: string | null | undefined;
 };
 
 /** @internal */
@@ -22,6 +24,11 @@ export const VendorType$inboundSchema: z.ZodType<
 > = z.object({
   id: types.optional(types.number()),
   name: types.optional(types.string()),
+  short_name: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "short_name": "shortName",
+  });
 });
 
 export function vendorTypeFromJSON(

package/src/models/operations/{createvendorbycompanymanager.ts → createvendor.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 4813c9f81c74
+ * @generated-id: abd496c93274
  */
 
 import * as z from "zod/v3";
@@ -10,7 +10,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type CreateVendorByCompanyManagerRequestBody = {
+export type CreateVendorRequestBody = {
   /**
    * The vendor's email address
    */
@@ -84,18 +84,18 @@ export type CreateVendorByCompanyManagerRequestBody = {
    */
   zip: string;
   /**
-   * Required for API users. The company manager user ID to act on behalf of.
+   * The company to register the vendor under. Required for all callers except
    *
    * @remarks
-   * The marketplace app must be activated for this user.
+   * company managers, who default to their own company if omitted.
    */
-  sourceUserId?: number | undefined;
+  companyId?: number | undefined;
 };
 
 /**
  * Vendor created successfully.
  */
-export type CreateVendorByCompanyManagerResponseBody = {
+export type CreateVendorResponseBody = {
   /**
    * ID of the newly created vendor
    */
@@ -103,7 +103,7 @@ export type CreateVendorByCompanyManagerResponseBody = {
 };
 
 /** @internal */
-export type CreateVendorByCompanyManagerRequestBody$Outbound = {
+export type CreateVendorRequestBody$Outbound = {
   email: string;
   first_name: string;
   last_name: string;
@@ -122,14 +122,14 @@ export type CreateVendorByCompanyManagerRequestBody$Outbound = {
   city: string;
   state: string;
   zip: string;
-  source_user_id?: number | undefined;
+  company_id?: number | undefined;
 };
 
 /** @internal */
-export const CreateVendorByCompanyManagerRequestBody$outboundSchema: z.ZodType<
-  CreateVendorByCompanyManagerRequestBody$Outbound,
+export const CreateVendorRequestBody$outboundSchema: z.ZodType<
+  CreateVendorRequestBody$Outbound,
   z.ZodTypeDef,
-  CreateVendorByCompanyManagerRequestBody
+  CreateVendorRequestBody
 > = z.object({
   email: z.string(),
   firstName: z.string(),
@@ -149,7 +149,7 @@ export const CreateVendorByCompanyManagerRequestBody$outboundSchema: z.ZodType<
   city: z.string(),
   state: z.string(),
   zip: z.string(),
-  sourceUserId: z.number().int().optional(),
+  companyId: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     firstName: "first_name",
@@ -158,24 +158,21 @@ export const CreateVendorByCompanyManagerRequestBody$outboundSchema: z.ZodType<
     supervisorName: "supervisor_name",
     supervisorEmail: "supervisor_email",
     supervisorPhone: "supervisor_phone",
-    sourceUserId: "source_user_id",
+    companyId: "company_id",
   });
 });
 
-export function createVendorByCompanyManagerRequestBodyToJSON(
-  createVendorByCompanyManagerRequestBody:
-    CreateVendorByCompanyManagerRequestBody,
+export function createVendorRequestBodyToJSON(
+  createVendorRequestBody: CreateVendorRequestBody,
 ): string {
   return JSON.stringify(
-    CreateVendorByCompanyManagerRequestBody$outboundSchema.parse(
-      createVendorByCompanyManagerRequestBody,
-    ),
+    CreateVendorRequestBody$outboundSchema.parse(createVendorRequestBody),
   );
 }
 
 /** @internal */
-export const CreateVendorByCompanyManagerResponseBody$inboundSchema: z.ZodType<
-  CreateVendorByCompanyManagerResponseBody,
+export const CreateVendorResponseBody$inboundSchema: z.ZodType<
+  CreateVendorResponseBody,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -186,18 +183,12 @@ export const CreateVendorByCompanyManagerResponseBody$inboundSchema: z.ZodType<
   });
 });
 
-export function createVendorByCompanyManagerResponseBodyFromJSON(
+export function createVendorResponseBodyFromJSON(
   jsonString: string,
-): SafeParseResult<
-  CreateVendorByCompanyManagerResponseBody,
-  SDKValidationError
-> {
+): SafeParseResult<CreateVendorResponseBody, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      CreateVendorByCompanyManagerResponseBody$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'CreateVendorByCompanyManagerResponseBody' from JSON`,
+    (x) => CreateVendorResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateVendorResponseBody' from JSON`,
   );
 }

package/src/models/operations/getuserbyid.ts

@@ -4,17 +4,27 @@
  */
 
 import * as z from "zod/v3";
+import * as components from "../components/index.js";
 
 export type GetUserByIdRequest = {
   /**
-   * The identifier of the object
+   * Either `me` for the authenticated user, or a positive integer user ID.
+   *
+   * @remarks
+   * Other values (including `0` and non-numeric strings) are rejected with
+   * a `422 Unprocessable Entity`.
    */
-  id: number;
+  id: string;
+  /**
+   * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
+   */
+  expand?: Array<components.Expand> | undefined;
 };
 
 /** @internal */
 export type GetUserByIdRequest$Outbound = {
-  id: number;
+  id: string;
+  expand?: Array<string> | undefined;
 };
 
 /** @internal */
@@ -23,7 +33,8 @@ export const GetUserByIdRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetUserByIdRequest
 > = z.object({
-  id: z.number().int(),
+  id: z.string(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
 });
 
 export function getUserByIdRequestToJSON(

package/src/models/operations/index.ts

@@ -19,7 +19,7 @@ export * from "./createevent.js";
 export * from "./createinvoice.js";
 export * from "./createnewvendorcredentialversion.js";
 export * from "./createorupdatebcr.js";
-export * from "./createvendorbycompanymanager.js";
+export * from "./createvendor.js";
 export * from "./createvendorcompany.js";
 export * from "./createvendorfield.js";
 export * from "./createvendorregistration.js";

package/src/models/operations/updateuser.ts

@@ -28,11 +28,28 @@ export type UpdateUserRequestBody = {
   country?: string | undefined;
   timezone?: string | undefined;
   utcOffset?: number | 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?: components.EmailPreferences | undefined;
 };
 
 export type UpdateUserRequest = {
   /**
-   * Numeric user ID or `me` for the authenticated user.
+   * Either `me` for the authenticated user, or a positive integer user ID.
+   *
+   * @remarks
+   * Other values (including `0` and non-numeric strings) are rejected with
+   * a `422 Unprocessable Entity`.
    */
   id: string;
   requestBody: UpdateUserRequestBody;
@@ -67,6 +84,7 @@ export type UpdateUserRequestBody$Outbound = {
   country?: string | undefined;
   timezone?: string | undefined;
   utc_offset?: number | undefined;
+  email_preferences?: components.EmailPreferences$Outbound | undefined;
 };
 
 /** @internal */
@@ -92,12 +110,14 @@ export const UpdateUserRequestBody$outboundSchema: z.ZodType<
   country: z.string().optional(),
   timezone: z.string().optional(),
   utcOffset: z.number().optional(),
+  emailPreferences: components.EmailPreferences$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     firstName: "first_name",
     lastName: "last_name",
     mobilePhone: "mobile_phone",
     utcOffset: "utc_offset",
+    emailPreferences: "email_preferences",
   });
 });
 

package/src/models/operations/updatevendordetails.ts

@@ -9,7 +9,15 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
 /**
- * The vendor's email_recepient value to update
+ * **Deprecated.** Use `PUT /api/users/:id` with
+ *
+ * @remarks
+ * `email_preferences.notification_recipients` instead.
+ * The handler dual-writes to the user-side field during the
+ * migration window; this field will be removed once SDK
+ * consumers migrate.
+ *
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export const EmailRecepient = {
   NoEmail: "No email",
@@ -18,7 +26,15 @@ export const EmailRecepient = {
   VendorAndCompanyManager: "Vendor and company manager",
 } as const;
 /**
- * The vendor's email_recepient value to update
+ * **Deprecated.** Use `PUT /api/users/:id` with
+ *
+ * @remarks
+ * `email_preferences.notification_recipients` instead.
+ * The handler dual-writes to the user-side field during the
+ * migration window; this field will be removed once SDK
+ * consumers migrate.
+ *
+ * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type EmailRecepient = ClosedEnum<typeof EmailRecepient>;
 
@@ -28,11 +44,27 @@ export type UpdateVendorDetailsRequestBody = {
    */
   qrCode?: string | undefined;
   /**
-   * The vendor's email_recepient value to update
+   * **Deprecated.** Use `PUT /api/users/:id` with
+   *
+   * @remarks
+   * `email_preferences.notification_recipients` instead.
+   * The handler dual-writes to the user-side field during the
+   * migration window; this field 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?: EmailRecepient | undefined;
   /**
-   * The vendor's send_weekly_summary_email value to update
+   * **Deprecated.** Use `PUT /api/users/:id` with
+   *
+   * @remarks
+   * `email_preferences.send_weekly_summary_email` instead.
+   * The handler dual-writes to the user-side field during the
+   * migration window; this field 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 | undefined;
   /**

package/src/react-query/index.ts

@@ -79,7 +79,7 @@ export * from "./vendorsChangeSubscription.js";
 export * from "./vendorsCheckDownloadCode.js";
 export * from "./vendorsCreateNewVendorCredentialVersion.js";
 export * from "./vendorsCreateOrUpdateBcr.js";
-export * from "./vendorsCreateVendorByCompanyManager.js";
+export * from "./vendorsCreateVendor.js";
 export * from "./vendorsCreateVendorCompany.js";
 export * from "./vendorsCreateVendorRegistration.js";
 export * from "./vendorsDeclineVendorCredential.js";

package/src/react-query/usersGetCurrentUser.ts

@@ -59,7 +59,17 @@ export type UsersGetCurrentUserQueryError =
  *
  * @remarks
  * Returns a user object for the user represented by the authorization token.
- * For Company Manager users, the `company` object supports expand. Available values: company.vendor_fields, company.location, company.vendor_type_restrictions.
+ *
+ * By default the response returns a compact profile (id, name, email,
+ * phone, timezone, user type, and a handful of confirmation flags).
+ *
+ * Supported `expand` values:
+ * - `user` — return the full user record, including all profile fields stored against the user (sensitive columns such as passwords, MFA codes, and payment-provider IDs are always omitted)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+ * - `company.location`, `company.vendor_type_restrictions`, `company.vendor_fields` — only valid for Company Manager users; embed extra fields on the user's company
+ *
+ * Multiple values can be combined with commas, e.g.
+ * `?expand=user.email_preferences,company.location`.
  */
 export function useUsersGetCurrentUser(
   request: operations.GetCurrentUserRequest,
@@ -84,7 +94,17 @@ export function useUsersGetCurrentUser(
  *
  * @remarks
  * Returns a user object for the user represented by the authorization token.
- * For Company Manager users, the `company` object supports expand. Available values: company.vendor_fields, company.location, company.vendor_type_restrictions.
+ *
+ * By default the response returns a compact profile (id, name, email,
+ * phone, timezone, user type, and a handful of confirmation flags).
+ *
+ * Supported `expand` values:
+ * - `user` — return the full user record, including all profile fields stored against the user (sensitive columns such as passwords, MFA codes, and payment-provider IDs are always omitted)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
+ * - `company.location`, `company.vendor_type_restrictions`, `company.vendor_fields` — only valid for Company Manager users; embed extra fields on the user's company
+ *
+ * Multiple values can be combined with commas, e.g.
+ * `?expand=user.email_preferences,company.location`.
  */
 export function useUsersGetCurrentUserSuspense(
   request: operations.GetCurrentUserRequest,

package/src/react-query/usersGetUserById.core.ts

@@ -43,7 +43,7 @@ export function buildUsersGetUserByIdQuery(
   ) => Promise<UsersGetUserByIdQueryData>;
 } {
   return {
-    queryKey: queryKeyUsersGetUserById(request.id),
+    queryKey: queryKeyUsersGetUserById(request.id, { expand: request.expand }),
     queryFn: async function usersGetUserByIdQueryFn(
       ctx,
     ): Promise<UsersGetUserByIdQueryData> {
@@ -67,6 +67,15 @@ export function buildUsersGetUserByIdQuery(
   };
 }
 
-export function queryKeyUsersGetUserById(id: number): QueryKey {
-  return ["@greensecurity/javascript-sdk", "users", "getUserById", id];
+export function queryKeyUsersGetUserById(
+  id: string,
+  parameters: { expand?: Array<components.Expand> | undefined },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "users",
+    "getUserById",
+    id,
+    parameters,
+  ];
 }

package/src/react-query/usersGetUserById.ts

@@ -11,6 +11,7 @@ import {
   useSuspenseQuery,
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
+import * as components from "../models/components/index.js";
 import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
 import {
   ConnectionError,
@@ -57,7 +58,15 @@ export type UsersGetUserByIdQueryError =
  * Get user by id
  *
  * @remarks
- * Returns a user object for the user represented by the identifier in the path.
+ * Returns a user object for the user represented by the identifier in
+ * the path.
+ *
+ * By default the response returns a compact profile (id, name, email,
+ * phone, timezone, user type, and a handful of confirmation flags).
+ *
+ * Supported `expand` values:
+ * - `user` — return the full user record (sensitive columns such as passwords and payment-provider IDs are always omitted)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
  */
 export function useUsersGetUserById(
   request: operations.GetUserByIdRequest,
@@ -81,7 +90,15 @@ export function useUsersGetUserById(
  * Get user by id
  *
  * @remarks
- * Returns a user object for the user represented by the identifier in the path.
+ * Returns a user object for the user represented by the identifier in
+ * the path.
+ *
+ * By default the response returns a compact profile (id, name, email,
+ * phone, timezone, user type, and a handful of confirmation flags).
+ *
+ * Supported `expand` values:
+ * - `user` — return the full user record (sensitive columns such as passwords and payment-provider IDs are always omitted)
+ * - `user.email_preferences` — include the user's `email_preferences` block (notification recipients and weekly email flags)
  */
 export function useUsersGetUserByIdSuspense(
   request: operations.GetUserByIdRequest,
@@ -106,7 +123,10 @@ export function useUsersGetUserByIdSuspense(
 
 export function setUsersGetUserByIdData(
   client: QueryClient,
-  queryKeyBase: [id: number],
+  queryKeyBase: [
+    id: string,
+    parameters: { expand?: Array<components.Expand> | undefined },
+  ],
   data: UsersGetUserByIdQueryData,
 ): UsersGetUserByIdQueryData | undefined {
   const key = queryKeyUsersGetUserById(...queryKeyBase);
@@ -116,7 +136,9 @@ export function setUsersGetUserByIdData(
 
 export function invalidateUsersGetUserById(
   client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[id: number]>,
+  queryKeyBase: TupleToPrefixes<
+    [id: string, parameters: { expand?: Array<components.Expand> | undefined }]
+  >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
 ): Promise<void> {
   return client.invalidateQueries({

package/src/react-query/usersUpdateUser.ts

@@ -50,12 +50,22 @@ export type UsersUpdateUserMutationError =
  * Update user by ID
  *
  * @remarks
- * Updates the contact information, address, and locale settings of a user.
- * Pass `me` as `{id}` to update the authenticated user's own profile.
+ * Updates the contact information, address, locale settings, and email
+ * preferences of a user. Pass `me` as `{id}` to update the authenticated
+ * user's own profile, or a positive integer user ID otherwise.
  *
  * Only submitted fields are applied — unrecognised fields are silently ignored.
  * Changing `email` automatically resets `bounced_email` to `false`.
  *
+ * Each subkey of `email_preferences` is independently optional; sending
+ * `{ "email_preferences": { "send_weekly_summary_email": true } }` flips
+ * only that flag and leaves the others unchanged.
+ *
+ * If the request body includes an `email_preferences` block, the response
+ * echoes the persisted values back as `user.email_preferences` so the
+ * client can confirm the write without a follow-up
+ * `GET ?expand=user.email_preferences` call.
+ *
  * To rotate an API token use `POST /users/api_key_rotator` instead.
  */
 export function useUsersUpdateUserMutation(