@greensecurity/javascript-sdk 0.9.1

package/src/models/components/passwordrequiredresponse.ts

@@ -0,0 +1,105 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 Requires = {
+  Password: "password",
+} as const;
+export type Requires = ClosedEnum<typeof Requires>;
+
+/**
+ * The response is sent when the email address provided requires a password (no SAML login).
+ */
+export type PasswordRequiredResponse = {
+  requires: Requires;
+  success: boolean;
+  /**
+   * Error describing the exact condition of what further steps are needed to finish the login process.
+   */
+  error: string;
+};
+
+/** @internal */
+export const Requires$inboundSchema: z.ZodNativeEnum<typeof Requires> = z
+  .nativeEnum(Requires);
+
+/** @internal */
+export const Requires$outboundSchema: z.ZodNativeEnum<typeof Requires> =
+  Requires$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Requires$ {
+  /** @deprecated use `Requires$inboundSchema` instead. */
+  export const inboundSchema = Requires$inboundSchema;
+  /** @deprecated use `Requires$outboundSchema` instead. */
+  export const outboundSchema = Requires$outboundSchema;
+}
+
+/** @internal */
+export const PasswordRequiredResponse$inboundSchema: z.ZodType<
+  PasswordRequiredResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requires: Requires$inboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+});
+
+/** @internal */
+export type PasswordRequiredResponse$Outbound = {
+  requires: string;
+  success: boolean;
+  error: string;
+};
+
+/** @internal */
+export const PasswordRequiredResponse$outboundSchema: z.ZodType<
+  PasswordRequiredResponse$Outbound,
+  z.ZodTypeDef,
+  PasswordRequiredResponse
+> = z.object({
+  requires: Requires$outboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PasswordRequiredResponse$ {
+  /** @deprecated use `PasswordRequiredResponse$inboundSchema` instead. */
+  export const inboundSchema = PasswordRequiredResponse$inboundSchema;
+  /** @deprecated use `PasswordRequiredResponse$outboundSchema` instead. */
+  export const outboundSchema = PasswordRequiredResponse$outboundSchema;
+  /** @deprecated use `PasswordRequiredResponse$Outbound` instead. */
+  export type Outbound = PasswordRequiredResponse$Outbound;
+}
+
+export function passwordRequiredResponseToJSON(
+  passwordRequiredResponse: PasswordRequiredResponse,
+): string {
+  return JSON.stringify(
+    PasswordRequiredResponse$outboundSchema.parse(passwordRequiredResponse),
+  );
+}
+
+export function passwordRequiredResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PasswordRequiredResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PasswordRequiredResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PasswordRequiredResponse' from JSON`,
+  );
+}

package/src/models/components/samlloginrequiredresponse.ts

@@ -0,0 +1,136 @@
+/*
+ * 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 SamlLoginRequiredResponseRequires = {
+  SamlLogin: "saml_login",
+} as const;
+export type SamlLoginRequiredResponseRequires = ClosedEnum<
+  typeof SamlLoginRequiredResponseRequires
+>;
+
+/**
+ * The email address provided must complete SAML authentication at the provided `sso_url` which encodes the `return_url` that was sent as part of the request.
+ *
+ * @remarks
+ *
+ * The user will complete their SAML login at the external IdP and the browser will be redirected to your selected `return_url` with an extra query string parameter called `user_token`. That token is equivalent to the user login and can be used in the `/users/me` endpoint to get user details.
+ */
+export type SamlLoginRequiredResponse = {
+  requires: SamlLoginRequiredResponseRequires;
+  success: boolean;
+  error: string;
+  /**
+   * Instructions that should be displayed to a user in case the SAML flow determines that the account is valid but this is a registration of a brand new user.
+   */
+  ssoInstructions?: string | undefined;
+  /**
+   * This is the URL that should be opened to initiate the SAML login flow
+   */
+  ssoUrl: string;
+};
+
+/** @internal */
+export const SamlLoginRequiredResponseRequires$inboundSchema: z.ZodNativeEnum<
+  typeof SamlLoginRequiredResponseRequires
+> = z.nativeEnum(SamlLoginRequiredResponseRequires);
+
+/** @internal */
+export const SamlLoginRequiredResponseRequires$outboundSchema: z.ZodNativeEnum<
+  typeof SamlLoginRequiredResponseRequires
+> = SamlLoginRequiredResponseRequires$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SamlLoginRequiredResponseRequires$ {
+  /** @deprecated use `SamlLoginRequiredResponseRequires$inboundSchema` instead. */
+  export const inboundSchema = SamlLoginRequiredResponseRequires$inboundSchema;
+  /** @deprecated use `SamlLoginRequiredResponseRequires$outboundSchema` instead. */
+  export const outboundSchema =
+    SamlLoginRequiredResponseRequires$outboundSchema;
+}
+
+/** @internal */
+export const SamlLoginRequiredResponse$inboundSchema: z.ZodType<
+  SamlLoginRequiredResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  requires: SamlLoginRequiredResponseRequires$inboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+  sso_instructions: z.string().optional(),
+  sso_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "sso_instructions": "ssoInstructions",
+    "sso_url": "ssoUrl",
+  });
+});
+
+/** @internal */
+export type SamlLoginRequiredResponse$Outbound = {
+  requires: string;
+  success: boolean;
+  error: string;
+  sso_instructions?: string | undefined;
+  sso_url: string;
+};
+
+/** @internal */
+export const SamlLoginRequiredResponse$outboundSchema: z.ZodType<
+  SamlLoginRequiredResponse$Outbound,
+  z.ZodTypeDef,
+  SamlLoginRequiredResponse
+> = z.object({
+  requires: SamlLoginRequiredResponseRequires$outboundSchema,
+  success: z.boolean(),
+  error: z.string(),
+  ssoInstructions: z.string().optional(),
+  ssoUrl: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    ssoInstructions: "sso_instructions",
+    ssoUrl: "sso_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SamlLoginRequiredResponse$ {
+  /** @deprecated use `SamlLoginRequiredResponse$inboundSchema` instead. */
+  export const inboundSchema = SamlLoginRequiredResponse$inboundSchema;
+  /** @deprecated use `SamlLoginRequiredResponse$outboundSchema` instead. */
+  export const outboundSchema = SamlLoginRequiredResponse$outboundSchema;
+  /** @deprecated use `SamlLoginRequiredResponse$Outbound` instead. */
+  export type Outbound = SamlLoginRequiredResponse$Outbound;
+}
+
+export function samlLoginRequiredResponseToJSON(
+  samlLoginRequiredResponse: SamlLoginRequiredResponse,
+): string {
+  return JSON.stringify(
+    SamlLoginRequiredResponse$outboundSchema.parse(samlLoginRequiredResponse),
+  );
+}
+
+export function samlLoginRequiredResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SamlLoginRequiredResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SamlLoginRequiredResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SamlLoginRequiredResponse' from JSON`,
+  );
+}

package/src/models/components/security.ts

@@ -0,0 +1,75 @@
+/*
+ * 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";
+
+export type Security = {
+  token?: string | undefined;
+  bearerJwt?: string | undefined;
+};
+
+/** @internal */
+export const Security$inboundSchema: z.ZodType<
+  Security,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  token: z.string().optional(),
+  BearerJwt: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "BearerJwt": "bearerJwt",
+  });
+});
+
+/** @internal */
+export type Security$Outbound = {
+  token?: string | undefined;
+  BearerJwt?: string | undefined;
+};
+
+/** @internal */
+export const Security$outboundSchema: z.ZodType<
+  Security$Outbound,
+  z.ZodTypeDef,
+  Security
+> = z.object({
+  token: z.string().optional(),
+  bearerJwt: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    bearerJwt: "BearerJwt",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Security$ {
+  /** @deprecated use `Security$inboundSchema` instead. */
+  export const inboundSchema = Security$inboundSchema;
+  /** @deprecated use `Security$outboundSchema` instead. */
+  export const outboundSchema = Security$outboundSchema;
+  /** @deprecated use `Security$Outbound` instead. */
+  export type Outbound = Security$Outbound;
+}
+
+export function securityToJSON(security: Security): string {
+  return JSON.stringify(Security$outboundSchema.parse(security));
+}
+
+export function securityFromJSON(
+  jsonString: string,
+): SafeParseResult<Security, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Security$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Security' from JSON`,
+  );
+}

package/src/models/components/status.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Status values
+ */
+export const Status = {
+  Active: "Active",
+  Inactive: "Inactive",
+  Deleted: "Deleted",
+} as const;
+/**
+ * Status values
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Status$ {
+  /** @deprecated use `Status$inboundSchema` instead. */
+  export const inboundSchema = Status$inboundSchema;
+  /** @deprecated use `Status$outboundSchema` instead. */
+  export const outboundSchema = Status$outboundSchema;
+}

package/src/models/components/systemsummary.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 System, typically used in list views.
+ */
+export type SystemSummary = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const SystemSummary$inboundSchema: z.ZodType<
+  SystemSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/** @internal */
+export type SystemSummary$Outbound = {
+  id: number;
+  name: string;
+};
+
+/** @internal */
+export const SystemSummary$outboundSchema: z.ZodType<
+  SystemSummary$Outbound,
+  z.ZodTypeDef,
+  SystemSummary
+> = z.object({
+  id: z.number().int(),
+  name: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SystemSummary$ {
+  /** @deprecated use `SystemSummary$inboundSchema` instead. */
+  export const inboundSchema = SystemSummary$inboundSchema;
+  /** @deprecated use `SystemSummary$outboundSchema` instead. */
+  export const outboundSchema = SystemSummary$outboundSchema;
+  /** @deprecated use `SystemSummary$Outbound` instead. */
+  export type Outbound = SystemSummary$Outbound;
+}
+
+export function systemSummaryToJSON(systemSummary: SystemSummary): string {
+  return JSON.stringify(SystemSummary$outboundSchema.parse(systemSummary));
+}
+
+export function systemSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<SystemSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SystemSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SystemSummary' from JSON`,
+  );
+}