mollie-api-typescript 0.8.4 → 0.8.5

package/src/models/entitywebhookevent.ts

@@ -5,6 +5,8 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
@@ -25,11 +27,25 @@ import {
   Url$Outbound,
   Url$outboundSchema,
 } from "./url.js";
-import {
-  WebhookEventTypes,
-  WebhookEventTypes$inboundSchema,
-  WebhookEventTypes$outboundSchema,
-} from "./webhookeventtypes.js";
+
+/**
+ * The event's type
+ */
+export const EntityWebhookEventWebhookEventTypes = {
+  PaymentLinkPaid: "payment-link.paid",
+  BalanceTransactionCreated: "balance-transaction.created",
+  SalesInvoiceCreated: "sales-invoice.created",
+  SalesInvoiceIssued: "sales-invoice.issued",
+  SalesInvoiceCanceled: "sales-invoice.canceled",
+  SalesInvoicePaid: "sales-invoice.paid",
+  Wildcard: "*",
+} as const;
+/**
+ * The event's type
+ */
+export type EntityWebhookEventWebhookEventTypes = OpenEnum<
+  typeof EntityWebhookEventWebhookEventTypes
+>;
 
 export type Entity = PaymentLinkResponse | ProfileResponse;
 
@@ -67,10 +83,7 @@ export type EntityWebhookEvent = {
    * The identifier uniquely referring to this event.
    */
   id: string;
-  /**
-   * The event's type
-   */
-  webhookEventTypes: WebhookEventTypes;
+  webhookEventTypes: EntityWebhookEventWebhookEventTypes;
   /**
    * The entity token that triggered the event
    */
@@ -89,6 +102,19 @@ export type EntityWebhookEvent = {
   links: EntityWebhookEventLinks;
 };
 
+/** @internal */
+export const EntityWebhookEventWebhookEventTypes$inboundSchema: z.ZodType<
+  EntityWebhookEventWebhookEventTypes,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityWebhookEventWebhookEventTypes);
+/** @internal */
+export const EntityWebhookEventWebhookEventTypes$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityWebhookEventWebhookEventTypes
+> = openEnums.outboundSchema(EntityWebhookEventWebhookEventTypes);
+
 /** @internal */
 export const Entity$inboundSchema: z.ZodType<Entity, z.ZodTypeDef, unknown> = z
   .union([PaymentLinkResponse$inboundSchema, ProfileResponse$inboundSchema]);
@@ -214,7 +240,7 @@ export const EntityWebhookEvent$inboundSchema: z.ZodType<
 > = z.object({
   resource: z.string(),
   id: z.string(),
-  type: WebhookEventTypes$inboundSchema,
+  type: EntityWebhookEventWebhookEventTypes$inboundSchema,
   entityId: z.string(),
   createdAt: z.string(),
   _embedded: z.nullable(z.lazy(() => Embedded$inboundSchema)).optional(),
@@ -245,7 +271,7 @@ export const EntityWebhookEvent$outboundSchema: z.ZodType<
 > = z.object({
   resource: z.string(),
   id: z.string(),
-  webhookEventTypes: WebhookEventTypes$outboundSchema,
+  webhookEventTypes: EntityWebhookEventWebhookEventTypes$outboundSchema,
   entityId: z.string(),
   createdAt: z.string(),
   embedded: z.nullable(z.lazy(() => Embedded$outboundSchema)).optional(),

package/src/models/index.ts

@@ -5,13 +5,16 @@
 export * from "./address.js";
 export * from "./amount.js";
 export * from "./amountnullable.js";
+export * from "./balancecardaudience.js";
+export * from "./balancecardissuer.js";
+export * from "./balancecardregion.js";
+export * from "./balancefeetype.js";
+export * from "./balanceprepaymentparttype.js";
 export * from "./balancereportgrouping.js";
-export * from "./balancestatus.js";
 export * from "./balancetransactiontype.js";
 export * from "./balancetransfercategory.js";
 export * from "./balancetransfercategoryresponse.js";
 export * from "./balancetransferdestinationtype.js";
-export * from "./balancetransferfrequency.js";
 export * from "./balancetransferpartytype.js";
 export * from "./balancetransferpartytyperesponse.js";
 export * from "./balancetransferstatus.js";
@@ -23,7 +26,6 @@ export * from "./capabilitystatusreason.js";
 export * from "./capturemode.js";
 export * from "./capturemoderesponse.js";
 export * from "./captureresponse.js";
-export * from "./capturestatus.js";
 export * from "./clientlinkrequest.js";
 export * from "./clientlinkresponse.js";
 export * from "./componentssubtotals.js";
@@ -61,7 +63,6 @@ export * from "./entityterminal.js";
 export * from "./entitywebhook.js";
 export * from "./entitywebhookevent.js";
 export * from "./errorresponse.js";
-export * from "./invoicestatus.js";
 export * from "./linecategories.js";
 export * from "./linecategoriesresponse.js";
 export * from "./listlinks.js";
@@ -72,7 +73,6 @@ export * from "./mandatemethod.js";
 export * from "./mandatemethodresponse.js";
 export * from "./mandaterequest.js";
 export * from "./mandateresponse.js";
-export * from "./mandatestatus.js";
 export * from "./metadata.js";
 export * from "./method.js";
 export * from "./methodincludewalletsparameter.js";
@@ -80,7 +80,6 @@ export * from "./methodresourceparameter.js";
 export * from "./methodresponse.js";
 export * from "./methodstatus.js";
 export * from "./mode.js";
-export * from "./onboardingstatus.js";
 export * from "./onboardingvatregulation.js";
 export * from "./organizationvatregulation.js";
 export * from "./paymentaddress.js";
@@ -106,17 +105,13 @@ export * from "./paymentlinksequencetyperesponse.js";
 export * from "./paymentmethod.js";
 export * from "./paymentrequest.js";
 export * from "./paymentresponse.js";
-export * from "./paymentstatus.js";
 export * from "./profilerequest.js";
 export * from "./profileresponse.js";
 export * from "./profilereviewstatusresponse.js";
-export * from "./profilestatus.js";
 export * from "./recurringlineitem.js";
 export * from "./refundexternalreferencetype.js";
 export * from "./refundexternalreferencetyperesponse.js";
 export * from "./refundrequest.js";
-export * from "./refundroutingreversalssourcetype.js";
-export * from "./refundstatus.js";
 export * from "./routecreateresponse.js";
 export * from "./routedestinationtype.js";
 export * from "./routedestinationtyperesponse.js";
@@ -149,7 +144,6 @@ export * from "./salesinvoicevatschemeresponse.js";
 export * from "./security.js";
 export * from "./sequencetype.js";
 export * from "./sequencetyperesponse.js";
-export * from "./settlementstatus.js";
 export * from "./sorting.js";
 export * from "./statusreason.js";
 export * from "./subgroup.js";
@@ -157,11 +151,9 @@ export * from "./subscriptionmethod.js";
 export * from "./subscriptionmethodresponse.js";
 export * from "./subscriptionrequest.js";
 export * from "./subscriptionresponse.js";
-export * from "./subscriptionstatus.js";
 export * from "./subtotals.js";
 export * from "./terminalbrand.js";
 export * from "./terminalmodel.js";
-export * from "./terminalstatus.js";
 export * from "./updatevaluessalesinvoice.js";
 export * from "./url.js";
 export * from "./urlnullable.js";

package/src/models/mandaterequest.ts

@@ -11,13 +11,11 @@ import {
   MandateMethod$inboundSchema,
   MandateMethod$outboundSchema,
 } from "./mandatemethod.js";
-import {
-  MandateStatus,
-  MandateStatus$inboundSchema,
-  MandateStatus$outboundSchema,
-} from "./mandatestatus.js";
 
 export type MandateRequest = {
+  /**
+   * The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`.
+   */
   id?: string | undefined;
   /**
    * Payment method of the mandate.
@@ -68,14 +66,6 @@ export type MandateRequest = {
    * Must provide either this field or `paypalBillingAgreementId`, but not both.
    */
   payPalVaultId?: string | null | undefined;
-  /**
-   * The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
-   *
-   * @remarks
-   * when we did not received the IBAN yet from the first payment.
-   */
-  status?: MandateStatus | undefined;
-  customerId?: string | undefined;
   /**
    * Whether to create the entity in test mode or live mode.
    *
@@ -104,8 +94,6 @@ export const MandateRequest$inboundSchema: z.ZodType<
   mandateReference: z.nullable(z.string()).optional(),
   paypalBillingAgreementId: z.nullable(z.string()).optional(),
   payPalVaultId: z.nullable(z.string()).optional(),
-  status: MandateStatus$inboundSchema.optional(),
-  customerId: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
 });
 /** @internal */
@@ -120,8 +108,6 @@ export type MandateRequest$Outbound = {
   mandateReference?: string | null | undefined;
   paypalBillingAgreementId?: string | null | undefined;
   payPalVaultId?: string | null | undefined;
-  status?: string | undefined;
-  customerId?: string | undefined;
   testmode?: boolean | null | undefined;
 };
 
@@ -141,8 +127,6 @@ export const MandateRequest$outboundSchema: z.ZodType<
   mandateReference: z.nullable(z.string()).optional(),
   paypalBillingAgreementId: z.nullable(z.string()).optional(),
   payPalVaultId: z.nullable(z.string()).optional(),
-  status: MandateStatus$outboundSchema.optional(),
-  customerId: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
 });
 

package/src/models/mandateresponse.ts

@@ -5,6 +5,8 @@
 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 { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
@@ -17,11 +19,6 @@ import {
   MandateMethodResponse$inboundSchema,
   MandateMethodResponse$outboundSchema,
 } from "./mandatemethodresponse.js";
-import {
-  MandateStatus,
-  MandateStatus$inboundSchema,
-  MandateStatus$outboundSchema,
-} from "./mandatestatus.js";
 import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
 import {
   Url,
@@ -68,6 +65,25 @@ export type MandateResponseDetails = {
   cardFingerprint?: string | null | undefined;
 };
 
+/**
+ * The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
+ *
+ * @remarks
+ * when we did not received the IBAN yet from the first payment.
+ */
+export const MandateResponseStatus = {
+  Valid: "valid",
+  Pending: "pending",
+  Invalid: "invalid",
+} as const;
+/**
+ * The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
+ *
+ * @remarks
+ * when we did not received the IBAN yet from the first payment.
+ */
+export type MandateResponseStatus = OpenEnum<typeof MandateResponseStatus>;
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -91,6 +107,9 @@ export type MandateResponse = {
    * Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this mandate. Example: `mdt_pWUnw6pkBN`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.
@@ -116,13 +135,10 @@ export type MandateResponse = {
    * decline Direct Debit payments if the mandate reference is not unique.
    */
   mandateReference: string | null;
+  status: MandateResponseStatus;
   /**
-   * The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
-   *
-   * @remarks
-   * when we did not received the IBAN yet from the first payment.
+   * The identifier referring to the [customer](get-customer) this mandate was linked to.
    */
-  status: MandateStatus;
   customerId: string;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -196,6 +212,19 @@ export function mandateResponseDetailsFromJSON(
   );
 }
 
+/** @internal */
+export const MandateResponseStatus$inboundSchema: z.ZodType<
+  MandateResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(MandateResponseStatus);
+/** @internal */
+export const MandateResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  MandateResponseStatus
+> = openEnums.outboundSchema(MandateResponseStatus);
+
 /** @internal */
 export const MandateResponseLinks$inboundSchema: z.ZodType<
   MandateResponseLinks,
@@ -254,7 +283,7 @@ export const MandateResponse$inboundSchema: z.ZodType<
   details: z.lazy(() => MandateResponseDetails$inboundSchema),
   signatureDate: z.nullable(z.string()),
   mandateReference: z.nullable(z.string()),
-  status: MandateStatus$inboundSchema,
+  status: MandateResponseStatus$inboundSchema,
   customerId: z.string(),
   createdAt: z.string(),
   _links: z.lazy(() => MandateResponseLinks$inboundSchema),
@@ -291,7 +320,7 @@ export const MandateResponse$outboundSchema: z.ZodType<
   details: z.lazy(() => MandateResponseDetails$outboundSchema),
   signatureDate: z.nullable(z.string()),
   mandateReference: z.nullable(z.string()),
-  status: MandateStatus$outboundSchema,
+  status: MandateResponseStatus$outboundSchema,
   customerId: z.string(),
   createdAt: z.string(),
   links: z.lazy(() => MandateResponseLinks$outboundSchema),

package/src/models/operations/createpaymentlink.ts

@@ -34,7 +34,6 @@ export type ApplicationFee = {
 };
 
 export type CreatePaymentLinkRequestBody = {
-  id?: string | undefined;
   /**
    * A short description of the payment link. The description is visible in the Dashboard and will be shown on the
    *
@@ -202,7 +201,6 @@ export const CreatePaymentLinkRequestBody$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
   description: z.string(),
   amount: z.nullable(models.AmountNullable$inboundSchema).optional(),
   minimumAmount: z.nullable(models.AmountNullable$inboundSchema).optional(),
@@ -223,7 +221,6 @@ export const CreatePaymentLinkRequestBody$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type CreatePaymentLinkRequestBody$Outbound = {
-  id?: string | undefined;
   description: string;
   amount?: models.AmountNullable$Outbound | null | undefined;
   minimumAmount?: models.AmountNullable$Outbound | null | undefined;
@@ -248,7 +245,6 @@ export const CreatePaymentLinkRequestBody$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CreatePaymentLinkRequestBody
 > = z.object({
-  id: z.string().optional(),
   description: z.string(),
   amount: z.nullable(models.AmountNullable$outboundSchema).optional(),
   minimumAmount: z.nullable(models.AmountNullable$outboundSchema).optional(),

package/src/models/operations/getclient.ts

@@ -73,6 +73,9 @@ export type GetClientResponse = {
    * Indicates the response contains a client object. Will always contain the string `client` for this resource type.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this client. Example: `org_12345678`.
+   */
   id: string;
   /**
    * The commission object.

package/src/models/operations/getcustomer.ts

@@ -85,6 +85,9 @@ export type GetCustomerResponse = {
    * Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this customer. Example: `cst_vsKJpSsabw`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.

package/src/models/operations/listclients.ts

@@ -77,6 +77,9 @@ export type Client = {
    * Indicates the response contains a client object. Will always contain the string `client` for this resource type.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this client. Example: `org_12345678`.
+   */
   id: string;
   /**
    * The commission object.

package/src/models/paymentlinkresponse.ts

@@ -95,6 +95,9 @@ export type PaymentLinkResponse = {
    * endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this payment link. Example: `pl_4Y0eZitmBnQ6IDoMqZQKh`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.

package/src/models/paymentrequest.ts

@@ -283,7 +283,6 @@ export type Company = {
 };
 
 export type PaymentRequest = {
-  id?: string | undefined;
   /**
    * The description of the payment. This will be shown to your customer on their card or bank statement when possible.
    *
@@ -302,26 +301,6 @@ export type PaymentRequest = {
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
   amount: Amount;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  amountRefunded?: Amount | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  amountRemaining?: Amount | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  amountCaptured?: Amount | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  amountChargedBack?: Amount | undefined;
-  /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
-   */
-  settlementAmount?: Amount | undefined;
   /**
    * The URL your customer will be redirected to after the payment process.
    *
@@ -501,8 +480,15 @@ export type PaymentRequest = {
    */
   routing?: Array<EntityPaymentRoute> | null | undefined;
   sequenceType?: SequenceType | undefined;
-  subscriptionId?: string | undefined;
-  mandateId?: string | undefined;
+  /**
+   * **Only relevant for recurring payments.**
+   *
+   * @remarks
+   *
+   * When creating recurring payments, the ID of a specific [mandate](get-mandate) can be supplied to indicate which of
+   * the customer's accounts should be credited.
+   */
+  mandateId?: string | null | undefined;
   customerId?: string | undefined;
   /**
    * The identifier referring to the [profile](get-profile) this entity belongs to.
@@ -514,8 +500,6 @@ export type PaymentRequest = {
    * required.
    */
   profileId?: string | undefined;
-  settlementId?: string | undefined;
-  orderId?: string | undefined;
   /**
    * The date by which the payment should be completed in `YYYY-MM-DD` format
    */
@@ -849,14 +833,8 @@ export const PaymentRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
   description: z.string(),
   amount: Amount$inboundSchema,
-  amountRefunded: Amount$inboundSchema.optional(),
-  amountRemaining: Amount$inboundSchema.optional(),
-  amountCaptured: Amount$inboundSchema.optional(),
-  amountChargedBack: Amount$inboundSchema.optional(),
-  settlementAmount: Amount$inboundSchema.optional(),
   redirectUrl: z.nullable(z.string()),
   cancelUrl: z.nullable(z.string()).optional(),
   webhookUrl: z.nullable(z.string()).optional(),
@@ -877,12 +855,9 @@ export const PaymentRequest$inboundSchema: z.ZodType<
   ).optional(),
   routing: z.nullable(z.array(EntityPaymentRoute$inboundSchema)).optional(),
   sequenceType: SequenceType$inboundSchema.optional(),
-  subscriptionId: z.string().optional(),
-  mandateId: z.string().optional(),
+  mandateId: z.nullable(z.string()).optional(),
   customerId: z.string().optional(),
   profileId: z.string().optional(),
-  settlementId: z.string().optional(),
-  orderId: z.string().optional(),
   dueDate: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
   applePayPaymentToken: z.string().optional(),
@@ -899,14 +874,8 @@ export const PaymentRequest$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type PaymentRequest$Outbound = {
-  id?: string | undefined;
   description: string;
   amount: Amount$Outbound;
-  amountRefunded?: Amount$Outbound | undefined;
-  amountRemaining?: Amount$Outbound | undefined;
-  amountCaptured?: Amount$Outbound | undefined;
-  amountChargedBack?: Amount$Outbound | undefined;
-  settlementAmount?: Amount$Outbound | undefined;
   redirectUrl: string | null;
   cancelUrl?: string | null | undefined;
   webhookUrl?: string | null | undefined;
@@ -923,12 +892,9 @@ export type PaymentRequest$Outbound = {
   applicationFee?: PaymentRequestApplicationFee$Outbound | null | undefined;
   routing?: Array<EntityPaymentRoute$Outbound> | null | undefined;
   sequenceType?: string | undefined;
-  subscriptionId?: string | undefined;
-  mandateId?: string | undefined;
+  mandateId?: string | null | undefined;
   customerId?: string | undefined;
   profileId?: string | undefined;
-  settlementId?: string | undefined;
-  orderId?: string | undefined;
   dueDate?: string | undefined;
   testmode?: boolean | null | undefined;
   applePayPaymentToken?: string | undefined;
@@ -950,14 +916,8 @@ export const PaymentRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PaymentRequest
 > = z.object({
-  id: z.string().optional(),
   description: z.string(),
   amount: Amount$outboundSchema,
-  amountRefunded: Amount$outboundSchema.optional(),
-  amountRemaining: Amount$outboundSchema.optional(),
-  amountCaptured: Amount$outboundSchema.optional(),
-  amountChargedBack: Amount$outboundSchema.optional(),
-  settlementAmount: Amount$outboundSchema.optional(),
   redirectUrl: z.nullable(z.string()),
   cancelUrl: z.nullable(z.string()).optional(),
   webhookUrl: z.nullable(z.string()).optional(),
@@ -978,12 +938,9 @@ export const PaymentRequest$outboundSchema: z.ZodType<
   ).optional(),
   routing: z.nullable(z.array(EntityPaymentRoute$outboundSchema)).optional(),
   sequenceType: SequenceType$outboundSchema.optional(),
-  subscriptionId: z.string().optional(),
-  mandateId: z.string().optional(),
+  mandateId: z.nullable(z.string()).optional(),
   customerId: z.string().optional(),
   profileId: z.string().optional(),
-  settlementId: z.string().optional(),
-  orderId: z.string().optional(),
   dueDate: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
   applePayPaymentToken: z.string().optional(),