mollie-api-typescript 0.2.4 → 0.2.6

package/src/models/entitysettlement.ts

@@ -12,7 +12,18 @@ 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 {
+  PaymentMethod,
+  PaymentMethod$inboundSchema,
+  PaymentMethod$outboundSchema,
+} from "./paymentmethod.js";
 import {
   SettlementStatus,
   SettlementStatus$inboundSchema,
@@ -31,6 +42,91 @@ import {
   UrlNullable$outboundSchema,
 } from "./urlnullable.js";
 
+/**
+ * The service rates, further divided into `fixed` and `percentage` costs.
+ */
+export type Rate = {
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  fixed?: Amount | undefined;
+  percentage?: string | undefined;
+};
+
+export type Cost = {
+  /**
+   * A description of the cost subtotal
+   */
+  description: string;
+  /**
+   * The payment method, if applicable
+   */
+  method: PaymentMethod | null;
+  /**
+   * The number of fees
+   */
+  count: number;
+  /**
+   * The service rates, further divided into `fixed` and `percentage` costs.
+   */
+  rate: Rate;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountNet: Amount;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountVat: Amount;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountGross: Amount;
+};
+
+export type Revenue = {
+  /**
+   * A description of the revenue subtotal
+   */
+  description: string;
+  /**
+   * The payment method, if applicable
+   */
+  method: PaymentMethod | null;
+  /**
+   * The number of payments
+   */
+  count: number;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountNet: Amount;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountVat: AmountNullable | null;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amountGross: Amount;
+};
+
+export type Periods = {
+  /**
+   * An array of cost objects, describing the fees withheld for each payment method during this period.
+   */
+  costs?: Array<Cost> | undefined;
+  /**
+   * An array of revenue objects containing the total revenue for each payment method during this period.
+   */
+  revenue?: Array<Revenue> | undefined;
+  invoiceId?: string | undefined;
+  /**
+   * The invoice reference, if the invoice has been created already.
+   */
+  invoiceReference?: string | null | undefined;
+};
+
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
@@ -38,7 +134,7 @@ export type EntitySettlementLinks = {
   /**
    * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
-  self?: Url | undefined;
+  self: Url;
   /**
    * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
@@ -72,8 +168,8 @@ export type EntitySettlement = {
    * @remarks
    * endpoint.
    */
-  resource?: string | undefined;
-  id?: string | undefined;
+  resource: string;
+  id: string;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
@@ -94,12 +190,12 @@ export type EntitySettlement = {
   /**
    * The status of the settlement.
    */
-  status?: SettlementStatus | undefined;
+  status: SettlementStatus;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  amount?: Amount | undefined;
-  balanceId?: string | undefined;
+  amount: Amount;
+  balanceId: string;
   invoiceId?: string | undefined;
   /**
    * For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These
@@ -115,20 +211,247 @@ export type EntitySettlement = {
    *
    * The example response should give a good idea of what this looks like in practise.
    */
-  periods?: { [k: string]: any } | undefined;
+  periods?: { [k: string]: { [k: string]: Periods } } | undefined;
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links?: EntitySettlementLinks | undefined;
+  links: EntitySettlementLinks;
+};
+
+/** @internal */
+export const Rate$inboundSchema: z.ZodType<Rate, z.ZodTypeDef, unknown> = z
+  .object({
+    fixed: Amount$inboundSchema.optional(),
+    percentage: z.string().optional(),
+  });
+
+/** @internal */
+export type Rate$Outbound = {
+  fixed?: Amount$Outbound | undefined;
+  percentage?: string | undefined;
+};
+
+/** @internal */
+export const Rate$outboundSchema: z.ZodType<Rate$Outbound, z.ZodTypeDef, Rate> =
+  z.object({
+    fixed: Amount$outboundSchema.optional(),
+    percentage: z.string().optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Rate$ {
+  /** @deprecated use `Rate$inboundSchema` instead. */
+  export const inboundSchema = Rate$inboundSchema;
+  /** @deprecated use `Rate$outboundSchema` instead. */
+  export const outboundSchema = Rate$outboundSchema;
+  /** @deprecated use `Rate$Outbound` instead. */
+  export type Outbound = Rate$Outbound;
+}
+
+export function rateToJSON(rate: Rate): string {
+  return JSON.stringify(Rate$outboundSchema.parse(rate));
+}
+
+export function rateFromJSON(
+  jsonString: string,
+): SafeParseResult<Rate, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Rate$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Rate' from JSON`,
+  );
+}
+
+/** @internal */
+export const Cost$inboundSchema: z.ZodType<Cost, z.ZodTypeDef, unknown> = z
+  .object({
+    description: z.string(),
+    method: z.nullable(PaymentMethod$inboundSchema),
+    count: z.number().int(),
+    rate: z.lazy(() => Rate$inboundSchema),
+    amountNet: Amount$inboundSchema,
+    amountVat: Amount$inboundSchema,
+    amountGross: Amount$inboundSchema,
+  });
+
+/** @internal */
+export type Cost$Outbound = {
+  description: string;
+  method: string | null;
+  count: number;
+  rate: Rate$Outbound;
+  amountNet: Amount$Outbound;
+  amountVat: Amount$Outbound;
+  amountGross: Amount$Outbound;
+};
+
+/** @internal */
+export const Cost$outboundSchema: z.ZodType<Cost$Outbound, z.ZodTypeDef, Cost> =
+  z.object({
+    description: z.string(),
+    method: z.nullable(PaymentMethod$outboundSchema),
+    count: z.number().int(),
+    rate: z.lazy(() => Rate$outboundSchema),
+    amountNet: Amount$outboundSchema,
+    amountVat: Amount$outboundSchema,
+    amountGross: Amount$outboundSchema,
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Cost$ {
+  /** @deprecated use `Cost$inboundSchema` instead. */
+  export const inboundSchema = Cost$inboundSchema;
+  /** @deprecated use `Cost$outboundSchema` instead. */
+  export const outboundSchema = Cost$outboundSchema;
+  /** @deprecated use `Cost$Outbound` instead. */
+  export type Outbound = Cost$Outbound;
+}
+
+export function costToJSON(cost: Cost): string {
+  return JSON.stringify(Cost$outboundSchema.parse(cost));
+}
+
+export function costFromJSON(
+  jsonString: string,
+): SafeParseResult<Cost, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Cost$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Cost' from JSON`,
+  );
+}
+
+/** @internal */
+export const Revenue$inboundSchema: z.ZodType<Revenue, z.ZodTypeDef, unknown> =
+  z.object({
+    description: z.string(),
+    method: z.nullable(PaymentMethod$inboundSchema),
+    count: z.number().int(),
+    amountNet: Amount$inboundSchema,
+    amountVat: z.nullable(AmountNullable$inboundSchema),
+    amountGross: Amount$inboundSchema,
+  });
+
+/** @internal */
+export type Revenue$Outbound = {
+  description: string;
+  method: string | null;
+  count: number;
+  amountNet: Amount$Outbound;
+  amountVat: AmountNullable$Outbound | null;
+  amountGross: Amount$Outbound;
+};
+
+/** @internal */
+export const Revenue$outboundSchema: z.ZodType<
+  Revenue$Outbound,
+  z.ZodTypeDef,
+  Revenue
+> = z.object({
+  description: z.string(),
+  method: z.nullable(PaymentMethod$outboundSchema),
+  count: z.number().int(),
+  amountNet: Amount$outboundSchema,
+  amountVat: z.nullable(AmountNullable$outboundSchema),
+  amountGross: Amount$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Revenue$ {
+  /** @deprecated use `Revenue$inboundSchema` instead. */
+  export const inboundSchema = Revenue$inboundSchema;
+  /** @deprecated use `Revenue$outboundSchema` instead. */
+  export const outboundSchema = Revenue$outboundSchema;
+  /** @deprecated use `Revenue$Outbound` instead. */
+  export type Outbound = Revenue$Outbound;
+}
+
+export function revenueToJSON(revenue: Revenue): string {
+  return JSON.stringify(Revenue$outboundSchema.parse(revenue));
+}
+
+export function revenueFromJSON(
+  jsonString: string,
+): SafeParseResult<Revenue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Revenue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Revenue' from JSON`,
+  );
+}
+
+/** @internal */
+export const Periods$inboundSchema: z.ZodType<Periods, z.ZodTypeDef, unknown> =
+  z.object({
+    costs: z.array(z.lazy(() => Cost$inboundSchema)).optional(),
+    revenue: z.array(z.lazy(() => Revenue$inboundSchema)).optional(),
+    invoiceId: z.string().optional(),
+    invoiceReference: z.nullable(z.string()).optional(),
+  });
+
+/** @internal */
+export type Periods$Outbound = {
+  costs?: Array<Cost$Outbound> | undefined;
+  revenue?: Array<Revenue$Outbound> | undefined;
+  invoiceId?: string | undefined;
+  invoiceReference?: string | null | undefined;
 };
 
+/** @internal */
+export const Periods$outboundSchema: z.ZodType<
+  Periods$Outbound,
+  z.ZodTypeDef,
+  Periods
+> = z.object({
+  costs: z.array(z.lazy(() => Cost$outboundSchema)).optional(),
+  revenue: z.array(z.lazy(() => Revenue$outboundSchema)).optional(),
+  invoiceId: z.string().optional(),
+  invoiceReference: z.nullable(z.string()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Periods$ {
+  /** @deprecated use `Periods$inboundSchema` instead. */
+  export const inboundSchema = Periods$inboundSchema;
+  /** @deprecated use `Periods$outboundSchema` instead. */
+  export const outboundSchema = Periods$outboundSchema;
+  /** @deprecated use `Periods$Outbound` instead. */
+  export type Outbound = Periods$Outbound;
+}
+
+export function periodsToJSON(periods: Periods): string {
+  return JSON.stringify(Periods$outboundSchema.parse(periods));
+}
+
+export function periodsFromJSON(
+  jsonString: string,
+): SafeParseResult<Periods, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Periods$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Periods' from JSON`,
+  );
+}
+
 /** @internal */
 export const EntitySettlementLinks$inboundSchema: z.ZodType<
   EntitySettlementLinks,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  self: Url$inboundSchema.optional(),
+  self: Url$inboundSchema,
   payments: Url$inboundSchema.optional(),
   captures: Url$inboundSchema.optional(),
   refunds: Url$inboundSchema.optional(),
@@ -139,7 +462,7 @@ export const EntitySettlementLinks$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntitySettlementLinks$Outbound = {
-  self?: Url$Outbound | undefined;
+  self: Url$Outbound;
   payments?: Url$Outbound | undefined;
   captures?: Url$Outbound | undefined;
   refunds?: Url$Outbound | undefined;
@@ -154,7 +477,7 @@ export const EntitySettlementLinks$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntitySettlementLinks
 > = z.object({
-  self: Url$outboundSchema.optional(),
+  self: Url$outboundSchema,
   payments: Url$outboundSchema.optional(),
   captures: Url$outboundSchema.optional(),
   refunds: Url$outboundSchema.optional(),
@@ -200,17 +523,17 @@ export const EntitySettlement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
+  resource: z.string(),
+  id: z.string(),
   createdAt: z.string().optional(),
   reference: z.nullable(z.string()).optional(),
   settledAt: z.nullable(z.string()).optional(),
-  status: SettlementStatus$inboundSchema.optional(),
-  amount: Amount$inboundSchema.optional(),
-  balanceId: z.string().optional(),
+  status: SettlementStatus$inboundSchema,
+  amount: Amount$inboundSchema,
+  balanceId: z.string(),
   invoiceId: z.string().optional(),
-  periods: z.record(z.any()).optional(),
-  _links: z.lazy(() => EntitySettlementLinks$inboundSchema).optional(),
+  periods: z.record(z.record(z.lazy(() => Periods$inboundSchema))).optional(),
+  _links: z.lazy(() => EntitySettlementLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -219,17 +542,17 @@ export const EntitySettlement$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntitySettlement$Outbound = {
-  resource?: string | undefined;
-  id?: string | undefined;
+  resource: string;
+  id: string;
   createdAt?: string | undefined;
   reference?: string | null | undefined;
   settledAt?: string | null | undefined;
-  status?: string | undefined;
-  amount?: Amount$Outbound | undefined;
-  balanceId?: string | undefined;
+  status: string;
+  amount: Amount$Outbound;
+  balanceId: string;
   invoiceId?: string | undefined;
-  periods?: { [k: string]: any } | undefined;
-  _links?: EntitySettlementLinks$Outbound | undefined;
+  periods?: { [k: string]: { [k: string]: Periods$Outbound } } | undefined;
+  _links: EntitySettlementLinks$Outbound;
 };
 
 /** @internal */
@@ -238,17 +561,17 @@ export const EntitySettlement$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntitySettlement
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
+  resource: z.string(),
+  id: z.string(),
   createdAt: z.string().optional(),
   reference: z.nullable(z.string()).optional(),
   settledAt: z.nullable(z.string()).optional(),
-  status: SettlementStatus$outboundSchema.optional(),
-  amount: Amount$outboundSchema.optional(),
-  balanceId: z.string().optional(),
+  status: SettlementStatus$outboundSchema,
+  amount: Amount$outboundSchema,
+  balanceId: z.string(),
   invoiceId: z.string().optional(),
-  periods: z.record(z.any()).optional(),
-  links: z.lazy(() => EntitySettlementLinks$outboundSchema).optional(),
+  periods: z.record(z.record(z.lazy(() => Periods$outboundSchema))).optional(),
+  links: z.lazy(() => EntitySettlementLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",

package/src/models/errors/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from "./clientdefaulterror.js";
+export * from "./clienterror.js";
 export * from "./errorresponse.js";
 export * from "./httpclienterrors.js";
 export * from "./responsevalidationerror.js";

package/src/models/operations/listsettlements.ts

@@ -53,7 +53,7 @@ export type ListSettlementsEmbedded = {
    * @remarks
    * of the settlement object, refer to the [Get settlement endpoint](get-settlement) documentation.
    */
-  settlements?: Array<models.EntitySettlement> | undefined;
+  settlements: Array<models.EntitySettlement>;
 };
 
 /**
@@ -72,12 +72,12 @@ export type ListSettlementsResponse = {
    * The maximum number of items per result set is controlled by the `limit` property provided in the request. The default
    * limit is 50 items.
    */
-  count?: number | undefined;
-  embedded?: ListSettlementsEmbedded | undefined;
+  count: number;
+  embedded: ListSettlementsEmbedded;
   /**
    * Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.
    */
-  links?: models.ListLinks | undefined;
+  links: models.ListLinks;
 };
 
 /** @internal */
@@ -166,12 +166,12 @@ export const ListSettlementsEmbedded$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  settlements: z.array(models.EntitySettlement$inboundSchema).optional(),
+  settlements: z.array(models.EntitySettlement$inboundSchema),
 });
 
 /** @internal */
 export type ListSettlementsEmbedded$Outbound = {
-  settlements?: Array<models.EntitySettlement$Outbound> | undefined;
+  settlements: Array<models.EntitySettlement$Outbound>;
 };
 
 /** @internal */
@@ -180,7 +180,7 @@ export const ListSettlementsEmbedded$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListSettlementsEmbedded
 > = z.object({
-  settlements: z.array(models.EntitySettlement$outboundSchema).optional(),
+  settlements: z.array(models.EntitySettlement$outboundSchema),
 });
 
 /**
@@ -220,9 +220,9 @@ export const ListSettlementsResponse$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  count: z.number().int().optional(),
-  _embedded: z.lazy(() => ListSettlementsEmbedded$inboundSchema).optional(),
-  _links: models.ListLinks$inboundSchema.optional(),
+  count: z.number().int(),
+  _embedded: z.lazy(() => ListSettlementsEmbedded$inboundSchema),
+  _links: models.ListLinks$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "_embedded": "embedded",
@@ -232,9 +232,9 @@ export const ListSettlementsResponse$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ListSettlementsResponse$Outbound = {
-  count?: number | undefined;
-  _embedded?: ListSettlementsEmbedded$Outbound | undefined;
-  _links?: models.ListLinks$Outbound | undefined;
+  count: number;
+  _embedded: ListSettlementsEmbedded$Outbound;
+  _links: models.ListLinks$Outbound;
 };
 
 /** @internal */
@@ -243,9 +243,9 @@ export const ListSettlementsResponse$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ListSettlementsResponse
 > = z.object({
-  count: z.number().int().optional(),
-  embedded: z.lazy(() => ListSettlementsEmbedded$outboundSchema).optional(),
-  links: models.ListLinks$outboundSchema.optional(),
+  count: z.number().int(),
+  embedded: z.lazy(() => ListSettlementsEmbedded$outboundSchema),
+  links: models.ListLinks$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     embedded: "_embedded",