mollie-api-typescript 0.4.0 → 0.4.1

package/src/models/entitybalance.ts

@@ -84,25 +84,25 @@ export type EntityBalance = {
   /**
    * Indicates the response contains a balance object. Will always contain the string `balance` for this endpoint.
    */
-  resource?: string | undefined;
-  id?: string | undefined;
+  resource: string;
+  id: string;
   /**
    * Whether this entity was created in live mode or in test mode.
    */
-  mode?: Mode | undefined;
+  mode: Mode;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
-  createdAt?: string | undefined;
-  currency?: Currencies | undefined;
+  createdAt: string;
+  currency: Currencies;
   /**
    * The description or name of the balance. Can be used to denote the purpose of the balance.
    */
-  description?: string | undefined;
+  description: string;
   /**
    * The status of the balance.
    */
-  status?: BalanceStatus | undefined;
+  status: BalanceStatus;
   /**
    * The frequency with which the available amount on the balance will be settled to the configured transfer
    *
@@ -130,15 +130,15 @@ export type EntityBalance = {
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  availableAmount?: Amount | undefined;
+  availableAmount: Amount;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  pendingAmount?: Amount | undefined;
+  pendingAmount: Amount;
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links?: EntityBalanceLinks | undefined;
+  links: EntityBalanceLinks;
 };
 
 /** @internal */
@@ -264,22 +264,22 @@ export const EntityBalance$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  mode: Mode$inboundSchema.optional(),
-  createdAt: z.string().optional(),
-  currency: Currencies$inboundSchema.optional(),
-  description: z.string().optional(),
-  status: BalanceStatus$inboundSchema.optional(),
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  createdAt: z.string(),
+  currency: Currencies$inboundSchema,
+  description: z.string(),
+  status: BalanceStatus$inboundSchema,
   transferFrequency: BalanceTransferFrequency$inboundSchema.optional(),
   transferThreshold: Amount$inboundSchema.optional(),
   transferReference: z.nullable(z.string()).optional(),
   transferDestination: z.nullable(
     z.lazy(() => TransferDestination$inboundSchema),
   ).optional(),
-  availableAmount: Amount$inboundSchema.optional(),
-  pendingAmount: Amount$inboundSchema.optional(),
-  _links: z.lazy(() => EntityBalanceLinks$inboundSchema).optional(),
+  availableAmount: Amount$inboundSchema,
+  pendingAmount: Amount$inboundSchema,
+  _links: z.lazy(() => EntityBalanceLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -288,20 +288,20 @@ export const EntityBalance$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityBalance$Outbound = {
-  resource?: string | undefined;
-  id?: string | undefined;
-  mode?: string | undefined;
-  createdAt?: string | undefined;
-  currency?: string | undefined;
-  description?: string | undefined;
-  status?: string | undefined;
+  resource: string;
+  id: string;
+  mode: string;
+  createdAt: string;
+  currency: string;
+  description: string;
+  status: string;
   transferFrequency?: string | undefined;
   transferThreshold?: Amount$Outbound | undefined;
   transferReference?: string | null | undefined;
   transferDestination?: TransferDestination$Outbound | null | undefined;
-  availableAmount?: Amount$Outbound | undefined;
-  pendingAmount?: Amount$Outbound | undefined;
-  _links?: EntityBalanceLinks$Outbound | undefined;
+  availableAmount: Amount$Outbound;
+  pendingAmount: Amount$Outbound;
+  _links: EntityBalanceLinks$Outbound;
 };
 
 /** @internal */
@@ -310,22 +310,22 @@ export const EntityBalance$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityBalance
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  mode: Mode$outboundSchema.optional(),
-  createdAt: z.string().optional(),
-  currency: Currencies$outboundSchema.optional(),
-  description: z.string().optional(),
-  status: BalanceStatus$outboundSchema.optional(),
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  createdAt: z.string(),
+  currency: Currencies$outboundSchema,
+  description: z.string(),
+  status: BalanceStatus$outboundSchema,
   transferFrequency: BalanceTransferFrequency$outboundSchema.optional(),
   transferThreshold: Amount$outboundSchema.optional(),
   transferReference: z.nullable(z.string()).optional(),
   transferDestination: z.nullable(
     z.lazy(() => TransferDestination$outboundSchema),
   ).optional(),
-  availableAmount: Amount$outboundSchema.optional(),
-  pendingAmount: Amount$outboundSchema.optional(),
-  links: z.lazy(() => EntityBalanceLinks$outboundSchema).optional(),
+  availableAmount: Amount$outboundSchema,
+  pendingAmount: Amount$outboundSchema,
+  links: z.lazy(() => EntityBalanceLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",

package/src/models/entitybalancereport.ts

@@ -229,12 +229,12 @@ export type EntityBalanceReport = {
    * @remarks
    * endpoint.
    */
-  resource?: string | undefined;
-  balanceId?: string | undefined;
+  resource: string;
+  balanceId: string;
   /**
    * The time zone used for the from and until parameters. Currently only time zone `Europe/Amsterdam` is supported.
    */
-  timeZone?: string | undefined;
+  timeZone: string;
   /**
    * The start date of the report, in `YYYY-MM-DD` format. The from date is 'inclusive', and in Central European Time.
    *
@@ -242,15 +242,15 @@ export type EntityBalanceReport = {
    * This means a report with for example `from=2024-01-01` will include movements of 2024-01-01 00:00:00 CET and
    * onwards.
    */
-  from?: string | undefined;
+  from: string;
   /**
    * The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time.
    *
    * @remarks
    * This means a report with for example `until=2024-02-01` will include movements up until 2024-01-31 23:59:59 CET.
    */
-  until?: string | undefined;
-  grouping?: BalanceReportGrouping | undefined;
+  until: string;
+  grouping: BalanceReportGrouping;
   /**
    * Totals are grouped according to the chosen grouping rule. The example response should give a good idea of what a
    *
@@ -275,11 +275,11 @@ export type EntityBalanceReport = {
    * * A `count` integer if relevant (for example, counting the number of refunds)
    * * A `subtotals` array containing more sub-group objects if applicable
    */
-  totals?: Totals | undefined;
+  totals: Totals;
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links?: EntityBalanceReportLinks | undefined;
+  links: EntityBalanceReportLinks;
 };
 
 /** @internal */
@@ -1095,14 +1095,14 @@ export const EntityBalanceReport$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  balanceId: z.string().optional(),
-  timeZone: z.string().optional(),
-  from: z.string().optional(),
-  until: z.string().optional(),
-  grouping: BalanceReportGrouping$inboundSchema.optional(),
-  totals: z.lazy(() => Totals$inboundSchema).optional(),
-  _links: z.lazy(() => EntityBalanceReportLinks$inboundSchema).optional(),
+  resource: z.string(),
+  balanceId: z.string(),
+  timeZone: z.string(),
+  from: z.string(),
+  until: z.string(),
+  grouping: BalanceReportGrouping$inboundSchema,
+  totals: z.lazy(() => Totals$inboundSchema),
+  _links: z.lazy(() => EntityBalanceReportLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -1111,14 +1111,14 @@ export const EntityBalanceReport$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityBalanceReport$Outbound = {
-  resource?: string | undefined;
-  balanceId?: string | undefined;
-  timeZone?: string | undefined;
-  from?: string | undefined;
-  until?: string | undefined;
-  grouping?: string | undefined;
-  totals?: Totals$Outbound | undefined;
-  _links?: EntityBalanceReportLinks$Outbound | undefined;
+  resource: string;
+  balanceId: string;
+  timeZone: string;
+  from: string;
+  until: string;
+  grouping: string;
+  totals: Totals$Outbound;
+  _links: EntityBalanceReportLinks$Outbound;
 };
 
 /** @internal */
@@ -1127,14 +1127,14 @@ export const EntityBalanceReport$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityBalanceReport
 > = z.object({
-  resource: z.string().optional(),
-  balanceId: z.string().optional(),
-  timeZone: z.string().optional(),
-  from: z.string().optional(),
-  until: z.string().optional(),
-  grouping: BalanceReportGrouping$outboundSchema.optional(),
-  totals: z.lazy(() => Totals$outboundSchema).optional(),
-  links: z.lazy(() => EntityBalanceReportLinks$outboundSchema).optional(),
+  resource: z.string(),
+  balanceId: z.string(),
+  timeZone: z.string(),
+  from: z.string(),
+  until: z.string(),
+  grouping: BalanceReportGrouping$outboundSchema,
+  totals: z.lazy(() => Totals$outboundSchema),
+  links: z.lazy(() => EntityBalanceReportLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",

package/src/models/entitybalancetransaction.ts

@@ -314,17 +314,17 @@ export type EntityBalanceTransaction = {
    * @remarks
    * for this endpoint.
    */
-  resource?: string | undefined;
-  id?: string | undefined;
-  type?: BalanceTransactionType | undefined;
+  resource: string;
+  id: string;
+  type: BalanceTransactionType;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  resultAmount?: Amount | undefined;
+  resultAmount: Amount;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  initialAmount?: Amount | undefined;
+  initialAmount: Amount;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
@@ -383,7 +383,7 @@ export type EntityBalanceTransaction = {
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
-  createdAt?: string | undefined;
+  createdAt: string;
 };
 
 /** @internal */
@@ -2543,26 +2543,26 @@ export const EntityBalanceTransaction$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  type: BalanceTransactionType$inboundSchema.optional(),
-  resultAmount: Amount$inboundSchema.optional(),
-  initialAmount: Amount$inboundSchema.optional(),
+  resource: z.string(),
+  id: z.string(),
+  type: BalanceTransactionType$inboundSchema,
+  resultAmount: Amount$inboundSchema,
+  initialAmount: Amount$inboundSchema,
   deductions: z.nullable(AmountNullable$inboundSchema).optional(),
   context: z.lazy(() => Context$inboundSchema).optional(),
-  createdAt: z.string().optional(),
+  createdAt: z.string(),
 });
 
 /** @internal */
 export type EntityBalanceTransaction$Outbound = {
-  resource?: string | undefined;
-  id?: string | undefined;
-  type?: string | undefined;
-  resultAmount?: Amount$Outbound | undefined;
-  initialAmount?: Amount$Outbound | undefined;
+  resource: string;
+  id: string;
+  type: string;
+  resultAmount: Amount$Outbound;
+  initialAmount: Amount$Outbound;
   deductions?: AmountNullable$Outbound | null | undefined;
   context?: Context$Outbound | undefined;
-  createdAt?: string | undefined;
+  createdAt: string;
 };
 
 /** @internal */
@@ -2571,14 +2571,14 @@ export const EntityBalanceTransaction$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityBalanceTransaction
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  type: BalanceTransactionType$outboundSchema.optional(),
-  resultAmount: Amount$outboundSchema.optional(),
-  initialAmount: Amount$outboundSchema.optional(),
+  resource: z.string(),
+  id: z.string(),
+  type: BalanceTransactionType$outboundSchema,
+  resultAmount: Amount$outboundSchema,
+  initialAmount: Amount$outboundSchema,
   deductions: z.nullable(AmountNullable$outboundSchema).optional(),
   context: z.lazy(() => Context$outboundSchema).optional(),
-  createdAt: z.string().optional(),
+  createdAt: z.string(),
 });
 
 /**

package/src/models/entitycapability.ts

@@ -27,14 +27,14 @@ export type EntityCapability = {
   /**
    * Always the word `capability` for this resource type.
    */
-  resource?: string | undefined;
+  resource: string;
   /**
    * A unique name for this capability like `payments` / `settlements`.
    */
-  name?: string | undefined;
-  status?: CapabilityStatus | undefined;
-  statusReason?: CapabilityStatusReason | undefined;
-  requirements?: Array<EntityCapabilityRequirement> | undefined;
+  name: string;
+  status: CapabilityStatus;
+  statusReason: CapabilityStatusReason | null;
+  requirements: Array<EntityCapabilityRequirement>;
 };
 
 /** @internal */
@@ -43,20 +43,20 @@ export const EntityCapability$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  name: z.string().optional(),
-  status: CapabilityStatus$inboundSchema.optional(),
-  statusReason: CapabilityStatusReason$inboundSchema.optional(),
-  requirements: z.array(EntityCapabilityRequirement$inboundSchema).optional(),
+  resource: z.string(),
+  name: z.string(),
+  status: CapabilityStatus$inboundSchema,
+  statusReason: z.nullable(CapabilityStatusReason$inboundSchema),
+  requirements: z.array(EntityCapabilityRequirement$inboundSchema),
 });
 
 /** @internal */
 export type EntityCapability$Outbound = {
-  resource?: string | undefined;
-  name?: string | undefined;
-  status?: string | undefined;
-  statusReason?: string | undefined;
-  requirements?: Array<EntityCapabilityRequirement$Outbound> | undefined;
+  resource: string;
+  name: string;
+  status: string;
+  statusReason: string | null;
+  requirements: Array<EntityCapabilityRequirement$Outbound>;
 };
 
 /** @internal */
@@ -65,11 +65,11 @@ export const EntityCapability$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityCapability
 > = z.object({
-  resource: z.string().optional(),
-  name: z.string().optional(),
-  status: CapabilityStatus$outboundSchema.optional(),
-  statusReason: CapabilityStatusReason$outboundSchema.optional(),
-  requirements: z.array(EntityCapabilityRequirement$outboundSchema).optional(),
+  resource: z.string(),
+  name: z.string(),
+  status: CapabilityStatus$outboundSchema,
+  statusReason: z.nullable(CapabilityStatusReason$outboundSchema),
+  requirements: z.array(EntityCapabilityRequirement$outboundSchema),
 });
 
 /**

package/src/models/entitycapabilityrequirement.ts

@@ -12,32 +12,18 @@ import {
   CapabilityRequirementStatus$outboundSchema,
 } from "./capabilityrequirementstatus.js";
 import { SDKValidationError } from "./errors/sdkvalidationerror.js";
-
-/**
- * If known, a deep link to the Mollie dashboard of the client, where the requirement can be fulfilled.
- *
- * @remarks
- * For example, where necessary documents are to be uploaded.
- */
-export type Dashboard = {
-  /**
-   * The actual URL string.
-   */
-  href?: string | undefined;
-  /**
-   * The content type of the page or endpoint the URL points to.
-   */
-  type?: string | undefined;
-};
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
 
 export type EntityCapabilityRequirementLinks = {
   /**
-   * If known, a deep link to the Mollie dashboard of the client, where the requirement can be fulfilled.
-   *
-   * @remarks
-   * For example, where necessary documents are to be uploaded.
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
-  dashboard?: Dashboard | undefined;
+  dashboard?: Url | undefined;
 };
 
 export type EntityCapabilityRequirement = {
@@ -48,86 +34,33 @@ export type EntityCapabilityRequirement = {
    * to enable or re-enable the capability. The name is unique among other requirements
    * of the same capability.
    */
-  id?: string | undefined;
+  id: string;
   /**
    * The status of the requirement depends on its due date.
    *
    * @remarks
    * If no due date is given, the status will be `requested`.
    */
-  status?: CapabilityRequirementStatus | undefined;
+  status: CapabilityRequirementStatus;
   /**
    * Due date until the requirement must be fulfilled, if any. The date is shown in ISO-8601 format.
    */
-  dueDate?: string | null | undefined;
-  links?: EntityCapabilityRequirementLinks | undefined;
-};
-
-/** @internal */
-export const Dashboard$inboundSchema: z.ZodType<
-  Dashboard,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  href: z.string().optional(),
-  type: z.string().optional(),
-});
-
-/** @internal */
-export type Dashboard$Outbound = {
-  href?: string | undefined;
-  type?: string | undefined;
+  dueDate: string | null;
+  links: EntityCapabilityRequirementLinks;
 };
 
-/** @internal */
-export const Dashboard$outboundSchema: z.ZodType<
-  Dashboard$Outbound,
-  z.ZodTypeDef,
-  Dashboard
-> = z.object({
-  href: z.string().optional(),
-  type: 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 Dashboard$ {
-  /** @deprecated use `Dashboard$inboundSchema` instead. */
-  export const inboundSchema = Dashboard$inboundSchema;
-  /** @deprecated use `Dashboard$outboundSchema` instead. */
-  export const outboundSchema = Dashboard$outboundSchema;
-  /** @deprecated use `Dashboard$Outbound` instead. */
-  export type Outbound = Dashboard$Outbound;
-}
-
-export function dashboardToJSON(dashboard: Dashboard): string {
-  return JSON.stringify(Dashboard$outboundSchema.parse(dashboard));
-}
-
-export function dashboardFromJSON(
-  jsonString: string,
-): SafeParseResult<Dashboard, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Dashboard$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Dashboard' from JSON`,
-  );
-}
-
 /** @internal */
 export const EntityCapabilityRequirementLinks$inboundSchema: z.ZodType<
   EntityCapabilityRequirementLinks,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  dashboard: z.lazy(() => Dashboard$inboundSchema).optional(),
+  dashboard: Url$inboundSchema.optional(),
 });
 
 /** @internal */
 export type EntityCapabilityRequirementLinks$Outbound = {
-  dashboard?: Dashboard$Outbound | undefined;
+  dashboard?: Url$Outbound | undefined;
 };
 
 /** @internal */
@@ -136,7 +69,7 @@ export const EntityCapabilityRequirementLinks$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityCapabilityRequirementLinks
 > = z.object({
-  dashboard: z.lazy(() => Dashboard$outboundSchema).optional(),
+  dashboard: Url$outboundSchema.optional(),
 });
 
 /**
@@ -178,11 +111,10 @@ export const EntityCapabilityRequirement$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  id: z.string().optional(),
-  status: CapabilityRequirementStatus$inboundSchema.optional(),
-  dueDate: z.nullable(z.string()).optional(),
-  _links: z.lazy(() => EntityCapabilityRequirementLinks$inboundSchema)
-    .optional(),
+  id: z.string(),
+  status: CapabilityRequirementStatus$inboundSchema,
+  dueDate: z.nullable(z.string()),
+  _links: z.lazy(() => EntityCapabilityRequirementLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -191,10 +123,10 @@ export const EntityCapabilityRequirement$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityCapabilityRequirement$Outbound = {
-  id?: string | undefined;
-  status?: string | undefined;
-  dueDate?: string | null | undefined;
-  _links?: EntityCapabilityRequirementLinks$Outbound | undefined;
+  id: string;
+  status: string;
+  dueDate: string | null;
+  _links: EntityCapabilityRequirementLinks$Outbound;
 };
 
 /** @internal */
@@ -203,11 +135,10 @@ export const EntityCapabilityRequirement$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityCapabilityRequirement
 > = z.object({
-  id: z.string().optional(),
-  status: CapabilityRequirementStatus$outboundSchema.optional(),
-  dueDate: z.nullable(z.string()).optional(),
-  links: z.lazy(() => EntityCapabilityRequirementLinks$outboundSchema)
-    .optional(),
+  id: z.string(),
+  status: CapabilityRequirementStatus$outboundSchema,
+  dueDate: z.nullable(z.string()),
+  links: z.lazy(() => EntityCapabilityRequirementLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",