@greensecurity/javascript-sdk 0.45.0-beta.9 → 0.46.0-beta.1

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/event.ts

@@ -0,0 +1,214 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { Invite, Invite$inboundSchema } from "./invite.js";
+
+export type EventFacility2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The facility id, or a summary when `event.facility` is passed to `expand`. Null when the appointment was booked against a department alone.
+ */
+export type EventFacility = EventFacility2 | number;
+
+export type Department2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The department id, or a summary when `event.department` is passed to `expand`. Null when the appointment was booked against a facility alone.
+ */
+export type EventDepartment = Department2 | number;
+
+/**
+ * An appointment, in the shape served to SDK builds `0.55.0-beta.1` and above. Associations are the numeric id by default, and `{ id, name }` under their expand scope. The display fields (`location`, `attendees`, `event_creator`, `event_creator_img_url`, `invitees`) are null unless their scope is passed. SDK builds below `0.55.0-beta.1` receive `Feed` or `StandingAppointment` instead, which is chosen from the `X-SDK-User-Agent` header.
+ *
+ * @remarks
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release. A build is compared to it by semantic-version ordering, in which a prerelease sorts below its own release: so `0.55.0-beta.1` itself, every later prerelease (`0.55.0-beta.2`, `0.55.0-rc.1`) and every release from `0.55.0` up receive this shape, while an earlier prerelease of the same release — `0.55.0-alpha.1` — does not.
+ */
+export type Event = {
+  id?: number | undefined;
+  /**
+   * The event name.
+   */
+  title?: string | null | undefined;
+  /**
+   * Start date and time in UTC (ISO 8601 format, e.g. 2026-02-23T14:00:00Z). Null if not set.
+   */
+  start?: string | null | undefined;
+  /**
+   * End date and time in UTC (ISO 8601 format, e.g. 2026-02-23T15:00:00Z). Null if not set.
+   */
+  end?: string | null | undefined;
+  allDay?: boolean | undefined;
+  /**
+   * Verbatim ("Approved") unless `event.viewer_invite` is passed to `expand`, which lower-cases it and appends the reading user's own outstanding invite, e.g. "approved but user invite pending". `/events/standing-appointments` passes it.
+   */
+  status?: string | null | undefined;
+  standingAppt?: boolean | undefined;
+  bringingFood?: boolean | undefined;
+  notes?: string | null | undefined;
+  /**
+   * ISO 8601 date-time when the event was approved.
+   */
+  dateApproved?: string | null | undefined;
+  /**
+   * The facility id, or a summary when `event.facility` is passed to `expand`. Null when the appointment was booked against a department alone.
+   */
+  facility?: EventFacility2 | number | null | undefined;
+  /**
+   * The department id, or a summary when `event.department` is passed to `expand`. Null when the appointment was booked against a facility alone.
+   */
+  department?: Department2 | number | null | undefined;
+  /**
+   * "Facility - Department". Populated when `event.location` is passed to `expand`.
+   */
+  location?: string | null | undefined;
+  /**
+   * Populated when `event.attendees` is passed to `expand`.
+   */
+  attendees?: Array<string> | null | undefined;
+  /**
+   * Populated when `event.creator` is passed to `expand`.
+   */
+  eventCreator?: string | null | undefined;
+  /**
+   * Populated when `event.creator` is passed to `expand`.
+   */
+  eventCreatorImgUrl?: string | null | undefined;
+  /**
+   * Populated when `event.invitees` is passed to `expand`.
+   */
+  invitees?: Array<Invite> | null | undefined;
+};
+
+/** @internal */
+export const EventFacility2$inboundSchema: z.ZodType<
+  EventFacility2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.nullable(types.string()),
+});
+
+export function eventFacility2FromJSON(
+  jsonString: string,
+): SafeParseResult<EventFacility2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFacility2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFacility2' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventFacility$inboundSchema: z.ZodType<
+  EventFacility,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => EventFacility2$inboundSchema), types.number()]);
+
+export function eventFacilityFromJSON(
+  jsonString: string,
+): SafeParseResult<EventFacility, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventFacility$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventFacility' from JSON`,
+  );
+}
+
+/** @internal */
+export const Department2$inboundSchema: z.ZodType<
+  Department2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  name: types.nullable(types.string()),
+});
+
+export function department2FromJSON(
+  jsonString: string,
+): SafeParseResult<Department2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Department2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Department2' from JSON`,
+  );
+}
+
+/** @internal */
+export const EventDepartment$inboundSchema: z.ZodType<
+  EventDepartment,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => Department2$inboundSchema), types.number()]);
+
+export function eventDepartmentFromJSON(
+  jsonString: string,
+): SafeParseResult<EventDepartment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EventDepartment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EventDepartment' from JSON`,
+  );
+}
+
+/** @internal */
+export const Event$inboundSchema: z.ZodType<Event, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    title: z.nullable(types.string()).optional(),
+    start: z.nullable(types.string()).optional(),
+    end: z.nullable(types.string()).optional(),
+    all_day: types.optional(types.boolean()),
+    status: z.nullable(types.string()).optional(),
+    standing_appt: types.optional(types.boolean()),
+    bringing_food: types.optional(types.boolean()),
+    notes: z.nullable(types.string()).optional(),
+    date_approved: z.nullable(types.string()).optional(),
+    facility: z.nullable(
+      smartUnion([z.lazy(() => EventFacility2$inboundSchema), types.number()]),
+    ).optional(),
+    department: z.nullable(
+      smartUnion([z.lazy(() => Department2$inboundSchema), types.number()]),
+    ).optional(),
+    location: z.nullable(types.string()).optional(),
+    attendees: z.nullable(z.array(types.string())).optional(),
+    event_creator: z.nullable(types.string()).optional(),
+    event_creator_img_url: z.nullable(types.string()).optional(),
+    invitees: z.nullable(z.array(Invite$inboundSchema)).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "all_day": "allDay",
+      "standing_appt": "standingAppt",
+      "bringing_food": "bringingFood",
+      "date_approved": "dateApproved",
+      "event_creator": "eventCreator",
+      "event_creator_img_url": "eventCreatorImgUrl",
+    });
+  });
+
+export function eventFromJSON(
+  jsonString: string,
+): SafeParseResult<Event, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event' 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",
@@ -30,7 +32,7 @@ export const Expand = {
   FacilityVendorGuestPolicy: "facility.vendor_guest_policy",
   FacilityVendorPolicy: "facility.vendor_policy",
   FacilityVisitorPolicy: "facility.visitor_policy",
-  FacilityWorkflow: "facility.workflow",
+  FacilityWorkflowPolicy: "facility.workflow_policy",
   VendorApprovedCalendaringFacilities: "vendor.approved_calendaring_facilities",
   VendorBackgroundCheckDateExpires: "vendor.background_check_date_expires",
   VendorBadgeDetails: "vendor.badge_details",
@@ -67,7 +69,14 @@ export const Expand = {
   InvoiceCustomFields: "invoice.custom_fields",
   InvoiceInvoiceType: "invoice.invoice_type",
   InvoiceMayPayInvoice: "invoice.may_pay_invoice",
+  InvoicePaymentProfile: "invoice.payment_profile",
+  InvoiceSharebackSystem: "invoice.shareback_system",
+  InvoiceAssociatedCredentials: "invoice.associated_credentials",
   InvoiceTransactionsPayee: "invoice_transactions.payee",
+  InvoiceTransactionsPaymentProfile: "invoice_transactions.payment_profile",
+  LineItemsDetails: "line_items.details",
+  LineItemsProduct: "line_items.product",
+  LineItemsVariant: "line_items.variant",
   VendorCredentialCredential: "vendor_credential.credential",
   VendorCredentialVendor: "vendor_credential.vendor",
   VendorCredentialInvoice: "vendor_credential.invoice",
@@ -85,6 +94,7 @@ export const Expand = {
   VendorCredentialExpeditedOffers: "vendor_credential.expedited_offers",
   VendorCredentialBackgroundCheckResults:
     "vendor_credential.background_check_results",
+  BackgroundCheckResultsPdfUris: "background_check_results.pdf_uris",
   VendorCredentialVendorCredentialDefaultStatus:
     "vendor_credential.vendor_credential_default_status",
   VendorCredentialVendorCredentialDataRequests:
@@ -118,7 +128,17 @@ export const Expand = {
   ZoneRules: "zone.rules",
   SystemFacilities: "system.facilities",
   SystemLocation: "system.location",
-  SubscriptionExpeditedOffer: "subscription.expedited_offer",
+  SystemAggregate: "system.aggregate",
+  SystemAutoApprovePolicy: "system.auto_approve_policy",
+  SystemCalendarPolicy: "system.calendar_policy",
+  SystemGpo: "system.gpo",
+  SystemGreenContacts: "system.green_contacts",
+  SystemInitiateVisitRequestRequirements:
+    "system.initiate_visit_request_requirements",
+  SystemPricingModel: "system.pricing_model",
+  SystemSalesInfo: "system.sales_info",
+  SystemVendorCounts: "system.vendor_counts",
+  SystemVendorGuestPolicy: "system.vendor_guest_policy",
   SubscriptionExpeditedOffers: "subscription.expedited_offers",
   SubscriptionDateEnds: "subscription.date_ends",
   SubscriptionVariantTitle: "subscription.variant_title",
@@ -129,6 +149,14 @@ export const Expand = {
   DepartmentMembershipContact: "department_membership.contact",
   DepartmentMembershipDepartment: "department_membership.department",
   ScreeningQuestionScreeningAnswers: "screening_question.screening_answers",
+  ScreeningQuestionScreeningAnswerActions:
+    "screening_question.screening_answer_actions",
+  EventFacility: "event.facility",
+  EventDepartment: "event.department",
+  EventInvitees: "event.invitees",
+  Entity: "entity",
+  FromEntity: "from_entity",
+  ToEntity: "to_entity",
   TargetFacilityStatusChangeFacility: "target_facility_status_change.facility",
   TargetFacilityStatusChangeVendor: "target_facility_status_change.vendor",
   TargetFacilityStatusChangeCompany: "target_facility_status_change.company",
@@ -137,6 +165,12 @@ export const Expand = {
   VisitorCheckinVisitingZone: "visitor_checkin.visiting_zone",
   VisitorCheckinPii: "visitor_checkin.pii",
   VisitorCheckinExternalScreens: "visitor_checkin.external_screens",
+  EventLocation: "event.location",
+  EventAttendees: "event.attendees",
+  EventCreator: "event.creator",
+  EventViewerInvite: "event.viewer_invite",
+  InviteEvent: "invite.event",
+  InviteInvitee: "invite.invitee",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.