mollie-api-typescript 1.3.7 → 1.3.8

package/src/models/entityunmatchedcredittransfer.ts

@@ -0,0 +1,538 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4963e048ca78
+ */
+
+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 {
+  UnmatchedCreditTransferStatus,
+  UnmatchedCreditTransferStatus$inboundSchema,
+  UnmatchedCreditTransferStatus$outboundSchema,
+} from "./unmatchedcredittransferstatus.js";
+
+/**
+ * Details about the sender of the credit transfer.
+ */
+export type EntityUnmatchedCreditTransferSource = {
+  /**
+   * The format of the source account. Currently always `iban`.
+   */
+  format: string;
+  /**
+   * The name of the account holder who sent the unmatched credit transfer.
+   */
+  accountHolderName: string;
+  /**
+   * The IBAN of the sender's bank account.
+   */
+  iban: string;
+  /**
+   * The BIC of the sender's bank.
+   */
+  bic: string;
+};
+
+/**
+ * Structured references provided with the unmatched credit transfer.
+ */
+export type EntityUnmatchedCreditTransferReferences = {
+  /**
+   * The creditor reference.
+   */
+  creditorReference?: string | null | undefined;
+  /**
+   * The end-to-end identifier.
+   */
+  endToEndId?: string | undefined;
+};
+
+/**
+ * Remittance information provided with the unmatched credit transfer.
+ */
+export type EntityUnmatchedCreditTransferRemittanceInformation = {
+  /**
+   * Unstructured remittance information, such as a free-text payment description.
+   */
+  unstructured?: string | undefined;
+  /**
+   * Structured references provided with the unmatched credit transfer.
+   */
+  references?: EntityUnmatchedCreditTransferReferences | undefined;
+};
+
+/**
+ * The URL to this unmatched credit transfer.
+ */
+export type EntityUnmatchedCreditTransferSelf = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * The URL to the documentation of this endpoint.
+ */
+export type EntityUnmatchedCreditTransferDocumentation = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * Links to related resources.
+ */
+export type EntityUnmatchedCreditTransferLinks = {
+  /**
+   * The URL to this unmatched credit transfer.
+   */
+  self?: EntityUnmatchedCreditTransferSelf | undefined;
+  /**
+   * The URL to the documentation of this endpoint.
+   */
+  documentation?: EntityUnmatchedCreditTransferDocumentation | undefined;
+};
+
+export type EntityUnmatchedCreditTransfer = {
+  /**
+   * Indicates the response contains an unmatched credit transfer object. Will always contain the string
+   *
+   * @remarks
+   * `unmatched-credit-transfer` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this unmatched credit transfer.
+   */
+  id: string;
+  profileId: string;
+  /**
+   * In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
+   */
+  amount: Amount;
+  /**
+   * Details about the sender of the credit transfer.
+   */
+  source: EntityUnmatchedCreditTransferSource;
+  /**
+   * Remittance information provided with the unmatched credit transfer.
+   */
+  remittanceInformation: EntityUnmatchedCreditTransferRemittanceInformation;
+  status: UnmatchedCreditTransferStatus;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * The date and time at which the unmatched credit transfer expires, in
+   *
+   * @remarks
+   * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  expiresAt: string;
+  /**
+   * The IDs of the payments this credit transfer was matched to. Only present when the status is `matched`.
+   */
+  paymentIds?: Array<string> | undefined;
+  /**
+   * Links to related resources.
+   */
+  links: EntityUnmatchedCreditTransferLinks;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferSource$inboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  format: z.string(),
+  accountHolderName: z.string(),
+  iban: z.string(),
+  bic: z.string(),
+});
+/** @internal */
+export type EntityUnmatchedCreditTransferSource$Outbound = {
+  format: string;
+  accountHolderName: string;
+  iban: string;
+  bic: string;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferSource$outboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferSource$Outbound,
+  z.ZodTypeDef,
+  EntityUnmatchedCreditTransferSource
+> = z.object({
+  format: z.string(),
+  accountHolderName: z.string(),
+  iban: z.string(),
+  bic: z.string(),
+});
+
+export function entityUnmatchedCreditTransferSourceToJSON(
+  entityUnmatchedCreditTransferSource: EntityUnmatchedCreditTransferSource,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferSource$outboundSchema.parse(
+      entityUnmatchedCreditTransferSource,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityUnmatchedCreditTransferSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityUnmatchedCreditTransferSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityUnmatchedCreditTransferSource' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransferReferences$inboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferReferences,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  creditorReference: z.nullable(z.string()).optional(),
+  endToEndId: z.string().optional(),
+});
+/** @internal */
+export type EntityUnmatchedCreditTransferReferences$Outbound = {
+  creditorReference?: string | null | undefined;
+  endToEndId?: string | undefined;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferReferences$outboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferReferences$Outbound,
+  z.ZodTypeDef,
+  EntityUnmatchedCreditTransferReferences
+> = z.object({
+  creditorReference: z.nullable(z.string()).optional(),
+  endToEndId: z.string().optional(),
+});
+
+export function entityUnmatchedCreditTransferReferencesToJSON(
+  entityUnmatchedCreditTransferReferences:
+    EntityUnmatchedCreditTransferReferences,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferReferences$outboundSchema.parse(
+      entityUnmatchedCreditTransferReferences,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferReferencesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EntityUnmatchedCreditTransferReferences,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityUnmatchedCreditTransferReferences$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EntityUnmatchedCreditTransferReferences' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransferRemittanceInformation$inboundSchema:
+  z.ZodType<
+    EntityUnmatchedCreditTransferRemittanceInformation,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    unstructured: z.string().optional(),
+    references: z.lazy(() =>
+      EntityUnmatchedCreditTransferReferences$inboundSchema
+    ).optional(),
+  });
+/** @internal */
+export type EntityUnmatchedCreditTransferRemittanceInformation$Outbound = {
+  unstructured?: string | undefined;
+  references?: EntityUnmatchedCreditTransferReferences$Outbound | undefined;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferRemittanceInformation$outboundSchema:
+  z.ZodType<
+    EntityUnmatchedCreditTransferRemittanceInformation$Outbound,
+    z.ZodTypeDef,
+    EntityUnmatchedCreditTransferRemittanceInformation
+  > = z.object({
+    unstructured: z.string().optional(),
+    references: z.lazy(() =>
+      EntityUnmatchedCreditTransferReferences$outboundSchema
+    ).optional(),
+  });
+
+export function entityUnmatchedCreditTransferRemittanceInformationToJSON(
+  entityUnmatchedCreditTransferRemittanceInformation:
+    EntityUnmatchedCreditTransferRemittanceInformation,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferRemittanceInformation$outboundSchema.parse(
+      entityUnmatchedCreditTransferRemittanceInformation,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferRemittanceInformationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EntityUnmatchedCreditTransferRemittanceInformation,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityUnmatchedCreditTransferRemittanceInformation$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EntityUnmatchedCreditTransferRemittanceInformation' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransferSelf$inboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferSelf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+/** @internal */
+export type EntityUnmatchedCreditTransferSelf$Outbound = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferSelf$outboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferSelf$Outbound,
+  z.ZodTypeDef,
+  EntityUnmatchedCreditTransferSelf
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+
+export function entityUnmatchedCreditTransferSelfToJSON(
+  entityUnmatchedCreditTransferSelf: EntityUnmatchedCreditTransferSelf,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferSelf$outboundSchema.parse(
+      entityUnmatchedCreditTransferSelf,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferSelfFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityUnmatchedCreditTransferSelf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityUnmatchedCreditTransferSelf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityUnmatchedCreditTransferSelf' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransferDocumentation$inboundSchema:
+  z.ZodType<EntityUnmatchedCreditTransferDocumentation, z.ZodTypeDef, unknown> =
+    z.object({
+      href: z.string().optional(),
+      type: z.string().optional(),
+    });
+/** @internal */
+export type EntityUnmatchedCreditTransferDocumentation$Outbound = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferDocumentation$outboundSchema:
+  z.ZodType<
+    EntityUnmatchedCreditTransferDocumentation$Outbound,
+    z.ZodTypeDef,
+    EntityUnmatchedCreditTransferDocumentation
+  > = z.object({
+    href: z.string().optional(),
+    type: z.string().optional(),
+  });
+
+export function entityUnmatchedCreditTransferDocumentationToJSON(
+  entityUnmatchedCreditTransferDocumentation:
+    EntityUnmatchedCreditTransferDocumentation,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferDocumentation$outboundSchema.parse(
+      entityUnmatchedCreditTransferDocumentation,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferDocumentationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  EntityUnmatchedCreditTransferDocumentation,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityUnmatchedCreditTransferDocumentation$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'EntityUnmatchedCreditTransferDocumentation' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransferLinks$inboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: z.lazy(() => EntityUnmatchedCreditTransferSelf$inboundSchema)
+    .optional(),
+  documentation: z.lazy(() =>
+    EntityUnmatchedCreditTransferDocumentation$inboundSchema
+  ).optional(),
+});
+/** @internal */
+export type EntityUnmatchedCreditTransferLinks$Outbound = {
+  self?: EntityUnmatchedCreditTransferSelf$Outbound | undefined;
+  documentation?:
+    | EntityUnmatchedCreditTransferDocumentation$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransferLinks$outboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransferLinks$Outbound,
+  z.ZodTypeDef,
+  EntityUnmatchedCreditTransferLinks
+> = z.object({
+  self: z.lazy(() => EntityUnmatchedCreditTransferSelf$outboundSchema)
+    .optional(),
+  documentation: z.lazy(() =>
+    EntityUnmatchedCreditTransferDocumentation$outboundSchema
+  ).optional(),
+});
+
+export function entityUnmatchedCreditTransferLinksToJSON(
+  entityUnmatchedCreditTransferLinks: EntityUnmatchedCreditTransferLinks,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransferLinks$outboundSchema.parse(
+      entityUnmatchedCreditTransferLinks,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityUnmatchedCreditTransferLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EntityUnmatchedCreditTransferLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityUnmatchedCreditTransferLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const EntityUnmatchedCreditTransfer$inboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransfer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  profileId: z.string(),
+  amount: Amount$inboundSchema,
+  source: z.lazy(() => EntityUnmatchedCreditTransferSource$inboundSchema),
+  remittanceInformation: z.lazy(() =>
+    EntityUnmatchedCreditTransferRemittanceInformation$inboundSchema
+  ),
+  status: UnmatchedCreditTransferStatus$inboundSchema,
+  createdAt: z.string(),
+  expiresAt: z.string(),
+  paymentIds: z.array(z.string()).optional(),
+  _links: z.lazy(() => EntityUnmatchedCreditTransferLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type EntityUnmatchedCreditTransfer$Outbound = {
+  resource: string;
+  id: string;
+  profileId: string;
+  amount: Amount$Outbound;
+  source: EntityUnmatchedCreditTransferSource$Outbound;
+  remittanceInformation:
+    EntityUnmatchedCreditTransferRemittanceInformation$Outbound;
+  status: string;
+  createdAt: string;
+  expiresAt: string;
+  paymentIds?: Array<string> | undefined;
+  _links: EntityUnmatchedCreditTransferLinks$Outbound;
+};
+
+/** @internal */
+export const EntityUnmatchedCreditTransfer$outboundSchema: z.ZodType<
+  EntityUnmatchedCreditTransfer$Outbound,
+  z.ZodTypeDef,
+  EntityUnmatchedCreditTransfer
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  profileId: z.string(),
+  amount: Amount$outboundSchema,
+  source: z.lazy(() => EntityUnmatchedCreditTransferSource$outboundSchema),
+  remittanceInformation: z.lazy(() =>
+    EntityUnmatchedCreditTransferRemittanceInformation$outboundSchema
+  ),
+  status: UnmatchedCreditTransferStatus$outboundSchema,
+  createdAt: z.string(),
+  expiresAt: z.string(),
+  paymentIds: z.array(z.string()).optional(),
+  links: z.lazy(() => EntityUnmatchedCreditTransferLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function entityUnmatchedCreditTransferToJSON(
+  entityUnmatchedCreditTransfer: EntityUnmatchedCreditTransfer,
+): string {
+  return JSON.stringify(
+    EntityUnmatchedCreditTransfer$outboundSchema.parse(
+      entityUnmatchedCreditTransfer,
+    ),
+  );
+}
+export function entityUnmatchedCreditTransferFromJSON(
+  jsonString: string,
+): SafeParseResult<EntityUnmatchedCreditTransfer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EntityUnmatchedCreditTransfer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EntityUnmatchedCreditTransfer' from JSON`,
+  );
+}

package/src/models/errorresponse.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "./errors/sdkvalidationerror.js";
 /**
  * The URL to the generic Mollie API error handling guide.
  */
-export type Documentation = {
+export type ErrorResponseDocumentation = {
   href: string;
   type: string;
 };
@@ -20,12 +20,12 @@ export type ErrorResponseLinks = {
   /**
    * The URL to the generic Mollie API error handling guide.
    */
-  documentation: Documentation;
+  documentation: ErrorResponseDocumentation;
 };
 
 /** @internal */
-export const Documentation$inboundSchema: z.ZodType<
-  Documentation,
+export const ErrorResponseDocumentation$inboundSchema: z.ZodType<
+  ErrorResponseDocumentation,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -33,31 +33,35 @@ export const Documentation$inboundSchema: z.ZodType<
   type: z.string(),
 });
 /** @internal */
-export type Documentation$Outbound = {
+export type ErrorResponseDocumentation$Outbound = {
   href: string;
   type: string;
 };
 
 /** @internal */
-export const Documentation$outboundSchema: z.ZodType<
-  Documentation$Outbound,
+export const ErrorResponseDocumentation$outboundSchema: z.ZodType<
+  ErrorResponseDocumentation$Outbound,
   z.ZodTypeDef,
-  Documentation
+  ErrorResponseDocumentation
 > = z.object({
   href: z.string(),
   type: z.string(),
 });
 
-export function documentationToJSON(documentation: Documentation): string {
-  return JSON.stringify(Documentation$outboundSchema.parse(documentation));
+export function errorResponseDocumentationToJSON(
+  errorResponseDocumentation: ErrorResponseDocumentation,
+): string {
+  return JSON.stringify(
+    ErrorResponseDocumentation$outboundSchema.parse(errorResponseDocumentation),
+  );
 }
-export function documentationFromJSON(
+export function errorResponseDocumentationFromJSON(
   jsonString: string,
-): SafeParseResult<Documentation, SDKValidationError> {
+): SafeParseResult<ErrorResponseDocumentation, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Documentation$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Documentation' from JSON`,
+    (x) => ErrorResponseDocumentation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorResponseDocumentation' from JSON`,
   );
 }
 
@@ -67,11 +71,11 @@ export const ErrorResponseLinks$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  documentation: z.lazy(() => Documentation$inboundSchema),
+  documentation: z.lazy(() => ErrorResponseDocumentation$inboundSchema),
 });
 /** @internal */
 export type ErrorResponseLinks$Outbound = {
-  documentation: Documentation$Outbound;
+  documentation: ErrorResponseDocumentation$Outbound;
 };
 
 /** @internal */
@@ -80,7 +84,7 @@ export const ErrorResponseLinks$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ErrorResponseLinks
 > = z.object({
-  documentation: z.lazy(() => Documentation$outboundSchema),
+  documentation: z.lazy(() => ErrorResponseDocumentation$outboundSchema),
 });
 
 export function errorResponseLinksToJSON(

package/src/models/index.ts

@@ -68,6 +68,7 @@ export * from "./entitypermission.js";
 export * from "./entityrefundresponse.js";
 export * from "./entitysettlement.js";
 export * from "./entityterminal.js";
+export * from "./entityunmatchedcredittransfer.js";
 export * from "./entitywebhook.js";
 export * from "./entitywebhookevent.js";
 export * from "./errorresponse.js";
@@ -84,6 +85,7 @@ export * from "./listentitypermission.js";
 export * from "./listentityrefund.js";
 export * from "./listentitysettlement.js";
 export * from "./listentityterminal.js";
+export * from "./listentityunmatchedcredittransfer.js";
 export * from "./listentitywebhook.js";
 export * from "./listlinks.js";
 export * from "./listmandateresponse.js";
@@ -209,6 +211,9 @@ export * from "./transferschemeresponse.js";
 export * from "./transferschemetype.js";
 export * from "./transferschemetyperesponse.js";
 export * from "./transferstatus.js";
+export * from "./unmatchedcredittransferactionresponse.js";
+export * from "./unmatchedcredittransfermatchrequest.js";
+export * from "./unmatchedcredittransferstatus.js";
 export * from "./url.js";
 export * from "./urlnullable.js";
 export * from "./verificationofpayeerequest.js";