mollie-api-typescript 0.9.5 → 0.9.6

package/src/models/listentitymethod.ts

@@ -0,0 +1,608 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  MethodStatus,
+  MethodStatus$inboundSchema,
+  MethodStatus$outboundSchema,
+} from "./methodstatus.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+
+/**
+ * The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+ *
+ * @remarks
+ * method selection screen will be skipped.
+ */
+export const ListEntityMethodId = {
+  Alma: "alma",
+  Applepay: "applepay",
+  Bacs: "bacs",
+  Bancomatpay: "bancomatpay",
+  Bancontact: "bancontact",
+  Banktransfer: "banktransfer",
+  Belfius: "belfius",
+  Billie: "billie",
+  Bizum: "bizum",
+  Blik: "blik",
+  Creditcard: "creditcard",
+  Directdebit: "directdebit",
+  Eps: "eps",
+  Giftcard: "giftcard",
+  Ideal: "ideal",
+  In3: "in3",
+  Kbc: "kbc",
+  Klarna: "klarna",
+  Mbway: "mbway",
+  Mobilepay: "mobilepay",
+  Multibanco: "multibanco",
+  Mybank: "mybank",
+  Paybybank: "paybybank",
+  Paypal: "paypal",
+  Paysafecard: "paysafecard",
+  Pointofsale: "pointofsale",
+  Przelewy24: "przelewy24",
+  Riverty: "riverty",
+  Satispay: "satispay",
+  Swish: "swish",
+  Trustly: "trustly",
+  Twint: "twint",
+  Vipps: "vipps",
+  Voucher: "voucher",
+  /**
+   * Deprecated, use 'klarna' instead
+   */
+  Klarnapaylater: "klarnapaylater",
+  /**
+   * Deprecated, use 'klarna' instead
+   */
+  Klarnapaynow: "klarnapaynow",
+  /**
+   * Deprecated, use 'klarna' instead
+   */
+  Klarnasliceit: "klarnasliceit",
+  /**
+   * No longer available
+   */
+  Payconiq: "payconiq",
+} as const;
+/**
+ * The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+ *
+ * @remarks
+ * method selection screen will be skipped.
+ */
+export type ListEntityMethodId = OpenEnum<typeof ListEntityMethodId>;
+
+/**
+ * The minimum payment amount required to use this payment method.
+ */
+export type ListEntityMethodMinimumAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+ *
+ * @remarks
+ * is returned instead.
+ */
+export type ListEntityMethodMaximumAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * URLs of images representing the payment method.
+ */
+export type ListEntityMethodImage = {
+  /**
+   * The URL pointing to an icon of 32 by 24 pixels.
+   */
+  size1x: string;
+  /**
+   * The URL pointing to an icon of 64 by 48 pixels.
+   */
+  size2x: string;
+  /**
+   * The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+   *
+   * @remarks
+   * scale to any desired size without compromising visual quality.
+   */
+  svg: string;
+};
+
+/**
+ * URLs of images representing the issuer.
+ *
+ * @remarks
+ * required:
+ *   - size1x
+ *   - size2x
+ *   - svg
+ */
+export type ListEntityMethodIssuerImage = {
+  /**
+   * The URL pointing to an icon of 32 by 24 pixels.
+   */
+  size1x?: string | undefined;
+  /**
+   * The URL pointing to an icon of 64 by 48 pixels.
+   */
+  size2x?: string | undefined;
+  /**
+   * The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
+   *
+   * @remarks
+   * scale to any desired size without compromising visual quality.
+   */
+  svg?: string | undefined;
+};
+
+export type ListEntityMethodIssuer = {
+  resource: string;
+  id: string;
+  /**
+   * The full name of the issuer.
+   */
+  name: string;
+  /**
+   * URLs of images representing the issuer.
+   *
+   * @remarks
+   * required:
+   *   - size1x
+   *   - size2x
+   *   - svg
+   */
+  image: ListEntityMethodIssuerImage;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityMethodLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
+};
+
+export type ListEntityMethod = {
+  /**
+   * Indicates the response contains a payment method object. Will always contain the string `method` for this
+   *
+   * @remarks
+   * endpoint.
+   */
+  resource: string;
+  /**
+   * The unique identifier of the payment method. When used during [payment creation](create-payment), the payment
+   *
+   * @remarks
+   * method selection screen will be skipped.
+   */
+  id: ListEntityMethodId | null;
+  /**
+   * The full name of the payment method.
+   *
+   * @remarks
+   *
+   * If a `locale` parameter is provided, the name is translated to the given locale if possible.
+   */
+  description: string;
+  /**
+   * The minimum payment amount required to use this payment method.
+   */
+  minimumAmount: ListEntityMethodMinimumAmount;
+  /**
+   * The maximum payment amount allowed when using this payment method. If there is no method-specific maximum, `null`
+   *
+   * @remarks
+   * is returned instead.
+   */
+  maximumAmount: ListEntityMethodMaximumAmount | null;
+  /**
+   * URLs of images representing the payment method.
+   */
+  image: ListEntityMethodImage;
+  /**
+   * The payment method's activation status for this profile.
+   */
+  status: MethodStatus | null;
+  /**
+   * **Optional include.** Array of objects for each 'issuer' that is available for this payment method. Only relevant
+   *
+   * @remarks
+   * for iDEAL, KBC/CBC, gift cards, and vouchers.
+   */
+  issuers?: Array<ListEntityMethodIssuer> | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListEntityMethodLinks;
+};
+
+/** @internal */
+export const ListEntityMethodId$inboundSchema: z.ZodType<
+  ListEntityMethodId,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListEntityMethodId);
+/** @internal */
+export const ListEntityMethodId$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListEntityMethodId
+> = openEnums.outboundSchema(ListEntityMethodId);
+
+/** @internal */
+export const ListEntityMethodMinimumAmount$inboundSchema: z.ZodType<
+  ListEntityMethodMinimumAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityMethodMinimumAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityMethodMinimumAmount$outboundSchema: z.ZodType<
+  ListEntityMethodMinimumAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodMinimumAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityMethodMinimumAmountToJSON(
+  listEntityMethodMinimumAmount: ListEntityMethodMinimumAmount,
+): string {
+  return JSON.stringify(
+    ListEntityMethodMinimumAmount$outboundSchema.parse(
+      listEntityMethodMinimumAmount,
+    ),
+  );
+}
+export function listEntityMethodMinimumAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodMinimumAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodMinimumAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodMinimumAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethodMaximumAmount$inboundSchema: z.ZodType<
+  ListEntityMethodMaximumAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type ListEntityMethodMaximumAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const ListEntityMethodMaximumAmount$outboundSchema: z.ZodType<
+  ListEntityMethodMaximumAmount$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodMaximumAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function listEntityMethodMaximumAmountToJSON(
+  listEntityMethodMaximumAmount: ListEntityMethodMaximumAmount,
+): string {
+  return JSON.stringify(
+    ListEntityMethodMaximumAmount$outboundSchema.parse(
+      listEntityMethodMaximumAmount,
+    ),
+  );
+}
+export function listEntityMethodMaximumAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodMaximumAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodMaximumAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodMaximumAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethodImage$inboundSchema: z.ZodType<
+  ListEntityMethodImage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  size1x: z.string(),
+  size2x: z.string(),
+  svg: z.string(),
+});
+/** @internal */
+export type ListEntityMethodImage$Outbound = {
+  size1x: string;
+  size2x: string;
+  svg: string;
+};
+
+/** @internal */
+export const ListEntityMethodImage$outboundSchema: z.ZodType<
+  ListEntityMethodImage$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodImage
+> = z.object({
+  size1x: z.string(),
+  size2x: z.string(),
+  svg: z.string(),
+});
+
+export function listEntityMethodImageToJSON(
+  listEntityMethodImage: ListEntityMethodImage,
+): string {
+  return JSON.stringify(
+    ListEntityMethodImage$outboundSchema.parse(listEntityMethodImage),
+  );
+}
+export function listEntityMethodImageFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodImage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodImage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodImage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethodIssuerImage$inboundSchema: z.ZodType<
+  ListEntityMethodIssuerImage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  size1x: z.string().optional(),
+  size2x: z.string().optional(),
+  svg: z.string().optional(),
+});
+/** @internal */
+export type ListEntityMethodIssuerImage$Outbound = {
+  size1x?: string | undefined;
+  size2x?: string | undefined;
+  svg?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityMethodIssuerImage$outboundSchema: z.ZodType<
+  ListEntityMethodIssuerImage$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodIssuerImage
+> = z.object({
+  size1x: z.string().optional(),
+  size2x: z.string().optional(),
+  svg: z.string().optional(),
+});
+
+export function listEntityMethodIssuerImageToJSON(
+  listEntityMethodIssuerImage: ListEntityMethodIssuerImage,
+): string {
+  return JSON.stringify(
+    ListEntityMethodIssuerImage$outboundSchema.parse(
+      listEntityMethodIssuerImage,
+    ),
+  );
+}
+export function listEntityMethodIssuerImageFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodIssuerImage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodIssuerImage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodIssuerImage' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethodIssuer$inboundSchema: z.ZodType<
+  ListEntityMethodIssuer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  name: z.string(),
+  image: z.lazy(() => ListEntityMethodIssuerImage$inboundSchema),
+});
+/** @internal */
+export type ListEntityMethodIssuer$Outbound = {
+  resource: string;
+  id: string;
+  name: string;
+  image: ListEntityMethodIssuerImage$Outbound;
+};
+
+/** @internal */
+export const ListEntityMethodIssuer$outboundSchema: z.ZodType<
+  ListEntityMethodIssuer$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodIssuer
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  name: z.string(),
+  image: z.lazy(() => ListEntityMethodIssuerImage$outboundSchema),
+});
+
+export function listEntityMethodIssuerToJSON(
+  listEntityMethodIssuer: ListEntityMethodIssuer,
+): string {
+  return JSON.stringify(
+    ListEntityMethodIssuer$outboundSchema.parse(listEntityMethodIssuer),
+  );
+}
+export function listEntityMethodIssuerFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodIssuer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodIssuer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodIssuer' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethodLinks$inboundSchema: z.ZodType<
+  ListEntityMethodLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+});
+/** @internal */
+export type ListEntityMethodLinks$Outbound = {
+  self: Url$Outbound;
+};
+
+/** @internal */
+export const ListEntityMethodLinks$outboundSchema: z.ZodType<
+  ListEntityMethodLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethodLinks
+> = z.object({
+  self: Url$outboundSchema,
+});
+
+export function listEntityMethodLinksToJSON(
+  listEntityMethodLinks: ListEntityMethodLinks,
+): string {
+  return JSON.stringify(
+    ListEntityMethodLinks$outboundSchema.parse(listEntityMethodLinks),
+  );
+}
+export function listEntityMethodLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethodLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethodLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethodLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityMethod$inboundSchema: z.ZodType<
+  ListEntityMethod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.nullable(ListEntityMethodId$inboundSchema),
+  description: z.string(),
+  minimumAmount: z.lazy(() => ListEntityMethodMinimumAmount$inboundSchema),
+  maximumAmount: z.nullable(
+    z.lazy(() => ListEntityMethodMaximumAmount$inboundSchema),
+  ),
+  image: z.lazy(() => ListEntityMethodImage$inboundSchema),
+  status: z.nullable(MethodStatus$inboundSchema),
+  issuers: z.array(z.lazy(() => ListEntityMethodIssuer$inboundSchema))
+    .optional(),
+  _links: z.lazy(() => ListEntityMethodLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityMethod$Outbound = {
+  resource: string;
+  id: string | null;
+  description: string;
+  minimumAmount: ListEntityMethodMinimumAmount$Outbound;
+  maximumAmount: ListEntityMethodMaximumAmount$Outbound | null;
+  image: ListEntityMethodImage$Outbound;
+  status: string | null;
+  issuers?: Array<ListEntityMethodIssuer$Outbound> | undefined;
+  _links: ListEntityMethodLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityMethod$outboundSchema: z.ZodType<
+  ListEntityMethod$Outbound,
+  z.ZodTypeDef,
+  ListEntityMethod
+> = z.object({
+  resource: z.string(),
+  id: z.nullable(ListEntityMethodId$outboundSchema),
+  description: z.string(),
+  minimumAmount: z.lazy(() => ListEntityMethodMinimumAmount$outboundSchema),
+  maximumAmount: z.nullable(
+    z.lazy(() => ListEntityMethodMaximumAmount$outboundSchema),
+  ),
+  image: z.lazy(() => ListEntityMethodImage$outboundSchema),
+  status: z.nullable(MethodStatus$outboundSchema),
+  issuers: z.array(z.lazy(() => ListEntityMethodIssuer$outboundSchema))
+    .optional(),
+  links: z.lazy(() => ListEntityMethodLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityMethodToJSON(
+  listEntityMethod: ListEntityMethod,
+): string {
+  return JSON.stringify(
+    ListEntityMethod$outboundSchema.parse(listEntityMethod),
+  );
+}
+export function listEntityMethodFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityMethod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityMethod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityMethod' from JSON`,
+  );
+}