@quiverai/sdk 0.1.3

package/src/sdk/models/shared/animatesvgrequest.ts

@@ -0,0 +1,159 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  SVGAnimateInput,
+  SVGAnimateInput$Outbound,
+  SVGAnimateInput$outboundSchema,
+} from "./svganimateinput.js";
+import {
+  SVGParams,
+  SVGParams$Outbound,
+  SVGParams$outboundSchema,
+} from "./svgparams.js";
+
+/**
+ * CSS easing function
+ */
+export const Easing = {
+  Linear: "linear",
+  Ease: "ease",
+  EaseIn: "ease-in",
+  EaseOut: "ease-out",
+  EaseInOut: "ease-in-out",
+} as const;
+/**
+ * CSS easing function
+ */
+export type Easing = ClosedEnum<typeof Easing>;
+
+export type AnimateSVGRequest = {
+  /**
+   * Animation duration in seconds
+   */
+  duration?: number | undefined;
+  /**
+   * CSS easing function
+   */
+  easing?: Easing | undefined;
+  /**
+   * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+   *
+   * @remarks
+   * their existing frequency in the text so far, decreasing the model's
+   * likelihood to repeat the same line verbatim.
+   */
+  frequencyPenalty?: number | null | undefined;
+  input: SVGAnimateInput;
+  /**
+   * Maximum tokens in the output
+   */
+  maxOutputTokens?: number | undefined;
+  /**
+   * The model to use for generation/editing
+   */
+  model: string;
+  /**
+   * Number of SVGs to generate
+   */
+  n?: number | undefined;
+  /**
+   * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+   *
+   * @remarks
+   * whether they appear in the text so far, increasing the model's likelihood
+   * to talk about new topics.
+   */
+  presencePenalty?: number | null | undefined;
+  /**
+   * This feature is in Beta.
+   *
+   * @remarks
+   * If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.
+   * Determinism is not guaranteed.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  seed?: number | null | undefined;
+  /**
+   * If true, responses are streamed as Server-Sent Events
+   */
+  stream?: boolean | undefined;
+  /**
+   * SVG-specific generation parameters for controlling canvas, design, and styling.
+   *
+   * @remarks
+   * These parameters give fine-grained control over the generated SVG output.
+   */
+  svgParams?: SVGParams | undefined;
+  /**
+   * Sampling temperature
+   */
+  temperature?: number | undefined;
+  /**
+   * Nucleus sampling parameter
+   */
+  topP?: number | undefined;
+};
+
+/** @internal */
+export const Easing$outboundSchema: z.ZodNativeEnum<typeof Easing> = z
+  .nativeEnum(Easing);
+
+/** @internal */
+export type AnimateSVGRequest$Outbound = {
+  duration: number;
+  easing: string;
+  frequency_penalty: number | null;
+  input: SVGAnimateInput$Outbound;
+  max_output_tokens?: number | undefined;
+  model: string;
+  n: number;
+  presence_penalty: number | null;
+  seed?: number | null | undefined;
+  stream: boolean;
+  svg_params?: SVGParams$Outbound | undefined;
+  temperature: number;
+  top_p: number;
+};
+
+/** @internal */
+export const AnimateSVGRequest$outboundSchema: z.ZodType<
+  AnimateSVGRequest$Outbound,
+  z.ZodTypeDef,
+  AnimateSVGRequest
+> = z.object({
+  duration: z.number().int().default(2),
+  easing: Easing$outboundSchema.default("ease"),
+  frequencyPenalty: z.nullable(z.number().default(0)),
+  input: SVGAnimateInput$outboundSchema,
+  maxOutputTokens: z.number().int().optional(),
+  model: z.string(),
+  n: z.number().int().default(1),
+  presencePenalty: z.nullable(z.number().default(0)),
+  seed: z.nullable(z.number().int()).optional(),
+  stream: z.boolean().default(false),
+  svgParams: SVGParams$outboundSchema.optional(),
+  temperature: z.number().default(1),
+  topP: z.number().default(1),
+}).transform((v) => {
+  return remap$(v, {
+    frequencyPenalty: "frequency_penalty",
+    maxOutputTokens: "max_output_tokens",
+    presencePenalty: "presence_penalty",
+    svgParams: "svg_params",
+    topP: "top_p",
+  });
+});
+
+export function animateSVGRequestToJSON(
+  animateSVGRequest: AnimateSVGRequest,
+): string {
+  return JSON.stringify(
+    AnimateSVGRequest$outboundSchema.parse(animateSVGRequest),
+  );
+}

package/src/sdk/models/shared/aspectratio.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Aspect ratio constraint for the generated SVG, specified as "width:height".
+ *
+ * @remarks
+ * - `1:1`: Square
+ * - `4:3`: Standard/classic
+ * - `3:4`: Portrait standard
+ * - `16:9`: Landscape/widescreen
+ * - `9:16`: Portrait/tall (mobile)
+ * - `3:2`: Photo landscape
+ * - `2:3`: Photo portrait
+ * - `21:9`: Ultra-wide/cinematic
+ */
+export const AspectRatio = {
+  Eleven: "1:1",
+  FortyThree: "4:3",
+  ThirtyFour: "3:4",
+  OneHundredAndSixtyNine: "16:9",
+  NineHundredAndSixteen: "9:16",
+  ThirtyTwo: "3:2",
+  TwentyThree: "2:3",
+  TwoHundredAndNineteen: "21:9",
+} as const;
+/**
+ * Aspect ratio constraint for the generated SVG, specified as "width:height".
+ *
+ * @remarks
+ * - `1:1`: Square
+ * - `4:3`: Standard/classic
+ * - `3:4`: Portrait standard
+ * - `16:9`: Landscape/widescreen
+ * - `9:16`: Portrait/tall (mobile)
+ * - `3:2`: Photo landscape
+ * - `2:3`: Photo portrait
+ * - `21:9`: Ultra-wide/cinematic
+ */
+export type AspectRatio = ClosedEnum<typeof AspectRatio>;
+
+/** @internal */
+export const AspectRatio$outboundSchema: z.ZodNativeEnum<typeof AspectRatio> = z
+  .nativeEnum(AspectRatio);

package/src/sdk/models/shared/canvas.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 { AspectRatio, AspectRatio$outboundSchema } from "./aspectratio.js";
+import {
+  SafeZone,
+  SafeZone$Outbound,
+  SafeZone$outboundSchema,
+} from "./safezone.js";
+import {
+  ViewBox,
+  ViewBox$Outbound,
+  ViewBox$outboundSchema,
+} from "./viewbox.js";
+
+/**
+ * Controls the coordinate system and "Safe Zones" to prevent clipping/bad cropping.
+ *
+ * @remarks
+ * NOTE: "mode" determines the default canvas if this is omitted.
+ */
+export type Canvas = {
+  /**
+   * Aspect ratio constraint for the generated SVG, specified as "width:height".
+   *
+   * @remarks
+   * - `1:1`: Square
+   * - `4:3`: Standard/classic
+   * - `3:4`: Portrait standard
+   * - `16:9`: Landscape/widescreen
+   * - `9:16`: Portrait/tall (mobile)
+   * - `3:2`: Photo landscape
+   * - `2:3`: Photo portrait
+   * - `21:9`: Ultra-wide/cinematic
+   */
+  aspectRatio?: AspectRatio | undefined;
+  /**
+   * The "Safe Zone" is the guaranteed empty margin between content and edge.
+   *
+   * @remarks
+   * Prevents clipping and bad cropping.
+   */
+  safeZone?: SafeZone | undefined;
+  /**
+   * ViewBox dimensions for the SVG coordinate system
+   */
+  viewBox?: ViewBox | undefined;
+};
+
+/** @internal */
+export type Canvas$Outbound = {
+  aspect_ratio: string;
+  safe_zone?: SafeZone$Outbound | undefined;
+  view_box?: ViewBox$Outbound | undefined;
+};
+
+/** @internal */
+export const Canvas$outboundSchema: z.ZodType<
+  Canvas$Outbound,
+  z.ZodTypeDef,
+  Canvas
+> = z.object({
+  aspectRatio: AspectRatio$outboundSchema.default("1:1"),
+  safeZone: SafeZone$outboundSchema.optional(),
+  viewBox: ViewBox$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    aspectRatio: "aspect_ratio",
+    safeZone: "safe_zone",
+    viewBox: "view_box",
+  });
+});
+
+export function canvasToJSON(canvas: Canvas): string {
+  return JSON.stringify(Canvas$outboundSchema.parse(canvas));
+}

package/src/sdk/models/shared/collectionresponse.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { SVGDocument, SVGDocument$inboundSchema } from "./svgdocument.js";
+import { Usage, Usage$inboundSchema } from "./usage.js";
+
+export type CollectionResponse = {
+  /**
+   * Unix timestamp of when the response was created
+   */
+  created: number;
+  /**
+   * Array of generated SVG documents in the collection
+   */
+  items: Array<SVGDocument>;
+  usage?: Usage | undefined;
+};
+
+/** @internal */
+export const CollectionResponse$inboundSchema: z.ZodType<
+  CollectionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  created: z.number().int(),
+  items: z.array(SVGDocument$inboundSchema),
+  usage: Usage$inboundSchema.optional(),
+});
+
+export function collectionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CollectionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CollectionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CollectionResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/collectionsvgrequest.ts

@@ -0,0 +1,130 @@
+/*
+ * 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 {
+  SVGInput,
+  SVGInput$Outbound,
+  SVGInput$outboundSchema,
+} from "./svginput.js";
+import {
+  SVGParams,
+  SVGParams$Outbound,
+  SVGParams$outboundSchema,
+} from "./svgparams.js";
+
+export type CollectionSVGRequest = {
+  /**
+   * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+   *
+   * @remarks
+   * their existing frequency in the text so far, decreasing the model's
+   * likelihood to repeat the same line verbatim.
+   */
+  frequencyPenalty?: number | null | undefined;
+  /**
+   * Input configuration for text-to-SVG generation
+   */
+  input: SVGInput;
+  /**
+   * Maximum tokens in the output
+   */
+  maxOutputTokens?: number | undefined;
+  /**
+   * The model to use for generation/editing
+   */
+  model: string;
+  /**
+   * Number of SVGs to generate
+   */
+  n?: number | undefined;
+  /**
+   * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+   *
+   * @remarks
+   * whether they appear in the text so far, increasing the model's likelihood
+   * to talk about new topics.
+   */
+  presencePenalty?: number | null | undefined;
+  /**
+   * This feature is in Beta.
+   *
+   * @remarks
+   * If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.
+   * Determinism is not guaranteed.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  seed?: number | null | undefined;
+  /**
+   * If true, responses are streamed as Server-Sent Events
+   */
+  stream?: boolean | undefined;
+  /**
+   * SVG-specific generation parameters for controlling canvas, design, and styling.
+   *
+   * @remarks
+   * These parameters give fine-grained control over the generated SVG output.
+   */
+  svgParams?: SVGParams | undefined;
+  /**
+   * Sampling temperature
+   */
+  temperature?: number | undefined;
+  /**
+   * Nucleus sampling parameter
+   */
+  topP?: number | undefined;
+};
+
+/** @internal */
+export type CollectionSVGRequest$Outbound = {
+  frequency_penalty: number | null;
+  input: SVGInput$Outbound;
+  max_output_tokens?: number | undefined;
+  model: string;
+  n: number;
+  presence_penalty: number | null;
+  seed?: number | null | undefined;
+  stream: boolean;
+  svg_params?: SVGParams$Outbound | undefined;
+  temperature: number;
+  top_p: number;
+};
+
+/** @internal */
+export const CollectionSVGRequest$outboundSchema: z.ZodType<
+  CollectionSVGRequest$Outbound,
+  z.ZodTypeDef,
+  CollectionSVGRequest
+> = z.object({
+  frequencyPenalty: z.nullable(z.number().default(0)),
+  input: SVGInput$outboundSchema,
+  maxOutputTokens: z.number().int().optional(),
+  model: z.string(),
+  n: z.number().int().default(1),
+  presencePenalty: z.nullable(z.number().default(0)),
+  seed: z.nullable(z.number().int()).optional(),
+  stream: z.boolean().default(false),
+  svgParams: SVGParams$outboundSchema.optional(),
+  temperature: z.number().default(1),
+  topP: z.number().default(1),
+}).transform((v) => {
+  return remap$(v, {
+    frequencyPenalty: "frequency_penalty",
+    maxOutputTokens: "max_output_tokens",
+    presencePenalty: "presence_penalty",
+    svgParams: "svg_params",
+    topP: "top_p",
+  });
+});
+
+export function collectionSVGRequestToJSON(
+  collectionSVGRequest: CollectionSVGRequest,
+): string {
+  return JSON.stringify(
+    CollectionSVGRequest$outboundSchema.parse(collectionSVGRequest),
+  );
+}

package/src/sdk/models/shared/coloradherence.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * How strictly the model must adhere to the provided colors.
+ *
+ * @remarks
+ * - `strict`: Only use exact hex codes provided
+ * - `tints_and_shades`: Can adjust lightness/opacity, but no new hues
+ * - `creative`: Palette is a suggestion/starting point
+ */
+export const ColorAdherence = {
+  Strict: "strict",
+  TintsAndShades: "tints_and_shades",
+  Creative: "creative",
+} as const;
+/**
+ * How strictly the model must adhere to the provided colors.
+ *
+ * @remarks
+ * - `strict`: Only use exact hex codes provided
+ * - `tints_and_shades`: Can adjust lightness/opacity, but no new hues
+ * - `creative`: Palette is a suggestion/starting point
+ */
+export type ColorAdherence = ClosedEnum<typeof ColorAdherence>;
+
+/** @internal */
+export const ColorAdherence$outboundSchema: z.ZodNativeEnum<
+  typeof ColorAdherence
+> = z.nativeEnum(ColorAdherence);

package/src/sdk/models/shared/colorroles.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Semantic mapping of colors to specific roles
+ */
+export type ColorRoles = {
+  /**
+   * Accent colors for highlights and emphasis
+   */
+  accent?: Array<string> | undefined;
+  /**
+   * Colors allowed for background elements
+   */
+  background?: Array<string> | undefined;
+  /**
+   * Arbitrary custom role colors
+   */
+  metadata?: Array<string> | undefined;
+  /**
+   * Primary/main colors for key elements
+   */
+  primary?: Array<string> | undefined;
+};
+
+/** @internal */
+export type ColorRoles$Outbound = {
+  accent?: Array<string> | undefined;
+  background?: Array<string> | undefined;
+  metadata?: Array<string> | undefined;
+  primary?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ColorRoles$outboundSchema: z.ZodType<
+  ColorRoles$Outbound,
+  z.ZodTypeDef,
+  ColorRoles
+> = z.object({
+  accent: z.array(z.string()).optional(),
+  background: z.array(z.string()).optional(),
+  metadata: z.array(z.string()).optional(),
+  primary: z.array(z.string()).optional(),
+});
+
+export function colorRolesToJSON(colorRoles: ColorRoles): string {
+  return JSON.stringify(ColorRoles$outboundSchema.parse(colorRoles));
+}

package/src/sdk/models/shared/colors.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 {
+  ColorAdherence,
+  ColorAdherence$outboundSchema,
+} from "./coloradherence.js";
+import {
+  ColorRoles,
+  ColorRoles$Outbound,
+  ColorRoles$outboundSchema,
+} from "./colorroles.js";
+
+/**
+ * The color system configuration for SVG generation
+ */
+export type Colors = {
+  /**
+   * How strictly the model must adhere to the provided colors.
+   *
+   * @remarks
+   * - `strict`: Only use exact hex codes provided
+   * - `tints_and_shades`: Can adjust lightness/opacity, but no new hues
+   * - `creative`: Palette is a suggestion/starting point
+   */
+  adherence?: ColorAdherence | undefined;
+  /**
+   * Whether to allow opacity/transparency variations
+   */
+  allowOpacity?: boolean | undefined;
+  /**
+   * Soft limit on unique colors
+   */
+  maxColors?: number | undefined;
+  /**
+   * General list of allowed colors (hex codes)
+   */
+  palette?: Array<string> | undefined;
+  /**
+   * Semantic mapping of colors to specific roles
+   */
+  roles?: ColorRoles | undefined;
+  /**
+   * If true, allows <linearGradient> and <radialGradient> definitions
+   */
+  useGradients?: boolean | undefined;
+};
+
+/** @internal */
+export type Colors$Outbound = {
+  adherence: string;
+  allow_opacity: boolean;
+  max_colors: number;
+  palette?: Array<string> | undefined;
+  roles?: ColorRoles$Outbound | undefined;
+  use_gradients: boolean;
+};
+
+/** @internal */
+export const Colors$outboundSchema: z.ZodType<
+  Colors$Outbound,
+  z.ZodTypeDef,
+  Colors
+> = z.object({
+  adherence: ColorAdherence$outboundSchema.default("tints_and_shades"),
+  allowOpacity: z.boolean().default(true),
+  maxColors: z.number().int().default(4),
+  palette: z.array(z.string()).optional(),
+  roles: ColorRoles$outboundSchema.optional(),
+  useGradients: z.boolean().default(false),
+}).transform((v) => {
+  return remap$(v, {
+    allowOpacity: "allow_opacity",
+    maxColors: "max_colors",
+    useGradients: "use_gradients",
+  });
+});
+
+export function colorsToJSON(colors: Colors): string {
+  return JSON.stringify(Colors$outboundSchema.parse(colors));
+}

package/src/sdk/models/shared/constraints.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+
+/**
+ * Limits and constraints for the generated SVG output
+ */
+export type Constraints = {
+  /**
+   * Maximum total number of SVG elements
+   */
+  maxElements?: number | undefined;
+  /**
+   * Maximum number of path elements in the SVG
+   */
+  maxPaths?: number | undefined;
+  /**
+   * Maximum number of points/commands per path
+   */
+  maxPointsPerPath?: number | undefined;
+};
+
+/** @internal */
+export type Constraints$Outbound = {
+  max_elements?: number | undefined;
+  max_paths?: number | undefined;
+  max_points_per_path?: number | undefined;
+};
+
+/** @internal */
+export const Constraints$outboundSchema: z.ZodType<
+  Constraints$Outbound,
+  z.ZodTypeDef,
+  Constraints
+> = z.object({
+  maxElements: z.number().int().optional(),
+  maxPaths: z.number().int().optional(),
+  maxPointsPerPath: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    maxElements: "max_elements",
+    maxPaths: "max_paths",
+    maxPointsPerPath: "max_points_per_path",
+  });
+});
+
+export function constraintsToJSON(constraints: Constraints): string {
+  return JSON.stringify(Constraints$outboundSchema.parse(constraints));
+}