@greensecurity/javascript-sdk 0.9.1

package/src/models/components/facilitysummary.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A simplified representation of a Facility, typically used in list views.
+ */
+export type FacilitySummary = {
+  id?: number | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const FacilitySummary$inboundSchema: z.ZodType<
+  FacilitySummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int().optional(),
+  name: z.string().optional(),
+});
+
+/** @internal */
+export type FacilitySummary$Outbound = {
+  id?: number | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const FacilitySummary$outboundSchema: z.ZodType<
+  FacilitySummary$Outbound,
+  z.ZodTypeDef,
+  FacilitySummary
+> = z.object({
+  id: z.number().int().optional(),
+  name: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FacilitySummary$ {
+  /** @deprecated use `FacilitySummary$inboundSchema` instead. */
+  export const inboundSchema = FacilitySummary$inboundSchema;
+  /** @deprecated use `FacilitySummary$outboundSchema` instead. */
+  export const outboundSchema = FacilitySummary$outboundSchema;
+  /** @deprecated use `FacilitySummary$Outbound` instead. */
+  export type Outbound = FacilitySummary$Outbound;
+}
+
+export function facilitySummaryToJSON(
+  facilitySummary: FacilitySummary,
+): string {
+  return JSON.stringify(FacilitySummary$outboundSchema.parse(facilitySummary));
+}
+
+export function facilitySummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<FacilitySummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FacilitySummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FacilitySummary' from JSON`,
+  );
+}

package/src/models/components/imageset.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * A set of images in different sizes
+ */
+export type ImageSet = {
+  tiny?: string | undefined;
+  thumb?: string | undefined;
+  large?: string | undefined;
+  original?: string | undefined;
+};
+
+/** @internal */
+export const ImageSet$inboundSchema: z.ZodType<
+  ImageSet,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tiny: z.string().optional(),
+  thumb: z.string().optional(),
+  large: z.string().optional(),
+  original: z.string().optional(),
+});
+
+/** @internal */
+export type ImageSet$Outbound = {
+  tiny?: string | undefined;
+  thumb?: string | undefined;
+  large?: string | undefined;
+  original?: string | undefined;
+};
+
+/** @internal */
+export const ImageSet$outboundSchema: z.ZodType<
+  ImageSet$Outbound,
+  z.ZodTypeDef,
+  ImageSet
+> = z.object({
+  tiny: z.string().optional(),
+  thumb: z.string().optional(),
+  large: z.string().optional(),
+  original: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ImageSet$ {
+  /** @deprecated use `ImageSet$inboundSchema` instead. */
+  export const inboundSchema = ImageSet$inboundSchema;
+  /** @deprecated use `ImageSet$outboundSchema` instead. */
+  export const outboundSchema = ImageSet$outboundSchema;
+  /** @deprecated use `ImageSet$Outbound` instead. */
+  export type Outbound = ImageSet$Outbound;
+}
+
+export function imageSetToJSON(imageSet: ImageSet): string {
+  return JSON.stringify(ImageSet$outboundSchema.parse(imageSet));
+}
+
+export function imageSetFromJSON(
+  jsonString: string,
+): SafeParseResult<ImageSet, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImageSet$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImageSet' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./contact.js";
+export * from "./departmentsummary.js";
+export * from "./desc.js";
+export * from "./expand.js";
+export * from "./facility.js";
+export * from "./facilitysummary.js";
+export * from "./imageset.js";
+export * from "./loginemailandpassword.js";
+export * from "./loginrequirementsfromemail.js";
+export * from "./mfarequiredresponse.js";
+export * from "./pager.js";
+export * from "./passwordrequiredresponse.js";
+export * from "./samlloginrequiredresponse.js";
+export * from "./security.js";
+export * from "./status.js";
+export * from "./systemsummary.js";
+export * from "./user.js";
+export * from "./vendorjobtitle.js";
+export * from "./vendortype.js";

package/src/models/components/loginemailandpassword.ts

@@ -0,0 +1,95 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Login a user with Email, Password and optional MFA
+ */
+export type LoginEmailAndPassword = {
+  /**
+   * A valid email address
+   */
+  email: string;
+  /**
+   * MFA Code as entered by the user. Typically a 6 digit code treated as a string.
+   */
+  mfaCode?: string | undefined;
+  /**
+   * Password as entered by the user
+   */
+  password: string;
+};
+
+/** @internal */
+export const LoginEmailAndPassword$inboundSchema: z.ZodType<
+  LoginEmailAndPassword,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+  mfa_code: z.string().optional(),
+  password: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "mfa_code": "mfaCode",
+  });
+});
+
+/** @internal */
+export type LoginEmailAndPassword$Outbound = {
+  email: string;
+  mfa_code?: string | undefined;
+  password: string;
+};
+
+/** @internal */
+export const LoginEmailAndPassword$outboundSchema: z.ZodType<
+  LoginEmailAndPassword$Outbound,
+  z.ZodTypeDef,
+  LoginEmailAndPassword
+> = z.object({
+  email: z.string(),
+  mfaCode: z.string().optional(),
+  password: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    mfaCode: "mfa_code",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LoginEmailAndPassword$ {
+  /** @deprecated use `LoginEmailAndPassword$inboundSchema` instead. */
+  export const inboundSchema = LoginEmailAndPassword$inboundSchema;
+  /** @deprecated use `LoginEmailAndPassword$outboundSchema` instead. */
+  export const outboundSchema = LoginEmailAndPassword$outboundSchema;
+  /** @deprecated use `LoginEmailAndPassword$Outbound` instead. */
+  export type Outbound = LoginEmailAndPassword$Outbound;
+}
+
+export function loginEmailAndPasswordToJSON(
+  loginEmailAndPassword: LoginEmailAndPassword,
+): string {
+  return JSON.stringify(
+    LoginEmailAndPassword$outboundSchema.parse(loginEmailAndPassword),
+  );
+}
+
+export function loginEmailAndPasswordFromJSON(
+  jsonString: string,
+): SafeParseResult<LoginEmailAndPassword, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoginEmailAndPassword$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoginEmailAndPassword' from JSON`,
+  );
+}

package/src/models/components/loginrequirementsfromemail.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Given a user email, checks whether SAML or Password is required.
+ */
+export type LoginRequirementsFromEmail = {
+  /**
+   * Properly formatted email address
+   */
+  email: string;
+  /**
+   * A proper URI where the user should be sent after completing a SAML login. This is encoded into the response you will get if the user requires a SAML login.
+   */
+  returnUrl: string;
+};
+
+/** @internal */
+export const LoginRequirementsFromEmail$inboundSchema: z.ZodType<
+  LoginRequirementsFromEmail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+  return_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "return_url": "returnUrl",
+  });
+});
+
+/** @internal */
+export type LoginRequirementsFromEmail$Outbound = {
+  email: string;
+  return_url: string;
+};
+
+/** @internal */
+export const LoginRequirementsFromEmail$outboundSchema: z.ZodType<
+  LoginRequirementsFromEmail$Outbound,
+  z.ZodTypeDef,
+  LoginRequirementsFromEmail
+> = z.object({
+  email: z.string(),
+  returnUrl: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    returnUrl: "return_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace LoginRequirementsFromEmail$ {
+  /** @deprecated use `LoginRequirementsFromEmail$inboundSchema` instead. */
+  export const inboundSchema = LoginRequirementsFromEmail$inboundSchema;
+  /** @deprecated use `LoginRequirementsFromEmail$outboundSchema` instead. */
+  export const outboundSchema = LoginRequirementsFromEmail$outboundSchema;
+  /** @deprecated use `LoginRequirementsFromEmail$Outbound` instead. */
+  export type Outbound = LoginRequirementsFromEmail$Outbound;
+}
+
+export function loginRequirementsFromEmailToJSON(
+  loginRequirementsFromEmail: LoginRequirementsFromEmail,
+): string {
+  return JSON.stringify(
+    LoginRequirementsFromEmail$outboundSchema.parse(loginRequirementsFromEmail),
+  );
+}
+
+export function loginRequirementsFromEmailFromJSON(
+  jsonString: string,
+): SafeParseResult<LoginRequirementsFromEmail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LoginRequirementsFromEmail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LoginRequirementsFromEmail' from JSON`,
+  );
+}

package/src/models/components/mfarequiredresponse.ts

@@ -0,0 +1,160 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const MfaRequiredResponseRequires = {
+  MfaCode: "mfa_code",
+} as const;
+export type MfaRequiredResponseRequires = ClosedEnum<
+  typeof MfaRequiredResponseRequires
+>;
+
+export const MfaMethod = {
+  Text: "text",
+  Email: "email",
+} as const;
+export type MfaMethod = ClosedEnum<typeof MfaMethod>;
+
+/**
+ * The response is sent when a login is successful, but requires more information such as a MFA.
+ *
+ * @remarks
+ *
+ * If the `mfa_method` is text or email, it's best to show helper text to the user to notify them that a code was sent via mobile or email and they should enter it to proceed.
+ */
+export type MfaRequiredResponse = {
+  requires: MfaRequiredResponseRequires;
+  success: boolean;
+  /**
+   * Error describing the exact condition of what further steps are needed to finish the login process.
+   */
+  error: string;
+  /**
+   * A redacted version of the phone number such as `###-###-1234`
+   */
+  mobilePhone?: string | undefined;
+  mfaMethod?: MfaMethod | undefined;
+};
+
+/** @internal */
+export const MfaRequiredResponseRequires$inboundSchema: z.ZodNativeEnum<
+  typeof MfaRequiredResponseRequires
+> = z.nativeEnum(MfaRequiredResponseRequires);
+
+/** @internal */
+export const MfaRequiredResponseRequires$outboundSchema: z.ZodNativeEnum<
+  typeof MfaRequiredResponseRequires
+> = MfaRequiredResponseRequires$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MfaRequiredResponseRequires$ {
+  /** @deprecated use `MfaRequiredResponseRequires$inboundSchema` instead. */
+  export const inboundSchema = MfaRequiredResponseRequires$inboundSchema;
+  /** @deprecated use `MfaRequiredResponseRequires$outboundSchema` instead. */
+  export const outboundSchema = MfaRequiredResponseRequires$outboundSchema;
+}
+
+/** @internal */
+export const MfaMethod$inboundSchema: z.ZodNativeEnum<typeof MfaMethod> = z
+  .nativeEnum(MfaMethod);
+
+/** @internal */
+export const MfaMethod$outboundSchema: z.ZodNativeEnum<typeof MfaMethod> =
+  MfaMethod$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MfaMethod$ {
+  /** @deprecated use `MfaMethod$inboundSchema` instead. */
+  export const inboundSchema = MfaMethod$inboundSchema;
+  /** @deprecated use `MfaMethod$outboundSchema` instead. */
+  export const outboundSchema = MfaMethod$outboundSchema;
+}
+
+/** @internal */
+export const MfaRequiredResponse$inboundSchema: z.ZodType<
+  MfaRequiredResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requires: MfaRequiredResponseRequires$inboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+  mobile_phone: z.string().optional(),
+  mfa_method: MfaMethod$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "mobile_phone": "mobilePhone",
+    "mfa_method": "mfaMethod",
+  });
+});
+
+/** @internal */
+export type MfaRequiredResponse$Outbound = {
+  requires: string;
+  success: boolean;
+  error: string;
+  mobile_phone?: string | undefined;
+  mfa_method?: string | undefined;
+};
+
+/** @internal */
+export const MfaRequiredResponse$outboundSchema: z.ZodType<
+  MfaRequiredResponse$Outbound,
+  z.ZodTypeDef,
+  MfaRequiredResponse
+> = z.object({
+  requires: MfaRequiredResponseRequires$outboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+  mobilePhone: z.string().optional(),
+  mfaMethod: MfaMethod$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    mobilePhone: "mobile_phone",
+    mfaMethod: "mfa_method",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MfaRequiredResponse$ {
+  /** @deprecated use `MfaRequiredResponse$inboundSchema` instead. */
+  export const inboundSchema = MfaRequiredResponse$inboundSchema;
+  /** @deprecated use `MfaRequiredResponse$outboundSchema` instead. */
+  export const outboundSchema = MfaRequiredResponse$outboundSchema;
+  /** @deprecated use `MfaRequiredResponse$Outbound` instead. */
+  export type Outbound = MfaRequiredResponse$Outbound;
+}
+
+export function mfaRequiredResponseToJSON(
+  mfaRequiredResponse: MfaRequiredResponse,
+): string {
+  return JSON.stringify(
+    MfaRequiredResponse$outboundSchema.parse(mfaRequiredResponse),
+  );
+}
+
+export function mfaRequiredResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<MfaRequiredResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MfaRequiredResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MfaRequiredResponse' from JSON`,
+  );
+}

package/src/models/components/pager.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Pagination information for a pageable list
+ */
+export type Pager = {
+  /**
+   * Url path of where to fetch this or other pages of the same objects
+   */
+  baseUrl: string;
+  /**
+   * A comma-separated list of column names signifying which columns the `items` are sorted by.
+   */
+  sort: string;
+  /**
+   * `0` signifies the items are sorted in ascending order, `1` signifies the items are sorted in descending order
+   */
+  desc: number;
+  /**
+   * Number of total items for all pages
+   */
+  itemCount: number;
+  itemsPerPage: number;
+  /**
+   * The page represented by the current `items` list. Pages are 1-based for easy display to the user.
+   */
+  page: number;
+  /**
+   * When `true`, the following fields may be updated by adding query string parameters to the request (via GET)
+   *
+   * @remarks
+   *
+   * - sort
+   * - desc
+   * - page
+   * - items_per_page
+   */
+  useUrlParams: boolean;
+};
+
+/** @internal */
+export const Pager$inboundSchema: z.ZodType<Pager, z.ZodTypeDef, unknown> = z
+  .object({
+    base_url: z.string(),
+    sort: z.string(),
+    desc: z.number().int(),
+    item_count: z.number().int(),
+    items_per_page: z.number().int(),
+    page: z.number().int(),
+    use_url_params: z.boolean(),
+  }).transform((v) => {
+    return remap$(v, {
+      "base_url": "baseUrl",
+      "item_count": "itemCount",
+      "items_per_page": "itemsPerPage",
+      "use_url_params": "useUrlParams",
+    });
+  });
+
+/** @internal */
+export type Pager$Outbound = {
+  base_url: string;
+  sort: string;
+  desc: number;
+  item_count: number;
+  items_per_page: number;
+  page: number;
+  use_url_params: boolean;
+};
+
+/** @internal */
+export const Pager$outboundSchema: z.ZodType<
+  Pager$Outbound,
+  z.ZodTypeDef,
+  Pager
+> = z.object({
+  baseUrl: z.string(),
+  sort: z.string(),
+  desc: z.number().int(),
+  itemCount: z.number().int(),
+  itemsPerPage: z.number().int(),
+  page: z.number().int(),
+  useUrlParams: z.boolean(),
+}).transform((v) => {
+  return remap$(v, {
+    baseUrl: "base_url",
+    itemCount: "item_count",
+    itemsPerPage: "items_per_page",
+    useUrlParams: "use_url_params",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Pager$ {
+  /** @deprecated use `Pager$inboundSchema` instead. */
+  export const inboundSchema = Pager$inboundSchema;
+  /** @deprecated use `Pager$outboundSchema` instead. */
+  export const outboundSchema = Pager$outboundSchema;
+  /** @deprecated use `Pager$Outbound` instead. */
+  export type Outbound = Pager$Outbound;
+}
+
+export function pagerToJSON(pager: Pager): string {
+  return JSON.stringify(Pager$outboundSchema.parse(pager));
+}
+
+export function pagerFromJSON(
+  jsonString: string,
+): SafeParseResult<Pager, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pager$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pager' from JSON`,
+  );
+}