mollie-api-typescript 1.6.4 → 1.6.6

package/src/funcs/{verifyPayeesCreate.ts → verifyPayeeCreate.ts}

@@ -1,6 +1,6 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 10f27368a6f1
+ * @generated-id: b10476a7eab6
  */
 
 import { ClientCore } from "../core.js";
@@ -57,7 +57,7 @@ import { Result } from "../types/fp.js";
  *
  * If set, this operation will use {@link Security.organizationAccessToken} from the global security.
  */
-export function verifyPayeesCreate(
+export function verifyPayeeCreate(
   client: ClientCore,
   request?: operations.VerifyPayeeRequest | undefined,
   options?: RequestOptions,

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.6.4",
-  genVersion: "2.881.4",
+  sdkVersion: "1.6.6",
+  genVersion: "2.881.17",
   userAgent:
-    "speakeasy-sdk/typescript 1.6.4 2.881.4 1.0.0 mollie-api-typescript",
+    "speakeasy-sdk/typescript 1.6.6 2.881.17 1.0.0 mollie-api-typescript",
 } as const;

package/src/models/captureresponse.ts

@@ -20,14 +20,15 @@ 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
+ * **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.
  *
- * 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 that will be settled to your account for this capture, converted to the currency your account is
+ * settled in. Only available once the capture is finalized and the final settlement amount has been determined.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type CaptureResponseSettlementAmount = {
   /**
@@ -101,14 +102,15 @@ export type CaptureResponse = {
    */
   amount: AmountNullable | null;
   /**
-   * 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 for this capture, converted to the currency your account is
+   * settled in. Only available once the capture is finalized and the final settlement amount has been determined.
    *
-   * 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.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   settlementAmount?: CaptureResponseSettlementAmount | null | undefined;
   status: CaptureResponseStatus;

package/src/models/entitycapabilityrequirement.ts

@@ -27,8 +27,7 @@ export type EntityCapabilityRequirement = {
    *
    * @remarks
    * to enable or re-enable the capability. The name is unique among other requirements
-   * of the same capability. Requirements related to the onboarding process start with 'onboarding-', while
-   * requirements related to information requests start with 'information-request-'.
+   * of the same capability. Examples include `needs-data` and `process-first-payment`.
    */
   id: string;
   /**

package/src/models/entitychargeback.ts

@@ -13,16 +13,16 @@ 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 chargeback, converted to the currency your account is
+ * settled in. Always a **negative** amount. Only available once the chargeback is finalized and the final settlement
+ * amount has been determined.
  *
- * Since the field contains an estimated amount during chargeback processing, it may change over time. 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 EntityChargebackSettlementAmount = {
   /**
@@ -88,16 +88,16 @@ export type EntityChargeback = {
    */
   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 [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 chargeback, converted to the currency your account is
+   * settled in. Always a **negative** amount. Only available once the chargeback is finalized and the final settlement
+   * amount has been determined.
    *
-   * Since the field contains an estimated amount during chargeback processing, it may change over time. 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?: EntityChargebackSettlementAmount | null | undefined;
   /**

package/src/models/entityrefundresponse.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 EntityRefundResponseSettlementAmount = {
   /**
@@ -136,21 +133,18 @@ export type EntityRefundResponse = {
    */
   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?: EntityRefundResponseSettlementAmount | null | undefined;
   /**

package/src/models/index.ts

@@ -93,6 +93,7 @@ export * from "./listprofileresponse.js";
 export * from "./listroutegetresponse.js";
 export * from "./listsalesinvoiceresponse.js";
 export * from "./listsettlementcaptureresponse.js";
+export * from "./listsettlementchargebackresponse.js";
 export * from "./listsettlementpaymentresponse.js";
 export * from "./listsettlementrefundresponse.js";
 export * from "./listsubscriptionresponse.js";
@@ -171,6 +172,7 @@ export * from "./salesinvoicerequest.js";
 export * from "./salesinvoiceresponse.js";
 export * from "./salesinvoicestatus.js";
 export * from "./salesinvoicestatusresponse.js";
+export * from "./salesinvoicestatusupdate.js";
 export * from "./salesinvoicevatmode.js";
 export * from "./salesinvoicevatmoderesponse.js";
 export * from "./salesinvoicevatscheme.js";

package/src/models/listcaptureresponse.ts

@@ -20,14 +20,15 @@ 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
+ * **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.
  *
- * 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 that will be settled to your account for this capture, converted to the currency your account is
+ * settled in. Only available once the capture is finalized and the final settlement amount has been determined.
+ *
+ * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export type ListCaptureResponseSettlementAmount = {
   /**
@@ -99,14 +100,15 @@ export type ListCaptureResponse = {
    */
   amount: AmountNullable | null;
   /**
-   * 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 for this capture, converted to the currency your account is
+   * settled in. Only available once the capture is finalized and the final settlement amount has been determined.
    *
-   * 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.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   settlementAmount?: ListCaptureResponseSettlementAmount | null | undefined;
   status: ListCaptureResponseStatus;

package/src/models/listentitychargeback.ts

@@ -13,16 +13,16 @@ 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 chargeback, converted to the currency your account is
+ * settled in. Always a **negative** amount. Only available once the chargeback is finalized and the final settlement
+ * amount has been determined.
  *
- * Since the field contains an estimated amount during chargeback processing, it may change over time. 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 ListEntityChargebackSettlementAmount = {
   /**
@@ -84,16 +84,16 @@ export type ListEntityChargeback = {
    */
   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 [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 chargeback, converted to the currency your account is
+   * settled in. Always a **negative** amount. Only available once the chargeback is finalized and the final settlement
+   * amount has been determined.
    *
-   * Since the field contains an estimated amount during chargeback processing, it may change over time. 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?: ListEntityChargebackSettlementAmount | null | undefined;
   /**

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/listsalesinvoiceresponse.ts

@@ -182,9 +182,6 @@ export type ListSalesInvoiceResponse = {
    * the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to
    * mark it as paid. It can then subsequently be sent as well, same as with `issued`.
    *
-   * A status value that cannot be set but can be returned is `canceled`, for invoices which were
-   * issued, but then canceled. Currently this can only be done for invoices created in the dashboard.
-   *
    * Dependent parameters:
    *   - `paymentDetails` is required if invoice should be set directly to `paid`
    *   - `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
@@ -217,7 +214,13 @@ export type ListSalesInvoiceResponse = {
    * The payment term to be set on the invoice.
    */
   paymentTerm?: SalesInvoicePaymentTermResponse | null | undefined;
-  paymentDetails?: SalesInvoicePaymentDetailsResponse | undefined;
+  /**
+   * Used when setting an invoice to status of `paid`, and will store a payment that fully pays the invoice with the
+   *
+   * @remarks
+   * provided details. Required for `paid` status.
+   */
+  paymentDetails?: Array<SalesInvoicePaymentDetailsResponse> | undefined;
   emailDetails?: SalesInvoiceEmailDetails | null | undefined;
   /**
    * The identifier referring to the [customer](get-customer) you want to attempt an automated payment for. If
@@ -467,7 +470,8 @@ export const ListSalesInvoiceResponse$inboundSchema: z.ZodType<
   metadata: z.nullable(z.record(z.any())).optional(),
   paymentTerm: z.nullable(SalesInvoicePaymentTermResponse$inboundSchema)
     .optional(),
-  paymentDetails: SalesInvoicePaymentDetailsResponse$inboundSchema.optional(),
+  paymentDetails: z.array(SalesInvoicePaymentDetailsResponse$inboundSchema)
+    .optional(),
   emailDetails: z.nullable(SalesInvoiceEmailDetails$inboundSchema).optional(),
   customerId: z.string().optional(),
   mandateId: z.string().optional(),

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