mollie-api-typescript 0.8.4 → 0.8.6

package/src/models/entityonboardingstatus.ts

@@ -5,13 +5,10 @@
 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 {
-  OnboardingStatus,
-  OnboardingStatus$inboundSchema,
-  OnboardingStatus$outboundSchema,
-} from "./onboardingstatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -19,6 +16,21 @@ import {
   Url$outboundSchema,
 } from "./url.js";
 
+/**
+ * The current status of the organization's onboarding process.
+ */
+export const EntityOnboardingStatusStatus = {
+  NeedsData: "needs-data",
+  InReview: "in-review",
+  Completed: "completed",
+} as const;
+/**
+ * The current status of the organization's onboarding process.
+ */
+export type EntityOnboardingStatusStatus = OpenEnum<
+  typeof EntityOnboardingStatusStatus
+>;
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -53,10 +65,7 @@ export type EntityOnboardingStatus = {
    * The name of the organization.
    */
   name: string;
-  /**
-   * The current status of the organization's onboarding process.
-   */
-  status: OnboardingStatus;
+  status: EntityOnboardingStatusStatus;
   /**
    * Whether the organization can receive payments.
    */
@@ -75,6 +84,19 @@ export type EntityOnboardingStatus = {
   links: EntityOnboardingStatusLinks;
 };
 
+/** @internal */
+export const EntityOnboardingStatusStatus$inboundSchema: z.ZodType<
+  EntityOnboardingStatusStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityOnboardingStatusStatus);
+/** @internal */
+export const EntityOnboardingStatusStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityOnboardingStatusStatus
+> = openEnums.outboundSchema(EntityOnboardingStatusStatus);
+
 /** @internal */
 export const EntityOnboardingStatusLinks$inboundSchema: z.ZodType<
   EntityOnboardingStatusLinks,
@@ -133,7 +155,7 @@ export const EntityOnboardingStatus$inboundSchema: z.ZodType<
 > = z.object({
   resource: z.string(),
   name: z.string(),
-  status: OnboardingStatus$inboundSchema,
+  status: EntityOnboardingStatusStatus$inboundSchema,
   canReceivePayments: z.boolean(),
   canReceiveSettlements: z.boolean(),
   signedUpAt: z.string(),
@@ -162,7 +184,7 @@ export const EntityOnboardingStatus$outboundSchema: z.ZodType<
 > = z.object({
   resource: z.string(),
   name: z.string(),
-  status: OnboardingStatus$outboundSchema,
+  status: EntityOnboardingStatusStatus$outboundSchema,
   canReceivePayments: z.boolean(),
   canReceiveSettlements: z.boolean(),
   signedUpAt: z.string(),

package/src/models/entityorganization.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 {
   Address,
@@ -13,11 +15,6 @@ import {
   Address$outboundSchema,
 } from "./address.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-import {
-  LocaleResponse,
-  LocaleResponse$inboundSchema,
-  LocaleResponse$outboundSchema,
-} from "./localeresponse.js";
 import {
   OrganizationVatRegulation,
   OrganizationVatRegulation$inboundSchema,
@@ -30,6 +27,41 @@ import {
   Url$outboundSchema,
 } from "./url.js";
 
+/**
+ * The preferred locale of the merchant, as set in their Mollie dashboard.
+ */
+export const EntityOrganizationLocale = {
+  EnUS: "en_US",
+  EnGB: "en_GB",
+  NLNL: "nl_NL",
+  NlBE: "nl_BE",
+  DEDE: "de_DE",
+  DeAT: "de_AT",
+  DeCH: "de_CH",
+  FRFR: "fr_FR",
+  FrBE: "fr_BE",
+  ESES: "es_ES",
+  CaES: "ca_ES",
+  PTPT: "pt_PT",
+  ITIT: "it_IT",
+  NbNO: "nb_NO",
+  SvSE: "sv_SE",
+  FIFI: "fi_FI",
+  DaDK: "da_DK",
+  ISIS: "is_IS",
+  HUHU: "hu_HU",
+  PLPL: "pl_PL",
+  LVLV: "lv_LV",
+  LTLT: "lt_LT",
+  Null: "null",
+} as const;
+/**
+ * The preferred locale of the merchant, as set in their Mollie dashboard.
+ */
+export type EntityOrganizationLocale = OpenEnum<
+  typeof EntityOrganizationLocale
+>;
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -66,9 +98,9 @@ export type EntityOrganization = {
    */
   email: string;
   /**
-   * Allows you to preset the language to be used.
+   * The preferred locale of the merchant, as set in their Mollie dashboard.
    */
-  locale: LocaleResponse | null;
+  locale: EntityOrganizationLocale | null;
   address: Address;
   /**
    * The registration number of the organization at their local chamber of commerce.
@@ -98,6 +130,19 @@ export type EntityOrganization = {
   links: EntityOrganizationLinks;
 };
 
+/** @internal */
+export const EntityOrganizationLocale$inboundSchema: z.ZodType<
+  EntityOrganizationLocale,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityOrganizationLocale);
+/** @internal */
+export const EntityOrganizationLocale$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityOrganizationLocale
+> = openEnums.outboundSchema(EntityOrganizationLocale);
+
 /** @internal */
 export const EntityOrganizationLinks$inboundSchema: z.ZodType<
   EntityOrganizationLinks,
@@ -153,7 +198,7 @@ export const EntityOrganization$inboundSchema: z.ZodType<
   id: z.string(),
   name: z.string(),
   email: z.string(),
-  locale: z.nullable(LocaleResponse$inboundSchema),
+  locale: z.nullable(EntityOrganizationLocale$inboundSchema),
   address: Address$inboundSchema,
   registrationNumber: z.string(),
   vatNumber: z.nullable(z.string()).optional(),
@@ -188,7 +233,7 @@ export const EntityOrganization$outboundSchema: z.ZodType<
   id: z.string(),
   name: z.string(),
   email: z.string(),
-  locale: z.nullable(LocaleResponse$outboundSchema),
+  locale: z.nullable(EntityOrganizationLocale$outboundSchema),
   address: Address$outboundSchema,
   registrationNumber: z.string(),
   vatNumber: z.nullable(z.string()).optional(),

package/src/models/entitypaymentroute.ts

@@ -51,7 +51,6 @@ export type EntityPaymentRouteLinks = {
 };
 
 export type EntityPaymentRoute = {
-  id: string;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
@@ -167,7 +166,6 @@ export const EntityPaymentRoute$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string(),
   amount: Amount$inboundSchema,
   destination: z.lazy(() => EntityPaymentRouteDestination$inboundSchema),
   releaseDate: z.nullable(z.string()).optional(),
@@ -179,7 +177,6 @@ export const EntityPaymentRoute$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type EntityPaymentRoute$Outbound = {
-  id: string;
   amount: Amount$Outbound;
   destination: EntityPaymentRouteDestination$Outbound;
   releaseDate?: string | null | undefined;
@@ -192,7 +189,6 @@ export const EntityPaymentRoute$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityPaymentRoute
 > = z.object({
-  id: z.string(),
   amount: Amount$outboundSchema,
   destination: z.lazy(() => EntityPaymentRouteDestination$outboundSchema),
   releaseDate: z.nullable(z.string()).optional(),

package/src/models/entitypaymentrouteresponse.ts

@@ -56,6 +56,12 @@ export type EntityPaymentRouteResponse = {
    * Indicates the response contains a route object. Will always contain the string `route` for this endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this route. Mollie will always refer to the route by this ID.
+   *
+   * @remarks
+   * Example: `rt_5B8cwPMGnU6qLbRvo7qEZo`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.

package/src/models/entitypermission.ts

@@ -36,6 +36,9 @@ export type EntityPermission = {
    * endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this permission. Example: `payments.read`.
+   */
   id: string;
   /**
    * A short description of what kind of access the permission enables.

package/src/models/entityrefundresponse.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 {
   Amount,
@@ -12,12 +14,6 @@ import {
   Amount$Outbound,
   Amount$outboundSchema,
 } from "./amount.js";
-import {
-  AmountNullable,
-  AmountNullable$inboundSchema,
-  AmountNullable$Outbound,
-  AmountNullable$outboundSchema,
-} from "./amountnullable.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 import {
   Metadata,
@@ -31,16 +27,6 @@ import {
   RefundExternalReferenceTypeResponse$inboundSchema,
   RefundExternalReferenceTypeResponse$outboundSchema,
 } from "./refundexternalreferencetyperesponse.js";
-import {
-  RefundRoutingReversalsSourceType,
-  RefundRoutingReversalsSourceType$inboundSchema,
-  RefundRoutingReversalsSourceType$outboundSchema,
-} from "./refundroutingreversalssourcetype.js";
-import {
-  RefundStatus,
-  RefundStatus$inboundSchema,
-  RefundStatus$outboundSchema,
-} from "./refundstatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -54,6 +40,46 @@ import {
   UrlNullable$outboundSchema,
 } from "./urlnullable.js";
 
+/**
+ * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+ *
+ * @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.
+ *
+ * To retrieve accurate settlement amounts we recommend using the
+ * [List balance transactions endpoint](list-balance-transactions) instead.
+ */
+export type EntityRefundResponseSettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+export const EntityRefundResponseStatus = {
+  Queued: "queued",
+  Pending: "pending",
+  Processing: "processing",
+  Refunded: "refunded",
+  Failed: "failed",
+  Canceled: "canceled",
+} as const;
+export type EntityRefundResponseStatus = OpenEnum<
+  typeof EntityRefundResponseStatus
+>;
+
 export type EntityRefundResponseExternalReference = {
   /**
    * Specifies the reference type
@@ -69,10 +95,6 @@ export type EntityRefundResponseExternalReference = {
  * Where the funds will be pulled back from.
  */
 export type EntityRefundResponseSource = {
-  /**
-   * The type of source. Currently only the source type `organization` is supported.
-   */
-  type?: RefundRoutingReversalsSourceType | undefined;
   organizationId?: string | undefined;
 };
 
@@ -114,6 +136,12 @@ export type EntityRefundResponse = {
    * Indicates the response contains a refund object. Will always contain the string `refund` for this endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this refund. Mollie assigns this identifier at refund creation time. Mollie
+   *
+   * @remarks
+   * will always refer to the refund by this ID. Example: `re_4qqhO89gsT`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.
@@ -128,9 +156,23 @@ export type EntityRefundResponse = {
    */
   amount: Amount;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * This optional field will contain the approximate amount that will be deducted from your account balance, converted
+   *
+   * @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.
+   *
+   * To retrieve accurate settlement amounts we recommend using the
+   * [List balance transactions endpoint](list-balance-transactions) instead.
    */
-  settlementAmount?: AmountNullable | null | undefined;
+  settlementAmount?: EntityRefundResponseSettlementAmount | null | undefined;
   /**
    * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
    *
@@ -138,9 +180,18 @@ export type EntityRefundResponse = {
    * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
    */
   metadata: Metadata | null;
+  /**
+   * The unique identifier of the payment this refund was created for.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
   paymentId?: string | undefined;
-  settlementId?: string | undefined;
-  status: RefundStatus;
+  /**
+   * The identifier referring to the settlement this refund was settled with. This field is omitted if the refund is not settled (yet).
+   */
+  settlementId?: string | null | undefined;
+  status: EntityRefundResponseStatus;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
@@ -168,6 +219,64 @@ export type EntityRefundResponse = {
   links: EntityRefundResponseLinks;
 };
 
+/** @internal */
+export const EntityRefundResponseSettlementAmount$inboundSchema: z.ZodType<
+  EntityRefundResponseSettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type EntityRefundResponseSettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const EntityRefundResponseSettlementAmount$outboundSchema: z.ZodType<
+  EntityRefundResponseSettlementAmount$Outbound,
+  z.ZodTypeDef,
+  EntityRefundResponseSettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function entityRefundResponseSettlementAmountToJSON(
+  entityRefundResponseSettlementAmount: EntityRefundResponseSettlementAmount,
+): string {
+  return JSON.stringify(
+    EntityRefundResponseSettlementAmount$outboundSchema.parse(
+      entityRefundResponseSettlementAmount,
+    ),
+  );
+}
+export function entityRefundResponseSettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityRefundResponseSettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityRefundResponseSettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityRefundResponseSettlementAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityRefundResponseStatus$inboundSchema: z.ZodType<
+  EntityRefundResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityRefundResponseStatus);
+/** @internal */
+export const EntityRefundResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityRefundResponseStatus
+> = openEnums.outboundSchema(EntityRefundResponseStatus);
+
 /** @internal */
 export const EntityRefundResponseExternalReference$inboundSchema: z.ZodType<
   EntityRefundResponseExternalReference,
@@ -219,12 +328,10 @@ export const EntityRefundResponseSource$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: RefundRoutingReversalsSourceType$inboundSchema.optional(),
   organizationId: z.string().optional(),
 });
 /** @internal */
 export type EntityRefundResponseSource$Outbound = {
-  type?: string | undefined;
   organizationId?: string | undefined;
 };
 
@@ -234,7 +341,6 @@ export const EntityRefundResponseSource$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityRefundResponseSource
 > = z.object({
-  type: RefundRoutingReversalsSourceType$outboundSchema.optional(),
   organizationId: z.string().optional(),
 });
 
@@ -359,11 +465,13 @@ export const EntityRefundResponse$inboundSchema: z.ZodType<
   mode: Mode$inboundSchema,
   description: z.string(),
   amount: Amount$inboundSchema,
-  settlementAmount: z.nullable(AmountNullable$inboundSchema).optional(),
+  settlementAmount: z.nullable(
+    z.lazy(() => EntityRefundResponseSettlementAmount$inboundSchema),
+  ).optional(),
   metadata: z.nullable(Metadata$inboundSchema),
   paymentId: z.string().optional(),
-  settlementId: z.string().optional(),
-  status: RefundStatus$inboundSchema,
+  settlementId: z.nullable(z.string()).optional(),
+  status: EntityRefundResponseStatus$inboundSchema,
   createdAt: z.string(),
   externalReference: z.lazy(() =>
     EntityRefundResponseExternalReference$inboundSchema
@@ -384,10 +492,13 @@ export type EntityRefundResponse$Outbound = {
   mode: string;
   description: string;
   amount: Amount$Outbound;
-  settlementAmount?: AmountNullable$Outbound | null | undefined;
+  settlementAmount?:
+    | EntityRefundResponseSettlementAmount$Outbound
+    | null
+    | undefined;
   metadata: Metadata$Outbound | null;
   paymentId?: string | undefined;
-  settlementId?: string | undefined;
+  settlementId?: string | null | undefined;
   status: string;
   createdAt: string;
   externalReference?:
@@ -411,11 +522,13 @@ export const EntityRefundResponse$outboundSchema: z.ZodType<
   mode: Mode$outboundSchema,
   description: z.string(),
   amount: Amount$outboundSchema,
-  settlementAmount: z.nullable(AmountNullable$outboundSchema).optional(),
+  settlementAmount: z.nullable(
+    z.lazy(() => EntityRefundResponseSettlementAmount$outboundSchema),
+  ).optional(),
   metadata: z.nullable(Metadata$outboundSchema),
   paymentId: z.string().optional(),
-  settlementId: z.string().optional(),
-  status: RefundStatus$outboundSchema,
+  settlementId: z.nullable(z.string()).optional(),
+  status: EntityRefundResponseStatus$outboundSchema,
   createdAt: z.string(),
   externalReference: z.lazy(() =>
     EntityRefundResponseExternalReference$outboundSchema

package/src/models/entityroute.ts

@@ -30,8 +30,6 @@ export type EntityRouteDestination = {
 };
 
 export type EntityRoute = {
-  id?: string | undefined;
-  paymentId?: string | undefined;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
@@ -104,8 +102,6 @@ export const EntityRoute$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
-  paymentId: z.string().optional(),
   amount: Amount$inboundSchema.optional(),
   description: z.string().optional(),
   destination: z.lazy(() => EntityRouteDestination$inboundSchema).optional(),
@@ -113,8 +109,6 @@ export const EntityRoute$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type EntityRoute$Outbound = {
-  id?: string | undefined;
-  paymentId?: string | undefined;
   amount?: Amount$Outbound | undefined;
   description?: string | undefined;
   destination?: EntityRouteDestination$Outbound | undefined;
@@ -127,8 +121,6 @@ export const EntityRoute$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityRoute
 > = z.object({
-  id: z.string().optional(),
-  paymentId: z.string().optional(),
   amount: Amount$outboundSchema.optional(),
   description: z.string().optional(),
   destination: z.lazy(() => EntityRouteDestination$outboundSchema).optional(),