@greensecurity/javascript-sdk 0.45.0-beta.8 → 0.45.0

package/src/models/components/alert.ts

@@ -27,7 +27,7 @@ export const FollowUpType = {
 export type FollowUpType = OpenEnum<typeof FollowUpType>;
 
 /**
- * Context data for smart badge follow-up alerts.
+ * Context data for the alert. Smart badge follow-ups carry the check-in fields, and credential paid alerts carry vendor_credential_id.
  */
 export type AlertContext = {
   facilityId?: number | null | undefined;
@@ -37,6 +37,7 @@ export type AlertContext = {
   vendorScanId?: number | null | undefined;
   recheckVendorScanId?: number | null | undefined;
   followUpType?: FollowUpType | null | undefined;
+  vendorCredentialId?: number | null | undefined;
 };
 
 /**
@@ -53,7 +54,7 @@ export type Alert = {
   title?: string | null | undefined;
   plainText?: string | null | undefined;
   /**
-   * Context data for smart badge follow-up alerts.
+   * Context data for the alert. Smart badge follow-ups carry the check-in fields, and credential paid alerts carry vendor_credential_id.
    */
   alertContext?: AlertContext | null | undefined;
   viewed?: boolean | null | undefined;
@@ -84,6 +85,7 @@ export const AlertContext$inboundSchema: z.ZodType<
   vendor_scan_id: z.nullable(types.number()).optional(),
   recheck_vendor_scan_id: z.nullable(types.number()).optional(),
   follow_up_type: z.nullable(FollowUpType$inboundSchema).optional(),
+  vendor_credential_id: z.nullable(types.number()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "facility_id": "facilityId",
@@ -93,6 +95,7 @@ export const AlertContext$inboundSchema: z.ZodType<
     "vendor_scan_id": "vendorScanId",
     "recheck_vendor_scan_id": "recheckVendorScanId",
     "follow_up_type": "followUpType",
+    "vendor_credential_id": "vendorCredentialId",
   });
 });
 

package/src/models/components/authenticatesuccessresponse.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+import { Company, Company$inboundSchema } from "./company.js";
+import { Contact, Contact$inboundSchema } from "./contact.js";
+import {
+  SsoContinuation,
+  SsoContinuation$inboundSchema,
+} from "./ssocontinuation.js";
+import { UserDetails, UserDetails$inboundSchema } from "./userdetails.js";
+import { Vendor, Vendor$inboundSchema } from "./vendor.js";
+
+/**
+ * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+ */
+export const AuthenticateSuccessResponseTokenType = {
+  Permanent: "permanent",
+  OneTime: "one time",
+} as const;
+/**
+ * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+ */
+export type AuthenticateSuccessResponseTokenType = OpenEnum<
+  typeof AuthenticateSuccessResponseTokenType
+>;
+
+export type AuthenticateSuccessResponseUserToken = {
+  /**
+   * This token can be passed in authorization headers for this user.
+   */
+  token: string;
+  /**
+   * A `permanent` user token can be used to access any API endpoint as the logged in user. A `one time` token is used to authenticate the user once.
+   */
+  tokenType: AuthenticateSuccessResponseTokenType;
+};
+
+export type AuthenticateSuccessResponseInventoryManager = {};
+
+/**
+ * A completed login. Identical to the `User` object returned everywhere
+ *
+ * @remarks
+ * else, plus an `sso` object when the request carried a valid `sso_state`
+ * and the login therefore has a SAML flow waiting to be finished.
+ */
+export type AuthenticateSuccessResponse = {
+  /**
+   * A `gatekeeper` is a special type of service user. This type of service user is assigned to Kiosks and Apps to verify Vendors using APIs that have some access to facility data.
+   */
+  isGatekeeper?: boolean | undefined;
+  success: boolean;
+  /**
+   * Core user profile fields returned by user detail and update endpoints.
+   */
+  user: UserDetails;
+  userToken: AuthenticateSuccessResponseUserToken;
+  /**
+   * Vendor details
+   */
+  vendor?: Vendor | undefined;
+  inventoryManager?: AuthenticateSuccessResponseInventoryManager | undefined;
+  /**
+   * This object represents a contact at the system or facility level. Use it to verify vendors, create appointments, or check in visitors.
+   */
+  contact?: Contact | null | undefined;
+  /**
+   * A simplified representation of a Company, typically used in list views.
+   */
+  company?: Company | null | undefined;
+  /**
+   * Where to send the browser to finish a "Login with Green Security" flow.
+   *
+   * @remarks
+   *
+   * Present on a `200` from `POST /users/authenticate` only when the request
+   * carried a valid, unexpired `sso_state`. Its absence means the login
+   * succeeded but the SAML flow did not resume — treat the login as an
+   * ordinary one rather than retrying.
+   *
+   * This object is additive. The login itself is unaffected by it: the
+   * caller's own permanent token is in `user_token` exactly as it would be on
+   * any other successful authentication, and it is not the token embedded in
+   * `continue_url`.
+   */
+  sso?: SsoContinuation | undefined;
+};
+
+/** @internal */
+export const AuthenticateSuccessResponseTokenType$inboundSchema: z.ZodType<
+  AuthenticateSuccessResponseTokenType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AuthenticateSuccessResponseTokenType);
+
+/** @internal */
+export const AuthenticateSuccessResponseUserToken$inboundSchema: z.ZodType<
+  AuthenticateSuccessResponseUserToken,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: types.string(),
+  token_type: AuthenticateSuccessResponseTokenType$inboundSchema.default(
+    "permanent",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "token_type": "tokenType",
+  });
+});
+
+export function authenticateSuccessResponseUserTokenFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthenticateSuccessResponseUserToken, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AuthenticateSuccessResponseUserToken$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthenticateSuccessResponseUserToken' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuthenticateSuccessResponseInventoryManager$inboundSchema:
+  z.ZodType<
+    AuthenticateSuccessResponseInventoryManager,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({});
+
+export function authenticateSuccessResponseInventoryManagerFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  AuthenticateSuccessResponseInventoryManager,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      AuthenticateSuccessResponseInventoryManager$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'AuthenticateSuccessResponseInventoryManager' from JSON`,
+  );
+}
+
+/** @internal */
+export const AuthenticateSuccessResponse$inboundSchema: z.ZodType<
+  AuthenticateSuccessResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  is_gatekeeper: types.optional(types.boolean()),
+  success: types.boolean(),
+  user: UserDetails$inboundSchema,
+  user_token: z.lazy(() => AuthenticateSuccessResponseUserToken$inboundSchema),
+  vendor: types.optional(Vendor$inboundSchema),
+  inventory_manager: types.optional(
+    z.lazy(() => AuthenticateSuccessResponseInventoryManager$inboundSchema),
+  ),
+  contact: z.nullable(Contact$inboundSchema).optional(),
+  company: z.nullable(Company$inboundSchema).optional(),
+  sso: types.optional(SsoContinuation$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "is_gatekeeper": "isGatekeeper",
+    "user_token": "userToken",
+    "inventory_manager": "inventoryManager",
+  });
+});
+
+export function authenticateSuccessResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthenticateSuccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthenticateSuccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthenticateSuccessResponse' from JSON`,
+  );
+}

package/src/models/components/companymanagerlookup.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A company manager reduced to what is needed to address a message to them. Deliberately narrower than the CompanyManager schema, which a vendor identity may not read.
+ */
+export type CompanyManagerLookup = {
+  /**
+   * Id of the company manager record, not of the underlying user.
+   */
+  id: number;
+  firstName: string | null;
+  lastName: string | null;
+  email: string;
+};
+
+/** @internal */
+export const CompanyManagerLookup$inboundSchema: z.ZodType<
+  CompanyManagerLookup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  first_name: types.nullable(types.string()),
+  last_name: types.nullable(types.string()),
+  email: types.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "first_name": "firstName",
+    "last_name": "lastName",
+  });
+});
+
+export function companyManagerLookupFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyManagerLookup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyManagerLookup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyManagerLookup' from JSON`,
+  );
+}

package/src/models/components/contact.ts

@@ -37,7 +37,7 @@ import {
 
 export type ContactFacility = FacilitySummary | number;
 
-export type System = SystemSummary | number;
+export type ContactSystem = SystemSummary | number;
 
 export type ContactUser = UserSummary | number;
 
@@ -95,28 +95,31 @@ export function contactFacilityFromJSON(
 }
 
 /** @internal */
-export const System$inboundSchema: z.ZodType<System, z.ZodTypeDef, unknown> =
-  smartUnion([SystemSummary$inboundSchema, types.number()]);
+export const ContactSystem$inboundSchema: z.ZodType<
+  ContactSystem,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([SystemSummary$inboundSchema, types.number()]);
 /** @internal */
-export type System$Outbound = SystemSummary$Outbound | number;
+export type ContactSystem$Outbound = SystemSummary$Outbound | number;
 
 /** @internal */
-export const System$outboundSchema: z.ZodType<
-  System$Outbound,
+export const ContactSystem$outboundSchema: z.ZodType<
+  ContactSystem$Outbound,
   z.ZodTypeDef,
-  System
+  ContactSystem
 > = smartUnion([SystemSummary$outboundSchema, z.number().int()]);
 
-export function systemToJSON(system: System): string {
-  return JSON.stringify(System$outboundSchema.parse(system));
+export function contactSystemToJSON(contactSystem: ContactSystem): string {
+  return JSON.stringify(ContactSystem$outboundSchema.parse(contactSystem));
 }
-export function systemFromJSON(
+export function contactSystemFromJSON(
   jsonString: string,
-): SafeParseResult<System, SDKValidationError> {
+): SafeParseResult<ContactSystem, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => System$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'System' from JSON`,
+    (x) => ContactSystem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContactSystem' from JSON`,
   );
 }
 

package/src/models/components/expand.ts

@@ -17,6 +17,8 @@ export const Expand = {
   CompanyVendorTypeRestrictions: "company.vendor_type_restrictions",
   CompanyTargetFacilityFacility: "company_target_facility.facility",
   VendorTargetFacilityFacility: "vendor_target_facility.facility",
+  VendorTargetFacilityHasScreeningResponses:
+    "vendor_target_facility.has_screening_responses",
   ContactFacility: "contact.facility",
   ContactSystem: "contact.system",
   ContactDepartment: "contact.department",
@@ -67,6 +69,7 @@ export const Expand = {
   InvoiceCustomFields: "invoice.custom_fields",
   InvoiceInvoiceType: "invoice.invoice_type",
   InvoiceMayPayInvoice: "invoice.may_pay_invoice",
+  InvoiceAssociatedCredentials: "invoice.associated_credentials",
   InvoiceTransactionsPayee: "invoice_transactions.payee",
   VendorCredentialCredential: "vendor_credential.credential",
   VendorCredentialVendor: "vendor_credential.vendor",

package/src/models/components/fullreport.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } 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";
+
+/**
+ * Where the run ended up. A delivery of `FullReport.created` only ever carries a
+ *
+ * @remarks
+ * terminal value; the others are states a run passes through.
+ */
+export const FullReportStatus = {
+  Pending: "pending",
+  Processing: "processing",
+  Completed: "completed",
+  Canceled: "canceled",
+  Failed: "failed",
+} as const;
+/**
+ * Where the run ended up. A delivery of `FullReport.created` only ever carries a
+ *
+ * @remarks
+ * terminal value; the others are states a run passes through.
+ */
+export type FullReportStatus = ClosedEnum<typeof FullReportStatus>;
+
+/**
+ * One run of a report, generated on request or by a schedule. Carries the run's own state
+ *
+ * @remarks
+ * plus which report it was and a short-lived signed link to the file it produced.
+ */
+export type FullReport = {
+  id: number;
+  /**
+   * Where the run ended up. A delivery of `FullReport.created` only ever carries a
+   *
+   * @remarks
+   * terminal value; the others are states a run passes through.
+   */
+  status: FullReportStatus;
+  /**
+   * The report that was run, e.g. `Reports::SqlQueryReport`.
+   */
+  reportClass: string;
+  /**
+   * The subject line of the schedule that produced this run. Null for a run that was
+   *
+   * @remarks
+   * generated on request rather than by a schedule.
+   */
+  name?: string | null | undefined;
+  /**
+   * Signed download link, valid for 2 hours from the moment the delivery was built and
+   *
+   * @remarks
+   * minted fresh for each delivery. Null when the run produced no file, which is every
+   * non-`completed` status.
+   */
+  reportUrl?: string | null | undefined;
+  dateSubmitted?: Date | null | undefined;
+  /**
+   * When the run started generating.
+   */
+  dateCreated?: Date | null | undefined;
+  /**
+   * When the run reached a terminal state. Stamping this is what delivers `created`.
+   */
+  dateCompleted?: Date | null | undefined;
+  /**
+   * Milliseconds spent generating.
+   */
+  durationMs?: number | null | undefined;
+  rowCount?: number | null | undefined;
+  /**
+   * Size of the generated file in bytes.
+   */
+  fileSize?: number | null | undefined;
+  /**
+   * Why a `failed` run failed. Null on every other status.
+   */
+  errorMessage?: string | null | undefined;
+};
+
+/** @internal */
+export const FullReportStatus$inboundSchema: z.ZodNativeEnum<
+  typeof FullReportStatus
+> = z.nativeEnum(FullReportStatus);
+/** @internal */
+export const FullReportStatus$outboundSchema: z.ZodNativeEnum<
+  typeof FullReportStatus
+> = FullReportStatus$inboundSchema;
+
+/** @internal */
+export const FullReport$inboundSchema: z.ZodType<
+  FullReport,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  status: FullReportStatus$inboundSchema,
+  report_class: types.string(),
+  name: z.nullable(types.string()).optional(),
+  report_url: z.nullable(types.string()).optional(),
+  date_submitted: z.nullable(types.date()).optional(),
+  date_created: z.nullable(types.date()).optional(),
+  date_completed: z.nullable(types.date()).optional(),
+  duration_ms: z.nullable(types.number()).optional(),
+  row_count: z.nullable(types.number()).optional(),
+  file_size: z.nullable(types.number()).optional(),
+  error_message: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "report_class": "reportClass",
+    "report_url": "reportUrl",
+    "date_submitted": "dateSubmitted",
+    "date_created": "dateCreated",
+    "date_completed": "dateCompleted",
+    "duration_ms": "durationMs",
+    "row_count": "rowCount",
+    "file_size": "fileSize",
+    "error_message": "errorMessage",
+  });
+});
+/** @internal */
+export type FullReport$Outbound = {
+  id: number;
+  status: string;
+  report_class: string;
+  name?: string | null | undefined;
+  report_url?: string | null | undefined;
+  date_submitted?: string | null | undefined;
+  date_created?: string | null | undefined;
+  date_completed?: string | null | undefined;
+  duration_ms?: number | null | undefined;
+  row_count?: number | null | undefined;
+  file_size?: number | null | undefined;
+  error_message?: string | null | undefined;
+};
+
+/** @internal */
+export const FullReport$outboundSchema: z.ZodType<
+  FullReport$Outbound,
+  z.ZodTypeDef,
+  FullReport
+> = z.object({
+  id: z.number().int(),
+  status: FullReportStatus$outboundSchema,
+  reportClass: z.string(),
+  name: z.nullable(z.string()).optional(),
+  reportUrl: z.nullable(z.string()).optional(),
+  dateSubmitted: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
+  dateCreated: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  dateCompleted: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
+  durationMs: z.nullable(z.number().int()).optional(),
+  rowCount: z.nullable(z.number().int()).optional(),
+  fileSize: z.nullable(z.number().int()).optional(),
+  errorMessage: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    reportClass: "report_class",
+    reportUrl: "report_url",
+    dateSubmitted: "date_submitted",
+    dateCreated: "date_created",
+    dateCompleted: "date_completed",
+    durationMs: "duration_ms",
+    rowCount: "row_count",
+    fileSize: "file_size",
+    errorMessage: "error_message",
+  });
+});
+
+export function fullReportToJSON(fullReport: FullReport): string {
+  return JSON.stringify(FullReport$outboundSchema.parse(fullReport));
+}
+export function fullReportFromJSON(
+  jsonString: string,
+): SafeParseResult<FullReport, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FullReport$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FullReport' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -5,11 +5,13 @@
 export * from "./activestatus.js";
 export * from "./alert.js";
 export * from "./appointmentsummary.js";
+export * from "./authenticatesuccessresponse.js";
 export * from "./backgroundcheckresult.js";
 export * from "./company.js";
 export * from "./companycredentiallistitem.js";
 export * from "./companylookup.js";
 export * from "./companymanager.js";
+export * from "./companymanagerlookup.js";
 export * from "./companytargetfacility.js";
 export * from "./companyvendorfield.js";
 export * from "./companyvendortyperestriction.js";
@@ -44,6 +46,7 @@ export * from "./fhirconfigcreate.js";
 export * from "./fhirconfigpartialupdate.js";
 export * from "./fhirextraentities.js";
 export * from "./financialstatus.js";
+export * from "./fullreport.js";
 export * from "./handoff.js";
 export * from "./imageset.js";
 export * from "./invitee.js";
@@ -87,11 +90,13 @@ export * from "./screeningansweractionsummary.js";
 export * from "./screeningquestion.js";
 export * from "./screeningresponse.js";
 export * from "./security.js";
+export * from "./ssocontinuation.js";
 export * from "./standingappointment.js";
 export * from "./state.js";
 export * from "./subscription.js";
 export * from "./supervisor.js";
 export * from "./supportarticle.js";
+export * from "./system.js";
 export * from "./systemsummary.js";
 export * from "./targetfacilitystatuschange.js";
 export * from "./uploadhistoryitem.js";
@@ -120,6 +125,7 @@ export * from "./vendorscanscreeningresponse.js";
 export * from "./vendorscrubdetails.js";
 export * from "./vendorscrubpurchase.js";
 export * from "./vendortargetfacility.js";
+export * from "./vendortargetfacilityscreeningresponse.js";
 export * from "./vendortype.js";
 export * from "./visitorcheckin.js";
 export * from "./webhookconsumers.js";