mollie-api-typescript 0.8.6 → 0.9.0

package/src/models/listsubscriptionresponse.ts

@@ -0,0 +1,447 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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,
+  Amount$inboundSchema,
+  Amount$Outbound,
+  Amount$outboundSchema,
+} from "./amount.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import {
+  Metadata,
+  Metadata$inboundSchema,
+  Metadata$Outbound,
+  Metadata$outboundSchema,
+} from "./metadata.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  SubscriptionMethodResponse,
+  SubscriptionMethodResponse$inboundSchema,
+  SubscriptionMethodResponse$outboundSchema,
+} from "./subscriptionmethodresponse.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+import {
+  UrlNullable,
+  UrlNullable$inboundSchema,
+  UrlNullable$Outbound,
+  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 ListSubscriptionResponseStatus = {
+  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 ListSubscriptionResponseStatus = OpenEnum<
+  typeof ListSubscriptionResponseStatus
+>;
+
+/**
+ * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+ *
+ * @remarks
+ * merchants.
+ *
+ * Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+ *
+ * Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+ * information.
+ */
+export type ListSubscriptionResponseApplicationFee = {
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  description: string;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListSubscriptionResponseLinks = {
+  /**
+   * 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.
+   */
+  customer: UrlNullable | null;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  mandate?: UrlNullable | null | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  profile: UrlNullable | null;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  payments?: UrlNullable | null | undefined;
+};
+
+export type ListSubscriptionResponse = {
+  /**
+   * Indicates the response contains a subscription object. Will always contain the string `subscription` for this
+   *
+   * @remarks
+   * 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;
+  status: ListSubscriptionResponseStatus;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * Total number of payments for the subscription. Once this number of payments is reached, the subscription is
+   *
+   * @remarks
+   * considered completed.
+   *
+   * Test mode subscriptions will get canceled automatically after 10 payments.
+   */
+  times: number | null;
+  /**
+   * Number of payments left for the subscription.
+   */
+  timesRemaining: number | null;
+  /**
+   * Interval to wait between payments, for example `1 month` or `14 days`.
+   *
+   * @remarks
+   *
+   * The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
+   *
+   * Possible values: `... days`, `... weeks`, `... months`.
+   */
+  interval: string;
+  /**
+   * The start date of the subscription in `YYYY-MM-DD` format.
+   */
+  startDate: string;
+  /**
+   * The date of the next scheduled payment in `YYYY-MM-DD` format. If the subscription has been completed or canceled,
+   *
+   * @remarks
+   * this parameter will not be returned.
+   */
+  nextPaymentDate?: string | null | undefined;
+  /**
+   * The subscription's description will be used as the description of the resulting individual payments and so showing
+   *
+   * @remarks
+   * up on the bank statement of the consumer.
+   *
+   * **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
+   */
+  description: string;
+  /**
+   * The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
+   */
+  method: SubscriptionMethodResponse | null;
+  /**
+   * With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
+   *
+   * @remarks
+   * merchants.
+   *
+   * Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
+   *
+   * Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
+   * information.
+   */
+  applicationFee?: ListSubscriptionResponseApplicationFee | undefined;
+  /**
+   * Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
+   *
+   * @remarks
+   * you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
+   */
+  metadata: Metadata | null;
+  /**
+   * We will call this URL for any payment status changes of payments resulting from this subscription.
+   *
+   * @remarks
+   *
+   * This webhook will receive **all** events for the subscription's payments. This may include payment failures as
+   * 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;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the
+   *
+   * @remarks
+   * subscription is not canceled (yet).
+   */
+  canceledAt?: string | null | undefined;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListSubscriptionResponseLinks;
+};
+
+/** @internal */
+export const ListSubscriptionResponseStatus$inboundSchema: z.ZodType<
+  ListSubscriptionResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListSubscriptionResponseStatus);
+/** @internal */
+export const ListSubscriptionResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListSubscriptionResponseStatus
+> = openEnums.outboundSchema(ListSubscriptionResponseStatus);
+
+/** @internal */
+export const ListSubscriptionResponseApplicationFee$inboundSchema: z.ZodType<
+  ListSubscriptionResponseApplicationFee,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: Amount$inboundSchema,
+  description: z.string(),
+});
+/** @internal */
+export type ListSubscriptionResponseApplicationFee$Outbound = {
+  amount: Amount$Outbound;
+  description: string;
+};
+
+/** @internal */
+export const ListSubscriptionResponseApplicationFee$outboundSchema: z.ZodType<
+  ListSubscriptionResponseApplicationFee$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionResponseApplicationFee
+> = z.object({
+  amount: Amount$outboundSchema,
+  description: z.string(),
+});
+
+export function listSubscriptionResponseApplicationFeeToJSON(
+  listSubscriptionResponseApplicationFee:
+    ListSubscriptionResponseApplicationFee,
+): string {
+  return JSON.stringify(
+    ListSubscriptionResponseApplicationFee$outboundSchema.parse(
+      listSubscriptionResponseApplicationFee,
+    ),
+  );
+}
+export function listSubscriptionResponseApplicationFeeFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSubscriptionResponseApplicationFee, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListSubscriptionResponseApplicationFee$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSubscriptionResponseApplicationFee' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSubscriptionResponseLinks$inboundSchema: z.ZodType<
+  ListSubscriptionResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema,
+  customer: z.nullable(UrlNullable$inboundSchema),
+  mandate: z.nullable(UrlNullable$inboundSchema).optional(),
+  profile: z.nullable(UrlNullable$inboundSchema),
+  payments: z.nullable(UrlNullable$inboundSchema).optional(),
+});
+/** @internal */
+export type ListSubscriptionResponseLinks$Outbound = {
+  self: Url$Outbound;
+  customer: UrlNullable$Outbound | null;
+  mandate?: UrlNullable$Outbound | null | undefined;
+  profile: UrlNullable$Outbound | null;
+  payments?: UrlNullable$Outbound | null | undefined;
+};
+
+/** @internal */
+export const ListSubscriptionResponseLinks$outboundSchema: z.ZodType<
+  ListSubscriptionResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionResponseLinks
+> = z.object({
+  self: Url$outboundSchema,
+  customer: z.nullable(UrlNullable$outboundSchema),
+  mandate: z.nullable(UrlNullable$outboundSchema).optional(),
+  profile: z.nullable(UrlNullable$outboundSchema),
+  payments: z.nullable(UrlNullable$outboundSchema).optional(),
+});
+
+export function listSubscriptionResponseLinksToJSON(
+  listSubscriptionResponseLinks: ListSubscriptionResponseLinks,
+): string {
+  return JSON.stringify(
+    ListSubscriptionResponseLinks$outboundSchema.parse(
+      listSubscriptionResponseLinks,
+    ),
+  );
+}
+export function listSubscriptionResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSubscriptionResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSubscriptionResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSubscriptionResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSubscriptionResponse$inboundSchema: z.ZodType<
+  ListSubscriptionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  status: ListSubscriptionResponseStatus$inboundSchema,
+  amount: Amount$inboundSchema,
+  times: z.nullable(z.number().int()),
+  timesRemaining: z.nullable(z.number().int()),
+  interval: z.string(),
+  startDate: z.string(),
+  nextPaymentDate: z.nullable(z.string()).optional(),
+  description: z.string(),
+  method: z.nullable(SubscriptionMethodResponse$inboundSchema),
+  applicationFee: z.lazy(() =>
+    ListSubscriptionResponseApplicationFee$inboundSchema
+  ).optional(),
+  metadata: z.nullable(Metadata$inboundSchema),
+  webhookUrl: z.string(),
+  customerId: z.string(),
+  mandateId: z.string().optional(),
+  createdAt: z.string(),
+  canceledAt: z.nullable(z.string()).optional(),
+  _links: z.lazy(() => ListSubscriptionResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListSubscriptionResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  status: string;
+  amount: Amount$Outbound;
+  times: number | null;
+  timesRemaining: number | null;
+  interval: string;
+  startDate: string;
+  nextPaymentDate?: string | null | undefined;
+  description: string;
+  method: string | null;
+  applicationFee?: ListSubscriptionResponseApplicationFee$Outbound | undefined;
+  metadata: Metadata$Outbound | null;
+  webhookUrl: string;
+  customerId: string;
+  mandateId?: string | undefined;
+  createdAt: string;
+  canceledAt?: string | null | undefined;
+  _links: ListSubscriptionResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListSubscriptionResponse$outboundSchema: z.ZodType<
+  ListSubscriptionResponse$Outbound,
+  z.ZodTypeDef,
+  ListSubscriptionResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  status: ListSubscriptionResponseStatus$outboundSchema,
+  amount: Amount$outboundSchema,
+  times: z.nullable(z.number().int()),
+  timesRemaining: z.nullable(z.number().int()),
+  interval: z.string(),
+  startDate: z.string(),
+  nextPaymentDate: z.nullable(z.string()).optional(),
+  description: z.string(),
+  method: z.nullable(SubscriptionMethodResponse$outboundSchema),
+  applicationFee: z.lazy(() =>
+    ListSubscriptionResponseApplicationFee$outboundSchema
+  ).optional(),
+  metadata: z.nullable(Metadata$outboundSchema),
+  webhookUrl: z.string(),
+  customerId: z.string(),
+  mandateId: z.string().optional(),
+  createdAt: z.string(),
+  canceledAt: z.nullable(z.string()).optional(),
+  links: z.lazy(() => ListSubscriptionResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listSubscriptionResponseToJSON(
+  listSubscriptionResponse: ListSubscriptionResponse,
+): string {
+  return JSON.stringify(
+    ListSubscriptionResponse$outboundSchema.parse(listSubscriptionResponse),
+  );
+}
+export function listSubscriptionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSubscriptionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSubscriptionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSubscriptionResponse' from JSON`,
+  );
+}

package/src/models/operations/listallmethods.ts

@@ -93,7 +93,7 @@ export type ListAllMethodsEmbedded = {
    * reference of the payment method object, refer to the [Get payment method endpoint](get-method)
    * documentation.
    */
-  methods: Array<models.EntityMethodAll>;
+  methods: Array<models.ListEntityMethodAll>;
 };
 
 export type ListAllMethodsLinks = {
@@ -235,11 +235,11 @@ export const ListAllMethodsEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  methods: z.array(models.EntityMethodAll$inboundSchema),
+  methods: z.array(models.ListEntityMethodAll$inboundSchema),
 });
 /** @internal */
 export type ListAllMethodsEmbedded$Outbound = {
-  methods: Array<models.EntityMethodAll$Outbound>;
+  methods: Array<models.ListEntityMethodAll$Outbound>;
 };
 
 /** @internal */
@@ -248,7 +248,7 @@ export const ListAllMethodsEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListAllMethodsEmbedded
 > = z.object({
-  methods: z.array(models.EntityMethodAll$outboundSchema),
+  methods: z.array(models.ListEntityMethodAll$outboundSchema),
 });
 
 export function listAllMethodsEmbeddedToJSON(

package/src/models/operations/listbalances.ts

@@ -61,7 +61,7 @@ export type ListBalancesEmbedded = {
    * @remarks
    * the balance object, refer to the [Get balance endpoint](get-balance) documentation.
    */
-  balances: Array<models.EntityBalance>;
+  balances: Array<models.ListEntityBalance>;
 };
 
 /**
@@ -192,11 +192,11 @@ export const ListBalancesEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  balances: z.array(models.EntityBalance$inboundSchema),
+  balances: z.array(models.ListEntityBalance$inboundSchema),
 });
 /** @internal */
 export type ListBalancesEmbedded$Outbound = {
-  balances: Array<models.EntityBalance$Outbound>;
+  balances: Array<models.ListEntityBalance$Outbound>;
 };
 
 /** @internal */
@@ -205,7 +205,7 @@ export const ListBalancesEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListBalancesEmbedded
 > = z.object({
-  balances: z.array(models.EntityBalance$outboundSchema),
+  balances: z.array(models.ListEntityBalance$outboundSchema),
 });
 
 export function listBalancesEmbeddedToJSON(

package/src/models/operations/listclients.ts

@@ -60,10 +60,6 @@ export type ListClientsLinks = {
    * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
   onboarding?: models.Url | undefined;
-  /**
-   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
-   */
-  documentation?: models.Url | undefined;
 };
 
 export type ClientEmbedded = {
@@ -237,14 +233,12 @@ export const ListClientsLinks$inboundSchema: z.ZodType<
   self: models.Url$inboundSchema,
   organization: models.Url$inboundSchema.optional(),
   onboarding: models.Url$inboundSchema.optional(),
-  documentation: models.Url$inboundSchema.optional(),
 });
 /** @internal */
 export type ListClientsLinks$Outbound = {
   self: models.Url$Outbound;
   organization?: models.Url$Outbound | undefined;
   onboarding?: models.Url$Outbound | undefined;
-  documentation?: models.Url$Outbound | undefined;
 };
 
 /** @internal */
@@ -256,7 +250,6 @@ export const ListClientsLinks$outboundSchema: z.ZodType<
   self: models.Url$outboundSchema,
   organization: models.Url$outboundSchema.optional(),
   onboarding: models.Url$outboundSchema.optional(),
-  documentation: models.Url$outboundSchema.optional(),
 });
 
 export function listClientsLinksToJSON(

package/src/models/operations/listcustomers.ts

@@ -61,7 +61,7 @@ export type ListCustomersEmbedded = {
   /**
    * An array of customer objects.
    */
-  customers: Array<models.CustomerResponse>;
+  customers: Array<models.ListCustomerResponse>;
 };
 
 /**
@@ -189,11 +189,11 @@ export const ListCustomersEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  customers: z.array(models.CustomerResponse$inboundSchema),
+  customers: z.array(models.ListCustomerResponse$inboundSchema),
 });
 /** @internal */
 export type ListCustomersEmbedded$Outbound = {
-  customers: Array<models.CustomerResponse$Outbound>;
+  customers: Array<models.ListCustomerResponse$Outbound>;
 };
 
 /** @internal */
@@ -202,7 +202,7 @@ export const ListCustomersEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListCustomersEmbedded
 > = z.object({
-  customers: z.array(models.CustomerResponse$outboundSchema),
+  customers: z.array(models.ListCustomerResponse$outboundSchema),
 });
 
 export function listCustomersEmbeddedToJSON(

package/src/models/operations/listinvoices.ts

@@ -49,8 +49,6 @@ export type ListInvoicesRequest = {
   idempotencyKey?: string | undefined;
 };
 
-export type Invoice = {};
-
 export type ListInvoicesEmbedded = {
   /**
    * An array of invoice objects. For a complete reference of
@@ -58,7 +56,7 @@ export type ListInvoicesEmbedded = {
    * @remarks
    * the invoice object, refer to the [Get invoice endpoint](get-invoice) documentation.
    */
-  invoices: Array<Invoice>;
+  invoices: Array<models.ListEntityInvoice>;
 };
 
 /**
@@ -150,43 +148,17 @@ export function listInvoicesRequestFromJSON(
   );
 }
 
-/** @internal */
-export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
-  z.object({});
-/** @internal */
-export type Invoice$Outbound = {};
-
-/** @internal */
-export const Invoice$outboundSchema: z.ZodType<
-  Invoice$Outbound,
-  z.ZodTypeDef,
-  Invoice
-> = z.object({});
-
-export function invoiceToJSON(invoice: Invoice): string {
-  return JSON.stringify(Invoice$outboundSchema.parse(invoice));
-}
-export function invoiceFromJSON(
-  jsonString: string,
-): SafeParseResult<Invoice, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Invoice$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Invoice' from JSON`,
-  );
-}
-
 /** @internal */
 export const ListInvoicesEmbedded$inboundSchema: z.ZodType<
   ListInvoicesEmbedded,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  invoices: z.array(z.lazy(() => Invoice$inboundSchema)),
+  invoices: z.array(models.ListEntityInvoice$inboundSchema),
 });
 /** @internal */
 export type ListInvoicesEmbedded$Outbound = {
-  invoices: Array<Invoice$Outbound>;
+  invoices: Array<models.ListEntityInvoice$Outbound>;
 };
 
 /** @internal */
@@ -195,7 +167,7 @@ export const ListInvoicesEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListInvoicesEmbedded
 > = z.object({
-  invoices: z.array(z.lazy(() => Invoice$outboundSchema)),
+  invoices: z.array(models.ListEntityInvoice$outboundSchema),
 });
 
 export function listInvoicesEmbeddedToJSON(

package/src/models/operations/listmandates.ts

@@ -65,7 +65,7 @@ export type ListMandatesEmbedded = {
   /**
    * An array of mandate objects.
    */
-  mandates: Array<models.MandateResponse>;
+  mandates: Array<models.ListMandateResponse>;
 };
 
 /**
@@ -196,11 +196,11 @@ export const ListMandatesEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  mandates: z.array(models.MandateResponse$inboundSchema),
+  mandates: z.array(models.ListMandateResponse$inboundSchema),
 });
 /** @internal */
 export type ListMandatesEmbedded$Outbound = {
-  mandates: Array<models.MandateResponse$Outbound>;
+  mandates: Array<models.ListMandateResponse$Outbound>;
 };
 
 /** @internal */
@@ -209,7 +209,7 @@ export const ListMandatesEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListMandatesEmbedded
 > = z.object({
-  mandates: z.array(models.MandateResponse$outboundSchema),
+  mandates: z.array(models.ListMandateResponse$outboundSchema),
 });
 
 export function listMandatesEmbeddedToJSON(