@moovio/sdk 0.16.3 → 0.16.5

package/src/models/components/createproductoption.ts

@@ -0,0 +1,102 @@
+/*
+ * 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 {
+  AssignProductImage,
+  AssignProductImage$inboundSchema,
+  AssignProductImage$Outbound,
+  AssignProductImage$outboundSchema,
+} from "./assignproductimage.js";
+
+export type CreateProductOption = {
+  /**
+   * 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;
+  /**
+   * Assign previously uploaded images to a product or option.
+   */
+  images?: Array<AssignProductImage> | undefined;
+};
+
+/** @internal */
+export const CreateProductOption$inboundSchema: z.ZodType<
+  CreateProductOption,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.array(AssignProductImage$inboundSchema).optional(),
+});
+
+/** @internal */
+export type CreateProductOption$Outbound = {
+  name: string;
+  description?: string | undefined;
+  priceModifier?: string | undefined;
+  images?: Array<AssignProductImage$Outbound> | undefined;
+};
+
+/** @internal */
+export const CreateProductOption$outboundSchema: z.ZodType<
+  CreateProductOption$Outbound,
+  z.ZodTypeDef,
+  CreateProductOption
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  priceModifier: z.string().optional(),
+  images: z.array(AssignProductImage$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 CreateProductOption$ {
+  /** @deprecated use `CreateProductOption$inboundSchema` instead. */
+  export const inboundSchema = CreateProductOption$inboundSchema;
+  /** @deprecated use `CreateProductOption$outboundSchema` instead. */
+  export const outboundSchema = CreateProductOption$outboundSchema;
+  /** @deprecated use `CreateProductOption$Outbound` instead. */
+  export type Outbound = CreateProductOption$Outbound;
+}
+
+export function createProductOptionToJSON(
+  createProductOption: CreateProductOption,
+): string {
+  return JSON.stringify(
+    CreateProductOption$outboundSchema.parse(createProductOption),
+  );
+}
+
+export function createProductOptionFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateProductOption, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateProductOption$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateProductOption' from JSON`,
+  );
+}

package/src/models/components/createproductoptiongroup.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 {
+  CreateProductOption,
+  CreateProductOption$inboundSchema,
+  CreateProductOption$Outbound,
+  CreateProductOption$outboundSchema,
+} from "./createproductoption.js";
+
+export type CreateProductOptionGroup = {
+  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<CreateProductOption>;
+};
+
+/** @internal */
+export const CreateProductOptionGroup$inboundSchema: z.ZodType<
+  CreateProductOptionGroup,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  minSelect: z.number().int(),
+  maxSelect: z.number().int(),
+  options: z.array(CreateProductOption$inboundSchema),
+});
+
+/** @internal */
+export type CreateProductOptionGroup$Outbound = {
+  name: string;
+  description?: string | undefined;
+  minSelect: number;
+  maxSelect: number;
+  options: Array<CreateProductOption$Outbound>;
+};
+
+/** @internal */
+export const CreateProductOptionGroup$outboundSchema: z.ZodType<
+  CreateProductOptionGroup$Outbound,
+  z.ZodTypeDef,
+  CreateProductOptionGroup
+> = z.object({
+  name: z.string(),
+  description: z.string().optional(),
+  minSelect: z.number().int(),
+  maxSelect: z.number().int(),
+  options: z.array(CreateProductOption$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateProductOptionGroup$ {
+  /** @deprecated use `CreateProductOptionGroup$inboundSchema` instead. */
+  export const inboundSchema = CreateProductOptionGroup$inboundSchema;
+  /** @deprecated use `CreateProductOptionGroup$outboundSchema` instead. */
+  export const outboundSchema = CreateProductOptionGroup$outboundSchema;
+  /** @deprecated use `CreateProductOptionGroup$Outbound` instead. */
+  export type Outbound = CreateProductOptionGroup$Outbound;
+}
+
+export function createProductOptionGroupToJSON(
+  createProductOptionGroup: CreateProductOptionGroup,
+): string {
+  return JSON.stringify(
+    CreateProductOptionGroup$outboundSchema.parse(createProductOptionGroup),
+  );
+}
+
+export function createProductOptionGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateProductOptionGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateProductOptionGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateProductOptionGroup' from JSON`,
+  );
+}

package/src/models/components/feeproperties.ts

@@ -12,6 +12,12 @@ import {
   AmountDecimal$Outbound,
   AmountDecimal$outboundSchema,
 } from "./amountdecimal.js";
+import {
+  VolumeRange,
+  VolumeRange$inboundSchema,
+  VolumeRange$Outbound,
+  VolumeRange$outboundSchema,
+} from "./volumerange.js";
 
 /**
  * Defines the specific parameters used for fee calculation.
@@ -37,6 +43,10 @@ export type FeeProperties = {
    * Specifies the maximum allowable spending for a single transaction, working as a transaction ceiling.
    */
   maxPerTransaction?: AmountDecimal | undefined;
+  /**
+   * Defines the volume ranges for tiered pricing models.
+   */
+  volumeRanges: Array<VolumeRange>;
 };
 
 /** @internal */
@@ -49,6 +59,7 @@ export const FeeProperties$inboundSchema: z.ZodType<
   variableRate: z.string().optional(),
   minPerTransaction: AmountDecimal$inboundSchema.optional(),
   maxPerTransaction: AmountDecimal$inboundSchema.optional(),
+  volumeRanges: z.array(VolumeRange$inboundSchema),
 });
 
 /** @internal */
@@ -57,6 +68,7 @@ export type FeeProperties$Outbound = {
   variableRate?: string | undefined;
   minPerTransaction?: AmountDecimal$Outbound | undefined;
   maxPerTransaction?: AmountDecimal$Outbound | undefined;
+  volumeRanges: Array<VolumeRange$Outbound>;
 };
 
 /** @internal */
@@ -69,6 +81,7 @@ export const FeeProperties$outboundSchema: z.ZodType<
   variableRate: z.string().optional(),
   minPerTransaction: AmountDecimal$outboundSchema.optional(),
   maxPerTransaction: AmountDecimal$outboundSchema.optional(),
+  volumeRanges: z.array(VolumeRange$outboundSchema),
 });
 
 /**

package/src/models/components/index.ts

@@ -32,6 +32,7 @@ export * from "./addressupdate.js";
 export * from "./adjustment.js";
 export * from "./amount.js";
 export * from "./amountdecimal.js";
+export * from "./amountdecimalvalidationerror.js";
 export * from "./amountupdate.js";
 export * from "./amountvalidationerror.js";
 export * from "./applebillingcontact.js";
@@ -40,6 +41,8 @@ export * from "./applepaymerchantdomains.js";
 export * from "./applepaypaymentmethod.js";
 export * from "./applepayresponse.js";
 export * from "./applicationscope.js";
+export * from "./assignproductimage.js";
+export * from "./assignproductimagevalidationerror.js";
 export * from "./asynccreatedrefund.js";
 export * from "./asynctransfer.js";
 export * from "./authorizeduser.js";
@@ -139,6 +142,8 @@ export * from "./createfeeplanagreement.js";
 export * from "./createindividualerror.js";
 export * from "./createindividualprofile.js";
 export * from "./createpaymentlink.js";
+export * from "./createproductoption.js";
+export * from "./createproductoptiongroup.js";
 export * from "./createprofile.js";
 export * from "./createprofileerror.js";
 export * from "./createrefund.js";
@@ -317,6 +322,13 @@ export * from "./plaidlinkpayload.js";
 export * from "./plaidpayload.js";
 export * from "./platformfees.js";
 export * from "./primaryregulator.js";
+export * from "./product.js";
+export * from "./productimagemetadata.js";
+export * from "./productoption.js";
+export * from "./productoptiongroup.js";
+export * from "./productoptiongroupvalidationerror.js";
+export * from "./productoptionvalidationerror.js";
+export * from "./productrequest.js";
 export * from "./profile.js";
 export * from "./pullfromcardpaymentmethod.js";
 export * from "./pushtocardpaymentmethod.js";
@@ -426,6 +438,7 @@ export * from "./verificationstatus.js";
 export * from "./verificationstatusdetail.js";
 export * from "./volumebycustomertype.js";
 export * from "./volumebycustomertypeerror.js";
+export * from "./volumerange.js";
 export * from "./volumesharebycustomertype.js";
 export * from "./volumesharebycustomertypeerror.js";
 export * from "./wallet.js";

package/src/models/components/partnerpricing.ts

@@ -33,7 +33,7 @@ import {
 export type PartnerPricing = {
   planID: string;
   /**
-   * The name of the fee plan.
+   * The name of the partner pricing plan.
    */
   name: string;
   /**
@@ -41,9 +41,13 @@ export type PartnerPricing = {
    */
   description?: string | undefined;
   /**
-   * The integer percentage value of the revenue split for partner.
+   *   The decimal-formatted numerical string of the revenue split for partner.
+   *
+   * @remarks
+   *
+   *   For example, 2.25% is '2.25'.
    */
-  revenueShare: number;
+  revenueShare: string;
   /**
    * Specifies the card processing pricing model
    */
@@ -69,7 +73,7 @@ export const PartnerPricing$inboundSchema: z.ZodType<
   planID: z.string(),
   name: z.string(),
   description: z.string().optional(),
-  revenueShare: z.number().int(),
+  revenueShare: z.string(),
   cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
@@ -82,7 +86,7 @@ export type PartnerPricing$Outbound = {
   planID: string;
   name: string;
   description?: string | undefined;
-  revenueShare: number;
+  revenueShare: string;
   cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
@@ -99,7 +103,7 @@ export const PartnerPricing$outboundSchema: z.ZodType<
   planID: z.string(),
   name: z.string(),
   description: z.string().optional(),
-  revenueShare: z.number().int(),
+  revenueShare: z.string(),
   cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,

package/src/models/components/partnerpricingagreement.ts

@@ -63,9 +63,13 @@ export type PartnerPricingAgreement = {
    */
   monthlyPlatformFee: MonthlyPlatformFee;
   /**
-   * The integer percentage value of the revenue split for partner.
+   *   The decimal-formatted numerical string of the revenue split for partner.
+   *
+   * @remarks
+   *
+   *   For example, 2.25% is '2.25'.
    */
-  revenueShare: number;
+  revenueShare: string;
 };
 
 /** @internal */
@@ -85,7 +89,7 @@ export const PartnerPricingAgreement$inboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$inboundSchema),
   minimumCommitment: MinimumCommitment$inboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$inboundSchema,
-  revenueShare: z.number().int(),
+  revenueShare: z.string(),
 });
 
 /** @internal */
@@ -101,7 +105,7 @@ export type PartnerPricingAgreement$Outbound = {
   billableFees: Array<BillableFee$Outbound>;
   minimumCommitment: MinimumCommitment$Outbound;
   monthlyPlatformFee: MonthlyPlatformFee$Outbound;
-  revenueShare: number;
+  revenueShare: string;
 };
 
 /** @internal */
@@ -121,7 +125,7 @@ export const PartnerPricingAgreement$outboundSchema: z.ZodType<
   billableFees: z.array(BillableFee$outboundSchema),
   minimumCommitment: MinimumCommitment$outboundSchema,
   monthlyPlatformFee: MonthlyPlatformFee$outboundSchema,
-  revenueShare: z.number().int(),
+  revenueShare: z.string(),
 });
 
 /**

package/src/models/components/product.ts

@@ -0,0 +1,148 @@
+/*
+ * 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 {
+  ProductImageMetadata,
+  ProductImageMetadata$inboundSchema,
+  ProductImageMetadata$Outbound,
+  ProductImageMetadata$outboundSchema,
+} from "./productimagemetadata.js";
+import {
+  ProductOptionGroup,
+  ProductOptionGroup$inboundSchema,
+  ProductOptionGroup$Outbound,
+  ProductOptionGroup$outboundSchema,
+} from "./productoptiongroup.js";
+
+/**
+ * A product available for purchase, which may have optional configuration options.
+ */
+export type Product = {
+  /**
+   * Unique identifier for a product.
+   */
+  productID: string;
+  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;
+  /**
+   * Optional configuration options for a product, such as size or color.
+   */
+  optionGroups?: Array<ProductOptionGroup> | undefined;
+  /**
+   * Optional images associated with the product.
+   */
+  images?: Array<ProductImageMetadata> | undefined;
+  /**
+   * The date and time when the product was added.
+   */
+  createdOn: Date;
+  /**
+   * The date and time when the product was last updated.
+   */
+  updatedOn: Date;
+  /**
+   * The date and time when the product was disabled.
+   */
+  disabledOn?: Date | undefined;
+};
+
+/** @internal */
+export const Product$inboundSchema: z.ZodType<Product, z.ZodTypeDef, unknown> =
+  z.object({
+    productID: z.string(),
+    title: z.string(),
+    description: z.string().optional(),
+    basePrice: AmountDecimal$inboundSchema,
+    optionGroups: z.array(ProductOptionGroup$inboundSchema).optional(),
+    images: z.array(ProductImageMetadata$inboundSchema).optional(),
+    createdOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    updatedOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    disabledOn: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ).optional(),
+  });
+
+/** @internal */
+export type Product$Outbound = {
+  productID: string;
+  title: string;
+  description?: string | undefined;
+  basePrice: AmountDecimal$Outbound;
+  optionGroups?: Array<ProductOptionGroup$Outbound> | undefined;
+  images?: Array<ProductImageMetadata$Outbound> | undefined;
+  createdOn: string;
+  updatedOn: string;
+  disabledOn?: string | undefined;
+};
+
+/** @internal */
+export const Product$outboundSchema: z.ZodType<
+  Product$Outbound,
+  z.ZodTypeDef,
+  Product
+> = z.object({
+  productID: z.string(),
+  title: z.string(),
+  description: z.string().optional(),
+  basePrice: AmountDecimal$outboundSchema,
+  optionGroups: z.array(ProductOptionGroup$outboundSchema).optional(),
+  images: z.array(ProductImageMetadata$outboundSchema).optional(),
+  createdOn: z.date().transform(v => v.toISOString()),
+  updatedOn: z.date().transform(v => v.toISOString()),
+  disabledOn: 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 Product$ {
+  /** @deprecated use `Product$inboundSchema` instead. */
+  export const inboundSchema = Product$inboundSchema;
+  /** @deprecated use `Product$outboundSchema` instead. */
+  export const outboundSchema = Product$outboundSchema;
+  /** @deprecated use `Product$Outbound` instead. */
+  export type Outbound = Product$Outbound;
+}
+
+export function productToJSON(product: Product): string {
+  return JSON.stringify(Product$outboundSchema.parse(product));
+}
+
+export function productFromJSON(
+  jsonString: string,
+): SafeParseResult<Product, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Product$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Product' from JSON`,
+  );
+}

package/src/models/components/productimagemetadata.ts

@@ -0,0 +1,83 @@
+/*
+ * 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";
+
+export type ProductImageMetadata = {
+  /**
+   * Unique identifier for a product or product option image resource.
+   */
+  imageID: string;
+  /**
+   * Alternative text for the image.
+   */
+  altText?: string | undefined;
+  /**
+   * The image's public URL.
+   */
+  link: string;
+};
+
+/** @internal */
+export const ProductImageMetadata$inboundSchema: z.ZodType<
+  ProductImageMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  imageID: z.string(),
+  altText: z.string().optional(),
+  link: z.string(),
+});
+
+/** @internal */
+export type ProductImageMetadata$Outbound = {
+  imageID: string;
+  altText?: string | undefined;
+  link: string;
+};
+
+/** @internal */
+export const ProductImageMetadata$outboundSchema: z.ZodType<
+  ProductImageMetadata$Outbound,
+  z.ZodTypeDef,
+  ProductImageMetadata
+> = z.object({
+  imageID: z.string(),
+  altText: z.string().optional(),
+  link: 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 ProductImageMetadata$ {
+  /** @deprecated use `ProductImageMetadata$inboundSchema` instead. */
+  export const inboundSchema = ProductImageMetadata$inboundSchema;
+  /** @deprecated use `ProductImageMetadata$outboundSchema` instead. */
+  export const outboundSchema = ProductImageMetadata$outboundSchema;
+  /** @deprecated use `ProductImageMetadata$Outbound` instead. */
+  export type Outbound = ProductImageMetadata$Outbound;
+}
+
+export function productImageMetadataToJSON(
+  productImageMetadata: ProductImageMetadata,
+): string {
+  return JSON.stringify(
+    ProductImageMetadata$outboundSchema.parse(productImageMetadata),
+  );
+}
+
+export function productImageMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductImageMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductImageMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductImageMetadata' from JSON`,
+  );
+}