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

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";
@@ -32,21 +34,22 @@ export * from "./distributor.js";
 export * from "./distributorcreate.js";
 export * from "./distributorupdate.js";
 export * from "./emailpreferences.js";
+export * from "./event.js";
 export * from "./expand.js";
 export * from "./facility.js";
 export * from "./facilitycalendarsummary.js";
 export * from "./facilitystatus.js";
 export * from "./facilitysummary.js";
 export * from "./facilityvendortype.js";
-export * from "./feed.js";
 export * from "./fhirconfig.js";
 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";
+export * from "./invite.js";
 export * from "./invoice.js";
 export * from "./invoicefinancialstatus.js";
 export * from "./invoiceitem.js";
@@ -77,7 +80,6 @@ export * from "./passwordnotsetresponse.js";
 export * from "./passwordrequiredresponse.js";
 export * from "./paymentprofile.js";
 export * from "./paymentprofileinfo.js";
-export * from "./pendinginvitation.js";
 export * from "./product.js";
 export * from "./productvariant.js";
 export * from "./samlloginrequiredresponse.js";
@@ -87,11 +89,12 @@ export * from "./screeningansweractionsummary.js";
 export * from "./screeningquestion.js";
 export * from "./screeningresponse.js";
 export * from "./security.js";
-export * from "./standingappointment.js";
+export * from "./ssocontinuation.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 +123,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";

package/src/models/components/invite.ts

@@ -0,0 +1,168 @@
+/*
+ * 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 { smartUnion } from "../../types/smartUnion.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Event2 = {
+  id: number;
+  name: string | null;
+};
+
+/**
+ * The event id, or a summary when `invite.event` is passed to `expand`.
+ */
+export type InviteEvent = Event2 | number;
+
+export const InviteStatus = {
+  Pending: "Pending",
+  Accepted: "Accepted",
+  Declined: "Declined",
+} as const;
+export type InviteStatus = OpenEnum<typeof InviteStatus>;
+
+export const InviteType = {
+  User: "user",
+  Department: "department",
+  Company: "company",
+} as const;
+export type InviteType = OpenEnum<typeof InviteType>;
+
+/**
+ * Who the invitation is addressed to. Populated when `invite.invitee` is passed to `expand`.
+ */
+export type Invitee = {
+  id?: number | undefined;
+  name?: string | null | undefined;
+  type?: InviteType | undefined;
+};
+
+/**
+ * An invitation to an appointment, in the shape served to SDK builds `0.55.0-beta.1` and above. SDK builds below `0.55.0-beta.1` receive `PendingInvitation` instead.
+ *
+ * @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 Invite = {
+  id?: number | undefined;
+  /**
+   * The event id, or a summary when `invite.event` is passed to `expand`.
+   */
+  event?: Event2 | number | undefined;
+  userId?: number | null | undefined;
+  companyId?: number | null | undefined;
+  departmentId?: number | null | undefined;
+  status?: InviteStatus | null | undefined;
+  dateReviewed?: string | null | undefined;
+  /**
+   * Who the invitation is addressed to. Populated when `invite.invitee` is passed to `expand`.
+   */
+  invitee?: Invitee | null | undefined;
+};
+
+/** @internal */
+export const Event2$inboundSchema: z.ZodType<Event2, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.number(),
+    name: types.nullable(types.string()),
+  });
+
+export function event2FromJSON(
+  jsonString: string,
+): SafeParseResult<Event2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Event2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Event2' from JSON`,
+  );
+}
+
+/** @internal */
+export const InviteEvent$inboundSchema: z.ZodType<
+  InviteEvent,
+  z.ZodTypeDef,
+  unknown
+> = smartUnion([z.lazy(() => Event2$inboundSchema), types.number()]);
+
+export function inviteEventFromJSON(
+  jsonString: string,
+): SafeParseResult<InviteEvent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InviteEvent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InviteEvent' from JSON`,
+  );
+}
+
+/** @internal */
+export const InviteStatus$inboundSchema: z.ZodType<
+  InviteStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(InviteStatus);
+
+/** @internal */
+export const InviteType$inboundSchema: z.ZodType<
+  InviteType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(InviteType);
+
+/** @internal */
+export const Invitee$inboundSchema: z.ZodType<Invitee, z.ZodTypeDef, unknown> =
+  z.object({
+    id: types.optional(types.number()),
+    name: z.nullable(types.string()).optional(),
+    type: types.optional(InviteType$inboundSchema),
+  });
+
+export function inviteeFromJSON(
+  jsonString: string,
+): SafeParseResult<Invitee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invitee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invitee' from JSON`,
+  );
+}
+
+/** @internal */
+export const Invite$inboundSchema: z.ZodType<Invite, z.ZodTypeDef, unknown> = z
+  .object({
+    id: types.optional(types.number()),
+    event: types.optional(
+      smartUnion([z.lazy(() => Event2$inboundSchema), types.number()]),
+    ),
+    user_id: z.nullable(types.number()).optional(),
+    company_id: z.nullable(types.number()).optional(),
+    department_id: z.nullable(types.number()).optional(),
+    status: z.nullable(InviteStatus$inboundSchema).optional(),
+    date_reviewed: z.nullable(types.string()).optional(),
+    invitee: z.nullable(z.lazy(() => Invitee$inboundSchema)).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "user_id": "userId",
+      "company_id": "companyId",
+      "department_id": "departmentId",
+      "date_reviewed": "dateReviewed",
+    });
+  });
+
+export function inviteFromJSON(
+  jsonString: string,
+): SafeParseResult<Invite, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Invite$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Invite' from JSON`,
+  );
+}

package/src/models/components/invoice.ts

@@ -69,9 +69,6 @@ export type InvoiceType = OpenEnum<typeof InvoiceType>;
  *
  * This is used exclusively to control the visibility of the "Make Payment" button in the UI.
  * It is not used for any other invoice logic or backend decision-making.
- *
- * Frontend should compare the logged-in user's ID (for vendors) or company_id (for company managers)
- * with these arrays to determine if the payment button should be shown.
  */
 export type MayPayInvoice = {
   /**
@@ -84,6 +81,16 @@ export type MayPayInvoice = {
   companies?: Array<number> | undefined;
 };
 
+export type AssociatedCredentials = {
+  id: number;
+  vendorId: number | null;
+  companyId: number | null;
+  /**
+   * True when the credential's invoice is paid but its required info has not been submitted yet.
+   */
+  awaitingSubmission: boolean;
+};
+
 /**
  * A simplified representation of an Invoice
  */
@@ -131,11 +138,15 @@ export type Invoice = {
    *
    * This is used exclusively to control the visibility of the "Make Payment" button in the UI.
    * It is not used for any other invoice logic or backend decision-making.
-   *
-   * Frontend should compare the logged-in user's ID (for vendors) or company_id (for company managers)
-   * with these arrays to determine if the payment button should be shown.
    */
   mayPayInvoice?: MayPayInvoice | null | undefined;
+  /**
+   * Credentials this invoice pays for, including those on its child invoices, limited to the ones the caller can read. Only included when `invoice.associated_credentials` is requested in the expand parameter.
+   *
+   * @remarks
+   * Frontend should compare the logged-in user's ID (for vendors) or company_id (for company managers) with these arrays to determine if the payment button should be shown.
+   */
+  associatedCredentials?: Array<AssociatedCredentials> | null | undefined;
 };
 
 /** @internal */
@@ -243,6 +254,66 @@ export function mayPayInvoiceFromJSON(
   );
 }
 
+/** @internal */
+export const AssociatedCredentials$inboundSchema: z.ZodType<
+  AssociatedCredentials,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  vendor_id: types.nullable(types.number()),
+  company_id: types.nullable(types.number()),
+  awaiting_submission: types.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    "vendor_id": "vendorId",
+    "company_id": "companyId",
+    "awaiting_submission": "awaitingSubmission",
+  });
+});
+/** @internal */
+export type AssociatedCredentials$Outbound = {
+  id: number;
+  vendor_id: number | null;
+  company_id: number | null;
+  awaiting_submission: boolean;
+};
+
+/** @internal */
+export const AssociatedCredentials$outboundSchema: z.ZodType<
+  AssociatedCredentials$Outbound,
+  z.ZodTypeDef,
+  AssociatedCredentials
+> = z.object({
+  id: z.number().int(),
+  vendorId: z.nullable(z.number().int()),
+  companyId: z.nullable(z.number().int()),
+  awaitingSubmission: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    vendorId: "vendor_id",
+    companyId: "company_id",
+    awaitingSubmission: "awaiting_submission",
+  });
+});
+
+export function associatedCredentialsToJSON(
+  associatedCredentials: AssociatedCredentials,
+): string {
+  return JSON.stringify(
+    AssociatedCredentials$outboundSchema.parse(associatedCredentials),
+  );
+}
+export function associatedCredentialsFromJSON(
+  jsonString: string,
+): SafeParseResult<AssociatedCredentials, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssociatedCredentials$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssociatedCredentials' from JSON`,
+  );
+}
+
 /** @internal */
 export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
   z.object({
@@ -269,6 +340,9 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
     invoice_type: types.optional(InvoiceType$inboundSchema),
     may_pay_invoice: z.nullable(z.lazy(() => MayPayInvoice$inboundSchema))
       .optional(),
+    associated_credentials: z.nullable(
+      z.array(z.lazy(() => AssociatedCredentials$inboundSchema)),
+    ).optional(),
   }).transform((v) => {
     return remap$(v, {
       "invoice_number": "invoiceNumber",
@@ -282,6 +356,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
       "custom_fields": "customFields",
       "invoice_type": "invoiceType",
       "may_pay_invoice": "mayPayInvoice",
+      "associated_credentials": "associatedCredentials",
     });
   });
 /** @internal */
@@ -305,6 +380,10 @@ export type Invoice$Outbound = {
   representative?: string | null | undefined;
   invoice_type?: string | undefined;
   may_pay_invoice?: MayPayInvoice$Outbound | null | undefined;
+  associated_credentials?:
+    | Array<AssociatedCredentials$Outbound>
+    | null
+    | undefined;
 };
 
 /** @internal */
@@ -335,6 +414,9 @@ export const Invoice$outboundSchema: z.ZodType<
   invoiceType: InvoiceType$outboundSchema.optional(),
   mayPayInvoice: z.nullable(z.lazy(() => MayPayInvoice$outboundSchema))
     .optional(),
+  associatedCredentials: z.nullable(
+    z.array(z.lazy(() => AssociatedCredentials$outboundSchema)),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     invoiceNumber: "invoice_number",
@@ -348,6 +430,7 @@ export const Invoice$outboundSchema: z.ZodType<
     customFields: "custom_fields",
     invoiceType: "invoice_type",
     mayPayInvoice: "may_pay_invoice",
+    associatedCredentials: "associated_credentials",
   });
 });
 

package/src/models/components/loginemailandpassword.ts

@@ -21,6 +21,39 @@ export type LoginEmailAndPassword = {
    * Password as entered by the user
    */
   password: string;
+  /**
+   * Opaque, signed state that Green Security issues when a third-party service
+   *
+   * @remarks
+   * provider starts a "Login with Green Security" SAML flow at
+   * `/saml/idp/sso`. The login screen receives it as the `sso_state` query
+   * string parameter and must pass it back, byte for byte, on every call to
+   * this endpoint for the remainder of the login journey — including the
+   * second call that carries an `mfa_code`.
+   *
+   * The blob is signed, not encrypted, and it expires five minutes after the
+   * service provider's request arrives. Do not parse it, shorten it, decode
+   * it, or re-encode it.
+   *
+   * **An invalid blob does not fail the login.** This is the opposite of what
+   * most integrators assume, so it is worth stating plainly: a forged, edited
+   * or expired `sso_state` is silently discarded, and the request then
+   * proceeds as an ordinary login. Valid credentials still authenticate and
+   * still return `200` — just with no `sso` object, leaving the user signed in
+   * to Green Security with no way back to the service provider that sent them.
+   * Never treat a `200` as proof that the SSO hand-off survived; check for
+   * `sso` explicitly.
+   *
+   * Every `202` response echoes the *verified* blob back in its own
+   * `sso_state` field. Always send back the value from the response you just
+   * received rather than the one you started with, so that a blob the server
+   * has already rejected is never resent, and so a client does not have to
+   * hold state of its own across the login journey.
+   *
+   * Omit this field entirely for an ordinary login that did not originate
+   * from a service provider.
+   */
+  ssoState?: string | undefined;
 };
 
 /** @internal */
@@ -28,6 +61,7 @@ export type LoginEmailAndPassword$Outbound = {
   email: string;
   mfa_code?: string | undefined;
   password: string;
+  sso_state?: string | undefined;
 };
 
 /** @internal */
@@ -39,9 +73,11 @@ export const LoginEmailAndPassword$outboundSchema: z.ZodType<
   email: z.string(),
   mfaCode: z.string().optional(),
   password: z.string(),
+  ssoState: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     mfaCode: "mfa_code",
+    ssoState: "sso_state",
   });
 });