mollie-api-typescript 0.8.4 → 0.8.5

package/src/models/entitysalesinvoiceresponse.ts

@@ -6,12 +6,6 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.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 {
   SalesInvoiceDiscountResponse,
@@ -78,6 +72,76 @@ import {
  */
 export type EntitySalesInvoiceResponseMetadata = {};
 
+/**
+ * The amount that is left to be paid.
+ */
+export type AmountDue = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The total amount without VAT before discounts.
+ */
+export type SubtotalAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The total amount with VAT.
+ */
+export type TotalAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The total VAT amount.
+ */
+export type TotalVatAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
+/**
+ * The total amount without VAT after discounts.
+ */
+export type DiscountedSubtotalAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -116,6 +180,9 @@ export type EntitySalesInvoiceResponse = {
    * endpoint.
    */
   resource?: string | undefined;
+  /**
+   * The identifier uniquely referring to this invoice. Example: `invoice_4Y0eZitmBnQ6IDoMqZQKh`.
+   */
   id?: string | undefined;
   /**
    * When issued, an invoice number will be set for the sales invoice.
@@ -201,25 +268,25 @@ export type EntitySalesInvoiceResponse = {
   lines?: Array<SalesInvoiceLineItemResponse> | null | undefined;
   discount?: SalesInvoiceDiscountResponse | null | undefined;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The amount that is left to be paid.
    */
-  amountDue?: Amount | undefined;
+  amountDue?: AmountDue | undefined;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The total amount without VAT before discounts.
    */
-  subtotalAmount?: Amount | undefined;
+  subtotalAmount?: SubtotalAmount | undefined;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The total amount with VAT.
    */
-  totalAmount?: Amount | undefined;
+  totalAmount?: TotalAmount | undefined;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The total VAT amount.
    */
-  totalVatAmount?: Amount | undefined;
+  totalVatAmount?: TotalVatAmount | undefined;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The total amount without VAT after discounts.
    */
-  discountedSubtotalAmount?: Amount | undefined;
+  discountedSubtotalAmount?: DiscountedSubtotalAmount | undefined;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
@@ -287,6 +354,200 @@ export function entitySalesInvoiceResponseMetadataFromJSON(
   );
 }
 
+/** @internal */
+export const AmountDue$inboundSchema: z.ZodType<
+  AmountDue,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type AmountDue$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const AmountDue$outboundSchema: z.ZodType<
+  AmountDue$Outbound,
+  z.ZodTypeDef,
+  AmountDue
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function amountDueToJSON(amountDue: AmountDue): string {
+  return JSON.stringify(AmountDue$outboundSchema.parse(amountDue));
+}
+export function amountDueFromJSON(
+  jsonString: string,
+): SafeParseResult<AmountDue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AmountDue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AmountDue' from JSON`,
+  );
+}
+
+/** @internal */
+export const SubtotalAmount$inboundSchema: z.ZodType<
+  SubtotalAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type SubtotalAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const SubtotalAmount$outboundSchema: z.ZodType<
+  SubtotalAmount$Outbound,
+  z.ZodTypeDef,
+  SubtotalAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function subtotalAmountToJSON(subtotalAmount: SubtotalAmount): string {
+  return JSON.stringify(SubtotalAmount$outboundSchema.parse(subtotalAmount));
+}
+export function subtotalAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<SubtotalAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubtotalAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubtotalAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const TotalAmount$inboundSchema: z.ZodType<
+  TotalAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type TotalAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const TotalAmount$outboundSchema: z.ZodType<
+  TotalAmount$Outbound,
+  z.ZodTypeDef,
+  TotalAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function totalAmountToJSON(totalAmount: TotalAmount): string {
+  return JSON.stringify(TotalAmount$outboundSchema.parse(totalAmount));
+}
+export function totalAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<TotalAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TotalAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TotalAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const TotalVatAmount$inboundSchema: z.ZodType<
+  TotalVatAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type TotalVatAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const TotalVatAmount$outboundSchema: z.ZodType<
+  TotalVatAmount$Outbound,
+  z.ZodTypeDef,
+  TotalVatAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function totalVatAmountToJSON(totalVatAmount: TotalVatAmount): string {
+  return JSON.stringify(TotalVatAmount$outboundSchema.parse(totalVatAmount));
+}
+export function totalVatAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<TotalVatAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TotalVatAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TotalVatAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const DiscountedSubtotalAmount$inboundSchema: z.ZodType<
+  DiscountedSubtotalAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type DiscountedSubtotalAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const DiscountedSubtotalAmount$outboundSchema: z.ZodType<
+  DiscountedSubtotalAmount$Outbound,
+  z.ZodTypeDef,
+  DiscountedSubtotalAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function discountedSubtotalAmountToJSON(
+  discountedSubtotalAmount: DiscountedSubtotalAmount,
+): string {
+  return JSON.stringify(
+    DiscountedSubtotalAmount$outboundSchema.parse(discountedSubtotalAmount),
+  );
+}
+export function discountedSubtotalAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<DiscountedSubtotalAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DiscountedSubtotalAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DiscountedSubtotalAmount' from JSON`,
+  );
+}
+
 /** @internal */
 export const EntitySalesInvoiceResponseLinks$inboundSchema: z.ZodType<
   EntitySalesInvoiceResponseLinks,
@@ -371,11 +632,12 @@ export const EntitySalesInvoiceResponse$inboundSchema: z.ZodType<
   lines: z.nullable(z.array(SalesInvoiceLineItemResponse$inboundSchema))
     .optional(),
   discount: z.nullable(SalesInvoiceDiscountResponse$inboundSchema).optional(),
-  amountDue: Amount$inboundSchema.optional(),
-  subtotalAmount: Amount$inboundSchema.optional(),
-  totalAmount: Amount$inboundSchema.optional(),
-  totalVatAmount: Amount$inboundSchema.optional(),
-  discountedSubtotalAmount: Amount$inboundSchema.optional(),
+  amountDue: z.lazy(() => AmountDue$inboundSchema).optional(),
+  subtotalAmount: z.lazy(() => SubtotalAmount$inboundSchema).optional(),
+  totalAmount: z.lazy(() => TotalAmount$inboundSchema).optional(),
+  totalVatAmount: z.lazy(() => TotalVatAmount$inboundSchema).optional(),
+  discountedSubtotalAmount: z.lazy(() => DiscountedSubtotalAmount$inboundSchema)
+    .optional(),
   createdAt: z.string().optional(),
   issuedAt: z.nullable(z.string()).optional(),
   paidAt: z.nullable(z.string()).optional(),
@@ -409,11 +671,11 @@ export type EntitySalesInvoiceResponse$Outbound = {
   recipient?: SalesInvoiceRecipientResponse$Outbound | null | undefined;
   lines?: Array<SalesInvoiceLineItemResponse$Outbound> | null | undefined;
   discount?: SalesInvoiceDiscountResponse$Outbound | null | undefined;
-  amountDue?: Amount$Outbound | undefined;
-  subtotalAmount?: Amount$Outbound | undefined;
-  totalAmount?: Amount$Outbound | undefined;
-  totalVatAmount?: Amount$Outbound | undefined;
-  discountedSubtotalAmount?: Amount$Outbound | undefined;
+  amountDue?: AmountDue$Outbound | undefined;
+  subtotalAmount?: SubtotalAmount$Outbound | undefined;
+  totalAmount?: TotalAmount$Outbound | undefined;
+  totalVatAmount?: TotalVatAmount$Outbound | undefined;
+  discountedSubtotalAmount?: DiscountedSubtotalAmount$Outbound | undefined;
   createdAt?: string | undefined;
   issuedAt?: string | null | undefined;
   paidAt?: string | null | undefined;
@@ -450,11 +712,13 @@ export const EntitySalesInvoiceResponse$outboundSchema: z.ZodType<
   lines: z.nullable(z.array(SalesInvoiceLineItemResponse$outboundSchema))
     .optional(),
   discount: z.nullable(SalesInvoiceDiscountResponse$outboundSchema).optional(),
-  amountDue: Amount$outboundSchema.optional(),
-  subtotalAmount: Amount$outboundSchema.optional(),
-  totalAmount: Amount$outboundSchema.optional(),
-  totalVatAmount: Amount$outboundSchema.optional(),
-  discountedSubtotalAmount: Amount$outboundSchema.optional(),
+  amountDue: z.lazy(() => AmountDue$outboundSchema).optional(),
+  subtotalAmount: z.lazy(() => SubtotalAmount$outboundSchema).optional(),
+  totalAmount: z.lazy(() => TotalAmount$outboundSchema).optional(),
+  totalVatAmount: z.lazy(() => TotalVatAmount$outboundSchema).optional(),
+  discountedSubtotalAmount: z.lazy(() =>
+    DiscountedSubtotalAmount$outboundSchema
+  ).optional(),
   createdAt: z.string().optional(),
   issuedAt: z.nullable(z.string()).optional(),
   paidAt: z.nullable(z.string()).optional(),

package/src/models/entitysettlement.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,
@@ -24,11 +26,6 @@ import {
   PaymentMethod$inboundSchema,
   PaymentMethod$outboundSchema,
 } from "./paymentmethod.js";
-import {
-  SettlementStatus,
-  SettlementStatus$inboundSchema,
-  SettlementStatus$outboundSchema,
-} from "./settlementstatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -42,6 +39,34 @@ import {
   UrlNullable$outboundSchema,
 } from "./urlnullable.js";
 
+/**
+ * The status of the settlement.
+ */
+export const EntitySettlementStatus = {
+  Open: "open",
+  Pending: "pending",
+  Paidout: "paidout",
+  Failed: "failed",
+} as const;
+/**
+ * The status of the settlement.
+ */
+export type EntitySettlementStatus = OpenEnum<typeof EntitySettlementStatus>;
+
+/**
+ * The total amount of the settlement.
+ */
+export type EntitySettlementAmount = {
+  /**
+   * A three-character ISO 4217 currency code.
+   */
+  currency: string;
+  /**
+   * A string containing an exact monetary amount in the given currency.
+   */
+  value: string;
+};
+
 /**
  * The service rates, further divided into `fixed` and `percentage` costs.
  */
@@ -169,6 +194,9 @@ export type EntitySettlement = {
    * endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this settlement.
+   */
   id: string;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
@@ -187,16 +215,19 @@ export type EntitySettlement = {
    * date is available.
    */
   settledAt?: string | null | undefined;
+  status: EntitySettlementStatus;
   /**
-   * The status of the settlement.
+   * The total amount of the settlement.
    */
-  status: SettlementStatus;
+  amount: EntitySettlementAmount;
   /**
-   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   * The balance token that the settlement was settled to.
    */
-  amount: Amount;
   balanceId: string;
-  invoiceId?: string | undefined;
+  /**
+   * The ID of the oldest invoice created for all the periods, if the invoice has been created yet.
+   */
+  invoiceId?: string | null | undefined;
   /**
    * For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These
    *
@@ -218,6 +249,61 @@ export type EntitySettlement = {
   links: EntitySettlementLinks;
 };
 
+/** @internal */
+export const EntitySettlementStatus$inboundSchema: z.ZodType<
+  EntitySettlementStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntitySettlementStatus);
+/** @internal */
+export const EntitySettlementStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntitySettlementStatus
+> = openEnums.outboundSchema(EntitySettlementStatus);
+
+/** @internal */
+export const EntitySettlementAmount$inboundSchema: z.ZodType<
+  EntitySettlementAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+/** @internal */
+export type EntitySettlementAmount$Outbound = {
+  currency: string;
+  value: string;
+};
+
+/** @internal */
+export const EntitySettlementAmount$outboundSchema: z.ZodType<
+  EntitySettlementAmount$Outbound,
+  z.ZodTypeDef,
+  EntitySettlementAmount
+> = z.object({
+  currency: z.string(),
+  value: z.string(),
+});
+
+export function entitySettlementAmountToJSON(
+  entitySettlementAmount: EntitySettlementAmount,
+): string {
+  return JSON.stringify(
+    EntitySettlementAmount$outboundSchema.parse(entitySettlementAmount),
+  );
+}
+export function entitySettlementAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EntitySettlementAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntitySettlementAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntitySettlementAmount' from JSON`,
+  );
+}
+
 /** @internal */
 export const Rate$inboundSchema: z.ZodType<Rate, z.ZodTypeDef, unknown> = z
   .object({
@@ -453,10 +539,10 @@ export const EntitySettlement$inboundSchema: z.ZodType<
   createdAt: z.string().optional(),
   reference: z.nullable(z.string()).optional(),
   settledAt: z.nullable(z.string()).optional(),
-  status: SettlementStatus$inboundSchema,
-  amount: Amount$inboundSchema,
+  status: EntitySettlementStatus$inboundSchema,
+  amount: z.lazy(() => EntitySettlementAmount$inboundSchema),
   balanceId: z.string(),
-  invoiceId: z.string().optional(),
+  invoiceId: z.nullable(z.string()).optional(),
   periods: z.record(z.record(z.lazy(() => Periods$inboundSchema))).optional(),
   _links: z.lazy(() => EntitySettlementLinks$inboundSchema),
 }).transform((v) => {
@@ -472,9 +558,9 @@ export type EntitySettlement$Outbound = {
   reference?: string | null | undefined;
   settledAt?: string | null | undefined;
   status: string;
-  amount: Amount$Outbound;
+  amount: EntitySettlementAmount$Outbound;
   balanceId: string;
-  invoiceId?: string | undefined;
+  invoiceId?: string | null | undefined;
   periods?: { [k: string]: { [k: string]: Periods$Outbound } } | undefined;
   _links: EntitySettlementLinks$Outbound;
 };
@@ -490,10 +576,10 @@ export const EntitySettlement$outboundSchema: z.ZodType<
   createdAt: z.string().optional(),
   reference: z.nullable(z.string()).optional(),
   settledAt: z.nullable(z.string()).optional(),
-  status: SettlementStatus$outboundSchema,
-  amount: Amount$outboundSchema,
+  status: EntitySettlementStatus$outboundSchema,
+  amount: z.lazy(() => EntitySettlementAmount$outboundSchema),
   balanceId: z.string(),
-  invoiceId: z.string().optional(),
+  invoiceId: z.nullable(z.string()).optional(),
   periods: z.record(z.record(z.lazy(() => Periods$outboundSchema))).optional(),
   links: z.lazy(() => EntitySettlementLinks$outboundSchema),
 }).transform((v) => {

package/src/models/entityterminal.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";
@@ -18,11 +20,6 @@ import {
   TerminalModel$inboundSchema,
   TerminalModel$outboundSchema,
 } from "./terminalmodel.js";
-import {
-  TerminalStatus,
-  TerminalStatus$inboundSchema,
-  TerminalStatus$outboundSchema,
-} from "./terminalstatus.js";
 import {
   Url,
   Url$inboundSchema,
@@ -30,6 +27,19 @@ import {
   Url$outboundSchema,
 } from "./url.js";
 
+/**
+ * The status of the terminal.
+ */
+export const EntityTerminalStatus = {
+  Pending: "pending",
+  Active: "active",
+  Inactive: "inactive",
+} as const;
+/**
+ * The status of the terminal.
+ */
+export type EntityTerminalStatus = OpenEnum<typeof EntityTerminalStatus>;
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -49,6 +59,9 @@ export type EntityTerminal = {
    * Indicates the response contains a terminal object. Will always contain the string `terminal` for this endpoint.
    */
   resource: string;
+  /**
+   * The identifier uniquely referring to this terminal. Example: `term_7MgL4wea46qkRcoTZjWEH`.
+   */
   id: string;
   /**
    * Whether this entity was created in live mode or in test mode.
@@ -62,10 +75,7 @@ export type EntityTerminal = {
    * may be visible on the device itself depending on the device.
    */
   description: string;
-  /**
-   * The status of the terminal.
-   */
-  status: TerminalStatus;
+  status: EntityTerminalStatus;
   /**
    * The brand of the terminal.
    */
@@ -109,6 +119,19 @@ export type EntityTerminal = {
   links: EntityTerminalLinks;
 };
 
+/** @internal */
+export const EntityTerminalStatus$inboundSchema: z.ZodType<
+  EntityTerminalStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(EntityTerminalStatus);
+/** @internal */
+export const EntityTerminalStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  EntityTerminalStatus
+> = openEnums.outboundSchema(EntityTerminalStatus);
+
 /** @internal */
 export const EntityTerminalLinks$inboundSchema: z.ZodType<
   EntityTerminalLinks,
@@ -161,7 +184,7 @@ export const EntityTerminal$inboundSchema: z.ZodType<
   id: z.string(),
   mode: Mode$inboundSchema,
   description: z.string(),
-  status: TerminalStatus$inboundSchema,
+  status: EntityTerminalStatus$inboundSchema,
   brand: z.nullable(TerminalBrand$inboundSchema),
   model: z.nullable(TerminalModel$inboundSchema),
   serialNumber: z.nullable(z.string()),
@@ -202,7 +225,7 @@ export const EntityTerminal$outboundSchema: z.ZodType<
   id: z.string(),
   mode: Mode$outboundSchema,
   description: z.string(),
-  status: TerminalStatus$outboundSchema,
+  status: EntityTerminalStatus$outboundSchema,
   brand: z.nullable(TerminalBrand$outboundSchema),
   model: z.nullable(TerminalModel$outboundSchema),
   serialNumber: z.nullable(z.string()),