mollie-api-typescript 0.8.7 → 0.9.0

package/src/models/listentitybalance.ts

@@ -0,0 +1,598 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  BalanceTransferDestinationType,
+  BalanceTransferDestinationType$inboundSchema,
+  BalanceTransferDestinationType$outboundSchema,
+} from "./balancetransferdestinationtype.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+
+/**
+ * The balance's ISO 4217 currency code.
+ */
+export const ListEntityBalanceCurrency = {
+  Eur: "EUR",
+  Gbp: "GBP",
+  Chf: "CHF",
+  Dkk: "DKK",
+  Nok: "NOK",
+  Pln: "PLN",
+  Sek: "SEK",
+  Usd: "USD",
+  Czk: "CZK",
+  Huf: "HUF",
+  Aud: "AUD",
+  Cad: "CAD",
+} as const;
+/**
+ * The balance's ISO 4217 currency code.
+ */
+export type ListEntityBalanceCurrency = OpenEnum<
+  typeof ListEntityBalanceCurrency
+>;
+
+/**
+ * The status of the balance.
+ */
+export const ListEntityBalanceStatus = {
+  Active: "active",
+  Inactive: "inactive",
+} as const;
+/**
+ * The status of the balance.
+ */
+export type ListEntityBalanceStatus = OpenEnum<typeof ListEntityBalanceStatus>;
+
+/**
+ * The frequency with which the available amount on the balance will be settled to the configured transfer
+ *
+ * @remarks
+ * destination.
+ *
+ * Settlements created during weekends or on bank holidays will take place on the next business day.
+ */
+export const ListEntityBalanceTransferFrequency = {
+  EveryDay: "every-day",
+  Daily: "daily",
+  EveryMonday: "every-monday",
+  EveryTuesday: "every-tuesday",
+  EveryWednesday: "every-wednesday",
+  EveryThursday: "every-thursday",
+  EveryFriday: "every-friday",
+  Monthly: "monthly",
+  RevenueDay: "revenue-day",
+  Never: "never",
+} as const;
+/**
+ * The frequency with which the available amount on the balance will be settled to the configured transfer
+ *
+ * @remarks
+ * destination.
+ *
+ * Settlements created during weekends or on bank holidays will take place on the next business day.
+ */
+export type ListEntityBalanceTransferFrequency = OpenEnum<
+  typeof ListEntityBalanceTransferFrequency
+>;
+
+/**
+ * The minimum amount configured for scheduled automatic settlements. As soon as the amount on the balance exceeds
+ *
+ * @remarks
+ * this threshold, the complete balance will be paid out to the transfer destination according to the configured
+ * frequency.
+ */
+export type ListEntityBalanceTransferThreshold = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The destination where the available amount will be automatically transferred to according to the configured
+ *
+ * @remarks
+ * transfer frequency.
+ */
+export type ListEntityBalanceTransferDestination = {
+  /**
+   * The default destination of automatic scheduled transfers. Currently only `bank-account` is supported.
+   *
+   * @remarks
+   *
+   * * `bank-account` — Transfer the balance amount to an external bank account
+   */
+  type?: BalanceTransferDestinationType | undefined;
+  /**
+   * The configured bank account number of the beneficiary the balance amount is to be transferred to.
+   */
+  bankAccount?: string | undefined;
+  /**
+   * The full name of the beneficiary the balance amount is to be transferred to.
+   */
+  beneficiaryName?: string | undefined;
+};
+
+/**
+ * The amount directly available on the balance, e.g. `{"currency":"EUR", "value":"100.00"}`.
+ */
+export type ListEntityBalanceAvailableAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The total amount that is queued to be transferred to your balance. For example, a credit card payment can take a
+ *
+ * @remarks
+ * few days to clear.
+ */
+export type ListEntityBalancePendingAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityBalanceLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self?: Url | undefined;
+};
+
+export type ListEntityBalance = {
+  /**
+   * Indicates the response contains a balance object. Will always contain the string `balance` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this balance.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The balance's ISO 4217 currency code.
+   */
+  currency: ListEntityBalanceCurrency;
+  /**
+   * The description or name of the balance. Can be used to denote the purpose of the balance.
+   */
+  description: string;
+  status: ListEntityBalanceStatus;
+  transferFrequency?: ListEntityBalanceTransferFrequency | undefined;
+  /**
+   * The minimum amount configured for scheduled automatic settlements. As soon as the amount on the balance exceeds
+   *
+   * @remarks
+   * this threshold, the complete balance will be paid out to the transfer destination according to the configured
+   * frequency.
+   */
+  transferThreshold?: ListEntityBalanceTransferThreshold | undefined;
+  /**
+   * The transfer reference set to be included in all the transfers for this balance.
+   */
+  transferReference?: string | null | undefined;
+  /**
+   * The destination where the available amount will be automatically transferred to according to the configured
+   *
+   * @remarks
+   * transfer frequency.
+   */
+  transferDestination?: ListEntityBalanceTransferDestination | null | undefined;
+  /**
+   * The amount directly available on the balance, e.g. `{"currency":"EUR", "value":"100.00"}`.
+   */
+  availableAmount: ListEntityBalanceAvailableAmount;
+  /**
+   * The total amount that is queued to be transferred to your balance. For example, a credit card payment can take a
+   *
+   * @remarks
+   * few days to clear.
+   */
+  pendingAmount: ListEntityBalancePendingAmount;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityBalanceLinks;
+};
+
+/** @internal */
+export const ListEntityBalanceCurrency$inboundSchema: z.ZodType<
+  ListEntityBalanceCurrency,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityBalanceCurrency);
+/** @internal */
+export const ListEntityBalanceCurrency$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityBalanceCurrency
+> = openEnums.outboundSchema(ListEntityBalanceCurrency);
+
+/** @internal */
+export const ListEntityBalanceStatus$inboundSchema: z.ZodType<
+  ListEntityBalanceStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityBalanceStatus);
+/** @internal */
+export const ListEntityBalanceStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityBalanceStatus
+> = openEnums.outboundSchema(ListEntityBalanceStatus);
+
+/** @internal */
+export const ListEntityBalanceTransferFrequency$inboundSchema: z.ZodType<
+  ListEntityBalanceTransferFrequency,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityBalanceTransferFrequency);
+/** @internal */
+export const ListEntityBalanceTransferFrequency$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityBalanceTransferFrequency
+> = openEnums.outboundSchema(ListEntityBalanceTransferFrequency);
+
+/** @internal */
+export const ListEntityBalanceTransferThreshold$inboundSchema: z.ZodType<
+  ListEntityBalanceTransferThreshold,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityBalanceTransferThreshold$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityBalanceTransferThreshold$outboundSchema: z.ZodType<
+  ListEntityBalanceTransferThreshold$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalanceTransferThreshold
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityBalanceTransferThresholdToJSON(
+  listEntityBalanceTransferThreshold: ListEntityBalanceTransferThreshold,
+): string {
+  return JSON.stringify(
+    ListEntityBalanceTransferThreshold$outboundSchema.parse(
+      listEntityBalanceTransferThreshold,
+    ),
+  );
+}
+export function listEntityBalanceTransferThresholdFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalanceTransferThreshold, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityBalanceTransferThreshold$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalanceTransferThreshold' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityBalanceTransferDestination$inboundSchema: z.ZodType<
+  ListEntityBalanceTransferDestination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: BalanceTransferDestinationType$inboundSchema.optional(),
+  bankAccount: z.string().optional(),
+  beneficiaryName: z.string().optional(),
+});
+/** @internal */
+export type ListEntityBalanceTransferDestination$Outbound = {
+  type?: string | undefined;
+  bankAccount?: string | undefined;
+  beneficiaryName?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityBalanceTransferDestination$outboundSchema: z.ZodType<
+  ListEntityBalanceTransferDestination$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalanceTransferDestination
+> = z.object({
+  type: BalanceTransferDestinationType$outboundSchema.optional(),
+  bankAccount: z.string().optional(),
+  beneficiaryName: z.string().optional(),
+});
+
+export function listEntityBalanceTransferDestinationToJSON(
+  listEntityBalanceTransferDestination: ListEntityBalanceTransferDestination,
+): string {
+  return JSON.stringify(
+    ListEntityBalanceTransferDestination$outboundSchema.parse(
+      listEntityBalanceTransferDestination,
+    ),
+  );
+}
+export function listEntityBalanceTransferDestinationFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalanceTransferDestination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityBalanceTransferDestination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalanceTransferDestination' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityBalanceAvailableAmount$inboundSchema: z.ZodType<
+  ListEntityBalanceAvailableAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityBalanceAvailableAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityBalanceAvailableAmount$outboundSchema: z.ZodType<
+  ListEntityBalanceAvailableAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalanceAvailableAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityBalanceAvailableAmountToJSON(
+  listEntityBalanceAvailableAmount: ListEntityBalanceAvailableAmount,
+): string {
+  return JSON.stringify(
+    ListEntityBalanceAvailableAmount$outboundSchema.parse(
+      listEntityBalanceAvailableAmount,
+    ),
+  );
+}
+export function listEntityBalanceAvailableAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalanceAvailableAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityBalanceAvailableAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalanceAvailableAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityBalancePendingAmount$inboundSchema: z.ZodType<
+  ListEntityBalancePendingAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityBalancePendingAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityBalancePendingAmount$outboundSchema: z.ZodType<
+  ListEntityBalancePendingAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalancePendingAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityBalancePendingAmountToJSON(
+  listEntityBalancePendingAmount: ListEntityBalancePendingAmount,
+): string {
+  return JSON.stringify(
+    ListEntityBalancePendingAmount$outboundSchema.parse(
+      listEntityBalancePendingAmount,
+    ),
+  );
+}
+export function listEntityBalancePendingAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalancePendingAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityBalancePendingAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalancePendingAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityBalanceLinks$inboundSchema: z.ZodType<
+  ListEntityBalanceLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema.optional(),
+});
+/** @internal */
+export type ListEntityBalanceLinks$Outbound = {
+  self?: Url$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityBalanceLinks$outboundSchema: z.ZodType<
+  ListEntityBalanceLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalanceLinks
+> = z.object({
+  self: Url$outboundSchema.optional(),
+});
+
+export function listEntityBalanceLinksToJSON(
+  listEntityBalanceLinks: ListEntityBalanceLinks,
+): string {
+  return JSON.stringify(
+    ListEntityBalanceLinks$outboundSchema.parse(listEntityBalanceLinks),
+  );
+}
+export function listEntityBalanceLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalanceLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityBalanceLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalanceLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityBalance$inboundSchema: z.ZodType<
+  ListEntityBalance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  createdAt: z.string(),
+  currency: ListEntityBalanceCurrency$inboundSchema,
+  description: z.string(),
+  status: ListEntityBalanceStatus$inboundSchema,
+  transferFrequency: ListEntityBalanceTransferFrequency$inboundSchema
+    .optional(),
+  transferThreshold: z.lazy(() =>
+    ListEntityBalanceTransferThreshold$inboundSchema
+  ).optional(),
+  transferReference: z.nullable(z.string()).optional(),
+  transferDestination: z.nullable(
+    z.lazy(() => ListEntityBalanceTransferDestination$inboundSchema),
+  ).optional(),
+  availableAmount: z.lazy(() => ListEntityBalanceAvailableAmount$inboundSchema),
+  pendingAmount: z.lazy(() => ListEntityBalancePendingAmount$inboundSchema),
+  _links: z.lazy(() => ListEntityBalanceLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityBalance$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  createdAt: string;
+  currency: string;
+  description: string;
+  status: string;
+  transferFrequency?: string | undefined;
+  transferThreshold?: ListEntityBalanceTransferThreshold$Outbound | undefined;
+  transferReference?: string | null | undefined;
+  transferDestination?:
+    | ListEntityBalanceTransferDestination$Outbound
+    | null
+    | undefined;
+  availableAmount: ListEntityBalanceAvailableAmount$Outbound;
+  pendingAmount: ListEntityBalancePendingAmount$Outbound;
+  _links: ListEntityBalanceLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityBalance$outboundSchema: z.ZodType<
+  ListEntityBalance$Outbound,
+  z.ZodTypeDef,
+  ListEntityBalance
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  createdAt: z.string(),
+  currency: ListEntityBalanceCurrency$outboundSchema,
+  description: z.string(),
+  status: ListEntityBalanceStatus$outboundSchema,
+  transferFrequency: ListEntityBalanceTransferFrequency$outboundSchema
+    .optional(),
+  transferThreshold: z.lazy(() =>
+    ListEntityBalanceTransferThreshold$outboundSchema
+  ).optional(),
+  transferReference: z.nullable(z.string()).optional(),
+  transferDestination: z.nullable(
+    z.lazy(() => ListEntityBalanceTransferDestination$outboundSchema),
+  ).optional(),
+  availableAmount: z.lazy(() =>
+    ListEntityBalanceAvailableAmount$outboundSchema
+  ),
+  pendingAmount: z.lazy(() => ListEntityBalancePendingAmount$outboundSchema),
+  links: z.lazy(() => ListEntityBalanceLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityBalanceToJSON(
+  listEntityBalance: ListEntityBalance,
+): string {
+  return JSON.stringify(
+    ListEntityBalance$outboundSchema.parse(listEntityBalance),
+  );
+}
+export function listEntityBalanceFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityBalance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityBalance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityBalance' from JSON`,
+  );
+}