@versedbcom/sdk 0.1.1

package/src/models/operations/update-collection-item.ts

@@ -0,0 +1,658 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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/sdk-validation-error.js";
+
+/**
+ * Comic condition grade (CGC scale).
+ */
+export const Condition = {
+  Mint: "MT",
+  NearMintMint: "NM/MT",
+  NearMintPlus: "NM+",
+  NearMint: "NM",
+  NearMintMinus: "NM-",
+  VeryFineNearMint: "VF/NM",
+  VeryFinePlus: "VF+",
+  VeryFine: "VF",
+  VeryFineMinus: "VF-",
+  FineVeryFine: "F/VF",
+  FinePlus: "F+",
+  Fine: "F",
+  FineMinus: "F-",
+  VeryGoodFine: "VG/F",
+  VeryGoodPlus: "VG+",
+  VeryGood: "VG",
+  VeryGoodMinus: "VG-",
+  GoodVeryGood: "G/VG",
+  Good: "G",
+  Fair: "FR",
+  Poor: "PR",
+} as const;
+/**
+ * Comic condition grade (CGC scale).
+ */
+export type Condition = ClosedEnum<typeof Condition>;
+
+/**
+ * Physical format of the copy.
+ */
+export const UpdateCollectionItemFormat = {
+  Standard: "standard",
+  TradePaperback: "trade_paperback",
+  Hardcover: "hardcover",
+  Omnibus: "omnibus",
+  DeluxeEdition: "deluxe_edition",
+  Annual: "annual",
+  GraphicNovel: "graphic_novel",
+  Digital: "digital",
+  Treasury: "treasury",
+  Magazine: "magazine",
+  Prestige: "prestige",
+  Digest: "digest",
+  Other: "other",
+} as const;
+/**
+ * Physical format of the copy.
+ */
+export type UpdateCollectionItemFormat = ClosedEnum<
+  typeof UpdateCollectionItemFormat
+>;
+
+/**
+ * Where the comic was purchased.
+ */
+export const UpdateCollectionItemPurchaseSource = {
+  ComicShop: "comic_shop",
+  OnlineRetailer: "online_retailer",
+  Auction: "auction",
+  Convention: "convention",
+  PrivateSeller: "private_seller",
+  Subscription: "subscription",
+  DigitalPlatform: "digital_platform",
+  SecondHandStore: "second_hand_store",
+  Inheritance: "inheritance",
+  Gift: "gift",
+  Trade: "trade",
+  Other: "other",
+} as const;
+/**
+ * Where the comic was purchased.
+ */
+export type UpdateCollectionItemPurchaseSource = ClosedEnum<
+  typeof UpdateCollectionItemPurchaseSource
+>;
+
+/**
+ * How the comic was acquired.
+ */
+export const UpdateCollectionItemAcquisitionMethod = {
+  Purchase: "purchase",
+  Trade: "trade",
+  Gift: "gift",
+  Inheritance: "inheritance",
+  Subscription: "subscription",
+  Found: "found",
+  Other: "other",
+} as const;
+/**
+ * How the comic was acquired.
+ */
+export type UpdateCollectionItemAcquisitionMethod = ClosedEnum<
+  typeof UpdateCollectionItemAcquisitionMethod
+>;
+
+export const UpdateCollectionItemVariantType = {
+  Standard: "standard",
+  CoverVariant: "cover_variant",
+  RetailerExclusive: "retailer_exclusive",
+  ConventionExclusive: "convention_exclusive",
+  IncentiveVariant: "incentive_variant",
+  RatioVariant: "ratio_variant",
+  FoilVariant: "foil_variant",
+  SketchVariant: "sketch_variant",
+  VirginVariant: "virgin_variant",
+  BlankVariant: "blank_variant",
+  ArtistVariant: "artist_variant",
+  HologramVariant: "hologram_variant",
+  GlowInDarkVariant: "glow_in_dark_variant",
+  Facsimile: "facsimile",
+  Reprint: "reprint",
+  Other: "other",
+} as const;
+export type UpdateCollectionItemVariantType = ClosedEnum<
+  typeof UpdateCollectionItemVariantType
+>;
+
+/**
+ * Grading company (CGC, CBCS, PGX, other, self_graded).
+ */
+export const UpdateCollectionItemGradingCompany = {
+  Cgc: "CGC",
+  Cbcs: "CBCS",
+  Pgx: "PGX",
+  Other: "other",
+  SelfGraded: "self_graded",
+} as const;
+/**
+ * Grading company (CGC, CBCS, PGX, other, self_graded).
+ */
+export type UpdateCollectionItemGradingCompany = ClosedEnum<
+  typeof UpdateCollectionItemGradingCompany
+>;
+
+/**
+ * Slab label tier (e.g. universal, signature_series, restored, qualified).
+ */
+export const UpdateCollectionItemLabelType = {
+  Universal: "universal",
+  SignatureSeries: "signature_series",
+  Qualified: "qualified",
+  Restored: "restored",
+  Cgcxjsa: "cgcxjsa",
+  Standard: "standard",
+  VerifiedSignature: "verified_signature",
+  Signed: "signed",
+  Conserved: "conserved",
+} as const;
+/**
+ * Slab label tier (e.g. universal, signature_series, restored, qualified).
+ */
+export type UpdateCollectionItemLabelType = ClosedEnum<
+  typeof UpdateCollectionItemLabelType
+>;
+
+/**
+ * Interior page color quality from the slab label.
+ */
+export const UpdateCollectionItemPageQuality = {
+  White: "white",
+  OffWhiteToWhite: "off_white_to_white",
+  OffWhite: "off_white",
+  CreamToOffWhite: "cream_to_off_white",
+  LightTan: "light_tan",
+  Tan: "tan",
+  Brittle: "brittle",
+} as const;
+/**
+ * Interior page color quality from the slab label.
+ */
+export type UpdateCollectionItemPageQuality = ClosedEnum<
+  typeof UpdateCollectionItemPageQuality
+>;
+
+export const UpdateCollectionItemPrintNumber = {
+  Onest: "1st",
+  Twond: "2nd",
+  Threerd: "3rd",
+  Fourth: "4th",
+  Fiveth: "5th",
+  Sixth: "6th",
+  Seventh: "7th",
+  Eightth: "8th",
+  Nineth: "9th",
+  Tenth: "10th",
+  Other: "other",
+} as const;
+export type UpdateCollectionItemPrintNumber = ClosedEnum<
+  typeof UpdateCollectionItemPrintNumber
+>;
+
+export const UpdateCollectionItemSignatureWitness = {
+  Cgc: "CGC",
+  Cbcs: "CBCS",
+  Jsa: "JSA",
+  PsaDna: "PSA/DNA",
+  WitnessedInPerson: "witnessed_in_person",
+  Unwitnessed: "unwitnessed",
+  Other: "other",
+} as const;
+export type UpdateCollectionItemSignatureWitness = ClosedEnum<
+  typeof UpdateCollectionItemSignatureWitness
+>;
+
+export type UpdateCollectionItemRequestBody = {
+  /**
+   * Link to a specific issue variant. Must belong to the issue. The <code>id</code> of an existing record in the issue_variants table.
+   */
+  variantId?: number | null | undefined;
+  /**
+   * Comic condition grade (CGC scale).
+   */
+  condition?: Condition | null | undefined;
+  /**
+   * User notes about this copy. Must not be greater than 1000 characters.
+   */
+  notes?: string | null | undefined;
+  /**
+   * Purchase price in dollars. Must be at least 0. Must not be greater than 999999.99.
+   */
+  pricePaid?: number | null | undefined;
+  /**
+   * Physical format of the copy.
+   */
+  format?: UpdateCollectionItemFormat | null | undefined;
+  /**
+   * Where the comic was purchased.
+   */
+  purchaseSource?: UpdateCollectionItemPurchaseSource | null | undefined;
+  /**
+   * ID of the specific comic shop the copy was purchased from. Self-reported; independent of purchase_source. The <code>id</code> of an existing record in the comic_shops table.
+   */
+  comicShopId?: number | null | undefined;
+  /**
+   * How the comic was acquired.
+   */
+  acquisitionMethod?: UpdateCollectionItemAcquisitionMethod | null | undefined;
+  /**
+   * Date of purchase (YYYY-MM-DD). Must be a valid date.
+   */
+  purchasedAt?: string | null | undefined;
+  /**
+   * Where the comic is stored. Must not be greater than 255 characters.
+   */
+  storageLocation?: string | null | undefined;
+  /**
+   * Whether the comic is signed.
+   */
+  isSigned?: boolean | undefined;
+  /**
+   * Name(s) of the creator(s) who signed the comic. Free-text — comma-separate multiple signers. Must not be greater than 255 characters.
+   */
+  signedBy?: string | null | undefined;
+  isVariant?: boolean | undefined;
+  /**
+   * Must not be greater than 500 characters.
+   */
+  variantDescription?: string | null | undefined;
+  variantType?: UpdateCollectionItemVariantType | null | undefined;
+  /**
+   * Whether the comic is professionally graded.
+   */
+  graded?: boolean | undefined;
+  /**
+   * Numeric grade score (e.g. 9.8). Must not be greater than 10 characters.
+   */
+  gradeScore?: string | null | undefined;
+  /**
+   * Grading company (CGC, CBCS, PGX, other, self_graded).
+   */
+  gradingCompany?: UpdateCollectionItemGradingCompany | null | undefined;
+  /**
+   * Grading certification number. Must not be greater than 50 characters.
+   */
+  gradingNumber?: string | null | undefined;
+  /**
+   * Slab label tier (e.g. universal, signature_series, restored, qualified).
+   */
+  labelType?: UpdateCollectionItemLabelType | null | undefined;
+  /**
+   * Interior page color quality from the slab label.
+   */
+  pageQuality?: UpdateCollectionItemPageQuality | null | undefined;
+  /**
+   * Free-text notes printed on the slab label. Must not be greater than 2000 characters.
+   */
+  graderNotes?: string | null | undefined;
+  printNumber?: UpdateCollectionItemPrintNumber | null | undefined;
+  signatureWitness?: UpdateCollectionItemSignatureWitness | null | undefined;
+  /**
+   * Current estimated value in dollars. Must be at least 0. Must not be greater than 999999.99.
+   */
+  estimatedValue?: number | null | undefined;
+  /**
+   * Whether the item is for sale.
+   */
+  forSale?: boolean | undefined;
+  /**
+   * Whether the item is available for trade.
+   */
+  forTrade?: boolean | undefined;
+  /**
+   * Whether this collection item is publicly visible.
+   */
+  isPublic?: boolean | undefined;
+  /**
+   * Whether the issue has been read.
+   */
+  isRead?: boolean | undefined;
+  /**
+   * When the issue was read (YYYY-MM-DD). Cannot be in the future. Must be a valid date. Must be a date before or equal to <code>today</code>.
+   */
+  readAt?: string | null | undefined;
+};
+
+export type UpdateCollectionItemRequest = {
+  /**
+   * The issue ID.
+   */
+  issueId: number;
+  /**
+   * Specific variant ID to update (when user has multiple entries).
+   */
+  variantId?: number | undefined;
+  /**
+   * Specific collection item ID to update.
+   */
+  collectionItemId?: number | undefined;
+  body?: UpdateCollectionItemRequestBody | undefined;
+};
+
+export type UpdateCollectionItemData = {
+  id?: number | undefined;
+  condition?: string | undefined;
+  pricePaid?: number | undefined;
+  graded?: boolean | undefined;
+};
+
+/**
+ * Success
+ */
+export type UpdateCollectionItemResponseBody = {
+  data?: UpdateCollectionItemData | undefined;
+};
+
+export type UpdateCollectionItemResponse = {
+  headers: { [k: string]: Array<string> };
+  result: UpdateCollectionItemResponseBody;
+};
+
+/** @internal */
+export const Condition$outboundSchema: z.ZodMiniEnum<typeof Condition> = z.enum(
+  Condition,
+);
+
+/** @internal */
+export const UpdateCollectionItemFormat$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemFormat
+> = z.enum(UpdateCollectionItemFormat);
+
+/** @internal */
+export const UpdateCollectionItemPurchaseSource$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemPurchaseSource
+> = z.enum(UpdateCollectionItemPurchaseSource);
+
+/** @internal */
+export const UpdateCollectionItemAcquisitionMethod$outboundSchema:
+  z.ZodMiniEnum<typeof UpdateCollectionItemAcquisitionMethod> = z.enum(
+    UpdateCollectionItemAcquisitionMethod,
+  );
+
+/** @internal */
+export const UpdateCollectionItemVariantType$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemVariantType
+> = z.enum(UpdateCollectionItemVariantType);
+
+/** @internal */
+export const UpdateCollectionItemGradingCompany$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemGradingCompany
+> = z.enum(UpdateCollectionItemGradingCompany);
+
+/** @internal */
+export const UpdateCollectionItemLabelType$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemLabelType
+> = z.enum(UpdateCollectionItemLabelType);
+
+/** @internal */
+export const UpdateCollectionItemPageQuality$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemPageQuality
+> = z.enum(UpdateCollectionItemPageQuality);
+
+/** @internal */
+export const UpdateCollectionItemPrintNumber$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemPrintNumber
+> = z.enum(UpdateCollectionItemPrintNumber);
+
+/** @internal */
+export const UpdateCollectionItemSignatureWitness$outboundSchema: z.ZodMiniEnum<
+  typeof UpdateCollectionItemSignatureWitness
+> = z.enum(UpdateCollectionItemSignatureWitness);
+
+/** @internal */
+export type UpdateCollectionItemRequestBody$Outbound = {
+  variant_id?: number | null | undefined;
+  condition?: string | null | undefined;
+  notes?: string | null | undefined;
+  price_paid?: number | null | undefined;
+  format?: string | null | undefined;
+  purchase_source?: string | null | undefined;
+  comic_shop_id?: number | null | undefined;
+  acquisition_method?: string | null | undefined;
+  purchased_at?: string | null | undefined;
+  storage_location?: string | null | undefined;
+  is_signed?: boolean | undefined;
+  signed_by?: string | null | undefined;
+  is_variant?: boolean | undefined;
+  variant_description?: string | null | undefined;
+  variant_type?: string | null | undefined;
+  graded?: boolean | undefined;
+  grade_score?: string | null | undefined;
+  grading_company?: string | null | undefined;
+  grading_number?: string | null | undefined;
+  label_type?: string | null | undefined;
+  page_quality?: string | null | undefined;
+  grader_notes?: string | null | undefined;
+  print_number?: string | null | undefined;
+  signature_witness?: string | null | undefined;
+  estimated_value?: number | null | undefined;
+  for_sale?: boolean | undefined;
+  for_trade?: boolean | undefined;
+  is_public?: boolean | undefined;
+  is_read?: boolean | undefined;
+  read_at?: string | null | undefined;
+};
+
+/** @internal */
+export const UpdateCollectionItemRequestBody$outboundSchema: z.ZodMiniType<
+  UpdateCollectionItemRequestBody$Outbound,
+  UpdateCollectionItemRequestBody
+> = z.pipe(
+  z.object({
+    variantId: z.optional(z.nullable(z.int())),
+    condition: z.optional(z.nullable(Condition$outboundSchema)),
+    notes: z.optional(z.nullable(z.string())),
+    pricePaid: z.optional(z.nullable(z.number())),
+    format: z.optional(z.nullable(UpdateCollectionItemFormat$outboundSchema)),
+    purchaseSource: z.optional(
+      z.nullable(UpdateCollectionItemPurchaseSource$outboundSchema),
+    ),
+    comicShopId: z.optional(z.nullable(z.int())),
+    acquisitionMethod: z.optional(
+      z.nullable(UpdateCollectionItemAcquisitionMethod$outboundSchema),
+    ),
+    purchasedAt: z.optional(z.nullable(z.string())),
+    storageLocation: z.optional(z.nullable(z.string())),
+    isSigned: z.optional(z.boolean()),
+    signedBy: z.optional(z.nullable(z.string())),
+    isVariant: z.optional(z.boolean()),
+    variantDescription: z.optional(z.nullable(z.string())),
+    variantType: z.optional(
+      z.nullable(UpdateCollectionItemVariantType$outboundSchema),
+    ),
+    graded: z.optional(z.boolean()),
+    gradeScore: z.optional(z.nullable(z.string())),
+    gradingCompany: z.optional(
+      z.nullable(UpdateCollectionItemGradingCompany$outboundSchema),
+    ),
+    gradingNumber: z.optional(z.nullable(z.string())),
+    labelType: z.optional(
+      z.nullable(UpdateCollectionItemLabelType$outboundSchema),
+    ),
+    pageQuality: z.optional(
+      z.nullable(UpdateCollectionItemPageQuality$outboundSchema),
+    ),
+    graderNotes: z.optional(z.nullable(z.string())),
+    printNumber: z.optional(
+      z.nullable(UpdateCollectionItemPrintNumber$outboundSchema),
+    ),
+    signatureWitness: z.optional(
+      z.nullable(UpdateCollectionItemSignatureWitness$outboundSchema),
+    ),
+    estimatedValue: z.optional(z.nullable(z.number())),
+    forSale: z.optional(z.boolean()),
+    forTrade: z.optional(z.boolean()),
+    isPublic: z.optional(z.boolean()),
+    isRead: z.optional(z.boolean()),
+    readAt: z.optional(z.nullable(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      variantId: "variant_id",
+      pricePaid: "price_paid",
+      purchaseSource: "purchase_source",
+      comicShopId: "comic_shop_id",
+      acquisitionMethod: "acquisition_method",
+      purchasedAt: "purchased_at",
+      storageLocation: "storage_location",
+      isSigned: "is_signed",
+      signedBy: "signed_by",
+      isVariant: "is_variant",
+      variantDescription: "variant_description",
+      variantType: "variant_type",
+      gradeScore: "grade_score",
+      gradingCompany: "grading_company",
+      gradingNumber: "grading_number",
+      labelType: "label_type",
+      pageQuality: "page_quality",
+      graderNotes: "grader_notes",
+      printNumber: "print_number",
+      signatureWitness: "signature_witness",
+      estimatedValue: "estimated_value",
+      forSale: "for_sale",
+      forTrade: "for_trade",
+      isPublic: "is_public",
+      isRead: "is_read",
+      readAt: "read_at",
+    });
+  }),
+);
+
+export function updateCollectionItemRequestBodyToJSON(
+  updateCollectionItemRequestBody: UpdateCollectionItemRequestBody,
+): string {
+  return JSON.stringify(
+    UpdateCollectionItemRequestBody$outboundSchema.parse(
+      updateCollectionItemRequestBody,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateCollectionItemRequest$Outbound = {
+  issue_id: number;
+  variant_id?: number | undefined;
+  collection_item_id?: number | undefined;
+  body?: UpdateCollectionItemRequestBody$Outbound | undefined;
+};
+
+/** @internal */
+export const UpdateCollectionItemRequest$outboundSchema: z.ZodMiniType<
+  UpdateCollectionItemRequest$Outbound,
+  UpdateCollectionItemRequest
+> = z.pipe(
+  z.object({
+    issueId: z.int(),
+    variantId: z.optional(z.int()),
+    collectionItemId: z.optional(z.int()),
+    body: z.optional(
+      z.lazy(() => UpdateCollectionItemRequestBody$outboundSchema),
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      issueId: "issue_id",
+      variantId: "variant_id",
+      collectionItemId: "collection_item_id",
+    });
+  }),
+);
+
+export function updateCollectionItemRequestToJSON(
+  updateCollectionItemRequest: UpdateCollectionItemRequest,
+): string {
+  return JSON.stringify(
+    UpdateCollectionItemRequest$outboundSchema.parse(
+      updateCollectionItemRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const UpdateCollectionItemData$inboundSchema: z.ZodMiniType<
+  UpdateCollectionItemData,
+  unknown
+> = z.pipe(
+  z.object({
+    id: types.optional(types.number()),
+    condition: types.optional(types.string()),
+    price_paid: types.optional(types.number()),
+    graded: types.optional(types.boolean()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "price_paid": "pricePaid",
+    });
+  }),
+);
+
+export function updateCollectionItemDataFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCollectionItemData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCollectionItemData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCollectionItemData' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateCollectionItemResponseBody$inboundSchema: z.ZodMiniType<
+  UpdateCollectionItemResponseBody,
+  unknown
+> = z.object({
+  data: types.optional(z.lazy(() => UpdateCollectionItemData$inboundSchema)),
+});
+
+export function updateCollectionItemResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCollectionItemResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCollectionItemResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCollectionItemResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdateCollectionItemResponse$inboundSchema: z.ZodMiniType<
+  UpdateCollectionItemResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: z.lazy(() => UpdateCollectionItemResponseBody$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+export function updateCollectionItemResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateCollectionItemResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateCollectionItemResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateCollectionItemResponse' from JSON`,
+  );
+}