mollie-api-typescript 1.3.7 → 1.3.8

package/src/models/listentityunmatchedcredittransfer.ts

@@ -0,0 +1,476 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 39ed01c4877f
+ */
+
+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 ListEntityUnmatchedCreditTransferSource = {
+  /**
+   * 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 ListEntityUnmatchedCreditTransferReferences = {
+  /**
+   * 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 ListEntityUnmatchedCreditTransferRemittanceInformation = {
+  /**
+   * Unstructured remittance information, such as a free-text payment description.
+   */
+  unstructured?: string | undefined;
+  /**
+   * Structured references provided with the unmatched credit transfer.
+   */
+  references?: ListEntityUnmatchedCreditTransferReferences | undefined;
+};
+
+/**
+ * The URL to this unmatched credit transfer.
+ */
+export type ListEntityUnmatchedCreditTransferSelf = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * Links to related resources.
+ */
+export type ListEntityUnmatchedCreditTransferLinks = {
+  /**
+   * The URL to this unmatched credit transfer.
+   */
+  self?: ListEntityUnmatchedCreditTransferSelf | undefined;
+};
+
+export type ListEntityUnmatchedCreditTransfer = {
+  /**
+   * 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: ListEntityUnmatchedCreditTransferSource;
+  /**
+   * Remittance information provided with the unmatched credit transfer.
+   */
+  remittanceInformation: ListEntityUnmatchedCreditTransferRemittanceInformation;
+  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: ListEntityUnmatchedCreditTransferLinks;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferSource$inboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  format: z.string(),
+  accountHolderName: z.string(),
+  iban: z.string(),
+  bic: z.string(),
+});
+/** @internal */
+export type ListEntityUnmatchedCreditTransferSource$Outbound = {
+  format: string;
+  accountHolderName: string;
+  iban: string;
+  bic: string;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferSource$outboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferSource$Outbound,
+  z.ZodTypeDef,
+  ListEntityUnmatchedCreditTransferSource
+> = z.object({
+  format: z.string(),
+  accountHolderName: z.string(),
+  iban: z.string(),
+  bic: z.string(),
+});
+
+export function listEntityUnmatchedCreditTransferSourceToJSON(
+  listEntityUnmatchedCreditTransferSource:
+    ListEntityUnmatchedCreditTransferSource,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransferSource$outboundSchema.parse(
+      listEntityUnmatchedCreditTransferSource,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityUnmatchedCreditTransferSource,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityUnmatchedCreditTransferSource$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListEntityUnmatchedCreditTransferSource' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferReferences$inboundSchema:
+  z.ZodType<
+    ListEntityUnmatchedCreditTransferReferences,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    creditorReference: z.nullable(z.string()).optional(),
+    endToEndId: z.string().optional(),
+  });
+/** @internal */
+export type ListEntityUnmatchedCreditTransferReferences$Outbound = {
+  creditorReference?: string | null | undefined;
+  endToEndId?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferReferences$outboundSchema:
+  z.ZodType<
+    ListEntityUnmatchedCreditTransferReferences$Outbound,
+    z.ZodTypeDef,
+    ListEntityUnmatchedCreditTransferReferences
+  > = z.object({
+    creditorReference: z.nullable(z.string()).optional(),
+    endToEndId: z.string().optional(),
+  });
+
+export function listEntityUnmatchedCreditTransferReferencesToJSON(
+  listEntityUnmatchedCreditTransferReferences:
+    ListEntityUnmatchedCreditTransferReferences,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransferReferences$outboundSchema.parse(
+      listEntityUnmatchedCreditTransferReferences,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferReferencesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityUnmatchedCreditTransferReferences,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityUnmatchedCreditTransferReferences$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListEntityUnmatchedCreditTransferReferences' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferRemittanceInformation$inboundSchema:
+  z.ZodType<
+    ListEntityUnmatchedCreditTransferRemittanceInformation,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    unstructured: z.string().optional(),
+    references: z.lazy(() =>
+      ListEntityUnmatchedCreditTransferReferences$inboundSchema
+    ).optional(),
+  });
+/** @internal */
+export type ListEntityUnmatchedCreditTransferRemittanceInformation$Outbound = {
+  unstructured?: string | undefined;
+  references?: ListEntityUnmatchedCreditTransferReferences$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferRemittanceInformation$outboundSchema:
+  z.ZodType<
+    ListEntityUnmatchedCreditTransferRemittanceInformation$Outbound,
+    z.ZodTypeDef,
+    ListEntityUnmatchedCreditTransferRemittanceInformation
+  > = z.object({
+    unstructured: z.string().optional(),
+    references: z.lazy(() =>
+      ListEntityUnmatchedCreditTransferReferences$outboundSchema
+    ).optional(),
+  });
+
+export function listEntityUnmatchedCreditTransferRemittanceInformationToJSON(
+  listEntityUnmatchedCreditTransferRemittanceInformation:
+    ListEntityUnmatchedCreditTransferRemittanceInformation,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransferRemittanceInformation$outboundSchema.parse(
+      listEntityUnmatchedCreditTransferRemittanceInformation,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferRemittanceInformationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListEntityUnmatchedCreditTransferRemittanceInformation,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityUnmatchedCreditTransferRemittanceInformation$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityUnmatchedCreditTransferRemittanceInformation' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferSelf$inboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferSelf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+/** @internal */
+export type ListEntityUnmatchedCreditTransferSelf$Outbound = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferSelf$outboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferSelf$Outbound,
+  z.ZodTypeDef,
+  ListEntityUnmatchedCreditTransferSelf
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+
+export function listEntityUnmatchedCreditTransferSelfToJSON(
+  listEntityUnmatchedCreditTransferSelf: ListEntityUnmatchedCreditTransferSelf,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransferSelf$outboundSchema.parse(
+      listEntityUnmatchedCreditTransferSelf,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferSelfFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityUnmatchedCreditTransferSelf, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityUnmatchedCreditTransferSelf$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityUnmatchedCreditTransferSelf' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferLinks$inboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: z.lazy(() => ListEntityUnmatchedCreditTransferSelf$inboundSchema)
+    .optional(),
+});
+/** @internal */
+export type ListEntityUnmatchedCreditTransferLinks$Outbound = {
+  self?: ListEntityUnmatchedCreditTransferSelf$Outbound | undefined;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransferLinks$outboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransferLinks$Outbound,
+  z.ZodTypeDef,
+  ListEntityUnmatchedCreditTransferLinks
+> = z.object({
+  self: z.lazy(() => ListEntityUnmatchedCreditTransferSelf$outboundSchema)
+    .optional(),
+});
+
+export function listEntityUnmatchedCreditTransferLinksToJSON(
+  listEntityUnmatchedCreditTransferLinks:
+    ListEntityUnmatchedCreditTransferLinks,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransferLinks$outboundSchema.parse(
+      listEntityUnmatchedCreditTransferLinks,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityUnmatchedCreditTransferLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListEntityUnmatchedCreditTransferLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityUnmatchedCreditTransferLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransfer$inboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransfer,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  profileId: z.string(),
+  amount: Amount$inboundSchema,
+  source: z.lazy(() => ListEntityUnmatchedCreditTransferSource$inboundSchema),
+  remittanceInformation: z.lazy(() =>
+    ListEntityUnmatchedCreditTransferRemittanceInformation$inboundSchema
+  ),
+  status: UnmatchedCreditTransferStatus$inboundSchema,
+  createdAt: z.string(),
+  expiresAt: z.string(),
+  paymentIds: z.array(z.string()).optional(),
+  _links: z.lazy(() => ListEntityUnmatchedCreditTransferLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListEntityUnmatchedCreditTransfer$Outbound = {
+  resource: string;
+  id: string;
+  profileId: string;
+  amount: Amount$Outbound;
+  source: ListEntityUnmatchedCreditTransferSource$Outbound;
+  remittanceInformation:
+    ListEntityUnmatchedCreditTransferRemittanceInformation$Outbound;
+  status: string;
+  createdAt: string;
+  expiresAt: string;
+  paymentIds?: Array<string> | undefined;
+  _links: ListEntityUnmatchedCreditTransferLinks$Outbound;
+};
+
+/** @internal */
+export const ListEntityUnmatchedCreditTransfer$outboundSchema: z.ZodType<
+  ListEntityUnmatchedCreditTransfer$Outbound,
+  z.ZodTypeDef,
+  ListEntityUnmatchedCreditTransfer
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  profileId: z.string(),
+  amount: Amount$outboundSchema,
+  source: z.lazy(() => ListEntityUnmatchedCreditTransferSource$outboundSchema),
+  remittanceInformation: z.lazy(() =>
+    ListEntityUnmatchedCreditTransferRemittanceInformation$outboundSchema
+  ),
+  status: UnmatchedCreditTransferStatus$outboundSchema,
+  createdAt: z.string(),
+  expiresAt: z.string(),
+  paymentIds: z.array(z.string()).optional(),
+  links: z.lazy(() => ListEntityUnmatchedCreditTransferLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listEntityUnmatchedCreditTransferToJSON(
+  listEntityUnmatchedCreditTransfer: ListEntityUnmatchedCreditTransfer,
+): string {
+  return JSON.stringify(
+    ListEntityUnmatchedCreditTransfer$outboundSchema.parse(
+      listEntityUnmatchedCreditTransfer,
+    ),
+  );
+}
+export function listEntityUnmatchedCreditTransferFromJSON(
+  jsonString: string,
+): SafeParseResult<ListEntityUnmatchedCreditTransfer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListEntityUnmatchedCreditTransfer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListEntityUnmatchedCreditTransfer' from JSON`,
+  );
+}

package/src/models/operations/getunmatchedcredittransfer.ts

@@ -0,0 +1,73 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 544c6d7e8058
+ */
+
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetUnmatchedCreditTransferRequest = {
+  /**
+   * Provide the ID of the related unmatched credit transfer.
+   */
+  unmatchedCreditTransferId: string;
+  /**
+   * A unique key to ensure idempotent requests. This key should be a UUID v4 string.
+   */
+  idempotencyKey?: string | undefined;
+};
+
+/** @internal */
+export const GetUnmatchedCreditTransferRequest$inboundSchema: z.ZodType<
+  GetUnmatchedCreditTransferRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  unmatchedCreditTransferId: z.string(),
+  "idempotency-key": z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "idempotency-key": "idempotencyKey",
+  });
+});
+/** @internal */
+export type GetUnmatchedCreditTransferRequest$Outbound = {
+  unmatchedCreditTransferId: string;
+  "idempotency-key"?: string | undefined;
+};
+
+/** @internal */
+export const GetUnmatchedCreditTransferRequest$outboundSchema: z.ZodType<
+  GetUnmatchedCreditTransferRequest$Outbound,
+  z.ZodTypeDef,
+  GetUnmatchedCreditTransferRequest
+> = z.object({
+  unmatchedCreditTransferId: z.string(),
+  idempotencyKey: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    idempotencyKey: "idempotency-key",
+  });
+});
+
+export function getUnmatchedCreditTransferRequestToJSON(
+  getUnmatchedCreditTransferRequest: GetUnmatchedCreditTransferRequest,
+): string {
+  return JSON.stringify(
+    GetUnmatchedCreditTransferRequest$outboundSchema.parse(
+      getUnmatchedCreditTransferRequest,
+    ),
+  );
+}
+export function getUnmatchedCreditTransferRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetUnmatchedCreditTransferRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetUnmatchedCreditTransferRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetUnmatchedCreditTransferRequest' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -58,6 +58,7 @@ export * from "./getsettlement.js";
 export * from "./getsubscription.js";
 export * from "./getterminal.js";
 export * from "./gettransfer.js";
+export * from "./getunmatchedcredittransfer.js";
 export * from "./getwebhook.js";
 export * from "./getwebhookevent.js";
 export * from "./listallchargebacks.js";
@@ -92,12 +93,15 @@ export * from "./listsettlements.js";
 export * from "./listsubscriptionpayments.js";
 export * from "./listsubscriptions.js";
 export * from "./listterminals.js";
+export * from "./listunmatchedcredittransfers.js";
 export * from "./listwebhooks.js";
+export * from "./matchunmatchedcredittransfer.js";
 export * from "./paymentcreateroute.js";
 export * from "./paymentgetroute.js";
 export * from "./paymentlistroutes.js";
 export * from "./releaseauthorization.js";
 export * from "./requestapplepaypaymentsession.js";
+export * from "./returnunmatchedcredittransfer.js";
 export * from "./revokemandate.js";
 export * from "./submitonboardingdata.js";
 export * from "./testwebhook.js";