mollie-api-typescript 1.3.3 → 1.3.5

package/src/models/transferresponse.ts

@@ -0,0 +1,321 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4f0735bf13c6
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  Amount,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import {
+  CreditDebitIndicator,
+  CreditDebitIndicator$inboundSchema,
+  CreditDebitIndicator$outboundSchema,
+} from "./creditdebitindicator.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  StatusHistoryEntryResponse,
+  StatusHistoryEntryResponse$inboundSchema,
+  StatusHistoryEntryResponse$Outbound,
+  StatusHistoryEntryResponse$outboundSchema,
+} from "./statushistoryentryresponse.js";
+import {
+  StatusReason2,
+  StatusReason2$inboundSchema,
+  StatusReason2$Outbound,
+  StatusReason2$outboundSchema,
+} from "./statusreason2.js";
+import {
+  TransferParty,
+  TransferParty$inboundSchema,
+  TransferParty$Outbound,
+  TransferParty$outboundSchema,
+} from "./transferparty.js";
+import {
+  TransferSchemeResponse,
+  TransferSchemeResponse$inboundSchema,
+  TransferSchemeResponse$Outbound,
+  TransferSchemeResponse$outboundSchema,
+} from "./transferschemeresponse.js";
+import {
+  TransferStatus,
+  TransferStatus$inboundSchema,
+  TransferStatus$outboundSchema,
+} from "./transferstatus.js";
+
+/**
+ * The bank account details of the party.
+ */
+export type TransferResponseAccount = {
+  /**
+   * The IBAN (International Bank Account Number) of the account holder.
+   */
+  iban: string;
+};
+
+/**
+ * The debtor (sender) of the transfer, including their name and account details.
+ */
+export type Debtor = {
+  /**
+   * The full name of the account holder.
+   */
+  fullName: string;
+  /**
+   * The bank account details of the party.
+   */
+  account: TransferResponseAccount;
+};
+
+export type TransferResponse = {
+  /**
+   * Indicates the response contains a transfer object. Will always contain the string `business-account-transfer`
+   *
+   * @remarks
+   * for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this transfer. Mollie assigns this identifier at transfer creation time.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The debtor (sender) of the transfer, including their name and account details.
+   */
+  debtor: Debtor;
+  /**
+   * A party involved in the transfer, representing either the debtor (sender) or creditor (recipient).
+   *
+   * @remarks
+   * Contains the party's name and account details.
+   */
+  creditor: TransferParty;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A short description of the transfer. This will appear on the bank statement of both the debtor and creditor.
+   *
+   * @remarks
+   *
+   * It must begin with an alphanumeric character, followed by any combination of letters, numbers, spaces or special characters `/ - ? : ( ) . , ' + _`.
+   *
+   * Constraints:
+   * - Cannot be solely a hyphen (-) or colon (:)
+   * - Cannot contain consecutive hyphens (--)
+   * - Cannot contain consecutive colons (::)
+   */
+  description?: string | null | undefined;
+  /**
+   * The identifier of the corresponding transaction in the business accounts transaction resource.
+   */
+  businessAccountTransactionId: string;
+  /**
+   * The scheme, as requested by the client.
+   */
+  transferScheme: TransferSchemeResponse;
+  /**
+   * Indicates whether the transfer is a credit or debit transaction from the perspective of the account holder.
+   */
+  creditDebitIndicator: CreditDebitIndicator;
+  /**
+   * The status of the transfer.
+   */
+  status: TransferStatus;
+  /**
+   * A chronological list of status transitions the transfer has gone through.
+   */
+  statusHistory: Array<StatusHistoryEntryResponse>;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * A human-readable reason explaining the current status of the transfer. Only populated when the transfer has
+   *
+   * @remarks
+   * reached a terminal status of `failed`, `rejected`, or `blocked`.
+   *
+   * This field is `null` for transfers that have not reached one of these statuses.
+   */
+  statusReason?: StatusReason2 | null | undefined;
+  /**
+   * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+   *
+   * @remarks
+   * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+   */
+  metadata?: Metadata | null | undefined;
+};
+
+/** @internal */
+export const TransferResponseAccount$inboundSchema: z.ZodType<
+  TransferResponseAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  iban: z.string(),
+});
+/** @internal */
+export type TransferResponseAccount$Outbound = {
+  iban: string;
+};
+
+/** @internal */
+export const TransferResponseAccount$outboundSchema: z.ZodType<
+  TransferResponseAccount$Outbound,
+  z.ZodTypeDef,
+  TransferResponseAccount
+> = z.object({
+  iban: z.string(),
+});
+
+export function transferResponseAccountToJSON(
+  transferResponseAccount: TransferResponseAccount,
+): string {
+  return JSON.stringify(
+    TransferResponseAccount$outboundSchema.parse(transferResponseAccount),
+  );
+}
+export function transferResponseAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferResponseAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferResponseAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferResponseAccount' from JSON`,
+  );
+}
+
+/** @internal */
+export const Debtor$inboundSchema: z.ZodType<Debtor, z.ZodTypeDef, unknown> = z
+  .object({
+    fullName: z.string(),
+    account: z.lazy(() => TransferResponseAccount$inboundSchema),
+  });
+/** @internal */
+export type Debtor$Outbound = {
+  fullName: string;
+  account: TransferResponseAccount$Outbound;
+};
+
+/** @internal */
+export const Debtor$outboundSchema: z.ZodType<
+  Debtor$Outbound,
+  z.ZodTypeDef,
+  Debtor
+> = z.object({
+  fullName: z.string(),
+  account: z.lazy(() => TransferResponseAccount$outboundSchema),
+});
+
+export function debtorToJSON(debtor: Debtor): string {
+  return JSON.stringify(Debtor$outboundSchema.parse(debtor));
+}
+export function debtorFromJSON(
+  jsonString: string,
+): SafeParseResult<Debtor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Debtor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Debtor' from JSON`,
+  );
+}
+
+/** @internal */
+export const TransferResponse$inboundSchema: z.ZodType<
+  TransferResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  debtor: z.lazy(() => Debtor$inboundSchema),
+  creditor: TransferParty$inboundSchema,
+  amount: Amount$inboundSchema,
+  description: z.nullable(z.string()).optional(),
+  businessAccountTransactionId: z.string(),
+  transferScheme: TransferSchemeResponse$inboundSchema,
+  creditDebitIndicator: CreditDebitIndicator$inboundSchema,
+  status: TransferStatus$inboundSchema,
+  statusHistory: z.array(StatusHistoryEntryResponse$inboundSchema),
+  createdAt: z.string(),
+  statusReason: z.nullable(StatusReason2$inboundSchema).optional(),
+  metadata: z.nullable(Metadata$inboundSchema).optional(),
+});
+/** @internal */
+export type TransferResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  debtor: Debtor$Outbound;
+  creditor: TransferParty$Outbound;
+  amount: Amount$Outbound;
+  description?: string | null | undefined;
+  businessAccountTransactionId: string;
+  transferScheme: TransferSchemeResponse$Outbound;
+  creditDebitIndicator: string;
+  status: string;
+  statusHistory: Array<StatusHistoryEntryResponse$Outbound>;
+  createdAt: string;
+  statusReason?: StatusReason2$Outbound | null | undefined;
+  metadata?: Metadata$Outbound | null | undefined;
+};
+
+/** @internal */
+export const TransferResponse$outboundSchema: z.ZodType<
+  TransferResponse$Outbound,
+  z.ZodTypeDef,
+  TransferResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  debtor: z.lazy(() => Debtor$outboundSchema),
+  creditor: TransferParty$outboundSchema,
+  amount: Amount$outboundSchema,
+  description: z.nullable(z.string()).optional(),
+  businessAccountTransactionId: z.string(),
+  transferScheme: TransferSchemeResponse$outboundSchema,
+  creditDebitIndicator: CreditDebitIndicator$outboundSchema,
+  status: TransferStatus$outboundSchema,
+  statusHistory: z.array(StatusHistoryEntryResponse$outboundSchema),
+  createdAt: z.string(),
+  statusReason: z.nullable(StatusReason2$outboundSchema).optional(),
+  metadata: z.nullable(Metadata$outboundSchema).optional(),
+});
+
+export function transferResponseToJSON(
+  transferResponse: TransferResponse,
+): string {
+  return JSON.stringify(
+    TransferResponse$outboundSchema.parse(transferResponse),
+  );
+}
+export function transferResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferResponse' from JSON`,
+  );
+}

package/src/models/transferscheme.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e20ec02e7463
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  TransferSchemeType,
+  TransferSchemeType$inboundSchema,
+  TransferSchemeType$outboundSchema,
+} from "./transferschemetype.js";
+
+/**
+ * The scheme, as requested by the client.
+ */
+export type TransferScheme = {
+  /**
+   * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+   */
+  type: TransferSchemeType;
+};
+
+/** @internal */
+export const TransferScheme$inboundSchema: z.ZodType<
+  TransferScheme,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: TransferSchemeType$inboundSchema,
+});
+/** @internal */
+export type TransferScheme$Outbound = {
+  type: string;
+};
+
+/** @internal */
+export const TransferScheme$outboundSchema: z.ZodType<
+  TransferScheme$Outbound,
+  z.ZodTypeDef,
+  TransferScheme
+> = z.object({
+  type: TransferSchemeType$outboundSchema,
+});
+
+export function transferSchemeToJSON(transferScheme: TransferScheme): string {
+  return JSON.stringify(TransferScheme$outboundSchema.parse(transferScheme));
+}
+export function transferSchemeFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferScheme, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferScheme$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferScheme' from JSON`,
+  );
+}

package/src/models/transferschemeresponse.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4582756ac09f
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  TransferSchemeTypeResponse,
+  TransferSchemeTypeResponse$inboundSchema,
+  TransferSchemeTypeResponse$outboundSchema,
+} from "./transferschemetyperesponse.js";
+
+/**
+ * The scheme, as requested by the client.
+ */
+export type TransferSchemeResponse = {
+  /**
+   * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+   */
+  type: TransferSchemeTypeResponse;
+};
+
+/** @internal */
+export const TransferSchemeResponse$inboundSchema: z.ZodType<
+  TransferSchemeResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: TransferSchemeTypeResponse$inboundSchema,
+});
+/** @internal */
+export type TransferSchemeResponse$Outbound = {
+  type: string;
+};
+
+/** @internal */
+export const TransferSchemeResponse$outboundSchema: z.ZodType<
+  TransferSchemeResponse$Outbound,
+  z.ZodTypeDef,
+  TransferSchemeResponse
+> = z.object({
+  type: TransferSchemeTypeResponse$outboundSchema,
+});
+
+export function transferSchemeResponseToJSON(
+  transferSchemeResponse: TransferSchemeResponse,
+): string {
+  return JSON.stringify(
+    TransferSchemeResponse$outboundSchema.parse(transferSchemeResponse),
+  );
+}
+export function transferSchemeResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferSchemeResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferSchemeResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferSchemeResponse' from JSON`,
+  );
+}

package/src/models/transferschemetype.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 427461b19fca
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../types/enums.js";
+
+/**
+ * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+ */
+export const TransferSchemeType = {
+  SepaCreditInst: "sepa-credit-inst",
+  SepaCredit: "sepa-credit",
+} as const;
+/**
+ * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+ */
+export type TransferSchemeType = ClosedEnum<typeof TransferSchemeType>;
+
+/** @internal */
+export const TransferSchemeType$inboundSchema: z.ZodNativeEnum<
+  typeof TransferSchemeType
+> = z.nativeEnum(TransferSchemeType);
+/** @internal */
+export const TransferSchemeType$outboundSchema: z.ZodNativeEnum<
+  typeof TransferSchemeType
+> = TransferSchemeType$inboundSchema;

package/src/models/transferschemetyperesponse.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3b16f38c6c16
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+ */
+export const TransferSchemeTypeResponse = {
+  SepaCreditInst: "sepa-credit-inst",
+  SepaCredit: "sepa-credit",
+} as const;
+/**
+ * The transfer scheme to be used for the transfer. The transfer scheme determines the processing time and method of the transfer.
+ */
+export type TransferSchemeTypeResponse = OpenEnum<
+  typeof TransferSchemeTypeResponse
+>;
+
+/** @internal */
+export const TransferSchemeTypeResponse$inboundSchema: z.ZodType<
+  TransferSchemeTypeResponse,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransferSchemeTypeResponse);
+/** @internal */
+export const TransferSchemeTypeResponse$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TransferSchemeTypeResponse
+> = openEnums.outboundSchema(TransferSchemeTypeResponse);

package/src/models/transferstatus.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: cec633fa7089
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The status of the transfer.
+ */
+export const TransferStatus = {
+  Requested: "requested",
+  Initiated: "initiated",
+  PendingReview: "pending-review",
+  Processed: "processed",
+  Failed: "failed",
+  Blocked: "blocked",
+  IncomingSettled: "incoming-settled",
+} as const;
+/**
+ * The status of the transfer.
+ */
+export type TransferStatus = OpenEnum<typeof TransferStatus>;
+
+/** @internal */
+export const TransferStatus$inboundSchema: z.ZodType<
+  TransferStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(TransferStatus);
+/** @internal */
+export const TransferStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  TransferStatus
+> = openEnums.outboundSchema(TransferStatus);

package/src/models/verificationofpayeerequest.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 081487b0aab2
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import {
+  CreditorBankAccount,
+  CreditorBankAccount$inboundSchema,
+  CreditorBankAccount$Outbound,
+  CreditorBankAccount$outboundSchema,
+} from "./creditorbankaccount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * The request body for performing a Verification of Payee (VoP) check. VoP allows you to verify the
+ *
+ * @remarks
+ * account holder name against the records held by the receiving bank before initiating a transfer.
+ */
+export type VerificationOfPayeeRequest = {
+  /**
+   * The bank account details of the creditor (recipient) for Verification of Payee.
+   */
+  creditorBankAccount: CreditorBankAccount;
+  /**
+   * Whether to create the entity in test mode or live mode.
+   *
+   * @remarks
+   *
+   * Most API credentials are specifically created for either live mode or test mode, in which case this parameter must
+   * not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
+   * `testmode` to `true`.
+   */
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const VerificationOfPayeeRequest$inboundSchema: z.ZodType<
+  VerificationOfPayeeRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  creditorBankAccount: CreditorBankAccount$inboundSchema,
+  testmode: z.nullable(z.boolean()).optional(),
+});
+/** @internal */
+export type VerificationOfPayeeRequest$Outbound = {
+  creditorBankAccount: CreditorBankAccount$Outbound;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const VerificationOfPayeeRequest$outboundSchema: z.ZodType<
+  VerificationOfPayeeRequest$Outbound,
+  z.ZodTypeDef,
+  VerificationOfPayeeRequest
+> = z.object({
+  creditorBankAccount: CreditorBankAccount$outboundSchema,
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+export function verificationOfPayeeRequestToJSON(
+  verificationOfPayeeRequest: VerificationOfPayeeRequest,
+): string {
+  return JSON.stringify(
+    VerificationOfPayeeRequest$outboundSchema.parse(verificationOfPayeeRequest),
+  );
+}
+export function verificationOfPayeeRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<VerificationOfPayeeRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerificationOfPayeeRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerificationOfPayeeRequest' from JSON`,
+  );
+}