mollie-api-typescript 1.7.0 → 1.7.2

package/src/lib/config.ts

@@ -78,8 +78,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "1.7.0",
-  genVersion: "2.882.0",
+  sdkVersion: "1.7.2",
+  genVersion: "2.884.0",
   userAgent:
-    "speakeasy-sdk/typescript 1.7.0 2.882.0 1.0.0 mollie-api-typescript",
+    "speakeasy-sdk/typescript 1.7.2 2.884.0 1.0.0 mollie-api-typescript",
 } as const;

package/src/models/entitypayoutresponse.ts

@@ -0,0 +1,157 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 43f55d244bf6
+ */
+
+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 {
+  AmountNullable,
+  AmountNullable$inboundSchema,
+} from "./amountnullable.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema } from "./mode.js";
+import { PayoutStatus, PayoutStatus$inboundSchema } from "./payoutstatus.js";
+import {
+  PayoutStatusReason,
+  PayoutStatusReason$inboundSchema,
+} from "./payoutstatusreason.js";
+import { Url, Url$inboundSchema } from "./url.js";
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type EntityPayoutResponseLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  documentation: Url;
+};
+
+export type EntityPayoutResponse = {
+  /**
+   * Indicates the response contains a payout object. Will always contain the string `payout` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this payout. Mollie assigns this identifier at payout creation time.
+   *
+   * @remarks
+   * Mollie will always refer to the payout by this ID. Example: `payout_j8NvRAM2WNZtsykpLEX8J`.
+   */
+  id: string;
+  /**
+   * The identifier of the balance that will be paid out. Example: `bal_gVMhHKqSSRYJyPsuoPNFH`.
+   */
+  balanceId: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount?: AmountNullable | null | undefined;
+  /**
+   * The description that will appear on the bank statement for this payout.
+   */
+  description?: string | undefined;
+  /**
+   * The status of the payout.
+   */
+  status: PayoutStatus;
+  /**
+   * The reason for the payout's current status.
+   */
+  statusReason: PayoutStatusReason;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The date and time the payout was initiated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * This is the moment Mollie attempted to reserve the funds on the balance.
+   */
+  initiatedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was sent to the destination bank account, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. `null` if the payout has not completed yet.
+   */
+  completedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was canceled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * `null` if the payout was not canceled.
+   */
+  canceledAt?: string | null | undefined;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links?: EntityPayoutResponseLinks | undefined;
+};
+
+/** @internal */
+export const EntityPayoutResponseLinks$inboundSchema: z.ZodType<
+  EntityPayoutResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  documentation: Url$inboundSchema,
+});
+
+export function entityPayoutResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPayoutResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPayoutResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPayoutResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityPayoutResponse$inboundSchema: z.ZodType<
+  EntityPayoutResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  balanceId: z.string(),
+  amount: z.nullable(AmountNullable$inboundSchema).optional(),
+  description: z.string().optional(),
+  status: PayoutStatus$inboundSchema,
+  statusReason: PayoutStatusReason$inboundSchema,
+  createdAt: z.string(),
+  initiatedAt: z.nullable(z.string()).optional(),
+  completedAt: z.nullable(z.string()).optional(),
+  canceledAt: z.nullable(z.string()).optional(),
+  mode: Mode$inboundSchema,
+  _links: z.lazy(() => EntityPayoutResponseLinks$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function entityPayoutResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityPayoutResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityPayoutResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityPayoutResponse' from JSON`,
+  );
+}

package/src/models/entitywebhookevent.ts

@@ -9,6 +9,10 @@ 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 {
+  EntityPayoutResponse,
+  EntityPayoutResponse$inboundSchema,
+} from "./entitypayoutresponse.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
   PaymentLinkResponse,
@@ -33,6 +37,11 @@ import { Url, Url$inboundSchema } from "./url.js";
 export const EntityWebhookEventWebhookEventTypes = {
   PaymentLinkPaid: "payment-link.paid",
   BalanceTransactionCreated: "balance-transaction.created",
+  PayoutInitiated: "payout.initiated",
+  PayoutProcessingAtBank: "payout.processing-at-bank",
+  PayoutCompleted: "payout.completed",
+  PayoutCanceled: "payout.canceled",
+  PayoutFailed: "payout.failed",
   SalesInvoiceCreated: "sales-invoice.created",
   SalesInvoiceIssued: "sales-invoice.issued",
   SalesInvoiceCanceled: "sales-invoice.canceled",
@@ -60,6 +69,7 @@ export type EntityWebhookEventWebhookEventTypes = OpenEnum<
 export type Entity =
   | PaymentLinkResponse
   | TransferResponse
+  | EntityPayoutResponse
   | SalesInvoiceResponse;
 
 /**
@@ -69,6 +79,7 @@ export type Embedded = {
   entity?:
     | PaymentLinkResponse
     | TransferResponse
+    | EntityPayoutResponse
     | SalesInvoiceResponse
     | undefined;
 };
@@ -131,6 +142,7 @@ export const Entity$inboundSchema: z.ZodType<Entity, z.ZodTypeDef, unknown> = z
   .union([
     PaymentLinkResponse$inboundSchema,
     TransferResponse$inboundSchema,
+    EntityPayoutResponse$inboundSchema,
     SalesInvoiceResponse$inboundSchema,
   ]);
 
@@ -153,6 +165,7 @@ export const Embedded$inboundSchema: z.ZodType<
   entity: z.union([
     PaymentLinkResponse$inboundSchema,
     TransferResponse$inboundSchema,
+    EntityPayoutResponse$inboundSchema,
     SalesInvoiceResponse$inboundSchema,
   ]).optional(),
 });

package/src/models/index.ts

@@ -63,6 +63,7 @@ export * from "./entityonboardingstatus.js";
 export * from "./entityorganization.js";
 export * from "./entitypaymentroute.js";
 export * from "./entitypaymentrouteresponse.js";
+export * from "./entitypayoutresponse.js";
 export * from "./entitypermission.js";
 export * from "./entityrefundresponse.js";
 export * from "./entitysettlement.js";
@@ -80,6 +81,7 @@ export * from "./listentitychargeback.js";
 export * from "./listentityinvoice.js";
 export * from "./listentitymethod.js";
 export * from "./listentitymethodall.js";
+export * from "./listentitypayout.js";
 export * from "./listentitypermission.js";
 export * from "./listentityrefund.js";
 export * from "./listentitysettlement.js";
@@ -139,6 +141,10 @@ export * from "./paymentlinksequencetyperesponse.js";
 export * from "./paymentmethod.js";
 export * from "./paymentrequest.js";
 export * from "./paymentresponse.js";
+export * from "./payoutrequest.js";
+export * from "./payoutstatus.js";
+export * from "./payoutstatusreason.js";
+export * from "./payoutstatusreasoncode.js";
 export * from "./profilerequest.js";
 export * from "./profileresponse.js";
 export * from "./profilereviewstatusresponse.js";

package/src/models/listentitypayout.ts

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 394d8d8b123a
+ */
+
+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 {
+  AmountNullable,
+  AmountNullable$inboundSchema,
+} from "./amountnullable.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema } from "./mode.js";
+import { PayoutStatus, PayoutStatus$inboundSchema } from "./payoutstatus.js";
+import {
+  PayoutStatusReason,
+  PayoutStatusReason$inboundSchema,
+} from "./payoutstatusreason.js";
+import { Url, Url$inboundSchema } from "./url.js";
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListEntityPayoutLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self: Url;
+};
+
+export type ListEntityPayout = {
+  /**
+   * Indicates the response contains a payout object. Will always contain the string `payout` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this payout. Mollie assigns this identifier at payout creation time.
+   *
+   * @remarks
+   * Mollie will always refer to the payout by this ID. Example: `payout_j8NvRAM2WNZtsykpLEX8J`.
+   */
+  id: string;
+  /**
+   * The identifier of the balance that will be paid out. Example: `bal_gVMhHKqSSRYJyPsuoPNFH`.
+   */
+  balanceId: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount?: AmountNullable | null | undefined;
+  /**
+   * The description that will appear on the bank statement for this payout.
+   */
+  description?: string | undefined;
+  /**
+   * The status of the payout.
+   */
+  status: PayoutStatus;
+  /**
+   * The reason for the payout's current status.
+   */
+  statusReason: PayoutStatusReason;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The date and time the payout was initiated, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * This is the moment Mollie attempted to reserve the funds on the balance.
+   */
+  initiatedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was sent to the destination bank account, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. `null` if the payout has not completed yet.
+   */
+  completedAt?: string | null | undefined;
+  /**
+   * The date and time the payout was canceled, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   *
+   * @remarks
+   * `null` if the payout was not canceled.
+   */
+  canceledAt?: string | null | undefined;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links?: ListEntityPayoutLinks | undefined;
+};
+
+/** @internal */
+export const ListEntityPayoutLinks$inboundSchema: z.ZodType<
+  ListEntityPayoutLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+});
+
+export function listEntityPayoutLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityPayoutLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityPayoutLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityPayoutLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityPayout$inboundSchema: z.ZodType<
+  ListEntityPayout,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  balanceId: z.string(),
+  amount: z.nullable(AmountNullable$inboundSchema).optional(),
+  description: z.string().optional(),
+  status: PayoutStatus$inboundSchema,
+  statusReason: PayoutStatusReason$inboundSchema,
+  createdAt: z.string(),
+  initiatedAt: z.nullable(z.string()).optional(),
+  completedAt: z.nullable(z.string()).optional(),
+  canceledAt: z.nullable(z.string()).optional(),
+  mode: Mode$inboundSchema,
+  _links: z.lazy(() => ListEntityPayoutLinks$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function listEntityPayoutFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityPayout, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityPayout$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityPayout' from JSON`,
+  );
+}

package/src/models/operations/cancelpayout.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a8ceed358b32
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type CancelPayoutGlobals = {
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+};
+
+export type CancelPayoutRequest = {
+  /**
+   * Provide the ID of the payout.
+   */
+  payoutId: string;
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type CancelPayoutRequest$Outbound = {
+  payoutId: string;
+  testmode?: boolean | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const CancelPayoutRequest$outboundSchema: z.ZodType<
+  CancelPayoutRequest$Outbound,
+  z.ZodTypeDef,
+  CancelPayoutRequest
+> = z.object({
+  payoutId: z.string(),
+  testmode: z.boolean().optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function cancelPayoutRequestToJSON(
+  cancelPayoutRequest: CancelPayoutRequest,
+): string {
+  return JSON.stringify(
+    CancelPayoutRequest$outboundSchema.parse(cancelPayoutRequest),
+  );
+}

package/src/models/operations/createpayout.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b7566a7f5207
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as models from "../index.js";
+
+export type CreatePayoutGlobals = {
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+};
+
+export type CreatePayoutRequest = {
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+  payoutRequest: models.PayoutRequest;
+};
+
+/** @internal */
+export type CreatePayoutRequest$Outbound = {
+  testmode?: boolean | undefined;
+  "idempotency-key"?: string | undefined;
+  "payout-request": models.PayoutRequest$Outbound;
+};
+
+/** @internal */
+export const CreatePayoutRequest$outboundSchema: z.ZodType<
+  CreatePayoutRequest$Outbound,
+  z.ZodTypeDef,
+  CreatePayoutRequest
+> = z.object({
+  testmode: z.boolean().optional(),
+  idempotencyKey: z.string().optional(),
+  payoutRequest: models.PayoutRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+    payoutRequest: "payout-request",
+  });
+});
+
+export function createPayoutRequestToJSON(
+  createPayoutRequest: CreatePayoutRequest,
+): string {
+  return JSON.stringify(
+    CreatePayoutRequest$outboundSchema.parse(createPayoutRequest),
+  );
+}

package/src/models/operations/getpayout.ts

@@ -0,0 +1,71 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ae27c300ffe4
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetPayoutGlobals = {
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+};
+
+export type GetPayoutRequest = {
+  /**
+   * Provide the ID of the payout.
+   */
+  payoutId: string;
+  /**
+   * Most API credentials are specifically created for either live mode or test mode. In those cases the `testmode` query
+   *
+   * @remarks
+   * parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by
+   * setting the `testmode` query parameter to `true`.
+   *
+   * Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
+   */
+  testmode?: boolean | undefined;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export type GetPayoutRequest$Outbound = {
+  payoutId: string;
+  testmode?: boolean | undefined;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const GetPayoutRequest$outboundSchema: z.ZodType<
+  GetPayoutRequest$Outbound,
+  z.ZodTypeDef,
+  GetPayoutRequest
+> = z.object({
+  payoutId: z.string(),
+  testmode: z.boolean().optional(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function getPayoutRequestToJSON(
+  getPayoutRequest: GetPayoutRequest,
+): string {
+  return JSON.stringify(
+    GetPayoutRequest$outboundSchema.parse(getPayoutRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -4,6 +4,7 @@
  */
 
 export * from "./cancelpayment.js";
+export * from "./cancelpayout.js";
 export * from "./cancelrefund.js";
 export * from "./cancelsubscription.js";
 export * from "./createcapture.js";
@@ -14,6 +15,7 @@ export * from "./createcustomerpayment.js";
 export * from "./createmandate.js";
 export * from "./createpayment.js";
 export * from "./createpaymentlink.js";
+export * from "./createpayout.js";
 export * from "./createprofile.js";
 export * from "./createrefund.js";
 export * from "./createsalesinvoice.js";
@@ -48,6 +50,7 @@ export * from "./getpartnerstatus.js";
 export * from "./getpayment.js";
 export * from "./getpaymentlink.js";
 export * from "./getpaymentlinkpayments.js";
+export * from "./getpayout.js";
 export * from "./getpermission.js";
 export * from "./getprimarybalance.js";
 export * from "./getprofile.js";
@@ -81,6 +84,7 @@ export * from "./listmandates.js";
 export * from "./listmethods.js";
 export * from "./listpaymentlinks.js";
 export * from "./listpayments.js";
+export * from "./listpayouts.js";
 export * from "./listpermissions.js";
 export * from "./listprofiles.js";
 export * from "./listrefunds.js";