@moovio/sdk 0.4.0 → 0.5.1

package/src/models/components/feeproperties.ts

@@ -6,60 +6,12 @@ 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";
-
-/**
- * A fixed fee that is applied to the amount of each transaction in the `fixed` and `blended` fee models.
- */
-export type FixedAmount = {
-  /**
-   * A 3-letter ISO 4217 currency code.
-   */
-  currency: string;
-  /**
-   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
-   *
-   * @remarks
-   *
-   * For example, $12.987654321 is '12.987654321'.
-   */
-  valueDecimal: string;
-};
-
-/**
- * Specifies the minimum allowable spending for a single transaction, working as a transaction floor.
- */
-export type MinPerTransaction = {
-  /**
-   * A 3-letter ISO 4217 currency code.
-   */
-  currency: string;
-  /**
-   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
-   *
-   * @remarks
-   *
-   * For example, $12.987654321 is '12.987654321'.
-   */
-  valueDecimal: string;
-};
-
-/**
- * Specifies the maximum allowable spending for a single transaction, working as a transaction ceiling.
- */
-export type MaxPerTransaction = {
-  /**
-   * A 3-letter ISO 4217 currency code.
-   */
-  currency: string;
-  /**
-   * A decimal-formatted numerical string that represents up to 9 decimal place precision.
-   *
-   * @remarks
-   *
-   * For example, $12.987654321 is '12.987654321'.
-   */
-  valueDecimal: string;
-};
+import {
+  AmountDecimal,
+  AmountDecimal$inboundSchema,
+  AmountDecimal$Outbound,
+  AmountDecimal$outboundSchema,
+} from "./amountdecimal.js";
 
 /**
  * Defines the specific parameters used for fee calculation.
@@ -68,7 +20,7 @@ export type FeeProperties = {
   /**
    * A fixed fee that is applied to the amount of each transaction in the `fixed` and `blended` fee models.
    */
-  fixedAmount?: FixedAmount | null | undefined;
+  fixedAmount?: AmountDecimal | undefined;
   /**
    * A percentage fee that is applied to the amount of each transaction in the `blended` fee model, expressed as a decimal.
    *
@@ -80,200 +32,31 @@ export type FeeProperties = {
   /**
    * Specifies the minimum allowable spending for a single transaction, working as a transaction floor.
    */
-  minPerTransaction?: MinPerTransaction | null | undefined;
+  minPerTransaction?: AmountDecimal | undefined;
   /**
    * Specifies the maximum allowable spending for a single transaction, working as a transaction ceiling.
    */
-  maxPerTransaction?: MaxPerTransaction | null | undefined;
+  maxPerTransaction?: AmountDecimal | undefined;
 };
 
-/** @internal */
-export const FixedAmount$inboundSchema: z.ZodType<
-  FixedAmount,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  currency: z.string(),
-  valueDecimal: z.string(),
-});
-
-/** @internal */
-export type FixedAmount$Outbound = {
-  currency: string;
-  valueDecimal: string;
-};
-
-/** @internal */
-export const FixedAmount$outboundSchema: z.ZodType<
-  FixedAmount$Outbound,
-  z.ZodTypeDef,
-  FixedAmount
-> = z.object({
-  currency: z.string(),
-  valueDecimal: 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 FixedAmount$ {
-  /** @deprecated use `FixedAmount$inboundSchema` instead. */
-  export const inboundSchema = FixedAmount$inboundSchema;
-  /** @deprecated use `FixedAmount$outboundSchema` instead. */
-  export const outboundSchema = FixedAmount$outboundSchema;
-  /** @deprecated use `FixedAmount$Outbound` instead. */
-  export type Outbound = FixedAmount$Outbound;
-}
-
-export function fixedAmountToJSON(fixedAmount: FixedAmount): string {
-  return JSON.stringify(FixedAmount$outboundSchema.parse(fixedAmount));
-}
-
-export function fixedAmountFromJSON(
-  jsonString: string,
-): SafeParseResult<FixedAmount, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FixedAmount$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FixedAmount' from JSON`,
-  );
-}
-
-/** @internal */
-export const MinPerTransaction$inboundSchema: z.ZodType<
-  MinPerTransaction,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  currency: z.string(),
-  valueDecimal: z.string(),
-});
-
-/** @internal */
-export type MinPerTransaction$Outbound = {
-  currency: string;
-  valueDecimal: string;
-};
-
-/** @internal */
-export const MinPerTransaction$outboundSchema: z.ZodType<
-  MinPerTransaction$Outbound,
-  z.ZodTypeDef,
-  MinPerTransaction
-> = z.object({
-  currency: z.string(),
-  valueDecimal: 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 MinPerTransaction$ {
-  /** @deprecated use `MinPerTransaction$inboundSchema` instead. */
-  export const inboundSchema = MinPerTransaction$inboundSchema;
-  /** @deprecated use `MinPerTransaction$outboundSchema` instead. */
-  export const outboundSchema = MinPerTransaction$outboundSchema;
-  /** @deprecated use `MinPerTransaction$Outbound` instead. */
-  export type Outbound = MinPerTransaction$Outbound;
-}
-
-export function minPerTransactionToJSON(
-  minPerTransaction: MinPerTransaction,
-): string {
-  return JSON.stringify(
-    MinPerTransaction$outboundSchema.parse(minPerTransaction),
-  );
-}
-
-export function minPerTransactionFromJSON(
-  jsonString: string,
-): SafeParseResult<MinPerTransaction, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MinPerTransaction$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MinPerTransaction' from JSON`,
-  );
-}
-
-/** @internal */
-export const MaxPerTransaction$inboundSchema: z.ZodType<
-  MaxPerTransaction,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  currency: z.string(),
-  valueDecimal: z.string(),
-});
-
-/** @internal */
-export type MaxPerTransaction$Outbound = {
-  currency: string;
-  valueDecimal: string;
-};
-
-/** @internal */
-export const MaxPerTransaction$outboundSchema: z.ZodType<
-  MaxPerTransaction$Outbound,
-  z.ZodTypeDef,
-  MaxPerTransaction
-> = z.object({
-  currency: z.string(),
-  valueDecimal: 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 MaxPerTransaction$ {
-  /** @deprecated use `MaxPerTransaction$inboundSchema` instead. */
-  export const inboundSchema = MaxPerTransaction$inboundSchema;
-  /** @deprecated use `MaxPerTransaction$outboundSchema` instead. */
-  export const outboundSchema = MaxPerTransaction$outboundSchema;
-  /** @deprecated use `MaxPerTransaction$Outbound` instead. */
-  export type Outbound = MaxPerTransaction$Outbound;
-}
-
-export function maxPerTransactionToJSON(
-  maxPerTransaction: MaxPerTransaction,
-): string {
-  return JSON.stringify(
-    MaxPerTransaction$outboundSchema.parse(maxPerTransaction),
-  );
-}
-
-export function maxPerTransactionFromJSON(
-  jsonString: string,
-): SafeParseResult<MaxPerTransaction, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MaxPerTransaction$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MaxPerTransaction' from JSON`,
-  );
-}
-
 /** @internal */
 export const FeeProperties$inboundSchema: z.ZodType<
   FeeProperties,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  fixedAmount: z.nullable(z.lazy(() => FixedAmount$inboundSchema)).optional(),
+  fixedAmount: AmountDecimal$inboundSchema.optional(),
   variableRate: z.string().optional(),
-  minPerTransaction: z.nullable(z.lazy(() => MinPerTransaction$inboundSchema))
-    .optional(),
-  maxPerTransaction: z.nullable(z.lazy(() => MaxPerTransaction$inboundSchema))
-    .optional(),
+  minPerTransaction: AmountDecimal$inboundSchema.optional(),
+  maxPerTransaction: AmountDecimal$inboundSchema.optional(),
 });
 
 /** @internal */
 export type FeeProperties$Outbound = {
-  fixedAmount?: FixedAmount$Outbound | null | undefined;
+  fixedAmount?: AmountDecimal$Outbound | undefined;
   variableRate?: string | undefined;
-  minPerTransaction?: MinPerTransaction$Outbound | null | undefined;
-  maxPerTransaction?: MaxPerTransaction$Outbound | null | undefined;
+  minPerTransaction?: AmountDecimal$Outbound | undefined;
+  maxPerTransaction?: AmountDecimal$Outbound | undefined;
 };
 
 /** @internal */
@@ -282,12 +65,10 @@ export const FeeProperties$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FeeProperties
 > = z.object({
-  fixedAmount: z.nullable(z.lazy(() => FixedAmount$outboundSchema)).optional(),
+  fixedAmount: AmountDecimal$outboundSchema.optional(),
   variableRate: z.string().optional(),
-  minPerTransaction: z.nullable(z.lazy(() => MinPerTransaction$outboundSchema))
-    .optional(),
-  maxPerTransaction: z.nullable(z.lazy(() => MaxPerTransaction$outboundSchema))
-    .optional(),
+  minPerTransaction: AmountDecimal$outboundSchema.optional(),
+  maxPerTransaction: AmountDecimal$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/index.ts

@@ -78,8 +78,8 @@ export * from "./capabilitystatus.js";
 export * from "./card.js";
 export * from "./cardaccountupdater.js";
 export * from "./cardacquiringdispute.js";
+export * from "./cardacquiringmodel.js";
 export * from "./cardacquiringrefund.js";
-export * from "./cardacquringmodel.js";
 export * from "./cardaddress.js";
 export * from "./cardbrand.js";
 export * from "./cardexpiration.js";
@@ -126,6 +126,7 @@ export * from "./createrefundresponse.js";
 export * from "./createrepresentative.js";
 export * from "./createreversal.js";
 export * from "./createsweepconfig.js";
+export * from "./createterminalapplication.js";
 export * from "./createtransfer.js";
 export * from "./createtransferdestination.js";
 export * from "./createtransferdestinationach.js";
@@ -304,6 +305,9 @@ export * from "./sweepconfigstatus.js";
 export * from "./sweepstatus.js";
 export * from "./taxid.js";
 export * from "./taxidupdate.js";
+export * from "./terminalapplication.js";
+export * from "./terminalapplicationplatform.js";
+export * from "./terminalapplicationstatus.js";
 export * from "./termsofservice.js";
 export * from "./termsofserviceerror.js";
 export * from "./termsofservicetoken.js";

package/src/models/components/partnerpricing.ts

@@ -13,10 +13,10 @@ import {
   BillableFee$outboundSchema,
 } from "./billablefee.js";
 import {
-  CardAcquringModel,
-  CardAcquringModel$inboundSchema,
-  CardAcquringModel$outboundSchema,
-} from "./cardacquringmodel.js";
+  CardAcquiringModel,
+  CardAcquiringModel$inboundSchema,
+  CardAcquiringModel$outboundSchema,
+} from "./cardacquiringmodel.js";
 
 export type PartnerPricing = {
   planID: string;
@@ -35,7 +35,7 @@ export type PartnerPricing = {
   /**
    * Specifies the card processing pricing model
    */
-  cardAcquringModel: CardAcquringModel;
+  cardAcquiringModel: CardAcquiringModel;
   billableFees: Array<BillableFee>;
   createdAt: Date;
 };
@@ -50,7 +50,7 @@ export const PartnerPricing$inboundSchema: z.ZodType<
   name: z.string(),
   description: z.string().optional(),
   revenueShare: z.number().int(),
-  cardAcquringModel: CardAcquringModel$inboundSchema,
+  cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
 });
@@ -61,7 +61,7 @@ export type PartnerPricing$Outbound = {
   name: string;
   description?: string | undefined;
   revenueShare: number;
-  cardAcquringModel: string;
+  cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   createdAt: string;
 };
@@ -76,7 +76,7 @@ export const PartnerPricing$outboundSchema: z.ZodType<
   name: z.string(),
   description: z.string().optional(),
   revenueShare: z.number().int(),
-  cardAcquringModel: CardAcquringModel$outboundSchema,
+  cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   createdAt: z.date().transform(v => v.toISOString()),
 });

package/src/models/components/partnerpricingagreement.ts

@@ -13,10 +13,10 @@ import {
   BillableFee$outboundSchema,
 } from "./billablefee.js";
 import {
-  CardAcquringModel,
-  CardAcquringModel$inboundSchema,
-  CardAcquringModel$outboundSchema,
-} from "./cardacquringmodel.js";
+  CardAcquiringModel,
+  CardAcquiringModel$inboundSchema,
+  CardAcquiringModel$outboundSchema,
+} from "./cardacquiringmodel.js";
 import {
   FeePlanAgreementStatus,
   FeePlanAgreementStatus$inboundSchema,
@@ -24,15 +24,23 @@ import {
 } from "./feeplanagreementstatus.js";
 
 export type PartnerPricingAgreement = {
-  aggreementID: string;
+  agreementID: string;
   planID: string;
   accountID?: string | undefined;
+  /**
+   * The name of the agreement.
+   */
+  name: string;
+  /**
+   * The description of the agreement.
+   */
+  description?: string | undefined;
   acceptedOn: Date;
   status: FeePlanAgreementStatus;
   /**
    * Specifies the card processing pricing model
    */
-  cardAcquringModel: CardAcquringModel;
+  cardAcquiringModel: CardAcquiringModel;
   billableFees: Array<BillableFee>;
   /**
    * The integer percentage value of the revenue split for partner.
@@ -46,24 +54,28 @@ export const PartnerPricingAgreement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  aggreementID: z.string(),
+  agreementID: z.string(),
   planID: z.string(),
   accountID: z.string().optional(),
+  name: z.string(),
+  description: z.string().optional(),
   acceptedOn: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   status: FeePlanAgreementStatus$inboundSchema,
-  cardAcquringModel: CardAcquringModel$inboundSchema,
+  cardAcquiringModel: CardAcquiringModel$inboundSchema,
   billableFees: z.array(BillableFee$inboundSchema),
   revenueShare: z.number().int(),
 });
 
 /** @internal */
 export type PartnerPricingAgreement$Outbound = {
-  aggreementID: string;
+  agreementID: string;
   planID: string;
   accountID?: string | undefined;
+  name: string;
+  description?: string | undefined;
   acceptedOn: string;
   status: string;
-  cardAcquringModel: string;
+  cardAcquiringModel: string;
   billableFees: Array<BillableFee$Outbound>;
   revenueShare: number;
 };
@@ -74,12 +86,14 @@ export const PartnerPricingAgreement$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PartnerPricingAgreement
 > = z.object({
-  aggreementID: z.string(),
+  agreementID: z.string(),
   planID: z.string(),
   accountID: z.string().optional(),
+  name: z.string(),
+  description: z.string().optional(),
   acceptedOn: z.date().transform(v => v.toISOString()),
   status: FeePlanAgreementStatus$outboundSchema,
-  cardAcquringModel: CardAcquringModel$outboundSchema,
+  cardAcquiringModel: CardAcquiringModel$outboundSchema,
   billableFees: z.array(BillableFee$outboundSchema),
   revenueShare: z.number().int(),
 });

package/src/models/components/terminalapplication.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 {
+  TerminalApplicationPlatform,
+  TerminalApplicationPlatform$inboundSchema,
+  TerminalApplicationPlatform$outboundSchema,
+} from "./terminalapplicationplatform.js";
+import {
+  TerminalApplicationStatus,
+  TerminalApplicationStatus$inboundSchema,
+  TerminalApplicationStatus$outboundSchema,
+} from "./terminalapplicationstatus.js";
+
+/**
+ * Describes a terminal application.
+ */
+export type TerminalApplication = {
+  /**
+   * ID of the terminal application.
+   */
+  terminalApplicationID: string;
+  /**
+   * Status of the terminal application.
+   */
+  status: TerminalApplicationStatus;
+  /**
+   * Platform of the terminal application.
+   */
+  platform: TerminalApplicationPlatform;
+  /**
+   * The app bundle identifier of the terminal application. Will be returned if platform is ios.
+   */
+  appBundleID?: string | undefined;
+  /**
+   * The app package name of the terminal application. Will be returned if platform is android.
+   */
+  packageName?: string | undefined;
+  /**
+   * The app version of the terminal application Will be returned if platform is android.
+   */
+  sha256Digest?: string | undefined;
+  /**
+   * The app version of the terminal application Will be returned if platform is android.
+   */
+  versionCode?: string | undefined;
+};
+
+/** @internal */
+export const TerminalApplication$inboundSchema: z.ZodType<
+  TerminalApplication,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  terminalApplicationID: z.string(),
+  status: TerminalApplicationStatus$inboundSchema,
+  platform: TerminalApplicationPlatform$inboundSchema,
+  appBundleID: z.string().optional(),
+  packageName: z.string().optional(),
+  sha256Digest: z.string().optional(),
+  versionCode: z.string().optional(),
+});
+
+/** @internal */
+export type TerminalApplication$Outbound = {
+  terminalApplicationID: string;
+  status: string;
+  platform: string;
+  appBundleID?: string | undefined;
+  packageName?: string | undefined;
+  sha256Digest?: string | undefined;
+  versionCode?: string | undefined;
+};
+
+/** @internal */
+export const TerminalApplication$outboundSchema: z.ZodType<
+  TerminalApplication$Outbound,
+  z.ZodTypeDef,
+  TerminalApplication
+> = z.object({
+  terminalApplicationID: z.string(),
+  status: TerminalApplicationStatus$outboundSchema,
+  platform: TerminalApplicationPlatform$outboundSchema,
+  appBundleID: z.string().optional(),
+  packageName: z.string().optional(),
+  sha256Digest: z.string().optional(),
+  versionCode: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TerminalApplication$ {
+  /** @deprecated use `TerminalApplication$inboundSchema` instead. */
+  export const inboundSchema = TerminalApplication$inboundSchema;
+  /** @deprecated use `TerminalApplication$outboundSchema` instead. */
+  export const outboundSchema = TerminalApplication$outboundSchema;
+  /** @deprecated use `TerminalApplication$Outbound` instead. */
+  export type Outbound = TerminalApplication$Outbound;
+}
+
+export function terminalApplicationToJSON(
+  terminalApplication: TerminalApplication,
+): string {
+  return JSON.stringify(
+    TerminalApplication$outboundSchema.parse(terminalApplication),
+  );
+}
+
+export function terminalApplicationFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminalApplication, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminalApplication$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminalApplication' from JSON`,
+  );
+}

package/src/models/components/terminalapplicationplatform.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Platform of the terminal application.
+ */
+export const TerminalApplicationPlatform = {
+  Undefined: "undefined",
+  Ios: "ios",
+  Android: "android",
+} as const;
+/**
+ * Platform of the terminal application.
+ */
+export type TerminalApplicationPlatform = ClosedEnum<
+  typeof TerminalApplicationPlatform
+>;
+
+/** @internal */
+export const TerminalApplicationPlatform$inboundSchema: z.ZodNativeEnum<
+  typeof TerminalApplicationPlatform
+> = z.nativeEnum(TerminalApplicationPlatform);
+
+/** @internal */
+export const TerminalApplicationPlatform$outboundSchema: z.ZodNativeEnum<
+  typeof TerminalApplicationPlatform
+> = TerminalApplicationPlatform$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TerminalApplicationPlatform$ {
+  /** @deprecated use `TerminalApplicationPlatform$inboundSchema` instead. */
+  export const inboundSchema = TerminalApplicationPlatform$inboundSchema;
+  /** @deprecated use `TerminalApplicationPlatform$outboundSchema` instead. */
+  export const outboundSchema = TerminalApplicationPlatform$outboundSchema;
+}

package/src/models/components/terminalapplicationstatus.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Status of the terminal application.
+ */
+export const TerminalApplicationStatus = {
+  Undefined: "undefined",
+  Pending: "pending",
+  Enabled: "enabled",
+  Disabled: "disabled",
+} as const;
+/**
+ * Status of the terminal application.
+ */
+export type TerminalApplicationStatus = ClosedEnum<
+  typeof TerminalApplicationStatus
+>;
+
+/** @internal */
+export const TerminalApplicationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof TerminalApplicationStatus
+> = z.nativeEnum(TerminalApplicationStatus);
+
+/** @internal */
+export const TerminalApplicationStatus$outboundSchema: z.ZodNativeEnum<
+  typeof TerminalApplicationStatus
+> = TerminalApplicationStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TerminalApplicationStatus$ {
+  /** @deprecated use `TerminalApplicationStatus$inboundSchema` instead. */
+  export const inboundSchema = TerminalApplicationStatus$inboundSchema;
+  /** @deprecated use `TerminalApplicationStatus$outboundSchema` instead. */
+  export const outboundSchema = TerminalApplicationStatus$outboundSchema;
+}