mollie-api-typescript 0.3.4 → 0.4.1

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",

package/src/models/entityinvoice.ts

@@ -29,23 +29,23 @@ export type EntityInvoiceLine = {
   /**
    * The administrative period in `YYYY-MM` on which the line should be booked.
    */
-  period?: string | undefined;
+  period: string;
   /**
    * Description of the product.
    */
-  description?: string | undefined;
+  description: string;
   /**
    * Number of products invoiced. For example, the number of payments.
    */
-  count?: number | undefined;
+  count: number;
   /**
    * VAT percentage rate that applies to this product.
    */
-  vatPercentage?: number | undefined;
+  vatPercentage: number;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  amount?: Amount | undefined;
+  amount: Amount;
 };
 
 /**
@@ -73,43 +73,40 @@ export type EntityInvoice = {
    * @remarks
    * Will always contain the string `invoice` for this endpoint.
    */
-  resource?: string | undefined;
-  /**
-   * The identifier uniquely referring to this invoice. Example: `inv_FrvewDA3Pr`.
-   */
-  id?: string | undefined;
+  resource: string;
+  id: string;
   /**
    * The reference number of the invoice. An example value would be: `2024.10000`.
    */
-  reference?: string | undefined;
+  reference: string;
   /**
    * The VAT number to which the invoice was issued to, if applicable.
    */
-  vatNumber?: string | null | undefined;
+  vatNumber: string | null;
   /**
    * Status of the invoice.
    */
-  status?: InvoiceStatus | undefined;
+  status: InvoiceStatus;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  netAmount?: Amount | undefined;
+  netAmount: Amount;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  vatAmount?: Amount | undefined;
+  vatAmount: Amount;
   /**
    * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
    */
-  grossAmount?: Amount | undefined;
+  grossAmount: Amount;
   /**
    * The collection of products which make up the invoice.
    */
-  lines?: Array<EntityInvoiceLine> | undefined;
+  lines: Array<EntityInvoiceLine>;
   /**
    * The invoice date in `YYYY-MM-DD` format.
    */
-  issuedAt?: string | undefined;
+  issuedAt: string;
   /**
    * The date on which the invoice was paid, if applicable, in `YYYY-MM-DD` format.
    */
@@ -121,7 +118,7 @@ export type EntityInvoice = {
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links?: EntityInvoiceLinks | undefined;
+  links: EntityInvoiceLinks;
 };
 
 /** @internal */
@@ -130,20 +127,20 @@ export const EntityInvoiceLine$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  period: z.string().optional(),
-  description: z.string().optional(),
-  count: z.number().int().optional(),
-  vatPercentage: z.number().int().optional(),
-  amount: Amount$inboundSchema.optional(),
+  period: z.string(),
+  description: z.string(),
+  count: z.number().int(),
+  vatPercentage: z.number().int(),
+  amount: Amount$inboundSchema,
 });
 
 /** @internal */
 export type EntityInvoiceLine$Outbound = {
-  period?: string | undefined;
-  description?: string | undefined;
-  count?: number | undefined;
-  vatPercentage?: number | undefined;
-  amount?: Amount$Outbound | undefined;
+  period: string;
+  description: string;
+  count: number;
+  vatPercentage: number;
+  amount: Amount$Outbound;
 };
 
 /** @internal */
@@ -152,11 +149,11 @@ export const EntityInvoiceLine$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityInvoiceLine
 > = z.object({
-  period: z.string().optional(),
-  description: z.string().optional(),
-  count: z.number().int().optional(),
-  vatPercentage: z.number().int().optional(),
-  amount: Amount$outboundSchema.optional(),
+  period: z.string(),
+  description: z.string(),
+  count: z.number().int(),
+  vatPercentage: z.number().int(),
+  amount: Amount$outboundSchema,
 });
 
 /**
@@ -256,19 +253,19 @@ export const EntityInvoice$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  reference: z.string().optional(),
-  vatNumber: z.nullable(z.string()).optional(),
-  status: InvoiceStatus$inboundSchema.optional(),
-  netAmount: Amount$inboundSchema.optional(),
-  vatAmount: Amount$inboundSchema.optional(),
-  grossAmount: Amount$inboundSchema.optional(),
-  lines: z.array(z.lazy(() => EntityInvoiceLine$inboundSchema)).optional(),
-  issuedAt: z.string().optional(),
+  resource: z.string(),
+  id: z.string(),
+  reference: z.string(),
+  vatNumber: z.nullable(z.string()),
+  status: InvoiceStatus$inboundSchema,
+  netAmount: Amount$inboundSchema,
+  vatAmount: Amount$inboundSchema,
+  grossAmount: Amount$inboundSchema,
+  lines: z.array(z.lazy(() => EntityInvoiceLine$inboundSchema)),
+  issuedAt: z.string(),
   paidAt: z.nullable(z.string()).optional(),
   dueAt: z.nullable(z.string()).optional(),
-  _links: z.lazy(() => EntityInvoiceLinks$inboundSchema).optional(),
+  _links: z.lazy(() => EntityInvoiceLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -277,19 +274,19 @@ export const EntityInvoice$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityInvoice$Outbound = {
-  resource?: string | undefined;
-  id?: string | undefined;
-  reference?: string | undefined;
-  vatNumber?: string | null | undefined;
-  status?: string | undefined;
-  netAmount?: Amount$Outbound | undefined;
-  vatAmount?: Amount$Outbound | undefined;
-  grossAmount?: Amount$Outbound | undefined;
-  lines?: Array<EntityInvoiceLine$Outbound> | undefined;
-  issuedAt?: string | undefined;
+  resource: string;
+  id: string;
+  reference: string;
+  vatNumber: string | null;
+  status: string;
+  netAmount: Amount$Outbound;
+  vatAmount: Amount$Outbound;
+  grossAmount: Amount$Outbound;
+  lines: Array<EntityInvoiceLine$Outbound>;
+  issuedAt: string;
   paidAt?: string | null | undefined;
   dueAt?: string | null | undefined;
-  _links?: EntityInvoiceLinks$Outbound | undefined;
+  _links: EntityInvoiceLinks$Outbound;
 };
 
 /** @internal */
@@ -298,19 +295,19 @@ export const EntityInvoice$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityInvoice
 > = z.object({
-  resource: z.string().optional(),
-  id: z.string().optional(),
-  reference: z.string().optional(),
-  vatNumber: z.nullable(z.string()).optional(),
-  status: InvoiceStatus$outboundSchema.optional(),
-  netAmount: Amount$outboundSchema.optional(),
-  vatAmount: Amount$outboundSchema.optional(),
-  grossAmount: Amount$outboundSchema.optional(),
-  lines: z.array(z.lazy(() => EntityInvoiceLine$outboundSchema)).optional(),
-  issuedAt: z.string().optional(),
+  resource: z.string(),
+  id: z.string(),
+  reference: z.string(),
+  vatNumber: z.nullable(z.string()),
+  status: InvoiceStatus$outboundSchema,
+  netAmount: Amount$outboundSchema,
+  vatAmount: Amount$outboundSchema,
+  grossAmount: Amount$outboundSchema,
+  lines: z.array(z.lazy(() => EntityInvoiceLine$outboundSchema)),
+  issuedAt: z.string(),
   paidAt: z.nullable(z.string()).optional(),
   dueAt: z.nullable(z.string()).optional(),
-  links: z.lazy(() => EntityInvoiceLinks$outboundSchema).optional(),
+  links: z.lazy(() => EntityInvoiceLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",

package/src/models/entityonboardingstatus.ts

@@ -48,31 +48,31 @@ export type EntityOnboardingStatus = {
    * @remarks
    * resource type.
    */
-  resource?: string | undefined;
+  resource: string;
   /**
    * The name of the organization.
    */
-  name?: string | undefined;
+  name: string;
   /**
    * The current status of the organization's onboarding process.
    */
-  status?: OnboardingStatus | undefined;
+  status: OnboardingStatus;
   /**
    * Whether the organization can receive payments.
    */
-  canReceivePayments?: boolean | undefined;
+  canReceivePayments: boolean;
   /**
    * Whether the organization can receive settlements to their external bank account.
    */
-  canReceiveSettlements?: boolean | undefined;
+  canReceiveSettlements: boolean;
   /**
    * The sign up date time of the organization in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
-  signedUpAt?: string | undefined;
+  signedUpAt: string;
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links?: EntityOnboardingStatusLinks | undefined;
+  links: EntityOnboardingStatusLinks;
 };
 
 /** @internal */
@@ -146,13 +146,13 @@ export const EntityOnboardingStatus$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  resource: z.string().optional(),
-  name: z.string().optional(),
-  status: OnboardingStatus$inboundSchema.optional(),
-  canReceivePayments: z.boolean().optional(),
-  canReceiveSettlements: z.boolean().optional(),
-  signedUpAt: z.string().optional(),
-  _links: z.lazy(() => EntityOnboardingStatusLinks$inboundSchema).optional(),
+  resource: z.string(),
+  name: z.string(),
+  status: OnboardingStatus$inboundSchema,
+  canReceivePayments: z.boolean(),
+  canReceiveSettlements: z.boolean(),
+  signedUpAt: z.string(),
+  _links: z.lazy(() => EntityOnboardingStatusLinks$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_links": "links",
@@ -161,13 +161,13 @@ export const EntityOnboardingStatus$inboundSchema: z.ZodType<
 
 /** @internal */
 export type EntityOnboardingStatus$Outbound = {
-  resource?: string | undefined;
-  name?: string | undefined;
-  status?: string | undefined;
-  canReceivePayments?: boolean | undefined;
-  canReceiveSettlements?: boolean | undefined;
-  signedUpAt?: string | undefined;
-  _links?: EntityOnboardingStatusLinks$Outbound | undefined;
+  resource: string;
+  name: string;
+  status: string;
+  canReceivePayments: boolean;
+  canReceiveSettlements: boolean;
+  signedUpAt: string;
+  _links: EntityOnboardingStatusLinks$Outbound;
 };
 
 /** @internal */
@@ -176,13 +176,13 @@ export const EntityOnboardingStatus$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   EntityOnboardingStatus
 > = z.object({
-  resource: z.string().optional(),
-  name: z.string().optional(),
-  status: OnboardingStatus$outboundSchema.optional(),
-  canReceivePayments: z.boolean().optional(),
-  canReceiveSettlements: z.boolean().optional(),
-  signedUpAt: z.string().optional(),
-  links: z.lazy(() => EntityOnboardingStatusLinks$outboundSchema).optional(),
+  resource: z.string(),
+  name: z.string(),
+  status: OnboardingStatus$outboundSchema,
+  canReceivePayments: z.boolean(),
+  canReceiveSettlements: z.boolean(),
+  signedUpAt: z.string(),
+  links: z.lazy(() => EntityOnboardingStatusLinks$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     links: "_links",