mollie-api-typescript 1.3.7 → 1.3.8

package/src/models/unmatchedcredittransferactionresponse.ts

@@ -0,0 +1,426 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 70f9c8054155
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+/**
+ * The action performed on the unmatched credit transfer.
+ */
+export const Action = {
+  Match: "match",
+  Return: "return",
+} as const;
+/**
+ * The action performed on the unmatched credit transfer.
+ */
+export type Action = OpenEnum<typeof Action>;
+
+/**
+ * The current status of the action.
+ */
+export const UnmatchedCreditTransferActionResponseStatus = {
+  Pending: "pending",
+} as const;
+/**
+ * The current status of the action.
+ */
+export type UnmatchedCreditTransferActionResponseStatus = OpenEnum<
+  typeof UnmatchedCreditTransferActionResponseStatus
+>;
+
+/**
+ * Additional details about the action.
+ */
+export type UnmatchedCreditTransferActionResponseDetails = {
+  /**
+   * The IDs of the payments matched to the unmatched credit transfer.
+   */
+  paymentIds?: Array<string> | undefined;
+};
+
+/**
+ * The URL to this action.
+ */
+export type UnmatchedCreditTransferActionResponseSelf = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * The URL to the documentation of this endpoint.
+ */
+export type UnmatchedCreditTransferActionResponseDocumentation = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/**
+ * Links to related resources.
+ */
+export type UnmatchedCreditTransferActionResponseLinks = {
+  /**
+   * The URL to this action.
+   */
+  self?: UnmatchedCreditTransferActionResponseSelf | undefined;
+  /**
+   * The URL to the documentation of this endpoint.
+   */
+  documentation?:
+    | UnmatchedCreditTransferActionResponseDocumentation
+    | undefined;
+};
+
+export type UnmatchedCreditTransferActionResponse = {
+  /**
+   * The resource type of the object.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this unmatched credit transfer action.
+   */
+  id: string;
+  /**
+   * The identifier of the unmatched credit transfer this action belongs to.
+   */
+  unmatchedCreditTransferId: string;
+  /**
+   * The action performed on the unmatched credit transfer.
+   */
+  action: Action;
+  /**
+   * The current status of the action.
+   */
+  status: UnmatchedCreditTransferActionResponseStatus;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * Additional details about the action.
+   */
+  details?: UnmatchedCreditTransferActionResponseDetails | undefined;
+  /**
+   * Links to related resources.
+   */
+  links: UnmatchedCreditTransferActionResponseLinks;
+};
+
+/** @internal */
+export const Action$inboundSchema: z.ZodType<Action, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Action);
+/** @internal */
+export const Action$outboundSchema: z.ZodType<string, z.ZodTypeDef, Action> =
+  openEnums.outboundSchema(Action);
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseStatus$inboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseStatus,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(UnmatchedCreditTransferActionResponseStatus);
+/** @internal */
+export const UnmatchedCreditTransferActionResponseStatus$outboundSchema:
+  z.ZodType<string, z.ZodTypeDef, UnmatchedCreditTransferActionResponseStatus> =
+    openEnums.outboundSchema(UnmatchedCreditTransferActionResponseStatus);
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseDetails$inboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseDetails,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    paymentIds: z.array(z.string()).optional(),
+  });
+/** @internal */
+export type UnmatchedCreditTransferActionResponseDetails$Outbound = {
+  paymentIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseDetails$outboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseDetails$Outbound,
+    z.ZodTypeDef,
+    UnmatchedCreditTransferActionResponseDetails
+  > = z.object({
+    paymentIds: z.array(z.string()).optional(),
+  });
+
+export function unmatchedCreditTransferActionResponseDetailsToJSON(
+  unmatchedCreditTransferActionResponseDetails:
+    UnmatchedCreditTransferActionResponseDetails,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferActionResponseDetails$outboundSchema.parse(
+      unmatchedCreditTransferActionResponseDetails,
+    ),
+  );
+}
+export function unmatchedCreditTransferActionResponseDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UnmatchedCreditTransferActionResponseDetails,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferActionResponseDetails$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UnmatchedCreditTransferActionResponseDetails' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseSelf$inboundSchema: z.ZodType<
+  UnmatchedCreditTransferActionResponseSelf,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  href: z.string().optional(),
+  type: z.string().optional(),
+});
+/** @internal */
+export type UnmatchedCreditTransferActionResponseSelf$Outbound = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseSelf$outboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseSelf$Outbound,
+    z.ZodTypeDef,
+    UnmatchedCreditTransferActionResponseSelf
+  > = z.object({
+    href: z.string().optional(),
+    type: z.string().optional(),
+  });
+
+export function unmatchedCreditTransferActionResponseSelfToJSON(
+  unmatchedCreditTransferActionResponseSelf:
+    UnmatchedCreditTransferActionResponseSelf,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferActionResponseSelf$outboundSchema.parse(
+      unmatchedCreditTransferActionResponseSelf,
+    ),
+  );
+}
+export function unmatchedCreditTransferActionResponseSelfFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UnmatchedCreditTransferActionResponseSelf,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferActionResponseSelf$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UnmatchedCreditTransferActionResponseSelf' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseDocumentation$inboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseDocumentation,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    href: z.string().optional(),
+    type: z.string().optional(),
+  });
+/** @internal */
+export type UnmatchedCreditTransferActionResponseDocumentation$Outbound = {
+  href?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseDocumentation$outboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseDocumentation$Outbound,
+    z.ZodTypeDef,
+    UnmatchedCreditTransferActionResponseDocumentation
+  > = z.object({
+    href: z.string().optional(),
+    type: z.string().optional(),
+  });
+
+export function unmatchedCreditTransferActionResponseDocumentationToJSON(
+  unmatchedCreditTransferActionResponseDocumentation:
+    UnmatchedCreditTransferActionResponseDocumentation,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferActionResponseDocumentation$outboundSchema.parse(
+      unmatchedCreditTransferActionResponseDocumentation,
+    ),
+  );
+}
+export function unmatchedCreditTransferActionResponseDocumentationFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UnmatchedCreditTransferActionResponseDocumentation,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferActionResponseDocumentation$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UnmatchedCreditTransferActionResponseDocumentation' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseLinks$inboundSchema:
+  z.ZodType<UnmatchedCreditTransferActionResponseLinks, z.ZodTypeDef, unknown> =
+    z.object({
+      self: z.lazy(() =>
+        UnmatchedCreditTransferActionResponseSelf$inboundSchema
+      ).optional(),
+      documentation: z.lazy(() =>
+        UnmatchedCreditTransferActionResponseDocumentation$inboundSchema
+      ).optional(),
+    });
+/** @internal */
+export type UnmatchedCreditTransferActionResponseLinks$Outbound = {
+  self?: UnmatchedCreditTransferActionResponseSelf$Outbound | undefined;
+  documentation?:
+    | UnmatchedCreditTransferActionResponseDocumentation$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponseLinks$outboundSchema:
+  z.ZodType<
+    UnmatchedCreditTransferActionResponseLinks$Outbound,
+    z.ZodTypeDef,
+    UnmatchedCreditTransferActionResponseLinks
+  > = z.object({
+    self: z.lazy(() => UnmatchedCreditTransferActionResponseSelf$outboundSchema)
+      .optional(),
+    documentation: z.lazy(() =>
+      UnmatchedCreditTransferActionResponseDocumentation$outboundSchema
+    ).optional(),
+  });
+
+export function unmatchedCreditTransferActionResponseLinksToJSON(
+  unmatchedCreditTransferActionResponseLinks:
+    UnmatchedCreditTransferActionResponseLinks,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferActionResponseLinks$outboundSchema.parse(
+      unmatchedCreditTransferActionResponseLinks,
+    ),
+  );
+}
+export function unmatchedCreditTransferActionResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  UnmatchedCreditTransferActionResponseLinks,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferActionResponseLinks$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'UnmatchedCreditTransferActionResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponse$inboundSchema: z.ZodType<
+  UnmatchedCreditTransferActionResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  unmatchedCreditTransferId: z.string(),
+  action: Action$inboundSchema,
+  status: UnmatchedCreditTransferActionResponseStatus$inboundSchema,
+  createdAt: z.string(),
+  details: z.lazy(() =>
+    UnmatchedCreditTransferActionResponseDetails$inboundSchema
+  ).optional(),
+  _links: z.lazy(() =>
+    UnmatchedCreditTransferActionResponseLinks$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type UnmatchedCreditTransferActionResponse$Outbound = {
+  resource: string;
+  id: string;
+  unmatchedCreditTransferId: string;
+  action: string;
+  status: string;
+  createdAt: string;
+  details?: UnmatchedCreditTransferActionResponseDetails$Outbound | undefined;
+  _links: UnmatchedCreditTransferActionResponseLinks$Outbound;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferActionResponse$outboundSchema: z.ZodType<
+  UnmatchedCreditTransferActionResponse$Outbound,
+  z.ZodTypeDef,
+  UnmatchedCreditTransferActionResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  unmatchedCreditTransferId: z.string(),
+  action: Action$outboundSchema,
+  status: UnmatchedCreditTransferActionResponseStatus$outboundSchema,
+  createdAt: z.string(),
+  details: z.lazy(() =>
+    UnmatchedCreditTransferActionResponseDetails$outboundSchema
+  ).optional(),
+  links: z.lazy(() =>
+    UnmatchedCreditTransferActionResponseLinks$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function unmatchedCreditTransferActionResponseToJSON(
+  unmatchedCreditTransferActionResponse: UnmatchedCreditTransferActionResponse,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferActionResponse$outboundSchema.parse(
+      unmatchedCreditTransferActionResponse,
+    ),
+  );
+}
+export function unmatchedCreditTransferActionResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UnmatchedCreditTransferActionResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferActionResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnmatchedCreditTransferActionResponse' from JSON`,
+  );
+}

package/src/models/unmatchedcredittransfermatchrequest.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 62d67e484ffd
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export type UnmatchedCreditTransferMatchRequest = {
+  /**
+   * The IDs of the payments to match against the unmatched credit transfer.
+   */
+  paymentIds: Array<string>;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferMatchRequest$inboundSchema: z.ZodType<
+  UnmatchedCreditTransferMatchRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  paymentIds: z.array(z.string()),
+});
+/** @internal */
+export type UnmatchedCreditTransferMatchRequest$Outbound = {
+  paymentIds: Array<string>;
+};
+
+/** @internal */
+export const UnmatchedCreditTransferMatchRequest$outboundSchema: z.ZodType<
+  UnmatchedCreditTransferMatchRequest$Outbound,
+  z.ZodTypeDef,
+  UnmatchedCreditTransferMatchRequest
+> = z.object({
+  paymentIds: z.array(z.string()),
+});
+
+export function unmatchedCreditTransferMatchRequestToJSON(
+  unmatchedCreditTransferMatchRequest: UnmatchedCreditTransferMatchRequest,
+): string {
+  return JSON.stringify(
+    UnmatchedCreditTransferMatchRequest$outboundSchema.parse(
+      unmatchedCreditTransferMatchRequest,
+    ),
+  );
+}
+export function unmatchedCreditTransferMatchRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<UnmatchedCreditTransferMatchRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      UnmatchedCreditTransferMatchRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UnmatchedCreditTransferMatchRequest' from JSON`,
+  );
+}

package/src/models/unmatchedcredittransferstatus.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e2b8ffb2feac
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+
+export const UnmatchedCreditTransferStatus = {
+  Received: "received",
+  Matched: "matched",
+  Returned: "returned",
+  Expired: "expired",
+} as const;
+export type UnmatchedCreditTransferStatus = OpenEnum<
+  typeof UnmatchedCreditTransferStatus
+>;
+
+/** @internal */
+export const UnmatchedCreditTransferStatus$inboundSchema: z.ZodType<
+  UnmatchedCreditTransferStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(UnmatchedCreditTransferStatus);
+/** @internal */
+export const UnmatchedCreditTransferStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  UnmatchedCreditTransferStatus
+> = openEnums.outboundSchema(UnmatchedCreditTransferStatus);

package/src/sdk/sdk.ts

@@ -30,6 +30,7 @@ import { Settlements } from "./settlements.js";
 import { Subscriptions } from "./subscriptions.js";
 import { Terminals } from "./terminals.js";
 import { Transfers } from "./transfers.js";
+import { UnmatchedCreditTransfers } from "./unmatchedcredittransfers.js";
 import { VerifyPayees } from "./verifypayees.js";
 import { Wallets } from "./wallets.js";
 import { WebhookEvents } from "./webhookevents.js";
@@ -106,6 +107,13 @@ export class Client extends ClientSDK {
     return (this._payments ??= new Payments(this._options));
   }
 
+  private _unmatchedCreditTransfers?: UnmatchedCreditTransfers;
+  get unmatchedCreditTransfers(): UnmatchedCreditTransfers {
+    return (this._unmatchedCreditTransfers ??= new UnmatchedCreditTransfers(
+      this._options,
+    ));
+  }
+
   private _sessions?: Sessions;
   get sessions(): Sessions {
     return (this._sessions ??= new Sessions(this._options));

package/src/sdk/unmatchedcredittransfers.ts

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d83796b1e949
+ */
+
+import { unmatchedCreditTransfersGet } from "../funcs/unmatchedCreditTransfersGet.js";
+import { unmatchedCreditTransfersList } from "../funcs/unmatchedCreditTransfersList.js";
+import { unmatchedCreditTransfersMatch } from "../funcs/unmatchedCreditTransfersMatch.js";
+import { unmatchedCreditTransfersReturn } from "../funcs/unmatchedCreditTransfersReturn.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export class UnmatchedCreditTransfers extends ClientSDK {
+  /**
+   * List unmatched credit transfers
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in private beta, and the final specification may still change.
+   *
+   * Retrieves a list of unmatched credit transfers for the profile.
+   *
+   * The results are paginated.
+   */
+  async list(
+    request?: operations.ListUnmatchedCreditTransfersRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListUnmatchedCreditTransfersResponse,
+      { url: string }
+    >
+  > {
+    return unwrapResultIterator(unmatchedCreditTransfersList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get unmatched credit transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in private beta, and the final specification may still change.
+   *
+   * Retrieves a single unmatched credit transfer by its identifier.
+   */
+  async get(
+    request: operations.GetUnmatchedCreditTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.EntityUnmatchedCreditTransfer> {
+    return unwrapAsync(unmatchedCreditTransfersGet(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Match unmatched credit transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in private beta, and the final specification may still change.
+   *
+   * Matches an unmatched credit transfer to one or more payments, settling the funds accordingly.
+   */
+  async match(
+    request: operations.MatchUnmatchedCreditTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.UnmatchedCreditTransferActionResponse> {
+    return unwrapAsync(unmatchedCreditTransfersMatch(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Return unmatched credit transfer
+   *
+   * @remarks
+   * > 🚧 Beta feature
+   * >
+   * > This feature is currently in private beta, and the final specification may still change.
+   *
+   * Returns an unmatched credit transfer, sending the funds back to the original sender.
+   */
+  async return(
+    request: operations.ReturnUnmatchedCreditTransferRequest,
+    options?: RequestOptions,
+  ): Promise<models.UnmatchedCreditTransferActionResponse> {
+    return unwrapAsync(unmatchedCreditTransfersReturn(
+      this,
+      request,
+      options,
+    ));
+  }
+}