@moovio/sdk 0.16.4 → 0.16.5

package/src/models/components/productoption.ts

@@ -0,0 +1,101 @@
+/*
+ * 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";
+import {
+  ProductImageMetadata,
+  ProductImageMetadata$inboundSchema,
+  ProductImageMetadata$Outbound,
+  ProductImageMetadata$outboundSchema,
+} from "./productimagemetadata.js";
+
+/**
+ * Represents a single product option within a group.
+ */
+export type ProductOption = {
+  /**
+   * The display name of a product option.
+   */
+  name: string;
+  /**
+   * A detailed description of the option.
+   *
+   * @remarks
+   *
+   * - Must be valid UTF-8 text
+   * - Supports Markdown for formatting
+   * - HTML is not permitted and will be rejected
+   */
+  description?: string | undefined;
+  /**
+   * The adjustment applied to a product's base price by this option. Can be negative, positive, or zero.
+   */
+  priceModifier?: string | undefined;
+  /**
+   * The images associated with this option.
+   */
+  images?: Array<ProductImageMetadata> | undefined;
+};
+
+/** @internal */
+export const ProductOption$inboundSchema: z.ZodType<
+  ProductOption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.array(ProductImageMetadata$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ProductOption$Outbound = {
+  name: string;
+  description?: string | undefined;
+  priceModifier?: string | undefined;
+  images?: Array<ProductImageMetadata$Outbound> | undefined;
+};
+
+/** @internal */
+export const ProductOption$outboundSchema: z.ZodType<
+  ProductOption$Outbound,
+  z.ZodTypeDef,
+  ProductOption
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.array(ProductImageMetadata$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductOption$ {
+  /** @deprecated use `ProductOption$inboundSchema` instead. */
+  export const inboundSchema = ProductOption$inboundSchema;
+  /** @deprecated use `ProductOption$outboundSchema` instead. */
+  export const outboundSchema = ProductOption$outboundSchema;
+  /** @deprecated use `ProductOption$Outbound` instead. */
+  export type Outbound = ProductOption$Outbound;
+}
+
+export function productOptionToJSON(productOption: ProductOption): string {
+  return JSON.stringify(ProductOption$outboundSchema.parse(productOption));
+}
+
+export function productOptionFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductOption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductOption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductOption' from JSON`,
+  );
+}

package/src/models/components/productoptiongroup.ts

@@ -0,0 +1,113 @@
+/*
+ * 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";
+import {
+  ProductOption,
+  ProductOption$inboundSchema,
+  ProductOption$Outbound,
+  ProductOption$outboundSchema,
+} from "./productoption.js";
+
+/**
+ * Represents a group of product configuration options, such as size or color.
+ */
+export type ProductOptionGroup = {
+  name: string;
+  /**
+   * A detailed description of the option group.
+   *
+   * @remarks
+   *
+   * - Must be valid UTF-8 text
+   * - Supports Markdown for formatting
+   * - HTML is not permitted and will be rejected
+   */
+  description?: string | undefined;
+  /**
+   * The minimum number of options that must be selected from this group.
+   *
+   * @remarks
+   *
+   * A value of 0 indicates that no selection from this group is required.
+   */
+  minSelect: number;
+  /**
+   * The maximum number of options that can be selected from this group.
+   */
+  maxSelect: number;
+  /**
+   * The options available within this group.
+   */
+  options: Array<ProductOption>;
+};
+
+/** @internal */
+export const ProductOptionGroup$inboundSchema: z.ZodType<
+  ProductOptionGroup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  minSelect: z.number().int(),
+  maxSelect: z.number().int(),
+  options: z.array(ProductOption$inboundSchema),
+});
+
+/** @internal */
+export type ProductOptionGroup$Outbound = {
+  name: string;
+  description?: string | undefined;
+  minSelect: number;
+  maxSelect: number;
+  options: Array<ProductOption$Outbound>;
+};
+
+/** @internal */
+export const ProductOptionGroup$outboundSchema: z.ZodType<
+  ProductOptionGroup$Outbound,
+  z.ZodTypeDef,
+  ProductOptionGroup
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  minSelect: z.number().int(),
+  maxSelect: z.number().int(),
+  options: z.array(ProductOption$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductOptionGroup$ {
+  /** @deprecated use `ProductOptionGroup$inboundSchema` instead. */
+  export const inboundSchema = ProductOptionGroup$inboundSchema;
+  /** @deprecated use `ProductOptionGroup$outboundSchema` instead. */
+  export const outboundSchema = ProductOptionGroup$outboundSchema;
+  /** @deprecated use `ProductOptionGroup$Outbound` instead. */
+  export type Outbound = ProductOptionGroup$Outbound;
+}
+
+export function productOptionGroupToJSON(
+  productOptionGroup: ProductOptionGroup,
+): string {
+  return JSON.stringify(
+    ProductOptionGroup$outboundSchema.parse(productOptionGroup),
+  );
+}
+
+export function productOptionGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductOptionGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductOptionGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductOptionGroup' from JSON`,
+  );
+}

package/src/models/components/productoptiongroupvalidationerror.ts

@@ -0,0 +1,91 @@
+/*
+ * 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";
+import {
+  ProductOptionValidationError,
+  ProductOptionValidationError$inboundSchema,
+  ProductOptionValidationError$Outbound,
+  ProductOptionValidationError$outboundSchema,
+} from "./productoptionvalidationerror.js";
+
+export type ProductOptionGroupValidationError = {
+  name?: string | undefined;
+  description?: string | undefined;
+  minSelect?: string | undefined;
+  maxSelect?: string | undefined;
+  options?: { [k: string]: ProductOptionValidationError } | undefined;
+};
+
+/** @internal */
+export const ProductOptionGroupValidationError$inboundSchema: z.ZodType<
+  ProductOptionGroupValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  minSelect: z.string().optional(),
+  maxSelect: z.string().optional(),
+  options: z.record(ProductOptionValidationError$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ProductOptionGroupValidationError$Outbound = {
+  name?: string | undefined;
+  description?: string | undefined;
+  minSelect?: string | undefined;
+  maxSelect?: string | undefined;
+  options?: { [k: string]: ProductOptionValidationError$Outbound } | undefined;
+};
+
+/** @internal */
+export const ProductOptionGroupValidationError$outboundSchema: z.ZodType<
+  ProductOptionGroupValidationError$Outbound,
+  z.ZodTypeDef,
+  ProductOptionGroupValidationError
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  minSelect: z.string().optional(),
+  maxSelect: z.string().optional(),
+  options: z.record(ProductOptionValidationError$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductOptionGroupValidationError$ {
+  /** @deprecated use `ProductOptionGroupValidationError$inboundSchema` instead. */
+  export const inboundSchema = ProductOptionGroupValidationError$inboundSchema;
+  /** @deprecated use `ProductOptionGroupValidationError$outboundSchema` instead. */
+  export const outboundSchema =
+    ProductOptionGroupValidationError$outboundSchema;
+  /** @deprecated use `ProductOptionGroupValidationError$Outbound` instead. */
+  export type Outbound = ProductOptionGroupValidationError$Outbound;
+}
+
+export function productOptionGroupValidationErrorToJSON(
+  productOptionGroupValidationError: ProductOptionGroupValidationError,
+): string {
+  return JSON.stringify(
+    ProductOptionGroupValidationError$outboundSchema.parse(
+      productOptionGroupValidationError,
+    ),
+  );
+}
+
+export function productOptionGroupValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductOptionGroupValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductOptionGroupValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductOptionGroupValidationError' from JSON`,
+  );
+}

package/src/models/components/productoptionvalidationerror.ts

@@ -0,0 +1,88 @@
+/*
+ * 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";
+import {
+  AssignProductImageValidationError,
+  AssignProductImageValidationError$inboundSchema,
+  AssignProductImageValidationError$Outbound,
+  AssignProductImageValidationError$outboundSchema,
+} from "./assignproductimagevalidationerror.js";
+
+export type ProductOptionValidationError = {
+  name?: string | undefined;
+  description?: string | undefined;
+  priceModifier?: string | undefined;
+  images?: { [k: string]: AssignProductImageValidationError } | undefined;
+};
+
+/** @internal */
+export const ProductOptionValidationError$inboundSchema: z.ZodType<
+  ProductOptionValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.record(AssignProductImageValidationError$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ProductOptionValidationError$Outbound = {
+  name?: string | undefined;
+  description?: string | undefined;
+  priceModifier?: string | undefined;
+  images?:
+    | { [k: string]: AssignProductImageValidationError$Outbound }
+    | undefined;
+};
+
+/** @internal */
+export const ProductOptionValidationError$outboundSchema: z.ZodType<
+  ProductOptionValidationError$Outbound,
+  z.ZodTypeDef,
+  ProductOptionValidationError
+> = z.object({
+  name: z.string().optional(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.record(AssignProductImageValidationError$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductOptionValidationError$ {
+  /** @deprecated use `ProductOptionValidationError$inboundSchema` instead. */
+  export const inboundSchema = ProductOptionValidationError$inboundSchema;
+  /** @deprecated use `ProductOptionValidationError$outboundSchema` instead. */
+  export const outboundSchema = ProductOptionValidationError$outboundSchema;
+  /** @deprecated use `ProductOptionValidationError$Outbound` instead. */
+  export type Outbound = ProductOptionValidationError$Outbound;
+}
+
+export function productOptionValidationErrorToJSON(
+  productOptionValidationError: ProductOptionValidationError,
+): string {
+  return JSON.stringify(
+    ProductOptionValidationError$outboundSchema.parse(
+      productOptionValidationError,
+    ),
+  );
+}
+
+export function productOptionValidationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductOptionValidationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductOptionValidationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductOptionValidationError' from JSON`,
+  );
+}

package/src/models/components/productrequest.ts

@@ -0,0 +1,117 @@
+/*
+ * 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";
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
+import {
+  AssignProductImage,
+  AssignProductImage$inboundSchema,
+  AssignProductImage$Outbound,
+  AssignProductImage$outboundSchema,
+} from "./assignproductimage.js";
+import {
+  CreateProductOptionGroup,
+  CreateProductOptionGroup$inboundSchema,
+  CreateProductOptionGroup$Outbound,
+  CreateProductOptionGroup$outboundSchema,
+} from "./createproductoptiongroup.js";
+
+/**
+ * Request to create or update a product.
+ */
+export type ProductRequest = {
+  title: string;
+  /**
+   * A detailed description of the product.
+   *
+   * @remarks
+   *
+   * - Must be valid UTF-8 text
+   * - Supports Markdown for formatting
+   * - HTML is not permitted and will be rejected
+   */
+  description?: string | undefined;
+  /**
+   * A product's starting price, before applying modifiers.
+   */
+  basePrice: AmountDecimal;
+  /**
+   * Assign previously uploaded images to a product or option.
+   */
+  images?: Array<AssignProductImage> | undefined;
+  /**
+   * Optional configuration options for a product, such as size or color.
+   */
+  optionGroups?: Array<CreateProductOptionGroup> | undefined;
+};
+
+/** @internal */
+export const ProductRequest$inboundSchema: z.ZodType<
+  ProductRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  description: z.string().optional(),
+  basePrice: AmountDecimal$inboundSchema,
+  images: z.array(AssignProductImage$inboundSchema).optional(),
+  optionGroups: z.array(CreateProductOptionGroup$inboundSchema).optional(),
+});
+
+/** @internal */
+export type ProductRequest$Outbound = {
+  title: string;
+  description?: string | undefined;
+  basePrice: AmountDecimal$Outbound;
+  images?: Array<AssignProductImage$Outbound> | undefined;
+  optionGroups?: Array<CreateProductOptionGroup$Outbound> | undefined;
+};
+
+/** @internal */
+export const ProductRequest$outboundSchema: z.ZodType<
+  ProductRequest$Outbound,
+  z.ZodTypeDef,
+  ProductRequest
+> = z.object({
+  title: z.string(),
+  description: z.string().optional(),
+  basePrice: AmountDecimal$outboundSchema,
+  images: z.array(AssignProductImage$outboundSchema).optional(),
+  optionGroups: z.array(CreateProductOptionGroup$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductRequest$ {
+  /** @deprecated use `ProductRequest$inboundSchema` instead. */
+  export const inboundSchema = ProductRequest$inboundSchema;
+  /** @deprecated use `ProductRequest$outboundSchema` instead. */
+  export const outboundSchema = ProductRequest$outboundSchema;
+  /** @deprecated use `ProductRequest$Outbound` instead. */
+  export type Outbound = ProductRequest$Outbound;
+}
+
+export function productRequestToJSON(productRequest: ProductRequest): string {
+  return JSON.stringify(ProductRequest$outboundSchema.parse(productRequest));
+}
+
+export function productRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductRequest' from JSON`,
+  );
+}

package/src/models/errors/index.ts

@@ -32,6 +32,7 @@ export * from "./patchaccounterror.js";
 export * from "./patchsweepconfigerror.js";
 export * from "./patchtransfervalidationerror.js";
 export * from "./patchwalletvalidationerror.js";
+export * from "./productrequestvalidationerror.js";
 export * from "./refundvalidationerror.js";
 export * from "./representativevalidationerror.js";
 export * from "./requestcarderror.js";

package/src/models/errors/productrequestvalidationerror.ts

@@ -0,0 +1,124 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import * as components from "../components/index.js";
+import { MoovError } from "./mooverror.js";
+
+export type ProductRequestValidationErrorData = {
+  title?: string | undefined;
+  description?: string | undefined;
+  basePrice?: components.AmountDecimalValidationError | undefined;
+  images?:
+    | { [k: string]: components.AssignProductImageValidationError }
+    | undefined;
+  optionGroups?:
+    | { [k: string]: components.ProductOptionGroupValidationError }
+    | undefined;
+};
+
+export class ProductRequestValidationError extends MoovError {
+  title?: string | undefined;
+  description?: string | undefined;
+  basePrice?: components.AmountDecimalValidationError | undefined;
+  images?:
+    | { [k: string]: components.AssignProductImageValidationError }
+    | undefined;
+  optionGroups?:
+    | { [k: string]: components.ProductOptionGroupValidationError }
+    | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: ProductRequestValidationErrorData;
+
+  constructor(
+    err: ProductRequestValidationErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    if (err.title != null) this.title = err.title;
+    if (err.description != null) this.description = err.description;
+    if (err.basePrice != null) this.basePrice = err.basePrice;
+    if (err.images != null) this.images = err.images;
+    if (err.optionGroups != null) this.optionGroups = err.optionGroups;
+
+    this.name = "ProductRequestValidationError";
+  }
+}
+
+/** @internal */
+export const ProductRequestValidationError$inboundSchema: z.ZodType<
+  ProductRequestValidationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string().optional(),
+  description: z.string().optional(),
+  basePrice: components.AmountDecimalValidationError$inboundSchema.optional(),
+  images: z.record(components.AssignProductImageValidationError$inboundSchema)
+    .optional(),
+  optionGroups: z.record(
+    components.ProductOptionGroupValidationError$inboundSchema,
+  ).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ProductRequestValidationError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type ProductRequestValidationError$Outbound = {
+  title?: string | undefined;
+  description?: string | undefined;
+  basePrice?: components.AmountDecimalValidationError$Outbound | undefined;
+  images?: {
+    [k: string]: components.AssignProductImageValidationError$Outbound;
+  } | undefined;
+  optionGroups?: {
+    [k: string]: components.ProductOptionGroupValidationError$Outbound;
+  } | undefined;
+};
+
+/** @internal */
+export const ProductRequestValidationError$outboundSchema: z.ZodType<
+  ProductRequestValidationError$Outbound,
+  z.ZodTypeDef,
+  ProductRequestValidationError
+> = z.instanceof(ProductRequestValidationError)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    title: z.string().optional(),
+    description: z.string().optional(),
+    basePrice: components.AmountDecimalValidationError$outboundSchema
+      .optional(),
+    images: z.record(
+      components.AssignProductImageValidationError$outboundSchema,
+    ).optional(),
+    optionGroups: z.record(
+      components.ProductOptionGroupValidationError$outboundSchema,
+    ).optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ProductRequestValidationError$ {
+  /** @deprecated use `ProductRequestValidationError$inboundSchema` instead. */
+  export const inboundSchema = ProductRequestValidationError$inboundSchema;
+  /** @deprecated use `ProductRequestValidationError$outboundSchema` instead. */
+  export const outboundSchema = ProductRequestValidationError$outboundSchema;
+  /** @deprecated use `ProductRequestValidationError$Outbound` instead. */
+  export type Outbound = ProductRequestValidationError$Outbound;
+}