mollie-api-typescript 1.6.5 → 1.6.6

package/src/models/listentityrefund.ts

@@ -21,21 +21,18 @@ import { Url, Url$inboundSchema } from "./url.js";
 import { UrlNullable, UrlNullable$inboundSchema } from "./urlnullable.js";
 
 /**
- * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+ * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
  *
  * @remarks
- * to the currency your account is settled in.
+ * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
  *
- * The amount is a **negative** amount.
+ * The amount deducted from your account balance for this refund, converted to the currency your account is settled
+ * in. Always a **negative** amount. Only available once the refund is finalized and the final settlement amount has
+ * been determined.
  *
- * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
- * zero.
+ * For refunds not directly processed by Mollie (e.g. PayPal), the settlement amount is zero.
  *
- * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
- * the refund is queued the settlement amount is likely not yet available.
- *
- * To retrieve accurate settlement amounts we recommend using the
- * [List balance transactions endpoint](list-balance-transactions) instead.
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type ListEntityRefundSettlementAmount = {
   /**
@@ -130,21 +127,18 @@ export type ListEntityRefund = {
    */
   amount: Amount;
   /**
-   * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+   * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
    *
    * @remarks
-   * to the currency your account is settled in.
-   *
-   * The amount is a **negative** amount.
+   * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
    *
-   * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
-   * zero.
+   * The amount deducted from your account balance for this refund, converted to the currency your account is settled
+   * in. Always a **negative** amount. Only available once the refund is finalized and the final settlement amount has
+   * been determined.
    *
-   * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
-   * the refund is queued the settlement amount is likely not yet available.
+   * For refunds not directly processed by Mollie (e.g. PayPal), the settlement amount is zero.
    *
-   * To retrieve accurate settlement amounts we recommend using the
-   * [List balance transactions endpoint](list-balance-transactions) instead.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   settlementAmount?: ListEntityRefundSettlementAmount | null | undefined;
   /**

package/src/models/listpaymentresponse.ts

@@ -162,16 +162,18 @@ export type ListPaymentResponseAmountChargedBack = {
 };
 
 /**
- * This optional field will contain the approximate amount that will be settled to your account, converted to the
+ * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
  *
  * @remarks
- * currency your account is settled in.
+ * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
  *
- * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
- * settled by Mollie the `settlementAmount` is omitted from the response.
+ * The amount that will be settled to your account, converted to the currency your account is settled in. Only
+ * available once the payment is finalized and the final settlement amount has been determined.
  *
- * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
- * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+ * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+ * Mollie, this field is omitted from the response.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type ListPaymentResponseSettlementAmount = {
   /**
@@ -849,16 +851,18 @@ export type ListPaymentResponse = {
    */
   amountChargedBack?: ListPaymentResponseAmountChargedBack | undefined;
   /**
-   * This optional field will contain the approximate amount that will be settled to your account, converted to the
+   * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
    *
    * @remarks
-   * currency your account is settled in.
+   * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
+   *
+   * The amount that will be settled to your account, converted to the currency your account is settled in. Only
+   * available once the payment is finalized and the final settlement amount has been determined.
    *
-   * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
-   * settled by Mollie the `settlementAmount` is omitted from the response.
+   * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+   * Mollie, this field is omitted from the response.
    *
-   * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
-   * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   settlementAmount?: ListPaymentResponseSettlementAmount | undefined;
   /**

package/src/models/listsettlementcaptureresponse.ts

@@ -25,14 +25,7 @@ import { Url, Url$inboundSchema } from "./url.js";
 import { UrlNullable, UrlNullable$inboundSchema } from "./urlnullable.js";
 
 /**
- * This optional field will contain the approximate amount that will be settled to your account, converted to the
- *
- * @remarks
- * currency your account is settled in.
- *
- * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
- * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
- * instead.
+ * The amount settled to your account for this capture, converted to the currency your account is settled in.
  */
 export type ListSettlementCaptureResponseSettlementAmount = {
   /**
@@ -89,14 +82,7 @@ export type ListSettlementCaptureResponse = {
    */
   amount: AmountNullable | null;
   /**
-   * This optional field will contain the approximate amount that will be settled to your account, converted to the
-   *
-   * @remarks
-   * currency your account is settled in.
-   *
-   * Since the field contains an estimated amount during capture processing, it may change over time. To retrieve
-   * accurate settlement amounts we recommend using the [List balance transactions endpoint](list-balance-transactions)
-   * instead.
+   * The amount settled to your account for this capture, converted to the currency your account is settled in.
    */
   settlementAmount?:
     | ListSettlementCaptureResponseSettlementAmount

package/src/models/listsettlementchargebackresponse.ts

@@ -0,0 +1,240 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6798922f9369
+ */
+
+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 { Amount, Amount$inboundSchema } from "./amount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  SettlementMode,
+  SettlementMode$inboundSchema,
+} from "./settlementmode.js";
+import { Url, Url$inboundSchema } from "./url.js";
+import { UrlNullable, UrlNullable$inboundSchema } from "./urlnullable.js";
+
+/**
+ * The amount deducted from your account balance for this chargeback, converted to the currency your account is
+ *
+ * @remarks
+ * settled in. Always a **negative** amount.
+ */
+export type ListSettlementChargebackResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
+ */
+export type ListSettlementChargebackResponseReason = {
+  /**
+   * Technical code provided by the bank.
+   */
+  code: string;
+  /**
+   * A more detailed human-friendly description.
+   */
+  description: string;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListSettlementChargebackResponseLinks = {
+  /**
+   * 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.
+   */
+  payment: Url;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  settlement?: UrlNullable | null | undefined;
+};
+
+export type ListSettlementChargebackResponse = {
+  /**
+   * Indicates the response contains a chargeback object. Will always contain the string `chargeback` for this
+   *
+   * @remarks
+   * endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this chargeback. Example: `chb_n9z0tp`.
+   */
+  id: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * The amount deducted from your account balance for this chargeback, converted to the currency your account is
+   *
+   * @remarks
+   * settled in. Always a **negative** amount.
+   */
+  settlementAmount?:
+    | ListSettlementChargebackResponseSettlementAmount
+    | null
+    | undefined;
+  /**
+   * Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
+   */
+  reason?: ListSettlementChargebackResponseReason | null | undefined;
+  /**
+   * The unique identifier of the payment this chargeback was created for. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
+  paymentId: string;
+  /**
+   * The identifier referring to the settlement this payment was settled with. For example, `stl_BkEjN2eBb`. This field
+   *
+   * @remarks
+   * is omitted if the refund is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  /**
+   * 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 chargeback was reversed if applicable, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  reversedAt?: string | null | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListSettlementChargebackResponseLinks;
+  /**
+   * Whether this entity was created in live mode or in test mode. Settlements are always in live mode.
+   */
+  mode?: SettlementMode | undefined;
+};
+
+/** @internal */
+export const ListSettlementChargebackResponseSettlementAmount$inboundSchema:
+  z.ZodType<
+    ListSettlementChargebackResponseSettlementAmount,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    currency: z.string(),
+    value: z.string(),
+  });
+
+export function listSettlementChargebackResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListSettlementChargebackResponseSettlementAmount,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementChargebackResponseSettlementAmount$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListSettlementChargebackResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementChargebackResponseReason$inboundSchema: z.ZodType<
+  ListSettlementChargebackResponseReason,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  description: z.string(),
+});
+
+export function listSettlementChargebackResponseReasonFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementChargebackResponseReason, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementChargebackResponseReason$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementChargebackResponseReason' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementChargebackResponseLinks$inboundSchema: z.ZodType<
+  ListSettlementChargebackResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  payment: Url$inboundSchema,
+  settlement: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+
+export function listSettlementChargebackResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementChargebackResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSettlementChargebackResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementChargebackResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSettlementChargebackResponse$inboundSchema: z.ZodType<
+  ListSettlementChargebackResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  amount: Amount$inboundSchema,
+  settlementAmount: z.nullable(
+    z.lazy(() =>
+      ListSettlementChargebackResponseSettlementAmount$inboundSchema
+    ),
+  ).optional(),
+  reason: z.nullable(
+    z.lazy(() => ListSettlementChargebackResponseReason$inboundSchema),
+  ).optional(),
+  paymentId: z.string(),
+  settlementId: z.nullable(z.string()).optional(),
+  createdAt: z.string(),
+  reversedAt: z.nullable(z.string()).optional(),
+  _links: z.lazy(() => ListSettlementChargebackResponseLinks$inboundSchema),
+  mode: SettlementMode$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+
+export function listSettlementChargebackResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSettlementChargebackResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSettlementChargebackResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSettlementChargebackResponse' from JSON`,
+  );
+}

package/src/models/listsettlementpaymentresponse.ts

@@ -167,16 +167,12 @@ export type ListSettlementPaymentResponseAmountChargedBack = {
 };
 
 /**
- * This optional field will contain the approximate amount that will be settled to your account, converted to the
+ * The amount settled to your account for this payment, converted to the currency your account is settled in.
  *
  * @remarks
- * currency your account is settled in.
  *
- * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
- * settled by Mollie the `settlementAmount` is omitted from the response.
- *
- * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
- * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+ * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+ * Mollie, this field is omitted from the response.
  */
 export type ListSettlementPaymentResponseSettlementAmount = {
   /**
@@ -831,16 +827,12 @@ export type ListSettlementPaymentResponse = {
     | ListSettlementPaymentResponseAmountChargedBack
     | undefined;
   /**
-   * This optional field will contain the approximate amount that will be settled to your account, converted to the
+   * The amount settled to your account for this payment, converted to the currency your account is settled in.
    *
    * @remarks
-   * currency your account is settled in.
-   *
-   * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
-   * settled by Mollie the `settlementAmount` is omitted from the response.
    *
-   * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
-   * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+   * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+   * Mollie, this field is omitted from the response.
    */
   settlementAmount?: ListSettlementPaymentResponseSettlementAmount | undefined;
   /**

package/src/models/listsettlementrefundresponse.ts

@@ -26,21 +26,12 @@ import { Url, Url$inboundSchema } from "./url.js";
 import { UrlNullable, UrlNullable$inboundSchema } from "./urlnullable.js";
 
 /**
- * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+ * The amount deducted from your account balance for this refund, converted to the currency your account is
  *
  * @remarks
- * to the currency your account is settled in.
+ * settled in. Always a **negative** amount.
  *
- * The amount is a **negative** amount.
- *
- * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
- * zero.
- *
- * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
- * the refund is queued the settlement amount is likely not yet available.
- *
- * To retrieve accurate settlement amounts we recommend using the
- * [List balance transactions endpoint](list-balance-transactions) instead.
+ * For refunds not directly processed by Mollie (e.g. PayPal), the settlement amount is zero.
  */
 export type ListSettlementRefundResponseSettlementAmount = {
   /**
@@ -125,21 +116,12 @@ export type ListSettlementRefundResponse = {
    */
   amount: Amount;
   /**
-   * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+   * The amount deducted from your account balance for this refund, converted to the currency your account is
    *
    * @remarks
-   * to the currency your account is settled in.
-   *
-   * The amount is a **negative** amount.
-   *
-   * If the refund is not directly processed by Mollie, for example for PayPal refunds, the settlement amount will be
-   * zero.
-   *
-   * Since the field contains an estimated amount during refund processing, it may change over time. For example, while
-   * the refund is queued the settlement amount is likely not yet available.
+   * settled in. Always a **negative** amount.
    *
-   * To retrieve accurate settlement amounts we recommend using the
-   * [List balance transactions endpoint](list-balance-transactions) instead.
+   * For refunds not directly processed by Mollie (e.g. PayPal), the settlement amount is zero.
    */
   settlementAmount?:
     | ListSettlementRefundResponseSettlementAmount

package/src/models/operations/listsettlementchargebacks.ts

@@ -63,7 +63,7 @@ export type ListSettlementChargebacksEmbedded = {
   /**
    * A list of chargeback objects.
    */
-  chargebacks: Array<models.ListEntityChargeback>;
+  chargebacks: Array<models.ListSettlementChargebackResponse>;
 };
 
 /**
@@ -135,7 +135,7 @@ export const ListSettlementChargebacksEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  chargebacks: z.array(models.ListEntityChargeback$inboundSchema),
+  chargebacks: z.array(models.ListSettlementChargebackResponse$inboundSchema),
 });
 
 export function listSettlementChargebacksEmbeddedFromJSON(

package/src/models/paymentresponse.ts

@@ -162,16 +162,18 @@ export type PaymentResponseAmountChargedBack = {
 };
 
 /**
- * This optional field will contain the approximate amount that will be settled to your account, converted to the
+ * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
  *
  * @remarks
- * currency your account is settled in.
+ * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
  *
- * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
- * settled by Mollie the `settlementAmount` is omitted from the response.
+ * The amount that will be settled to your account, converted to the currency your account is settled in. Only
+ * available once the payment is finalized and the final settlement amount has been determined.
  *
- * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
- * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+ * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+ * Mollie, this field is omitted from the response.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type PaymentResponseSettlementAmount = {
   /**
@@ -851,16 +853,18 @@ export type PaymentResponse = {
    */
   amountChargedBack?: PaymentResponseAmountChargedBack | undefined;
   /**
-   * This optional field will contain the approximate amount that will be settled to your account, converted to the
+   * **Deprecated.** This field will be removed on January 1st, 2027. Use the [Settlements API](list-settlements) or
    *
    * @remarks
-   * currency your account is settled in.
+   * the [List balance transactions endpoint](list-balance-transactions) for settlement data.
+   *
+   * The amount that will be settled to your account, converted to the currency your account is settled in. Only
+   * available once the payment is finalized and the final settlement amount has been determined.
    *
-   * Any amounts not settled by Mollie will not be reflected in this amount, e.g. PayPal or gift cards. If no amount is
-   * settled by Mollie the `settlementAmount` is omitted from the response.
+   * Amounts not settled by Mollie are not reflected here (e.g. PayPal or gift cards). If no amount is settled by
+   * Mollie, this field is omitted from the response.
    *
-   * Please note that this amount might be recalculated and changed when the status of the payment changes. We suggest
-   * using the List balance transactions endpoint instead to get more accurate settlement amounts for your payments.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   settlementAmount?: PaymentResponseSettlementAmount | undefined;
   /**

package/src/models/statusreason.ts

@@ -5,7 +5,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
-import { ClosedEnum } from "../types/enums.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";
 
@@ -143,7 +144,7 @@ export const Code = {
 /**
  * A machine-readable code that indicates the reason for the payment's status.
  */
-export type Code = ClosedEnum<typeof Code>;
+export type Code = OpenEnum<typeof Code>;
 
 /**
  * This object offers details about the status of a payment. Currently it is only available for point-of-sale
@@ -163,9 +164,8 @@ export type StatusReason = {
 };
 
 /** @internal */
-export const Code$inboundSchema: z.ZodNativeEnum<typeof Code> = z.nativeEnum(
-  Code,
-);
+export const Code$inboundSchema: z.ZodType<Code, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Code);
 
 /** @internal */
 export const StatusReason$inboundSchema: z.ZodType<