mollie-api-typescript 0.8.3 → 0.8.5

package/src/models/profileresponse.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 { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
@@ -13,11 +15,6 @@ import {
   ProfileReviewStatusResponse$inboundSchema,
   ProfileReviewStatusResponse$outboundSchema,
 } from "./profilereviewstatusresponse.js";
-import {
-  ProfileStatus,
-  ProfileStatus$inboundSchema,
-  ProfileStatus$outboundSchema,
-} from "./profilestatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -25,6 +22,31 @@ import {
   Url$outboundSchema,
 } from "./url.js";
 
+/**
+ * The profile status determines whether the profile is able to receive live payments.
+ *
+ * @remarks
+ *
+ * * `unverified`: The profile has not been verified yet and can only be used to create test payments.
+ * * `verified`: The profile has been verified and can be used to create live payments and test payments.
+ * * `blocked`: The profile is blocked and can no longer be used or changed.
+ */
+export const ProfileResponseStatus = {
+  Unverified: "unverified",
+  Verified: "verified",
+  Blocked: "blocked",
+} as const;
+/**
+ * The profile status determines whether the profile is able to receive live payments.
+ *
+ * @remarks
+ *
+ * * `unverified`: The profile has not been verified yet and can only be used to create test payments.
+ * * `verified`: The profile has been verified and can be used to create live payments and test payments.
+ * * `blocked`: The profile is blocked and can no longer be used or changed.
+ */
+export type ProfileResponseStatus = OpenEnum<typeof ProfileResponseStatus>;
+
 /**
  * Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
  *
@@ -130,16 +152,7 @@ export type ProfileResponse = {
    * [business category list](common-data-types#business-category) for all possible options.
    */
   businessCategory: string;
-  /**
-   * The profile status determines whether the profile is able to receive live payments.
-   *
-   * @remarks
-   *
-   * * `unverified`: The profile has not been verified yet and can only be used to create test payments.
-   * * `verified`: The profile has been verified and can be used to create live payments and test payments.
-   * * `blocked`: The profile is blocked and can no longer be used or changed.
-   */
-  status: ProfileStatus;
+  status: ProfileResponseStatus;
   /**
    * Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
    *
@@ -158,6 +171,19 @@ export type ProfileResponse = {
   links: ProfileResponseLinks;
 };
 
+/** @internal */
+export const ProfileResponseStatus$inboundSchema: z.ZodType<
+  ProfileResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ProfileResponseStatus);
+/** @internal */
+export const ProfileResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ProfileResponseStatus
+> = openEnums.outboundSchema(ProfileResponseStatus);
+
 /** @internal */
 export const Review$inboundSchema: z.ZodType<Review, z.ZodTypeDef, unknown> = z
   .object({
@@ -266,7 +292,7 @@ export const ProfileResponse$inboundSchema: z.ZodType<
   description: z.string().optional(),
   countriesOfActivity: z.array(z.string()).optional(),
   businessCategory: z.string(),
-  status: ProfileStatus$inboundSchema,
+  status: ProfileResponseStatus$inboundSchema,
   review: z.lazy(() => Review$inboundSchema).optional(),
   createdAt: z.string(),
   _links: z.lazy(() => ProfileResponseLinks$inboundSchema),
@@ -309,7 +335,7 @@ export const ProfileResponse$outboundSchema: z.ZodType<
   description: z.string().optional(),
   countriesOfActivity: z.array(z.string()).optional(),
   businessCategory: z.string(),
-  status: ProfileStatus$outboundSchema,
+  status: ProfileResponseStatus$outboundSchema,
   review: z.lazy(() => Review$outboundSchema).optional(),
   createdAt: z.string(),
   links: z.lazy(() => ProfileResponseLinks$outboundSchema),

package/src/models/refundrequest.ts

@@ -4,6 +4,7 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
 import { Result as SafeParseResult } from "../types/fp.js";
 import {
   Amount,
@@ -11,12 +12,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,
@@ -29,16 +24,6 @@ import {
   RefundExternalReferenceType$inboundSchema,
   RefundExternalReferenceType$outboundSchema,
 } from "./refundexternalreferencetype.js";
-import {
-  RefundRoutingReversalsSourceType,
-  RefundRoutingReversalsSourceType$inboundSchema,
-  RefundRoutingReversalsSourceType$outboundSchema,
-} from "./refundroutingreversalssourcetype.js";
-import {
-  RefundStatus,
-  RefundStatus$inboundSchema,
-  RefundStatus$outboundSchema,
-} from "./refundstatus.js";
 
 export type RefundRequestExternalReference = {
   /**
@@ -51,14 +36,22 @@ export type RefundRequestExternalReference = {
   id?: string | undefined;
 };
 
+/**
+ * The type of source. Currently only the source type `organization` is supported.
+ */
+export const Type = {
+  Organization: "organization",
+} as const;
+/**
+ * The type of source. Currently only the source type `organization` is supported.
+ */
+export type Type = ClosedEnum<typeof Type>;
+
 /**
  * Where the funds will be pulled back from.
  */
 export type RefundRequestSource = {
-  /**
-   * The type of source. Currently only the source type `organization` is supported.
-   */
-  type?: RefundRoutingReversalsSourceType | undefined;
+  type?: Type | undefined;
   organizationId?: string | undefined;
 };
 
@@ -74,7 +67,6 @@ export type RefundRequestRoutingReversal = {
 };
 
 export type RefundRequest = {
-  id: string;
   /**
    * The description of the refund that may be shown to your customer, depending on the payment method used.
    */
@@ -83,10 +75,6 @@ export type RefundRequest = {
    * 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.
-   */
-  settlementAmount?: AmountNullable | null | undefined;
   /**
    * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
    *
@@ -94,9 +82,6 @@ export type RefundRequest = {
    * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
    */
   metadata: Metadata | null;
-  paymentId?: string | undefined;
-  settlementId?: string | undefined;
-  status: RefundStatus;
   externalReference?: RefundRequestExternalReference | undefined;
   /**
    * *This feature is only available to marketplace operators.*
@@ -183,13 +168,21 @@ export function refundRequestExternalReferenceFromJSON(
   );
 }
 
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
 /** @internal */
 export const RefundRequestSource$inboundSchema: z.ZodType<
   RefundRequestSource,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: RefundRoutingReversalsSourceType$inboundSchema.optional(),
+  type: Type$inboundSchema.optional(),
   organizationId: z.string().optional(),
 });
 /** @internal */
@@ -204,7 +197,7 @@ export const RefundRequestSource$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RefundRequestSource
 > = z.object({
-  type: RefundRoutingReversalsSourceType$outboundSchema.optional(),
+  type: Type$outboundSchema.optional(),
   organizationId: z.string().optional(),
 });
 
@@ -275,14 +268,9 @@ export const RefundRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string(),
   description: z.string(),
   amount: Amount$inboundSchema,
-  settlementAmount: z.nullable(AmountNullable$inboundSchema).optional(),
   metadata: z.nullable(Metadata$inboundSchema),
-  paymentId: z.string().optional(),
-  settlementId: z.string().optional(),
-  status: RefundStatus$inboundSchema,
   externalReference: z.lazy(() => RefundRequestExternalReference$inboundSchema)
     .optional(),
   reverseRouting: z.nullable(z.boolean()).optional(),
@@ -293,14 +281,9 @@ export const RefundRequest$inboundSchema: z.ZodType<
 });
 /** @internal */
 export type RefundRequest$Outbound = {
-  id: string;
   description: string;
   amount: Amount$Outbound;
-  settlementAmount?: AmountNullable$Outbound | null | undefined;
   metadata: Metadata$Outbound | null;
-  paymentId?: string | undefined;
-  settlementId?: string | undefined;
-  status: string;
   externalReference?: RefundRequestExternalReference$Outbound | undefined;
   reverseRouting?: boolean | null | undefined;
   routingReversals?:
@@ -316,14 +299,9 @@ export const RefundRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RefundRequest
 > = z.object({
-  id: z.string(),
   description: z.string(),
   amount: Amount$outboundSchema,
-  settlementAmount: z.nullable(AmountNullable$outboundSchema).optional(),
   metadata: z.nullable(Metadata$outboundSchema),
-  paymentId: z.string().optional(),
-  settlementId: z.string().optional(),
-  status: RefundStatus$outboundSchema,
   externalReference: z.lazy(() => RefundRequestExternalReference$outboundSchema)
     .optional(),
   reverseRouting: z.nullable(z.boolean()).optional(),

package/src/models/routecreateresponse.ts

@@ -55,7 +55,19 @@ export type RouteCreateResponse = {
    * 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 assigns this identifier at route creation time. Mollie
+   *
+   * @remarks
+   * will always refer to the route by this ID. Example: `crt_dyARQ3JzCgtPDhU2Pbq3J`.
+   */
   id: string;
+  /**
+   * The unique identifier of the payment. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
   paymentId: string;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.

package/src/models/routegetresponse.ts

@@ -55,7 +55,19 @@ export type RouteGetResponse = {
    * 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 assigns this identifier at route creation time. Mollie
+   *
+   * @remarks
+   * will always refer to the route by this ID. Example: `crt_dyARQ3JzCgtPDhU2Pbq3J`.
+   */
   id: string;
+  /**
+   * The unique identifier of the payment. For example: `tr_5B8cwPMGnU6qLbRvo7qEZo`.
+   *
+   * @remarks
+   * The full payment object can be retrieved via the payment URL in the `_links` object.
+   */
   paymentId: string;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.

package/src/models/subscriptionrequest.ts

@@ -23,11 +23,6 @@ import {
   SubscriptionMethod$inboundSchema,
   SubscriptionMethod$outboundSchema,
 } from "./subscriptionmethod.js";
-import {
-  SubscriptionStatus,
-  SubscriptionStatus$inboundSchema,
-  SubscriptionStatus$outboundSchema,
-} from "./subscriptionstatus.js";
 
 /**
  * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
@@ -49,14 +44,6 @@ export type SubscriptionRequestApplicationFee = {
 };
 
 export type SubscriptionRequest = {
-  id?: string | undefined;
-  /**
-   * The subscription's current status is directly related to the status of the underlying customer or mandate that is
-   *
-   * @remarks
-   * enabling the subscription.
-   */
-  status?: SubscriptionStatus | undefined;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
@@ -125,7 +112,6 @@ export type SubscriptionRequest = {
    * well. Be sure to verify the payment's subscription ID and its status.
    */
   webhookUrl?: string | undefined;
-  customerId?: string | undefined;
   mandateId?: string | undefined;
   /**
    * Whether to create the entity in test mode or live mode.
@@ -189,8 +175,6 @@ export const SubscriptionRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
-  status: SubscriptionStatus$inboundSchema.optional(),
   amount: Amount$inboundSchema.optional(),
   times: z.nullable(z.number().int()).optional(),
   interval: z.string().optional(),
@@ -201,14 +185,11 @@ export const SubscriptionRequest$inboundSchema: z.ZodType<
     .optional(),
   metadata: z.nullable(Metadata$inboundSchema).optional(),
   webhookUrl: z.string().optional(),
-  customerId: z.string().optional(),
   mandateId: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
 });
 /** @internal */
 export type SubscriptionRequest$Outbound = {
-  id?: string | undefined;
-  status?: string | undefined;
   amount?: Amount$Outbound | undefined;
   times?: number | null | undefined;
   interval?: string | undefined;
@@ -218,7 +199,6 @@ export type SubscriptionRequest$Outbound = {
   applicationFee?: SubscriptionRequestApplicationFee$Outbound | undefined;
   metadata?: Metadata$Outbound | null | undefined;
   webhookUrl?: string | undefined;
-  customerId?: string | undefined;
   mandateId?: string | undefined;
   testmode?: boolean | null | undefined;
 };
@@ -229,8 +209,6 @@ export const SubscriptionRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SubscriptionRequest
 > = z.object({
-  id: z.string().optional(),
-  status: SubscriptionStatus$outboundSchema.optional(),
   amount: Amount$outboundSchema.optional(),
   times: z.nullable(z.number().int()).optional(),
   interval: z.string().optional(),
@@ -241,7 +219,6 @@ export const SubscriptionRequest$outboundSchema: z.ZodType<
     .optional(),
   metadata: z.nullable(Metadata$outboundSchema).optional(),
   webhookUrl: z.string().optional(),
-  customerId: z.string().optional(),
   mandateId: z.string().optional(),
   testmode: z.nullable(z.boolean()).optional(),
 });

package/src/models/subscriptionresponse.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,
@@ -25,11 +27,6 @@ import {
   SubscriptionMethodResponse$inboundSchema,
   SubscriptionMethodResponse$outboundSchema,
 } from "./subscriptionmethodresponse.js";
-import {
-  SubscriptionStatus,
-  SubscriptionStatus$inboundSchema,
-  SubscriptionStatus$outboundSchema,
-} from "./subscriptionstatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -43,6 +40,29 @@ import {
   UrlNullable$outboundSchema,
 } from "./urlnullable.js";
 
+/**
+ * The subscription's current status is directly related to the status of the underlying customer or mandate that is
+ *
+ * @remarks
+ * enabling the subscription.
+ */
+export const SubscriptionResponseStatus = {
+  Pending: "pending",
+  Active: "active",
+  Canceled: "canceled",
+  Suspended: "suspended",
+  Completed: "completed",
+} as const;
+/**
+ * The subscription's current status is directly related to the status of the underlying customer or mandate that is
+ *
+ * @remarks
+ * enabling the subscription.
+ */
+export type SubscriptionResponseStatus = OpenEnum<
+  typeof SubscriptionResponseStatus
+>;
+
 /**
  * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
  *
@@ -100,18 +120,15 @@ export type SubscriptionResponse = {
    * endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this subscription. Example: `sub_rVKGtNd6s3`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.
    */
   mode: Mode;
-  /**
-   * The subscription's current status is directly related to the status of the underlying customer or mandate that is
-   *
-   * @remarks
-   * enabling the subscription.
-   */
-  status: SubscriptionStatus;
+  status: SubscriptionResponseStatus;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
@@ -191,6 +208,9 @@ export type SubscriptionResponse = {
    * well. Be sure to verify the payment's subscription ID and its status.
    */
   webhookUrl: string;
+  /**
+   * The customer this subscription belongs to.
+   */
   customerId: string;
   mandateId?: string | undefined;
   /**
@@ -210,6 +230,19 @@ export type SubscriptionResponse = {
   links: SubscriptionResponseLinks;
 };
 
+/** @internal */
+export const SubscriptionResponseStatus$inboundSchema: z.ZodType<
+  SubscriptionResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(SubscriptionResponseStatus);
+/** @internal */
+export const SubscriptionResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  SubscriptionResponseStatus
+> = openEnums.outboundSchema(SubscriptionResponseStatus);
+
 /** @internal */
 export const SubscriptionResponseApplicationFee$inboundSchema: z.ZodType<
   SubscriptionResponseApplicationFee,
@@ -318,7 +351,7 @@ export const SubscriptionResponse$inboundSchema: z.ZodType<
   resource: z.string(),
   id: z.string(),
   mode: Mode$inboundSchema,
-  status: SubscriptionStatus$inboundSchema,
+  status: SubscriptionResponseStatus$inboundSchema,
   amount: Amount$inboundSchema,
   times: z.nullable(z.number().int()),
   timesRemaining: z.nullable(z.number().int()),
@@ -374,7 +407,7 @@ export const SubscriptionResponse$outboundSchema: z.ZodType<
   resource: z.string(),
   id: z.string(),
   mode: Mode$outboundSchema,
-  status: SubscriptionStatus$outboundSchema,
+  status: SubscriptionResponseStatus$outboundSchema,
   amount: Amount$outboundSchema,
   times: z.nullable(z.number().int()),
   timesRemaining: z.nullable(z.number().int()),