@moovio/sdk 0.16.2 → 0.16.4

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

@@ -426,6 +426,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/volumerange.ts

@@ -0,0 +1,95 @@
+/*
+ * 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";
+
+/**
+ * Defines the volume ranges for tiered pricing models.
+ */
+export type VolumeRange = {
+  /**
+   * Specifies the lower value of a tier for the fee.
+   */
+  fromValue: number;
+  /**
+   * Specifies the upper value of a tier for the fee.
+   */
+  toValue?: number | undefined;
+  /**
+   * The flat amount for a whole tier of the fee.
+   */
+  flatAmount: AmountDecimal;
+  /**
+   * The unit price for a specific tier of the fee.
+   */
+  perUnitAmount: AmountDecimal;
+};
+
+/** @internal */
+export const VolumeRange$inboundSchema: z.ZodType<
+  VolumeRange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fromValue: z.number().int(),
+  toValue: z.number().int().optional(),
+  flatAmount: AmountDecimal$inboundSchema,
+  perUnitAmount: AmountDecimal$inboundSchema,
+});
+
+/** @internal */
+export type VolumeRange$Outbound = {
+  fromValue: number;
+  toValue?: number | undefined;
+  flatAmount: AmountDecimal$Outbound;
+  perUnitAmount: AmountDecimal$Outbound;
+};
+
+/** @internal */
+export const VolumeRange$outboundSchema: z.ZodType<
+  VolumeRange$Outbound,
+  z.ZodTypeDef,
+  VolumeRange
+> = z.object({
+  fromValue: z.number().int(),
+  toValue: z.number().int().optional(),
+  flatAmount: AmountDecimal$outboundSchema,
+  perUnitAmount: AmountDecimal$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace VolumeRange$ {
+  /** @deprecated use `VolumeRange$inboundSchema` instead. */
+  export const inboundSchema = VolumeRange$inboundSchema;
+  /** @deprecated use `VolumeRange$outboundSchema` instead. */
+  export const outboundSchema = VolumeRange$outboundSchema;
+  /** @deprecated use `VolumeRange$Outbound` instead. */
+  export type Outbound = VolumeRange$Outbound;
+}
+
+export function volumeRangeToJSON(volumeRange: VolumeRange): string {
+  return JSON.stringify(VolumeRange$outboundSchema.parse(volumeRange));
+}
+
+export function volumeRangeFromJSON(
+  jsonString: string,
+): SafeParseResult<VolumeRange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VolumeRange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VolumeRange' from JSON`,
+  );
+}