@greensecurity/javascript-sdk 0.47.0 → 0.48.0-beta.0

package/src/__tests__/zones.test.ts

@@ -35,34 +35,65 @@ test("Zones List Or Search Security Zones", async () => {
       useUrlParams: false,
     },
     items: [
-      {
-        facility: {},
-      },
       {
         facility: {
           contacts: {
             contact: {
+              status: "Inactive",
+              department: null,
+            },
+            adminContact: {
+              status: "Deleted",
+              department: 123,
+            },
+            techContact: {
+              status: "Deleted",
+              department: 123,
+            },
+            greenSecurityCsm: {
+              status: "Deleted",
+              department: 123,
+            },
+            accountManager: {
               status: "Active",
               department: 123,
             },
-            adminContact: {
+          },
+          vendorGuestPolicy: {
+            enabled: false,
+            vendorGuestLimitAndOr: "and",
+            vendorGuestRequireEmail: false,
+          },
+        },
+      },
+      {
+        facility: {
+          contacts: {
+            contact: {
               status: "Inactive",
+              department: null,
+            },
+            adminContact: {
+              status: "Deleted",
               department: 123,
             },
             techContact: {
-              status: "Active",
+              status: "Deleted",
               department: 123,
             },
             greenSecurityCsm: {
+              status: "Deleted",
+              department: 123,
+            },
+            accountManager: {
               status: "Active",
               department: 123,
             },
-            accountManager: null,
           },
           vendorGuestPolicy: {
             enabled: false,
             vendorGuestLimitAndOr: "and",
-            vendorGuestRequireEmail: true,
+            vendorGuestRequireEmail: false,
           },
         },
       },
@@ -83,7 +114,7 @@ test("Zones Security Zone Checkin", async () => {
 
   const result = await greenSecurity.zones.securityZoneCheckin({
     qrCode: "<value>",
-    zoneId: 776072,
+    zoneId: 834385,
   });
   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/admin-funcs/vendorGetCompanyCredentialsSummary.ts

@@ -1,10 +1,14 @@
 import { APIPromise } from "../types/async.js";
-import { $doGetSingle, internalApiResult } from "./doAdmin.js";
+import { $doGetSingle, hashToQueryString, internalApiResult } from "./doAdmin.js";
 
-// Internal-only, not part of openapi.yaml. Vendor is resolved from the token, so no request shape.
-export function vendorGetCompanyCredentialsSummary(): internalApiResult {
-  return new APIPromise($doGetSingle(
-      "/vendors/me/company-credentials-summary",
-      {}
-  ));
+// Internal-only, not part of openapi.yaml. Vendor is resolved from the token. Pass `facilityId` to
+// summarize only the company credentials required at that facility instead of at every facility
+// the vendor targets.
+export function vendorGetCompanyCredentialsSummary(facilityId?: number): internalApiResult {
+  let route = "/vendors/me/company-credentials-summary";
+  if (facilityId !== undefined) {
+    route += `?${hashToQueryString({ facility_id: facilityId })}`;
+  }
+
+  return new APIPromise($doGetSingle(route, {}));
 }

package/src/funcs/vendorsGetVendorTargetFacilities.ts

@@ -45,6 +45,7 @@ import {
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
  * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
  *

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.47.0",
-  sdkVersion: "0.47.0",
+  sdkVersion: "0.48.0-beta.0",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.47.0 2.948.4 0.47.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.48.0-beta.0 2.948.4 0.47.0 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -21,6 +21,7 @@ export const Expand = {
     "vendor_target_facility.has_screening_responses",
   VendorTargetFacilityExpiringCredentialCount:
     "vendor_target_facility.expiring_credential_count",
+  VendorTargetFacilitySystemLogoUrl: "vendor_target_facility.system_logo_url",
   ContactFacility: "contact.facility",
   ContactSystem: "contact.system",
   ContactDepartment: "contact.department",

package/src/models/components/invoice.ts

@@ -103,6 +103,10 @@ export type AssociatedCredentials = {
    * The ID of the company that requested the credential. `null` if the credential has no company.
    */
   companyId: number | null;
+  /**
+   * The ID of the invoice the credential was raised on. This can be a child of the requested invoice. `null` if the credential has no invoice.
+   */
+  invoiceId: number | null;
   /**
    * Whether the vendor has paid the credential's invoice but has not submitted the required information.
    */
@@ -320,11 +324,13 @@ export const AssociatedCredentials$inboundSchema: z.ZodType<
   id: types.number(),
   vendor_id: types.nullable(types.number()),
   company_id: types.nullable(types.number()),
+  invoice_id: types.nullable(types.number()),
   awaiting_submission: types.boolean(),
 }).transform((v) => {
   return remap$(v, {
     "vendor_id": "vendorId",
     "company_id": "companyId",
+    "invoice_id": "invoiceId",
     "awaiting_submission": "awaitingSubmission",
   });
 });
@@ -333,6 +339,7 @@ export type AssociatedCredentials$Outbound = {
   id: number;
   vendor_id: number | null;
   company_id: number | null;
+  invoice_id: number | null;
   awaiting_submission: boolean;
 };
 
@@ -345,11 +352,13 @@ export const AssociatedCredentials$outboundSchema: z.ZodType<
   id: z.number().int(),
   vendorId: z.nullable(z.number().int()),
   companyId: z.nullable(z.number().int()),
+  invoiceId: z.nullable(z.number().int()),
   awaitingSubmission: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     vendorId: "vendor_id",
     companyId: "company_id",
+    invoiceId: "invoice_id",
     awaitingSubmission: "awaiting_submission",
   });
 });

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/models/components/vendortargetfacility.ts

@@ -44,6 +44,10 @@ export type VendorTargetFacility = {
    * How many credentials the facility requires from the vendor have an approved version that expires within 30 days, with no newer version approved or waiting for approval. Company-owned credentials are left out when the caller is a vendor whose company has company managers. Present only when you pass `vendor_target_facility.expiring_credential_count` to `expand`.
    */
   expiringCredentialCount?: number | undefined;
+  /**
+   * The URL of the logo of the facility's system, or `null` when the system has no logo or the facility has no system. Present only when you pass `vendor_target_facility.system_logo_url` to `expand`.
+   */
+  systemLogoUrl?: string | null | undefined;
   /**
    * The date and time the target facility was added to the vendor, in ISO 8601 format, or `null` if not available.
    */
@@ -81,12 +85,14 @@ export const VendorTargetFacility$inboundSchema: z.ZodType<
   questions_answered: types.nullable(types.boolean()),
   has_screening_responses: types.optional(types.boolean()),
   expiring_credential_count: types.optional(types.number()),
+  system_logo_url: z.nullable(types.string()).optional(),
   date_created: z.nullable(types.date()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "questions_answered": "questionsAnswered",
     "has_screening_responses": "hasScreeningResponses",
     "expiring_credential_count": "expiringCredentialCount",
+    "system_logo_url": "systemLogoUrl",
     "date_created": "dateCreated",
   });
 });

package/src/models/operations/getvendortargetfacilities.ts

@@ -52,7 +52,7 @@ export const IncludeStatusCounts = {
 export type IncludeStatusCounts = ClosedEnum<typeof IncludeStatusCounts>;
 
 /**
- * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `not_approved_first` ignores `desc`.
+ * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
  */
 export const GetVendorTargetFacilitiesQueryParamSort = {
   FacilityName: "facility_name",
@@ -61,9 +61,10 @@ export const GetVendorTargetFacilitiesQueryParamSort = {
   QuestionsAnswered: "questions_answered",
   DateCreated: "date_created",
   NotApprovedFirst: "not_approved_first",
+  SystemAndFacilityName: "system_and_facility_name",
 } as const;
 /**
- * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `not_approved_first` ignores `desc`.
+ * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
  */
 export type GetVendorTargetFacilitiesQueryParamSort = ClosedEnum<
   typeof GetVendorTargetFacilitiesQueryParamSort
@@ -117,7 +118,7 @@ export type GetVendorTargetFacilitiesRequest = {
    */
   itemsPerPage?: number | undefined;
   /**
-   * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `not_approved_first` ignores `desc`.
+   * The field to sort results by. Defaults to `facility_name`. `not_approved_first` lists the systems with the most rows that are not approved first, then by system name; within a system it puts the rows that are not approved first, then sorts by facility name. `system_and_facility_name` sorts by system name, then by facility name, and lists facilities without a system last. Both ignore `desc`.
    */
   sort?: GetVendorTargetFacilitiesQueryParamSort | undefined;
   /**

package/src/react-query/vendorsGetVendorTargetFacilities.ts

@@ -84,6 +84,7 @@ export type VendorsGetVendorTargetFacilitiesQueryError =
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
  * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
  *
@@ -123,6 +124,7 @@ export function useVendorsGetVendorTargetFacilities(
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
  * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
  *
@@ -162,6 +164,7 @@ export function useVendorsGetVendorTargetFacilitiesSuspense(
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
  * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
  *
@@ -215,6 +218,7 @@ export function useVendorsGetVendorTargetFacilitiesInfinite(
  * - `vendor_target_facility.facility`
  * - `vendor_target_facility.has_screening_responses`
  * - `vendor_target_facility.expiring_credential_count`
+ * - `vendor_target_facility.system_logo_url`
  *
  * The endpoint rejects any other value with `422 Unprocessable Entity`.
  *

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
@@ -1504,6 +1507,7 @@ export class Vendors extends ClientSDK {
    * - `vendor_target_facility.facility`
    * - `vendor_target_facility.has_screening_responses`
    * - `vendor_target_facility.expiring_credential_count`
+   * - `vendor_target_facility.system_logo_url`
    *
    * The endpoint rejects any other value with `422 Unprocessable Entity`.
    *