@greensecurity/javascript-sdk 0.47.0-beta.15 → 0.47.0-beta.17

package/src/__tests__/zones.test.ts

@@ -35,9 +35,6 @@ test("Zones List Or Search Security Zones", async () => {
       useUrlParams: false,
     },
     items: [
-      {
-        facility: {},
-      },
       {
         facility: {
           contacts: {
@@ -46,26 +43,32 @@ test("Zones List Or Search Security Zones", async () => {
               department: 123,
             },
             adminContact: {
-              status: "Inactive",
+              status: "Active",
               department: 123,
             },
             techContact: {
-              status: "Active",
+              status: "Inactive",
               department: 123,
             },
             greenSecurityCsm: {
-              status: "Active",
+              status: "Deleted",
+              department: 123,
+            },
+            accountManager: {
+              status: "Inactive",
               department: 123,
             },
-            accountManager: null,
           },
           vendorGuestPolicy: {
-            enabled: false,
+            enabled: true,
             vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: true,
+            vendorGuestRequireEmail: false,
           },
         },
       },
+      {
+        facility: {},
+      },
     ],
   });
 });
@@ -82,8 +85,9 @@ test("Zones Security Zone Checkin", async () => {
   });
 
   const result = await greenSecurity.zones.securityZoneCheckin({
-    qrCode: "<value>",
-    zoneId: 776072,
+    longitude: 8706.45,
+    latitude: 7315.87,
+    zoneId: 944641,
   });
   expect(result).toBeDefined();
   expect(result).toEqual({});

package/src/admin-funcs/clearVerifications.ts

@@ -0,0 +1,42 @@
+import { APIPromise } from "../types/async.js";
+import { $doGetSingle, $doPost, internalApiResult } from "./doAdmin.js";
+
+export type ClearVerificationContext = "registration" | "account";
+export type ClearVerificationPlatform = "web" | "native";
+
+export type clearCreateSessionRequest = {
+  context: ClearVerificationContext;
+  platform: ClearVerificationPlatform;
+  /** Where CLEAR sends the vendor back; the server adds a `state` parameter. */
+  return_url: string;
+};
+
+export type clearCompleteRequest = {
+  /** The `state` CLEAR sent back on the return URL. */
+  state: string;
+};
+
+/** Starts a CLEAR verification for the calling vendor. Resolves to `{ verify_url }`. */
+export function clearCreateSession(request: clearCreateSessionRequest): internalApiResult {
+  return new APIPromise($doPost("/clear-verifications", request));
+}
+
+/** Reads the outcome of the session `state` belongs to. Resolves to the vendor's CLEAR summary plus `outcome` and `context`. */
+export function clearComplete(request: clearCompleteRequest): internalApiResult {
+  return new APIPromise($doPost("/clear-verifications/complete", request));
+}
+
+/** Records that the calling vendor continued without CLEAR. Resolves to the vendor's CLEAR summary. */
+export function clearOptOut(): internalApiResult {
+  return new APIPromise($doPost("/clear-verifications/opt-out", {}));
+}
+
+/** The calling vendor's CLEAR summary: `{ status, prefilled_fields, personal_email }`. */
+export function clearGetStatus(): internalApiResult {
+  return new APIPromise($doGetSingle("/clear-verifications/status", {}));
+}
+
+/** What the vendor's profile and CLEAR can fill on their background check, SSN included. */
+export function clearGetBackgroundCheckPrefill(): internalApiResult {
+  return new APIPromise($doGetSingle("/clear-verifications/background-check-prefill", {}));
+}

package/src/admin-funcs/registerGeneralInfo.ts

@@ -14,12 +14,17 @@ export type formInputs = {
   supervisor_name: string;
   supervisor_email: string;
   supervisor_phone: string;
-  country: string;
-  address1: string;
-  address2: string;
-  city: string;
-  state: string;
-  zip: string;
+  /** Becomes the login email when it differs from the one the vendor registered with. */
+  work_email?: string;
+  personal_email?: string;
+  work_phone?: string;
+  /** Registration no longer collects an address; these remain for older forms. */
+  country?: string;
+  address1?: string;
+  address2?: string;
+  city?: string;
+  state?: string;
+  zip?: string;
 };
 
 export function submitGeneralInfo(request: formInputs): internalApiResult {

package/src/funcs/vendorsUpdateVendorDetails.ts

@@ -36,12 +36,15 @@ import * as types$ from "../types/primitives.js";
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
- * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+ * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax` and `personal_email`. The `address` and
  * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
  * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
+ * `location.personal_email` is stored lowercased, and a value that is not a valid
+ * email address, or is longer than 255 characters, gets a `422` response.
+ *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
  * of the two you omit from the request). The server rejects a code that is not shaped like a real
@@ -66,6 +69,7 @@ export function vendorsUpdateVendorDetails(
   Result<
     boolean,
     | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -92,6 +96,7 @@ async function $do(
     Result<
       boolean,
       | errors.ApiErrorResponse
+      | errors.UnprocessableEntityOrValidationError
       | GreenSecurityError
       | ResponseValidationError
       | ConnectionError
@@ -181,6 +186,7 @@ async function $do(
   const [result] = await M.match<
     boolean,
     | errors.ApiErrorResponse
+    | errors.UnprocessableEntityOrValidationError
     | GreenSecurityError
     | ResponseValidationError
     | ConnectionError
@@ -192,6 +198,7 @@ async function $do(
   >(
     M.json(200, types$.boolean()),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(422, errors.UnprocessableEntityOrValidationError$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });

package/src/index.extras.ts

@@ -33,6 +33,13 @@ import { submitEmailStep } from "./admin-funcs/registerEmail.js";
 import { submitPassword } from "./admin-funcs/registerPassword.js";
 import { submitGeneralInfo } from "./admin-funcs/registerGeneralInfo.js";
 import { submitCompany } from "./admin-funcs/registerCompanies.js";
+import {
+  clearComplete,
+  clearCreateSession,
+  clearGetBackgroundCheckPrefill,
+  clearGetStatus,
+  clearOptOut,
+} from "./admin-funcs/clearVerifications.js";
 
 import { smartBadgePairBadge } from "./admin-funcs/smartBadgePairBadge.js";
 import { smartBadgeUnpairBadge } from "./admin-funcs/smartBadgeUnpairBadge.js";
@@ -126,6 +133,14 @@ export const __internal = {
     submitCompany
   },
 
+  clear: {
+    createSession: clearCreateSession,
+    complete: clearComplete,
+    optOut: clearOptOut,
+    getStatus: clearGetStatus,
+    getBackgroundCheckPrefill: clearGetBackgroundCheckPrefill
+  },
+
   smartBadge: {
     pairBadge: smartBadgePairBadge,
     unpairBadge: smartBadgeUnpairBadge,

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.46.0",
-  sdkVersion: "0.47.0-beta.15",
+  sdkVersion: "0.47.0-beta.17",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.47.0-beta.15 2.948.4 0.46.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.47.0-beta.17 2.948.4 0.46.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/userdetails.ts

@@ -85,6 +85,10 @@ export type UserDetails = {
    * First name of the user.
    */
   firstName?: string | null | undefined;
+  /**
+   * Middle name of the user, or `null` if not set. Returned only in the full user record (`expand=user`).
+   */
+  middleName?: string | null | undefined;
   /**
    * Last name of the user.
    */
@@ -93,6 +97,14 @@ export type UserDetails = {
    * Email address (not always valid)
    */
   email: string;
+  /**
+   * A vendor's personal email address, kept apart from `email`, which is
+   *
+   * @remarks
+   * the work email they sign in with. `null` if not set. Returned only in
+   * the full user record (`expand=user`).
+   */
+  personalEmail?: string | null | undefined;
   /**
    * The user's landline phone number, or `null` if not set.
    */
@@ -253,8 +265,10 @@ export const UserDetails$inboundSchema: z.ZodType<
 > = z.object({
   id: types.number(),
   first_name: z.nullable(types.string()).optional(),
+  middle_name: z.nullable(types.string()).optional(),
   last_name: z.nullable(types.string()).optional(),
   email: types.string(),
+  personal_email: z.nullable(types.string()).optional(),
   phone: z.nullable(types.string()).optional(),
   mobile_phone: z.nullable(types.string()).optional(),
   fax: z.nullable(types.string()).optional(),
@@ -274,7 +288,9 @@ export const UserDetails$inboundSchema: z.ZodType<
 }).transform((v) => {
   return remap$(v, {
     "first_name": "firstName",
+    "middle_name": "middleName",
     "last_name": "lastName",
+    "personal_email": "personalEmail",
     "mobile_phone": "mobilePhone",
     "phone_confirmed": "phoneConfirmed",
     "email_confirmed": "emailConfirmed",

package/src/models/components/userlocation.ts

@@ -212,6 +212,10 @@ export type UserLocation = {
    * The fax number of the location. `null` if not set.
    */
   fax?: string | null | undefined;
+  /**
+   * The vendor's personal email address. Only `PUT /vendors/{vendor_id_or_me}` reads it. `null` if not set.
+   */
+  personalEmail?: string | null | undefined;
   /**
    * The country of the location. `null` if not set.
    */
@@ -250,11 +254,13 @@ export const UserLocation$inboundSchema: z.ZodType<
   phone: z.nullable(types.string()).optional(),
   mobile_phone: z.nullable(types.string()).optional(),
   fax: z.nullable(types.string()).optional(),
+  personal_email: z.nullable(types.string()).optional(),
   country: z.nullable(types.string()).optional(),
   timezone: z.nullable(Timezone$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "mobile_phone": "mobilePhone",
+    "personal_email": "personalEmail",
   });
 });
 /** @internal */
@@ -268,6 +274,7 @@ export type UserLocation$Outbound = {
   phone?: string | null | undefined;
   mobile_phone?: string | null | undefined;
   fax?: string | null | undefined;
+  personal_email?: string | null | undefined;
   country?: string | null | undefined;
   timezone?: string | null | undefined;
 };
@@ -287,11 +294,13 @@ export const UserLocation$outboundSchema: z.ZodType<
   phone: z.nullable(z.string()).optional(),
   mobilePhone: z.nullable(z.string()).optional(),
   fax: z.nullable(z.string()).optional(),
+  personalEmail: z.nullable(z.string()).optional(),
   country: z.nullable(z.string()).optional(),
   timezone: z.nullable(Timezone$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     mobilePhone: "mobile_phone",
+    personalEmail: "personal_email",
   });
 });
 

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -36,6 +36,7 @@ export type VendorsUpdateVendorDetailsMutationData = boolean;
 
 export type VendorsUpdateVendorDetailsMutationError =
   | errors.ApiErrorResponse
+  | errors.UnprocessableEntityOrValidationError
   | GreenSecurityError
   | ResponseValidationError
   | ConnectionError
@@ -54,12 +55,15 @@ export type VendorsUpdateVendorDetailsMutationError =
  * can also remove the vendor from their company by sending `company_id: null`.
  *
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
- * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+ * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax` and `personal_email`. The `address` and
  * `country` properties of the shared `UserLocation` schema have no effect here, and
  * updating them is not supported. `state` accepts a US state or a Canadian
  * province—the vendor's country, set only at registration, is not editable
  * through this endpoint.
  *
+ * `location.personal_email` is stored lowercased, and a value that is not a valid
+ * email address, or is longer than 255 characters, gets a `422` response.
+ *
  * Submitting `location.zip` or `location.state` cross-checks the postal code
  * against the resulting state (using the vendor's existing value for whichever
  * of the two you omit from the request). The server rejects a code that is not shaped like a real

package/src/sdk/vendors.ts

@@ -1026,12 +1026,15 @@ export class Vendors extends ClientSDK {
    * can also remove the vendor from their company by sending `company_id: null`.
    *
    * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
-   * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
+   * `city`, `state`, `zip`, `phone`, `mobile_phone`, `fax` and `personal_email`. The `address` and
    * `country` properties of the shared `UserLocation` schema have no effect here, and
    * updating them is not supported. `state` accepts a US state or a Canadian
    * province—the vendor's country, set only at registration, is not editable
    * through this endpoint.
    *
+   * `location.personal_email` is stored lowercased, and a value that is not a valid
+   * email address, or is longer than 255 characters, gets a `422` response.
+   *
    * Submitting `location.zip` or `location.state` cross-checks the postal code
    * against the resulting state (using the vendor's existing value for whichever
    * of the two you omit from the request). The server rejects a code that is not shaped like a real