mollie-api-typescript 1.12.13 → 1.12.15

package/src/models/listdrafttransferresponse.ts

@@ -0,0 +1,297 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e704b701a9b8
+ */
+
+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 { RFCDate } from "../types/rfcdate.js";
+import { Amount, Amount$inboundSchema } from "./amount.js";
+import {
+  DraftTransferParty,
+  DraftTransferParty$inboundSchema,
+} from "./drafttransferparty.js";
+import {
+  DraftTransferStatusHistoryEntryResponse,
+  DraftTransferStatusHistoryEntryResponse$inboundSchema,
+} from "./drafttransferstatushistoryentryresponse.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema } from "./mode.js";
+
+/**
+ * Whether the draft transfer was created via this API, or created in Mollie Apps.
+ */
+export const ListDraftTransferResponseSource = {
+  Api: "api",
+  MollieApp: "mollie-app",
+} as const;
+/**
+ * Whether the draft transfer was created via this API, or created in Mollie Apps.
+ */
+export type ListDraftTransferResponseSource = OpenEnum<
+  typeof ListDraftTransferResponseSource
+>;
+
+/**
+ * The bank account details of the party.
+ */
+export type ListDraftTransferResponseAccount = {
+  /**
+   * The IBAN (International Bank Account Number) of the account holder.
+   */
+  iban: string;
+};
+
+/**
+ * The debtor (sender) of the draft transfer, resolved from `debtorIban` at creation time.
+ */
+export type ListDraftTransferResponseDebtor = {
+  /**
+   * The full name of the account holder.
+   */
+  fullName: string;
+  /**
+   * The bank account details of the party.
+   */
+  account: ListDraftTransferResponseAccount;
+};
+
+/**
+ * The status of the draft transfer.
+ */
+export const ListDraftTransferResponseStatus = {
+  AwaitingInitiation: "awaiting-initiation",
+  Initiated: "initiated",
+  Declined: "declined",
+} as const;
+/**
+ * The status of the draft transfer.
+ */
+export type ListDraftTransferResponseStatus = OpenEnum<
+  typeof ListDraftTransferResponseStatus
+>;
+
+/**
+ * The URL to this draft transfer.
+ */
+export type ListDraftTransferResponseSelf = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * Links to related resources.
+ */
+export type ListDraftTransferResponseLinks = {
+  /**
+   * The URL to this draft transfer.
+   */
+  self: ListDraftTransferResponseSelf;
+};
+
+export type ListDraftTransferResponse = {
+  /**
+   * Indicates the response contains a draft transfer object. Will always contain the string
+   *
+   * @remarks
+   * `business-account-draft-transfer` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this draft transfer. Mollie assigns this identifier at draft transfer
+   *
+   * @remarks
+   * creation time.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * Whether the draft transfer was created via this API, or created in Mollie Apps.
+   */
+  source: ListDraftTransferResponseSource;
+  /**
+   * The debtor (sender) of the draft transfer, resolved from `debtorIban` at creation time.
+   */
+  debtor: ListDraftTransferResponseDebtor;
+  /**
+   * A party involved in the draft transfer, representing either the debtor (sender) or creditor
+   *
+   * @remarks
+   * (recipient). Contains the party's name and account details.
+   */
+  creditor: DraftTransferParty;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * A short description of the draft transfer. Once approved, this will appear on the bank statement of both
+   *
+   * @remarks
+   * the debtor and creditor.
+   */
+  description?: string | null | undefined;
+  /**
+   * The date on which the resulting transfer will be executed, once approved. Defaults to same-day if omitted,
+   *
+   * @remarks
+   * in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date format.
+   */
+  scheduledFor?: RFCDate | null | undefined;
+  status: ListDraftTransferResponseStatus;
+  /**
+   * The reason for the current status. Only populated when `status` is `declined`, either free text provided
+   *
+   * @remarks
+   * by the initiator or `"Declined by creator"` when cancelled via the `DELETE` endpoint.
+   */
+  statusReason?: string | null | undefined;
+  /**
+   * A chronological list of status transitions the draft transfer has gone through.
+   */
+  statusHistory: Array<DraftTransferStatusHistoryEntryResponse>;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * Links to related resources.
+   */
+  links: ListDraftTransferResponseLinks;
+};
+
+/** @internal */
+export const ListDraftTransferResponseSource$inboundSchema: z.ZodType<
+  ListDraftTransferResponseSource,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListDraftTransferResponseSource);
+
+/** @internal */
+export const ListDraftTransferResponseAccount$inboundSchema: z.ZodType<
+  ListDraftTransferResponseAccount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  iban: z.string(),
+});
+
+export function listDraftTransferResponseAccountFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransferResponseAccount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransferResponseAccount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransferResponseAccount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransferResponseDebtor$inboundSchema: z.ZodType<
+  ListDraftTransferResponseDebtor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  fullName: z.string(),
+  account: z.lazy(() => ListDraftTransferResponseAccount$inboundSchema),
+});
+
+export function listDraftTransferResponseDebtorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransferResponseDebtor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransferResponseDebtor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransferResponseDebtor' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransferResponseStatus$inboundSchema: z.ZodType<
+  ListDraftTransferResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListDraftTransferResponseStatus);
+
+/** @internal */
+export const ListDraftTransferResponseSelf$inboundSchema: z.ZodType<
+  ListDraftTransferResponseSelf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+
+export function listDraftTransferResponseSelfFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransferResponseSelf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransferResponseSelf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransferResponseSelf' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransferResponseLinks$inboundSchema: z.ZodType<
+  ListDraftTransferResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: z.lazy(() => ListDraftTransferResponseSelf$inboundSchema),
+});
+
+export function listDraftTransferResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransferResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransferResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransferResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransferResponse$inboundSchema: z.ZodType<
+  ListDraftTransferResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  source: ListDraftTransferResponseSource$inboundSchema,
+  debtor: z.lazy(() => ListDraftTransferResponseDebtor$inboundSchema),
+  creditor: DraftTransferParty$inboundSchema,
+  amount: Amount$inboundSchema,
+  description: z.nullable(z.string()).optional(),
+  scheduledFor: z.nullable(z.string().transform(v => new RFCDate(v)))
+    .optional(),
+  status: ListDraftTransferResponseStatus$inboundSchema,
+  statusReason: z.nullable(z.string()).optional(),
+  statusHistory: z.array(DraftTransferStatusHistoryEntryResponse$inboundSchema),
+  createdAt: z.string(),
+  _links: z.lazy(() => ListDraftTransferResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function listDraftTransferResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransferResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransferResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransferResponse' from JSON`,
+  );
+}

package/src/models/operations/canceldrafttransfer.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d3acc61c2eed
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CancelDraftTransferRequest = {
+  /**
+   * Provide the ID of the related draft transfer.
+   */
+  draftTransferId: string;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type CancelDraftTransferRequest$Outbound = {
+  draftTransferId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const CancelDraftTransferRequest$outboundSchema: z.ZodType<
+  CancelDraftTransferRequest$Outbound,
+  z.ZodTypeDef,
+  CancelDraftTransferRequest
+> = z.object({
+  draftTransferId: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function cancelDraftTransferRequestToJSON(
+  cancelDraftTransferRequest: CancelDraftTransferRequest,
+): string {
+  return JSON.stringify(
+    CancelDraftTransferRequest$outboundSchema.parse(cancelDraftTransferRequest),
+  );
+}

package/src/models/operations/createdrafttransfer.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1884db8ca709
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type CreateDraftTransferRequest = {
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  createDraftTransferRequest?: models.CreateDraftTransferRequest | undefined;
+};
+
+/** @internal */
+export type CreateDraftTransferRequest$Outbound = {
+  "idempotency-key"?: string | undefined;
+  "create-draft-transfer-request"?:
+    | models.CreateDraftTransferRequest$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const CreateDraftTransferRequest$outboundSchema: z.ZodType<
+  CreateDraftTransferRequest$Outbound,
+  z.ZodTypeDef,
+  CreateDraftTransferRequest
+> = z.object({
+  idempotencyKey: z.string().optional(),
+  createDraftTransferRequest: models.CreateDraftTransferRequest$outboundSchema
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    createDraftTransferRequest: "create-draft-transfer-request",
+  });
+});
+
+export function createDraftTransferRequestToJSON(
+  createDraftTransferRequest: CreateDraftTransferRequest,
+): string {
+  return JSON.stringify(
+    CreateDraftTransferRequest$outboundSchema.parse(createDraftTransferRequest),
+  );
+}

package/src/models/operations/getdrafttransfer.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 51ab3e7f957e
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetDraftTransferRequest = {
+  /**
+   * Provide the ID of the related draft transfer.
+   */
+  draftTransferId: string;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type GetDraftTransferRequest$Outbound = {
+  draftTransferId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const GetDraftTransferRequest$outboundSchema: z.ZodType<
+  GetDraftTransferRequest$Outbound,
+  z.ZodTypeDef,
+  GetDraftTransferRequest
+> = z.object({
+  draftTransferId: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function getDraftTransferRequestToJSON(
+  getDraftTransferRequest: GetDraftTransferRequest,
+): string {
+  return JSON.stringify(
+    GetDraftTransferRequest$outboundSchema.parse(getDraftTransferRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -3,6 +3,7 @@
  * @generated-id: 0d9ffaf774d2
  */
 
+export * from "./canceldrafttransfer.js";
 export * from "./cancelpayment.js";
 export * from "./cancelpayout.js";
 export * from "./cancelrefund.js";
@@ -12,6 +13,7 @@ export * from "./createclientlink.js";
 export * from "./createconnectbalancetransfer.js";
 export * from "./createcustomer.js";
 export * from "./createcustomerpayment.js";
+export * from "./createdrafttransfer.js";
 export * from "./createmandate.js";
 export * from "./createpayment.js";
 export * from "./createpaymentlink.js";
@@ -39,6 +41,7 @@ export * from "./getconnectbalancetransfer.js";
 export * from "./getcurrentorganization.js";
 export * from "./getcurrentprofile.js";
 export * from "./getcustomer.js";
+export * from "./getdrafttransfer.js";
 export * from "./getinvoice.js";
 export * from "./getmandate.js";
 export * from "./getmethod.js";
@@ -79,6 +82,7 @@ export * from "./listclients.js";
 export * from "./listconnectbalancetransfers.js";
 export * from "./listcustomerpayments.js";
 export * from "./listcustomers.js";
+export * from "./listdrafttransfers.js";
 export * from "./listinvoices.js";
 export * from "./listmandates.js";
 export * from "./listmethods.js";

package/src/models/operations/listdrafttransfers.ts

@@ -0,0 +1,178 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: de1a951c2027
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as models from "../index.js";
+
+export type ListDraftTransfersRequest = {
+  /**
+   * Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the
+   *
+   * @remarks
+   * result set.
+   */
+  from?: string | null | undefined;
+  /**
+   * The maximum number of items to return. Defaults to 50 items.
+   */
+  limit?: number | null | undefined;
+  /**
+   * Filter the list by draft transfer status. Omit to return draft transfers in any status.
+   */
+  status?: models.DraftTransferStatus | undefined;
+  /**
+   * Filter the list by origin: `api` for draft transfers created via this API, `mollie-app` for ones created
+   *
+   * @remarks
+   * in Mollie Apps. Omit to return draft transfers from any source.
+   */
+  source?: models.DraftTransferSource | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+export type ListDraftTransfersEmbedded = {
+  /**
+   * An array of draft transfer objects.
+   */
+  draftTransfers: Array<models.ListDraftTransferResponse>;
+};
+
+/**
+ * A list of draft transfer objects.
+ */
+export type ListDraftTransfersResponseBody = {
+  /**
+   * The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result
+   *
+   * @remarks
+   * as well.
+   *
+   * The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
+   * limit is 50 items.
+   */
+  count: number;
+  embedded: ListDraftTransfersEmbedded;
+  /**
+   * Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
+   */
+  links: models.ListLinks;
+};
+
+export type ListDraftTransfersResponse = {
+  result: ListDraftTransfersResponseBody;
+};
+
+/** @internal */
+export type ListDraftTransfersRequest$Outbound = {
+  from?: string | null | undefined;
+  limit?: number | null | undefined;
+  status?: string | undefined;
+  source?: string | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const ListDraftTransfersRequest$outboundSchema: z.ZodType<
+  ListDraftTransfersRequest$Outbound,
+  z.ZodTypeDef,
+  ListDraftTransfersRequest
+> = z.object({
+  from: z.nullable(z.string()).optional(),
+  limit: z.nullable(z.number().int()).optional(),
+  status: models.DraftTransferStatus$outboundSchema.optional(),
+  source: models.DraftTransferSource$outboundSchema.optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function listDraftTransfersRequestToJSON(
+  listDraftTransfersRequest: ListDraftTransfersRequest,
+): string {
+  return JSON.stringify(
+    ListDraftTransfersRequest$outboundSchema.parse(listDraftTransfersRequest),
+  );
+}
+
+/** @internal */
+export const ListDraftTransfersEmbedded$inboundSchema: z.ZodType<
+  ListDraftTransfersEmbedded,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  draft_transfers: z.array(models.ListDraftTransferResponse$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "draft_transfers": "draftTransfers",
+  });
+});
+
+export function listDraftTransfersEmbeddedFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransfersEmbedded, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransfersEmbedded$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransfersEmbedded' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransfersResponseBody$inboundSchema: z.ZodType<
+  ListDraftTransfersResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  count: z.number().int(),
+  _embedded: z.lazy(() => ListDraftTransfersEmbedded$inboundSchema),
+  _links: models.ListLinks$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "_embedded": "embedded",
+    "_links": "links",
+  });
+});
+
+export function listDraftTransfersResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransfersResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransfersResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransfersResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListDraftTransfersResponse$inboundSchema: z.ZodType<
+  ListDraftTransfersResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListDraftTransfersResponseBody$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listDraftTransfersResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListDraftTransfersResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListDraftTransfersResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListDraftTransfersResponse' from JSON`,
+  );
+}

package/src/models/sessionrequest.ts

@@ -15,6 +15,10 @@ import {
   SessionLineItem$Outbound,
   SessionLineItem$outboundSchema,
 } from "./sessionlineitem.js";
+import {
+  SessionRequiredCustomerDetails,
+  SessionRequiredCustomerDetails$outboundSchema,
+} from "./sessionrequiredcustomerdetails.js";
 import {
   SessionSequenceType,
   SessionSequenceType$outboundSchema,
@@ -62,6 +66,17 @@ export type SessionRequest = {
    * right page referencing the order when your customer returns.
    */
   redirectUrl: string;
+  /**
+   * > 🚧 Private beta
+   *
+   * @remarks
+   * >
+   * > This property is currently in private beta, and the final specification may still change.
+   *
+   * Declare which customer details should be collected during checkout. Mollie can collect these details for you
+   * with the Express Component and returns them on the session's and payment's `billingAddress` and `shippingAddress`.
+   */
+  requiredCustomerDetails?: Array<SessionRequiredCustomerDetails> | undefined;
   billingAddress?: PaymentAddress | undefined;
   shippingAddress?: PaymentAddress | undefined;
   customerId?: string | undefined;
@@ -126,6 +141,7 @@ export type SessionRequest$Outbound = {
   description: string;
   lines: Array<SessionLineItem$Outbound>;
   redirectUrl: string;
+  requiredCustomerDetails?: Array<string> | undefined;
   billingAddress?: PaymentAddress$Outbound | undefined;
   shippingAddress?: PaymentAddress$Outbound | undefined;
   customerId?: string | undefined;
@@ -146,6 +162,9 @@ export const SessionRequest$outboundSchema: z.ZodType<
   description: z.string(),
   lines: z.array(SessionLineItem$outboundSchema),
   redirectUrl: z.string(),
+  requiredCustomerDetails: z.array(
+    SessionRequiredCustomerDetails$outboundSchema,
+  ).optional(),
   billingAddress: PaymentAddress$outboundSchema.optional(),
   shippingAddress: PaymentAddress$outboundSchema.optional(),
   customerId: z.string().optional(),