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

package/src/__tests__/vendors.test.ts

@@ -1064,8 +1064,14 @@ test("Vendors Update Vendor Custom Field", async () => {
   expect(result).toEqual({});
 });
 
-test("Vendors Create Vendor By Company Manager", async () => {
-  const testHttpClient = createTestHTTPClient("createVendorByCompanyManager");
+it.skip("Vendors Create Vendor By Company Manager", async () => {
+  assert.fail(
+    "incomplete test found please make sure to address the following errors: [`workflow step createVendorByCompanyManager.test referencing operation createVendorByCompanyManager not found in document`]",
+  );
+});
+
+test("Vendors Create Vendor", async () => {
+  const testHttpClient = createTestHTTPClient("createVendor");
 
   const greenSecurity = new GreenSecurity({
     serverURL: process.env["TEST_SERVER_URL"] ?? "https://localhost:3000/api",
@@ -1075,24 +1081,24 @@ test("Vendors Create Vendor By Company Manager", async () => {
     },
   });
 
-  const result = await greenSecurity.vendors.createVendorByCompanyManager({
-    email: "Florine.Hammes@gmail.com",
-    firstName: "Marietta",
-    lastName: "Wehner",
+  const result = await greenSecurity.vendors.createVendor({
+    email: "Lillie11@gmail.com",
+    firstName: "Nannie",
+    lastName: "Conroy",
     title: "<value>",
-    phone: "1-502-438-3106 x58367",
-    primaryFacilityId: 803558,
+    phone: "611-206-9678",
+    primaryFacilityId: 450969,
     supervisorName: "<value>",
-    supervisorEmail: "Saige.Koss11@hotmail.com",
+    supervisorEmail: "Nettie.Prohaska-Frami37@yahoo.com",
     supervisorPhone: "<value>",
-    country: "Comoros",
+    country: "Tuvalu",
     address1: "<value>",
-    city: "Ornton",
-    state: "North Carolina",
-    zip: "80053",
+    city: "Las Cruces",
+    state: "Utah",
+    zip: "42613",
   });
   expect(result).toBeDefined();
   expect(result).toEqual({
-    vendorId: 554318,
+    vendorId: 333613,
   });
 });

package/src/__tests__/zones.test.ts

@@ -39,12 +39,9 @@ test("Zones List Or Search Security Zones", async () => {
       {
         facility: {
           contacts: {
-            contact: {
-              status: "Deleted",
-              department: 123,
-            },
+            contact: null,
             adminContact: {
-              status: "Active",
+              status: "Inactive",
               department: 123,
             },
             techContact: {
@@ -52,8 +49,8 @@ test("Zones List Or Search Security Zones", async () => {
               department: 123,
             },
             greenSecurityCsm: {
-              status: "Inactive",
-              department: 123,
+              status: "Active",
+              department: null,
             },
             accountManager: {
               status: "Active",
@@ -61,7 +58,7 @@ test("Zones List Or Search Security Zones", async () => {
             },
           },
           vendorGuestPolicy: {
-            enabled: false,
+            enabled: true,
             vendorGuestLimitAndOr: "and",
             vendorGuestRequireEmail: false,
           },
@@ -86,8 +83,9 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    qrCode: "<value>",
-    zoneId: 185875,
+    longitude: 4275.84,
+    latitude: 5120.17,
+    zoneId: 673216,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/funcs/usersGetCurrentUser.ts

@@ -33,7 +33,17 @@ import { Result } from "../types/fp.js";
  *
  * @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`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/src/funcs/usersGetUserById.ts

@@ -4,7 +4,7 @@
  */
 
 import { GreenSecurityCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -32,7 +32,15 @@ import { Result } from "../types/fp.js";
  * 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)
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
@@ -101,6 +109,10 @@ async function $do(
   };
   const path = pathToFunc("/users/{id}")(pathParams);
 
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+  }, { explode: false });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -129,6 +141,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,

package/src/funcs/usersUpdateUser.ts

@@ -31,12 +31,22 @@ import { Result } from "../types/fp.js";
  * 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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.

package/src/funcs/{vendorsCreateVendorByCompanyManager.ts → vendorsCreateVendor.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 3646515787f6
+ * @generated-id: 24cce6a339d6
  */
 
 import { GreenSecurityCore } from "../core.js";
@@ -28,24 +28,24 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create vendor on behalf of company manager
+ * Create a new vendor
  *
  * @remarks
- * Creates a new vendor account on behalf of the authenticated company manager.
- * The vendor is automatically linked to the company manager's company.
+ * Creates a new vendor account linked to the specified company.
  *
- * For API users: `source_user_id` is required. The API user acts on behalf of a company manager user.
- * The marketplace app must be activated for that user via MarketplaceAppActivation.
+ * `company_id` is optional for company managers — it defaults to their own company.
+ * All other callers must provide `company_id`. The caller must have access to the
+ * specified company (verified via scoped access policy) and the `vendors:add` permission.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */
-export function vendorsCreateVendorByCompanyManager(
+export function vendorsCreateVendor(
   client: GreenSecurityCore,
-  request: operations.CreateVendorByCompanyManagerRequestBody,
+  request: operations.CreateVendorRequestBody,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateVendorByCompanyManagerResponseBody,
+    operations.CreateVendorResponseBody,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -66,12 +66,12 @@ export function vendorsCreateVendorByCompanyManager(
 
 async function $do(
   client: GreenSecurityCore,
-  request: operations.CreateVendorByCompanyManagerRequestBody,
+  request: operations.CreateVendorRequestBody,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.CreateVendorByCompanyManagerResponseBody,
+      operations.CreateVendorResponseBody,
       | errors.ApiErrorResponse
       | GreenSecurityError
       | ResponseValidationError
@@ -87,10 +87,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.CreateVendorByCompanyManagerRequestBody$outboundSchema.parse(
-        value,
-      ),
+    (value) => operations.CreateVendorRequestBody$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -99,7 +96,7 @@ async function $do(
   const payload = parsed.value;
   const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/company-manager/vendors")();
+  const path = pathToFunc("/vendors")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -112,7 +109,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "createVendorByCompanyManager",
+    operationID: "createVendor",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -156,7 +153,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.CreateVendorByCompanyManagerResponseBody,
+    operations.CreateVendorResponseBody,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -167,10 +164,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(
-      201,
-      operations.CreateVendorByCompanyManagerResponseBody$inboundSchema,
-    ),
+    M.json(201, operations.CreateVendorResponseBody$inboundSchema),
     M.jsonErr([400, 401, 409, 422], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),

package/src/lib/config.ts

@@ -81,8 +81,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.11",
-  sdkVersion: "0.43.1-beta.132",
+  sdkVersion: "0.43.1-beta.134",
   genVersion: "2.882.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.43.1-beta.132 2.882.0 0.0.11 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.43.1-beta.134 2.882.0 0.0.11 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/emailpreferences.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2af302c1fbc3
+ */
+
+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";
+
+/**
+ * Who receives vendor-related notification emails:
+ *
+ * @remarks
+ * - `none` — no recipients
+ * - `self` — the user (vendor) themselves
+ * - `company_manager` — the vendor's company manager only
+ * - `self_and_company_manager` — both
+ */
+export const NotificationRecipients = {
+  None: "none",
+  Self: "self",
+  CompanyManager: "company_manager",
+  SelfAndCompanyManager: "self_and_company_manager",
+} as const;
+/**
+ * Who receives vendor-related notification emails:
+ *
+ * @remarks
+ * - `none` — no recipients
+ * - `self` — the user (vendor) themselves
+ * - `company_manager` — the vendor's company manager only
+ * - `self_and_company_manager` — both
+ */
+export type NotificationRecipients = OpenEnum<typeof NotificationRecipients>;
+
+/**
+ * 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.
+ */
+export type EmailPreferences = {
+  /**
+   * Who receives vendor-related notification emails:
+   *
+   * @remarks
+   * - `none` — no recipients
+   * - `self` — the user (vendor) themselves
+   * - `company_manager` — the vendor's company manager only
+   * - `self_and_company_manager` — both
+   */
+  notificationRecipients?: NotificationRecipients | null | undefined;
+  /**
+   * Whether the user receives the weekly vendor activity summary email.
+   */
+  sendWeeklySummaryEmail?: boolean | undefined;
+  /**
+   * Whether the user receives the weekly credentialing status summary email.
+   */
+  sendWeeklyCredentialingStatusEmail?: boolean | undefined;
+};
+
+/** @internal */
+export const NotificationRecipients$inboundSchema: z.ZodType<
+  NotificationRecipients,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(NotificationRecipients);
+/** @internal */
+export const NotificationRecipients$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  NotificationRecipients
+> = openEnums.outboundSchema(NotificationRecipients);
+
+/** @internal */
+export const EmailPreferences$inboundSchema: z.ZodType<
+  EmailPreferences,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  notification_recipients: z.nullable(NotificationRecipients$inboundSchema)
+    .optional(),
+  send_weekly_summary_email: types.optional(types.boolean()),
+  send_weekly_credentialing_status_email: types.optional(types.boolean()),
+}).transform((v) => {
+  return remap$(v, {
+    "notification_recipients": "notificationRecipients",
+    "send_weekly_summary_email": "sendWeeklySummaryEmail",
+    "send_weekly_credentialing_status_email":
+      "sendWeeklyCredentialingStatusEmail",
+  });
+});
+/** @internal */
+export type EmailPreferences$Outbound = {
+  notification_recipients?: string | null | undefined;
+  send_weekly_summary_email?: boolean | undefined;
+  send_weekly_credentialing_status_email?: boolean | undefined;
+};
+
+/** @internal */
+export const EmailPreferences$outboundSchema: z.ZodType<
+  EmailPreferences$Outbound,
+  z.ZodTypeDef,
+  EmailPreferences
+> = z.object({
+  notificationRecipients: z.nullable(NotificationRecipients$outboundSchema)
+    .optional(),
+  sendWeeklySummaryEmail: z.boolean().optional(),
+  sendWeeklyCredentialingStatusEmail: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    notificationRecipients: "notification_recipients",
+    sendWeeklySummaryEmail: "send_weekly_summary_email",
+    sendWeeklyCredentialingStatusEmail:
+      "send_weekly_credentialing_status_email",
+  });
+});
+
+export function emailPreferencesToJSON(
+  emailPreferences: EmailPreferences,
+): string {
+  return JSON.stringify(
+    EmailPreferences$outboundSchema.parse(emailPreferences),
+  );
+}
+export function emailPreferencesFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailPreferences, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailPreferences$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailPreferences' from JSON`,
+  );
+}

package/src/models/components/expand.ts

@@ -36,6 +36,8 @@ export const Expand = {
   VendorCreditBalance: "vendor.credit_balance",
   VendorHasCredentialedFacilities: "vendor.has_credentialed_facilities",
   VendorHasEmeraldStatus: "vendor.has_emerald_status",
+  VendorCustomFields: "vendor.custom_fields",
+  VendorLastScanned: "vendor.last_scanned",
   VendorImageUrls: "vendor.image_urls",
   VendorPrimaryFacility: "vendor.primary_facility",
   VendorPrimaryDepartment: "vendor.primary_department",
@@ -105,6 +107,13 @@ export const Expand = {
   SystemFacilities: "system.facilities",
   SystemLocation: "system.location",
   SubscriptionExpeditedOffer: "subscription.expedited_offer",
+  SubscriptionExpeditedOffers: "subscription.expedited_offers",
+  SubscriptionDateEnds: "subscription.date_ends",
+  SubscriptionVariantTitle: "subscription.variant_title",
+  SubscriptionCurrentLineItem: "subscription.current_line_item",
+  SubscriptionNextLineItem: "subscription.next_line_item",
+  SubscriptionCurrentFinancialStatus: "subscription.current_financial_status",
+  SubscriptionNextFinancialStatus: "subscription.next_financial_status",
   DepartmentMembershipContact: "department_membership.contact",
   DepartmentMembershipDepartment: "department_membership.department",
   ScreeningQuestionScreeningAnswers: "screening_question.screening_answers",

package/src/models/components/index.ts

@@ -23,6 +23,7 @@ export * from "./department.js";
 export * from "./departmentmembership.js";
 export * from "./departmentsummary.js";
 export * from "./desc.js";
+export * from "./emailpreferences.js";
 export * from "./expand.js";
 export * from "./facility.js";
 export * from "./facilitycalendarsummary.js";

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(