@archdao/archdao-client 1.7.1

package/src/models/components/proposal.ts

@@ -0,0 +1,223 @@
+/*
+ * 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";
+import {
+  DecisionMarket,
+  DecisionMarket$inboundSchema,
+  DecisionMarket$Outbound,
+  DecisionMarket$outboundSchema,
+} from "./decisionmarket.js";
+import {
+  ProposalAction,
+  ProposalAction$inboundSchema,
+  ProposalAction$Outbound,
+  ProposalAction$outboundSchema,
+} from "./proposalaction.js";
+
+export const ProposalStatus = {
+  Draft: "draft",
+  Staking: "staking",
+  Active: "active",
+  Resolved: "resolved",
+  Executed: "executed",
+  Cancelled: "cancelled",
+} as const;
+export type ProposalStatus = ClosedEnum<typeof ProposalStatus>;
+
+export const Outcome = {
+  Pass: "pass",
+  Fail: "fail",
+} as const;
+export type Outcome = ClosedEnum<typeof Outcome>;
+
+export type Proposal = {
+  id?: number | undefined;
+  organizationId: number;
+  userId?: number | undefined;
+  title: string;
+  description: string;
+  status?: ProposalStatus | undefined;
+  outcome?: Outcome | undefined;
+  lpAllocation?: number | undefined;
+  tokensForLp?: number | undefined;
+  usdcForLp?: number | undefined;
+  stakingThreshold?: number | undefined;
+  passThresholdBps?: number | undefined;
+  totalStaked?: number | undefined;
+  tradingStartsAt?: Date | undefined;
+  tradingEndsAt?: Date | undefined;
+  resolvedAt?: Date | undefined;
+  executedAt?: Date | undefined;
+  actions?: Array<ProposalAction> | undefined;
+  /**
+   * Decision markets for this proposal. Null during draft/staking phases, populated once active.
+   */
+  decisionMarkets?: Array<DecisionMarket> | null | undefined;
+  created?: Date | undefined;
+  updated?: Date | undefined;
+};
+
+/** @internal */
+export const ProposalStatus$inboundSchema: z.ZodNativeEnum<
+  typeof ProposalStatus
+> = z.nativeEnum(ProposalStatus);
+
+/** @internal */
+export const ProposalStatus$outboundSchema: z.ZodNativeEnum<
+  typeof ProposalStatus
+> = ProposalStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProposalStatus$ {
+  /** @deprecated use `ProposalStatus$inboundSchema` instead. */
+  export const inboundSchema = ProposalStatus$inboundSchema;
+  /** @deprecated use `ProposalStatus$outboundSchema` instead. */
+  export const outboundSchema = ProposalStatus$outboundSchema;
+}
+
+/** @internal */
+export const Outcome$inboundSchema: z.ZodNativeEnum<typeof Outcome> = z
+  .nativeEnum(Outcome);
+
+/** @internal */
+export const Outcome$outboundSchema: z.ZodNativeEnum<typeof Outcome> =
+  Outcome$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Outcome$ {
+  /** @deprecated use `Outcome$inboundSchema` instead. */
+  export const inboundSchema = Outcome$inboundSchema;
+  /** @deprecated use `Outcome$outboundSchema` instead. */
+  export const outboundSchema = Outcome$outboundSchema;
+}
+
+/** @internal */
+export const Proposal$inboundSchema: z.ZodType<
+  Proposal,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.number().int().optional(),
+  organizationId: z.number().int(),
+  userId: z.number().int().optional(),
+  title: z.string(),
+  description: z.string(),
+  status: ProposalStatus$inboundSchema.optional(),
+  outcome: Outcome$inboundSchema.optional(),
+  lpAllocation: z.number().int().optional(),
+  tokensForLp: z.number().optional(),
+  usdcForLp: z.number().optional(),
+  stakingThreshold: z.number().optional(),
+  passThresholdBps: z.number().int().optional(),
+  totalStaked: z.number().optional(),
+  tradingStartsAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  tradingEndsAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  resolvedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  executedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  actions: z.array(ProposalAction$inboundSchema).optional(),
+  decisionMarkets: z.nullable(z.array(DecisionMarket$inboundSchema)).optional(),
+  created: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  updated: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+});
+
+/** @internal */
+export type Proposal$Outbound = {
+  id?: number | undefined;
+  organizationId: number;
+  userId?: number | undefined;
+  title: string;
+  description: string;
+  status?: string | undefined;
+  outcome?: string | undefined;
+  lpAllocation?: number | undefined;
+  tokensForLp?: number | undefined;
+  usdcForLp?: number | undefined;
+  stakingThreshold?: number | undefined;
+  passThresholdBps?: number | undefined;
+  totalStaked?: number | undefined;
+  tradingStartsAt?: string | undefined;
+  tradingEndsAt?: string | undefined;
+  resolvedAt?: string | undefined;
+  executedAt?: string | undefined;
+  actions?: Array<ProposalAction$Outbound> | undefined;
+  decisionMarkets?: Array<DecisionMarket$Outbound> | null | undefined;
+  created?: string | undefined;
+  updated?: string | undefined;
+};
+
+/** @internal */
+export const Proposal$outboundSchema: z.ZodType<
+  Proposal$Outbound,
+  z.ZodTypeDef,
+  Proposal
+> = z.object({
+  id: z.number().int().optional(),
+  organizationId: z.number().int(),
+  userId: z.number().int().optional(),
+  title: z.string(),
+  description: z.string(),
+  status: ProposalStatus$outboundSchema.optional(),
+  outcome: Outcome$outboundSchema.optional(),
+  lpAllocation: z.number().int().optional(),
+  tokensForLp: z.number().optional(),
+  usdcForLp: z.number().optional(),
+  stakingThreshold: z.number().optional(),
+  passThresholdBps: z.number().int().optional(),
+  totalStaked: z.number().optional(),
+  tradingStartsAt: z.date().transform(v => v.toISOString()).optional(),
+  tradingEndsAt: z.date().transform(v => v.toISOString()).optional(),
+  resolvedAt: z.date().transform(v => v.toISOString()).optional(),
+  executedAt: z.date().transform(v => v.toISOString()).optional(),
+  actions: z.array(ProposalAction$outboundSchema).optional(),
+  decisionMarkets: z.nullable(z.array(DecisionMarket$outboundSchema))
+    .optional(),
+  created: z.date().transform(v => v.toISOString()).optional(),
+  updated: z.date().transform(v => v.toISOString()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Proposal$ {
+  /** @deprecated use `Proposal$inboundSchema` instead. */
+  export const inboundSchema = Proposal$inboundSchema;
+  /** @deprecated use `Proposal$outboundSchema` instead. */
+  export const outboundSchema = Proposal$outboundSchema;
+  /** @deprecated use `Proposal$Outbound` instead. */
+  export type Outbound = Proposal$Outbound;
+}
+
+export function proposalToJSON(proposal: Proposal): string {
+  return JSON.stringify(Proposal$outboundSchema.parse(proposal));
+}
+
+export function proposalFromJSON(
+  jsonString: string,
+): SafeParseResult<Proposal, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Proposal$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Proposal' from JSON`,
+  );
+}