mollie-api-typescript 1.3.3 → 1.3.5

package/src/models/settlementmode.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0ebfc9d67630
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * Whether this entity was created in live mode or in test mode. Settlements are always in live mode.
+ */
+export const SettlementMode = {
+  Live: "live",
+} as const;
+/**
+ * Whether this entity was created in live mode or in test mode. Settlements are always in live mode.
+ */
+export type SettlementMode = OpenEnum<typeof SettlementMode>;
+
+/** @internal */
+export const SettlementMode$inboundSchema: z.ZodType<
+  SettlementMode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SettlementMode);
+/** @internal */
+export const SettlementMode$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SettlementMode
+> = openEnums.outboundSchema(SettlementMode);

package/src/models/settlementpaymentstatus.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4e4410db40ce
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The payment's status. Settlement payments always have a status of `paid`.
+ */
+export const SettlementPaymentStatus = {
+  Paid: "paid",
+} as const;
+/**
+ * The payment's status. Settlement payments always have a status of `paid`.
+ */
+export type SettlementPaymentStatus = OpenEnum<typeof SettlementPaymentStatus>;
+
+/** @internal */
+export const SettlementPaymentStatus$inboundSchema: z.ZodType<
+  SettlementPaymentStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SettlementPaymentStatus);
+/** @internal */
+export const SettlementPaymentStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SettlementPaymentStatus
+> = openEnums.outboundSchema(SettlementPaymentStatus);

package/src/models/settlementrefundstatus.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 352f0e0a42f3
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * The refund's status. Settlement refunds always have a status of `refunded`.
+ */
+export const SettlementRefundStatus = {
+  Refunded: "refunded",
+} as const;
+/**
+ * The refund's status. Settlement refunds always have a status of `refunded`.
+ */
+export type SettlementRefundStatus = OpenEnum<typeof SettlementRefundStatus>;
+
+/** @internal */
+export const SettlementRefundStatus$inboundSchema: z.ZodType<
+  SettlementRefundStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SettlementRefundStatus);
+/** @internal */
+export const SettlementRefundStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SettlementRefundStatus
+> = openEnums.outboundSchema(SettlementRefundStatus);

package/src/models/statushistoryentryresponse.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3301ebd39f93
+ */
+
+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 {
+  StatusReason2,
+  StatusReason2$inboundSchema,
+  StatusReason2$Outbound,
+  StatusReason2$outboundSchema,
+} from "./statusreason2.js";
+import {
+  TransferStatus,
+  TransferStatus$inboundSchema,
+  TransferStatus$outboundSchema,
+} from "./transferstatus.js";
+
+/**
+ * Represents an entry in the transfer's status history, recording a past status transition.
+ */
+export type StatusHistoryEntryResponse = {
+  /**
+   * The status of the transfer.
+   */
+  status: TransferStatus;
+  /**
+   * 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;
+};
+
+/** @internal */
+export const StatusHistoryEntryResponse$inboundSchema: z.ZodType<
+  StatusHistoryEntryResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: TransferStatus$inboundSchema,
+  createdAt: z.string(),
+  statusReason: z.nullable(StatusReason2$inboundSchema).optional(),
+});
+/** @internal */
+export type StatusHistoryEntryResponse$Outbound = {
+  status: string;
+  createdAt: string;
+  statusReason?: StatusReason2$Outbound | null | undefined;
+};
+
+/** @internal */
+export const StatusHistoryEntryResponse$outboundSchema: z.ZodType<
+  StatusHistoryEntryResponse$Outbound,
+  z.ZodTypeDef,
+  StatusHistoryEntryResponse
+> = z.object({
+  status: TransferStatus$outboundSchema,
+  createdAt: z.string(),
+  statusReason: z.nullable(StatusReason2$outboundSchema).optional(),
+});
+
+export function statusHistoryEntryResponseToJSON(
+  statusHistoryEntryResponse: StatusHistoryEntryResponse,
+): string {
+  return JSON.stringify(
+    StatusHistoryEntryResponse$outboundSchema.parse(statusHistoryEntryResponse),
+  );
+}
+export function statusHistoryEntryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<StatusHistoryEntryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatusHistoryEntryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatusHistoryEntryResponse' from JSON`,
+  );
+}

package/src/models/statusreason2.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 48da0f9aa120
+ */
+
+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 {
+  StatusReasonCodeResponse,
+  StatusReasonCodeResponse$inboundSchema,
+  StatusReasonCodeResponse$outboundSchema,
+} from "./statusreasoncoderesponse.js";
+
+/**
+ * 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.
+ */
+export type StatusReason2 = {
+  /**
+   * A machine-readable code indicating the reason for the transfer's terminal status.
+   */
+  code?: StatusReasonCodeResponse | undefined;
+  /**
+   * Provides further details about failure indicated. This field is only populated if the`code` field is set to `error`.
+   */
+  message?: string | null | undefined;
+};
+
+/** @internal */
+export const StatusReason2$inboundSchema: z.ZodType<
+  StatusReason2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: StatusReasonCodeResponse$inboundSchema.optional(),
+  message: z.nullable(z.string()).optional(),
+});
+/** @internal */
+export type StatusReason2$Outbound = {
+  code?: string | undefined;
+  message?: string | null | undefined;
+};
+
+/** @internal */
+export const StatusReason2$outboundSchema: z.ZodType<
+  StatusReason2$Outbound,
+  z.ZodTypeDef,
+  StatusReason2
+> = z.object({
+  code: StatusReasonCodeResponse$outboundSchema.optional(),
+  message: z.nullable(z.string()).optional(),
+});
+
+export function statusReason2ToJSON(statusReason2: StatusReason2): string {
+  return JSON.stringify(StatusReason2$outboundSchema.parse(statusReason2));
+}
+export function statusReason2FromJSON(
+  jsonString: string,
+): SafeParseResult<StatusReason2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatusReason2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatusReason2' from JSON`,
+  );
+}

package/src/models/statusreasoncoderesponse.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fb0704131e81
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+/**
+ * A machine-readable code indicating the reason for the transfer's terminal status.
+ */
+export const StatusReasonCodeResponse = {
+  InsufficientFunds: "insufficient-funds",
+  Rejected: "rejected",
+  Error: "error",
+} as const;
+/**
+ * A machine-readable code indicating the reason for the transfer's terminal status.
+ */
+export type StatusReasonCodeResponse = OpenEnum<
+  typeof StatusReasonCodeResponse
+>;
+
+/** @internal */
+export const StatusReasonCodeResponse$inboundSchema: z.ZodType<
+  StatusReasonCodeResponse,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StatusReasonCodeResponse);
+/** @internal */
+export const StatusReasonCodeResponse$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  StatusReasonCodeResponse
+> = openEnums.outboundSchema(StatusReasonCodeResponse);

package/src/models/transferparty.ts

@@ -0,0 +1,113 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ef559e9c9778
+ */
+
+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";
+
+/**
+ * The bank account details of the party.
+ */
+export type TransferPartyAccount = {
+  /**
+   * The IBAN (International Bank Account Number) of the account holder.
+   */
+  iban: string;
+};
+
+/**
+ * A party involved in the transfer, representing either the debtor (sender) or creditor (recipient).
+ *
+ * @remarks
+ * Contains the party's name and account details.
+ */
+export type TransferParty = {
+  /**
+   * The full name of the account holder.
+   */
+  fullName: string;
+  /**
+   * The bank account details of the party.
+   */
+  account: TransferPartyAccount;
+};
+
+/** @internal */
+export const TransferPartyAccount$inboundSchema: z.ZodType<
+  TransferPartyAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  iban: z.string(),
+});
+/** @internal */
+export type TransferPartyAccount$Outbound = {
+  iban: string;
+};
+
+/** @internal */
+export const TransferPartyAccount$outboundSchema: z.ZodType<
+  TransferPartyAccount$Outbound,
+  z.ZodTypeDef,
+  TransferPartyAccount
+> = z.object({
+  iban: z.string(),
+});
+
+export function transferPartyAccountToJSON(
+  transferPartyAccount: TransferPartyAccount,
+): string {
+  return JSON.stringify(
+    TransferPartyAccount$outboundSchema.parse(transferPartyAccount),
+  );
+}
+export function transferPartyAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferPartyAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferPartyAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferPartyAccount' from JSON`,
+  );
+}
+
+/** @internal */
+export const TransferParty$inboundSchema: z.ZodType<
+  TransferParty,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fullName: z.string(),
+  account: z.lazy(() => TransferPartyAccount$inboundSchema),
+});
+/** @internal */
+export type TransferParty$Outbound = {
+  fullName: string;
+  account: TransferPartyAccount$Outbound;
+};
+
+/** @internal */
+export const TransferParty$outboundSchema: z.ZodType<
+  TransferParty$Outbound,
+  z.ZodTypeDef,
+  TransferParty
+> = z.object({
+  fullName: z.string(),
+  account: z.lazy(() => TransferPartyAccount$outboundSchema),
+});
+
+export function transferPartyToJSON(transferParty: TransferParty): string {
+  return JSON.stringify(TransferParty$outboundSchema.parse(transferParty));
+}
+export function transferPartyFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferParty, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferParty$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferParty' from JSON`,
+  );
+}

package/src/models/transferrequest.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 04c974972af0
+ */
+
+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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import {
+  TransferParty,
+  TransferParty$inboundSchema,
+  TransferParty$Outbound,
+  TransferParty$outboundSchema,
+} from "./transferparty.js";
+import {
+  TransferScheme,
+  TransferScheme$inboundSchema,
+  TransferScheme$Outbound,
+  TransferScheme$outboundSchema,
+} from "./transferscheme.js";
+
+export type TransferRequest = {
+  /**
+   * The IBAN of the debtor's (sender) Mollie account from which to initiate the transfer.
+   */
+  debtorIban: string;
+  /**
+   * 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 scheme, as requested by the client.
+   */
+  transferScheme: TransferScheme;
+  /**
+   * 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;
+  /**
+   * 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 TransferRequest$inboundSchema: z.ZodType<
+  TransferRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  debtorIban: z.string(),
+  creditor: TransferParty$inboundSchema,
+  amount: Amount$inboundSchema,
+  description: z.nullable(z.string()).optional(),
+  transferScheme: TransferScheme$inboundSchema,
+  metadata: z.nullable(Metadata$inboundSchema).optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+/** @internal */
+export type TransferRequest$Outbound = {
+  debtorIban: string;
+  creditor: TransferParty$Outbound;
+  amount: Amount$Outbound;
+  description?: string | null | undefined;
+  transferScheme: TransferScheme$Outbound;
+  metadata?: Metadata$Outbound | null | undefined;
+  testmode?: boolean | null | undefined;
+};
+
+/** @internal */
+export const TransferRequest$outboundSchema: z.ZodType<
+  TransferRequest$Outbound,
+  z.ZodTypeDef,
+  TransferRequest
+> = z.object({
+  debtorIban: z.string(),
+  creditor: TransferParty$outboundSchema,
+  amount: Amount$outboundSchema,
+  description: z.nullable(z.string()).optional(),
+  transferScheme: TransferScheme$outboundSchema,
+  metadata: z.nullable(Metadata$outboundSchema).optional(),
+  testmode: z.nullable(z.boolean()).optional(),
+});
+
+export function transferRequestToJSON(
+  transferRequest: TransferRequest,
+): string {
+  return JSON.stringify(TransferRequest$outboundSchema.parse(transferRequest));
+}
+export function transferRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<TransferRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TransferRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TransferRequest' from JSON`,
+  );
+}